Plugins API Reference#

class lightbulb.plugins.Plugin(name: str, description: Optional[str] = None, include_datastore: bool = False, default_enabled_guilds: Union[int, Sequence[int], hikari.undefined.UndefinedType] = UNDEFINED)[source]#

Container class for commands and listeners that can be loaded and unloaded from the bot to allow for hot-swapping of commands.

Parameters
  • name (str) – The name of the plugin.

  • description (Optional[str]) – Description of the plugin. Defaults to None.

  • include_datastore (bool) – Whether or not to create a DataStore instance internally for this plugin.

  • default_enabled_guilds (UndefinedOr[Union[int, Sequence[int]]]) – The guilds to create application commands registered to this plugin in by default. This overrides default_enabled_guilds but is overridden by guilds.

add_checks(*checks: t.Union[checks_.Check, checks_._ExclusiveCheck]) None[source]#

Adds one or more checks to the plugin object. These checks will be run for all commands in the plugin.

Parameters

*checks (Check) – Check object(s) to add to the command.

Returns

None

command(cmd_like: commands.base.CommandLike) commands.base.CommandLike[source]#
command() t.Callable[[commands.base.CommandLike], commands.base.CommandLike]

Adds a CommandLike object as a command to the plugin. This method can be used as a first or second order decorator, or called manually with the CommandLike instance to add as a command.

create_commands() None[source]#

Creates the command objects implemented by the CommandLike objects registered to the plugin.

Returns

None

listener(event: Type[hikari.events.base_events.Event], listener_func: lightbulb.plugins.ListenerT, *, bind: bool = 'False') lightbulb.plugins.ListenerT[source]#
listener(event: Type[hikari.events.base_events.Event], *, bind: bool = 'False') Callable[[lightbulb.plugins.ListenerT], lightbulb.plugins.ListenerT]

Adds a listener function to the plugin. This method can be used as a second order decorator, or called manually with the event type and function to add to the plugin as a listener.

Parameters

event (Type[Event) – Event that the listener is for.

Keyword Arguments

bind (bool) – Whether or not to bind the listener function to the plugin. If True, the function will be converted into a bound method and so will be called with the plugin as the first argument, and the error event as the second argument. Defaults to False.

remove_hook(func: lightbulb.plugins.RemoveHookT, *, bind: bool = 'False') lightbulb.plugins.RemoveHookT[source]#
remove_hook(*, bind: bool = 'False') Callable[[lightbulb.plugins.RemoveHookT], lightbulb.plugins.RemoveHookT]

Sets the remove hook function for the plugin. This method can be used as a second order decorator, or called manually with the function to set the plugin’s remove hook to. The registered function will be called when the plugin is removed from the bot so may be useful for teardown.

This function will be called after all the members of the plugin (listeners and commands) have already been removed from the bot.

Keyword Arguments

bind (bool) – Whether or not to bind the remove hook function to the plugin. If True, the function will be converted into a bound method and so will be called with the plugin as an argument. Defaults to False.

set_error_handler(func: lightbulb.plugins.ErrorHandlerT, *, bind: bool = 'False') lightbulb.plugins.ErrorHandlerT[source]#
set_error_handler(*, bind: bool = 'False') Callable[[lightbulb.plugins.ErrorHandlerT], lightbulb.plugins.ErrorHandlerT]

Sets the error handler function for the plugin. This method can be used as a second order decorator, or called manually with the event type and function to set the plugin’s error handler to.

Keyword Arguments

bind (bool) – Whether or not to bind the error handler function to the plugin. If True, the function will be converted into a bound method and so will be called with the plugin as the first argument, and the error event as the second argument. Defaults to False.

property all_commands: t.List[commands.base.Command]#

List of all created command objects registered to the plugin.

property app: app_.BotApp#

The BotApp instance that the plugin is registered to.

property bot: app_.BotApp#

Alias for app

property d: lightbulb.utils.data_store.DataStore#

A DataStore instance enabling storage of custom data without subclassing. This will raise a RuntimeError unless you explicitly specify you want the data storage instance included by passing the kwarg include_datastore=True to the constructor.

default_enabled_guilds: hikari.UndefinedOr[t.Sequence[int]]#

The guilds that application commands registered to this plugin will be created in by default.

description: str#

The plugin’s description.

name: str#

The plugin’s name.

property raw_commands: t.List[commands.base.CommandLike]#

List of all the CommandLike objects registered to the plugin.