Important

This documentation covers IPython versions 6.0 and higher. Beginning with version 6.0, IPython stopped supporting compatibility with Python versions lower than 3.3 including all versions of Python 2.7.

If you are looking for an IPython version compatible with Python 2.7, please use the IPython 5.x LTS release and refer to its documentation (LTS is the long term support release).

Module: terminal.prompts

Terminal input and output prompts.

3 Classes

class IPython.terminal.prompts.Prompts(shell)

Bases: object

__init__(shell)

Initialize self. See help(type(self)) for accurate signature.

class IPython.terminal.prompts.ClassicPrompts(shell)

Bases: IPython.terminal.prompts.Prompts

class IPython.terminal.prompts.RichPromptDisplayHook(shell=None, cache_size=1000, **kwargs)

Bases: IPython.core.displayhook.DisplayHook

Subclass of base display hook using coloured prompt

write_format_data(format_dict, md_dict=None) → None

Write the format data dict to the frontend.

This default version of this method simply writes the plain text representation of the object to sys.stdout. Subclasses should override this method to send the entire format_dict to the frontends.

Parameters
  • format_dict (dict) – The format dict for the object passed to sys.displayhook.

  • md_dict (dict (optional)) – The metadata dict to be associated with the display data.

write_output_prompt()

Write the output prompt.

The default implementation simply writes the prompt to sys.stdout.