3.11.25. numpy.lib.deprecate¶

numpy.lib.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:

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 : function

The deprecated function.

Examples

Note that olduint returns a value after printing Deprecation Warning:

>>> olduint = np.deprecate(np.uint)
>>> olduint(6)
/usr/lib/python2.5/site-packages/numpy/lib/utils.py:114:
DeprecationWarning: uint32 is deprecated
  warnings.warn(str1, DeprecationWarning)
6