thundergraph-model 1.4.4__tar.gz → 1.5.0__tar.gz

{thundergraph_model-1.4.4 → thundergraph_model-1.5.0}/PKG-INFO

@@ -1,7 +1,8 @@
-Metadata-Version: 2.3
+Metadata-Version: 2.4
 Name: thundergraph-model
-Version: 1.4.4
+Version: 1.5.0
 Summary: Executable systems modeling in Python
+License-File: LICENSE
 Requires-Python: >=3.11
 Requires-Dist: unitflow[numpy]>=0.2.0
 Provides-Extra: dev

{thundergraph_model-1.4.4 → thundergraph_model-1.5.0}/pyproject.toml

@@ -1,10 +1,10 @@
 [build-system]
-requires = ["hatchling>=1.24,<1.27"]
+requires = ["hatchling>=1.24"]
 build-backend = "hatchling.build"
 
 [project]
 name = "thundergraph-model"
-version = "1.4.4"
+version = "1.5.0"
 description = "Executable systems modeling in Python"
 readme = "PYPI.md"
 requires-python = ">=3.11"

{thundergraph_model-1.4.4 → thundergraph_model-1.5.0}/tests/unit/model/test_compile_types.py

@@ -210,3 +210,47 @@ class TestDeclaredNameAndDocInArtifact:
     def test_declared_name_accessible_via_class_attribute(self) -> None:
         Battery.compile()
         assert Battery._compiled_definition["declared_name"] == "battery"  # type: ignore[attr-defined]
+
+
+class TestDeclaredAnchorInArtifact:
+    """declared_anchor is preserved in the compiled artifact and is optional (v1.5.0)."""
+
+    def test_declared_anchor_in_artifact(self) -> None:
+        class AnchoredPart(Part):
+            @classmethod
+            def define(cls, model):  # type: ignore[override]
+                model.name("anchored_part")
+                model.anchor("an_7f3a2b")
+
+        result = AnchoredPart.compile()
+        assert result["declared_anchor"] == "an_7f3a2b"
+        AnchoredPart._reset_compilation()
+
+    def test_declared_anchor_is_none_when_not_declared(self) -> None:
+        # Anchor is optional; the field is present but None when unset.
+        result = Battery.compile()
+        assert "declared_anchor" in result
+        assert result["declared_anchor"] is None
+
+    def test_anchor_declared_twice_raises(self) -> None:
+        class DoubleAnchor(Part):
+            @classmethod
+            def define(cls, model):  # type: ignore[override]
+                model.name("double_anchor")
+                model.anchor("an_1")
+                model.anchor("an_2")
+
+        with pytest.raises(ModelDefinitionError, match="anchor"):
+            DoubleAnchor.compile()
+        DoubleAnchor._reset_compilation()
+
+    def test_declared_anchor_accessible_via_class_attribute(self) -> None:
+        class AttrAnchor(Part):
+            @classmethod
+            def define(cls, model):  # type: ignore[override]
+                model.name("attr_anchor")
+                model.anchor("an_attr")
+
+        AttrAnchor.compile()
+        assert AttrAnchor._compiled_definition["declared_anchor"] == "an_attr"  # type: ignore[attr-defined]
+        AttrAnchor._reset_compilation()

{thundergraph_model-1.4.4 → thundergraph_model-1.5.0}/tg_model/execution/configured_model.py

@@ -492,13 +492,6 @@ def _instantiate_children(
             _register(constraint_instance, path_registry, id_registry)
 
         elif kind == "citation":
-            sid = metadata.get("_sid")
-            if not sid:
-                raise ValueError(
-                    f"Citation '{name}' is missing a '_sid' field. "
-                    "Add a stable, unique string: model.citation('{name}', _sid='...', ...)"
-                )
-            metadata["_citation_stable_id"] = sid
             cite_instance = ElementInstance(
                 stable_id=child_id,
                 definition_type=parent.definition_type,
@@ -545,13 +538,6 @@ def _instantiate_requirement_block_children(
             package.add_member(name, req_instance)
             _register(req_instance, path_registry, id_registry)
         elif kind == "citation":
-            sid = metadata.get("_sid")
-            if not sid:
-                raise ValueError(
-                    f"Citation '{name}' is missing a '_sid' field. "
-                    "Add a stable, unique string: model.citation('{name}', _sid='...', ...)"
-                )
-            metadata["_citation_stable_id"] = sid
             cite_instance = ElementInstance(
                 stable_id=child_id,
                 definition_type=definition_root_type,

{thundergraph_model-1.4.4 → thundergraph_model-1.5.0}/tg_model/execution/stable_ids.py

@@ -87,22 +87,3 @@ def class_scoped_slot_sid(
             return f"class_slot:{cls.__module__}.{cls.__qualname__}:{local_name}"
 
     return None
-
-
-def class_scoped_citation_sid(element: "ElementInstance") -> str | None:
-    """Return the class-scoped stable_id for a citation element.
-
-    Citations are identified by a deterministic UUID assigned once at instantiation,
-    stored in the citation's metadata as ``_citation_stable_id``. This UUID is
-    independent of the citation's name, content, or position, allowing citations to
-    be renamed or edited without creating duplicate nodes.
-
-    Returns ``None`` only when the citation has no _citation_stable_id in metadata
-    (should not occur in a properly instantiated model).
-
-    Format: The raw UUID string assigned at instantiation time.
-    """
-    if not element.metadata:
-        return None
-    citation_uuid = element.metadata.get("_citation_stable_id")
-    return citation_uuid if isinstance(citation_uuid, str) else None

{thundergraph_model-1.4.4 → thundergraph_model-1.5.0}/tg_model/model/compile_types.py

@@ -153,6 +153,7 @@ def compile_type(
             "owner": qualified_name(element_cls),
             "declared_name": ctx._declared_name,
             "declared_doc": ctx._declared_doc,
+            "declared_anchor": ctx._declared_anchor,
             "nodes": {
                 name: {
                     "kind": decl.kind,

{thundergraph_model-1.4.4 → thundergraph_model-1.5.0}/tg_model/model/definition_context.py

@@ -360,6 +360,7 @@ class ModelDefinitionContext:
         self._frozen = False
         self._declared_name: str | None = None
         self._declared_doc: str | None = None
+        self._declared_anchor: str | None = None
 
     def _check_frozen(self) -> None:
         """Raise :class:`ModelDefinitionError` if :meth:`freeze` already ran."""
@@ -418,6 +419,32 @@ class ModelDefinitionContext:
             )
         self._declared_name = human_name
 
+    def anchor(self, anchor_id: str) -> None:
+        """Declare the durable, source-carried identity for this element.
+
+        The anchor is a permanent, opaque identifier assigned once and
+        preserved across renames and regeneration; element-linked data such as
+        comments key on it rather than on the element's name. It is optional in
+        authored source — the platform assigns one if absent — and is never
+        derived from the element's name.
+
+        Parameters
+        ----------
+        anchor_id : str
+            Opaque, stable identifier for this element.
+
+        Raises
+        ------
+        ModelDefinitionError
+            On second call or frozen context.
+        """
+        self._check_frozen()
+        if self._declared_anchor is not None:
+            raise ModelDefinitionError(
+                f"{self.owner_type.__name__}: model.anchor() called more than once"
+            )
+        self._declared_anchor = anchor_id
+
     def doc(self, text: str) -> None:
         """Declare the requirement statement text (required on every ``Requirement.define()``).