utils.deprecated

Deprecation utilities.

Module Contents

Classes

_deprecated_property(self,fget=None,fset=None,fdel=None,doc=None,**depreinfo)

Functions

warn(description=None,deprecation=None,removal=None,alternative=None,stacklevel=2) Warn of (pending) deprecation.
Callable(deprecation=None,removal=None,alternative=None,description=None) Decorator for deprecated functions.
Property(deprecation=None,removal=None,alternative=None,description=None) Decorator for deprecated properties.
warn(description=None, deprecation=None, removal=None, alternative=None, stacklevel=2)

Warn of (pending) deprecation.

Callable(deprecation=None, removal=None, alternative=None, description=None)

Decorator for deprecated functions.

A deprecation warning will be emitted when the function is called.

Arguments:
deprecation (str): Version that marks first deprecation, if this
argument isn’t set a PendingDeprecationWarning will be emitted instead.

removal (str): Future version when this feature will be removed. alternative (str): Instructions for an alternative solution (if any). description (str): Description of what’s being deprecated.

Property(deprecation=None, removal=None, alternative=None, description=None)

Decorator for deprecated properties.

class _deprecated_property(fget=None, fset=None, fdel=None, doc=None, **depreinfo)
__init__(fget=None, fset=None, fdel=None, doc=None, **depreinfo)
__get__(obj, type=None)
__set__(obj, value)
__delete__(obj)
setter(fset)
deleter(fdel)