Coverage for /pythoncovmergedfiles/medio/medio/usr/local/lib/python3.8/site-packages/IPython/testing/skipdoctest.py: 100%

3 statements  

« prev     ^ index     » next       coverage.py v7.4.4, created at 2024-04-20 06:09 +0000

1"""Decorators marks that a doctest should be skipped. 

2 

3The IPython.testing.decorators module triggers various extra imports, including 

4numpy and sympy if they're present. Since this decorator is used in core parts 

5of IPython, it's in a separate module so that running IPython doesn't trigger 

6those imports.""" 

7 

8# Copyright (C) IPython Development Team 

9# Distributed under the terms of the Modified BSD License. 

10 

11 

12def skip_doctest(f): 

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

14 

15 This decorator allows you to mark a function whose docstring you wish to 

16 omit from testing, while preserving the docstring for introspection, help, 

17 etc.""" 

18 f.__skip_doctest__ = True 

19 return f