Skip to content

Lifecycle Decorators

Deprecation warnings and versioning support.


Deprecated

Python
Deprecated(message: str = None)

Wraps a function with a decorator that warns the user the function is Deprecated. It also allows an optional custom message to be displayed when the function is used.

The warning message indicates that the function is no longer recommended for use and may be altered or removed in the future.

Text Only
provided, a default message will be used.
RETURNS DESCRIPTION

A decorator that when applied to a function, wraps it with the deprecation warning behavior.