support serialization and deserialization for SarifLog

Author: FunJim

sarif_om/__init__.py

@@ -1,5 +1,11 @@
 # This file was generated by jschema_to_python version 1.2.3.
 
+import json
+from typing import Dict
+from attrs import has, fields
+from cattrs import Converter
+from cattrs.gen import make_dict_unstructure_fn, make_dict_structure_fn, override
+
 from ._sarif_log import SarifLog
 from ._address import Address
 from ._artifact import Artifact
@@ -53,3 +59,56 @@
 from ._version_control_details import VersionControlDetails
 from ._web_request import WebRequest
 from ._web_response import WebResponse
+
+
+def _generate_sarif_report_cattrs_converter() -> Converter:
+    converter = Converter()
+
+    def _unstructure(cls):
+        return make_dict_unstructure_fn(
+            cls,
+            converter,
+            **{
+                a.name: override(
+                    rename=a.metadata["schema_property_name"],
+                    omit_if_default=True,
+                )
+                for a in fields(cls)
+            },
+        )
+
+    def _structure(cls):
+        return make_dict_structure_fn(
+            cls,
+            converter,
+            **{
+                a.name: override(
+                    rename=a.metadata["schema_property_name"],
+                )
+                for a in fields(cls)
+            },
+        )
+
+    converter.register_unstructure_hook_factory(has, _unstructure)
+    converter.register_structure_hook_factory(has, _structure)
+    return converter
+
+
+_converter = _generate_sarif_report_cattrs_converter()
+
+
+def to_dict(sarif_log: SarifLog) -> Dict:
+    return _converter.unstructure(sarif_log, SarifLog)
+
+
+def to_json(sarif_log: SarifLog, indent=2) -> str:
+    obj = to_dict(sarif_log)
+    return json.dumps(obj, indent=indent)
+
+
+def from_dict(data: Dict) -> SarifLog:
+    return _converter.structure(data, SarifLog)
+
+
+def from_json(data: str) -> SarifLog:
+    return from_dict(json.loads(data))

setup.cfg

@@ -20,6 +20,7 @@ classifier =
 python_requires = >= 2.7
 install_requires =
     attrs
+    cattrs
     pbr
 
 [files]

setup.py

@@ -2,4 +2,4 @@
 
 from setuptools import setup
 
-setup(setup_requires=["pbr"], pbr=True)
+setup(setup_requires=["pbr"], install_requires=["attrs", "cattrs"], pbr=True)