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

Remove the "autoedit_syntax" feature....

Remove the "autoedit_syntax" feature. IPython used to (a long time ago, in a galaxy far far away) have the ability to automatically open an editor in case a wild syntax error appears. The configuration option to enable that was not working for a few years, and apparently we by mistake re enabled it, to discover that the feature is actually broken. So this plainly remove the code to support this feature, at the exception of the `fix_error_editor` hook. Indeed it is public API, so for now as it seem to be used only for this feature, we'll just raise a UserWarning (there is roughly 0 chance of this being tested as it's used mostly interactively, so DeprecationWarnings would be unseen). We'll remove later if no complaints Closes

Matthias Bussonnier - - Load All Authors

File last commit:

r22245:c1b83029


                r22576:b7d03ed6

Download file

             skipdoctest.py
        
                    43 lines
            
             | 1.6 KiB
            
                | text/x-python
            
             |
                PythonLexer
            
             / IPython / testing / skipdoctest.py
          
                    History
                
                 |
                  Annotation
                 | Raw
                 |Copy content
                 |Copy permalink

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

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

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

      #  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

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

      import sys

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

      # Decorators

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

      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

      def skip_doctest_py3(f):

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

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

          return f

      def skip_doctest_py2(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

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

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

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

				import sys

				#-----------------------------------------------------------------------------
				# Decorators
				#-----------------------------------------------------------------------------

				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


				def skip_doctest_py3(f):
				"""Decorator - skip the doctest under Python 3."""
				f.skip_doctest = (sys.version_info[0] >= 3)
				return f

				def skip_doctest_py2(f):
				"""Decorator - skip the doctest under Python 3."""
				f.skip_doctest = (sys.version_info[0] < 3)
				return f