albumentations.core.pydantic
Module containing Pydantic validation utilities for Albumentations. This module provides a collection of validators and utility functions used for validating parameters in the Pydantic models throughout the Albumentations library. It includes functions for ensuring numeric ranges are valid, handling type conversions, and creating standardized validation patterns that are reused across the codebase.
Members
- functionnondecreasing
- functionprocess_non_negative_range
- functionfloat2int
- functioncreate_symmetric_range
- functioncreate_symmetric_range
- functioncreate_symmetric_range
- functionconvert_to_1plus_range
- functionconvert_to_0plus_range
- functionconvert_to_1centered_range
- functionrepeat_if_scalar
- functioncheck_range_bounds
nondecreasingfunction
nondecreasing(
value: tuple[Number, Number]
)Ensure a tuple of two numbers is in non-decreasing order. Args: value (tuple[Number, Number]): Tuple of two numeric values to validate. Returns: tuple[Number, Number]: The original tuple if valid. Raises: ValueError: If the first value is greater than the second value.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
| value | tuple[Number, Number] | - | - |
process_non_negative_rangefunction
process_non_negative_range(
value: tuple[float, float] | float | None
)Process and validate a non-negative range. Args: value (tuple[float, float] | float | None): Value to process. Can be: - A tuple of two floats - A single float (converted to symmetric range) - None (defaults to 0) Returns: tuple[float, float]: Validated non-negative range. Raises: ValueError: If any values in the range are negative.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
| value | One of:
| - | - |
float2intfunction
float2int(
value: tuple[float, float]
)Convert a tuple of floats to a tuple of integers. Args: value (tuple[float, float]): Tuple of two float values. Returns: tuple[int, int]: Tuple of two integer values.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
| value | tuple[float, float] | - | - |
create_symmetric_rangefunction
create_symmetric_range(
value: tuple[int, int] | int
)Parameters
| Name | Type | Default | Description |
|---|---|---|---|
| value | One of:
| - | - |
create_symmetric_rangefunction
create_symmetric_range(
value: tuple[float, float] | float
)Parameters
| Name | Type | Default | Description |
|---|---|---|---|
| value | One of:
| - | - |
create_symmetric_rangefunction
create_symmetric_range(
value: tuple[float, float] | float
)Create a symmetric range around zero or use provided range. Args: value (tuple[float, float] | float): Input value, either: - A tuple of two floats (used directly) - A single float (converted to (-value, value)) Returns: tuple[float, float]: Symmetric range.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
| value | One of:
| - | - |
convert_to_1plus_rangefunction
convert_to_1plus_range(
value: tuple[float, float] | float
)Convert value to a range with lower bound of 1. Args: value (tuple[float, float] | float): Input value. Returns: tuple[float, float]: Range with minimum value of at least 1.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
| value | One of:
| - | - |
convert_to_0plus_rangefunction
convert_to_0plus_range(
value: tuple[float, float] | float
)Convert value to a range with lower bound of 0. Args: value (tuple[float, float] | float): Input value. Returns: tuple[float, float]: Range with minimum value of at least 0.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
| value | One of:
| - | - |
convert_to_1centered_rangefunction
convert_to_1centered_range(
value: tuple[float, float] | float
)Convert value to a range centered at 1: (max(0, 1-x), 1+x) for scalar x. Args: value (tuple[float, float] | float): Input value. Scalar x becomes (max(0, 1-x), 1+x). Tuple is used as-is. Scalar must be non-negative. Returns: tuple[float, float]: Range suitable for brightness/contrast/saturation factors.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
| value | One of:
| - | - |
repeat_if_scalarfunction
repeat_if_scalar(
value: tuple[float, float] | float
)Convert a scalar value to a tuple by repeating it, or return the tuple as is. Args: value (tuple[float, float] | float): Input value, either a scalar or tuple. Returns: tuple[float, float]: If input is scalar, returns (value, value), otherwise returns input unchanged.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
| value | One of:
| - | - |
check_range_boundsfunction
check_range_bounds(
min_val: Number,
max_val: Number | None,
min_inclusive: bool = True,
max_inclusive: bool = True
)Validates that all values in a tuple are within specified bounds. Args: min_val (int | float): Minimum allowed value. max_val (int | float | None): Maximum allowed value. If None, only lower bound is checked. min_inclusive (bool): If True, min_val is inclusive (>=). If False, exclusive (>). max_inclusive (bool): If True, max_val is inclusive (<=). If False, exclusive (<). Returns: Callable[[tuple[T, ...] | None], tuple[T, ...] | None]: Validator function that checks if all values in tuple are within bounds. Returns None if input is None. Raises: ValueError: If any value in tuple is outside the allowed range Examples: >>> validator = check_range_bounds(0, 1) # For [0, 1] range >>> validator((0.1, 0.5)) # Valid 2D (0.1, 0.5) >>> validator((0.1, 0.5, 0.7)) # Valid 3D (0.1, 0.5, 0.7) >>> validator((1.1, 0.5)) # Raises ValueError - outside range >>> validator = check_range_bounds(0, 1, max_inclusive=False) # For [0, 1) range >>> validator((0, 1)) # Raises ValueError - 1 not included
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
| min_val | Number | - | - |
| max_val | One of:
| - | - |
| min_inclusive | bool | True | - |
| max_inclusive | bool | True | - |