pastas.decorators.PastasDeprecationWarning

pastas.decorators.PastasDeprecationWarning(remove_version: str, reason: str = '') → Any

Provide a warning or error when a Pastas class, method or function is deprecated.

Logs a warning if the current Pastas version is lower than the version in which the class, function or method is removed. Raises a DeprecationWarning if the current Pastas version is higher than the version in which the class, function or method was removed.

Parameters:

• remove_version (str) – The version in which the function or class will be removed.

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