ipython/IPython/testing/skipdoctest.py at python-3.14-dev · krassowski/ipython · GitHub

Repository navigation

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

# Copyright (C) IPython Development Team

# Distributed under the terms of the Modified BSD License.

def 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."""

f.__skip_doctest__ = True

return f