ros_sugar.config.base_validators
#
Module Contents#
Functions#
Validates that field is greater than value |
|
Validates that field is lesser than value |
|
Validates that value is in a given list |
|
Validates that all elements in a given list are in values |
|
Validates that a given value is within range |
|
Validates that a given value is within range with a given step |
API#
- ros_sugar.config.base_validators.gt(value: Union[int, float]) ros_sugar.config.base_validators.Validator #
Validates that field is greater than value
- Parameters:
value (int | float) β Value
- Returns:
Attrs validator function
- Return type:
func
- ros_sugar.config.base_validators.lt(value: Union[int, float]) ros_sugar.config.base_validators.Validator #
Validates that field is lesser than value
- Parameters:
value (int | float) β Value
- Returns:
Attrs validator function
- Return type:
func
- ros_sugar.config.base_validators.in_(values: List) ros_sugar.config.base_validators.Validator #
Validates that value is in a given list
- Parameters:
values (List) β Reference list of values
- Returns:
Attrs validator function
- Return type:
func
- ros_sugar.config.base_validators.list_contained_in(values: List) ros_sugar.config.base_validators.Validator #
Validates that all elements in a given list are in values
- Parameters:
values (List) β Reference list of values
- Returns:
Attrs validator function
- Return type:
func
- ros_sugar.config.base_validators.in_range(min_value: Union[float, int], max_value: Union[float, int]) ros_sugar.config.base_validators.Validator #
Validates that a given value is within range
- Parameters:
min_value (Union[float, int]) β Minimum value
max_value (Union[float, int]) β Maximum value
- Returns:
Attrs validator function
- Return type:
func
- ros_sugar.config.base_validators.in_range_discretized(step: Union[float, int], min_value: Union[float, int], max_value: Union[float, int]) ros_sugar.config.base_validators.Validator #
Validates that a given value is within range with a given step
- Parameters:
step (Union[float, int]) β Step size
min_value (Union[float, int]) β Minimum value
max_value (Union[float, int]) β Maximum value
- Returns:
Attrs validator function
- Return type:
func