matplotlib 3.5.1

ParametersBackRef
warn_deprecated(since, *, message='', name='', alternative='', pending=False, obj_type='', addendum='', removal='')

Parameters

since : str

The release at which this API became deprecated.

message : str, optional

Override the default deprecation message. The %(since)s , %(name)s , %(alternative)s , %(obj_type)s , %(addendum)s , and %(removal)s format specifiers will be replaced by the values of the respective arguments passed to this function.

name : str, optional

The name of the deprecated object.

alternative : str, optional

An alternative API that the user may use in place of the deprecated API. The deprecation warning will tell the user about this alternative if provided.

pending : bool, optional

If True, uses a PendingDeprecationWarning instead of a DeprecationWarning. Cannot be used together with removal.

obj_type : str, optional

The object type being deprecated.

addendum : str, optional

Additional text appended directly to the final message.

removal : str, optional

The expected removal version. With the default (an empty string), a removal version is automatically computed from since. Set to other Falsy values to not schedule a removal date. Cannot be used together with pending.

Display a standardized deprecation.

Examples

# To warn of the deprecation of "matplotlib.name_of_module" warn_deprecated('1.4.0', name='matplotlib.name_of_module', obj_type='module')

See :

Back References

The following pages refer to to this document either explicitly or contain code examples using this.

matplotlib._api.deprecation.deprecated matplotlib._api.deprecation.deprecate_method_override

Local connectivity graph

Hover to see nodes names; edges to Self not shown, Caped at 50 nodes.

Using a canvas is more power efficient and can get hundred of nodes ; but does not allow hyperlinks; , arrows or text (beyond on hover)

SVG is more flexible but power hungry; and does not scale well to 50 + nodes.

All aboves nodes referred to, (or are referred from) current nodes; Edges from Self to other have been omitted (or all nodes would be connected to the central node "self" which is not useful). Nodes are colored by the library they belong to, and scaled with the number of references pointing them


File: /matplotlib/_api/deprecation.py#55
type: <class 'function'>
Commit: