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:

test_coverage.sh

@@ -1,5 +1,5 @@
 #!/bin/sh
-rm -r htmlcov
+rm -r htmlcov || true
 coverage3 erase
 coverage3 run --source=contextshell -m unittest discover -s tests -t tests -p '*Tests.py'
 coverage3 report

tests/functional/FilesystemTests.py

@@ -1,7 +1,7 @@
 import unittest
 import os
 import tempfile
-from contextshell.TreeRoot import TreeRoot
+from contextshell.ActionExecutor import ActionExecutor
 from contextshell.VirtualTree import VirtualTree
 from tests.functional.ShellTestsBase import TreeRootTestsBase
 from tests.functional.TestExecutor import script_test
@@ -11,7 +11,7 @@
 class FilesystemTestsBase(TreeRootTestsBase):
     test_directory_path = os.path.join(os.path.dirname(os.path.abspath(__file__)), 'test_data')
 
-    def create_tree_root(self) -> TreeRoot:
+    def create_tree_root(self) -> ActionExecutor:
         self.test_directory = tempfile.TemporaryDirectory(FilesystemTestsBase.__name__)
         return FilesystemRoot(self.test_directory.name) # FIXME: make this work
 
@@ -24,6 +24,7 @@ def tearDown(self):
         super().tearDown()
 
 
+@unittest.skip("Implement when actions could be registered in FilesystemTreeRoot")
 class FilesystemRootTests(FilesystemTestsBase):
     def setUp(self):
         super().setUp()
@@ -39,7 +40,7 @@ def test_contains_existing_file(self):
 
 @unittest.skip("Those tests utilize attach actions which may not belong to the filesystem module")
 class AttachTests(TreeRootTestsBase):
-    def create_tree_root(self) -> TreeRoot:
+    def create_tree_root(self) -> ActionExecutor:
         pass
 
     def configure_virtual_tree(self, virtual_tree: VirtualTree):

tests/functional/ShellTestsBase.py

@@ -1,7 +1,7 @@
 import unittest
 from abc import ABC, abstractmethod
 
-from contextshell.TreeRoot import TreeRoot
+from contextshell.ActionExecutor import ActionExecutor
 from contextshell.Shell import Shell
 from contextshell.NodePath import NodePath
 from contextshell.CommandInterpreter import CommandInterpreter
@@ -17,7 +17,7 @@ def create_shell(self) -> Shell:
 
 class TreeRootTestsBase(ShellScriptTestsBase):
     @abstractmethod
-    def create_tree_root(self) -> TreeRoot:
+    def create_tree_root(self) -> ActionExecutor:
         raise NotImplementedError()
 
     def create_shell(self):
@@ -28,16 +28,16 @@ def create_shell(self):
         shell = Shell(interpreter)
         return shell
 
-    def configure_tree_root(self, tree_root: TreeRoot):
+    def configure_tree_root(self, tree_root: ActionExecutor):
         pass
 
 
 # TODO: is this class needed when testing single TreeRoot-based class?
 class VirtualTreeTestsBase(TreeRootTestsBase):
-    def create_tree_root(self) -> TreeRoot:
+    def create_tree_root(self) -> ActionExecutor:
         return VirtualTree()
 
-    def configure_tree_root(self, tree_root: TreeRoot):
+    def configure_tree_root(self, tree_root: ActionExecutor):
         self.configure_virtual_tree(tree_root)
 
 

tests/unit/ArgumentPackerTests.py

@@ -1,5 +1,5 @@
 import unittest
-from contextshell.TreeRoot import pack_argument_tree, unpack_argument_tree, parse_argument_tree
+from contextshell.ActionExecutor import pack_argument_tree, unpack_argument_tree, parse_argument_tree
 from contextshell.NodePath import NodePath as np
 from collections import OrderedDict
 

tests/unit/Fakes.py

@@ -1,7 +1,7 @@
 from contextshell.NodePath import NodePath
 from contextshell.Action import Action
 from typing import Dict
-from contextshell.TreeRoot import ActionArgsPack
+from contextshell.ActionEndpoint import ActionArgsPack
 
 
 class FakeTree:

tests/unit/NodeTreeActionsTests.py

@@ -3,7 +3,7 @@
 
 from contextshell.NodePath import NodePath as np
 from contextshell.NodePath import NodePath
-from contextshell.TreeRoot import TreeRoot
+from contextshell.ActionEndpoint import ActionEndpoint
 
 
 # class ActionTests(unittest.TestCase):

tests/unit/VirtualTreeTests.py

