refactor: Change APIAdapter name and general housekeeping (and Python 3.13)

Author: Alan Christie

poetry.lock

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "im-data-manager-workflow-engine"
-version = "0.1.0"
+version = "1.0.0"
 description = "The Data Manager workflow engine, schema and decoder."
 authors = [
     "Alan Christie <[email protected]>",
@@ -12,7 +12,7 @@ packages = [
 ]
 
 [tool.poetry.dependencies]
-python = "^3.12"
+python = "^3.13"
 im-protobuf = "^8.2.0"
 im-data-manager-job-decoder = "^2.1.0"
 jsonschema = "^4.21.1"

pyproject.toml

@@ -22,7 +22,7 @@
 
 import yaml
 
-from workflow.workflow_abc import APIAdapter
+from workflow.workflow_abc import WorkflowAPIAdapter
 
 # Load the Unit test Job Definitions file now.
 _JOB_DEFINITION_FILE: str = os.path.join(
@@ -52,7 +52,7 @@
 _TASK_PICKLE_FILE: str = f"{_PICKLE_DIRECTORY}/task.pickle"
 
 
-class UnitTestAPIAdapter(APIAdapter):
+class UnitTestAPIAdapter(WorkflowAPIAdapter):
     """A minimal API adapter. It serves-up Job Definitions
     from the job-definitions/job-definitions.yaml file and provides basic
     storage for Workflow Definitions and related tables.

tests/api_adapter.py

@@ -16,7 +16,7 @@ def basic_validator():
     api_adapter = UnitTestAPIAdapter()
     msg_queue = UnitTestMessageQueue()
     msg_dispatcher = UnitTestMessageDispatcher(msg_queue=msg_queue)
-    return WorkflowValidator(api_adapter=api_adapter, msg_dispatcher=msg_dispatcher)
+    return WorkflowValidator(wapi_adapter=api_adapter, msg_dispatcher=msg_dispatcher)
 
 
 def test_validate_minimal_for_create(basic_validator):

tests/test_worflow_validator.py

@@ -26,7 +26,7 @@ def basic_engine():
         api_adapter=api_adapter, msg_dispatcher=message_dispatcher
     )
     workflow_engine = WorkflowEngine(
-        api_adapter=api_adapter, instance_launcher=instance_launcher
+        wapi_adapter=api_adapter, instance_launcher=instance_launcher
     )
     message_queue.set_receiver(workflow_engine.handle_message)
     print("Starting message queue...")

tests/test_workflow_engine_examples.py

@@ -4,7 +4,7 @@
 """
 
 import os
-from typing import Any, Dict, Optional
+from typing import Any
 
 import jsonschema
 import yaml
@@ -19,11 +19,11 @@
 # This must work as the file is installed along with this module.
 assert os.path.isfile(_WORKFLOW_SCHEMA_FILE)
 with open(_WORKFLOW_SCHEMA_FILE, "r", encoding="utf8") as schema_file:
-    _WORKFLOW_SCHEMA: Dict[str, Any] = yaml.load(schema_file, Loader=yaml.FullLoader)
+    _WORKFLOW_SCHEMA: dict[str, Any] = yaml.load(schema_file, Loader=yaml.FullLoader)
 assert _WORKFLOW_SCHEMA
 
 
-def validate_schema(workflow: Dict[str, Any]) -> Optional[str]:
+def validate_schema(workflow: dict[str, Any]) -> str | None:
     """Checks the Workflow Definition against the built-in schema.
     If there's an error the error text is returned, otherwise None.
     """

workflow/decoder.py

@@ -1,10 +1,10 @@
 """Workflow abstract base classes.
-Interface definitions of class instances that must be provided to the Engine.
+Interface definitions of class instances that must be made available to the Engine.
 """
 
 from abc import ABC, abstractmethod
 from dataclasses import dataclass
-from typing import Any, Dict, List, Optional
+from typing import Any
 
 from google.protobuf.message import Message
 
@@ -14,10 +14,10 @@ class LaunchResult:
     """Results returned from methods in the InstanceLauncher."""
 
     error: int
-    error_msg: Optional[str]
-    instance_id: Optional[str]
-    task_id: Optional[str]
-    command: Optional[str]
+    error_msg: str | None
+    instance_id: str | None
+    task_id: str | None
+    command: str | None
 
 
 class InstanceLauncher(ABC):
@@ -31,7 +31,7 @@ def launch(
         running_workflow_id: str,
         running_workflow_step_id: str,
         step_specification: str,
-        variables: Dict[str, Any],
+        variables: dict[str, Any],
     ) -> LaunchResult:
         """Launch a (Job) Instance"""
 
@@ -48,17 +48,18 @@ def launch(
         # See _instance_preamble() in the DM's api_instance.py module.
 
 
-class APIAdapter(ABC):
-    """The APIAdapter providing read/write access to the Model. It provides
-    the ability to create and retrieve Workflow, RunningWorkflow and RunningWorkflowStep
-    records returning dictionary (API-like) responses."""
+class WorkflowAPIAdapter(ABC):
+    """The APIAdapter providing read/write access to various Workflow tables and records
+    in the Model that is owned by the DM. It provides the ability to create and retrieve
+    Workflow, RunningWorkflow and RunningWorkflowStep records returning dictionary
+    (API-like) responses."""
 
     @abstractmethod
     def create_workflow(
         self,
         *,
-        workflow_definition: Dict[str, Any],
-    ) -> Dict[str, Any]:
+        workflow_definition: dict[str, Any],
+    ) -> dict[str, Any]:
         """Create a Workflow, getting an ID in return"""
         # Should return:
         # {
@@ -70,7 +71,7 @@ def get_workflow(
         self,
         *,
         workflow_id: str,
-    ) -> Dict[str, Any]:
+    ) -> dict[str, Any]:
         """Get a Workflow Record by ID."""
         # If present this should return:
         # {
@@ -83,7 +84,7 @@ def get_workflow_by_name(
         *,
         name: str,
         version: str,
-    ) -> Dict[str, Any]:
+    ) -> dict[str, Any]:
         """Get a Workflow Record by name"""
         # If present this should return:
         # {
