Rename plugins => plugin_registration

Also simplify running modules with `python -m`
dwhswenson · Oct 28, 2021 · Jul 24, 2021 · Sep 27, 2021 · Sep 30, 2021 · Oct 2, 2021
commit bba408f7a256ebfa0f1ff1e1a3814335043e22de
diff --git a/paths_cli/commands/wizard.py b/paths_cli/commands/wizard.py
@@ -1,5 +1,5 @@
 import click
-from paths_cli.wizard.plugins import register_installed_plugins
+from paths_cli.wizard.plugin_registration import register_installed_plugins
 from paths_cli.wizard.two_state_tps import TWO_STATE_TPS_WIZARD
 from paths_cli import OPSCommandPlugin
 

diff --git a/paths_cli/wizard/cvs.py b/paths_cli/wizard/cvs.py
@@ -200,16 +200,5 @@ def coordinate(wizard, prereqs=None):
 )
 
 if __name__ == "__main__":  # no-cov
-    from paths_cli.wizard.wizard import Wizard
-    from paths_cli.wizard.plugins import register_installed_plugins
-    register_installed_plugins()
-    plugins = [obj for obj in globals().values()
-               if isinstance(obj, WizardObjectPlugin)]
-    from_file = [obj for obj in globals().values()
-                 if isinstance(obj, LoadFromOPS)]
-    for plugin in plugins + from_file:
-        CV_PLUGIN.register_plugin(plugin)
-
-    wiz = Wizard({})
-    cv = CV_PLUGIN(wiz)
-    print(cv)
+    from paths_cli.wizard.run_module import run_category
+    run_category('cv')
diff --git a/paths_cli/wizard/engines.py b/paths_cli/wizard/engines.py
@@ -19,13 +19,7 @@
 
 ENGINE_FROM_FILE = LoadFromOPS('engine')
 
-if __name__ == "__main__":
-    from paths_cli.wizard import wizard
-    from paths_cli.wizard.plugins import register_installed_plugins
-    from paths_cli.wizard.plugins import get_category_wizard
-    register_installed_plugins()
-    engines = get_category_wizard('engine')
-    wiz = wizard.Wizard([])
-    engine = engines(wiz)
-    print(engine)
+if __name__ == "__main__":  # no-cov
+    from paths_cli.wizard.run_module import run_category
+    run_category('engine')
 
diff --git a/paths_cli/wizard/parameters.py b/paths_cli/wizard/parameters.py
@@ -67,7 +67,8 @@ def from_proxy(cls, proxy, compiler_plugin):
         dct = proxy._asdict()
         loader = loader_dict[proxy.name]
         if isinstance(loader, _CategoryCompilerProxy):
-            from paths_cli.wizard.plugins import get_category_wizard
+            # TODO: can this import now be moved to top of file?
+            from paths_cli.wizard.plugin_registration import get_category_wizard
             category = loader.category
             dct['loader'] = get_category_wizard(category)
             dct['ask'] = get_category_info(category).singular

diff --git a/paths_cli/wizard/plugins.py → paths_cli/wizard/plugin_registration.py b/paths_cli/wizard/plugins.py → paths_cli/wizard/plugin_registration.py
@@ -6,6 +6,7 @@
 from paths_cli.utils import get_installed_plugins
 from paths_cli.plugin_management import NamespacePluginLoader
 
+
 class CategoryWizardPluginRegistrationError(Exception):
     pass
 

diff --git a/paths_cli/wizard/run_module.py b/paths_cli/wizard/run_module.py
@@ -0,0 +1,23 @@
+from paths_cli.wizard.plugin_registration import register_installed_plugins
+from paths_cli.wizard.wizard import Wizard
+from paths_cli.wizard.plugin_registration import get_category_wizard
+
+from paths_cli.wizard.parameters import WizardObjectPlugin
+from paths_cli.wizard.load_from_ops import LoadFromOPS
+
+# TODO: for now we ignore this for coverage -- it's mainly used for UX
+# testing by allowing each module to be run with, e.g.:
+#    python -m paths_cli.wizard.engines
+# If that functionality is retained, it might be good to find a way to test
+# this.
+def run_category(category, requirements=None):  # -no-cov-
+    # TODO: if we keep this, fix it up so that it also saves the resulting
+    # objects
+    register_installed_plugins()
+    if requirements is None:
+        requirements = {}
+    wiz = Wizard({})
+    wiz.requirements = requirements
+    category_plugin = get_category_wizard(category)
+    obj = category_plugin(wiz)
+    print(obj)
diff --git a/paths_cli/wizard/shooting.py b/paths_cli/wizard/shooting.py
@@ -2,7 +2,7 @@
 
 from paths_cli.wizard.core import get_missing_object
 # from paths_cli.wizard.engines import engines
-from paths_cli.wizard.plugins import get_category_wizard
+from paths_cli.wizard.plugin_registration import get_category_wizard
 from paths_cli.compiling.tools import custom_eval
 
 engines = get_category_wizard('engine')

diff --git a/paths_cli/wizard/steps.py b/paths_cli/wizard/steps.py
@@ -3,10 +3,9 @@
 
 # from paths_cli.wizard.cvs import cvs
 # from paths_cli.wizard.engines import engines
-from paths_cli.wizard.plugins import get_category_wizard
+from paths_cli.wizard.plugin_registration import get_category_wizard
 from paths_cli.wizard.tps import tps_scheme
 
