1 # Copyright (C) 2010 W. Trevor King <wking@drexel.edu>
3 # This file is part of Hooke.
5 # Hooke is free software: you can redistribute it and/or
6 # modify it under the terms of the GNU Lesser General Public
7 # License as published by the Free Software Foundation, either
8 # version 3 of the License, or (at your option) any later version.
10 # Hooke is distributed in the hope that it will be useful,
11 # but WITHOUT ANY WARRANTY; without even the implied warranty of
12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 # GNU Lesser General Public License for more details.
15 # You should have received a copy of the GNU Lesser General Public
16 # License along with Hooke. If not, see
17 # <http://www.gnu.org/licenses/>.
19 """The `plugin` module provides optional submodules that add new Hooke
22 All of the science happens in here.
25 import ConfigParser as configparser
27 from ..config import Setting
28 from ..util.pluggable import IsSubclass, construct_graph
33 # ('curvetools', True),
37 # ('flatfilts-rolf', True),
39 # ('generalclamp', True),
40 # ('generaltccd', True),
41 # ('generalvclamp', True),
44 # ('massanalysis', True),
45 # ('multidistance', True),
49 # ('procplots', True),
51 # ('showconvoluted', True),
52 # ('superimpose', True),
55 """List of plugin modules and whether they should be included by
56 default. TODO: autodiscovery
67 """List of builtin modules. TODO: autodiscovery
70 PLUGIN_SETTING_SECTION = 'plugins'
71 """Name of the config section which controls plugin selection.
75 # Plugins and settings
77 class Plugin (object):
78 """A pluggable collection of Hooke commands.
80 Fulfills the same role for Hooke that a software package does for
83 def __init__(self, name):
85 self.setting_section = '%s plugin' % self.name
89 def dependencies(self):
90 """Return a list of names of :class:`Plugin`\s we require."""
93 def default_settings(self):
94 """Return a list of :class:`hooke.config.Setting`\s for any
95 configurable plugin settings.
97 The suggested section setting is::
99 Setting(section=self.setting_section, help=self.__doc__)
104 """Return a list of :class:`hooke.command.Command`\s provided.
106 return list(self._commands)
108 class Builtin (Plugin):
109 """A required collection of Hooke commands.
111 These "core" plugins provide essential administrative commands
112 (playlist handling, etc.).
116 # Construct plugin dependency graph and load plugin instances.
118 PLUGIN_GRAPH = construct_graph(
119 this_modname=__name__,
120 submodnames=[name for name,include in PLUGIN_MODULES] + BUILTIN_MODULES,
121 class_selector=IsSubclass(Plugin, blacklist=[Plugin, Builtin]))
122 """Topologically sorted list of all possible :class:`Plugin`\s and
126 def default_settings():
127 settings = [Setting(PLUGIN_SETTING_SECTION,
128 help='Enable/disable default plugins.')]
129 for pnode in PLUGIN_GRAPH:
130 if pnode.data.name in BUILTIN_MODULES:
131 continue # builtin inclusion is not optional
133 default_include = [di for mod_name,di in PLUGIN_MODULES
134 if mod_name == plugin.name][0]
135 help = 'Commands: ' + ', '.join([c.name for c in plugin.commands()])
136 settings.append(Setting(
137 section=PLUGIN_SETTING_SECTION,
139 value=str(default_include),
142 for pnode in PLUGIN_GRAPH:
144 settings.extend(plugin.default_settings())
147 def load_graph(graph, config, include_section):
152 include = config.getboolean(include_section, item.name)
153 except configparser.NoOptionError:
154 include = True # non-optional include (e.g. a Builtin)
157 item.config = dict(config.items(item.setting_section))
158 except configparser.NoSectionError:
163 def setting_to_argument(self, setting):
164 """Convert a :class:`~hooke.conf.Setting` to an
165 :class:`~hooke.command.Argument`.