decorateme._status

Decorators that warn about code maturity.

Module Contents

Classes

CodeStatus

An enum for the quality/maturity of code,

Functions

status(level[, vr, msg])

Annotate code quality. Emits a warning if bad code is called.

exception decorateme._status.CodeIncompleteError

Bases: NotImplementedError

The code is not finished.

exception decorateme._status.CodeRemovedError

Bases: NotImplementedError

The code was removed.

exception decorateme._status.PreviewWarning

Bases: UserWarning

The code being called is a preview, unstable. or immature.

class decorateme._status.CodeStatus

Bases: enum.Enum

An enum for the quality/maturity of code, ranging from incomplete to deprecated.

INCOMPLETE

PREVIEW

STABLE = 0

PENDING_DEPRECATION = 1

DEPRECATED = 2

REMOVED = 3

classmethod of(x: Union[int, str, CodeStatus]) → CodeStatus

decorateme._status.status(level: Union[int, str, CodeStatus], vr: Optional[str] = '', msg: Optional[str] = None)

Annotate code quality. Emits a warning if bad code is called.

Parameters

• level – The quality / maturity

• vr – First version the status / warning applies to

• msg – Explanation and/or when it will be removed or completed