deprecated¶

metpy.io.cdm.deprecated(since, message='', name='', alternative='', pending=False, obj_type=None, addendum='')[source]¶

Mark a function or a class as deprecated.

Parameters:

since (str) – The release at which this API became deprecated. This is required.
message (str, optional) – Override the default deprecation message. The format specifier %(name)s may be used for the name of the object, and %(alternative)s may be used in the deprecation message to insert the name of an alternative to the deprecated object. %(obj_type)s may be used to insert a friendly name for the type of object being deprecated.
name (str, optional) –
The name of the deprecated object; if not provided the name is automatically determined from the passed in object, though this is useful in the case of renamed functions, where the new function is just assigned to the name of the deprecated function. For example:
```
def new_function():
    ...
oldFunction = new_function
```
alternative (str, optional) – An alternative object that the user may use in place of the deprecated object. The deprecation warning will tell the user about this alternative if provided.
pending (bool, optional) – If True, uses a PendingDeprecationWarning instead of a DeprecationWarning.
addendum (str, optional) – Additional text appended directly to the final message.

Examples

Basic example:

@deprecated('1.4.0')
def the_function_to_deprecate():
    pass