upstream/ipython Files · IPython/sphinxext/ipython_console_highlighting.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>

Michael Droettboom - - Load All Authors

File last commit:

r21874:3ffdf6f9


                r23138:fb70b991

Download file

             ipython_console_highlighting.py
        
                    28 lines
            
             | 970 B
            
                | text/x-python
            
             |
                PythonLexer
            
             / IPython / sphinxext / ipython_console_highlighting.py
          
                    History
                
                 |
                  Annotation
                 | Raw
                 |Copy content
                 |Copy permalink

      """

      reST directive for syntax-highlighting ipython interactive sessions.

      """

      from sphinx import highlighting

      from IPython.lib.lexers import IPyLexer

      def setup(app):

          """Setup as a sphinx extension."""

          # This is only a lexer, so adding it below to pygments appears sufficient.

          # But if somebody knows what the right API usage should be to do that via

          # sphinx, by all means fix it here.  At least having this setup.py

          # suppresses the sphinx warning we'd get without it.

          metadata = {'parallel_read_safe': True, 'parallel_write_safe': True}

          return metadata

      # Register the extension as a valid pygments lexer.

      # Alternatively, we could register the lexer with pygments instead. This would

      # require using setuptools entrypoints: http://pygments.org/docs/plugins

      ipy2 = IPyLexer(python3=False)

      ipy3 = IPyLexer(python3=True)

      highlighting.lexers['ipython'] = ipy2

      highlighting.lexers['ipython2'] = ipy2

      highlighting.lexers['ipython3'] = ipy3

	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

				"""
				reST directive for syntax-highlighting ipython interactive sessions.

				"""

				from sphinx import highlighting
				from IPython.lib.lexers import IPyLexer

				def setup(app):
				"""Setup as a sphinx extension."""

				# This is only a lexer, so adding it below to pygments appears sufficient.
				# But if somebody knows what the right API usage should be to do that via
				# sphinx, by all means fix it here. At least having this setup.py
				# suppresses the sphinx warning we'd get without it.
				metadata = {'parallel_read_safe': True, 'parallel_write_safe': True}
				return metadata

				# Register the extension as a valid pygments lexer.
				# Alternatively, we could register the lexer with pygments instead. This would
				# require using setuptools entrypoints: http://pygments.org/docs/plugins

				ipy2 = IPyLexer(python3=False)
				ipy3 = IPyLexer(python3=True)

				highlighting.lexers['ipython'] = ipy2
				highlighting.lexers['ipython2'] = ipy2
				highlighting.lexers['ipython3'] = ipy3