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

Allow to dispatch getting documentation on objects. (#13975)...

Allow to dispatch getting documentation on objects. (#13975) Base for , so that object can be queried for documentation on their fields/properties. Typically this allows the following, to extend the doc documentation when requesting information on a field. ```python class DictLike: def __getitem__(self, k): if k.startswith('f'): return "documentation for k" else: raise KeyError class Bar: __custom_documentations__ = DictLike() faz = 1 @property def foo(self): return 1 b = Bar() b.faz? ```

Srinivas Reddy Thatiparthy - - Load All Authors

File last commit:

r23700:8e864e7c


                r28201:d52bf622

Download file

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

        Srinivas Reddy Thatiparthy
    
remove python2 code

              r23109
            
      """

        Srinivas Reddy Thatiparthy
    
Add deprecation warnings and message to getlines function

              r23118
            
      This module has been deprecated since IPython 6.0.

        Srinivas Reddy Thatiparthy
    
remove python2 code

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

        Thomas Kluyver
    
Fix getting unicode lines in IPython.core.debugger.

              r8324
            
      """

      import functools

      import linecache

        Srinivas Reddy Thatiparthy
    
Add deprecation warnings and message to getlines function

              r23118
            
      from warnings import warn

        Thomas Kluyver
    
Fix getting unicode lines in IPython.core.debugger.

              r8324
            
        Srinivas Reddy Thatiparthy
    
remove python2 code

              r23109
            
      getline = linecache.getline

        Thomas Kluyver
    
Fix getting unicode lines in IPython.core.debugger.

              r8324
            
        Srinivas Reddy Thatiparthy
    
remove python2 code

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

      @functools.wraps(linecache.getlines)

      def getlines(filename, module_globals=None):

        Srinivas Reddy Thatiparthy
    
Add deprecation warnings and message to getlines function

              r23118
            
          """

          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)

        Srinivas Reddy Thatiparthy
    
remove python2 code

              r23109
            
          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

Srinivas Reddy Thatiparthy remove python2 code	r23109	"""
Srinivas Reddy Thatiparthy Add deprecation warnings and message to getlines function	r23118	This module has been deprecated since IPython 6.0.

Srinivas Reddy Thatiparthy remove python2 code	r23109	Wrapper around linecache which decodes files to unicode according to PEP 263.
Thomas Kluyver Fix getting unicode lines in IPython.core.debugger.	r8324	"""
		import functools
		import linecache
Srinivas Reddy Thatiparthy Add deprecation warnings and message to getlines function	r23118	from warnings import warn
Thomas Kluyver Fix getting unicode lines in IPython.core.debugger.	r8324
Srinivas Reddy Thatiparthy remove python2 code	r23109	getline = linecache.getline
Thomas Kluyver Fix getting unicode lines in IPython.core.debugger.	r8324
Srinivas Reddy Thatiparthy remove python2 code	r23109	# getlines has to be looked up at runtime, because doctests monkeypatch it.
		@functools.wraps(linecache.getlines)
		def getlines(filename, module_globals=None):
Srinivas Reddy Thatiparthy Add deprecation warnings and message to getlines function	r23118	"""
		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)
Srinivas Reddy Thatiparthy remove python2 code	r23109	return linecache.getlines(filename, module_globals=module_globals)