renamed assembly artifact -> build artifact, added a new comp_order decorator to give start and stop orderer more information, comp_order.worker starts worker components before and stops them after all other components, renamed component -> comp_type, removed factory (for now), default is singleton, moved build_app() call to init of server, not run method, added comp_order.worker to base worker class, version bump -> 1.2.0-beta.8

Author: lukvmil

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "koi-net"
-version = "1.2.0b7"
+version = "1.2.0b8"
 description = "Implementation of KOI-net protocol in Python"
 authors = [
     {name = "Luke Miller", email = "[email protected]"}

src/koi_net/build/artifact.py

@@ -1,22 +1,23 @@
 import inspect
 from collections import deque
 from typing import TYPE_CHECKING, Any
-from pydantic import BaseModel
-
-if TYPE_CHECKING:
-    from .assembler import NodeAssembler
 
 from .consts import (
+    COMP_ORDER_OVERRIDE,
     COMP_TYPE_OVERRIDE, 
     START_FUNC_NAME, 
     START_ORDER_OVERRIDE, 
     STOP_FUNC_NAME, 
     STOP_ORDER_OVERRIDE,
+    CompOrder,
     CompType
 )
 
+if TYPE_CHECKING:
+    from .assembler import NodeAssembler
+
 
-class AssemblyArtifact:
+class BuildArtifact:
     assembler: "NodeAssembler"
     comp_dict: dict[str, Any]
     dep_graph: dict[str, list[str]]
@@ -130,10 +131,24 @@ def build_start_order(self):
         Checks if components define a start function in init order. Can
         be overridden by setting start order override in the `NodeAssembler`.
         """
-        self.start_order = getattr(self.assembler, START_ORDER_OVERRIDE, None) or [
-            comp_name for comp_name in self.init_order 
-            if getattr(self.comp_dict[comp_name], START_FUNC_NAME, None)
-        ]
+        
+        self.start_order = getattr(self.assembler, START_ORDER_OVERRIDE, None)
+        
+        if self.start_order:
+            return
+        
+        workers = []
+        start_order = []
+        for comp_name in self.init_order:
+            comp = self.comp_dict[comp_name]
+            if getattr(comp, START_FUNC_NAME, None):
+                if getattr(comp, COMP_ORDER_OVERRIDE, None) == CompOrder.WORKER:
+                    workers.append(comp_name)
+                else:
+                    start_order.append(comp_name) 
+        
+        # order workers first
+        self.start_order = workers + start_order
 
         print("\nstart order")
         [print(f"{i}: {comp_name}") for i, comp_name in enumerate(self.start_order)]
@@ -144,11 +159,26 @@ def build_stop_order(self):
         Checks if components define a stop function in init order. Can
         be overridden by setting stop order override in the `NodeAssembler`.
         """
-        self.stop_order = getattr(self.assembler, STOP_ORDER_OVERRIDE, None) or [
-            comp_name for comp_name in self.init_order 
-            if getattr(self.comp_dict[comp_name], STOP_FUNC_NAME, None)
-        ]
-        
+        self.stop_order = getattr(self.assembler, STOP_ORDER_OVERRIDE, None)
+        
+        if self.stop_order:
+            return
+        
+        workers = []
+        stop_order = []
+        for comp_name in self.init_order:
+            comp = self.comp_dict[comp_name]
+            if getattr(comp, STOP_FUNC_NAME, None):
+                if getattr(comp, COMP_ORDER_OVERRIDE, None) == CompOrder.WORKER:
+                    workers.append(comp_name)
+                else:
+                    stop_order.append(comp_name) 
+        
+        # order workers first (last)
+        self.stop_order = workers + stop_order
+        # reverse order from start order
+        self.stop_order.reverse()
+                
         print("\nstop order")
         [print(f"{i}: {comp_name}") for i, comp_name in enumerate(self.stop_order)]
 

src/koi_net/build/assembler.py

@@ -3,14 +3,14 @@
 
 import structlog
 
-from .artifact import AssemblyArtifact, CompType
+from .artifact import BuildArtifact, CompType
 from .container import NodeContainer
 
 log = structlog.stdlib.get_logger()
 
 
 class NodeAssembler:
-    _artifact: AssemblyArtifact = None
+    _artifact: BuildArtifact = None
 
     # optional order overrides:
     _start_order: list[str]
@@ -22,15 +22,15 @@ def __new__(cls) -> Self | NodeContainer:
 
         # builds assembly artifact if it doesn't exist
         if not cls._artifact:
-            cls._artifact = AssemblyArtifact(cls)
+            cls._artifact = BuildArtifact(cls)
             cls._artifact.build()
 
         components = cls._build_components(cls._artifact)
 
         return NodeContainer(cls._artifact, **components)
 
     @staticmethod
-    def _build_components(artifact: AssemblyArtifact):
+    def _build_components(artifact: BuildArtifact):
         """Returns assembled components as a dict."""
 
         print("\nbuilding components")

src/koi_net/build/comp_order.py

@@ -0,0 +1,6 @@
+from koi_net.build.consts import COMP_ORDER_OVERRIDE, CompOrder
+
+
+def worker(cls):
+    setattr(cls, COMP_ORDER_OVERRIDE, CompOrder.WORKER)
+    return cls

src/koi_net/build/comp_type.py

@@ -0,0 +1,7 @@
+from .consts import COMP_TYPE_OVERRIDE, CompType
+
+
+def object(cls):
+    """Sets a component's type to `CompType.OBJECT`."""
+    setattr(cls, COMP_TYPE_OVERRIDE, CompType.OBJECT)
+    return cls

src/koi_net/build/component.py

@@ -3,11 +3,16 @@
 
 START_FUNC_NAME = "start"
 STOP_FUNC_NAME = "stop"
+
 START_ORDER_OVERRIDE = "_start_order"
 STOP_ORDER_OVERRIDE = "_stop_order"
+
 COMP_TYPE_OVERRIDE = "_comp_type"
+COMP_ORDER_OVERRIDE = "_comp_order"
 
 class CompType(StrEnum):
     SINGLETON = "SINGLETON"
-    FACTORY = "FACTORY"
     OBJECT = "OBJECT"
+
+class CompOrder(StrEnum):
+    WORKER = "WORKER"

src/koi_net/build/consts.py

@@ -1,15 +1,15 @@
 import structlog
 
 from ..entrypoints.base import EntryPoint
-from .artifact import AssemblyArtifact
+from .artifact import BuildArtifact
 from .consts import START_FUNC_NAME, STOP_FUNC_NAME
 
 log = structlog.stdlib.get_logger()
 
 
 class NodeContainer:
     """Dummy 'shape' for node containers built by assembler."""
-    _artifact: AssemblyArtifact
+    _artifact: BuildArtifact
 
     entrypoint: EntryPoint
 

src/koi_net/build/container.py

@@ -5,7 +5,7 @@
 from rid_lib.types import KoiNetNode
 import structlog
 
-from ..build import component
+from ..build import comp_type
 from ..protocol.secure import PrivateKey
 from ..protocol.node import NodeProfile
 
@@ -68,7 +68,7 @@ def __getattribute__(self, name):
 
 # marking this component as static, classes are implicitly treated as
 # factories, but this needs to be passed as is
-@component.object
+@comp_type.object
 class NodeConfig(BaseModel):
     """Base node config class, intended to be extended."""
 

src/koi_net/config/core.py

@@ -28,6 +28,8 @@ def __init__(
         self.config = config
         self.response_handler = response_handler
 
+        self.build_app()
+        
     def build_endpoints(self, router: APIRouter):
         """Builds endpoints for API router."""
         for path, models in API_MODEL_MAP.items():
@@ -75,8 +77,6 @@ def protocol_error_handler(self, request, exc: ProtocolError):
     def run(self):
         """Starts FastAPI server and event handler."""
 
-        self.build_app()
-        
         uvicorn.run(
             app=self.app,
             host=self.config.server.host,