Skip to content

Events Addon

addon

logger = logging.getLogger('scurrypy') module-attribute

E = TypeVar('E', bound=Event) module-attribute

AddonHandler: TypeAlias = _AddonHandler[Any] module-attribute

AddonDecorator: TypeAlias = Callable[[AddonHandler], AddonHandler] module-attribute

EventsAddon

Bases: Addon


              flowchart TD
              scurrypy.ext.events.addon.EventsAddon[EventsAddon]
              scurrypy.bases.addon.Addon[Addon]

                              scurrypy.bases.addon.Addon --> scurrypy.ext.events.addon.EventsAddon
                


              click scurrypy.ext.events.addon.EventsAddon href "" "scurrypy.ext.events.addon.EventsAddon"
              click scurrypy.bases.addon.Addon href "" "scurrypy.bases.addon.Addon"

Addon that implements automatic registering and decorating events.

Parameters:

  • client (Client) –

    the Client object

bot = client instance-attribute

on_startup

Adds registered events to client's event listener.

listen

Register and route an event with params (bot, event).

Raises:

Parameters:

  • event_name (str) –

    event name

  • handler (AddonHandler, default: None ) –

    callback for the event (if not a decorator)

dispatch async

Addon's entry point.

Parameters:

  • event (Event) –

    event data object