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: utils.decorators

Decorators that don’t go anywhere else.

This module contains misc. decorators that don’t really go with another module in IPython.utils. Before putting something here please see if it should go into another topical module in IPython.utils.

3 Functions


Wrap a function to detect and flag when it gets called.

This is a decorator which takes a function and wraps it in a function with a ‘called’ attribute. wrapper.called is initialized to False.

The wrapper.called attribute is set to False right before each call to the wrapped function, so if the call fails it remains False. After the call completes, wrapper.called is set to True and the output is returned.

Testing for truth in wrapper.called allows you to determine if a call to func() was attempted and succeeded.


Mark a function or class as undocumented.

This is found by inspecting the AST, so for now it must be used directly as @undoc, not as e.g. @decorators.undoc

IPython.utils.decorators.sphinx_options(show_inheritance: bool = True, show_inherited_members: bool = False, exclude_inherited_from: Sequence[str] = ())

Set sphinx options