##// END OF EJS Templates
Allow to dispatch getting documentation on objects. (#13975)...
Allow to dispatch getting documentation on objects. (#13975) Base for #13860, 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? ```

File last commit:

r23700:8e864e7c
r28201:d52bf622 merge
Show More
ulinecache.py
21 lines | 684 B | text/x-python | PythonLexer
"""
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)