t.plugin : module documentation

Part of twisted View Source

Plugin system for Twisted.
AuthorsJp Calderone
Glyph Lefkowitz
Interface IPlugin Interface that must be implemented by all plugins.
Class CachedPlugin Undocumented
Class CachedDropin A collection of CachedPlugin instances from a particular module in a plugin package.
Function fromkeys Undocumented
Function getCache Compute all the possible loadable plugins, while loading as few as possible and hitting the filesystem as little as possible.
Function getPlugins Retrieve all plugins implementing the given interface beneath the given module.
Function pluginPackagePaths Return a list of additional directories which should be searched for modules to be included as part of the named plugin package.
Function _determinePickleModule Determine which 'pickle' API module to use.
Function _generateCacheEntry Undocumented
def _determinePickleModule(): (source)
Determine which 'pickle' API module to use.
def _generateCacheEntry(provider): (source)
Undocumented
def fromkeys(keys, value=None): (source)
Undocumented
def getCache(module): (source)
Compute all the possible loadable plugins, while loading as few as possible and hitting the filesystem as little as possible.
Parametersmodulea Python module object. This represents a package to search for plugins.
Returnsa dictionary mapping module names to CachedDropin instances.
def getPlugins(interface, package=None): (source)
Retrieve all plugins implementing the given interface beneath the given module.
ParametersinterfaceAn interface class. Only plugins which implement this interface will be returned.
packageA package beneath which plugins are installed. For most uses, the default value is correct.
ReturnsAn iterator of plugins.
def pluginPackagePaths(name): (source)
Return a list of additional directories which should be searched for modules to be included as part of the named plugin package.
ParametersnameThe fully-qualified Python name of a plugin package, eg 'twisted.plugins'. (type: str)
ReturnsThe absolute paths to other directories which may contain plugin modules for the named plugin package. (type: list of str)
API Documentation for Twisted, generated by pydoctor at 2014-05-12 18:27:00.