API Documentation

Import this module to make event handling a little simpler.

class evenz.events.Args

Bases: tuple

Extend this named tuple to provide easy-to-understand arguments for your events.

property sender

the originator of the event

class evenz.events.Event(f: Callable, sender: Any = None)

Bases: object

An event object wraps a function and notifies a set of handlers when the function is called.

__init__(f: Callable, sender: Any = None)

Parameters

• f – the function that triggers the event

• sender – the sender of the event

property handlers

Get the handlers for this function.

Returns

an iteration of the handlers.

subscribe(handler: Callable)

Subscribe a handler function to this event.

Parameters

handler – the handler

Note

You can also use the += operator.

trigger(*args, **kwargs)

Trigger the event.

unsubscribe(handler: Callable)

Unsubscribe a handler function from this event.

Parameters

handler – the handler

Note

You can also use the -= operator.

evenz.events.event(f: Callable) → evenz.events.Event

Decorate a function or method to create an Event.

Parameters

f – the function.

Returns

the event

See also

If you are decorating a method within a class, you’ll need to use the observable() class decorator on the class as well.

evenz.events.observable(cls)

Use this decorator to mark a class that exposes events.

Parameters

cls – the class

Returns

the class

See also

If you are using this decorator, you probably also want to use event() on some of the methods.