orca-python 0.3.0__py3-none-any.whl → 0.5.0__py3-none-any.whl

orca_python/__init__.py

@@ -1,3 +1,3 @@
-from orca_python.main import Window, Processor, EmitWindow
+from orca_python.main import Window, Processor, EmitWindow, WindowType, ExecutionParams
 
-__all__ = ["Processor", "EmitWindow", "Window"]
+__all__ = ["Processor", "EmitWindow", "Window", "WindowType", "ExecutionParams"]

orca_python/main.py

@@ -26,8 +26,9 @@ from typing import (
     TypeVar,
     Callable,
     Iterable,
+    Optional,
+    Protocol,
     Generator,
-    TypeAlias,
     AsyncGenerator,
 )
 from concurrent import futures
@@ -48,13 +49,41 @@ ALGORITHM_NAME = r"^[A-Z][a-zA-Z0-9]*$"
 SEMVER_PATTERN = r"^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)$"
 WINDOW_NAME = r"^[A-Z][a-zA-Z0-9]*$"
 
-AlgorithmFn: TypeAlias = Callable[..., Any]
+
+@dataclass
+class ExecutionParams:
+    window: pb.Window
+    dependencies: Optional[Iterable[pb.AlgorithmResult]] = None
+
+
+class AlgorithmFn(Protocol):
+    def __call__(self, params: ExecutionParams, *args: Any, **kwargs: Any) -> Any: ...
+
 
 T = TypeVar("T", bound=AlgorithmFn)
 
 LOGGER = logging.getLogger(__name__)
 
 
+@dataclass
+class WindowType:
+    name: str
+    version: str
+    description: str
+
+    def __post__init__(self) -> None:
+        if not re.match(WINDOW_NAME, self.name):
+            raise InvalidAlgorithmArgument(
+                f"Window name '{self.name}' must be in PascalCase"
+            )
+
+        if not re.match(SEMVER_PATTERN, self.version):
+            raise InvalidAlgorithmArgument(
+                f"Window version '{self.version}' must follow basic semantic "
+                "versioning (e.g., '1.0.0') without release portions"
+            )
+
+
 @dataclass
 class Window:
     time_from: int
@@ -111,6 +140,7 @@ class Algorithm:
     version: str
     window_name: str
     window_version: str
+    window_description: str
     exec_fn: AlgorithmFn
     processor: str
     runtime: str
@@ -180,12 +210,11 @@ class Algorithms:
                 break
 
         if not dependencyAlgo:
+            dep_name = getattr(dependency, "__name__", "<unknown>")
             LOGGER.error(
-                f"Failed to find registered algorithm for dependency: {dependency.__name__}"
-            )
-            raise ValueError(
-                f"Dependency {dependency.__name__} not found in registered algorithms"
+                f"Failed to find registered algorithm for dependency: {dep_name}"
             )
+            raise ValueError(f"Dependency {dep_name} not found in reg=ms")
 
         if algorithm not in self._dependencyFns:
             self._dependencyFns[algorithm] = [dependency]
@@ -245,7 +274,7 @@ class Processor(OrcaProcessorServicer):  # type: ignore
         self,
         exec_id: str,
         algorithm: pb.Algorithm,
-        dependencyResults: Iterable[pb.AlgorithmResult],
+        params: ExecutionParams,
     ) -> pb.ExecutionResult:
         """
         Executes a single algorithm with resolved dependencies.
@@ -253,7 +282,7 @@ class Processor(OrcaProcessorServicer):  # type: ignore
         Args:
             exec_id (str): Unique execution ID.
             algorithm (pb.Algorithm): The algorithm to execute.
-            dependencyResults (Iterable[pb.AlgorithmResult]): Results from dependency algorithms.
+            params (ExecutionParams): The execution params object, which contains the triggering window and dependency results.
 
         Returns:
             pb.ExecutionResult: The result of the execution.
@@ -268,27 +297,28 @@ class Processor(OrcaProcessorServicer):  # type: ignore
 
             # convert dependency results into a dict of name -> value
             dependency_values = {}
-            for dep_result in dependencyResults:
-                # extract value based on which oneof field is set
-                dep_value = None
-                if dep_result.result.HasField("single_value"):
-                    dep_value = dep_result.result.single_value
-                elif dep_result.result.HasField("float_values"):
-                    dep_value = list(dep_result.result.float_values.values)
-                elif dep_result.result.HasField("struct_value"):
-                    dep_value = json_format.MessageToDict(
-                        dep_result.result.struct_value
+            if params.dependencies:
+                for dep_result in params.dependencies:
+                    # extract value based on which oneof field is set
+                    dep_value = None
+                    if dep_result.result.HasField("single_value"):
+                        dep_value = dep_result.result.single_value
+                    elif dep_result.result.HasField("float_values"):
+                        dep_value = list(dep_result.result.float_values.values)
+                    elif dep_result.result.HasField("struct_value"):
+                        dep_value = json_format.MessageToDict(
+                            dep_result.result.struct_value
+                        )
+
+                    dep_name = (
+                        f"{dep_result.algorithm.name}_{dep_result.algorithm.version}"
                     )
-
-                dep_name = f"{dep_result.algorithm.name}_{dep_result.algorithm.version}"
-                dependency_values[dep_name] = dep_value
+                    dependency_values[dep_name] = dep_value
 
             # execute in thread pool since algo.exec_fn is synchronous
             loop = asyncio.get_event_loop()
 
-            algoResult = await loop.run_in_executor(
-                None, algo.exec_fn, dependency_values
-            )
+            algoResult = await loop.run_in_executor(None, algo.exec_fn, params)
 
             # create result based on the return type
             current_time = int(time.time())  # Current timestamp in seconds
@@ -390,13 +420,13 @@ class Processor(OrcaProcessorServicer):  # type: ignore
             return pb.ExecutionResult(exec_id=exec_id, algorithm_result=algo_result)
 
     def ExecuteDagPart(
-        self, ExecutionRequest: pb.ExecutionRequest, context: grpc.ServicerContext
+        self, executionRequest: pb.ExecutionRequest, context: grpc.ServicerContext
     ) -> Generator[pb.ExecutionResult, None, None]:
         """
         Executes part of a DAG (Directed Acyclic Graph) of algorithms.
 
         Args:
