API ReferenceOther APIsAituneUtils

aitune.utils.validation

View as Markdown

Validation helpers.

Module Contents

Functions

NameDescription
in_rangeValidate that value is within the provided inclusive range.
non_negativeValidate that value is greater than or equal to 0.
positiveValidate that value is greater than 0.

Data

Number

API

aitune.utils.validation.in_range(
    value: aitune.utils.validation.Number,
    min_value: aitune.utils.validation.Number,
    max_value: aitune.utils.validation.Number,
    name: str | None = None
) -> None

Validate that value is within the provided inclusive range.

Parameters:

value
Number

Numeric value to validate.

min_value
Number

Inclusive lower bound.

max_value
Number

Inclusive upper bound.

name
str | NoneDefaults to None

Name of the value being validated.

Raises:

  • ValueError: If value is outside the inclusive range.
aitune.utils.validation.non_negative(
    value: aitune.utils.validation.Number,
    name: str | None = None
) -> None

Validate that value is greater than or equal to 0.

Parameters:

value
Number

Numeric value to validate.

name
str | NoneDefaults to None

Name of the value being validated.

Raises:

  • ValueError: If value is less than 0.
aitune.utils.validation.positive(
    value: aitune.utils.validation.Number,
    name: str | None = None
) -> None

Validate that value is greater than 0.

Parameters:

value
Number

Numeric value to validate.

name
str | NoneDefaults to None

Name of the value being validated.

Raises:

  • ValueError: If value is less than or equal to 0.
aitune.utils.validation.Number = TypeVar('Number', int, float)