_deprecated(*, version: str = None, message: str = None, use_instead: str = None, category: Type[Warning] = <class 'FutureWarning'>)

Parameters

version : str, optional

Version of Dask in which the function was deprecated. If specified, the version will be included in the default warning message.

message : str, optional

Custom warning message to raise.

use_instead : str, optional

Name of function to use in place of the deprecated function. If specified, this will be included in the default warning message.

category : type[Warning], optional

Type of warning to raise. Defaults to FutureWarning .

Decorator to mark a function as deprecated

Examples

This example is valid syntax, but we were not able to check execution

>>> from dask.utils import _deprecated
... @_deprecated(version="X.Y.Z", use_instead="bar")
... def foo():
...     return "baz"

See :

Back References

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

dask.utils._deprecated

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: /dask/utils.py#40
type: <class 'function'>
Commit: