Merge pull request #423 from puja-trivedi/fix_yamlutils_as_json_object_inject_type

added new variable: element_type in yamlutils.as_json_object() and JSONDumper.dumps()

Author: kevinschaper

linkml_runtime/dumpers/json_dumper.py

@@ -62,10 +62,14 @@ def default(o):
             else:
                 return json.JSONDecoder().decode(o)
 
+        element_type = element.__class__.__name__
         if isinstance(element, BaseModel):
             element = element.model_dump()
         return json.dumps(
-            as_json_object(element, contexts, inject_type=inject_type), default=default, ensure_ascii=False, indent="  "
+            as_json_object(element, contexts, inject_type=inject_type, element_type=element_type),
+            default=default,
+            ensure_ascii=False,
+            indent="  ",
         )
 
     @staticmethod

linkml_runtime/utils/yamlutils.py

@@ -360,17 +360,22 @@ def as_yaml(element: YAMLRoot) -> str:
     return yaml.dump(element, Dumper=yaml.SafeDumper, sort_keys=False)
 
 
-def as_json_object(element: YAMLRoot, contexts: CONTEXTS_PARAM_TYPE = None, inject_type=True) -> JsonObj:
+def as_json_object(
+    element: YAMLRoot, contexts: CONTEXTS_PARAM_TYPE = None, inject_type=True, element_type=None
+) -> JsonObj:
     """
     Return the representation of element as a JsonObj object
     :param element: element to return
     :param contexts: context(s) to include in the output
     :param inject_type: if True (default), add a @type at the top level
+    :param element_type: if provided, use this as the @type value instead of the element's class name
     :return: JsonObj representation of element
     """
     rval = copy(element)
     if inject_type:
-        rval["@type"] = element.__class__.__name__
+        if element_type is None:
+            element_type = element.__class__.__name__
+        rval["@type"] = element_type
     context_element = merge_contexts(contexts)
     if context_element:
         rval["@context"] = context_element["@context"]

tests/test_loaders_dumpers/test_dumpers_pydantic.py

@@ -54,6 +54,16 @@ def test_json_dumper(self):
                 "creator" not in data["books"][i].keys()
             self.assertEqual(data, remove_empty_items(self.bookseries.model_dump()))
 
+        # test @type is added to the top level and is assigned correct type when inject_type is True
+        bookseries_with_type = json.loads(json_dumper.dumps(self.bookseries, inject_type=True))
+        self.assertIn("@type", bookseries_with_type)
+        self.assertEqual("BookSeries", bookseries_with_type.get("@type"))
+
+        # test @type is not added to the top level when inject_type is False
+        bookseries_without_type = json.loads(json_dumper.dumps(self.bookseries, inject_type=False))
+        self.assertNotIn("@type", bookseries_without_type)
+        self.assertEqual(None, bookseries_without_type.get("@type"))
+
 
 class PydanticDumpersDateTestCase(LoaderDumperTestCase):
     @classmethod