upstream/ipython Files · IPython/utils/ulinecache.py

Improve API documentation around configuration of embedded IPython (#13989)...

Improve API documentation around configuration of embedded IPython (#13989) This PR tries to improve the API documentation of `embed()`, `embed_kernel()`, `start_ipython()` and `start_kernel()` with respect to the configuration of IPython by adding links to other sections of the documentation. It also reorganizes the API docs so that `embed()` is listed under `IPython`, just as it's presented in the narrative documentation.

Srinivas Reddy Thatiparthy - - Load All Authors

File last commit:

r23700:8e864e7c


                r28197:ad452c1d

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)