upstream/ipython Files · IPython/testing/skipdoctest.py

Fix another small bug in stripping kernel args...

Fix another small bug in stripping kernel args Problem case: flags and aliases with the same name (e.g. existing) would attempt removal twice, raising ValueError

Thomas Kluyver - - Load All Authors

File last commit:

r3886:dd8c6b4f


                r5143:cfc7e4a8

Download file

             skipdoctest.py
        
                    15 lines
            
             | 615 B
            
                | text/x-python
            
             |
                PythonLexer
            
             / IPython / testing / skipdoctest.py
          
                    History
                
                 |
                  Annotation
                 | Raw
                 |Copy content
                 |Copy permalink

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

      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

	Site-wide shortcuts
/	Use quick search box
g h	Goto home page
g g	Goto my private gists page
g G	Goto my public gists page
g 0-9	Goto bookmarked items from 0-9
n r	New repository page
n g	New gist page

	Repositories
g s	Goto summary page
g c	Goto changelog page
g f	Goto files page
g F	Goto files page with file search activated
g p	Goto pull requests page
g o	Goto repository settings
g O	Goto repository access permissions settings
t s	Toggle sidebar on some pages

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

				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