@@ -97,9 +98,9 @@ def create_running_workflow(
         *,
         workflow_id: str,
         project_id: str,
-        variables: Dict[str, Any],
+        variables: dict[str, Any],
         user_id: str,
-    ) -> Dict[str, Any]:
+    ) -> dict[str, Any]:
         """Create a RunningWorkflow Record (from a Workflow)"""
         # Should return:
         # {
@@ -112,14 +113,14 @@ def set_running_workflow_done(
         *,
         running_workflow_id: str,
         success: bool,
-        error: Optional[int] = None,
-        error_msg: Optional[str] = None,
+        error: int | None = None,
+        error_msg: str | None = None,
     ) -> None:
         """Set the success value for a RunningWorkflow Record.
         If not successful an error code and message should be provided."""
 
     @abstractmethod
-    def get_running_workflow(self, *, running_workflow_id: str) -> Dict[str, Any]:
+    def get_running_workflow(self, *, running_workflow_id: str) -> dict[str, Any]:
         """Get a RunningWorkflow Record"""
         # Should return:
         # {
@@ -141,7 +142,7 @@ def create_running_workflow_step(
         *,
         running_workflow_id: str,
         step: str,
-    ) -> Dict[str, Any]:
+    ) -> dict[str, Any]:
         """Create a RunningWorkflowStep Record (from a RunningWorkflow)"""
         # Should return:
         # {
@@ -151,7 +152,7 @@ def create_running_workflow_step(
     @abstractmethod
     def get_running_workflow_step(
         self, *, running_workflow_step_id: str
-    ) -> Dict[str, Any]:
+    ) -> dict[str, Any]:
         """Get a RunningWorkflowStep Record"""
         # Should return:
         # {
@@ -171,16 +172,16 @@ def set_running_workflow_step_done(
         *,
         running_workflow_step_id: str,
         success: bool,
-        error: Optional[int] = None,
-        error_msg: Optional[str] = None,
+        error: int | None = None,
+        error_msg: str | None = None,
     ) -> None:
         """Set the success value for a RunningWorkflowStep Record,
         If not successful an error code and message should be provided."""
 
     @abstractmethod
     def get_running_workflow_steps(
         self, *, running_workflow_id: str
-    ) -> List[Dict[str, Any]]:
+    ) -> list[dict[str, Any]]:
         """Gets all the RunningWorkflowStep Records (for a RunningWorkflow)"""
         # Should return:
         # {
@@ -201,7 +202,7 @@ def get_running_workflow_steps(
         # }
 
     @abstractmethod
-    def create_instance(self, running_workflow_step_id: str) -> Dict[str, Any]:
+    def create_instance(self, running_workflow_step_id: str) -> dict[str, Any]:
         """Create an Instance Record (for a RunningWorkflowStep)"""
         # Should return:
         # {
@@ -210,7 +211,7 @@ def create_instance(self, running_workflow_step_id: str) -> Dict[str, Any]:
         # }
 
     @abstractmethod
-    def get_instance(self, *, instance_id: str) -> Dict[str, Any]:
+    def get_instance(self, *, instance_id: str) -> dict[str, Any]:
         """Get an Instance Record"""
         # Should return:
         # {
@@ -219,15 +220,15 @@ def get_instance(self, *, instance_id: str) -> Dict[str, Any]:
         # }
 
     @abstractmethod
-    def create_task(self, instance_id: str) -> Dict[str, Any]:
-        """Create a Task Record (for amn Instance)"""
+    def create_task(self, instance_id: str) -> dict[str, Any]:
+        """Create a Task Record (for an Instance)"""
         # Should return:
         # {
         #    "id": "task-00000000-0000-0000-0000-000000000001",
         # }
 
     @abstractmethod
-    def get_task(self, *, task_id: str) -> Dict[str, Any]:
+    def get_task(self, *, task_id: str) -> dict[str, Any]:
         """Get a Task Record"""
         # Should return:
         # {
@@ -243,7 +244,7 @@ def get_job(
         collection: str,
         job: str,
         version: str,
-    ) -> Optional[Dict[str, Any]]:
+    ) -> dict[str, Any] | None:
         """Get a Job"""