API

The currently documented publicly exposed API’s for usage in your project are defined below.

Warning

External usage of internal utility functions and modules should be kept to a minimum as they may be altered, refactored or moved to other locations without notice (and without the typical deprecation cycle).

Moves

debtcollector.moves.moved_method(new_method_name, message=None, version=None, removal_version=None, stacklevel=3)

Decorates a instance method that was moved to another location.

debtcollector.moves.moved_property(new_attribute_name, message=None, version=None, removal_version=None, stacklevel=3)

Decorates a instance property that was moved to another location.

debtcollector.moves.moved_class(new_class, old_class_name, old_module_name, message=None, version=None, removal_version=None, stacklevel=3)

Deprecates a class that was moved to another location.

This creates a ‘new-old’ type that can be used for a deprecation period that can be inherited from. This will emit warnings when the old locations class is initialized, telling where the new and improved location for the old class now is.

Renames

debtcollector.renames.renamed_kwarg(old_name, new_name, message=None, version=None, removal_version=None, stacklevel=3)

Decorates a kwarg accepting function to deprecate a renamed kwarg.

Removals