deprecated_default_value()

audeer.deprecated_default_value(*, argument, change_in_version, new_default_value)

Mark default value of keyword argument as deprecated.

Provide a decorator to mark the default value of a keyword argument as deprecated. You have to specify the version for which the default value will change and the new default value.

Parameters

• argument (str) – keyword argument

• change_in_version (str) – version the default value will change

• new_default_value (Any) – new default value

Return type

Callable

Examples

>>> @deprecated_default_value(
...     argument="foo",
...     change_in_version="2.0.0",
...     new_default_value="bar",
... )
... def deprecated_function(foo="foo"):
...     pass