queueflow 0.1.0__py3-none-any.whl

queueflow/models/workflow.py

@@ -0,0 +1,130 @@
+# coding: utf-8
+
+"""
+    QueueFlow API
+
+    REST API for QueueFlow, a PostgreSQL-native distributed job queue and workflow engine.
+
+    The version of the OpenAPI document: 1.0.0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from datetime import datetime
+from pydantic import BaseModel, ConfigDict, Field, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from queueflow.models.workflow_status import WorkflowStatus
+from queueflow.models.workflow_step import WorkflowStep
+from typing import Optional, Set
+from typing_extensions import Self
+
+class Workflow(BaseModel):
+    """
+    A workflow instance and its steps.
+    """ # noqa: E501
+    completed_at: Optional[datetime] = None
+    context: Optional[Dict[str, Any]] = Field(default=None, description="Accumulated step results, keyed by step name. Passed to downstream steps under the `_context` payload key.")
+    created_at: datetime
+    id: StrictStr
+    metadata: Optional[Dict[str, Any]] = None
+    name: StrictStr
+    started_at: Optional[datetime] = None
+    status: WorkflowStatus
+    steps: List[WorkflowStep]
+    tenant_id: Optional[StrictStr] = None
+    __properties: ClassVar[List[str]] = ["completed_at", "context", "created_at", "id", "metadata", "name", "started_at", "status", "steps", "tenant_id"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of Workflow from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # override the default output from pydantic by calling `to_dict()` of each item in steps (list)
+        _items = []
+        if self.steps:
+            for _item_steps in self.steps:
+                if _item_steps:
+                    _items.append(_item_steps.to_dict())
+            _dict['steps'] = _items
+        # set to None if completed_at (nullable) is None
+        # and model_fields_set contains the field
+        if self.completed_at is None and "completed_at" in self.model_fields_set:
+            _dict['completed_at'] = None
+
+        # set to None if started_at (nullable) is None
+        # and model_fields_set contains the field
+        if self.started_at is None and "started_at" in self.model_fields_set:
+            _dict['started_at'] = None
+
+        # set to None if tenant_id (nullable) is None
+        # and model_fields_set contains the field
+        if self.tenant_id is None and "tenant_id" in self.model_fields_set:
+            _dict['tenant_id'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of Workflow from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "completed_at": obj.get("completed_at"),
+            "context": obj.get("context"),
+            "created_at": obj.get("created_at"),
+            "id": obj.get("id"),
+            "metadata": obj.get("metadata"),
+            "name": obj.get("name"),
+            "started_at": obj.get("started_at"),
+            "status": obj.get("status"),
+            "steps": [WorkflowStep.from_dict(_item) for _item in obj["steps"]] if obj.get("steps") is not None else None,
+            "tenant_id": obj.get("tenant_id")
+        })
+        return _obj
+
+

queueflow/models/workflow_diagram_response.py

@@ -0,0 +1,89 @@
+# coding: utf-8
+
+"""
+    QueueFlow API
+
+    REST API for QueueFlow, a PostgreSQL-native distributed job queue and workflow engine.
+
+    The version of the OpenAPI document: 1.0.0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field, StrictStr
+from typing import Any, ClassVar, Dict, List
+from typing import Optional, Set
+from typing_extensions import Self
+
+class WorkflowDiagramResponse(BaseModel):
+    """
+    WorkflowDiagramResponse
+    """ # noqa: E501
+    diagram: StrictStr = Field(description="The diagram document (Mermaid `graph TD`).")
+    format: StrictStr = Field(description="Diagram source format. Always `mermaid` today.")
+    __properties: ClassVar[List[str]] = ["diagram", "format"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of WorkflowDiagramResponse from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of WorkflowDiagramResponse from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "diagram": obj.get("diagram"),
+            "format": obj.get("format")
+        })
+        return _obj
+
+

queueflow/models/workflow_status.py

@@ -0,0 +1,41 @@
+# coding: utf-8
+
+"""
+    QueueFlow API
+
+    REST API for QueueFlow, a PostgreSQL-native distributed job queue and workflow engine.
+
+    The version of the OpenAPI document: 1.0.0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import json
+from enum import Enum
+from typing_extensions import Self
+
+
+class WorkflowStatus(str, Enum):
+    """
+    Lifecycle state of a workflow instance.
+    """
+
+    """
+    allowed enum values
+    """
+    CREATED = 'created'
+    RUNNING = 'running'
+    COMPLETED = 'completed'
+    FAILED = 'failed'
+    PARTIALLY_FAILED = 'partially_failed'
+    CANCELLED = 'cancelled'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of WorkflowStatus from a JSON string"""
+        return cls(json.loads(json_str))
+
+

