Home | Trees | Indices | Help |
|
---|
|
object --+ | Plugin
Base class for doapfiend plugins. It's not necessary to subclass this class to create a plugin; however, all plugins must implement `add_options(self, parser)` and `configure(self, options, conf)`, and must have the attributes `enabled` and `name`.
Plugins should not be enabled by default.
Subclassing Plugin will give your plugin some friendly default behavior:
|
|||
|
|||
|
|||
|
|||
|
|||
Inherited from |
|
|||
enable_opt = None
|
|||
enabled = False
|
|||
name = None
|
|
|||
Inherited from |
|
x.__init__(...) initializes x; see x.__class__.__doc__ for signature
|
Add command-line options for this plugin. The base plugin class adds --with-$name by default, used to enable the plugin. |
Configure the plugin and system, based on selected options. The base plugin class sets the plugin to enabled if the enable option for the plugin (self.enable_opt) is true. |
Return help for this plugin. This will be output as the help section of the --with-$name option that enables the plugin. |
Home | Trees | Indices | Help |
|
---|
Generated by Epydoc 3.0.1 on Mon Jun 9 22:26:19 2008 | http://epydoc.sourceforge.net |