t.p.plugin : module documentation

Part of twisted.python View Source

No module docstring
Class PlugIn I am a Python module registered in a plugins.tml file.
Class DropIn I am a Python package containing plugins.tml.
Function getPluginFileList Find plugin.tml files in subdirectories of paths in sys.path
Function loadPlugins Traverse the given list of files and attempt to load plugins from them.
Function getPlugIns Helper function to get all the plugins of a particular type.
Function isAModule This function checks the directory for __init__ files.
Function _prepCallbacks Undocumented
Function _getPlugIns Undocumented
def _prepCallbacks(debug, progress): (source)
Undocumented
def getPluginFileList(debugInspection=None, showProgress=None): (source)
Find plugin.tml files in subdirectories of paths in sys.path
ParametersdebugInspectionIf 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 )
showProgressIf 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. )
ReturnsA list of the plugin.tml files found. (type: list of str )
def loadPlugins(plugInType, fileList, debugInspection=None, showProgress=None): (source)
Traverse the given list of files and attempt to load plugins from them.
ParametersplugInTypeThe type of plugin to search for. This is tested against the type argument to the register function in the plugin.tml files. (type: str )
fileListA 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 )
debugInspectionIf 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 )
showProgressIf 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. )
ReturnsA list of the PlugIn objects found. (type: list )
def getPlugIns(plugInType, debugInspection=None, showProgress=None): (source)
Helper function to get all the plugins of a particular type.
ParametersplugInTypeThe type of plugin to search for. This is tested against the type argument to the register function in the plugin.tml files. (type: str )
debugInspectionIf 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 )
showProgressIf 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. )
ReturnsA list of PlugIn objects that were found. (type: list )
def _getPlugIns(plugInType, debugInspection=None, showProgress=None): (source)
Undocumented
def isAModule(d): (source)
This function checks the directory for __init__ files.
API Documentation for Twisted, generated by pydoctor at 2011-10-27 16:02:37.