queueflow/models/workflow_step.py

@@ -0,0 +1,112 @@
+# coding: utf-8
+
+"""
+    QueueFlow API
+
+    REST API for QueueFlow, a PostgreSQL-native distributed job queue and workflow engine.
+
+    The version of the OpenAPI document: 1.0.0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from queueflow.models.job_config import JobConfig
+from queueflow.models.on_failure import OnFailure
+from queueflow.models.on_success import OnSuccess
+from typing import Optional, Set
+from typing_extensions import Self
+
+class WorkflowStep(BaseModel):
+    """
+    A node in a workflow DAG. Steps are addressed by their unique `name`; `depends_on` lists the names of steps that must complete first.
+    """ # noqa: E501
+    config: Optional[JobConfig] = None
+    depends_on: Optional[List[StrictStr]] = None
+    metadata: Optional[Dict[str, Any]] = None
+    name: StrictStr
+    on_failure: Optional[OnFailure] = None
+    on_success: Optional[OnSuccess] = None
+    payload: Optional[Dict[str, Any]] = None
+    task_name: StrictStr
+    __properties: ClassVar[List[str]] = ["config", "depends_on", "metadata", "name", "on_failure", "on_success", "payload", "task_name"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of WorkflowStep from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # override the default output from pydantic by calling `to_dict()` of config
+        if self.config:
+            _dict['config'] = self.config.to_dict()
+        # set to None if config (nullable) is None
+        # and model_fields_set contains the field
+        if self.config is None and "config" in self.model_fields_set:
+            _dict['config'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of WorkflowStep from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "config": JobConfig.from_dict(obj["config"]) if obj.get("config") is not None else None,
+            "depends_on": obj.get("depends_on"),
+            "metadata": obj.get("metadata"),
+            "name": obj.get("name"),
+            "on_failure": obj.get("on_failure"),
+            "on_success": obj.get("on_success"),
+            "payload": obj.get("payload"),
+            "task_name": obj.get("task_name")
+        })
+        return _obj
+
+

queueflow/models/workflow_step_state.py

@@ -0,0 +1,97 @@
+# coding: utf-8
+
+"""
+    QueueFlow API
+
+    REST API for QueueFlow, a PostgreSQL-native distributed job queue and workflow engine.
+
+    The version of the OpenAPI document: 1.0.0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from queueflow.models.step_status import StepStatus
+from typing import Optional, Set
+from typing_extensions import Self
+
+class WorkflowStepState(BaseModel):
+    """
+    Runtime status of one workflow step (the live progress view).
+    """ # noqa: E501
+    job_id: Optional[StrictStr] = Field(default=None, description="The job executing this step, once one has been scheduled.")
+    name: StrictStr = Field(description="The step's name (its address within the workflow).")
+    status: StepStatus
+    __properties: ClassVar[List[str]] = ["job_id", "name", "status"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of WorkflowStepState from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # set to None if job_id (nullable) is None
+        # and model_fields_set contains the field
+        if self.job_id is None and "job_id" in self.model_fields_set:
+            _dict['job_id'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of WorkflowStepState from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "job_id": obj.get("job_id"),
+            "name": obj.get("name"),
+            "status": obj.get("status")
+        })
+        return _obj
+
+

queueflow/models/workflow_step_states_response.py

@@ -0,0 +1,95 @@
+# coding: utf-8
+
+"""
+    QueueFlow API
+
+    REST API for QueueFlow, a PostgreSQL-native distributed job queue and workflow engine.
+
+    The version of the OpenAPI document: 1.0.0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field
+from typing import Any, ClassVar, Dict, List
+from queueflow.models.workflow_step_state import WorkflowStepState
+from typing import Optional, Set
+from typing_extensions import Self
+
+class WorkflowStepStatesResponse(BaseModel):
+    """
+    WorkflowStepStatesResponse
+    """ # noqa: E501
+    steps: List[WorkflowStepState] = Field(description="One entry per step, in declaration order.")
+    __properties: ClassVar[List[str]] = ["steps"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of WorkflowStepStatesResponse from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # override the default output from pydantic by calling `to_dict()` of each item in steps (list)
+        _items = []
+        if self.steps:
+            for _item_steps in self.steps:
+                if _item_steps:
+                    _items.append(_item_steps.to_dict())
+            _dict['steps'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of WorkflowStepStatesResponse from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "steps": [WorkflowStepState.from_dict(_item) for _item in obj["steps"]] if obj.get("steps") is not None else None
+        })
+        return _obj
+
+