@@ -1,6 +1,6 @@
 import unittest
 
-from contextshell.TreeRoot import TreeRoot, ActionArgsPack, OrderedDict, pack_argument_tree
+from contextshell.ActionExecutor import ActionExecutor, ActionArgsPack, OrderedDict, pack_argument_tree
 from contextshell.NodePath import NodePath
 
 
@@ -13,7 +13,7 @@ def np(representation):
     return NodePath(representation)
 
 
-class FakeTreeRoot(TreeRoot):
+class FakeActionExecutor(ActionExecutor):
     def __init__(self):
         self.execute_target = None
         self.execute_action = None
@@ -30,14 +30,14 @@ def execute(self, target: NodePath, action: NodePath, args: ActionArgsPack = Non
 class MountTests(unittest.TestCase):
     def test_relative_target(self):
         vt = create_virtual_tree()
-        tree_root = FakeTreeRoot()
+        tree_root = FakeActionExecutor()
 
         with self.assertRaises(ValueError):
             vt.mount(np("foo"), tree_root)
 
     def test_mount_visible_in_mapping(self):
         vt = create_virtual_tree()
-        tree_root = FakeTreeRoot()
+        tree_root = FakeActionExecutor()
 
         vt.mount(np("."), tree_root)
 
@@ -46,14 +46,14 @@ def test_mount_visible_in_mapping(self):
     def test_mount_on_same_path(self):
         vt = create_virtual_tree()
         mount_path = np(".")
-        vt.mount(mount_path, FakeTreeRoot())
+        vt.mount(mount_path, FakeActionExecutor())
 
         with self.assertRaises(KeyError):
-            vt.mount(mount_path, FakeTreeRoot())
+            vt.mount(mount_path, FakeActionExecutor())
 
     def test_umount_removes_mapping(self):
         vt = create_virtual_tree()
-        vt.mount(np("."), FakeTreeRoot())
+        vt.mount(np("."), FakeActionExecutor())
 
         vt.umount(np("."))
 
@@ -63,22 +63,22 @@ def test_umount_removes_mapping(self):
 class ExecuteTests(unittest.TestCase):
     def test_relative_target(self):
         vt = create_virtual_tree()
-        vt.mount(np("."), FakeTreeRoot())
+        vt.mount(np("."), FakeActionExecutor())
 
         with self.assertRaises(ValueError):
             vt.execute(np("foo"), np("action"))
 
     def test_no_matching_provider(self):
         vt = create_virtual_tree()
-        vt.mount(np(".foo"), FakeTreeRoot())
+        vt.mount(np(".foo"), FakeActionExecutor())
 
         with self.assertRaises(RuntimeError):
             vt.execute(np(".bar"), np("action"))
 
     def test_target_remapping(self):
         """Target path is remapped to match provider's root"""
         vt = create_virtual_tree()
-        tree_root = FakeTreeRoot()
+        tree_root = FakeActionExecutor()
         vt.mount(np(".foo"), tree_root)
 
         vt.execute(np(".foo.bar"), np("action"))
@@ -87,7 +87,7 @@ def test_target_remapping(self):
 
     def test_action_forwarding(self):
         vt = create_virtual_tree()
-        tree_root = FakeTreeRoot()
+        tree_root = FakeActionExecutor()
         vt.mount(np("."), tree_root)
 
         vt.execute(np("."), np("action"))
@@ -96,7 +96,7 @@ def test_action_forwarding(self):
 
     def test_args_forwarding(self):
         vt = create_virtual_tree()
-        tree_root = FakeTreeRoot()
+        tree_root = FakeActionExecutor()
         vt.mount(np("."), tree_root)
         packed_args = pack_argument_tree('foo', 123)
 
@@ -106,7 +106,7 @@ def test_args_forwarding(self):
 
     def test_return_value_forwarding(self):
         vt = create_virtual_tree()
-        tree_root = FakeTreeRoot()
+        tree_root = FakeActionExecutor()
         tree_root.execute_return = 'RETURN_VALUE'
         vt.mount(np("."), tree_root)
 
@@ -116,8 +116,8 @@ def test_return_value_forwarding(self):
 
     def test_most_specific_provider_is_matched(self):
         vt = create_virtual_tree()
-        short_path_root = FakeTreeRoot()
-        long_path_root = FakeTreeRoot()
+        short_path_root = FakeActionExecutor()
+        long_path_root = FakeActionExecutor()
         vt.mount(np(".foo"), short_path_root)
         vt.mount(np(".foo.bar"), long_path_root)