Callable
Decorator for deprecated functions.
A deprecation warning will be emitted when the function is called.
def Callable(
deprecation: str = None,
removal: str = None,
alternative: str = None,
description: str = None
) - > function
Decorator for deprecated functions.
Parameters
| Name | Type | Description |
|---|---|---|
| deprecation | str = None | The version string that marks the first deprecation; if omitted, a PendingDeprecationWarning is emitted. |
| removal | str = None | The future version string indicating when the feature is scheduled for removal. |
| alternative | str = None | Instructions or guidance for an alternative solution to replace the deprecated functionality. |
| description | str = None | A description of the specific feature being deprecated; defaults to the qualified name of the function. |
Returns
| Type | Description |
|---|---|
function | A wrapper function that emits a deprecation warning before executing the original callable. |