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

Backport PR : safe_run_module: Silence SystemExit codes 0 and None....

Backport PR : safe_run_module: Silence SystemExit codes 0 and None. In `safe_execfile` we ignore SystemExit exceptions with codes 0 and 1. We don't do this for `safe_run_module` which leads to the following mismatch of tracebacks between Python and IPython: ``` $ cat > exit0.py import sys sys.exit(0) $ python -m exit0 $ ipython -m exit0 --------------------------------------------------------------------------- SystemExit Traceback (most recent call last) /usr/lib/python2.7/runpy.pyc in run_module(mod_name, init_globals, run_name, alter_sys) 174 if alter_sys: 175 return _run_module_code(code, init_globals, run_name, --> 176 fname, loader, pkg_name) 177 else: 178 # Leave the sys module alone /usr/lib/python2.7/runpy.pyc in _run_module_code(code, init_globals, mod_name, mod_fname, mod_loader, pkg_name) 80 mod_globals = temp_module.module.__dict__ 81 _run_code(code, mod_globals, init_globals, ---> 82 mod_name, mod_fname, mod_loader, pkg_name) 83 # Copy the globals of the temporary module, as they 84 # may be cleared when the temporary module goes away /usr/lib/python2.7/runpy.pyc in _run_code(code, run_globals, init_globals, mod_name, mod_fname, mod_loader, pkg_name) 70 __loader__ = mod_loader, 71 __package__ = pkg_name) ---> 72 exec code in run_globals 73 return run_globals 74 /tmp/exit0.py in <module>() 1 import sys ----> 2 sys.exit(0) SystemExit: 0 WARNING: Unknown failure executing module: <exit0> ``` The attached pull request silences SystemExit exceptions with codes 0 and None.

Fernando Perez - - Load All Authors

File last commit:

r5529:a1b74bc4


                r9972:8ab632a4

Download file

             skipdoctest.py
        
                    38 lines
            
             | 1.4 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

	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