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

Merge pull request from JeremySikes73/doc...

Merge pull request from JeremySikes73/doc Add notes to doc section on event loop integration

Paul Ivanov - - Load All Authors

File last commit:

r22960:cf0d4930


                r24030:0920f3a1

Download file

             skipdoctest.py
        
                    19 lines
            
             | 713 B
            
                | text/x-python
            
             |
                PythonLexer
            
             / IPython / testing / skipdoctest.py
          
                    History
                
                 |
                  Source
                 | Raw
                 |Copy content
                 |Copy permalink

        Paul Ivanov
    
remove sys_version for Python 3...

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

        Thomas Kluyver
    
Move skip_doctest decorator to separate module, so that it can be used without triggering other imports.

              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
    
Small cleanups and documentation to testing support code....

              r5529
            
        Paul Ivanov
    
remove sys_version for Python 3...

              r22959
            
      # Copyright (C) IPython Development Team

      # Distributed under the terms of the Modified BSD License.

        Fernando Perez
    
Small cleanups and documentation to testing support code....

              r5529
            
        Thomas Kluyver
    
Move skip_doctest decorator to separate module, so that it can be used without triggering other imports.

              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

	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

Paul Ivanov remove sys_version for Python 3...	r22959	"""Decorators marks that a doctest should be skipped.
Thomas Kluyver Move skip_doctest decorator to separate module, so that it can be used without triggering other imports.	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 Small cleanups and documentation to testing support code....	r5529
Paul Ivanov remove sys_version for Python 3...	r22959	# Copyright (C) IPython Development Team
		# Distributed under the terms of the Modified BSD License.
Fernando Perez Small cleanups and documentation to testing support code....	r5529

Thomas Kluyver Move skip_doctest decorator to separate module, so that it can be used without triggering other imports.	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