numpy.deprecate#

numpy.deprecate(*args, **kwargs)[source]#

Issues a DeprecationWarning, adds warning to old_name’s docstring, rebinds old_name.__name__ and returns the new function object.

This function may also be used as a decorator.

Parameters:
funcfunction

The function to be deprecated.

old_namestr, optional

The name of the function to be deprecated. Default is None, in which case the name of func is used.

new_namestr, 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.

messagestr, optional

Additional explanation of the deprecation. Displayed in the docstring after the warning.

Returns:
old_funcfunction

The deprecated function.

Examples

Note that olduint returns a value after printing Deprecation Warning:

>>> olduint = np.deprecate(np.uint)
DeprecationWarning: `uint64` is deprecated! # may vary
>>> olduint(6)
6