deprecation

This module provides utilities for deprecating functionality.

deprecated([msg, logger, version, remove_in])

Decorator to indicate that a function, method, or class is deprecated.

deprecation_warning(msg[, logger, version, ...])

Standardized formatter for deprecation warnings

relocated_module(new_name[, msg, logger, ...])

DEPRECATED.

relocated_module_attribute(local, target, ...)

Provide a deprecation path for moved / renamed module attributes

RenamedClass(name, bases, classdict, *args, ...)

Metaclass to provide a deprecation path for renamed classes

Classes

MovedModuleFinder()

Custom finder that supports loading a module through an alternative name.

MovedModuleInfo(old_name, new_name, msg, ...)

MovedModuleLoader(info)

Custom module loader that supports loading modules through alternate names

RenamedClass(name, bases, classdict, *args, ...)

Metaclass to provide a deprecation path for renamed classes

Functions

default_deprecation_msg(obj, user_msg, ...)

Generate the default deprecation message.

deprecated([msg, logger, version, remove_in])

Decorator to indicate that a function, method, or class is deprecated.

deprecation_warning(msg[, logger, version, ...])

Standardized formatter for deprecation warnings

moved_module(old_name, new_name[, msg, ...])

Provide a deprecation path for moved / renamed modules

relocated_module(new_name[, msg, logger, ...])

DEPRECATED.

relocated_module_attribute(local, target, ...)

Provide a deprecation path for moved / renamed module attributes