iii-sdk 0.19.0.dev4__tar.gz → 0.19.2.dev1__tar.gz

{iii_sdk-0.19.0.dev4 → iii_sdk-0.19.2.dev1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: iii-sdk
-Version: 0.19.0.dev4
+Version: 0.19.2.dev1
 Summary: III SDK for Python
 Project-URL: Homepage, https://github.com/iii-hq/iii
 Project-URL: Repository, https://github.com/iii-hq/iii
@@ -14,7 +14,7 @@ Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Requires-Python: >=3.10
-Requires-Dist: iii-observability==0.19.0.dev4
+Requires-Dist: iii-observability==0.19.2.dev1
 Requires-Dist: opentelemetry-api>=1.25
 Requires-Dist: pydantic>=2.0
 Requires-Dist: websockets>=12.0

{iii_sdk-0.19.0.dev4 → iii_sdk-0.19.2.dev1}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "iii-sdk"
-version = "0.19.0.dev4"
+version = "0.19.2.dev1"
 description = "III SDK for Python"
 authors = [{ name = "III" }]
 license = { text = "Apache-2.0" }
@@ -23,7 +23,7 @@ dependencies = [
     "websockets>=12.0",
     "pydantic>=2.0",
     "opentelemetry-api>=1.25",
-    "iii-observability==0.19.0.dev4",
+    "iii-observability==0.19.2.dev1",
 ]
 
 [project.urls]

{iii_sdk-0.19.0.dev4 → iii_sdk-0.19.2.dev1}/src/iii/iii.py

@@ -1235,7 +1235,7 @@ class III:
             ),
         }
 
-        return {
+        metadata: dict[str, Any] = {
             "runtime": "python",
             "version": sdk_version,
             "name": worker_name,
@@ -1244,6 +1244,11 @@ class III:
             "isolation": os.environ.get("III_ISOLATION") or None,
             "telemetry": telemetry,
         }
+        # Optional, like the other SDKs: only send `description` when set so the
+        # engine's `#[serde(default)]` field stays absent otherwise.
+        if self._options.worker_description:
+            metadata["description"] = self._options.worker_description
+        return metadata
 
     def _register_worker_metadata(self) -> None:
         msg = InvokeFunctionMessage(

{iii_sdk-0.19.0.dev4 → iii_sdk-0.19.2.dev1}/src/iii/iii_constants.py

@@ -47,6 +47,8 @@ class InitOptions:
 
     Attributes:
         worker_name: Display name for this worker. Defaults to ``hostname:pid``.
+        worker_description: One-line, human/LLM-readable summary of what this
+            worker does. Surfaces in ``engine::workers::list`` / ``engine::workers::info``.
         enable_metrics_reporting: Enable worker metrics via OpenTelemetry. Default ``True``.
         invocation_timeout_ms: Default timeout for ``trigger()`` in milliseconds. Default ``30000``.
         reconnection_config: WebSocket reconnection behavior.
@@ -56,6 +58,7 @@ class InitOptions:
     """
 
     worker_name: str | None = None
+    worker_description: str | None = None
     enable_metrics_reporting: bool = True
     invocation_timeout_ms: int = DEFAULT_INVOCATION_TIMEOUT_MS
     reconnection_config: ReconnectionConfig | None = None

{iii_sdk-0.19.0.dev4 → iii_sdk-0.19.2.dev1}/tests/test_worker_metadata.py

@@ -47,6 +47,18 @@ def test_get_worker_metadata_forwards_iii_isolation_env_var(
     assert metadata["isolation"] == "docker"
 
 
+def test_get_worker_metadata_omits_description_when_unset() -> None:
+    metadata = _call_metadata_method()
+
+    assert "description" not in metadata
+
+
+def test_get_worker_metadata_includes_worker_description_when_set() -> None:
+    metadata = _call_metadata_method(InitOptions(worker_description="resizes images"))
+
+    assert metadata["description"] == "resizes images"
+
+
 @requires_tomllib
 def test_detect_project_name_reads_pyproject_name(tmp_path: Path) -> None:
     (tmp_path / "pyproject.toml").write_text('[project]\nname = "my-pkg"\n')