API docs for “lib.pluginSupport.pluginSupport”

Class l.p.pluginSupport:

Part of lib.pluginSupport View Source View In Hierarchy

Known subclasses: services.ircClient.Bot, services.ircServer.Server, services.remoteCliServer.remoteCLI, services.webServer.myHTTPRequestHandler, services.webServer.webPluginSupport

No class docstring

Method	__init__	Undocumented
Method	register_pluginsupport_commands	Undocumented
Method	depends	Undocumented
Method	depends_on_module	Undocumented
Method	depends_on_service	Undocumented
Method	depends_on_plugin	Undocumented
Method	importPlugin	Undocumented
Method	callbackRegistered	Undocumented
Method	registerCallback	Undocumented
Method	unregisterCallback	Undocumented
Method	startPlugins	initializes all known plugins
Method	startPlugin	Undocumented
Method	reloadPluginClass	Undocumented
Method	restartPlugin	Undocumented
Method	reloadPlugins	call this to reload all plugins
Method	stopPlugins	stop all Plugins
Method	stopPlugin	Undocumented
Class	WontStart	Undocumented
Class	DependencyMissing	Undocumented
Class	ModuleMissing	Undocumented
Class	ServiceMissing	Undocumented
Class	PluginMissing	Undocumented
Method	logerror	format a exception nicely and pass it to the logger
Method	_getClassName	Undocumented
Method	_apirunner	Pass all calls to plugin callbacks through this method, they

def __init__(self, root, parent): (source)

overridden in services.ircClient.Bot, services.ircServer.Server, services.remoteCliServer.remoteCLI, services.webServer.myHTTPRequestHandler, services.webServer.webPluginSupport

Undocumented

def _getClassName(self, clas): (source)

Undocumented

def register_pluginsupport_commands(self): (source)

Undocumented

def depends(self, dependency): (source)

overridden in services.ircClient.Bot

Undocumented

def depends_on_module(self, dependency): (source)

Undocumented

def depends_on_service(self, dependency): (source)

Undocumented

def depends_on_plugin(dependency): (source)

Undocumented

def importPlugin(self, name): (source)

Undocumented

def callbackRegistered(self, module, callbackname): (source)

Undocumented

def registerCallback(self, module, callbackname, priority=10): (source)

Undocumented

def unregisterCallback(self, module, callbackname): (source)

Undocumented

def startPlugins(self): (source)

overridden in services.ircClient.Bot

initializes all known plugins

def startPlugin(self, pluginName): (source)

overridden in services.ircClient.Bot, services.ircServer.Server

Undocumented

def reloadPluginClass(self, pluginClass): (source)

Undocumented

def restartPlugin(self, pluginName): (source)

Undocumented

def reloadPlugins(self): (source)

call this to reload all plugins

def stopPlugins(self): (source)

stop all Plugins

def stopPlugin(self, pluginName): (source)

Undocumented

def logerror(self, logger, plugin, exception): (source)

format a exception nicely and pass it to the logger

Parameters	logger	the logger instance to use
	plugin	the plugin in which the exception occured (type: string )
	exception	the exception (type: exception )

def _apirunner(self, apifunction, args={}): (source)

Pass all calls to plugin callbacks through this method, they are checked whether they should be executed or not.

Example self._apirunner("privmsg",{"user":user,"channel":channel,"msg":msg})

Parameters	apifunction	the name of the callback function (type: string )
	args	the arguments for the callback (type: dict )

API Documentation for OtfBot - the friendly Bot, generated by pydoctor at 2010-01-04 01:40:56.