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: testing.skipdoctest

Decorators marks that a doctest should be skipped.

The IPython.testing.decorators module triggers various extra imports, including numpy and sympy if they’re present. Since this decorator is used in core parts of IPython, it’s in a separate module so that running IPython doesn’t trigger those imports.

1 Function

IPython.testing.skipdoctest.skip_doctest(f)

Decorator - mark a function or method for skipping its doctest.

This decorator allows you to mark a function whose docstring you wish to omit from testing, while preserving the docstring for introspection, help, etc.