astroid.decorators

module documentation
(source)

A few useful function/method decorators.

Class cachedproperty Provides a cached property equivalent to the stacking of @cached and @property, but more efficient.
Function cached Simple decorator to cache result of method calls without args.
Function deprecate_arguments Decorator which emits a DeprecationWarning if any arguments specified are passed.
Function deprecate_default_argument_values Decorator which emits a DeprecationWarning if any arguments specified are None or not passed at all.
Function path_wrapper Return the given infer function wrapped to handle the path.
Function raise_if_nothing_inferred Undocumented
Function yes_if_nothing_inferred Undocumented
Constant _P Undocumented
Type Variable _R Undocumented
@wrapt.decorator
def cached(func, instance, args, kwargs): (source)

Simple decorator to cache result of method calls without args.

def deprecate_arguments(astroid_version: str = '3.0', **arguments: str) -> Callable[[Callable[_P, _R]], Callable[_P, _R]]: (source)

Decorator which emits a DeprecationWarning if any arguments specified are passed. Arguments should be a key-value mapping, with the key being the argument to check and the value being a string that explains what to do instead of passing the argument. To improve performance, only used when DeprecationWarnings other than the default one are enabled.

def deprecate_default_argument_values(astroid_version: str = '3.0', **arguments: str) -> Callable[[Callable[_P, _R]], Callable[_P, _R]]: (source)

Decorator which emits a DeprecationWarning if any arguments specified are None or not passed at all. Arguments should be a key-value mapping, with the key being the argument to check and the value being a type annotation as string for the value of the argument. To improve performance, only used when DeprecationWarnings other than the default one are enabled.

def path_wrapper(func): (source)

Return the given infer function wrapped to handle the path. Used to stop inference if the node has already been looked at for a given `InferenceContext` to prevent infinite recursion

@wrapt.decorator
def raise_if_nothing_inferred(func, instance, args, kwargs): (source)

Undocumented

@wrapt.decorator
def yes_if_nothing_inferred(func, instance, args, kwargs): (source)

Undocumented

_P = (source)

Undocumented

Value
ParamSpec('_P')
_R = (source)

Undocumented

Value
TypeVar('_R')