graphddb-runtime 0.3.1__tar.gz → 0.4.1__tar.gz

{graphddb_runtime-0.3.1 → graphddb_runtime-0.4.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: graphddb-runtime
-Version: 0.3.1
+Version: 0.4.1
 Summary: Thin DynamoDB executor for GraphDDB-generated Python repositories (single-operation core, issue #44).
 License: MIT
 Requires-Python: >=3.9

{graphddb_runtime-0.3.1 → graphddb_runtime-0.4.1}/graphddb_runtime.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: graphddb-runtime
-Version: 0.3.1
+Version: 0.4.1
 Summary: Thin DynamoDB executor for GraphDDB-generated Python repositories (single-operation core, issue #44).
 License: MIT
 Requires-Python: >=3.9

{graphddb_runtime-0.3.1 → graphddb_runtime-0.4.1}/graphddb_runtime.egg-info/SOURCES.txt

@@ -22,6 +22,7 @@ graphddb_runtime.egg-info/requires.txt
 graphddb_runtime.egg-info/top_level.txt
 tests/test_concurrency.py
 tests/test_contract_runtime.py
+tests/test_description.py
 tests/test_integration.py
 tests/test_integration_command.py
 tests/test_integration_compose.py

{graphddb_runtime-0.3.1 → graphddb_runtime-0.4.1}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "graphddb-runtime"
-version = "0.3.1"
+version = "0.4.1"
 description = "Thin DynamoDB executor for GraphDDB-generated Python repositories (single-operation core, issue #44)."
 readme = "README.md"
 requires-python = ">=3.9"

graphddb_runtime-0.4.1/tests/test_description.py

@@ -0,0 +1,78 @@
+"""Issue #154: the description taken in on the TS declaration sites is propagated
+into the generated artifacts the Python bridge consumes — manifest.json (entity /
+field), operations.json (query / command / param / contract method), and the
+generated Python source docstrings (class docstring, field comment, method
+docstring). An undescribed declaration carries no `description` key (backward
+compatible). TS↔Python parity holds because both read the SAME serialized string.
+"""
+
+from __future__ import annotations
+
+import ast
+import json
+import os
+
+import conftest
+
+REPOSITORIES_PATH = os.path.join(conftest.FIXTURES_DIR, "repositories.py")
+TYPES_PATH = os.path.join(conftest.FIXTURES_DIR, "types.py")
+
+
+def _manifest() -> dict:
+    with open(conftest.MANIFEST_PATH, encoding="utf-8") as fh:
+        return json.load(fh)
+
+
+def _operations() -> dict:
+    with open(conftest.OPERATIONS_PATH, encoding="utf-8") as fh:
+        return json.load(fh)
+
+
+def test_manifest_carries_entity_and_field_description() -> None:
+    group = _manifest()["entities"]["GroupModel"]
+    assert group["description"] == "A group that users belong to."
+    assert group["fields"]["groupId"]["description"] == "The group unique identifier."
+    # A field without a declared description carries no `description` key.
+    assert "description" not in group["fields"]["name"]
+
+
+def test_operations_carries_query_param_and_contract_description() -> None:
+    ops = _operations()
+    get_group = ops["queries"]["getGroup"]
+    assert get_group["description"] == "Fetch a single group by its id."
+    assert get_group["params"]["groupId"]["description"] == "The group id to fetch."
+    # The contract method description rides the `contracts` map.
+    method = ops["contracts"]["GroupById"]["methods"]["get"]
+    assert method["description"] == "Read a group by its id."
+
+
+def test_undescribed_query_has_no_description_key() -> None:
+    # `getUser` declares no description — backward compatible.
+    get_user = _operations()["queries"]["getUser"]
+    assert "description" not in get_user
+
+
+def test_generated_python_source_is_valid_and_carries_docstrings() -> None:
+    with open(TYPES_PATH, encoding="utf-8") as fh:
+        types_src = fh.read()
+    with open(REPOSITORIES_PATH, encoding="utf-8") as fh:
+        repos_src = fh.read()
+
+    # The generated source must remain syntactically valid Python.
+    ast.parse(types_src)
+    ast.parse(repos_src)
+
+    # Class docstring (from the @model description) + field comment (field desc).
+    assert '"""A group that users belong to."""' in types_src
+    assert "# The group unique identifier." in types_src
+
+    # Method docstring (from the query description) on the generated repo method.
+    assert '"""Fetch a single group by its id."""' in repos_src
+
+
+def test_ts_python_description_parity_for_contract_method() -> None:
+    # The Python side reads the SAME serialized description the TS IR produced; if
+    # they ever diverged this string would differ. (The TS-side equality is asserted
+    # in __tests__/spec/description.test.ts; here we lock the Python-visible value.)
+    method = _operations()["contracts"]["GroupById"]["methods"]["get"]
+    assert method["description"] == "Read a group by its id."