upstream/ipython Files · IPython/sphinxext/ipython_console_highlighting.py

Improve async detection mechanism with blacklist...

Improve async detection mechanism with blacklist Because the async repl works by wrapping any code that raises SyntaxError in an async function and trying to execute it again, cell bodies that are invalid at the top level but valid in functions and methods (e.g. return and yield statements) currently allow executing invalid code. This patch blacklists return and yield statements outside of a function or method to restore the proper SyntaxError behavior.

Michael Droettboom - - Load All Authors

File last commit:

r21874:3ffdf6f9


                r24485:c4bf6326

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