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

Srinivas Reddy Thatiparthy - - Load All Authors

File last commit:

r23700:8e864e7c


                r24067:fcbe9bad

Download file

             ulinecache.py
        
                    21 lines
            
             | 684 B
            
                | text/x-python
            
             |
                PythonLexer
            
             / IPython / utils / ulinecache.py
          
                    History
                
                 |
                  Annotation
                 | Raw
                 |Copy content
                 |Copy permalink

      """

      This module has been deprecated since IPython 6.0.

      Wrapper around linecache which decodes files to unicode according to PEP 263.

      """

      import functools

      import linecache

      from warnings import warn

      getline = linecache.getline

      # getlines has to be looked up at runtime, because doctests monkeypatch it.

      @functools.wraps(linecache.getlines)

      def getlines(filename, module_globals=None):

          """

          Deprecated since IPython 6.0

          """

          warn(("`IPython.utils.ulinecache.getlines` is deprecated since"

                " IPython 6.0 and will be removed in future versions."),

               DeprecationWarning, stacklevel=2)

          return linecache.getlines(filename, module_globals=module_globals)

	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

				"""
				This module has been deprecated since IPython 6.0.

				Wrapper around linecache which decodes files to unicode according to PEP 263.
				"""
				import functools
				import linecache
				from warnings import warn

				getline = linecache.getline

				# getlines has to be looked up at runtime, because doctests monkeypatch it.
				@functools.wraps(linecache.getlines)
				def getlines(filename, module_globals=None):
				"""
				Deprecated since IPython 6.0
				"""
				warn(("`IPython.utils.ulinecache.getlines` is deprecated since"
				" IPython 6.0 and will be removed in future versions."),
				DeprecationWarning, stacklevel=2)
				return linecache.getlines(filename, module_globals=module_globals)