Warning

This documentation covers a development version of IPython. The development version may differ significantly from the latest stable release.

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).

Execution semantics in the IPython kernel

The execution of user code consists of the following phases:

  1. Fire the pre_execute event.
  2. Fire the pre_run_cell event unless silent is True.
  3. Execute the code field, see below for details.
  4. If execution succeeds, expressions in user_expressions are computed. This ensures that any error in the expressions don’t affect the main code execution.
  5. Fire the post_execute event.
  6. Fire the post_run_cell event unless silent is True.

See also

IPython Events

To understand how the code field is executed, one must know that Python code can be compiled in one of three modes (controlled by the mode argument to the compile() builtin):

single

Valid for a single interactive statement (though the source can contain multiple lines, such as a for loop). When compiled in this mode, the generated bytecode contains special instructions that trigger the calling of sys.displayhook() for any expression in the block that returns a value. This means that a single statement can actually produce multiple calls to sys.displayhook(), if for example it contains a loop where each iteration computes an unassigned expression would generate 10 calls:

for i in range(10):
    i**2
exec
An arbitrary amount of source code, this is how modules are compiled. sys.displayhook() is never implicitly called.
eval
A single expression that returns a value. sys.displayhook() is never implicitly called.

The code field is split into individual blocks each of which is valid for execution in ‘single’ mode, and then:

  • If there is only a single block: it is executed in ‘single’ mode.
  • If there is more than one block:
    • if the last one is a single line long, run all but the last in ‘exec’ mode and the very last one in ‘single’ mode. This makes it easy to type simple expressions at the end to see computed values.
    • if the last one is no more than two lines long, run all but the last in ‘exec’ mode and the very last one in ‘single’ mode. This makes it easy to type simple expressions at the end to see computed values. - otherwise (last one is also multiline), run all in ‘exec’ mode
    • otherwise (last one is also multiline), run all in ‘exec’ mode as a single unit.