cleanup

added the ability to check if a process is compiled. added plot method to compartment for future use

Author: willgebhardt

ngcsimlib/_src/compartment/compartment.py

@@ -28,7 +28,7 @@ class Compartment(metaclass=CompartmentMeta):
         fixed (default=False): sets the flag for if this compartment is fixed.
     """
     def __init__(self, initial_value: T, fixed: bool = False,
-                 display_name=None, units=None):
+                 display_name=None, units=None, plot_method=None):
         self._initial_value = initial_value
 
         self.name = None
@@ -38,6 +38,7 @@ def __init__(self, initial_value: T, fixed: bool = False,
 
         self.display_name = display_name
         self.units = units
+        self.plot_method = plot_method
 
     @property
     def root(self):

ngcsimlib/_src/context/contextAwareObjectMeta.py

@@ -50,13 +50,6 @@ def __call__(cls, *args, **kwargs):
                 error(f"Created context objects must have a name. "
                       f"Error occurred when making an object of class {cls.__name__}")
 
-            # if contextRef is None:
-            #     warn(f"An instance of a context aware object was initialized while "
-            #          f"the current context is None. Did you forget to place it in "
-            #          f"a \"with\" block?")
-            #     return obj
-
-
             if hasattr(obj, "compartments") and isinstance(obj.compartments, Iterable) and not isinstance(obj.compartments, (str, bytes)):
                 for (comp_name, comp) in obj.compartments:
                     if hasattr(comp, "_setup") and callable(comp._setup):

ngcsimlib/_src/global_state/manager.py

@@ -1,15 +1,18 @@
-from typing import Union, Any, Dict
+from typing import Union, Any, Dict, TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from ngcsimlib._src.compartment.compartment import Compartment
 
 
 class __global_state_manager:
     def __init__(self):
-        self.__state = {}
-        self.__compartments = {}
+        self.__state: Dict[str, any] = {}
+        self.__compartments: Dict[str: "Compartment"] = {}
 
-    def add_compartment(self, compartment):
+    def add_compartment(self, compartment: "Compartment"):
         self.__compartments[compartment.root] = compartment
 
-    def get_compartment(self, root):
+    def get_compartment(self, root: str) -> "Compartment":
         return self.__compartments[root]
 
     @staticmethod

ngcsimlib/_src/process/baseProcess.py

@@ -21,6 +21,10 @@ def __init__(self, name):
         self._keyword_order: List[str] = []
         self._watch_list: List[Compartment] = []
 
+    @property
+    def watch_list(self):
+        return self._watch_list
+
     def view_compiled_method(self) -> str:
         """
         Returns: The compiled method as a human-readable code block to assist
@@ -101,6 +105,9 @@ def pack_rows(self, length: int,
             seed_generator = lambda x: x
         return [self.pack_keywords(seed_generator(i), **kwargs) for i in range(length)]
 
+    def is_compiled(self) -> bool:
+        return hasattr(self.run, "compiled")
+
     def run(self, state=None, keywords=None, update=True, row_seed=None, **kwargs):
         """
         Runs the compiled process.
@@ -122,7 +129,7 @@ def run(self, state=None, keywords=None, update=True, row_seed=None, **kwargs):
         Returns: The final state, watched values as a tuple
 
         """
-        if hasattr(self.run, "compiled"):
+        if self.is_compiled():
             if state is None:
                 state = global_state_manager.state
             if keywords is None: