deprecated

pyarts.utils.common.deprecated(func=None, new_name=None, message=None)

Decorator which can be used to mark functions as deprecated.

Examples

Calling foo() will raise a DeprecationWarning.

>>> @deprecated
... def deprecated_function():
...     pass

Display message with additional information:

>>> @deprecated(message='Additional information message.')
... def deprecated_function():
...     pass