spdx-python-model 0.0.4__py3-none-any.whl → 0.0.6__py3-none-any.whl

spdx_python_model/__init__.py

@@ -1,6 +1,114 @@
-#
+# SPDX-FileType: SOURCE
 # SPDX-License-Identifier: Apache-2.0
-#
+"""
+Python bindings for the SPDX 3 data model.
+"""
 
-from .bindings import *
+import importlib
+import json
+from pathlib import Path
+from types import ModuleType
+from typing import TYPE_CHECKING, Any, List, Tuple
+
+from .bindings import _CONTEXT_TABLE
 from .version import VERSION
+from .version import VERSION as __version__
+
+if TYPE_CHECKING:
+    # Generated re-exports to give type checkers version types.
+    # Not imported during runtime.
+    from .bindings._reexport import *  # noqa: F403
+
+__all__ = [
+    "bindings",  # generated # noqa: F405
+    "LoadError",
+    "VERSION",
+    "__version__",
+    "load",
+    "load_data",
+]
+
+# Version submodule names accepted by __getattr__ for top-level import.
+_VERSION_MODULES = frozenset(_CONTEXT_TABLE.values())
+
+
+class LoadError(Exception):
+    """Raised when a SPDX document cannot be loaded."""
+
+
+def __getattr__(name: str) -> ModuleType:
+    """Lazily import a version's bindings on first top-level access (PEP 562)."""
+    if name in _VERSION_MODULES:
+        return importlib.import_module(f"{__name__}.bindings.{name}")
+    raise AttributeError(f"module {__name__!r} has no attribute {name!r}")
+
+
+def __dir__() -> List[str]:
+    return sorted(set(globals()) | _VERSION_MODULES)
+
+
+def load_data(data: Any) -> Tuple[ModuleType, Any]:
+    """
+    Automatically load a SPDX 3 JSON document with the correct model based on
+    its context
+
+    :param data: The decoded JSON data as a Python dict
+
+    :returns: A tuple that contains the model and the decoded SHACLObjectSet
+
+    :raises LoadError: If the data is missing a context or if the context is
+        not recognized
+    :raises TypeError: If the data is not a dictionary
+    """
+
+    if not isinstance(data, dict):
+        raise TypeError("Data must be a dictionary")
+
+    context = data.get("@context")
+    if not context:
+        raise LoadError("No @context in data")
+
+    context_url = None
+
+    if isinstance(context, str):
+        context_url = context
+    elif isinstance(context, list):
+        for item in context:
+            if isinstance(item, str):
+                context_url = item
+                break
+
+    if not context_url:
+        raise LoadError("No valid @context URL string found in data")
+
+    module_name = _CONTEXT_TABLE.get(context_url)
+    if module_name is None:
+        raise LoadError(f"Unknown context URL '{context_url}'")
+
+    model = importlib.import_module(f"{__name__}.bindings.{module_name}")
+
+    d = model.JSONLDDeserializer()
+    objset = model.SHACLObjectSet()
+
+    d.deserialize_data(data, objset)
+
+    return model, objset
+
+
+def load(path: Path) -> Tuple[ModuleType, Any]:
+    """
+    Automatically load a SPDX 3 JSON document with the correct model based on
+    its context
+
+    :param path: The path to the SPDX 3 JSON file
+
+    :returns: A tuple that contains the model and the decoded SHACLObjectSet
+
+    :raises LoadError: If the data is missing a context or if the context is
+        not recognized
+    :raises TypeError: If the data is not a dictionary
+    """
+    with path.open("r") as f:
+        data = json.load(f)
+
+    return load_data(data)

spdx_python_model/bindings/__init__.py

@@ -1,2 +1,13 @@
-# Import all versions
-from . import v3_0_1
+# SPDX-FileType: SOURCE
+# SPDX-License-Identifier: Apache-2.0
+#
+# Generated by generate-bindings at build time. DO NOT EDIT.
+"""SPDX model bindings, one submodule per version.
+
+Versions are not imported here, so importing one does not load the others.
+"""
+
+# JSON-LD @context URL -> version submodule name, for lazy lookup by load().
+_CONTEXT_TABLE = {
+    "https://spdx.org/rdf/3.0.1/spdx-context.jsonld": "v3_0_1",
+}

