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

added new use_shortcut method to shortcuts...

added new use_shortcut method to shortcuts this way, you can ask if a particular event will be handled by the shortcuts system. This takes away the need to special-case many different possible keys which should be ignored by codemirror by ignoring them en masse.

Fernando Perez - - Load All Authors

File last commit:

r5529:a1b74bc4


                r15758:1ebe52ee

Download file

             skipdoctest.py
        
                    38 lines
            
             | 1.4 KiB
            
                | text/x-python
            
             |
                PythonLexer
            
             / IPython / testing / skipdoctest.py
          
                    History
                
                 |
                  Source
                 | Raw
                 |Copy content
                 |Copy permalink

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

              r5529
            
      """Decorators marks that a doctest should be skipped, for both python 2 and 3.

        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
            
      #-----------------------------------------------------------------------------

      #  Copyright (C) 2009-2011  The IPython Development Team

      #

      #  Distributed under the terms of the BSD License.  The full license is in

      #  the file COPYING, distributed as part of this software.

      #-----------------------------------------------------------------------------

      #-----------------------------------------------------------------------------

      # Imports

      #-----------------------------------------------------------------------------

        Thomas Kluyver
    
Add decorators to mark known failures on Python 3.

              r5204
            
      import sys

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

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

              r5529
            
      #-----------------------------------------------------------------------------

      # Decorators

      #-----------------------------------------------------------------------------

        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

        Thomas Kluyver
    
Add decorators to mark known failures on Python 3.

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

              r5529
            
        Thomas Kluyver
    
Add decorators to mark known failures on Python 3.

              r5204
            
      def skip_doctest_py3(f):

          """Decorator - skip the doctest under Python 3."""

          f.skip_doctest = (sys.version_info[0] >= 3)

          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

Fernando Perez Small cleanups and documentation to testing support code....	r5529	"""Decorators marks that a doctest should be skipped, for both python 2 and 3.
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
		#-----------------------------------------------------------------------------
		# Copyright (C) 2009-2011 The IPython Development Team
		#
		# Distributed under the terms of the BSD License. The full license is in
		# the file COPYING, distributed as part of this software.
		#-----------------------------------------------------------------------------

		#-----------------------------------------------------------------------------
		# Imports
		#-----------------------------------------------------------------------------

Thomas Kluyver Add decorators to mark known failures on Python 3.	r5204	import sys
Thomas Kluyver Move skip_doctest decorator to separate module, so that it can be used without triggering other imports.	r3886
Fernando Perez Small cleanups and documentation to testing support code....	r5529	#-----------------------------------------------------------------------------
		# Decorators
		#-----------------------------------------------------------------------------

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
Thomas Kluyver Add decorators to mark known failures on Python 3.	r5204
Fernando Perez Small cleanups and documentation to testing support code....	r5529
Thomas Kluyver Add decorators to mark known failures on Python 3.	r5204	def skip_doctest_py3(f):
		"""Decorator - skip the doctest under Python 3."""
		f.skip_doctest = (sys.version_info[0] >= 3)
		return f