thundergraph-model 1.2.0__tar.gz → 1.2.1__tar.gz

{thundergraph_model-1.2.0 → thundergraph_model-1.2.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: thundergraph-model
-Version: 1.2.0
+Version: 1.2.1
 Summary: Executable systems modeling in Python
 License-File: LICENSE
 Requires-Python: >=3.11

thundergraph_model-1.2.1/docs/release/v1.2.1.md

@@ -0,0 +1,55 @@
+# v1.2.1 Release Notes
+
+## Summary
+
+Patch release. No breaking changes. No new authoring API.
+
+---
+
+## Bug fix: `declared_name` and `declared_doc` now preserved in the compiled artifact
+
+**Problem**
+
+`model.name(str)` and `model.doc(str)` were stored exclusively in
+`ModelDefinitionContext._declared_name` / `._declared_doc` during `define()`.
+After `compile_type()` ran, the context was discarded and those values were lost.
+The compiled artifact (`cls._compiled_definition`) did not include them, so there
+was no way to retrieve the human-readable name or documentation text after
+compilation without re-running `define()`.
+
+**Fix**
+
+The compiled artifact now includes two new keys:
+
+| Key | Type | Description |
+|---|---|---|
+| `declared_name` | `str` | The string passed to `model.name(...)`. Always present; validated as required by `_validate_name_and_doc_required`. |
+| `declared_doc` | `str \| None` | The string passed to `model.doc(...)`. Set on `Requirement` subclasses; `None` for `Part` and `System`. |
+
+**Reading the values**
+
+```python
+cd = MyPart.compile()
+name = cd["declared_name"]      # e.g. "hpc_colo_facility"
+doc  = cd["declared_doc"]       # None for Part/System
+
+cd = MyRequirement.compile()
+name = cd["declared_name"]      # e.g. "grid_import_capacity"
+doc  = cd["declared_doc"]       # e.g. "The aggregate facility electrical load shall..."
+```
+
+For `RequirementPackageInstance` objects produced by `instantiate()`, the declaring
+class is `obj.package_type`, not `obj.definition_type`:
+
+```python
+from tg_model.execution.instances import RequirementPackageInstance
+
+if isinstance(instance, RequirementPackageInstance):
+    name = instance.package_type._compiled_definition["declared_name"]
+    doc  = instance.package_type._compiled_definition["declared_doc"]
+```
+
+**Compatibility**
+
+Fully backward-compatible. Existing code that reads the artifact by key (e.g. `artifact["nodes"]`,
+`artifact["edges"]`) is unaffected. The two new keys are additive.

{thundergraph_model-1.2.0 → thundergraph_model-1.2.1}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "thundergraph-model"
-version = "1.2.0"
+version = "1.2.1"
 description = "Executable systems modeling in Python"
 readme = "PYPI.md"
 requires-python = ">=3.11"

{thundergraph_model-1.2.0 → thundergraph_model-1.2.1}/tests/unit/model/test_compile_types.py

@@ -169,3 +169,44 @@ class TestInvalidConnections:
         with pytest.raises(ModelDefinitionError, match="not a port"):
             BadSystem2.compile()
         BadSystem2._reset_compilation()
+
+
+class TestDeclaredNameAndDocInArtifact:
+    """declared_name and declared_doc are preserved in the compiled artifact (v1.2.1)."""
+
+    def test_part_declared_name_in_artifact(self) -> None:
+        result = Battery.compile()
+        assert result["declared_name"] == "battery"
+
+    def test_system_declared_name_in_artifact(self) -> None:
+        result = DriveSystem.compile()
+        assert result["declared_name"] == "drive_system"
+
+    def test_part_declared_doc_is_none(self) -> None:
+        # Parts and Systems have no doc requirement; field is present but None.
+        result = Battery.compile()
+        assert "declared_doc" in result
+        assert result["declared_doc"] is None
+
+    def test_requirement_declared_name_and_doc_in_artifact(self) -> None:
+        from tg_model.model.elements import Requirement
+
+        class LoadRequirement(Requirement):
+            @classmethod
+            def define(cls, model):  # type: ignore[override]
+                model.name("load_requirement")
+                model.doc("The system shall not exceed the declared load limit.")
+
+        result = LoadRequirement.compile()
+        assert result["declared_name"] == "load_requirement"
+        assert result["declared_doc"] == "The system shall not exceed the declared load limit."
+        LoadRequirement._reset_compilation()
+
+    def test_declared_name_present_after_reset_and_recompile(self) -> None:
+        Battery._reset_compilation()
+        result = Battery.compile()
+        assert result["declared_name"] == "battery"
+
+    def test_declared_name_accessible_via_class_attribute(self) -> None:
+        Battery.compile()
+        assert Battery._compiled_definition["declared_name"] == "battery"  # type: ignore[attr-defined]

{thundergraph_model-1.2.0 → thundergraph_model-1.2.1}/tg_model/model/compile_types.py

@@ -151,6 +151,8 @@ def compile_type(
 
         artifact: dict[str, Any] = {
             "owner": qualified_name(element_cls),
+            "declared_name": ctx._declared_name,
+            "declared_doc": ctx._declared_doc,
             "nodes": {
                 name: {
                     "kind": decl.kind,

{thundergraph_model-1.2.0 → thundergraph_model-1.2.1}/uv.lock

@@ -1815,7 +1815,7 @@ wheels = [
 
 [[package]]
 name = "thundergraph-model"
-version = "1.2.0"
+version = "1.2.1"
 source = { editable = "." }
 dependencies = [
     { name = "unitflow", extra = ["numpy"] },