plugins.instance module

Provides a base class used to store a loaded plugin.

class plugins.instance.Plugin(plugin_name, manager)[source]

Bases: object

Stores a plugin’s instance.

__init__(plugin_name, manager)[source]

Called when a plugin’s instance is initialized.

Parameters:
  • plugin_name (str) – Name of the plugin to load.
  • manager (PluginManager) – A plugin manager instance.
_load()[source]

Actually load the plugin.

_unload()[source]

Actually unload the plugin.

reload()[source]

Reload the plugin.

unload()[source]

Unload the plugin.

class plugins.instance.ServerPlugin

Bases: Boost.Python.instance

__init__()

Raises an exception This class cannot be instantiated from Python

interface_version

Return the version of the IServerPluginCallbacks interface the plugin is built on.

module_name

Return the path to the plugin’s shared library.

name

Return the name/description of the plugin.