shacl2code 1.0.1__tar.gz → 1.1.0__tar.gz

{shacl2code-1.0.1 → shacl2code-1.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: shacl2code
-Version: 1.0.1
+Version: 1.1.0
 Summary: Convert SHACL model file to code bindings
 Project-URL: Homepage, https://github.com/JPEWdev/shacl2code
 Project-URL: Repository, https://github.com/JPEWdev/shacl2code.git

{shacl2code-1.0.1 → shacl2code-1.1.0}/src/shacl2code/lang/python.py

@@ -36,6 +36,30 @@ DATATYPE_PYTHON_TYPES = {
 }
 
 
+SHACLOBJECT_RESERVED_WORDS = {
+    "AUTO_NAMED_INDIVIDUALS",
+    "CLASSES",
+    "COMPACT_TYPE",
+    "ID_ALIAS",
+    "IS_ABSTRACT",
+    "IS_DEPRECATED",
+    "NAMED_INDIVIDUALS",
+    "NODE_KIND",
+    "PROPERTIES",
+    "TYPE",
+    "decode",
+    "encode",
+    "get_compact_type",
+    "get_id",
+    "get_type",
+    "iter_objects",
+    "link_helper",
+    "property_keys",
+    "set_id",
+    "walk",
+}
+
+
 def varname(*name):
     """Make a valid Python variable name."""
     name = "_".join(name)
@@ -45,8 +69,8 @@ def varname(*name):
     name = re.sub(r"[^a-zA-Z0-9_]", "_", name)
     # Consolidate runs of "_" to a single one
     name = re.sub(r"__+", "_", name)
-    # Add a _ to anything that is a python keyword
-    while keyword.iskeyword(name):
+    # Append '_' to avoid collisions with Python or SHACLObject keywords
+    while keyword.iskeyword(name) or name in SHACLOBJECT_RESERVED_WORDS:
         name = name + "_"
     return name
 

{shacl2code-1.0.1 → shacl2code-1.1.0}/src/shacl2code/lang/templates/python/model.py.j2

@@ -1008,6 +1008,18 @@ class SHACLObject(metaclass=SHACLObjectMeta):
         for k, v in kwargs.items():
             setattr(self, k, v)
 
+    def get_id(self) -> Optional[str]:
+        """Return the IRI or blank node ID of this object, or None if not set."""
+        return self._id
+
+    def set_id(self, value: Optional[str]) -> None:
+        """Set the IRI or blank node ID of this object,
+        or clear it if value is None."""
+        if value is None:
+            del self._id
+        else:
+            self._id = value
+
     def get_type(self) -> str:
         """Return the fully qualified IRI type of this object."""
         return self._TYPE
@@ -1546,6 +1558,22 @@ class SHACLObjectSet(object):
             self.add_index(obj)
         return obj
 
+    def remove(self, obj: SHACLObject) -> None:
+        """
+        Remove object from object set
+
+        Remove a SHACLObject from the object set and rebuild index.
+
+        NOTE: If the object is still referenced by another object in
+        the object set, it will remain indexed
+        """
+        if not isinstance(obj, SHACLObject):
+            raise TypeError("Object is not of type SHACLObject")
+
+        if obj in self.objects:
+            self.objects.remove(obj)
+            self.create_index()
+
     def update(self, *others: Iterable[SHACLObject]) -> None:
         """
         Update object set adding all objects in each other iterable

{shacl2code-1.0.1 → shacl2code-1.1.0}/src/shacl2code/lang/templates/python/model.pyi.j2

@@ -233,6 +233,18 @@ class ClassProp:
     deprecated: bool = ...
 
 
+class EncodeState: ...
+
+
+class DecodeState: ...
+
+
+class Encoder(ABC): ...
+
+
+class Decoder(ABC): ...
+
+
 T_SHACLObject = TypeVar("T_SHACLObject", bound="SHACLObject")
 
 
@@ -249,6 +261,8 @@ class SHACLObject:
     PROPERTIES: ClassVar[List[ClassProp]]
 
     def __init__(self, **kwargs: Any) -> None: ...
+    def get_id(self) -> Optional[str]: ...
+    def set_id(self, value: Optional[str]) -> None: ...
     def get_type(self) -> str: ...
     def get_compact_type(self) -> Optional[str]: ...
     def __getitem__(self, iri: str) -> Any: ...
@@ -264,6 +278,19 @@ class SHACLObject:
     def iter_objects(
         self, *, recursive: bool = False, visited: Optional[Set[SHACLObject]] = None
     ) -> Iterable[SHACLObject]: ...
+    def encode(self, encoder: "Encoder", state: "EncodeState") -> None: ...
+    @classmethod
+    def _make_object(cls: Type[T_SHACLObject], typ: str) -> SHACLObject: ...
+    @classmethod
+    def decode(
+        cls: Type[T_SHACLObject], decoder: "Decoder", state: "DecodeState"
+    ) -> SHACLObject: ...
+    def link_helper(
+        self,
+        objectset: SHACLObjectSet,
+        missing: Optional[Set[str]],
+        visited: Set[SHACLObject],
+    ) -> None: ...
     def __hash__(self) -> int: ...
     def __eq__(self, other: Any) -> bool: ...
     def __lt__(self, other: Any) -> bool: ...
@@ -297,6 +324,7 @@ class SHACLObjectSet:
     def create_index(self) -> None: ...
     def add_index(self, obj: SHACLObject) -> None: ...
     def add(self, obj: T_SHACLObject) -> T_SHACLObject: ...
+    def remove(self, obj: SHACLObject) -> None: ...
     def update(self, *others: Iterable[SHACLObject]) -> None: ...
     def __contains__(self, item: SHACLObject) -> bool: ...
     def link(self) -> Set[str]: ...
@@ -316,6 +344,14 @@ class SHACLObjectSet:
     def inline_blank_nodes(self) -> None: ...
     def expand_iri(self, iri: str, default: Optional[str] = None) -> Optional[str]: ...
     def compact_iri(self, iri: str, default: Optional[str] = None) -> Optional[str]: ...
+    def encode(
+        self, encoder: "Encoder", state: "EncodeState", force_at_graph: bool = False
+    ) -> None: ...
+    def decode(
+        self,
+        decoder: "Decoder",
+        state: Optional["DecodeState"] = None,
+    ) -> None: ...
 
 
 class JSONLDDeserializer:
@@ -403,8 +439,14 @@ class {{ varname(*class.clsname) }}(
 
     def __init__(
         self,
-        {%- if class.properties %}
+        {%- if class.is_extensible %}
+        typ: Optional[str] = None,
+        {%- endif %}
+        {%- if class.id_property or class.properties %}
         *,
+        {%- if class.id_property %}
+        {{ class.id_property }}: Optional[str] = None,
+        {%- endif %}
         {%- for prop in class.properties %}
         {%- set is_list = prop.max_count is none or prop.max_count != 1 %}
         {%- if prop.enum_values %}
@@ -424,6 +466,9 @@ class {{ varname(*class.clsname) }}(
         **kwargs: Any
     ) -> None: ...
 
+    {%- if class.id_property %}
+    {{ class.id_property }}: Optional[str]
+    {%- endif %}
     {%- for prop in class.properties %}
         {%- set is_list = prop.max_count is none or prop.max_count != 1 %}
         {%- if prop.enum_values %}
@@ -433,7 +478,14 @@ class {{ varname(*class.clsname) }}(
         {%- else %}
         {%- set ptype = DATATYPE_PYTHON_TYPES[prop.datatype] %}
         {%- endif %}
-    {{ varname(prop.varname) }}: {% if is_list %}ListProxy[{{ ptype }}]{% else %}Optional[{{ ptype }}]{% endif %}
+        {%- if is_list %}
+    @property
+    def {{ varname(prop.varname) }}(self) -> ListProxy[{{ ptype }}]: ...
+    @{{ varname(prop.varname) }}.setter
+    def {{ varname(prop.varname) }}(self, value: Iterable[{{ ptype }}]) -> None: ...
+        {%- else %}
+    {{ varname(prop.varname) }}: Optional[{{ ptype }}]
+        {%- endif %}
     {%- endfor %}
 
 {% endfor %}

shacl2code-1.1.0/src/shacl2code/version.py

@@ -0,0 +1 @@
+VERSION = "1.1.0"

shacl2code-1.1.0/tests/data/reserved-words.ttl

@@ -0,0 +1,34 @@
+@base <http://example.org/reserved#> .
+@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
+@prefix sh: <http://www.w3.org/ns/shacl#> .
+@prefix owl: <http://www.w3.org/2002/07/owl#> .
+@prefix xsd: <http://www.w3.org/2001/XMLSchema#> .
+
+# A class whose properties collide with SHACLObject keywords.
+
+<test-rw-class> a rdfs:Class, sh:NodeShape, owl:Class;
+    sh:property [
+        sh:datatype xsd:string ;
+        sh:name "get_id" ;
+        sh:path <prop/get_id> ;
+        sh:maxCount 1
+    ],
+    [
+        sh:datatype xsd:string ;
+        sh:name "set_id" ;
+        sh:path <prop/set_id> ;
+        sh:maxCount 1
+    ],
+    [
+        sh:datatype xsd:string ;
+        sh:name "encode" ;
+        sh:path <prop/encode> ;
+        sh:maxCount 1
+    ],
+    [
+        sh:datatype xsd:string ;
+        sh:name "class" ;
+        sh:path <prop/class> ;
+        sh:maxCount 1
+    ]
+    .

{shacl2code-1.0.1 → shacl2code-1.1.0}/tests/test_python.py

@@ -679,6 +679,11 @@ def test_node_kind_iri(model, test_context_url, cls):
     ["id_prop_class", "inherited_id_prop_class"],
 )
 def test_id_name(model, test_context_url, cls):
+    """
+    Test that alternate ID property names work correctly,
+    including serialization and initialization.
+    """
+
     s = model.JSONLDSerializer()
     c = getattr(model, cls)()
 
@@ -696,7 +701,7 @@ def test_id_name(model, test_context_url, cls):
     assert c.testid is None
     assert c._id is None
 
-    # Serialization should the alias name
+    # Serialization should use the alias name
     c._id = TEST_ID
     result = s.serialize_data(model.SHACLObjectSet([c]))
     assert result == {
@@ -705,6 +710,69 @@ def test_id_name(model, test_context_url, cls):
         "testid": TEST_ID,
     }
 
+    # Test initialization using ID alias
+    c2 = getattr(model, cls)(testid=TEST_ID)
+    assert c2.get_id() == TEST_ID
+    assert c2.testid == TEST_ID
+
+
+def test_get_id_none(model):
+    """get_id returns None when no ID is set."""
+    c = model.test_class()
+    assert c.get_id() is None
+
+
+def test_get_id_set(model):
+    """get_id returns the assigned IRI."""
+    c = model.test_class()
+    c._id = "http://example.com/obj"
+    assert c.get_id() == "http://example.com/obj"
+
+
+def test_set_id(model):
+    """set_id assigns the IRI."""
+    c = model.test_class()
+    c.set_id("http://example.com/obj")
+    assert c._id == "http://example.com/obj"
+    assert c.get_id() == "http://example.com/obj"
+
+
+def test_set_id_none(model):
+    """set_id(None) clears the ID."""
+    c = model.test_class()
+    c.set_id("http://example.com/obj")
+    c.set_id(None)
+    assert c.get_id() is None
+    assert c._id is None
+
+
+def test_set_id_roundtrip(model, test_context_url):
+    """Object serialized with set_id value encodes correct @id."""
+    s = model.JSONLDSerializer()
+    c = model.test_class()
+    c.set_id("http://example.com/set-id-obj")
+    result = s.serialize_data(model.SHACLObjectSet([c]))
+    assert result["@id"] == "http://example.com/set-id-obj"
+
+
+@pytest.mark.parametrize("cls", ["id_prop_class", "inherited_id_prop_class"])
+def test_get_id_with_alias(model, cls):
+    """get_id returns ID set via alias property."""
+    # id-prop-class is a class with an ID alias "testid"
+    c = getattr(model, cls)()
+    c.testid = "http://example.com/alias-obj"
+    assert c.get_id() == "http://example.com/alias-obj"
+
+
+@pytest.mark.parametrize("cls", ["id_prop_class", "inherited_id_prop_class"])
+def test_set_id_with_alias(model, cls):
+    """set_id makes ID accessible through alias property."""
+    # id-prop-class is a class with an ID alias "testid"
+    c = getattr(model, cls)()
+    c.set_id("http://example.com/alias-obj")
+    assert c.testid == "http://example.com/alias-obj"
+    assert c.get_id() == "http://example.com/alias-obj"
+
 
 SAME_AS_VALUE = object()
 
@@ -1740,6 +1808,44 @@ def test_objset_foreach_type(model, roundtrip):
     assert set(objset.foreach_type(model.abstract_class, match_subclass=True)) == expect
 
 
+def test_objset_remove(model):
+    """
+    Tests that removing an object from the object set works correctly
+    """
+    obj1 = model.test_class(_id="https://example.org/obj1")
+    obj2 = model.test_class(_id="https://example.org/obj2")
+
+    objset = model.SHACLObjectSet([obj1, obj2])
+    assert obj1 in objset
+    assert obj2 in objset
+
+    objset.remove(obj1)
+
+    assert obj1 not in objset
+    assert obj2 in objset
+
+
+def test_objset_remove_not_existing(model):
+    """
+    Tests that removing an object that is not in the object set does not
+    raise an error. It should just do nothing silently.
+    """
+    obj = model.test_class(_id="https://example.org/obj")
+    objset = model.SHACLObjectSet()
+
+    objset.remove(obj)
+
+
+def test_objset_remove_invalid_type(model):
+    """
+    Tests that removing an object that is not a SHACLObject raises a TypeError
+    """
+    objset = model.SHACLObjectSet()
+
+    with pytest.raises(TypeError):
+        objset.remove("not-a-shacl-object")
+
+
 @pytest.mark.parametrize(
     "abstract,concrete",
     [
@@ -1865,6 +1971,56 @@ def test_slots_no(tmp_path):
     assert "_USE_SLOTS = False" in text
 
 
+RESERVED_WORDS_MODEL = DATA_DIR / "reserved-words.ttl"
+
+
+def test_varname_reserved_words(tmp_path):
+    """
+    varname() must append '_' to property names that collide with
+    SHACLOBJECT_RESERVED_WORDS or Python keywords so that the generated
+    ClassProp pyname, the __init__ kwargs, and _OBJ_PY_PROPS keys all agree.
+    """
+    output_dir = tmp_path / "temp_rwmodel"
+    shacl2code_generate(["--input", RESERVED_WORDS_MODEL], [], output_dir)
+
+    # Generated source must contain the renamed names, not the originals
+    text = (output_dir / "model.py").read_text()
+    for renamed in ("get_id_", "set_id_", "encode_", "class_"):
+        assert (
+            renamed in text
+        ), f"expected renamed property '{renamed}' in generated code"
+    for original in ('"get_id"', '"set_id"', '"encode"', '"class"'):
+        assert (
+            f"ClassProp({original}," not in text
+        ), f"unrenamed property {original} found as ClassProp pyname"
+
+    # Import the generated module and exercise the renamed properties
+    old_path = sys.path[:]
+    sys.path.append(str(tmp_path))
+    try:
+        import temp_rwmodel as m  # noqa: PLC0415
+
+        cls = m.SHACLObject.CLASSES["http://example.org/test-rw-class"]
+
+        # Renamed kwargs must work at construction time
+        obj = cls(get_id_="a", set_id_="b", encode_="c", class_="d")
+        assert obj.get_id_ == "a"
+        assert obj.set_id_ == "b"
+        assert obj.encode_ == "c"
+        assert obj.class_ == "d"
+
+        # SHACLObject.get_id() must still return the object IRI,
+        # not the value of the prop (get_id_)
+        assert obj.get_id() is None
+        obj.set_id("http://example.org/obj")
+        assert obj.get_id() == "http://example.org/obj"
+    finally:
+        sys.path = old_path
+        for mod in list(sys.modules):
+            if mod == "rwmodel" or mod.startswith("rwmodel."):
+                del sys.modules[mod]
+
+
 def test_extensible_properties(model, model_context_url):
 
     class Extension(model.extensible_class):
@@ -2113,6 +2269,9 @@ def test_introspection_extensible(model):
 
 
 def test_version(model):
+    """
+    Tests that the version string is correctly mapped.
+    """
     from shacl2code.util import convert_version_string
 
     assert model.VERSION_STRING == MODEL_VERSION

shacl2code-1.0.1/src/shacl2code/version.py

@@ -1 +0,0 @@
-VERSION = "1.0.1"