pastas.decorators.deprecate_args_or_kwargs

pastas.decorators.deprecate_args_or_kwargs(name: str, remove_version: str, reason: str = '', force_raise: bool = False)

Provide a warning or error when a function argument is deprecated.

Parameters:

• name (str) – The name of the argument that is deprecated.

• remove_version (str) – The version in which the argument will be removed.

• reason (str, optional) – The reason why the argument is deprecated. Or provide a message that tells the user which alternative should be used.

• force_raise (bool, optional) – If True, raise a DeprecationWarning even if remove_version is still in the future. Default is False.