Refactor: relocate interface definitions, update imports, and enhance type annotations across modules

Author: coordt

.beads/interactions.jsonl

@@ -7,7 +7,7 @@
 
 if TYPE_CHECKING:
     from pybpmn_server.datastore.data_objects import BpmnModelData, EventData, InstanceData, ItemData
-    from pybpmn_server.interfaces.elements import IDefinition
+    from pybpmn_server.elements.interfaces import IDefinition
 
 
 @dataclass

pybpmn_server/datastore/interfaces.py

@@ -10,7 +10,7 @@
 from pybpmn_server.datastore.mongodb import MongoDB
 from pybpmn_server.datastore.query_translator import QueryTranslator
 from pybpmn_server.elements.definition import Definition
-from pybpmn_server.interfaces.elements import IDefinition
+from pybpmn_server.elements.interfaces import IDefinition
 
 
 class ModelsDatastore(IModelsDatastore):

pybpmn_server/datastore/model_data_store.py

@@ -22,8 +22,8 @@
 if TYPE_CHECKING:
     from pybpmn_server.common.default_configuration import Settings
     from pybpmn_server.datastore.data_objects import ItemData
+    from pybpmn_server.elements.interfaces import Element, INode
     from pybpmn_server.interfaces.common import AppDelegateBase
-    from pybpmn_server.interfaces.elements import Element, INode
     from pybpmn_server.interfaces.enums import NodeAction, TokenType
     from pybpmn_server.interfaces.server import IBPMNServer
 

pybpmn_server/interfaces/elements.py pybpmn_server/elements/interfaces.pypybpmn_server/interfaces/elements.py renamed to pybpmn_server/elements/interfaces.py

@@ -13,7 +13,7 @@
 from pybpmn_server.interfaces.enums import ItemStatus
 
 if TYPE_CHECKING:
-    from pybpmn_server.interfaces.elements import Element, INode
+    from pybpmn_server.elements.interfaces import Element, INode
 
 
 class Item(IItem):

pybpmn_server/engine/interfaces.py

@@ -16,7 +16,7 @@
 
 if TYPE_CHECKING:
     from pybpmn_server.engine.interfaces import IExecution, IToken
-    from pybpmn_server.interfaces.elements import INode
+    from pybpmn_server.elements.interfaces import INode
 
 
 class Loop:

pybpmn_server/engine/item.py

@@ -42,7 +42,7 @@
     from pybpmn_server.engine.execution import Execution
     from pybpmn_server.engine.interfaces import IExecution, IItem
     from pybpmn_server.engine.loop import Loop
-    from pybpmn_server.interfaces.elements import INode
+    from pybpmn_server.elements.interfaces import INode
 
 
 class Token(IToken):

pybpmn_server/engine/loop.py

@@ -1,12 +1,12 @@
+"""Common interfaces."""
+
 from __future__ import annotations
 
-from pathlib import Path
-from typing import TYPE_CHECKING, Any, Callable, Dict, List, Mapping, Optional, Protocol, Union
+from abc import ABC, abstractmethod
+from typing import TYPE_CHECKING, Any, Callable, Dict, Optional, Protocol, TypeAlias, Mapping
 
 if TYPE_CHECKING:
-    from .datastore import IDataStore, IModelsDatastore
-    from .engine import IExecution, IItem, IScriptHandler
-    from .server import ICacheManager
+    from pybpmn_server.engine.interfaces import IExecution, IItem
 
 
 class IMongoDBDatabaseConfiguration(Protocol):
@@ -17,48 +17,57 @@ class ISQLiteDatabaseConfiguration(Protocol):
     SQLite: Dict[str, str]
 
 
