Rename interface TreeRoot -> ActionExecutor

Author: idle-code

contextshell/Action.py

@@ -1,6 +1,6 @@
 from abc import ABC, abstractmethod
 from contextshell.NodePath import NodePath
-from contextshell.TreeRoot import ActionArgsPack
+from contextshell.ActionExecutor import ActionArgsPack
 
 
 class Action(ABC):

contextshell/ActionEndpoint.py

@@ -0,0 +1,23 @@
+from abc import ABC, abstractmethod
+from typing import Optional
+
+from contextshell.Action import Action
+from contextshell.ActionExecutor import ActionExecutor, ActionArgsPack
+from contextshell.NodePath import NodePath
+from collections import OrderedDict
+
+
+class ActionEndpoint(ActionExecutor):
+    @abstractmethod
+    def find_action(self, target: NodePath, action: NodePath) -> Optional[Action]:
+        raise NotImplementedError()
+
+    def execute(self, target: NodePath, action_name: NodePath, args: ActionArgsPack = None):
+        #print("Execute: {}: {} {}".format(target, action, args))
+        if not args:
+            args = OrderedDict()
+        action_impl = self.find_action(target, action_name)
+        if action_impl is None:
+            raise NameError("Could not find action named '{}'".format(action_name))
+        return action_impl.invoke(target, action_name, args)
+

contextshell/TreeRoot.py renamed to contextshell/ActionExecutor.py

@@ -1,18 +1,19 @@
 from abc import ABC, abstractmethod
+from collections import OrderedDict
+
 from contextshell.NodePath import NodePath
 from typing import Dict, Union, Any, Tuple, List
-from collections import OrderedDict
 
 ArgumentValue = Any
 ActionArgsPack = Dict[Union[NodePath, int], ArgumentValue]
 PositionalArguments = List[ArgumentValue]
 KeywordArguments = Dict[str, ArgumentValue]
 
 
-# CHECK: Rename TreeRoot to ActionEndpoint or something more appropriate?
-class TreeRoot(ABC):
+class ActionExecutor(ABC):
+    """Interface for backends allowing execution of arbitrary actions"""
     @abstractmethod
-    def execute(self, target: NodePath, action: NodePath, args: ActionArgsPack = None):
+    def execute(self, target: NodePath, action_name: NodePath, args: ActionArgsPack = None):
         raise NotImplementedError()
 
 

contextshell/CallableAction.py

@@ -1,5 +1,5 @@
 from typing import Callable
-from contextshell.TreeRoot import unpack_argument_tree, ActionArgsPack
+from contextshell.ActionExecutor import unpack_argument_tree, ActionArgsPack
 from contextshell.Action import Action
 from contextshell.NodePath import NodePath
 

contextshell/CommandInterpreter.py

@@ -1,10 +1,10 @@
 from contextshell.Command import Command
 from contextshell.NodePath import NodePath
-from contextshell.TreeRoot import TreeRoot, parse_argument_tree
+from contextshell.ActionExecutor import ActionExecutor, parse_argument_tree
 
 
 class CommandInterpreter:
-    def __init__(self, tree: TreeRoot) -> None:
+    def __init__(self, tree: ActionExecutor) -> None:
         self.tree = tree
 
     def execute(self, command: Command):

contextshell/VirtualTree.py

@@ -1,16 +1,16 @@
-from contextshell.TreeRoot import TreeRoot, ActionArgsPack
+from contextshell.ActionExecutor import ActionExecutor, ActionArgsPack
 from contextshell.NodePath import NodePath
 from collections import OrderedDict
 
 
-class VirtualTree(TreeRoot):
+class VirtualTree(ActionExecutor):
     """Abstract frontend allowing embedding (mounting) of more specific tree roots"""
 
     def __init__(self):
-        self.mounts: OrderedDict[NodePath, TreeRoot] = OrderedDict()
+        self.mounts: OrderedDict[NodePath, ActionExecutor] = OrderedDict()
 
     # TODO: rename to attach/detach
-    def mount(self, path: NodePath, root: TreeRoot):
+    def mount(self, path: NodePath, root: ActionExecutor):
         if path.is_relative:
             raise ValueError("Could not mount relative path")
         if path in self.mounts:

contextshell/backends/Filesystem.py

@@ -1,9 +1,9 @@
 from contextshell.NodePath import NodePath
-from contextshell.TreeRoot import TreeRoot, ActionArgsPack
+from contextshell.ActionExecutor import ActionExecutor, ActionArgsPack
 from contextshell.backends.Module import Module
 
 
-class FilesystemRoot(TreeRoot):
+class FilesystemRoot(ActionExecutor):
     def __init__(self, root_directory_path: str):
         self.root_directory_path = root_directory_path
 

contextshell/backends/NodeTree.py

@@ -1,13 +1,14 @@
 from contextshell.Node import Node
 from contextshell.NodePath import NodePath
-from contextshell.TreeRoot import TreeRoot, ActionArgsPack, OrderedDict
+from contextshell.ActionEndpoint import ActionEndpoint
+from contextshell.ActionExecutor import ActionArgsPack, OrderedDict
 from contextshell.Action import Action
 from contextshell.CallableAction import action_from_function
 from typing import List, Optional
 
 
 # CHECK: how to implement TemporaryTreeRoot (based on NodeTreeRoot)
-class NodeTreeRoot(TreeRoot):
+class NodeTreeRoot(ActionEndpoint):
     """Frontend to the (passive) node-based data storage"""
     def __init__(self):
         self.root = self.create_node(None)
@@ -118,15 +119,6 @@ def find_type(self, target: NodePath, type_name: NodePath):  # TODO: add type-hi
             return None
         return type_node.get()
 
-    def execute(self, target: NodePath, action_name: NodePath, args: ActionArgsPack = None):
-        #print("Execute: {}: {} {}".format(target, action, args))
-        if not args:
-            args = OrderedDict()
-        action_impl = self.find_action(target, action_name)
-        if action_impl is None:
-            raise NameError("Could not find action named '{}'".format(action_name))
-        return action_impl.invoke(target, action_name, args)
-
     def create_node(self, value):
         return Node(value)
 

repl.py

@@ -1,10 +1,10 @@
 #!/usr/bin/python3.6
 import readline
 
-from contextshell.TreeRoot import *
+from contextshell.ActionExecutor import ActionExecutor
 from contextshell.Shell import *
 
-def create_context_tree() -> TreeRoot:
+def create_context_tree() -> ActionExecutor:
     pass
 
 if __name__ == '__main__':

script.py

@@ -1,14 +1,14 @@
 #!/usr/bin/python3
 import sys
 
-from TreeRoot import *
+from ActionEndpoint import *
 
 from contextshell.Shell import *
 
 if len(sys.argv) < 2:
     raise ValueError('Script requires single argument')
 
-tree = TreeRoot()
+tree = ActionEndpoint()
 shell = Shell(tree)
 
 with open(sys.argv[1]) as script: