FiPyfipy.tools.decorators¶
Functions
|
Issues a generic DeprecationWarning. |
- fipy.tools.decorators.deprecate(*args, **kwargs)¶
Issues a generic DeprecationWarning.
This function may also be used as a decorator.
- Parameters:
func (function) – The function to be deprecated.
old_name (str, optional) – The name of the function to be deprecated. Default is None, in which case the name of func is used.
new_name (str, optional) – The new name for the function. Default is None, in which case the deprecation message is that old_name is deprecated. If given, the deprecation message is that old_name is deprecated and new_name should be used instead.
message (str, optional) – Additional explanation of the deprecation. Displayed in the docstring after the warning.
- Returns:
old_func – The deprecated function.
- Return type:
function
Last updated on Jun 26, 2024.
Created using Sphinx 7.1.2.