Note

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

Module: qt.console.magic_helper

MagicHelper - dockable widget showing magic commands for the MainWindow

1 Class

class IPython.qt.console.magic_helper.MagicHelper(name, parent)

Bases: PyQt4.QtGui.QDockWidget

MagicHelper - dockable widget for convenient search and running of magic command for IPython QtConsole.

__init__(name, parent)

class_selected(index)

Handle search_class selection changes

filter_magic_helper(regex, cls)

Update search_list with magic commands whose text match regex and class match cls. If cls equals ‘any’ - any class matches.

pasteRequested

This signal is emitted when user wants to paste selected magic command into the command line.

paste_requested(item=None)

Emit pasteRequested signal with currently selected item text

populate_magic_helper(data)

Expects data returned by lsmagics query from kernel. Populates the search_class and search_list with relevant items.

readyForUpdate

This signal is emitted when MagicHelper is ready to be populated. Since kernel querying mechanisms are out of scope of this class, it expects its owner to invoke MagicHelper.populate_magic_helper() as a reaction on this event.

runRequested

This signal is emitted when user wants to execute selected magic command

run_requested(item=None)

Emit runRequested signal with currently selected item text

search_changed(search_string)

Handle search_line text changes. The text is interpreted as a regular expression