IPlugin¶

class mobase.IPlugin¶

Bases: abc.ABC

Base class for all plugins.

Methods Summary

`author`()	returns The name of the plugin author.
`description`()	returns The description for this plugin.
`init`(organizer)	Initialize this plugin.
`isActive`()	Check if this plugin is active.
`name`()	Retrieve the name of the plugin.
`settings`()	returns A list of settings for this plugin.
`version`()	returns The version of this plugin.

Methods Documentation

abstract author()¶

Returns: The name of the plugin author.
Return type: str

abstract description()¶

Returns: The description for this plugin.
Return type: str

abstract init(organizer)¶

Initialize this plugin.

Parameters: organizer – The main organizer interface.
Returns: True if the plugin was initialized correctly, False otherwise.
Return type: bool

abstract isActive()¶

Check if this plugin is active.

It is possible to use a plugin setting (specified in settings()) here to allow users to manually enable/disable a plugin.

Returns: True if this plugin is active, False otherwise.
Return type: bool

abstract name()¶

Retrieve the name of the plugin.

The name of the plugin is used for internal storage purpose so it should not change, and it should be static. In particular, you should not use a localized string (tr()) for the plugin name.

In the future, we will provide a way to localized plugin names using a distinct method, such as localizedName().

Returns: The name of the plugin.
Return type: str

abstract settings()¶

Returns: A list of settings for this plugin.
Return type: List[PluginSetting]

abstract version()¶

Returns: The version of this plugin.
Return type: VersionInfo