Op movement (#11)

* Move operations into their own directory

* Fix kwarg problem in wrapping commands

Author: willgebhardt

ngcsimlib/compilers/command_compiler.py

@@ -148,8 +148,8 @@ def wrap_command(command):
     Returns:
         the output of the command after it's been executed
     """
-    def _wrapped(*args):
-        vals = command(Get_Compartment_Batch(), *args)
+    def _wrapped(**kwargs):
+        vals = command(Get_Compartment_Batch(), **kwargs)
         Set_Compartment_Batch(vals)
         return vals
 

ngcsimlib/compilers/op_compiler.py

@@ -10,7 +10,7 @@
 as the `add` operation are not compilable as their resolve method contains execution logic that will not be captured
 by the compiled command.
 """
-from ngcsimlib.operations import BaseOp
+from ngcsimlib.operations.baseOp import BaseOp
 
 
 def parse(op):

ngcsimlib/context.py

@@ -2,7 +2,7 @@
 from ngcsimlib.logger import warn, info
 from ngcsimlib.utils import get_compartment_by_name, \
     get_context, add_context, get_current_path, get_current_context, set_new_context
-from ngcsimlib.compilers.command_compiler import dynamic_compile
+from ngcsimlib.compilers.command_compiler import dynamic_compile, wrap_command
 import json, os
 
 
@@ -343,7 +343,7 @@ def make_commands(self, path_to_commands_file):
             commands = json.load(file)
             for c_name, command in commands.items():
                 if command['class'] == "dynamic_compiled":
-                    self.compile_command_key(
+                    self.compile_by_key(
                         *self.get_components(*command['components']), compile_key=command['compile_key'], name=c_name)
                 else:
                     klass = load_from_path(command['class'])
@@ -384,7 +384,7 @@ def dynamicCommand(fn):
             get_current_context().__setattr__(fn.__name__, fn)
         return fn
 
-    def compile_command_key(self, *components, compile_key, name=None):
+    def compile_by_key(self, *components, compile_key, name=None):
         """
         Compiles a given set of components with a given compile key.
         It will automatically add it to the context after compiling
@@ -408,3 +408,15 @@ def compile_command_key(self, *components, compile_key, name=None):
         self._json_objects['commands'][name] = {"class": klass, "components": _components, "compile_key": compile_key}
         self.__setattr__(name, cmd)
         return cmd, args
+
+
+    def wrap_and_add_command(self, command, name=None):
+        """
+        wraps a command and adds it to the context, if no name is provided it will use the command's internal name
+
+        Args:
+            command: The command to wrap
+
+            name: The name of the command (default: None)
+        """
+        self.add_command(wrap_command(command), name=name)

ngcsimlib/operations/__init__.py

@@ -0,0 +1,5 @@
+from .baseOp import BaseOp
+from .add import add
+from .negate import negate
+from .overwrite import overwrite
+from .summation import summation

ngcsimlib/operations/add.py

@@ -0,0 +1,16 @@
+from .summation import summation
+
+class add(summation):
+    """
+    Not Compilable
+
+    A subclass of summation that also adds the destinations value instead of overwriting it. For a compiler friendly
+    version of this add the destination as a source to summation.
+    """
+    is_compilable = False
+
+    def resolve(self, value):
+        if self.destination is not None:
+            self.destination.set(self.destination.value + value)
+
+

ngcsimlib/operations.py ngcsimlib/operations/baseOp.pyngcsimlib/operations.py renamed to ngcsimlib/operations/baseOp.py

@@ -1,6 +1,5 @@
 from abc import abstractmethod, ABC
 
-
 class BaseOp(ABC):
     """
     This is the base class for all operations that define cable behavior in ngcsimlib. Generally the there is one
@@ -85,54 +84,4 @@ def __repr__(self) -> str:
             line += f"\tSources: {[source for source in self.sources]}"
         if self.destination is not None:
             line += f"\tDestination: {self.destination.name}"
-        return line
-
-
-class summation(BaseOp):
-    """
-    Adds together all the provided compartment's values and overwrites the previous value
-    """
-
-    @staticmethod
-    def operation(*sources):
-        s = None
-        for source in sources:
-            if s is None:
-                s = source
-            else:
-                s += source
-        return s
-
-
-class negate(BaseOp):
-    """
-    negates the first source compartment (other will be ignored) and overwrite the previous value
-    """
-
-    @staticmethod
-    def operation(*sources):
-        return -sources[0]
-
-
-class add(summation):
-    """
-    Not Compilable
-
-    A subclass of summation that also adds the destinations value instead of overwriting it. For a compiler friendly
-    version of this add the destination as a source to summation.
-    """
-    is_compilable = False
-
-    def resolve(self, value):
-        if self.destination is not None:
-            self.destination.set(self.destination.value + value)
-
-
-class overwrite(BaseOp):
-    """
-    The default operation behavior for cable's
-    Overwrites the previous value with the first source value (all other sources will be ignored)
-    """
-    @staticmethod
-    def operation(*sources):
-        return sources[0]
+        return line

ngcsimlib/operations/negate.py

@@ -0,0 +1,9 @@
+from .baseOp import BaseOp
+class negate(BaseOp):
+    """
+    negates the first source compartment (other will be ignored) and overwrite the previous value
+    """
+
+    @staticmethod
+    def operation(*sources):
+        return -sources[0]

ngcsimlib/operations/overwrite.py

@@ -0,0 +1,9 @@
+from .baseOp import BaseOp
+class overwrite(BaseOp):
+    """
+    The default operation behavior for cable's
+    Overwrites the previous value with the first source value (all other sources will be ignored)
+    """
+    @staticmethod
+    def operation(*sources):
+        return sources[0]

ngcsimlib/operations/summation.py

@@ -0,0 +1,16 @@
+from .baseOp import BaseOp
+
+class summation(BaseOp):
+    """
+    Adds together all the provided compartment's values and overwrites the previous value
+    """
+
+    @staticmethod
+    def operation(*sources):
+        s = None
+        for source in sources:
+            if s is None:
+                s = source
+            else:
+                s += source
+        return s