tomwer.core.utils.deprecation.deprecated_warning

tomwer.core.utils.deprecation.deprecated_warning(type_, name, reason=None, replacement=None, since_version=None, only_once=True, skip_backtrace_count=0)

Function to log a deprecation warning

Parameters:

• type – Nature of the object to be deprecated: “Module”, “Function”, “Class” …

• name – Object name.

• reason – Reason for deprecating this function (e.g. “feature no longer provided”,

• replacement – Name of replacement function (if the reason for deprecating was to rename the function)

• since_version – First silx version for which the function was deprecated (e.g. “0.5.0”).

• only_once – If true, the deprecation warning will only be generated one time for each different call locations. Default is true.

• skip_backtrace_count – Amount of last backtrace to ignore when logging the backtrace