events.EventManager Class Reference

Infrastructure for registering and firing callbacks on application events. More...

Public Member Functions
def	__init__ (self, kernel, available_events)
	Initialise the :class:CallbackManager. More...
def	register (self, event, function)
	Register a new event callback. More...
def	unregister (self, event, function)
	Remove a callback from the given event. More...
def	trigger (self, event, args, kwargs)
	Call callbacks for event. More...

Public Attributes
	kernel
	callbacks

Detailed Description

Infrastructure for registering and firing callbacks on application events.

Unlike :mod:IPython.core.hooks, which lets end users set single functions to be called at specific times, or a collection of alternative methods to try, callbacks are designed to be used by extension authors. A number of callbacks can be registered for the same event without needing to be aware of one another.

The functions defined in this module are no-ops indicating the names of available events and the arguments which will be passed to them.Manage a collection of events and a sequence of callbacks for each.

This is attached to :class:`~IPython.core.interactiveshell.InteractiveShell`
instances as an ``events`` attribute.

.. note::

   This API is experimental in IPython 2.0, and may be revised in future versions.

Constructor & Destructor Documentation

__init__()

def events.EventManager.__init__	(		self,
			kernel,
			available_events
	)

Initialise the :class:CallbackManager.

Parameters

shell available_callbacks An iterable of names for callback events.

Member Function Documentation

register()

def events.EventManager.register	(		self,
			event,
			function
	)

Register a new event callback.

Parameters

event str The event for which to register this callback. function callable A function to be called on the given event. It should take the same parameters as the appropriate callback prototype.

Raises

TypeError If function is not callable. KeyError If event is not one of the known events.

trigger()

def events.EventManager.trigger	(		self,
			event,
			args,
			kwargs
	)

Call callbacks for event.

Any additional arguments are passed to all callbacks registered for this event. Exceptions raised by callbacks are caught, and a message printed.

unregister()

def events.EventManager.unregister	(		self,
			event,
			function
	)

Remove a callback from the given event.

---

The documentation for this class was generated from the following file:

• logic/jupyterkernel/events.py