t.w.x.u.CallbackList : class documentation

Part of twisted.words.xish.utility View Source View In Hierarchy

Container for callbacks.

Event queries are linked to lists of callables. When a matching event occurs, these callables are called in sequence. One-time callbacks are removed from the list after the first time the event was triggered.

Arguments to callbacks are split spread across two sets. The first set, callback specific, is passed to addCallback and is used for all subsequent event triggers. The second set is passed to callback and is event specific. Positional arguments in the second set come after the positional arguments of the first set. Keyword arguments in the second set override those in the first set.
Instance VariablescallbacksThe registered callbacks as mapping from the callable to a tuple of a wrapper for that callable that keeps the callback specific arguments and a boolean that signifies if it is to be called only once. (type: dict )
Method __init__ Undocumented
Method addCallback Add callback.
Method removeCallback Remove callback.
Method callback Call all registered callbacks.
Method isEmpty Return if list of registered callbacks is empty.
def __init__(self): (source)
def addCallback(self, onetime, method, *args, **kwargs): (source)

Add callback.

The arguments passed are used as callback specific arguments.
ParametersonetimeIf True, this callback is called at most once. (type: bool )
methodThe callback callable to be added.
argsPositional arguments to the callable. (type: list )
kwargsKeyword arguments to the callable. (type: dict )
def removeCallback(self, method): (source)
Remove callback.
ParametersmethodThe callable to be removed.
def callback(self, *args, **kwargs): (source)

Call all registered callbacks.

The passed arguments are event specific and augment and override the callback specific arguments as described above.
ParametersargsPositional arguments to the callable. (type: list )
kwargsKeyword arguments to the callable. (type: dict )
NoteExceptions raised by callbacks are trapped and logged. They will not propagate up to make sure other callbacks will still be called, and the event dispatching allways succeeds.
def isEmpty(self): (source)
Return if list of registered callbacks is empty.
Returns (type: bool )
API Documentation for Twisted, generated by pydoctor at 2011-10-27 16:12:41.