-            ExecutionRequest (pb.ExecutionRequest): The DAG execution request.
+            executionRequest (pb.ExecutionRequest): The DAG execution request.
             context (grpc.ServicerContext): gRPC context for the request.
 
         Yields:
@@ -408,8 +438,8 @@ class Processor(OrcaProcessorServicer):  # type: ignore
 
         LOGGER.info(
             (
-                f"Received DAG execution request with {len(ExecutionRequest.algorithms)} "
-                f"algorithms and ExecId: {ExecutionRequest.exec_id}"
+                f"Received DAG execution request with {len(executionRequest.algorithms)} "
+                f"algorithms and ExecId: {executionRequest.exec_id}"
             )
         )
 
@@ -424,11 +454,14 @@ class Processor(OrcaProcessorServicer):  # type: ignore
             # create tasks for all algorithms
             tasks = [
                 self.execute_algorithm(
-                    ExecutionRequest.exec_id,
+                    executionRequest.exec_id,
                     algorithm,
-                    ExecutionRequest.algorithm_results,
+                    ExecutionParams(
+                        window=executionRequest.window,
+                        dependencies=executionRequest.algorithm_results,
+                    ),
                 )
-                for algorithm in ExecutionRequest.algorithms
+                for algorithm in executionRequest.algorithms
             ]
 
             # execute all tasks concurrently and yield results as they complete
@@ -509,6 +542,7 @@ class Processor(OrcaProcessorServicer):  # type: ignore
             # Add window type
             algo_msg.window_type.name = algorithm.window_name
             algo_msg.window_type.version = algorithm.window_version
+            algo_msg.window_type.description = algorithm.window_description
 
             # Add dependencies if they exist
             if algorithm.full_name in self._algorithmsSingleton._dependencies:
@@ -585,8 +619,7 @@ class Processor(OrcaProcessorServicer):  # type: ignore
         self,
         name: str,
         version: str,
