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
37 # ('flatfilts-rolf', True),
41 # ('massanalysis', True),
42 # ('multidistance', True),
45 # ('procplots', True),
47 # ('showconvoluted', True),
48 # ('superimpose', True),
53 """List of plugin modules and whether they should be included by
54 default. TODO: autodiscovery
66 """List of builtin modules. TODO: autodiscovery
69 PLUGIN_SETTING_SECTION = 'plugins'
70 """Name of the config section which controls plugin selection.
74 # Plugins and settings
76 class Plugin (object):
77 """A pluggable collection of Hooke commands.
79 Fulfills the same role for Hooke that a software package does for
82 def __init__(self, name):
84 self.setting_section = '%s plugin' % self.name
88 def dependencies(self):
89 """Return a list of names of :class:`Plugin`\s we require."""
92 def default_settings(self):
93 """Return a list of :class:`hooke.config.Setting`\s for any
94 configurable plugin settings.
96 The suggested section setting is::
98 Setting(section=self.setting_section, help=self.__doc__)
103 """Return a list of :class:`hooke.command.Command`\s provided.
105 return list(self._commands)
107 class Builtin (Plugin):
108 """A required collection of Hooke commands.
110 These "core" plugins provide essential administrative commands
111 (playlist handling, etc.).
115 # Plugin utility functions
117 def argument_to_setting(section_name, argument):
118 """Convert an :class:`~hooke.command.Argument` to a
119 `~hooke.conf.Setting`.
121 This is a lossy transition, because
122 :class:`~hooke.command.Argument`\s store more information than
123 `~hooke.conf.Setting`\s.
125 return Setting(section_name, option=argument.name, value=argument.default,
128 # Construct plugin dependency graph and load plugin instances.
130 PLUGIN_GRAPH = construct_graph(
131 this_modname=__name__,
132 submodnames=[name for name,include in PLUGIN_MODULES] + BUILTIN_MODULES,
133 class_selector=IsSubclass(Plugin, blacklist=[Plugin, Builtin]))
134 """Topologically sorted list of all possible :class:`Plugin`\s and
138 def default_settings():
139 settings = [Setting(PLUGIN_SETTING_SECTION,
140 help='Enable/disable default plugins.')]
141 for pnode in PLUGIN_GRAPH:
142 if pnode.data.name in BUILTIN_MODULES:
143 continue # builtin inclusion is not optional
145 default_include = [di for mod_name,di in PLUGIN_MODULES
146 if mod_name == plugin.name][0]
147 help = 'Commands: ' + ', '.join([c.name for c in plugin.commands()])
148 settings.append(Setting(
149 section=PLUGIN_SETTING_SECTION,
151 value=str(default_include),
154 for pnode in PLUGIN_GRAPH:
156 settings.extend(plugin.default_settings())
159 def load_graph(graph, config, include_section):
164 include = config.getboolean(include_section, item.name)
165 except configparser.NoOptionError:
166 include = True # non-optional include (e.g. a Builtin)
169 item.config = dict(config.items(item.setting_section))
170 except configparser.NoSectionError: