dirigent-plugin 0.16.6__tar.gz → 0.16.7__tar.gz

{dirigent_plugin-0.16.6 → dirigent_plugin-0.16.7}/PKG-INFO

@@ -1,12 +1,12 @@
 Metadata-Version: 2.4
 Name: dirigent-plugin
-Version: 0.16.6
+Version: 0.16.7
 Summary: The dirigent plugin contract: block specs, protocols, and markers.
 License-Expression: LicenseRef-Proprietary
 License-File: LICENSE
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.13
-Requires-Dist: dirigent-common==0.16.6
+Requires-Dist: dirigent-common==0.16.7
 Requires-Dist: httpx2>=2.12.0
 Requires-Dist: pluginkit>=0.5.0
 Requires-Dist: pydantic>=2.13.5

{dirigent_plugin-0.16.6 → dirigent_plugin-0.16.7}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "dirigent-plugin"
-version = "0.16.6"
+version = "0.16.7"
 description = "The dirigent plugin contract: block specs, protocols, and markers."
 readme = "README.md"
 requires-python = ">=3.13"
@@ -11,7 +11,7 @@ classifiers = [
     "Programming Language :: Python :: 3.13",
 ]
 dependencies = [
-    "dirigent-common==0.16.6",
+    "dirigent-common==0.16.7",
     "httpx2>=2.12.0",
     "pluginkit>=0.5.0",
     "pydantic>=2.13.5",

{dirigent_plugin-0.16.6 → dirigent_plugin-0.16.7}/pyproject.toml.orig

@@ -1,6 +1,6 @@
 [project]
 name = "dirigent-plugin"
-version = "0.16.6"
+version = "0.16.7"
 description = "The dirigent plugin contract: block specs, protocols, and markers."
 readme = "README.md"
 requires-python = ">=3.13"
@@ -11,7 +11,7 @@ classifiers = [
     "Programming Language :: Python :: 3.13",
 ]
 dependencies = [
-    "dirigent-common==0.16.6",
+    "dirigent-common==0.16.7",
     "httpx2>=2.12.0",
     "pluginkit>=0.5.0",
     "pydantic>=2.13.5",

{dirigent_plugin-0.16.6 → dirigent_plugin-0.16.7}/src/dirigent_plugin/__init__.py

@@ -22,12 +22,14 @@ from dirigent_plugin.blocks import (
     OperatorSpec,
     ProbeResult,
     ProbeStatus,
+    Reference,
     RemoteHandle,
     RunId,
     RunRefused,
     Runs,
     RunSnapshot,
     RunState,
+    SchemaRef,
     Sensor,
     SensorSpec,
     ShellString,
@@ -92,6 +94,7 @@ __all__ = [
     "ProbeResult",
     "ProbeStatus",
     "ProgramConfig",
+    "Reference",
     "RemoteHandle",
     "RunId",
     "RunRefused",
@@ -99,6 +102,7 @@ __all__ = [
     "RunState",
     "Runs",
     "SURFACE_ID_PATTERN",
+    "SchemaRef",
     "Sensor",
     "SensorSpec",
     "SHELL_VARIABLES_FIELD",

{dirigent_plugin-0.16.6 → dirigent_plugin-0.16.7}/src/dirigent_plugin/blocks.py

@@ -6,7 +6,7 @@ from contextlib import AbstractAsyncContextManager
 from datetime import datetime, timedelta
 from enum import StrEnum
 from pathlib import Path
-from typing import Annotated, Any, ClassVar, Final, Protocol, cast
+from typing import Annotated, Any, ClassVar, Final, Literal, Protocol, cast
 from uuid import UUID
 
 import httpx2
@@ -19,9 +19,6 @@ from dirigent_common import API_VERSION, SHELL_MEDIA_TYPE, BlockModel, HealthRep
 
 type RunId = UUID
 
-#: A connection is referenced by name, never by id, so documents stay portable.
-type ConnectionRef = str
-
 #: A JSON Schema format checker: a predicate that returns True when a value satisfies the
 #: format, False when it does not, and may instead raise to signal the value is invalid --
 #: exactly what ``jsonschema.FormatChecker.checks`` registers.
@@ -132,6 +129,43 @@ class ShellString:
         return published
 
 
+class Reference:
+    """Marks a config field whose value is the code of another thing this instance holds.
+
+    It publishes ``x-dirigent-ref`` carrying what the code names, and a form generated from the
+    schema draws that thing under the field. It is a bare class rather than a model: annotation
+    metadata pydantic recognises as a model would be read as the field's schema, and a marker
+    must stay invisible to validation.
+    """
+
+    __slots__ = ("kind",)
+
+    def __init__(self, kind: Literal["connection", "schema"]) -> None:
+        """Record what a value of the marked field names."""
+        self.kind = kind
+
+    def __repr__(self) -> str:
+        """Render the marker the way it is written."""
+        return f"Reference({self.kind!r})"
+
+    def __get_pydantic_json_schema__(
+        self,
+        schema: CoreSchema,
+        handler: GetJsonSchemaHandler,
+    ) -> JsonSchemaValue:
+        """Publish what the marked field's code names, leaving what it validates untouched."""
+        published = handler(schema)
+        published["x-dirigent-ref"] = self.kind
+        return published
+
+
+#: A connection is referenced by code, never by id, so documents stay portable.
+type ConnectionRef = Annotated[str, Reference("connection")]
+
+#: A schema is referenced by code: one the instance holds, or one the document carries.
+type SchemaRef = Annotated[str, Reference("schema")]
+
+
 #: What the engine names the variables it substitutes a shell string's references out into.
 SHELL_VARIABLE_PREFIX: Final = "DIRIGENT_V"