code0-hercules 1.7.2__tar.gz → 1.9.0__tar.gz

{code0_hercules-1.7.2 → code0_hercules-1.9.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: code0-hercules
-Version: 1.7.2
+Version: 1.9.0
 Summary: Python SDK for the hercules action runner
 License-Expression: MIT
 Project-URL: Repository, https://github.com/code0-tech/hercules
@@ -8,7 +8,7 @@ Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 Requires-Dist: grpcio>=1.64
 Requires-Dist: protobuf>=5.0
-Requires-Dist: tucana>=0.0.83
+Requires-Dist: tucana>=0.0.86
 Requires-Dist: pydantic>=2
 Provides-Extra: codegen
 Requires-Dist: datamodel-code-generator>=0.25; extra == "codegen"

{code0_hercules-1.7.2 → code0_hercules-1.9.0}/code0_hercules.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: code0-hercules
-Version: 1.7.2
+Version: 1.9.0
 Summary: Python SDK for the hercules action runner
 License-Expression: MIT
 Project-URL: Repository, https://github.com/code0-tech/hercules
@@ -8,7 +8,7 @@ Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 Requires-Dist: grpcio>=1.64
 Requires-Dist: protobuf>=5.0
-Requires-Dist: tucana>=0.0.83
+Requires-Dist: tucana>=0.0.86
 Requires-Dist: pydantic>=2
 Provides-Extra: codegen
 Requires-Dist: datamodel-code-generator>=0.25; extra == "codegen"

{code0_hercules-1.7.2 → code0_hercules-1.9.0}/code0_hercules.egg-info/requires.txt

@@ -1,6 +1,6 @@
 grpcio>=1.64
 protobuf>=5.0
-tucana>=0.0.83
+tucana>=0.0.86
 pydantic>=2
 
 [codegen]

{code0_hercules-1.7.2 → code0_hercules-1.9.0}/hercules/internal/literal.py

@@ -25,7 +25,7 @@ _SOLE_REFERENCE_PATTERN = re.compile(r"\A\$\{([^}]+)\}\Z")
 
 
 def to_sub_flow_caller(action, sub_flow):
-    """Wrap a sub flow value in an awaitable caller exposing its declared I/O schema."""
+    """Wrap a sub flow value in an awaitable caller exposing its declared metadata."""
 
     async def caller(*args):
         return await action.execute_sub_flow(sub_flow, *args)
@@ -33,6 +33,12 @@ def to_sub_flow_caller(action, sub_flow):
     # Expose the sub flow's declared I/O so the handler can inspect it.
     caller.input_schema = sub_flow.input_schema
     caller.output_schema = sub_flow.output_schema
+    # ``name``/``description`` are ``optional`` on the wire, so an unset field is
+    # surfaced as ``None`` rather than protobuf's empty-string default.
+    caller.name = sub_flow.name if sub_flow.HasField("name") else None
+    caller.description = (
+        sub_flow.description if sub_flow.HasField("description") else None
+    )
     return caller
 
 

{code0_hercules-1.7.2 → code0_hercules-1.9.0}/hercules/types.py

@@ -42,12 +42,15 @@ class SubFlow(Protocol):
 
     Call it with the sub flow's parameters to execute it and await its result.
     The input/output schema declared for the sub flow by the caller are exposed
-    via :attr:`input_schema` / :attr:`output_schema` (either may be ``None`` if
-    the caller omitted it).
+    via :attr:`input_schema` / :attr:`output_schema`, and the human-readable name
+    and description it was given via :attr:`name` / :attr:`description`. All four
+    are optional on the wire and are ``None`` if the caller omitted them.
     """
 
     input_schema: Optional[Struct]
     output_schema: Optional[Struct]
+    name: Optional[str]
+    description: Optional[str]
 
     def __call__(self, *args: PlainValue) -> Awaitable[PlainValue]: ...
 

{code0_hercules-1.7.2 → code0_hercules-1.9.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "code0-hercules"
-version = "1.7.2"
+version = "1.9.0"
 description = "Python SDK for the hercules action runner"
 readme = "README.md"
 requires-python = ">=3.10"
@@ -12,7 +12,7 @@ license = "MIT"
 dependencies = [
     "grpcio>=1.64",
     "protobuf>=5.0",
-    "tucana>=0.0.83",
+    "tucana>=0.0.86",
     "pydantic>=2",
 ]
 

{code0_hercules-1.7.2 → code0_hercules-1.9.0}/tests/test_execution.py

@@ -10,6 +10,7 @@ from hercules.manager.sub_flow_function import (
     SUB_FLOW_FUNCTION_TTL_SECONDS,
     SubFlowFunctionManager,
 )
+from hercules.models.function import FunctionParameterProps
 from hercules.models.runtime_function import RuntimeFunctionProps
 from tucana.generated.aquila import action_pb2
 from tucana.generated.shared import struct_pb2
@@ -33,6 +34,12 @@ def _literal_param(value):
     )
 
 
+def _sub_flow_param(**kwargs):
+    return action_pb2.ActionNodeValue(
+        sub_flow=action_pb2.ActionNodeSubFlowValue(**kwargs)
+    )
+
+
 class _StubStream:
     """Records everything the action would send to Aquila."""
 
@@ -187,6 +194,39 @@ def test_passes_a_plain_json_schema_dict_through_unchanged(action, sent):
     assert result.output_schema == struct_pb2.Struct(fields={"type": _str("string")})
 
 
+def test_hands_a_sub_flow_parameter_to_the_handler_with_its_name_and_description(
+    action, sent
+):
+    seen = []
+
+    def handler(callback):
+        seen.append((callback.name, callback.description))
+        return "ok"
+
+    action.runtime_functions.set(
+        "fn",
+        _runtime_function(
+            handler, parameters=[FunctionParameterProps(runtime_name="callback")]
+        ),
+    )
+
+    _run_handle(
+        action,
+        _request(
+            "fn",
+            [
+                _sub_flow_param(
+                    execution_identifier="sub-1",
+                    name="on_each_row",
+                    description="Runs for every row",
+                )
+            ],
+        ),
+    )
+
+    assert seen == [("on_each_row", "Runs for every row")]
+
+
 def test_gives_each_returned_sub_flow_function_its_own_identifier(action, sent):
     action.runtime_functions.set(
         "fn", _runtime_function(lambda: _sub_flow_function(lambda: None))

{code0_hercules-1.7.2 → code0_hercules-1.9.0}/tests/test_literal.py

@@ -121,7 +121,7 @@ class TestResolveNodeValue:
     def test_returns_none_for_absent_node(self):
         assert resolve_node_value(_NOOP_ACTION, None) is None
 
-    def test_wraps_sub_flow_node_in_caller_exposing_schema(self):
+    def test_wraps_sub_flow_node_in_caller_exposing_schema_and_metadata(self):
         calls = []
 
         class _Action:
@@ -130,10 +130,25 @@ class TestResolveNodeValue:
                 return "done"
 
         node = action_pb2.ActionNodeValue(
-            sub_flow=action_pb2.ActionNodeSubFlowValue(execution_identifier="sf")
+            sub_flow=action_pb2.ActionNodeSubFlowValue(
+                execution_identifier="sf",
+                name="greet",
+                description="Greets a name",
+            )
         )
         caller = resolve_node_value(_Action(), node)
         assert callable(caller)
         assert caller.input_schema == node.sub_flow.input_schema
+        assert caller.name == "greet"
+        assert caller.description == "Greets a name"
         assert asyncio.get_event_loop().run_until_complete(caller("a")) == "done"
         assert calls == [(node.sub_flow, "a")]
+
+    def test_sub_flow_metadata_is_none_when_omitted(self):
+        node = action_pb2.ActionNodeValue(
+            sub_flow=action_pb2.ActionNodeSubFlowValue(execution_identifier="sf")
+        )
+        caller = resolve_node_value(_NOOP_ACTION, node)
+        # ``optional`` on the wire: an unset field is ``None``, not ``""``.
+        assert caller.name is None
+        assert caller.description is None