upstream/ipython Files · IPython/utils/generics.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>

MinRK - - Load All Authors

File last commit:

r20816:fc7d8a36


                r23138:fb70b991

Download file

             generics.py
        
                    34 lines
            
             | 740 B
            
                | text/x-python
            
             |
                PythonLexer
            
             / IPython / utils / generics.py
          
                    History
                
                 |
                  Annotation
                 | Raw
                 |Copy content
                 |Copy permalink

      # encoding: utf-8

      """Generic functions for extending IPython.

      See http://pypi.python.org/pypi/simplegeneric.

      """

      from IPython.core.error import TryNext

      from simplegeneric import generic

      @generic

      def inspect_object(obj):

          """Called when you do obj?"""

          raise TryNext

      @generic

      def complete_object(obj, prev_completions):

          """Custom completer dispatching for python objects.

          Parameters

          ----------

          obj : object

              The object to complete.

          prev_completions : list

              List of attributes discovered so far.

          This should return the list of attributes in obj. If you only wish to

          add to the attributes already discovered normally, return

          own_attrs + prev_completions.

          """

          raise TryNext

	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

				# encoding: utf-8
				"""Generic functions for extending IPython.

				See http://pypi.python.org/pypi/simplegeneric.
				"""

				from IPython.core.error import TryNext
				from simplegeneric import generic


				@generic
				def inspect_object(obj):
				"""Called when you do obj?"""
				raise TryNext


				@generic
				def complete_object(obj, prev_completions):
				"""Custom completer dispatching for python objects.

				Parameters
				----------
				obj : object
				The object to complete.
				prev_completions : list
				List of attributes discovered so far.

				This should return the list of attributes in obj. If you only wish to
				add to the attributes already discovered normally, return
				own_attrs + prev_completions.
				"""
				raise TryNext