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 modify it
6 # under the terms of the GNU Lesser General Public License as
7 # published by the Free Software Foundation, either version 3 of the
8 # License, or (at your option) any later version.
10 # Hooke is distributed in the hope that it will be useful, but WITHOUT
11 # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
12 # or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General
13 # 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
28 from ..config import Setting
29 from ..util.pluggable import IsSubclass, construct_graph
37 # ('flatfilts-rolf', True),
40 # ('massanalysis', True),
41 # ('multidistance', True),
44 ('polymer_fit', 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
68 """List of builtin modules. TODO: autodiscovery
71 PLUGIN_SETTING_SECTION = 'plugins'
72 """Name of the config section which controls plugin selection.
76 # Plugins and settings
78 class Plugin (object):
79 """A pluggable collection of Hooke commands.
81 Fulfills the same role for Hooke that a software package does for
82 an operating system: contains a chunk of related commands and
83 routines. Command configuration also happens on the `Plugin`
84 level, with per-plugin sections in the configuration file.
86 def __init__(self, name):
88 self.setting_section = '%s plugin' % self.name
92 def dependencies(self):
93 """Return a list of names of :class:`Plugin`\s we require."""
96 def default_settings(self):
97 """Return a list of :class:`hooke.config.Setting`\s for any
98 configurable plugin settings.
100 The suggested section setting is::
102 Setting(section=self.setting_section, help=self.__doc__)
107 """Return a list of :class:`hooke.command.Command`\s provided.
109 return list(self._commands)
112 class Builtin (Plugin):
113 """A required collection of Hooke commands.
115 These "core" plugins provide essential administrative commands
116 (playlist handling, etc.).
121 # Plugin utility functions
123 def argument_to_setting(section_name, argument):
124 """Convert an :class:`~hooke.command.Argument` to a
125 `~hooke.conf.Setting`.
127 This is useful if, for example, you want to define arguments with
128 configurable default values.
130 Conversion is lossy transition, because
131 :class:`~hooke.command.Argument`\s store more information than
132 `~hooke.conf.Setting`\s.
134 return Setting(section_name, option=argument.name, value=argument.default,
135 type=argument.type, count=argument.count,
139 # Construct plugin dependency graph and load plugin instances.
141 PLUGIN_GRAPH = construct_graph(
142 this_modname=__name__,
143 submodnames=[name for name,include in PLUGIN_MODULES] + BUILTIN_MODULES,
144 class_selector=IsSubclass(Plugin, blacklist=[Plugin, Builtin]))
145 """Topologically sorted list of all possible :class:`Plugin`\s and
149 def default_settings():
150 settings = [Setting(PLUGIN_SETTING_SECTION,
151 help='Enable/disable default plugins.')]
152 for pnode in PLUGIN_GRAPH:
153 if pnode.data.name in BUILTIN_MODULES:
154 continue # builtin inclusion is not optional
156 default_include = [di for mod_name,di in PLUGIN_MODULES
157 if mod_name == plugin.name][0]
158 help = 'Commands: ' + ', '.join([c.name for c in plugin.commands()])
159 settings.append(Setting(
160 section=PLUGIN_SETTING_SECTION,
162 value=str(default_include),
165 for pnode in PLUGIN_GRAPH:
167 settings.extend(plugin.default_settings())
170 def load_graph(graph, config, include_section):
173 conditions = config.items('conditions')
177 include = config.getboolean(include_section, item.name)
178 except configparser.NoOptionError:
179 include = True # non-optional include (e.g. a Builtin)
180 enabled[item.name] = include
182 for dependency in node:
183 if enabled.get(dependency.data.name, None) != True:
184 log = logging.getLogger('hooke')
186 'could not setup plugin %s. unsatisfied dependency on %s.'
187 % (item.name, dependency.data.name))
188 enabled[item.name] = False
191 item.config = dict(config.items(item.setting_section))
192 except configparser.NoSectionError:
194 for key,value in conditions:
195 if key not in item.config:
196 item.config[key] = value