move task.proto to omotes-sdk-protocol

ci/linux/gen_protocol.sh

@@ -12,3 +12,13 @@ protoc -I include/ -I src/ --python_out python/src/omotes_sdk_protocol/ ./src/wo
 protoc -I include/ -I src/ --mypy_out python/src/omotes_sdk_protocol/ ./src/workflow.proto
 touch python/src/omotes_sdk_protocol/__init__.py
 touch python/src/omotes_sdk_protocol/py.typed
+
+protoc -I include/ -I src/ --python_out python/src/omotes_sdk_protocol/ ./src/internal/task.proto
+protoc -I include/ -I src/ --mypy_out python/src/omotes_sdk_protocol/ ./src/internal/task.proto
+protoc -I include/ -I src/ --python_out python/src/omotes_sdk_protocol/ ./src/internal/task.proto
+protoc -I include/ -I src/ --mypy_out python/src/omotes_sdk_protocol/ ./src/internal/task.proto
+touch python/src/omotes_sdk_protocol/internal/__init__.py
+touch python/src/omotes_sdk_protocol/internal/py.typed
+
+sed -i 's/import job_pb2/from .. import job_pb2/g' python/src/omotes_sdk_protocol/internal/task_pb2.py
+sed -i 's/import job_pb2/from .. import job_pb2/g' python/src/omotes_sdk_protocol/internal/task_pb2.pyi

python/src/omotes_sdk_protocol/internal/task_pb2.pyi

@@ -0,0 +1,112 @@
+"""
+@generated by mypy-protobuf.  Do not edit manually!
+isort:skip_file
+"""
+import builtins
+import collections.abc
+import google.protobuf.descriptor
+import google.protobuf.internal.containers
+import google.protobuf.internal.enum_type_wrapper
+import google.protobuf.message
+from .. import job_pb2
+import sys
+import typing
+
+if sys.version_info >= (3, 10):
+    import typing as typing_extensions
+else:
+    import typing_extensions
+
+DESCRIPTOR: google.protobuf.descriptor.FileDescriptor
+
+@typing_extensions.final
+class TaskResult(google.protobuf.message.Message):
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+
+    class _ResultType:
+        ValueType = typing.NewType("ValueType", builtins.int)
+        V: typing_extensions.TypeAlias = ValueType
+
+    class _ResultTypeEnumTypeWrapper(google.protobuf.internal.enum_type_wrapper._EnumTypeWrapper[TaskResult._ResultType.ValueType], builtins.type):
+        DESCRIPTOR: google.protobuf.descriptor.EnumDescriptor
+        SUCCEEDED: TaskResult._ResultType.ValueType  # 0
+        ERROR: TaskResult._ResultType.ValueType  # 1
+
+    class ResultType(_ResultType, metaclass=_ResultTypeEnumTypeWrapper): ...
+    SUCCEEDED: TaskResult.ResultType.ValueType  # 0
+    ERROR: TaskResult.ResultType.ValueType  # 1
+
+    JOB_ID_FIELD_NUMBER: builtins.int
+    CELERY_TASK_ID_FIELD_NUMBER: builtins.int
+    CELERY_TASK_TYPE_FIELD_NUMBER: builtins.int
+    RESULT_TYPE_FIELD_NUMBER: builtins.int
+    OUTPUT_ESDL_FIELD_NUMBER: builtins.int
+    LOGS_FIELD_NUMBER: builtins.int
+    ESDL_MESSAGES_FIELD_NUMBER: builtins.int
+    job_id: builtins.str
+    celery_task_id: builtins.str
+    celery_task_type: builtins.str
+    result_type: global___TaskResult.ResultType.ValueType
+    output_esdl: builtins.str
+    logs: builtins.str
+    @property
+    def esdl_messages(self) -> google.protobuf.internal.containers.RepeatedCompositeFieldContainer[job_pb2.EsdlMessage]: ...
+    def __init__(
+        self,
+        *,
+        job_id: builtins.str = ...,
+        celery_task_id: builtins.str = ...,
+        celery_task_type: builtins.str = ...,
+        result_type: global___TaskResult.ResultType.ValueType = ...,
+        output_esdl: builtins.str | None = ...,
+        logs: builtins.str = ...,
+        esdl_messages: collections.abc.Iterable[job_pb2.EsdlMessage] | None = ...,
+    ) -> None: ...
+    def HasField(self, field_name: typing_extensions.Literal["_output_esdl", b"_output_esdl", "output_esdl", b"output_esdl"]) -> builtins.bool: ...
+    def ClearField(self, field_name: typing_extensions.Literal["_output_esdl", b"_output_esdl", "celery_task_id", b"celery_task_id", "celery_task_type", b"celery_task_type", "esdl_messages", b"esdl_messages", "job_id", b"job_id", "logs", b"logs", "output_esdl", b"output_esdl", "result_type", b"result_type"]) -> None: ...
+    def WhichOneof(self, oneof_group: typing_extensions.Literal["_output_esdl", b"_output_esdl"]) -> typing_extensions.Literal["output_esdl"] | None: ...
+
+global___TaskResult = TaskResult
+
+@typing_extensions.final
+class TaskProgressUpdate(google.protobuf.message.Message):
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+
+    class _ProgressStatus:
+        ValueType = typing.NewType("ValueType", builtins.int)
+        V: typing_extensions.TypeAlias = ValueType
+
+    class _ProgressStatusEnumTypeWrapper(google.protobuf.internal.enum_type_wrapper._EnumTypeWrapper[TaskProgressUpdate._ProgressStatus.ValueType], builtins.type):
+        DESCRIPTOR: google.protobuf.descriptor.EnumDescriptor
+        START: TaskProgressUpdate._ProgressStatus.ValueType  # 0
+
+    class ProgressStatus(_ProgressStatus, metaclass=_ProgressStatusEnumTypeWrapper): ...
+    START: TaskProgressUpdate.ProgressStatus.ValueType  # 0
+
+    JOB_ID_FIELD_NUMBER: builtins.int
+    CELERY_TASK_ID_FIELD_NUMBER: builtins.int
+    CELERY_TASK_TYPE_FIELD_NUMBER: builtins.int
+    STATUS_FIELD_NUMBER: builtins.int
+    PROGRESS_FIELD_NUMBER: builtins.int
+    MESSAGE_FIELD_NUMBER: builtins.int
+    job_id: builtins.str
+    celery_task_id: builtins.str
+    celery_task_type: builtins.str
+    status: global___TaskProgressUpdate.ProgressStatus.ValueType
+    progress: builtins.float
+    message: builtins.str
+    def __init__(
+        self,
+        *,
+        job_id: builtins.str = ...,
+        celery_task_id: builtins.str = ...,
+        celery_task_type: builtins.str = ...,
+        status: global___TaskProgressUpdate.ProgressStatus.ValueType = ...,
+        progress: builtins.float = ...,
+        message: builtins.str = ...,
+    ) -> None: ...
+    def HasField(self, field_name: typing_extensions.Literal["progress", b"progress", "progress_type", b"progress_type", "status", b"status"]) -> builtins.bool: ...
+    def ClearField(self, field_name: typing_extensions.Literal["celery_task_id", b"celery_task_id", "celery_task_type", b"celery_task_type", "job_id", b"job_id", "message", b"message", "progress", b"progress", "progress_type", b"progress_type", "status", b"status"]) -> None: ...
+    def WhichOneof(self, oneof_group: typing_extensions.Literal["progress_type", b"progress_type"]) -> typing_extensions.Literal["status", "progress"] | None: ...
+
+global___TaskProgressUpdate = TaskProgressUpdate

python/src/omotes_sdk_protocol/job_pb2.pyi

@@ -137,9 +137,11 @@ class EsdlMessage(google.protobuf.message.Message):
         *,
         technical_message: builtins.str = ...,
         severity: global___EsdlMessage.Severity.ValueType = ...,
-        esdl_object_id: builtins.str = ...,
+        esdl_object_id: builtins.str | None = ...,
     ) -> None: ...
-    def ClearField(self, field_name: typing_extensions.Literal["esdl_object_id", b"esdl_object_id", "severity", b"severity", "technical_message", b"technical_message"]) -> None: ...
+    def HasField(self, field_name: typing_extensions.Literal["_esdl_object_id", b"_esdl_object_id", "esdl_object_id", b"esdl_object_id"]) -> builtins.bool: ...
+    def ClearField(self, field_name: typing_extensions.Literal["_esdl_object_id", b"_esdl_object_id", "esdl_object_id", b"esdl_object_id", "severity", b"severity", "technical_message", b"technical_message"]) -> None: ...
+    def WhichOneof(self, oneof_group: typing_extensions.Literal["_esdl_object_id", b"_esdl_object_id"]) -> typing_extensions.Literal["esdl_object_id"] | None: ...
 
 global___EsdlMessage = EsdlMessage
 

src/internal/task.proto

@@ -0,0 +1,33 @@
+syntax = "proto3";
+
+import "job.proto";
+
+message TaskResult {
+  string job_id = 1;
+  string celery_task_id = 2;
+  string celery_task_type = 6;
+  ResultType result_type = 3;
+  optional string output_esdl = 4;
+  string logs = 5;
+  repeated EsdlMessage esdl_messages = 7;
+
+  enum ResultType {
+    SUCCEEDED = 0;
+    ERROR = 1;
+  }
+}
+
+message TaskProgressUpdate {
+  string job_id = 1;
+  string celery_task_id = 2;
+  string celery_task_type = 5;
+  oneof progress_type {
+    ProgressStatus status = 6;
+    double progress = 7;
+  }
+  string message = 4;
+
+  enum ProgressStatus {
+    START = 0;
+  }
+}

src/job.proto

@@ -28,7 +28,7 @@ message JobResult {
 message EsdlMessage {
   string technical_message = 1;
   Severity severity = 2;
-  string esdl_object_id = 3; // can be omitted for general energy system messages
+  optional string esdl_object_id = 3; // can be omitted for general energy system messages
 
   enum Severity {
     DEBUG = 0;