Module t.plugin

Plugin system for Twisted.

Authors	Jp Calderone
	Glyph Lefkowitz

Line #	Kind	Name	Docs
38	Interface	IPlugin	Interface that must be implemented by all plugins.
49	Class	CachedPlugin	Undocumented
78	Class	CachedDropin	A collection of `CachedPlugin` instances from a particular module in a
114	Function	fromkeys	Undocumented
120	Function	getCache	Compute all the possible loadable plugins, while loading as few as
186	Function	getPlugins	Retrieve all plugins implementing the given interface beneath the given module.
216	Function	pluginPackagePaths	Return a list of additional directories which should be searched for
18	Function	_determinePickleModule	Determine which 'pickle' API module to use.
102	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.

Parameters	module	a Python module object. This represents a package to search for plugins.
Returns	a dictionary mapping module names to CachedDropin instances.

def getPlugins(interface, package=None): (source)

Retrieve all plugins implementing the given interface beneath the given module.

Parameters	interface	An interface class. Only plugins which implement this interface will be returned.
	package	A package beneath which plugins are installed. For most uses, the default value is correct.
Returns	An 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.

Parameters	name	The fully-qualified Python name of a plugin package, eg `'twisted.plugins'`. (type: `str` )
Returns	The 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 2008-10-26 16:12:37.