Note

This documentation is for a development version of IPython. There may be significant differences from the latest stable release.

Module: kernel.zmq.eventloops

Event loop integration for the ZeroMQ-based kernels.

9 Functions

IPython.kernel.zmq.eventloops.register_integration(*toolkitnames)

Decorator to register an event loop to integrate with the IPython kernel

The decorator takes names to register the event loop as for the %gui magic. You can provide alternative names for the same toolkit.

The decorated function should take a single argument, the IPython kernel instance, arrange for the event loop to call kernel.do_one_iteration() at least every kernel._poll_interval seconds, and start the event loop.

IPython.kernel.zmq.eventloops provides and registers such functions for a few common event loops.

IPython.kernel.zmq.eventloops.loop_qt4(kernel)

Start a kernel with PyQt4 event loop integration.

IPython.kernel.zmq.eventloops.loop_qt5(kernel)

Start a kernel with PyQt5 event loop integration.

IPython.kernel.zmq.eventloops.loop_wx(kernel)

Start a kernel with wx event loop support.

IPython.kernel.zmq.eventloops.loop_tk(kernel)

Start a kernel with the Tk event loop.

IPython.kernel.zmq.eventloops.loop_gtk(kernel)

Start the kernel, coordinating with the GTK event loop

IPython.kernel.zmq.eventloops.loop_gtk3(kernel)

Start the kernel, coordinating with the GTK event loop

IPython.kernel.zmq.eventloops.loop_cocoa(kernel)

Start the kernel, coordinating with the Cocoa CFRunLoop event loop via the matplotlib MacOSX backend.

IPython.kernel.zmq.eventloops.enable_gui(gui, kernel=None)

Enable integration with a given GUI