Numeric validators
MustBeBetween(*, min_value, max_value, min_inclusive=True, max_inclusive=True, err_msg=None, extra_msg_args=None)
Bases: Validator
Validates that the number is between min_value and max_value.
| PARAMETER | DESCRIPTION |
|---|---|
min_value
|
The minimum value (inclusive or exclusive based on min_inclusive).
TYPE:
|
max_value
|
The maximum value (inclusive or exclusive based on max_inclusive).
TYPE:
|
min_inclusive
|
If True, min_value is inclusive. Default is True.
TYPE:
|
max_inclusive
|
If True, max_value is inclusive. Default is True.
TYPE:
|
err_msg
|
error message.
TYPE:
|
MustBePositive(*, err_msg=None, extra_msg_args=None)
Bases: Validator
Validates that the number is positive (\(x \gt 0\)).
MustBeNonPositive(*, err_msg=None, extra_msg_args=None)
Bases: Validator
Validates that the number is non-positive (\(x \le 0\)).
MustBeNegative(*, err_msg=None, extra_msg_args=None)
Bases: Validator
Validates that the number is negative (\(x \lt 0\)).
MustBeNonNegative(*, err_msg=None, extra_msg_args=None)
Bases: Validator
Validates that the number is non-negative (\(x \ge 0\)).
MustBeEqual(value, /, *, err_msg=None, extra_msg_args=None)
Bases: Validator
Validates that the number is equal to the specified value
MustNotBeEqual(value, /, *, err_msg=None, extra_msg_args=None)
Bases: Validator
Validates that the number is not equal to the specified value
MustBeAlmostEqual(value, /, *, rel_tol=1e-09, abs_tol=0.0, err_msg=None, extra_msg_args=None)
Bases: Validator
Validates that argument value (float) is almost equal to the specified value.
Uses math.isclose (which means key-word arguments provided are
passed to math.isclose) for comparison, see its
documentation
for details.
MustBeGreaterThan(value, /, *, err_msg=None, extra_msg_args=None)
Bases: Validator
Validates that the number is greater than the specified value
MustBeGreaterThanOrEqual(value, /, *, err_msg=None, extra_msg_args=None)
Bases: Validator
Validates that the number is greater than or equal to the specified value.
MustBeLessThan(value, /, *, err_msg=None, extra_msg_args=None)
Bases: Validator
Validates that the number is less than the specified value
MustBeLessThanOrEqual(value, /, *, err_msg=None, extra_msg_args=None)
Bases: Validator
Validates that the number is less than or equal to the specified value.