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).

Helpers

debtcollector.deprecate(prefix, postfix=None, message=None, version=None, removal_version=None, stacklevel=3, category=<type 'exceptions.DeprecationWarning'>)

Helper to deprecate some thing using generated message format.

Parameters:

• prefix – prefix string used as the prefix of the output message
• postfix – postfix string used as the postfix of the output message
• message – message string used as ending contents of the deprecate message
• version – version string (represents the version this deprecation was created in)
• removal_version – version string (represents the version this deprecation will be removed in); a string of ‘?’ will denote this will be removed in some future unknown version
• stacklevel – stacklevel used in the warnings.warn() function to locate where the users code is in the warnings.warn() call
• category – the warnings category to use, defaults to DeprecationWarning if not provided

Moves

Renames

Removals

Fixtures