Module:utils.decorators

Decorators that don’t go anywhere else.

This module contains misc. decorators that don’t really go with another moduleinIPython.utils. Before putting something here please see if it shouldgo into another topical module inIPython.utils.

3 Functions

IPython.utils.decorators.flag_calls(func)

Wrap a function to detect and flag when it gets called.

This is a decorator which takes a function and wraps it in a function witha ‘called’ attribute. wrapper.called is initialized to False.

The wrapper.called attribute is set to False right before each call to thewrapped function, so if the call fails it remains False. After the callcompletes, wrapper.called is set to True and the output is returned.

Testing for truth in wrapper.called allows you to determine if a call tofunc() was attempted and succeeded.

IPython.utils.decorators.undoc(func)

Mark a function or class as undocumented.

This is found by inspecting the AST, so for now it must be used directlyas @undoc, not as e.g. @decorators.undoc

IPython.utils.decorators.sphinx_options(show_inheritance:bool=True,show_inherited_members:bool=False,exclude_inherited_from:Sequence[str]=())

Set sphinx options