Builder support for process

Added builder support for processes, use "*"s for special compartments that you don't want shown by default in the state view.

Author: willgebhardt

ngcsimlib/__init__.py

@@ -2,7 +2,6 @@
 from . import controller
 from . import commands
 
-
 import argparse, os, json
 from types import SimpleNamespace
 from importlib import import_module

ngcsimlib/compilers/process.py

@@ -45,25 +45,25 @@ def execute(self, update_state=False, **kwargs):
         if self._method is None:
             warn("Attempting to execute a process with no transition steps")
             return
-        state = self.pure(self.get_required_state(), **kwargs)
+        state = self.pure(self.get_required_state(include_special_compartments=True), **kwargs)
         if update_state:
             self.updated_modified_state(state)
         return state
 
     def as_obj(self):
         return {"name": self.name, "calls": self._calls}
 
-    def get_required_state(self):
+    def get_required_state(self, include_special_compartments=False):
         compound_state = {}
         for context in self._needed_contexts:
-            compound_state.update(context.get_current_state())
+            compound_state.update(context.get_current_state(include_special_compartments))
         return compound_state
 
     def updated_modified_state(self, state):
-        Set_Compartment_Batch({key: value for key, value in state.items() if key in self.get_required_state()})
+        Set_Compartment_Batch({key: value for key, value in state.items() if key in self.get_required_state(include_special_compartments=True)})
 
 
-def transition(output_compartments):
+def transition(output_compartments, builder=False):
     def _wrapper(f):
         @wraps(f)
         def inner(*args, **kwargs):
@@ -80,6 +80,7 @@ def inner(*args, **kwargs):
 
         inner.class_name = class_name
         inner.resolver_key = resolver_key
+        inner.builder = builder
 
         add_component_transition(class_name, resolver_key,
                                (f, output_compartments))

ngcsimlib/compilers/process_compiler/component_compiler.py

@@ -11,27 +11,37 @@ def __make_get_param(p, component):
 def __make_get_comp(c, component):
     return lambda current_state, **kwargs: current_state.get(component.__dict__[c].path, None)
 
+def builder(transition_method_to_build):
+    component = transition_method_to_build.__self__
+    builder_method = transition_method_to_build.f
+    # method, output_compartments, args, params, input_compartments
+    return builder_method(component)
+
 
 def compile(transition_method):
     composition = None
     component = transition_method.__self__
 
-    pure_fn = transition_method.f
-    output = transition_method.output_compartments
+    if transition_method.builder:
+        pure_fn, output, args, parameters, compartments = builder(transition_method)
+    else:
 
-    varnames = transition_method.fargs
+        pure_fn = transition_method.f
+        output = transition_method.output_compartments
 
-    args = []
-    compartments = []
-    parameters = []
+        varnames = transition_method.fargs
 
-    for name in varnames:
-        if name not in component.__dict__.keys():
-            args.append(name)
-        elif Compartment.is_compartment(component.__dict__[name]):
-            compartments.append(name)
-        else:
-            parameters.append(name)
+        args = []
+        compartments = []
+        parameters = []
+
+        for name in varnames:
+            if name not in component.__dict__.keys():
+                args.append(name)
+            elif Compartment.is_compartment(component.__dict__[name]):
+                compartments.append(name)
+            else:
+                parameters.append(name)
 
     for conn in component.connections:
         composition = compose(composition, op_compile(conn))

ngcsimlib/context.py

@@ -651,15 +651,15 @@ def view_guide(self, guide, skip=None):
             guides += klass.guides.__dict__[guide.value]
         return guides
 
-    def _get_state_keys(self):
+    def _get_state_keys(self, include_special_compartments=False):
         all_keys = []
         for comp_name in self.components.keys():
             all_keys.extend([key for key in Get_Compartment_Batch().keys()
-                             if self.path + "/" + comp_name in key])
+                         if (self.path + "/" + comp_name in key and (include_special_compartments or "*" not in key))])
         return all_keys
 
-    def get_current_state(self):
-        return Get_Compartment_Batch(self._get_state_keys())
+    def get_current_state(self, include_special_compartments=False):
+        return Get_Compartment_Batch(self._get_state_keys(include_special_compartments))
 
     def update_current_state(self, state):
         Set_Compartment_Batch({key: value for key, value in state.items() if key in self._get_state_keys()})