-from paths_cli.wizard.plugins import get_category_wizard
 volumes = get_category_wizard('volume')
 
 WizardStep = namedtuple('WizardStep', ['func', 'display_name', 'store_name',

diff --git a/paths_cli/wizard/tps.py b/paths_cli/wizard/tps.py
@@ -2,7 +2,7 @@
 from paths_cli.wizard.core import get_missing_object
 from paths_cli.wizard.shooting import shooting
 from paths_cli.wizard.volumes import VOLUMES_PLUGIN as volumes
-from paths_cli.wizard.plugins import get_category_wizard
+from paths_cli.wizard.plugin_registration import get_category_wizard
 
 from functools import partial
 volumes = get_category_wizard('volume')

diff --git a/paths_cli/wizard/two_state_tps.py b/paths_cli/wizard/two_state_tps.py
@@ -1,4 +1,4 @@
-from paths_cli.wizard.plugins import get_category_wizard
+from paths_cli.wizard.plugin_registration import get_category_wizard
 from paths_cli.wizard.tps import tps_scheme
 from paths_cli.wizard.steps import (
     SINGLE_ENGINE_STEP, CVS_STEP, WizardStep

diff --git a/paths_cli/wizard/volumes.py b/paths_cli/wizard/volumes.py
@@ -3,7 +3,7 @@
     ProxyParameter, WizardParameterObjectPlugin, WizardObjectPlugin
 )
 from paths_cli.wizard.load_from_ops import LoadFromOPS
-from paths_cli.wizard.plugins import get_category_wizard
+from paths_cli.wizard.plugin_registration import get_category_wizard
 from paths_cli.wizard.wrap_compilers import WrapCategory
 from paths_cli.wizard.core import interpret_req
 import paths_cli.compiling.volumes
@@ -121,17 +121,6 @@ def volume_ask(wizard, context):
     helper="No volume help yet"
 )
 
-
 if __name__ == "__main__":  # no-cov
-    from paths_cli.wizard.wizard import Wizard
-    from paths_cli.wizard.plugins import register_installed_plugins
-    register_installed_plugins()
-    plugins = [obj for obj in globals().values()
-               if isinstance(obj, WizardObjectPlugin)]
-    from_file = [obj for obj in globals().values()
-                 if isinstance(obj, LoadFromOPS)]
-    for plugin in plugins + from_file:
-        VOLUMES_PLUGIN.register_plugin(plugin)
-    wiz = Wizard([])
-    wiz.requirements['state'] = ('volumes', 1, 1)
-    VOLUMES_PLUGIN(wiz)
+    from paths_cli.wizard.run_module import run_category
+    run_category('volume', {'state': ('volumes', 1, 1)})
diff --git a/paths_cli/wizard/wizard.py b/paths_cli/wizard/wizard.py
@@ -323,6 +323,3 @@ def run_wizard(self):
 # TWO_STATE_TIS_WIZARD
 # MULTIPLE_STATE_TIS_WIZARD
 # MULTIPLE_INTERFACE_SET_TIS_WIZARD
-
-if __name__ == "__main__":
-    FLEX_LENGTH_TPS_WIZARD.run_wizard()
diff --git a/paths_cli/wizard/wrap_compilers.py b/paths_cli/wizard/wrap_compilers.py
@@ -3,37 +3,37 @@
 from .helper import Helper
 from paths_cli.plugin_management import OPSPlugin
 
-class WrapCompilerWizardPlugin:
-    def __init__(self, name, category, parameters, compiler_plugin,
-                 prerequisite=None, intro=None, description=None):
-        self.name = name
-        self.parameters = parameters
-        self.compiler_plugin = compiler_plugin
-        self.prerequisite = prerequisite
-        self.intro = intro
-        self.description = description
-        loaders = {p.name: p.loader for p in self.compiler_plugin.parameters}
-        for param in self.parameters:
-            param.register_loader(loaders[param.name])
-
-    def _builder(self, wizard, prereqs):
-        dct = dict(prereqs)  # make a copy
-        dct.update({param.name: param(wizard) for param in self.parameters})
-        result = self.compiler_plugin(**dct)
-        return result
-
-    def __call__(self, wizard):
-        if self.intro is not None:
-            wizard.say(self.intro)
-
-        if self.prerequisite is not None:
-            prereqs = self.prerequisite(wizard)
-        else:
-            prereqs = {}
-
-        result = self._builder(wizard, prereqs)
-
-        return result
+# class WrapCompilerWizardPlugin:
+#     def __init__(self, name, category, parameters, compiler_plugin,
+#                  prerequisite=None, intro=None, description=None):
+#         self.name = name
+#         self.parameters = parameters
+#         self.compiler_plugin = compiler_plugin
+#         self.prerequisite = prerequisite
+#         self.intro = intro
+#         self.description = description
+#         loaders = {p.name: p.loader for p in self.compiler_plugin.parameters}
+#         for param in self.parameters:
+#             param.register_loader(loaders[param.name])
+
+#     def _builder(self, wizard, prereqs):
+#         dct = dict(prereqs)  # make a copy
+#         dct.update({param.name: param(wizard) for param in self.parameters})
+#         result = self.compiler_plugin(**dct)
+#         return result
+
+#     def __call__(self, wizard):
+#         if self.intro is not None:
+#             wizard.say(self.intro)
+
+#         if self.prerequisite is not None:
+#             prereqs = self.prerequisite(wizard)
+#         else:
+#             prereqs = {}
+
+#         result = self._builder(wizard, prereqs)
+
+#         return result
 
 class CategoryHelpFunc:
     def __init__(self, category, basic_help=None):
-Original file line number
+Diff line change
@@ Expand Up / @@ -6,6 +6,7 @@ @@
     from paths_cli.utils import get_installed_plugins
     from paths_cli.plugin_management import NamespacePluginLoader
     class CategoryWizardPluginRegistrationError(Exception):
         pass
@@ Expand Down @@