upstream/ipython Files · IPython/frontend.py

Change return type in docstring to literal tuple to avoid bogus cross-ref....

Change return type in docstring to literal tuple to avoid bogus cross-ref. Before this change the Sphinx tried to produce cross-reference links for the returned (stdout, stderr) tuple. The docs build produced a warning because there are 2 possible cross-ref objects for `stdout`, one in `IPython.testing.iptestcontroller.TestController`, the other in `IPython.utils.capture.CapturedIO`. Neither of those is correct in the context of the `ipexec()` function. Changing literal ``(stdout, stderr)`` avoids the warning by preventing the attempt to produce cross-references.

Matthias Bussonnier - - Load All Authors

File last commit:

r23398:f33ca742


                r24067:fcbe9bad

Download file

             frontend.py
        
                    29 lines
            
             | 1.1 KiB
            
                | text/x-python
            
             |
                PythonLexer
            
             / IPython / frontend.py
          
                    History
                
                 |
                  Annotation
                 | Raw
                 |Copy content
                 |Copy permalink

      """

      Shim to maintain backwards compatibility with old frontend imports.

      We have moved all contents of the old `frontend` subpackage into top-level

      subpackages (`html`, `qt` and `terminal`), and flattened the notebook into

      just `IPython.html`, formerly `IPython.frontend.html.notebook`.

      This will let code that was making `from IPython.frontend...` calls continue

      working, though a warning will be printed.

      """

      # Copyright (c) IPython Development Team.

      # Distributed under the terms of the Modified BSD License.

      import sys

      from warnings import warn

      from IPython.utils.shimmodule import ShimModule, ShimWarning

      warn("The top-level `frontend` package has been deprecated since IPython 1.0. "

           "All its subpackages have been moved to the top `IPython` level.", ShimWarning)

      # Unconditionally insert the shim into sys.modules so that further import calls

      # trigger the custom attribute access above

      sys.modules['IPython.frontend.html.notebook'] = ShimModule(

          src='IPython.frontend.html.notebook', mirror='IPython.html')

      sys.modules['IPython.frontend'] = ShimModule(

          src='IPython.frontend', mirror='IPython')

	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

				"""
				Shim to maintain backwards compatibility with old frontend imports.

				We have moved all contents of the old `frontend` subpackage into top-level
				subpackages (`html`, `qt` and `terminal`), and flattened the notebook into
				just `IPython.html`, formerly `IPython.frontend.html.notebook`.

				This will let code that was making `from IPython.frontend...` calls continue
				working, though a warning will be printed.
				"""

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

				import sys
				from warnings import warn

				from IPython.utils.shimmodule import ShimModule, ShimWarning

				warn("The top-level `frontend` package has been deprecated since IPython 1.0. "
				"All its subpackages have been moved to the top `IPython` level.", ShimWarning)

				# Unconditionally insert the shim into sys.modules so that further import calls
				# trigger the custom attribute access above

				sys.modules['IPython.frontend.html.notebook'] = ShimModule(
				src='IPython.frontend.html.notebook', mirror='IPython.html')
				sys.modules['IPython.frontend'] = ShimModule(
				src='IPython.frontend', mirror='IPython')