##// 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:

r21078:2098e1d4
r28201:d52bf622 merge
Show More
sentinel.py
17 lines | 421 B | text/x-python | PythonLexer
"""Sentinel class for constants with useful reprs"""
# Copyright (c) IPython Development Team.
# Distributed under the terms of the Modified BSD License.
class Sentinel(object):
def __init__(self, name, module, docstring=None):
self.name = name
self.module = module
if docstring:
self.__doc__ = docstring
def __repr__(self):
return str(self.module)+'.'+self.name