spdx_python_model/bindings/_reexport.pyi

@@ -0,0 +1,14 @@
+# SPDX-FileType: SOURCE
+# SPDX-License-Identifier: Apache-2.0
+#
+# Generated by generate-bindings at build time. DO NOT EDIT.
+"""Type-checking-only re-exports so ``spdx_python_model.vX`` types resolve.
+
+Imported under TYPE_CHECKING only; the runtime loads versions lazily via the
+package __getattr__. __all__ marks the names as re-exports for --no-implicit-reexport.
+"""
+from . import v3_0_1
+
+__all__ = [
+    "v3_0_1",
+]

spdx_python_model/bindings/v3_0_1/__init__.py

@@ -0,0 +1,13 @@
+#! /usr/bin/env python3
+#
+# This file was auto-generated by shacl2code 1.1.0. DO NOT MANUALLY MODIFY IT
+#
+# SPDX-License-Identifier: Apache-2.0
+
+from .model import *  # noqa: F401, F403
+
+# fmt: off
+"""Format Guard"""
+from .cmd import main  # noqa: F401, I100, I202
+"""Format Guard"""
+# fmt on

spdx_python_model/bindings/v3_0_1/__main__.py

@@ -0,0 +1,12 @@
+#! /usr/bin/env python3
+#
+# This file was auto-generated by shacl2code 1.1.0. DO NOT MANUALLY MODIFY IT
+#
+# SPDX-License-Identifier: Apache-2.0
+
+import sys
+
+from .cmd import main
+
+if __name__ == "__main__":
+    sys.exit(main())

spdx_python_model/bindings/v3_0_1/cmd.py

@@ -0,0 +1,75 @@
+#! /usr/bin/env python3
+#
+# This file was auto-generated by shacl2code 1.1.0. DO NOT MANUALLY MODIFY IT
+#
+# SPDX-License-Identifier: Apache-2.0
+
+import argparse
+from pathlib import Path
+from typing import Any, Iterable, List
+
+from .model import (
+    JSONLDDeserializer,
+    JSONLDSerializer,
+    ListProxy,
+    SHACLObject,
+    SHACLObjectSet,
+)
+
+
+def print_tree(objects: Iterable[SHACLObject], all_fields: bool = False) -> None:
+    """
+    Print object tree
+    """
+    seen = set()
+
+    def callback(value: Any, path: List[str]) -> bool:
+        s = ("  " * (len(path) - 1)) + f"{path[-1]}"
+        if isinstance(value, SHACLObject):
+            s += f" {value} ({id(value)})"
+            is_empty = False
+        elif isinstance(value, ListProxy):
+            is_empty = len(value) == 0
+            if is_empty:
+                s += " []"
+        else:
+            s += f" {value!r}"
+            is_empty = value is None
+
+        if all_fields or not is_empty:
+            print(s)
+
+        if isinstance(value, SHACLObject):
+            if value in seen:
+                return False
+            seen.add(value)
+            return True
+
+        return True
+
+    for o in objects:
+        o.walk(callback)
+
+
+def main() -> int:
+    parser = argparse.ArgumentParser(description="Python SHACL model test")
+    parser.add_argument("infile", type=Path, help="Input file")
+    parser.add_argument("--print", action="store_true", help="Print object tree")
+    parser.add_argument("--outfile", type=Path, help="Output file")
+
+    args = parser.parse_args()
+
+    objectset = SHACLObjectSet()
+    with args.infile.open("r") as f:
+        d = JSONLDDeserializer()
+        d.read(f, objectset)
+
+    if args.print:
+        print_tree(objectset.objects)
+
+    if args.outfile:
+        with args.outfile.open("wb") as f:
+            s = JSONLDSerializer()
+            s.write(objectset, f)
+
+    return 0