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

Backport PR : Let IPython.lib.guisupport detect terminal-integrated event loops...

Backport PR : Let IPython.lib.guisupport detect terminal-integrated event loops Closes gh-9974 This is a bit more invasive than most backported changes, but it fixes a regression in IPython 5. My thinking: - The `guisupport` APIs that worked before should continue working until/unless we deprecate them. - There should be a common way to check if an event loop is already running in both the terminal and an IPython kernel. - It should be possible to check for any event loop, not just Qt and Wx (which `guisupport` has checks for). My plan is to make a public attribute `shell.active_eventloop`, which is either None or a string naming the event loop which IPython will run when waiting for input. E.g. `qt` or `gtk3`. (Todo: should we also expose the event loop object in cases where there is one? Not sure if anything useful can be done with it). This PR adds that attribute for terminal IPython; if we agree on it I'll make a separate PR for ipykernel. The functions in guisupport then become a convenient shortcut for checking this, and we can decide whether to deprecate them in favour or something more uniform, or add similar convenience functions for other common event loops. Signed-off-by: Thomas Kluyver <thomas@kluyver.me.uk>

Matthias Bussonnier - - Load All Authors

File last commit:

r22245:c1b83029


                r23138:fb70b991

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