flexget.event module#

Provides small event framework.

class flexget.event.Event(name, func, priority=128)[source]#

Bases: object

Represents one registered event.

Parameters:

name (str)
func (Callable)
priority (int)

flexget.event.add_event_handler(name, func, priority=128)[source]#

Return event created.

Parameters:

name (string) – Event name
func (function) – Function that acts as event handler
priority (int) – Priority for this hook

Returns:

Event created

Return type:

Event

Raises:

Exception – If func is already registered in an event

flexget.event.event(name, priority=128)[source]#

Register event to function with a decorator.

Parameters:

name (str)
priority (int)

Return type:

Callable[[Callable], Callable]

flexget.event.fire_event(name, *args, **kwargs)[source]#

Trigger an event with name.

If event is not hooked by anything nothing happens. If a function that hooks an event returns a value, it will replace the first argument when calling next function.

Parameters:

name (str) – Name of event to be called
args – List of arguments passed to handler function
kwargs – Key Value arguments passed to handler function

Return type:

Any

flexget.event.get_events(name)[source]#

Return list of Event for name ordered by priority.

Parameters:: name (String) – event name
Return type:: list[Event]

flexget.event.remove_event_handler(name, func)[source]#

Remove func from the handlers for event name.

Parameters:

name (str)
func (Callable)

Return type:

None

flexget.event.remove_event_handlers(name)[source]#

Remove all handlers for given event name.

Parameters:: name (str)
Return type:: None