##// END OF EJS Templates
Allow to dispatch getting documentation on objects...
Allow to dispatch getting documentation on objects 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. In [1]: 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() In [2]: b.faz?

File last commit:

r24459:d697c122
r28195:fc872d6c
Show More
signatures.py
12 lines | 474 B | text/x-python | PythonLexer
"""DEPRECATED: Function signature objects for callables.
Use the standard library version if available, as it is more up to date.
Fallback on backport otherwise.
"""
import warnings
warnings.warn("{} backport for Python 2 is deprecated in IPython 6, which only supports "
"Python 3. Import directly from standard library `inspect`".format(__name__),
DeprecationWarning, stacklevel=2)
from inspect import BoundArguments, Parameter, Signature, signature