slickml.utils._annotations#

Module Contents#

Functions#

deprecated(→ Callable[[Callable[P, R]], Callable[P, R]])

Annotation decorator for marking APIs as deprecated in docstrings and raising a warning if called.

Attributes#

P

R

slickml.utils._annotations.P#
slickml.utils._annotations.R#
slickml.utils._annotations.deprecated(alternative: Optional[str] = None, since: Optional[str] = None) → Callable[[Callable[P, R]], Callable[P, R]][source]#

Annotation decorator for marking APIs as deprecated in docstrings and raising a warning if called.

Parameters:

  • alternative (str, optional) – The name of a superseded replacement function, method, or class to use in place of the deprecated one, by default None

  • since (str, optional) – A version designator defining during which release the function, method, or class was marked as deprecated, by default None

Returns:

Callable[[Callable[P, R]], Callable[P, R]]