Merge pull request #22 from BlockScience/dev

v1.2.1
- moved logging system out of node container into module __init__ so logging format is configured immediately
- removed print statements from build system and added appropriate log statements
- updated component start/stop logging

Author: lukvmil

pyproject.toml

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

src/koi_net/__init__.py

@@ -0,0 +1 @@
+from . import log_system

src/koi_net/build/artifact.py

@@ -2,6 +2,8 @@
 from collections import deque
 from typing import TYPE_CHECKING, Any
 
+import structlog
+
 from .consts import (
     COMP_ORDER_OVERRIDE,
     COMP_TYPE_OVERRIDE, 
@@ -16,6 +18,8 @@
 if TYPE_CHECKING:
     from .assembler import NodeAssembler
 
+log = structlog.stdlib.get_logger()
+
 
 class BuildArtifact:
     assembler: "NodeAssembler"
@@ -42,6 +46,7 @@ def collect_comps(self):
                     continue
 
                 self.comp_dict[k] = v
+        log.debug(f"Collected {len(self.comp_dict)} components")
 
     def build_dependencies(self):
         """Builds dependency graph and component type map.
@@ -76,7 +81,7 @@ def build_dependencies(self):
 
             self.dep_graph[comp_name] = dep_names
 
-        [print(f"{i}: {comp_name} -> {deps}") for i, (comp_name, deps) in enumerate(self.dep_graph.items())]
+        log.debug("Built dependency graph")
 
     def build_init_order(self):
         """Builds component initialization order using Kahn's algorithm."""
@@ -122,8 +127,7 @@ def build_init_order(self):
             cycle_nodes = set(self.dep_graph) - set(self.init_order)
             raise Exception(f"Found cycle in dependency graph, the following nodes could not be ordered: {cycle_nodes}")
 
-        print("\ninit order")
-        [print(f"{i}: {comp_name}") for i, comp_name in enumerate(self.init_order)]
+        log.debug(f"Resolved initialization order: {' -> '.join(self.init_order)}")
 
     def build_start_order(self):
         """Builds component start order.
@@ -150,8 +154,7 @@ def build_start_order(self):
         # 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)]
+        log.debug(f"Resolved start order: {' -> '.join(self.start_order)}")
 
     def build_stop_order(self):
         """Builds component stop order.
@@ -178,11 +181,9 @@ def build_stop_order(self):
         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)]
 
-    
+        log.debug(f"Resolved stop order: {' -> '.join(self.stop_order)}")
+
     def visualize(self) -> str:
         """Creates representation of dependency graph in Graphviz DOT language."""
 
@@ -197,9 +198,11 @@ def visualize(self) -> str:
         self.graphviz = s
 
     def build(self):
+        log.debug("Creating build artifact...")
         self.collect_comps()
         self.build_dependencies()
         self.build_init_order()
         self.build_start_order()
         self.build_stop_order()
         self.visualize()
+        log.debug("Done")

src/koi_net/build/assembler.py

@@ -20,28 +20,29 @@ class NodeAssembler:
     def __new__(cls) -> Self | NodeContainer:
         """Returns assembled node container."""
 
+        log.debug(f"Assembling '{cls.__name__}'")
+        
         # builds assembly artifact if it doesn't exist
         if not cls._artifact:
             cls._artifact = BuildArtifact(cls)
             cls._artifact.build()
 
         components = cls._build_components(cls._artifact)
 
+        log.debug("Returning assembled node")
         return NodeContainer(cls._artifact, **components)
 
     @staticmethod
     def _build_components(artifact: BuildArtifact):
         """Returns assembled components as a dict."""
 
-        print("\nbuilding components")
+        log.debug("Building components...")
         components: dict[str, Any] = {}
         for comp_name in artifact.init_order:
         # for comp_name, (comp_type, dep_names) in dep_graph.items():
             comp = artifact.comp_dict[comp_name]
             comp_type = artifact.comp_types[comp_name]
 
-            print(comp, comp_type)
-            
             if comp_type == CompType.OBJECT:
                 components[comp_name] = comp
 
@@ -53,5 +54,6 @@ def _build_components(artifact: BuildArtifact):
                         raise Exception(f"Couldn't find required component '{dep}'")
                     dependencies[dep] = components[dep]
                 components[comp_name] = comp(**dependencies)
-                
+        log.debug("Done")
+        
         return components

src/koi_net/build/container.py

@@ -34,11 +34,13 @@ def start(self):
         for comp_name in self._artifact.start_order:
             comp = getattr(self, comp_name)
             start_func = getattr(comp, START_FUNC_NAME)
+            log.info(f"Starting {comp_name}...")
             start_func()
 
     def stop(self):
         log.info("Stopping node...")
         for comp_name in self._artifact.stop_order:
             comp = getattr(self, comp_name)
             stop_func = getattr(comp, STOP_FUNC_NAME)
-            stop_func()
+            log.info(f"Stopping {comp_name}...")
+            stop_func()

src/koi_net/core.py

@@ -1,5 +1,4 @@
 from .cache import Cache
-from .log_system import LogSystem
 from .build.assembler import NodeAssembler
 from .config.core import NodeConfig
 from .config.proxy import ConfigProxy
@@ -36,7 +35,6 @@
 )
 
 class BaseNode(NodeAssembler):
-    log_system: LogSystem = LogSystem
     kobj_queue: KobjQueue = KobjQueue
     event_queue: EventQueue = EventQueue
     poll_event_buf: EventBuffer = EventBuffer