twisted.python.plugin

Package twisted :: Package python :: Module plugin

[show private | hide private]

Module twisted.python.plugin

Classes
`PlugIn`	I am a Python module registered in a plugins.tml file.
`DropIn`	I am a Python package containing plugins.tml.

Function Summary
`list` of `str`	`getPluginFileList(debugInspection, showProgress)` Find plugin.tml files in subdirectories of paths in `sys.path`
`list`	`loadPlugins(plugInType, fileList, debugInspection, showProgress)` Traverse the given list of files and attempt to load plugins from them.
`list`	`getPlugIns(plugInType, debugInspection, showProgress)` Helper function to get all the plugins of a particular type.
	`_prepCallbacks(debug, progress)`

Variable Summary
`_Feature`	`nested_scopes`

Function Details

Find plugin.tml files in subdirectories of paths in sys.path

Parameters:: debugInspection - If not None, this is invoked with strings containing debug information about the loading process. If it is any other true value, this debug information is written to stdout (This behavior is deprecated).
(type=None or a callable taking one argument); showProgress - If not None, this is invoked with floating point values between 0 and 1 describing the progress of the loading process. If it is any other true value, this progress information is written to stdout. (This behavior is deprecated).
(type=None or a callable taking one argument.)

Helper function to get all the plugins of a particular type.

Parameters:: plugInType - The type of plugin to search for. This is tested against the type argument to the register function in the plugin.tml files.
(type=str); debugInspection - If not None, this is invoked with strings containing debug information about the loading process. If it is any other true value, this debug information is written to stdout (This behavior is deprecated).
(type=None or a callable taking one argument); showProgress - If not None, this is invoked with floating point values between 0 and 1 describing the progress of the loading process. If it is any other true value, this progress information is written to stdout. (This behavior is deprecated).
(type=None or a callable taking one argument.)

Traverse the given list of files and attempt to load plugins from them.

Parameters:: plugInType - The type of plugin to search for. This is tested against the type argument to the register function in the plugin.tml files.
(type=str); fileList - A list of the files to attempt to load plugin information from. One name is put in their scope, the register function.
(type=list of str); debugInspection - If not None, this is invoked with strings containing debug information about the loading process. If it is any other true value, this debug information is written to stdout (This behavior is deprecated).
(type=None or a callable taking one argument); showProgress - If not None, this is invoked with floating point values between 0 and 1 describing the progress of the loading process. If it is any other true value, this progress information is written to stdout. (This behavior is deprecated).
(type=None or a callable taking one argument.)

Variable Details

Type:

_Feature

Value:

_Feature((2, 1, 0, 'beta', 1), (2, 2, 0, 'alpha', 0), 16)

Generated by Epydoc 1.1 on Fri Jun 27 03:48:42 2003