IPython Documentation

Table Of Contents

Previous topic

Module: terminal.console.completer

Next topic

Module: terminal.embed

This Page


This documentation is for an old version of IPython. You can find docs for newer versions here.

Module: terminal.console.interactiveshell

terminal client to the IPython kernel

1 Class

class IPython.terminal.console.interactiveshell.ZMQTerminalInteractiveShell(config=None, ipython_dir=None, profile_dir=None, user_ns=None, user_module=None, custom_exceptions=((), None), usage=None, banner1=None, banner2=None, display_banner=None, **kwargs)

Bases: IPython.terminal.interactiveshell.TerminalInteractiveShell

A subclass of TerminalInteractiveShell that uses the 0MQ kernel


Method to process subscribe channel’s messages

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

It only displays output that is caused by the given msg_id

handle_stdin_request(msg_id, timeout=0.1)

Method to capture raw_input


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), programatically (such as in test suites) or out-of-prcess (typically over the network by remote frontends).


Closely emulate the interactive Python console.

run_cell(cell, store_history=True)

Run a complete IPython cell.


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.


method to wait for a kernel to be ready