Ran update_copyright.py, updating all the copyright blurbs and adding AUTHORS.

[hooke.git] / hooke / plugin / __init__.py

diff --git a/hooke/plugin/__init__.py b/hooke/plugin/__init__.py
index 6014a66207666ff4eeabd0bccb9c302a0b3a4870..075cdffa0e063c7437a09a666e2f96967e6327dc 100644 (file)
--- a/hooke/plugin/__init__.py
+++ b/hooke/plugin/__init__.py
@@ -1,3 +1,21 @@
+# Copyright (C) 2010 W. Trevor King <wking@drexel.edu>
+#
+# This file is part of Hooke.
+#
+# Hooke is free software: you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation, either
+# version 3 of the License, or (at your option) any later version.
+#
+# Hooke is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with Hooke.  If not, see
+# <http://www.gnu.org/licenses/>.
+
 """The `plugin` module provides optional submodules that add new Hooke
 commands.
 
@@ -7,7 +25,7 @@ All of the science happens in here.
 import ConfigParser as configparser
 
 from ..config import Setting
-from ..util.graph import Node, Graph
+from ..util.pluggable import IsSubclass, construct_graph
 
 
 PLUGIN_MODULES = [
@@ -26,24 +44,31 @@ PLUGIN_MODULES = [
 #    ('multidistance', True),
 #    ('multifit', True),
 #    ('pcluster', True),
+#    ('peakspot', True),
 #    ('procplots', True),
 #    ('review', True),
 #    ('showconvoluted', True),
 #    ('superimpose', True),
-    ('system', True),
 #    ('tutorial', True),
-#    ('viewer', True),
     ]
 """List of plugin modules and whether they should be included by
 default.  TODO: autodiscovery
 """
 
 BUILTIN_MODULES = [
+    'config',
+    'debug',
+    'note',
     'playlist',
+    'system',
     ]
 """List of builtin modules.  TODO: autodiscovery
 """
 
+PLUGIN_SETTING_SECTION = 'plugins'
+"""Name of the config section which controls plugin selection.
+"""
+
 
 # Plugins and settings
 
@@ -87,78 +112,6 @@ class Builtin (Plugin):
 
 # Construct plugin dependency graph and load plugin instances.
 
-def construct_graph(this_modname, submodnames, class_selector,
-                    assert_name_match=True):
-    """Search the submodules `submodnames` of a module `this_modname`
-    for class objects for which `class_selector(class)` returns
-    `True`.  These classes are instantiated, and the `instance.name`
-    is compared to the `submodname` (if `assert_name_match` is
-    `True`).
-
-    The instances are further arranged into a dependency
-    :class:`hooke.util.graph.Graph` according to their
-    `instance.dependencies()` values.  The topologically sorted graph
-    is returned.
-    """
-    instances = {}
-    for submodname in submodnames:
-        count = len([s for s in submodnames if s == submodname])
-        assert count > 0, 'No %s entries: %s' % (submodname, submodnames)
-        assert count == 1, 'Multiple (%d) %s entries: %s' \
-            % (count, submodname, submodnames)
-        this_mod = __import__(this_modname, fromlist=[submodname])
-        submod = getattr(this_mod, submodname)
-        for objname in dir(submod):
-            obj = getattr(submod, objname)
-            if class_selector(obj):
-                instance = obj()
-                if assert_name_match == True and instance.name != submodname:
-                    raise Exception(
-                        'Instance name %s does not match module name %s'
-                        % (instance.name, submodname))
-                instances[instance.name] = instance
-    graph = Graph([Node([instances[name] for name in i.dependencies()],
-                        data=i)
-                   for i in instances.values()])
-    graph.topological_sort()
-    return graph
-
-class IsSubclass (object):
-    """A safe subclass comparator.
-    
-    Examples
-    --------
-
-    >>> class A (object):
-    ...     pass
-    >>> class B (A):
-    ...     pass
-    >>> C = 5
-    >>> is_subclass = IsSubclass(A)
-    >>> is_subclass(A)
-    True
-    >>> is_subclass = IsSubclass(A, blacklist=[A])
-    >>> is_subclass(A)
-    False
-    >>> is_subclass(B)
-    True
-    >>> is_subclass(C)
-    False
-    """
-    def __init__(self, base_class, blacklist=None):
-        self.base_class = base_class
-        if blacklist == None:
-            blacklist = []
-        self.blacklist = blacklist
-    def __call__(self, other):
-        try:
-            subclass = issubclass(other, self.base_class)
-        except TypeError:
-            return False
-        if other in self.blacklist:
-            return False
-        return subclass
-
 PLUGIN_GRAPH = construct_graph(
     this_modname=__name__,
     submodnames=[name for name,include in PLUGIN_MODULES] + BUILTIN_MODULES,
@@ -168,8 +121,8 @@ PLUGIN_GRAPH = construct_graph(
 """
 
 def default_settings():
-    settings = [Setting(
-            'plugins', help='Enable/disable default plugins.')]
+    settings = [Setting(PLUGIN_SETTING_SECTION,
+                        help='Enable/disable default plugins.')]
     for pnode in PLUGIN_GRAPH:
         if pnode.data.name in BUILTIN_MODULES:
             continue # builtin inclusion is not optional
@@ -178,7 +131,7 @@ def default_settings():
                            if mod_name == plugin.name][0]
         help = 'Commands: ' + ', '.join([c.name for c in plugin.commands()])
         settings.append(Setting(
-                section='plugins',
+                section=PLUGIN_SETTING_SECTION,
                 option=plugin.name,
                 value=str(default_include),
                 help=help,