skipdoctest.py
19 lines
| 713 B
| text/x-python
|
PythonLexer
Paul Ivanov
|
r22959 | """Decorators marks that a doctest should be skipped. | ||
Thomas Kluyver
|
r3886 | |||
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.""" | ||||
Fernando Perez
|
r5529 | |||
Paul Ivanov
|
r22959 | # Copyright (C) IPython Development Team | ||
# Distributed under the terms of the Modified BSD License. | ||||
Fernando Perez
|
r5529 | |||
Thomas Kluyver
|
r3886 | 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 | ||||