-        window_name: str,
-        window_version: str,
+        window_type: WindowType,
         depends_on: List[Callable[..., Any]] = [],
     ) -> Callable[[T], T]:
         """
@@ -595,10 +628,8 @@ class Processor(OrcaProcessorServicer):  # type: ignore
         Args:
             name (str): Algorithm name (PascalCase).
             version (str): Semantic version (e.g., "1.0.0").
-            window_name (str): Triggering window name (PascalCase).
-            window_version (str): Semantic version of the window.
+            window_type (WindowType): Triggering window type
             depends_on (List[Callable]): List of dependent algorithm functions.
-
         Returns:
             Callable[[T], T]: The decorated function.
 
@@ -617,31 +648,18 @@ class Processor(OrcaProcessorServicer):  # type: ignore
                 "versioning (e.g., '1.0.0') without release portions"
             )
 
-        if not re.match(WINDOW_NAME, window_name):
-            raise InvalidAlgorithmArgument(
-                f"Window name '{window_name}' must be in PascalCase"
-            )
-
-        if not re.match(SEMVER_PATTERN, window_version):
-            raise InvalidAlgorithmArgument(
-                f"Window version '{window_version}' must follow basic semantic "
-                "versioning (e.g., '1.0.0') without release portions"
-            )
-
         def inner(algo: T) -> T:
             def wrapper(
-                dependency_values: Dict[str, Any] | None = None,
+                params: ExecutionParams,
                 *args: Any,
                 **kwargs: Any,
             ) -> Any:
                 LOGGER.debug(f"Executing algorithm {name}_{version}")
                 try:
                     # setup ready for the algo
-                    # add dependency values to kwargs if provided
-                    if dependency_values:
-                        kwargs["dependencies"] = dependency_values
+                    # pack the params into the kwargs - user can decide if they want it
+                    kwargs["params"] = params
                     LOGGER.debug(f"Algorithm {name}_{version} setup complete")
-                    # TODO
 
                     # run the algo
                     LOGGER.info(f"Running algorithm {name}_{version}")
@@ -660,8 +678,9 @@ class Processor(OrcaProcessorServicer):  # type: ignore
             algorithm = Algorithm(
                 name=name,
                 version=version,
-                window_name=window_name,
-                window_version=window_version,
+                window_name=window_type.name,
+                window_version=window_type.version,
+                window_description=window_type.description,
                 exec_fn=wrapper,
                 processor=self._name,
                 runtime=sys.version,
@@ -687,6 +706,6 @@ class Processor(OrcaProcessorServicer):  # type: ignore
             # needs to be defined before a dependency can be created, and you can only register depencenies
             # once. But when dependencies are grabbed from a server, circular dependencies will be possible
 
-            return wrapper  # type: ignore
+            return wrapper  # type: ignore[return-value]
 
         return inner

{orca_python-0.3.0.dist-info → orca_python-0.5.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: orca-python
-Version: 0.3.0
+Version: 0.5.0
 Summary: Python SDK for the Predixus Orca product
 Author: Frederick Mannings
 Author-email: contact@predixus.com

{orca_python-0.3.0.dist-info → orca_python-0.5.0.dist-info}/RECORD

@@ -1,17 +1,17 @@
 __init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-service_pb2.py,sha256=2lo-2dtvDnLo2JtK26B2VN8PGI-yXMzpJpPqginVzHA,16167
-service_pb2.pyi,sha256=_EhTUy_VBfVP9ytmVEGhVQ_NodZMJvfpxbp10GWBfIE,11608
-service_pb2_grpc.py,sha256=cAADQz6f26Dh6fXrvtdpLS8dKI_5OXE11kzAmgm-4Wk,17835
+service_pb2.py,sha256=O9Z-UawI0OCuztUEooLmDwx-FMwnTnhKswx3sH1fuGY,16422
+service_pb2.pyi,sha256=aM7M31KZljN9OMFh1MIkyhEWl8xglhq5NKsV1G06Rpw,11724
+service_pb2_grpc.py,sha256=fh82JLm4Y0wOOabMfbrP2qoq7QJ67CRE3Xs9Igqp7ns,17598
 vendor/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 vendor/validate_pb2.py,sha256=lyYYFtGDzHjs9ZHMUnQLcE_G5qYWfOluts0gm6m1D88,149437
 vendor/validate_pb2.pyi,sha256=Qyebm_XUdrvo8As3XovHu7vVsHXYJtTdP3bYUmQEecs,30245
 vendor/validate_pb2_grpc.py,sha256=qIlTS0MGHE7myQ7tCMbS-pPqA9FMZl_Hn9Mh_uq2o9o,896
-orca_python/__init__.py,sha256=7iu_tkM2DQXuNpBPx-uwj68l9SYHJxeyrM6NL1HsX5k,108
+orca_python/__init__.py,sha256=AiOoJCsZEDqR6r-pkjgyfA9GbA2poIASZtn4lSSaBGc,170
 orca_python/envs.py,sha256=zSuukNSpEw78VpSSIDAA9KRAurWedQMwx1qyQg9f8pk,560
 orca_python/exceptions.py,sha256=Z9iJg6tKpnrNhDxQlVvG5xpgjGbaiMNAeFkwMonM-PM,390
-orca_python/main.py,sha256=i5BVkisxuUdlG6djzw4QX7sls4O5eZTFiUH4vGqjahk,25544
+orca_python/main.py,sha256=DdD84lOZk-GBi4d8v4Fc-MRPF4b0LPnmeJ2U2Kxnq3c,26103
 orca_python/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-orca_python-0.3.0.dist-info/LICENSE,sha256=sxb8X8qhbZ_JaCBFmoIriJzA-jelKmh86sAKQsIRN_I,1062
-orca_python-0.3.0.dist-info/METADATA,sha256=aN0U-I2wRr1Er3ZGKRnq4wyI6nvxFIJ4wkdzcXBCVmY,3019
-orca_python-0.3.0.dist-info/WHEEL,sha256=XbeZDeTWKc1w7CSIyre5aMDU_-PohRwTQceYnisIYYY,88
-orca_python-0.3.0.dist-info/RECORD,,
+orca_python-0.5.0.dist-info/LICENSE,sha256=sxb8X8qhbZ_JaCBFmoIriJzA-jelKmh86sAKQsIRN_I,1062
+orca_python-0.5.0.dist-info/METADATA,sha256=HQqIUzB9oLM3agqWhszUX0fDxWhfGn4eIP5Youl7KU0,3019
+orca_python-0.5.0.dist-info/WHEEL,sha256=XbeZDeTWKc1w7CSIyre5aMDU_-PohRwTQceYnisIYYY,88
+orca_python-0.5.0.dist-info/RECORD,,

service_pb2.py

@@ -26,7 +26,7 @@ from google.protobuf import struct_pb2 as google_dot_protobuf_dot_struct__pb2
 from vendor import validate_pb2 as vendor_dot_validate__pb2
 
 
-DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n\rservice.proto\x1a\x1cgoogle/protobuf/struct.proto\x1a\x15vendor/validate.proto\"\xb9\x02\n\x06Window\x12\x1d\n\ttime_from\x18\x01 \x01(\x04\x42\n\xbaH\x07\x32\x02 \x00\xc8\x01\x01\x12\x17\n\x07time_to\x18\x02 \x01(\x04\x42\x06\xbaH\x03\xc8\x01\x01\x12 \n\x10window_type_name\x18\x03 \x01(\tB\x06\xbaH\x03\xc8\x01\x01\x12#\n\x13window_type_version\x18\x04 \x01(\tB\x06\xbaH\x03\xc8\x01\x01\x12\x16\n\x06origin\x18\x05 \x01(\tB\x06\xbaH\x03\xc8\x01\x01\x12)\n\x08metadata\x18\x06 \x01(\x0b\x32\x17.google.protobuf.Struct:m\xbaHj\x1ah\n\x0ewindow.time_to\x12\x36`time_to` must be greater than or equal to `time_from`\x1a\x1ethis.time_to >= this.time_from\";\n\nWindowType\x12\x14\n\x04name\x18\x01 \x01(\tB\x06\xbaH\x03\xc8\x01\x01\x12\x17\n\x07version\x18\x02 \x01(\tB\x06\xbaH\x03\xc8\x01\x01\"\xa4\x01\n\x10WindowEmitStatus\x12\x34\n\x06status\x18\x01 \x01(\x0e\x32\x1c.WindowEmitStatus.StatusEnumB\x06\xbaH\x03\xc8\x01\x01\"Z\n\nStatusEnum\x12\x1b\n\x17NO_TRIGGERED_ALGORITHMS\x10\x00\x12\x18\n\x14PROCESSING_TRIGGERED\x10\x01\x12\x15\n\x11TRIGGERING_FAILED\x10\x02\"\x87\x01\n\x13\x41lgorithmDependency\x12\x14\n\x04name\x18\x01 \x01(\tB\x06\xbaH\x03\xc8\x01\x01\x12\x17\n\x07version\x18\x02 \x01(\tB\x06\xbaH\x03\xc8\x01\x01\x12\x1e\n\x0eprocessor_name\x18\x03 \x01(\tB\x06\xbaH\x03\xc8\x01\x01\x12!\n\x11processor_runtime\x18\x04 \x01(\tB\x06\xbaH\x03\xc8\x01\x01\"\x90\x01\n\tAlgorithm\x12\x14\n\x04name\x18\x01 \x01(\tB\x06\xbaH\x03\xc8\x01\x01\x12\x17\n\x07version\x18\x02 \x01(\tB\x06\xbaH\x03\xc8\x01\x01\x12(\n\x0bwindow_type\x18\x03 \x01(\x0b\x32\x0b.WindowTypeB\x06\xbaH\x03\xc8\x01\x01\x12*\n\x0c\x64\x65pendencies\x18\x04 \x03(\x0b\x32\x14.AlgorithmDependency\"\x1c\n\nFloatArray\x12\x0e\n\x06values\x18\x01 \x03(\x02\"\xc7\x01\n\x06Result\x12%\n\x06status\x18\x01 \x01(\x0e\x32\r.ResultStatusB\x06\xbaH\x03\xc8\x01\x01\x12\x16\n\x0csingle_value\x18\x02 \x01(\x02H\x00\x12#\n\x0c\x66loat_values\x18\x03 \x01(\x0b\x32\x0b.FloatArrayH\x00\x12/\n\x0cstruct_value\x18\x04 \x01(\x0b\x32\x17.google.protobuf.StructH\x00\x12\x19\n\ttimestamp\x18\x05 \x01(\x03\x42\x06\xbaH\x03\xc8\x01\x01\x42\r\n\x0bresult_data\"\x98\x01\n\x15ProcessorRegistration\x12\x14\n\x04name\x18\x01 \x01(\tB\x06\xbaH\x03\xc8\x01\x01\x12\x17\n\x07runtime\x18\x02 \x01(\tB\x06\xbaH\x03\xc8\x01\x01\x12\x1e\n\x0e\x63onnection_str\x18\x03 \x01(\tB\x06\xbaH\x03\xc8\x01\x01\x12\x30\n\x14supported_algorithms\x18\x04 \x03(\x0b\x32\n.AlgorithmB\x06\xbaH\x03\xc8\x01\x01\"\x96\x01\n\x0eProcessingTask\x12\x17\n\x07task_id\x18\x01 \x01(\tB\x06\xbaH\x03\xc8\x01\x01\x12%\n\talgorithm\x18\x02 \x01(\x0b\x32\n.AlgorithmB\x06\xbaH\x03\xc8\x01\x01\x12\x1f\n\x06window\x18\x03 \x01(\x0b\x32\x07.WindowB\x06\xbaH\x03\xc8\x01\x01\x12#\n\x12\x64\x65pendency_results\x18\x04 \x03(\x0b\x32\x07.Result\"\x99\x01\n\x10\x45xecutionRequest\x12\x17\n\x07\x65xec_id\x18\x01 \x01(\tB\x06\xbaH\x03\xc8\x01\x01\x12\x1f\n\x06window\x18\x02 \x01(\x0b\x32\x07.WindowB\x06\xbaH\x03\xc8\x01\x01\x12+\n\x11\x61lgorithm_results\x18\x03 \x03(\x0b\x32\x10.AlgorithmResult\x12\x1e\n\nalgorithms\x18\x04 \x03(\x0b\x32\n.Algorithm\"^\n\x0f\x45xecutionResult\x12\x17\n\x07\x65xec_id\x18\x01 \x01(\tB\x06\xbaH\x03\xc8\x01\x01\x12\x32\n\x10\x61lgorithm_result\x18\x03 \x01(\x0b\x32\x10.AlgorithmResultB\x06\xbaH\x03\xc8\x01\x01\"Y\n\x0f\x41lgorithmResult\x12%\n\talgorithm\x18\x01 \x01(\x0b\x32\n.AlgorithmB\x06\xbaH\x03\xc8\x01\x01\x12\x1f\n\x06result\x18\x02 \x01(\x0b\x32\x07.ResultB\x06\xbaH\x03\xc8\x01\x01\"+\n\x06Status\x12\x10\n\x08received\x18\x01 \x01(\x08\x12\x0f\n\x07message\x18\x02 \x01(\t\"/\n\x12HealthCheckRequest\x12\x19\n\ttimestamp\x18\x01 \x01(\x03\x42\x06\xbaH\x03\xc8\x01\x01\"\xe3\x01\n\x13HealthCheckResponse\x12\x33\n\x06status\x18\x01 \x01(\x0e\x32\x1b.HealthCheckResponse.StatusB\x06\xbaH\x03\xc8\x01\x01\x12\x0f\n\x07message\x18\x02 \x01(\t\x12\"\n\x07metrics\x18\x03 \x01(\x0b\x32\x11.ProcessorMetrics\"b\n\x06Status\x12\x12\n\x0eSTATUS_UNKNOWN\x10\x00\x12\x12\n\x0eSTATUS_SERVING\x10\x01\x12\x18\n\x14STATUS_TRANSITIONING\x10\x02\x12\x16\n\x12STATUS_NOT_SERVING\x10\x03\"k\n\x10ProcessorMetrics\x12\x14\n\x0c\x61\x63tive_tasks\x18\x01 \x01(\x05\x12\x14\n\x0cmemory_bytes\x18\x02 \x01(\x03\x12\x13\n\x0b\x63pu_percent\x18\x03 \x01(\x02\x12\x16\n\x0euptime_seconds\x18\x04 \x01(\x03\"\x10\n\x0eWindowTypeRead\"+\n\x0bWindowTypes\x12\x1c\n\x07windows\x18\x01 \x03(\x0b\x32\x0b.WindowType\"\x10\n\x0e\x41lgorithmsRead\"+\n\nAlgorithms\x12\x1d\n\talgorithm\x18\x01 \x03(\x0b\x32\n.Algorithm\"\x10\n\x0eProcessorsRead\"b\n\nProcessors\x12(\n\tprocessor\x18\x01 \x03(\x0b\x32\x15.Processors.Processor\x1a*\n\tProcessor\x12\x0c\n\x04name\x18\x01 \x01(\t\x12\x0f\n\x07runtime\x18\x02 \x01(\t\"\x12\n\x10ResultsStatsRead\"\x1d\n\x0cResultsStats\x12\r\n\x05\x43ount\x18\x01 \x01(\x03*p\n\x0cResultStatus\x12 \n\x1cRESULT_STATUS_HANDLED_FAILED\x10\x00\x12\"\n\x1eRESULT_STATUS_UNHANDLED_FAILED\x10\x01\x12\x1a\n\x16RESULT_STATUS_SUCEEDED\x10\x02\x32\xb2\x02\n\x08OrcaCore\x12\x34\n\x11RegisterProcessor\x12\x16.ProcessorRegistration\x1a\x07.Status\x12(\n\nEmitWindow\x12\x07.Window\x1a\x11.WindowEmitStatus\x12\x30\n\x0fReadWindowTypes\x12\x0f.WindowTypeRead\x1a\x0c.WindowTypes\x12.\n\x0eReadAlgorithms\x12\x0f.AlgorithmsRead\x1a\x0b.Algorithms\x12.\n\x0eReadProcessors\x12\x0f.ProcessorsRead\x1a\x0b.Processors\x12\x34\n\x10ReadResultsStats\x12\x11.ResultsStatsRead\x1a\r.ResultsStats2\x82\x01\n\rOrcaProcessor\x12\x37\n\x0e\x45xecuteDagPart\x12\x11.ExecutionRequest\x1a\x10.ExecutionResult0\x01\x12\x38\n\x0bHealthCheck\x12\x13.HealthCheckRequest\x1a\x14.HealthCheckResponseB\'Z%github.com/predixus/orca/protobufs/gob\x06proto3')
+DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n\rservice.proto\x1a\x1cgoogle/protobuf/struct.proto\x1a\x15vendor/validate.proto\"\xb9\x02\n\x06Window\x12\x1d\n\ttime_from\x18\x01 \x01(\x04\x42\n\xbaH\x07\x32\x02 \x00\xc8\x01\x01\x12\x17\n\x07time_to\x18\x02 \x01(\x04\x42\x06\xbaH\x03\xc8\x01\x01\x12 \n\x10window_type_name\x18\x03 \x01(\tB\x06\xbaH\x03\xc8\x01\x01\x12#\n\x13window_type_version\x18\x04 \x01(\tB\x06\xbaH\x03\xc8\x01\x01\x12\x16\n\x06origin\x18\x05 \x01(\tB\x06\xbaH\x03\xc8\x01\x01\x12)\n\x08metadata\x18\x06 \x01(\x0b\x32\x17.google.protobuf.Struct:m\xbaHj\x1ah\n\x0ewindow.time_to\x12\x36`time_to` must be greater than or equal to `time_from`\x1a\x1ethis.time_to >= this.time_from\"X\n\nWindowType\x12\x14\n\x04name\x18\x01 \x01(\tB\x06\xbaH\x03\xc8\x01\x01\x12\x17\n\x07version\x18\x02 \x01(\tB\x06\xbaH\x03\xc8\x01\x01\x12\x1b\n\x0b\x64\x65scription\x18\x03 \x01(\tB\x06\xbaH\x03\xc8\x01\x01\"\xa4\x01\n\x10WindowEmitStatus\x12\x34\n\x06status\x18\x01 \x01(\x0e\x32\x1c.WindowEmitStatus.StatusEnumB\x06\xbaH\x03\xc8\x01\x01\"Z\n\nStatusEnum\x12\x1b\n\x17NO_TRIGGERED_ALGORITHMS\x10\x00\x12\x18\n\x14PROCESSING_TRIGGERED\x10\x01\x12\x15\n\x11TRIGGERING_FAILED\x10\x02\"\x87\x01\n\x13\x41lgorithmDependency\x12\x14\n\x04name\x18\x01 \x01(\tB\x06\xbaH\x03\xc8\x01\x01\x12\x17\n\x07version\x18\x02 \x01(\tB\x06\xbaH\x03\xc8\x01\x01\x12\x1e\n\x0eprocessor_name\x18\x03 \x01(\tB\x06\xbaH\x03\xc8\x01\x01\x12!\n\x11processor_runtime\x18\x04 \x01(\tB\x06\xbaH\x03\xc8\x01\x01\"\x90\x01\n\tAlgorithm\x12\x14\n\x04name\x18\x01 \x01(\tB\x06\xbaH\x03\xc8\x01\x01\x12\x17\n\x07version\x18\x02 \x01(\tB\x06\xbaH\x03\xc8\x01\x01\x12(\n\x0bwindow_type\x18\x03 \x01(\x0b\x32\x0b.WindowTypeB\x06\xbaH\x03\xc8\x01\x01\x12*\n\x0c\x64\x65pendencies\x18\x04 \x03(\x0b\x32\x14.AlgorithmDependency\"\x1c\n\nFloatArray\x12\x0e\n\x06values\x18\x01 \x03(\x02\"\xc7\x01\n\x06Result\x12%\n\x06status\x18\x01 \x01(\x0e\x32\r.ResultStatusB\x06\xbaH\x03\xc8\x01\x01\x12\x16\n\x0csingle_value\x18\x02 \x01(\x02H\x00\x12#\n\x0c\x66loat_values\x18\x03 \x01(\x0b\x32\x0b.FloatArrayH\x00\x12/\n\x0cstruct_value\x18\x04 \x01(\x0b\x32\x17.google.protobuf.StructH\x00\x12\x19\n\ttimestamp\x18\x05 \x01(\x03\x42\x06\xbaH\x03\xc8\x01\x01\x42\r\n\x0bresult_data\"\x98\x01\n\x15ProcessorRegistration\x12\x14\n\x04name\x18\x01 \x01(\tB\x06\xbaH\x03\xc8\x01\x01\x12\x17\n\x07runtime\x18\x02 \x01(\tB\x06\xbaH\x03\xc8\x01\x01\x12\x1e\n\x0e\x63onnection_str\x18\x03 \x01(\tB\x06\xbaH\x03\xc8\x01\x01\x12\x30\n\x14supported_algorithms\x18\x04 \x03(\x0b\x32\n.AlgorithmB\x06\xbaH\x03\xc8\x01\x01\"\x96\x01\n\x0eProcessingTask\x12\x17\n\x07task_id\x18\x01 \x01(\tB\x06\xbaH\x03\xc8\x01\x01\x12%\n\talgorithm\x18\x02 \x01(\x0b\x32\n.AlgorithmB\x06\xbaH\x03\xc8\x01\x01\x12\x1f\n\x06window\x18\x03 \x01(\x0b\x32\x07.WindowB\x06\xbaH\x03\xc8\x01\x01\x12#\n\x12\x64\x65pendency_results\x18\x04 \x03(\x0b\x32\x07.Result\"\x99\x01\n\x10\x45xecutionRequest\x12\x17\n\x07\x65xec_id\x18\x01 \x01(\tB\x06\xbaH\x03\xc8\x01\x01\x12\x1f\n\x06window\x18\x02 \x01(\x0b\x32\x07.WindowB\x06\xbaH\x03\xc8\x01\x01\x12+\n\x11\x61lgorithm_results\x18\x03 \x03(\x0b\x32\x10.AlgorithmResult\x12\x1e\n\nalgorithms\x18\x04 \x03(\x0b\x32\n.Algorithm\"^\n\x0f\x45xecutionResult\x12\x17\n\x07\x65xec_id\x18\x01 \x01(\tB\x06\xbaH\x03\xc8\x01\x01\x12\x32\n\x10\x61lgorithm_result\x18\x03 \x01(\x0b\x32\x10.AlgorithmResultB\x06\xbaH\x03\xc8\x01\x01\"Y\n\x0f\x41lgorithmResult\x12%\n\talgorithm\x18\x01 \x01(\x0b\x32\n.AlgorithmB\x06\xbaH\x03\xc8\x01\x01\x12\x1f\n\x06result\x18\x02 \x01(\x0b\x32\x07.ResultB\x06\xbaH\x03\xc8\x01\x01\"+\n\x06Status\x12\x10\n\x08received\x18\x01 \x01(\x08\x12\x0f\n\x07message\x18\x02 \x01(\t\"/\n\x12HealthCheckRequest\x12\x19\n\ttimestamp\x18\x01 \x01(\x03\x42\x06\xbaH\x03\xc8\x01\x01\"\xe3\x01\n\x13HealthCheckResponse\x12\x33\n\x06status\x18\x01 \x01(\x0e\x32\x1b.HealthCheckResponse.StatusB\x06\xbaH\x03\xc8\x01\x01\x12\x0f\n\x07message\x18\x02 \x01(\t\x12\"\n\x07metrics\x18\x03 \x01(\x0b\x32\x11.ProcessorMetrics\"b\n\x06Status\x12\x12\n\x0eSTATUS_UNKNOWN\x10\x00\x12\x12\n\x0eSTATUS_SERVING\x10\x01\x12\x18\n\x14STATUS_TRANSITIONING\x10\x02\x12\x16\n\x12STATUS_NOT_SERVING\x10\x03\"k\n\x10ProcessorMetrics\x12\x14\n\x0c\x61\x63tive_tasks\x18\x01 \x01(\x05\x12\x14\n\x0cmemory_bytes\x18\x02 \x01(\x03\x12\x13\n\x0b\x63pu_percent\x18\x03 \x01(\x02\x12\x16\n\x0euptime_seconds\x18\x04 \x01(\x03\"\x10\n\x0eWindowTypeRead\"+\n\x0bWindowTypes\x12\x1c\n\x07windows\x18\x01 \x03(\x0b\x32\x0b.WindowType\"\x10\n\x0e\x41lgorithmsRead\"+\n\nAlgorithms\x12\x1d\n\talgorithm\x18\x01 \x03(\x0b\x32\n.Algorithm\"\x10\n\x0eProcessorsRead\"b\n\nProcessors\x12(\n\tprocessor\x18\x01 \x03(\x0b\x32\x15.Processors.Processor\x1a*\n\tProcessor\x12\x0c\n\x04name\x18\x01 \x01(\t\x12\x0f\n\x07runtime\x18\x02 \x01(\t\"\x12\n\x10ResultsStatsRead\"\x1d\n\x0cResultsStats\x12\r\n\x05\x43ount\x18\x01 \x01(\x03*p\n\x0cResultStatus\x12 \n\x1cRESULT_STATUS_HANDLED_FAILED\x10\x00\x12\"\n\x1eRESULT_STATUS_UNHANDLED_FAILED\x10\x01\x12\x1a\n\x16RESULT_STATUS_SUCEEDED\x10\x02\x32\xb2\x02\n\x08OrcaCore\x12\x34\n\x11RegisterProcessor\x12\x16.ProcessorRegistration\x1a\x07.Status\x12(\n\nEmitWindow\x12\x07.Window\x1a\x11.WindowEmitStatus\x12\x30\n\x0fReadWindowTypes\x12\x0f.WindowTypeRead\x1a\x0c.WindowTypes\x12.\n\x0eReadAlgorithms\x12\x0f.AlgorithmsRead\x1a\x0b.Algorithms\x12.\n\x0eReadProcessors\x12\x0f.ProcessorsRead\x1a\x0b.Processors\x12\x34\n\x10ReadResultsStats\x12\x11.ResultsStatsRead\x1a\r.ResultsStats2\x82\x01\n\rOrcaProcessor\x12\x37\n\x0e\x45xecuteDagPart\x12\x11.ExecutionRequest\x1a\x10.ExecutionResult0\x01\x12\x38\n\x0bHealthCheck\x12\x13.HealthCheckRequest\x1a\x14.HealthCheckResponseB\'Z%github.com/predixus/orca/protobufs/gob\x06proto3')
 
 _globals = globals()
 _builder.BuildMessageAndEnumDescriptors(DESCRIPTOR, _globals)
@@ -50,6 +50,8 @@ if not _descriptor._USE_C_DESCRIPTORS:
   _globals['_WINDOWTYPE'].fields_by_name['name']._serialized_options = b'\272H\003\310\001\001'
   _globals['_WINDOWTYPE'].fields_by_name['version']._loaded_options = None
   _globals['_WINDOWTYPE'].fields_by_name['version']._serialized_options = b'\272H\003\310\001\001'
+  _globals['_WINDOWTYPE'].fields_by_name['description']._loaded_options = None
+  _globals['_WINDOWTYPE'].fields_by_name['description']._serialized_options = b'\272H\003\310\001\001'
   _globals['_WINDOWEMITSTATUS'].fields_by_name['status']._loaded_options = None
   _globals['_WINDOWEMITSTATUS'].fields_by_name['status']._serialized_options = b'\272H\003\310\001\001'
   _globals['_ALGORITHMDEPENDENCY'].fields_by_name['name']._loaded_options = None
@@ -100,64 +102,64 @@ if not _descriptor._USE_C_DESCRIPTORS:
   _globals['_HEALTHCHECKREQUEST'].fields_by_name['timestamp']._serialized_options = b'\272H\003\310\001\001'
   _globals['_HEALTHCHECKRESPONSE'].fields_by_name['status']._loaded_options = None
   _globals['_HEALTHCHECKRESPONSE'].fields_by_name['status']._serialized_options = b'\272H\003\310\001\001'
-  _globals['_RESULTSTATUS']._serialized_start=2510
-  _globals['_RESULTSTATUS']._serialized_end=2622
+  _globals['_RESULTSTATUS']._serialized_start=2539
+  _globals['_RESULTSTATUS']._serialized_end=2651
   _globals['_WINDOW']._serialized_start=71
   _globals['_WINDOW']._serialized_end=384
   _globals['_WINDOWTYPE']._serialized_start=386
-  _globals['_WINDOWTYPE']._serialized_end=445
-  _globals['_WINDOWEMITSTATUS']._serialized_start=448
-  _globals['_WINDOWEMITSTATUS']._serialized_end=612
-  _globals['_WINDOWEMITSTATUS_STATUSENUM']._serialized_start=522
-  _globals['_WINDOWEMITSTATUS_STATUSENUM']._serialized_end=612
-  _globals['_ALGORITHMDEPENDENCY']._serialized_start=615
-  _globals['_ALGORITHMDEPENDENCY']._serialized_end=750
-  _globals['_ALGORITHM']._serialized_start=753
-  _globals['_ALGORITHM']._serialized_end=897
-  _globals['_FLOATARRAY']._serialized_start=899
-  _globals['_FLOATARRAY']._serialized_end=927
-  _globals['_RESULT']._serialized_start=930
-  _globals['_RESULT']._serialized_end=1129
-  _globals['_PROCESSORREGISTRATION']._serialized_start=1132
-  _globals['_PROCESSORREGISTRATION']._serialized_end=1284
-  _globals['_PROCESSINGTASK']._serialized_start=1287
-  _globals['_PROCESSINGTASK']._serialized_end=1437
-  _globals['_EXECUTIONREQUEST']._serialized_start=1440
-  _globals['_EXECUTIONREQUEST']._serialized_end=1593
-  _globals['_EXECUTIONRESULT']._serialized_start=1595
-  _globals['_EXECUTIONRESULT']._serialized_end=1689
-  _globals['_ALGORITHMRESULT']._serialized_start=1691
-  _globals['_ALGORITHMRESULT']._serialized_end=1780
-  _globals['_STATUS']._serialized_start=1782
-  _globals['_STATUS']._serialized_end=1825
-  _globals['_HEALTHCHECKREQUEST']._serialized_start=1827
-  _globals['_HEALTHCHECKREQUEST']._serialized_end=1874
-  _globals['_HEALTHCHECKRESPONSE']._serialized_start=1877
-  _globals['_HEALTHCHECKRESPONSE']._serialized_end=2104
-  _globals['_HEALTHCHECKRESPONSE_STATUS']._serialized_start=2006
-  _globals['_HEALTHCHECKRESPONSE_STATUS']._serialized_end=2104
-  _globals['_PROCESSORMETRICS']._serialized_start=2106
-  _globals['_PROCESSORMETRICS']._serialized_end=2213
-  _globals['_WINDOWTYPEREAD']._serialized_start=2215
-  _globals['_WINDOWTYPEREAD']._serialized_end=2231
-  _globals['_WINDOWTYPES']._serialized_start=2233
-  _globals['_WINDOWTYPES']._serialized_end=2276
-  _globals['_ALGORITHMSREAD']._serialized_start=2278
-  _globals['_ALGORITHMSREAD']._serialized_end=2294
-  _globals['_ALGORITHMS']._serialized_start=2296
-  _globals['_ALGORITHMS']._serialized_end=2339
-  _globals['_PROCESSORSREAD']._serialized_start=2341
-  _globals['_PROCESSORSREAD']._serialized_end=2357
-  _globals['_PROCESSORS']._serialized_start=2359
-  _globals['_PROCESSORS']._serialized_end=2457
-  _globals['_PROCESSORS_PROCESSOR']._serialized_start=2415
-  _globals['_PROCESSORS_PROCESSOR']._serialized_end=2457
-  _globals['_RESULTSSTATSREAD']._serialized_start=2459
-  _globals['_RESULTSSTATSREAD']._serialized_end=2477
-  _globals['_RESULTSSTATS']._serialized_start=2479
-  _globals['_RESULTSSTATS']._serialized_end=2508
-  _globals['_ORCACORE']._serialized_start=2625
-  _globals['_ORCACORE']._serialized_end=2931
-  _globals['_ORCAPROCESSOR']._serialized_start=2934
-  _globals['_ORCAPROCESSOR']._serialized_end=3064
+  _globals['_WINDOWTYPE']._serialized_end=474
+  _globals['_WINDOWEMITSTATUS']._serialized_start=477
+  _globals['_WINDOWEMITSTATUS']._serialized_end=641
+  _globals['_WINDOWEMITSTATUS_STATUSENUM']._serialized_start=551
+  _globals['_WINDOWEMITSTATUS_STATUSENUM']._serialized_end=641
+  _globals['_ALGORITHMDEPENDENCY']._serialized_start=644
+  _globals['_ALGORITHMDEPENDENCY']._serialized_end=779
+  _globals['_ALGORITHM']._serialized_start=782
+  _globals['_ALGORITHM']._serialized_end=926
+  _globals['_FLOATARRAY']._serialized_start=928
+  _globals['_FLOATARRAY']._serialized_end=956
+  _globals['_RESULT']._serialized_start=959
+  _globals['_RESULT']._serialized_end=1158
+  _globals['_PROCESSORREGISTRATION']._serialized_start=1161
+  _globals['_PROCESSORREGISTRATION']._serialized_end=1313
+  _globals['_PROCESSINGTASK']._serialized_start=1316
+  _globals['_PROCESSINGTASK']._serialized_end=1466
+  _globals['_EXECUTIONREQUEST']._serialized_start=1469
+  _globals['_EXECUTIONREQUEST']._serialized_end=1622
+  _globals['_EXECUTIONRESULT']._serialized_start=1624
+  _globals['_EXECUTIONRESULT']._serialized_end=1718
+  _globals['_ALGORITHMRESULT']._serialized_start=1720
+  _globals['_ALGORITHMRESULT']._serialized_end=1809
+  _globals['_STATUS']._serialized_start=1811
+  _globals['_STATUS']._serialized_end=1854
+  _globals['_HEALTHCHECKREQUEST']._serialized_start=1856
+  _globals['_HEALTHCHECKREQUEST']._serialized_end=1903
+  _globals['_HEALTHCHECKRESPONSE']._serialized_start=1906
+  _globals['_HEALTHCHECKRESPONSE']._serialized_end=2133
+  _globals['_HEALTHCHECKRESPONSE_STATUS']._serialized_start=2035
+  _globals['_HEALTHCHECKRESPONSE_STATUS']._serialized_end=2133
+  _globals['_PROCESSORMETRICS']._serialized_start=2135
+  _globals['_PROCESSORMETRICS']._serialized_end=2242
+  _globals['_WINDOWTYPEREAD']._serialized_start=2244
+  _globals['_WINDOWTYPEREAD']._serialized_end=2260
+  _globals['_WINDOWTYPES']._serialized_start=2262
+  _globals['_WINDOWTYPES']._serialized_end=2305
+  _globals['_ALGORITHMSREAD']._serialized_start=2307
+  _globals['_ALGORITHMSREAD']._serialized_end=2323
+  _globals['_ALGORITHMS']._serialized_start=2325
+  _globals['_ALGORITHMS']._serialized_end=2368
+  _globals['_PROCESSORSREAD']._serialized_start=2370
+  _globals['_PROCESSORSREAD']._serialized_end=2386
+  _globals['_PROCESSORS']._serialized_start=2388
+  _globals['_PROCESSORS']._serialized_end=2486
+  _globals['_PROCESSORS_PROCESSOR']._serialized_start=2444
+  _globals['_PROCESSORS_PROCESSOR']._serialized_end=2486
+  _globals['_RESULTSSTATSREAD']._serialized_start=2488
+  _globals['_RESULTSSTATSREAD']._serialized_end=2506
+  _globals['_RESULTSSTATS']._serialized_start=2508
+  _globals['_RESULTSSTATS']._serialized_end=2537
+  _globals['_ORCACORE']._serialized_start=2654
+  _globals['_ORCACORE']._serialized_end=2960
+  _globals['_ORCAPROCESSOR']._serialized_start=2963
+  _globals['_ORCAPROCESSOR']._serialized_end=3093
 # @@protoc_insertion_point(module_scope)

service_pb2.pyi

@@ -34,12 +34,14 @@ class Window(_message.Message):
     def __init__(self, time_from: _Optional[int] = ..., time_to: _Optional[int] = ..., window_type_name: _Optional[str] = ..., window_type_version: _Optional[str] = ..., origin: _Optional[str] = ..., metadata: _Optional[_Union[_struct_pb2.Struct, _Mapping]] = ...) -> None: ...
 
 class WindowType(_message.Message):
-    __slots__ = ("name", "version")
+    __slots__ = ("name", "version", "description")
     NAME_FIELD_NUMBER: _ClassVar[int]
     VERSION_FIELD_NUMBER: _ClassVar[int]
+    DESCRIPTION_FIELD_NUMBER: _ClassVar[int]
     name: str
     version: str
-    def __init__(self, name: _Optional[str] = ..., version: _Optional[str] = ...) -> None: ...
+    description: str
+    def __init__(self, name: _Optional[str] = ..., version: _Optional[str] = ..., description: _Optional[str] = ...) -> None: ...
 
 class WindowEmitStatus(_message.Message):
     __slots__ = ("status",)

service_pb2_grpc.py

@@ -334,9 +334,7 @@ class OrcaCore(object):
 
 
 class OrcaProcessorStub(object):
-    """---------------------------- Core Operations ----------------------------
-
-    OrcaProcessor defines the interface that each processing node must implement.
+    """OrcaProcessor defines the interface that each processing node must implement.
     Processors are language-agnostic services that:
     - Execute individual algorithms
     - Handle their own internal state
@@ -363,9 +361,7 @@ class OrcaProcessorStub(object):
 
 
 class OrcaProcessorServicer(object):
-    """---------------------------- Core Operations ----------------------------
-
-    OrcaProcessor defines the interface that each processing node must implement.
+    """OrcaProcessor defines the interface that each processing node must implement.
     Processors are language-agnostic services that:
     - Execute individual algorithms
     - Handle their own internal state
@@ -410,9 +406,7 @@ def add_OrcaProcessorServicer_to_server(servicer, server):
 
  # This class is part of an EXPERIMENTAL API.
 class OrcaProcessor(object):
-    """---------------------------- Core Operations ----------------------------
-
-    OrcaProcessor defines the interface that each processing node must implement.
+    """OrcaProcessor defines the interface that each processing node must implement.
     Processors are language-agnostic services that:
     - Execute individual algorithms
     - Handle their own internal state