Warning

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

Module: testing.skipdoctest

Decorators marks that a doctest should be skipped, for both python 2 and 3.

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.

2 Functions

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.

IPython.testing.skipdoctest.skip_doctest_py3(f)

Decorator - skip the doctest under Python 3.