panda-server-source 0.8.0__py3-none-any.whl

pandaserver/workflow/workflow_base.py

@@ -0,0 +1,531 @@
+import json
+from collections import namedtuple
+from dataclasses import MISSING, InitVar, asdict, dataclass, field
+from datetime import datetime, timedelta
+from typing import Any, Dict, List
+
+# from pandacommon.pandalogger.PandaLogger import PandaLogger
+from pandacommon.pandautils.base import SpecBase
+
+from pandaserver.config import panda_config
+
+# main logger
+# logger = PandaLogger().getLogger(__name__.split(".")[-1])
+
+# named tuple for attribute with type
+AttributeWithType = namedtuple("AttributeWithType", ["attribute", "type"])
+
+
+# ==== Status of Entities ======================================
+
+
+class WorkflowStatus(object):
+    """
+    Class to define the status of workflows
+    """
+
+    registered = "registered"
+    parsed = "parsed"
+    checking = "checking"
+    checked = "checked"
+    starting = "starting"
+    running = "running"
+    done = "done"
+    failed = "failed"
+    cancelled = "cancelled"
+
+    active_statuses = (registered, parsed, checking, checked, starting, running)
+    final_statuses = (done, failed, cancelled)
+    transient_statuses = (parsed, checking, checked, starting)
+
+
+class WFStepStatus(object):
+    """
+    Class to define the status of workflow steps
+    """
+
+    registered = "registered"
+    checking = "checking"
+    checked_true = "checked_true"
+    checked_false = "checked_false"
+    pending = "pending"
+    ready = "ready"
+    starting = "starting"
+    running = "running"
+    done = "done"
+    failed = "failed"
+    closed = "closed"
+    cancelled = "cancelled"
+
+    checked_statuses = (checked_true, checked_false)
+    to_advance_step_statuses = (registered, checking, checked_true, checked_false, pending, ready, starting)
+    after_starting_statuses = (running, done, failed, cancelled)
+    after_starting_uninterrupted_statuses = (running, done, failed)
+    after_running_statuses = (done, failed, cancelled)
+    final_statuses = (done, failed, closed, cancelled)
+    transient_statuses = (checked_true, checked_false, ready)
+
+
+class WFDataStatus(object):
+    """
+    Class to define the status of workflow data
+    """
+
+    registered = "registered"
+    checking = "checking"
+    checked_nonexist = "checked_nonexist"  # data does not exist
+    checked_insuffi = "checked_insuffi"  # data available but insufficient to be step input
+    checked_suffice = "checked_suffice"  # data partially available and sufficient to be step input
+    checked_complete = "checked_complete"  # data completely available
+    binding = "binding"  # data being bound to a step to generate
+    generating_bound = "generating_bound"
+    generating_insuffi = "generating_insuffi"
+    generating_suffice = "generating_suffice"
+    waiting_insuffi = "waiting_insuffi"
+    waiting_suffice = "waiting_suffice"
+    done_generated = "done_generated"
+    done_waited = "done_waited"
+    done_skipped = "done_skipped"
+    cancelled = "cancelled"
+    retired = "retired"
+
+    checked_statuses = (checked_nonexist, checked_insuffi, checked_suffice, checked_complete)
+    generating_statuses = (generating_bound, generating_insuffi, generating_suffice)
+    waiting_statuses = (waiting_insuffi, waiting_suffice)
+    done_statuses = (done_generated, done_waited, done_skipped)
+    good_input_statuses = (generating_suffice, waiting_suffice, done_generated, done_waited, done_skipped)
+    good_output_statuses = (done_generated, done_waited, done_skipped)
+    after_generating_bound_statuses = (generating_suffice, done_generated, cancelled)
+    after_generating_suffice_statuses = (done_generated, cancelled)
+    after_waiting_suffice_statuses = (done_waited, cancelled)
+    terminated_statuses = (done_generated, done_waited, done_skipped, cancelled, retired)
+    nonreusable_statuses = (cancelled, retired)
+    transient_statuses = (checked_nonexist, checked_insuffi, checked_suffice, checked_complete)
+
+
+# ==== Types ===================================================
+
+
+class WFStepType(object):
+    """
+    Class to define the types of workflow steps
+    """
+
+    ...
+    ordinary = "ordinary"
+
+
+class WFDataType(object):
+    """
+    Class to define the types of workflow data
+    """
+
+    input = "input"
+    output = "output"
+    mid = "mid"
+
+
+# ==== Specifications ==========================================
+
+
+class WorkflowBaseSpec(SpecBase):
+    """
+    Base class for workflow related specifications
+    """
+
+    @property
+    def parameter_map(self) -> dict:
+        """
+        Get the dictionary parsed by the parameters attribute in JSON
+        Possible parameters:
+            ...
+
+        Returns:
+            dict : dict of parameters if it is JSON or empty dict if null
+        """
+        if self.parameters is None:
+            return {}
+        else:
+            return json.loads(self.parameters)
+
+    @parameter_map.setter
+    def parameter_map(self, value_map: dict):
+        """
+        Set the dictionary and store in parameters attribute in JSON
+
+        Args:
+            value_map (dict): dict to set the parameter map
+        """
+        self.parameters = json.dumps(value_map)
+
+    def get_parameter(self, param: str) -> Any:
+        """
+        Get the value of one parameter. None as default
+
+        Args:
+            param (str): parameter name
+
+        Returns:
+            Any : value of the parameter; None if parameter not set
+        """
+        tmp_dict = self.parameter_map
+        return tmp_dict.get(param)
+
+    def set_parameter(self, param: str, value):
+        """
+        Set the value of one parameter and store in parameters attribute in JSON
+
+        Args:
+            param (str): parameter name
+            value (Any): value of the parameter to set; must be JSON-serializable
+        """
+        tmp_dict = self.parameter_map
+        tmp_dict[param] = value
+        self.parameter_map = tmp_dict
+
+    def update_parameters(self, params: dict):
+        """
+        Update values of parameters with a dict and store in parameters attribute in JSON
+
+        Args:
+            params (dict): dict of parameter names and values to set
+        """
+        tmp_dict = self.parameter_map
+        tmp_dict.update(params)
+        self.parameter_map = tmp_dict
+
+
+class WorkflowSpec(WorkflowBaseSpec):
+    """
+    Workflow specification
+    """
+
+    # attributes with types
+    attributes_with_types = (
+        AttributeWithType("workflow_id", int),
+        AttributeWithType("name", str),
+        AttributeWithType("parent_id", int),
+        AttributeWithType("loop_count", int),
+        AttributeWithType("status", str),
+        AttributeWithType("prodsourcelabel", str),
+        AttributeWithType("username", str),
+        AttributeWithType("creation_time", datetime),
+        AttributeWithType("start_time", datetime),
+        AttributeWithType("end_time", datetime),
+        AttributeWithType("modification_time", datetime),
+        AttributeWithType("check_time", datetime),
+        AttributeWithType("locked_by", str),
+        AttributeWithType("lock_time", datetime),
+        AttributeWithType("raw_request_json", str),
+        AttributeWithType("definition_json", str),
+        AttributeWithType("parameters", str),
+    )
+    # attributes
+    attributes = tuple([attr.attribute for attr in attributes_with_types])
+    # attributes which have 0 by default
+    _zeroAttrs = ()
+    # attributes to force update
+    _forceUpdateAttrs = ()
+    # mapping between sequence and attr
+    _seqAttrMap = {"workflow_id": f"{panda_config.schemaJEDI}.WORKFLOW_ID_SEQ.nextval"}
+
+    @property
+    def raw_request_json_map(self) -> dict:
+        """
+        Get the dictionary parsed by raw_request_json attribute in JSON
+
+        Returns:
+            dict : dict of raw_request_json if it is JSON or empty dict if null
+        """
+        if self.raw_request_json is None:
+            return {}
+        else:
+            return json.loads(self.raw_request_json)
+
+    @raw_request_json_map.setter
+    def raw_request_json_map(self, value_map: dict):
+        """
+        Set the dictionary and store in raw_request_json attribute in JSON
+
+        Args:
+            value_map (dict): dict to set the raw_request_json map
+        """
+        self.raw_request_json = json.dumps(value_map)
+
+    @property
+    def definition_json_map(self) -> dict:
+        """
+        Get the dictionary parsed by definition_json attribute in JSON
+
+        Returns:
+            dict : dict of definition_json if it is JSON or empty dict if null
+        """
+        if self.definition_json is None:
+            return {}
+        else:
+            return json.loads(self.definition_json)
+
+    @definition_json_map.setter
+    def definition_json_map(self, value_map: dict):
+        """
+        Set the dictionary and store in definition_json attribute in JSON
+
+        Args:
+            value_map (dict): dict to set the definition_json map
+        """
+        self.definition_json = json.dumps(value_map)
+
+
+class WFStepSpec(WorkflowBaseSpec):
+    """
+    Workflow Step specification
+    """
+
+    # attributes with types
+    attributes_with_types = (
+        AttributeWithType("step_id", int),
+        AttributeWithType("name", str),
+        AttributeWithType("workflow_id", int),
+        AttributeWithType("member_id", int),
+        AttributeWithType("type", str),
+        AttributeWithType("status", str),
+        AttributeWithType("flavor", str),
+        AttributeWithType("target_id", str),
+        AttributeWithType("creation_time", datetime),
+        AttributeWithType("start_time", datetime),
+        AttributeWithType("end_time", datetime),
+        AttributeWithType("modification_time", datetime),
+        AttributeWithType("check_time", datetime),
+        AttributeWithType("locked_by", str),
+        AttributeWithType("lock_time", datetime),
+        AttributeWithType("definition_json", str),
+        AttributeWithType("parameters", str),
+    )
+    # attributes
+    attributes = tuple([attr.attribute for attr in attributes_with_types])
+    # attributes which have 0 by default
+    _zeroAttrs = ()
+    # attributes to force update
+    _forceUpdateAttrs = ()
+    # mapping between sequence and attr
+    _seqAttrMap = {"step_id": f"{panda_config.schemaJEDI}.WORKFLOW_STEP_ID_SEQ.nextval"}
+
+    @property
+    def definition_json_map(self) -> dict:
+        """
+        Get the dictionary parsed by definition_json attribute in JSON
+
+        Returns:
+            dict : dict of definition_json if it is JSON or empty dict if null
+        """
+        if self.definition_json is None:
+            return {}
+        else:
+            return json.loads(self.definition_json)
+
+    @definition_json_map.setter
+    def definition_json_map(self, value_map: dict):
+        """
+        Set the dictionary and store in definition_json attribute in JSON
+
+        Args:
+            value_map (dict): dict to set the definition_json map
+        """
+        self.definition_json = json.dumps(value_map)
+
+
+class WFDataSpec(WorkflowBaseSpec):
+    """
+    Workflow Data specification
+    """
+
+    # attributes with types
+    attributes_with_types = (
+        AttributeWithType("data_id", int),
+        AttributeWithType("name", str),
+        AttributeWithType("workflow_id", int),
+        AttributeWithType("source_step_id", int),
+        AttributeWithType("type", str),
+        AttributeWithType("status", str),
+        AttributeWithType("flavor", str),
+        AttributeWithType("target_id", str),
+        AttributeWithType("creation_time", datetime),
+        AttributeWithType("start_time", datetime),
+        AttributeWithType("end_time", datetime),
+        AttributeWithType("modification_time", datetime),
+        AttributeWithType("check_time", datetime),
+        AttributeWithType("locked_by", str),
+        AttributeWithType("lock_time", datetime),
+        AttributeWithType("metadata", str),
+        AttributeWithType("parameters", str),
+    )
+    # attributes
+    attributes = tuple([attr.attribute for attr in attributes_with_types])
+    # attributes which have 0 by default
+    _zeroAttrs = ()
+    # attributes to force update
+    _forceUpdateAttrs = ()
+    # mapping between sequence and attr
+    _seqAttrMap = {"data_id": f"{panda_config.schemaJEDI}.WORKFLOW_DATA_ID_SEQ.nextval"}
+
+    @property
+    def metadata_map(self) -> dict:
+        """
+        Get the dictionary parsed by metadata attribute in JSON
+
+        Returns:
+            dict : dict of metadata if it is JSON or empty dict if null
+        """
+        if self.metadata is None:
+            return {}
+        else:
+            return json.loads(self.metadata)
+
+    @metadata_map.setter
+    def metadata_map(self, value_map: dict):
+        """
+        Set the dictionary and store in metadata attribute in JSON
+
+        Args:
+            value_map (dict): dict to set the metadata map
+        """
+        self.metadata = json.dumps(value_map)
+
+
+# === Return objects of core methods which process status ======
+
+
+@dataclass(slots=True)
+class WFDataProcessResult:
+    """
+    Result of processing data.
+
+    Fields:
+        success (bool | None): Indicates if the processing was successful.
+        new_status (WFDataStatus | None): The new status of the data after processing, None if no change.
+        message (str): A message providing additional information about the processing result.
+    """
+
+    success: bool | None = None
+    new_status: WFDataStatus | None = None
+    message: str = ""
+
+
+@dataclass(slots=True)
+class WFStepProcessResult:
+    """
+    Result of processing a step.
+
+    Fields:
+        success (bool | None): Indicates if the processing was successful.
+        new_status (WFStepStatus | None): The new status of the step after processing, None if no change.
+        message (str): A message providing additional information about the processing result.
+    """
+
+    success: bool | None = None
+    new_status: WFStepStatus | None = None
+    message: str = ""
+
+
+@dataclass(slots=True)
+class WorkflowProcessResult:
+    """
+    Result of processing a workflow.
+
+    Fields:
+        success (bool | None): Indicates if the processing was successful.
+        new_status (WorkflowStatus | None): The new status of the workflow after processing, None if no change.
+        message (str): A message providing additional information about the processing result.
+    """
+
+    success: bool | None = None
+    new_status: WorkflowStatus | None = None
+    message: str = ""
+
+
+# === Return objects of step handler methods ===================
+
+
+@dataclass(slots=True)
+class WFStepTargetSubmitResult:
+    """
+    Result of submitting a target of a step.
+
+    Fields:
+        success (bool | None): Indicates if the submission was successful.
+        target_id (str | None): The ID of the submitted target (e.g., task ID).
+        message (str): A message providing additional information about the submission result.
+    """
+
+    success: bool | None = None
+    target_id: str | None = None
+    message: str = ""
+
+
+@dataclass(slots=True)
+class WFStepTargetCheckResult:
+    """
+    Result of checking the status of a submitted target.
+
+    Fields:
+        success (bool | None): Indicates if the status check was successful.
+        status (WFStepStatus | None): The status of the step to move to.
+        native_status (str | None): The native status string from the target system.
+        message (str): A message providing additional information about the status check result.
+    """
+
+    success: bool | None = None
+    step_status: WFStepStatus | None = None
+    native_status: str | None = None
+    message: str = ""
+
+
+@dataclass(slots=True)
+class WFStepTargetCancelResult:
+    """
+    Result of cancelling a target of a step.
+
+    Fields:
+        success (bool | None): Indicates if the cancellation was successful.
+        target_id (str | None): The ID of the cancelled target (e.g., task ID).
+        message (str): A message providing additional information about the cancellation result.
+    """
+
+    success: bool | None = None
+    target_id: str | None = None
+    message: str = ""
+
+
+# ==== Return objects of data handler methods ==================
+
+
+class WFDataTargetCheckStatus:
+    """
+    Possible statuses returned by data target check
+    """
+
+    complete = "complete"  # data completely exists
+    suffice = "suffice"  # data partially exists and suffices to be step input
+    insuffi = "insuffi"  # data partially exists but is insufficient to be step input
+    nonexist = "nonexist"  # data does not exist
+
+
+@dataclass(slots=True)
+class WFDataTargetCheckResult:
+    """
+    Result of checking the status of a data target.
+
+    Fields:
+        success (bool | None): Indicates if the status check was successful.
+        check_status (WFDataTargetCheckStatus | None): The status of the data target.
+        metadata (dict | None): The native metadata from the target system.
+        message (str): A message providing additional information about the status check result.
+    """
+
+    success: bool | None = None
+    check_status: WFDataTargetCheckStatus | None = None
+    metadata: dict | None = None
+    message: str = ""
+
+
+# ==============================================================