-class IConfiguration(Protocol):
-    definitions_path: Optional[Path]
-    templates_path: Optional[Path]
-    timers: Mapping[str, int | float]
-    database: Union[IMongoDBDatabaseConfiguration, ISQLiteDatabaseConfiguration, Any]
-    api_key: str
-
-    def definitions(self, server: Any) -> IModelsDatastore: ...
-    def app_delegate(self, server: Any) -> IAppDelegate: ...
-    def data_store(self, server: Any) -> IDataStore: ...
-    def script_handler(self, server: Any) -> IScriptHandler: ...
-    def cache_manager(self, server: Any) -> ICacheManager: ...
-
-
-class ILogger(Protocol):
-    def set_options(self, options: Dict[str, Any]) -> None: ...
-    def clear(self) -> None: ...
-    def get(self) -> List[Any]: ...
-    def debug(self, *message: Any) -> Any: ...
-    def warn(self, *message: Any) -> Any: ...
-    def log(self, *message: Any) -> Any: ...
-    def error(self, err: Any) -> None: ...
-    def report_error(self, err: Any) -> None: ...
-    async def save(self, filename: Any) -> None: ...
-    async def save_for_instance(self, instance_id: str) -> Any: ...
-
-
-class IServiceProvider(Protocol):
-    # In Python, we can't easily express string indexer for different types in one Protocol
-    # without using __getitem__ or similar, but for migration we use Any for indexer.
-    def __getitem__(self, key: str) -> Union[Callable[..., Any], IServiceProvider]: ...
-
-
-class IAppDelegate(Protocol):
-    moddle_options: Any
-
-    def get_services_provider(self, execution: IExecution) -> Union[IServiceProvider, Any]: ...  # Simplified Promise
-    def send_email(self, to: Any, msg: Any, body: Any) -> Any: ...
-    def execution_started(self, execution: IExecution) -> Any: ...
-    def start_up(self, options: Any) -> Any: ...
-    def message_thrown(self, message_id: str, data: Any, message_matching_key: Any, item: IItem) -> Any: ...
-    def signal_thrown(self, signal_id: str, data: Any, message_matching_key: Any, item: IItem) -> Any: ...
-    def issue_message(self, message_id: str, data: Any) -> Any: ...
-    def issue_signal(self, message_id: str, data: Any) -> Any: ...
-    def service_called(self, kwargs: Dict[str, Any], execution: IExecution, item: IItem) -> Any: ...
+# In Python, we can't easily express string indexer for different types in one Protocol
+# without using __getitem__ or similar, but for migration we use Any for indexer.
+IServiceProvider: TypeAlias = Mapping[str, Callable[..., Any] | "IServiceProvider"]  # noqa: TC010
+
+
+class AppDelegateBase(ABC):
+    """
+    Application Delegate Object to respond to various events and services.
+
+    1.  Receive all events from the workflow
+    2.  Receive service calls
+    3.  Receive message and signal calls
+    4.  Execute scripts
+    """
+
+    def __init__(self, server: Any, moddle_options: Optional[Dict[str, Any]] = None):
+        self.server = server
+        self.moddle_options = moddle_options
+
+    @abstractmethod
+    async def get_services_provider(self, execution: IExecution) -> IServiceProvider:
+        pass  # Simplified Promise
+
+    @abstractmethod
+    def send_email(self, to: Any, msg: Any, body: Any) -> Any:
+        pass
+
+    @abstractmethod
+    def execution_started(self, execution: IExecution) -> Any:
+        pass
+
+    @abstractmethod
+    def start_up(self, options: Any) -> Any:
+        pass
+
+    @abstractmethod
+    def message_thrown(self, message_id: str, data: Any, message_matching_key: Any, item: IItem) -> Any:
+        pass
+
+    @abstractmethod
+    def signal_thrown(self, signal_id: str, data: Any, message_matching_key: Any, item: IItem) -> Any:
+        pass
+
+    @abstractmethod
+    def issue_message(self, message_id: str, data: Any) -> Any:
+        pass
+
+    @abstractmethod
+    def issue_signal(self, message_id: str, data: Any) -> Any:
+        pass
+
+    @abstractmethod
+    def service_called(self, kwargs: Dict[str, Any], execution: IExecution, item: IItem) -> Any:
+        pass

pybpmn_server/engine/token.py

@@ -16,42 +16,46 @@
 from typing import TYPE_CHECKING, Any, Dict, List, Optional, Protocol, Union
 
 if TYPE_CHECKING:
-    from .common import IAppDelegate, IConfiguration
-    from .datastore import IDataStore, IModelsDatastore
-    from .engine import IExecution, IItem, IScriptHandler
+    from pybpmn_server.common.default_configuration import Settings
+    from pybpmn_server.datastore.interfaces import IDataStore, IModelsDatastore
+    from pybpmn_server.engine.interfaces import IExecution, IItem, ScriptHandler
+    from pybpmn_server.interfaces.common import AppDelegateBase
 
 
 class IBPMNServer(Protocol):
     """Represents the core BPMN server and its dependencies."""
 
     engine: IEngine
     listener: Any  # EventEmitter
-    configuration: IConfiguration
+    configuration: Settings
     definitions: IModelsDatastore
-    app_delegate: IAppDelegate
+    app_delegate: AppDelegateBase
     data_store: IDataStore
     cache: ICacheManager
     cron: ICron
-    script_handler: IScriptHandler
+    script_handler: ScriptHandler
 
 
 class IServerComponent(Protocol):
     """Represents a component of the BPMN server."""
 
     server: IBPMNServer
-    configuration: IConfiguration
+    configuration: Settings
     cron: Any
     cache: Any
-    app_delegate: IAppDelegate
+    app_delegate: AppDelegateBase
     engine: Any
     data_store: IDataStore
-    script_handler: IScriptHandler
+    script_handler: ScriptHandler
     definitions: Any
 
 
 class IEngine(Protocol):
     """Represents the execution engine handling business process executions."""
 
+    running_counter: int
+    calls_counter: int
+
     async def start(
         self,
         name: Any,