cleverly.AssessmentStatus#

class cleverly.AssessmentStatus(*values)[source]#

Status returned by a diagnostic or validation operation.

DEFERRED means that the operation can run after the caller supplies a required choice or cost opt-in. NOT_APPLICABLE means that the operation does not apply to the fitted estimand. UNAVAILABLE means that the operation applies, but this fit cannot run it. Four causes reach that status: a missing method, a missing derivation, a missing replay artifact, and a requested variant that has no support. An operation that raises a capability refusal after the combined report invoked it is unavailable for the same reason.

Reach a status by name, as AssessmentStatus.PASSED.

The synthetic constructor that enum.StrEnum gives every member is not a caller argument, and its parameters differ by interpreter: 3.11 exposes value, names, module, qualname, type, start and boundary, while 3.12 collapses several into *values. Documenting either one satisfies numpydoc on that version and fails it on the other, which is how a Parameters block written for 3.12 left PR01 and PR02 firing on the 3.11 build. Ignoring both is the version-independent answer, and docs/development/contributing.md tells a contributor to build the documentation on whichever interpreter they have.

Methods#

Attributes#

AssessmentStatus.PASSED = 'passed'#
AssessmentStatus.FAILED = 'failed'#
AssessmentStatus.WARNING = 'warning'#
AssessmentStatus.COMPLETED = 'completed'#
AssessmentStatus.DEFERRED = 'deferred'#
AssessmentStatus.NOT_APPLICABLE = 'not_applicable'#
AssessmentStatus.UNAVAILABLE = 'unavailable'#