more pylint cleanup for the wizard

main thing left is, I think, wizard.py

Author: dwhswenson

paths_cli/wizard/plugin_classes.py

@@ -7,7 +7,8 @@
 
 
 class WizardObjectPluginRegistrationError(Exception):
-    pass
+    """Error during wizard object plugin registration.
+    """
 
 
 _PLUGIN_DOCSTRING = """
@@ -30,6 +31,7 @@ class WizardObjectPluginRegistrationError(Exception):
         created
 """ + _PLUGIN_DOCSTRING
 
+
 class LoadFromOPS(OPSPlugin):
     """Wizard plugin type to load from an existing OPS file.
 
@@ -62,6 +64,7 @@ def __init__(self, category, *, obj_name=None, store_name=None,
     def __call__(self, wizard, context=None):
         return load_from_ops(wizard, self.store_name, self.obj_name)
 
+
 def get_text_from_context(name, instance, default, wizard, context, *args,
                           **kwargs):
     """Generic method for getting text from context of other sources.
@@ -130,6 +133,7 @@ def __init__(self, name, category, builder, *, prerequisite=None,
         self._summary = summary  # func to summarize
 
     def default_summarize(self, wizard, context, result):
+        """Default summary function"""
         return [f"Here's what we'll make:\n  {str(result)}"]
 
     def get_summary(self, wizard, context, result):
@@ -354,8 +358,7 @@ def _set_context(self, wizard, context, selected):
         """If user has provided a funtion to create context, use it."""
         if self._user_set_context:
             return self._user_set_context(wizard, context, selected)
-        else:
-            return context
+        return context
 
     def register_plugin(self, plugin):
         """Register a :class:`.WizardObjectPlugin` with this category.

paths_cli/wizard/plugin_registration.py

@@ -1,15 +1,15 @@
+import logging
 from paths_cli.wizard.plugin_classes import (
     LoadFromOPS, WizardObjectPlugin, WrapCategory
 )
 from paths_cli.utils import get_installed_plugins
 from paths_cli.plugin_management import NamespacePluginLoader
 
-import logging
 logger = logging.getLogger(__name__)
 
 
 class CategoryWizardPluginRegistrationError(Exception):
-    pass
+    """Error with wizard category plugin registration fails"""
 
 
 _CATEGORY_PLUGINS = {}
@@ -70,15 +70,16 @@ def register_plugins(plugins):
             object_plugins.append(plugin)
 
     for plugin in categories:
-        logger.debug("Registering " + str(plugin))
+        logger.debug("Registering %s", str(plugin))
         _register_category_plugin(plugin)
 
     for plugin in object_plugins:
         category = _CATEGORY_PLUGINS[plugin.category]
-        logger.debug("Registering " + str(plugin))
-        logger.debug("Category: " + str(category))
+        logger.debug("Registering %s", str(plugin))
+        logger.debug("Category: %s", str(category))
         category.register_plugin(plugin)
 
+
 def register_installed_plugins():
     """Register all Wizard plugins found in standard locations.
 

paths_cli/wizard/run_module.py

@@ -2,6 +2,7 @@
 from paths_cli.wizard.wizard import Wizard
 from paths_cli.wizard.plugin_registration import get_category_wizard
 
+
 # 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

paths_cli/wizard/shooting.py

@@ -2,18 +2,19 @@
 
 from paths_cli.wizard.core import get_missing_object
 from paths_cli.wizard.plugin_registration import get_category_wizard
-from paths_cli.compiling.tools import custom_eval
 
-engines = get_category_wizard('engine')
 
-import numpy as np
+engines = get_category_wizard('engine')
 
 
 def uniform_selector(wizard):
+    """Create a uniform selector (using the wizard)"""
     import openpathsampling as paths
     return paths.UniformSelector()
 
+
 def gaussian_selector(wizard):
+    """Create a Gaussian biased selector (using the wizard)"""
     import openpathsampling as paths
     cv_name = wizard.ask_enumerate("Which CV do you want the Gaussian to "
                                    "be based on?",
@@ -44,6 +45,7 @@ def gaussian_selector(wizard):
 
     # return allowed
 
+
 SHOOTING_SELECTORS = {
     'Uniform random': uniform_selector,
     'Gaussian bias': gaussian_selector,
@@ -59,6 +61,7 @@ def _get_selector(wizard, selectors=None):
     selector = selectors[sel](wizard)
     return selector
 
+
 def one_way_shooting(wizard, selectors=None, engine=None):
     from openpathsampling import strategies
     if engine is None:
@@ -73,6 +76,7 @@ def one_way_shooting(wizard, selectors=None, engine=None):
 # def two_way_shooting(wizard, selectors=None, modifiers=None):
     # pass
 
+
 def spring_shooting(wizard, engine=None):
     import openpathsampling as paths
     if engine is None:
@@ -109,10 +113,10 @@ def shooting(wizard, shooting_types=None, engine=None):
     # allowed_modifiers = get_allowed_modifiers(engine)
     # TWO_WAY = 'Two-way shooting'
     # if len(allowed_modifiers) == 0 and TWO_WAY in shooting_types:
-        # del shooting_types[TWO_WAY]
+    #     del shooting_types[TWO_WAY]
     # else:
-        # shooting_types[TWO_WAY] = partial(two_way_shooting,
-                                          # allowed_modifiers=allowed_modifiers)
+    #     shooting_types[TWO_WAY] = partial(two_way_shooting,
+    #                                       allowed_modifiers=allowed_modifiers)
 
     shooting_type = None
     if len(shooting_types) == 1:
@@ -126,4 +130,3 @@ def shooting(wizard, shooting_types=None, engine=None):
 
     shooting_strategy = shooting_type(wizard)
     return shooting_strategy
-

paths_cli/wizard/standard_categories.py

@@ -23,6 +23,7 @@
 
 CATEGORIES = {cat.name: cat for cat in _CATEGORY_LIST}
 
+
 def get_category_info(category):
     """Obtain info for a stanard (or registered) category.
 

paths_cli/wizard/steps.py

@@ -1,8 +1,5 @@
 from collections import namedtuple
-from functools import partial
-
 from paths_cli.wizard.plugin_registration import get_category_wizard
-from paths_cli.wizard.tps import tps_scheme
 
 volumes = get_category_wizard('volume')
 
@@ -26,5 +23,3 @@
                                   store_name="states",
                                   minimum=2,
                                   maximum=float('inf'))
-
-

paths_cli/wizard/tools.py

@@ -1,5 +1,6 @@
 def a_an(obj):
     return "an" if obj[0].lower() in "aeiou" else "a"
 
+
 def yes_no(char):
     return {'yes': True, 'no': False, 'y': True, 'n': False}[char.lower()]

paths_cli/wizard/tps.py

@@ -1,11 +1,10 @@
-from paths_cli.wizard.tools import a_an
 from paths_cli.wizard.core import get_missing_object
 from paths_cli.wizard.shooting import shooting
 from paths_cli.wizard.plugin_registration import get_category_wizard
 
-from functools import partial
 volumes = get_category_wizard('volume')
 
+
 def tps_network(wizard):
     raise NotImplementedError("Still need to add other network choices")
 

paths_cli/wizard/two_state_tps.py

@@ -5,9 +5,10 @@
 )
 from paths_cli.wizard.wizard import Wizard
 from paths_cli.wizard import pause
+from paths_cli.wizard.volumes import _FIRST_STATE, _VOL_DESC
 
 volumes = get_category_wizard('volume')
-from paths_cli.wizard.volumes import _FIRST_STATE, _VOL_DESC
+
 
 def two_state_tps(wizard, fixed_length=False):
     import openpathsampling as paths