Skip to content

threshold_checker

Classes#

ThresholdChecker #

Bases: QualityChecker, ABC

Base class for checks that use a variable attribute to specify a threshold.

Parameters:

Name Type Description Default
attribute_name str

The name of the attribute containing the maximum threshold. If the attribute ends in '_range' then it is assumed to be a list, and the first value from the list will be used as the minimum threshold.

 required
allow_equal bool

True if values equal to the threshold should pass the check, False otherwise.

 required

Attributes#

allow_equal class-attribute instance-attribute #
allow_equal: bool = True

True if values equal to the threshold should pass, False otherwise.

attribute_name instance-attribute #
attribute_name: str

The attribute on the data variable that should be used to get the threshold.