IPython Documentation

Table Of Contents

Previous topic

Module: terminal.console.completer

Next topic

Module: terminal.embed

This Page

Note

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

Module: terminal.console.interactiveshell

terminal client to the IPython kernel

1 Class

class IPython.terminal.console.interactiveshell.ZMQTerminalInteractiveShell(ipython_dir=None, profile_dir=None, user_module=None, user_ns=None, custom_exceptions=((), None), **kwargs)

Bases: IPython.terminal.interactiveshell.TerminalInteractiveShell

A subclass of TerminalInteractiveShell that uses the 0MQ kernel

from_here(msg)

Return whether a message is from this session

handle_input_request(msg_id, timeout=0.1)

Method to capture raw_input

handle_iopub(msg_id='')

Process messages on the IOPub channel

This method consumes and processes messages on the IOPub channel, such as stdout, stderr, execute_result and status.

It only displays output that is caused by this session.

include_output(msg)

Return whether we should include a given output message

init_completer()

Initialize the completion machinery.

This creates completion machinery that can be used by client code, either interactively in-process (typically triggered by the readline library), programmatically (such as in test suites) or out-of-process (typically over the network by remote frontends).

interact(display_banner=None)

Closely emulate the interactive Python console.

run_cell(cell, store_history=True)

Run a complete IPython cell.

Parameters:

cell : str

The code (including IPython code such as %magic functions) to run.

store_history : bool

If True, the raw and translated cell will be stored in IPython’s history. For user code calling back into IPython’s machinery, this should be set to False.

wait_for_kernel(timeout=None)

method to wait for a kernel to be ready