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

Fix many py2-style prints in docs and commented code. (#14432)...

Fix many py2-style prints in docs and commented code. (#14432) The main interest was to transform py2-style print statements that still appeared in some docstrings (e.g. for %history) and would thus show up when looking at the docs either interactively or in the rendered website. I also fixed a number of commented-out print statements at the same time, mostly because it was easier for me to just regexp-change all of them so that I could focus on the others.

Nikita Kniazev - - Load All Authors

File last commit:

r26873:17153999


                r28760:1066e43a

Download file

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

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

      # Copyright (C) IPython Development Team

      # Distributed under the terms of the Modified BSD License.

      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

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

				# Copyright (C) IPython Development Team
				# Distributed under the terms of the Modified BSD License.


				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