Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 4 additions & 6 deletions src/validataclass_search_queries/validators/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,7 @@
Use of this source code is governed by an MIT-style license that can be found in the LICENSE file.
"""

from .multi_select_validator import (
MultiSelectValidator,
MultiSelectIntegerValidator,
MultiSelectAnyOfValidator,
MultiSelectEnumValidator,
)
from .multi_select_any_of_validator import MultiSelectAnyOfValidator
from .multi_select_enum_validator import MultiSelectEnumValidator
from .multi_select_integer_validator import MultiSelectIntegerValidator
from .multi_select_validator import MultiSelectValidator
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
"""
validataclass-search-queries
Copyright (c) 2026, binary butterfly GmbH and contributors
Use of this source code is governed by an MIT-style license that can be found in the LICENSE file.
"""

from collections.abc import Iterable
from typing import Any

from validataclass.validators import AnyOfValidator

from .multi_select_validator import MultiSelectValidator

__all__ = [
'MultiSelectAnyOfValidator',
]


class MultiSelectAnyOfValidator(MultiSelectValidator):
"""
Validator for multi-select search parameters that only allows a specified set of values.

Shortcut for a `MultiSelectValidator` with an `AnyOfValidator`.
"""

def __init__(
self,
# AnyOfValidator settings
allowed_values: Iterable[Any],
# TODO: case_insensitive is deprecated in validataclass and must be removed in a future version.
case_sensitive: bool | None = None,
case_insensitive: bool | None = None,
*,
# List settings
delimiter: str = ',',
max_length: int | None = None,
):
"""
Create a `MultiSelectValidator` using an `AnyOfValidator` to validate the items.
"""
super().__init__(
AnyOfValidator(
allowed_values,
case_sensitive=case_sensitive,
case_insensitive=case_insensitive,
),
delimiter=delimiter,
max_length=max_length,
)
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
"""
validataclass-search-queries
Copyright (c) 2026, binary butterfly GmbH and contributors
Use of this source code is governed by an MIT-style license that can be found in the LICENSE file.
"""

from collections.abc import Iterable
from enum import Enum
from typing import Any, TypeVar

from validataclass.validators import EnumValidator

from .multi_select_validator import MultiSelectValidator

__all__ = [
'MultiSelectEnumValidator',
]

T_Enum = TypeVar('T_Enum', bound=Enum)


class MultiSelectEnumValidator(MultiSelectValidator[T_Enum]):
"""
Validator for multi-select search parameters that allows values from an Enum class.

Shortcut for a `MultiSelectValidator` with an `EnumValidator`.
"""

def __init__(
self,
# EnumValidator settings
enum_cls: type[Enum],
*,
allowed_values: Iterable[Any] | None = None,
# TODO: case_insensitive is deprecated in validataclass and must be removed in a future version.
case_sensitive: bool | None = None,
case_insensitive: bool | None = None,
# List settings
delimiter: str = ',',
max_length: int | None = None,
):
"""
Create a `MultiSelectValidator` using an `EnumValidator` to validate the items.
"""
super().__init__(
EnumValidator(
enum_cls,
allowed_values=allowed_values,
case_sensitive=case_sensitive,
case_insensitive=case_insensitive,
),
delimiter=delimiter,
max_length=max_length,
)
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
"""
validataclass-search-queries
Copyright (c) 2026, binary butterfly GmbH and contributors
Use of this source code is governed by an MIT-style license that can be found in the LICENSE file.
"""

from validataclass.validators import IntegerValidator

from .multi_select_validator import MultiSelectValidator

__all__ = [
'MultiSelectIntegerValidator',
]


class MultiSelectIntegerValidator(MultiSelectValidator[int]):
"""
Validator for multi-select search parameters that only allows integers.

Shortcut for a `MultiSelectValidator` with an `IntegerValidator`.
"""

def __init__(
self,
*,
# Integer validator settings
min_value: int | None = IntegerValidator.DEFAULT_MIN_VALUE,
max_value: int | None = IntegerValidator.DEFAULT_MAX_VALUE,
# List settings
delimiter: str = ',',
max_length: int | None = None,
):
"""
Create a `MultiSelectValidator` using an `IntegerValidator` to validate the items.
"""
# Initialize base MultiSelectValidator and IntegerValidator
super().__init__(
IntegerValidator(
min_value=min_value,
max_value=max_value,
allow_strings=True,
),
delimiter=delimiter,
max_length=max_length,
)
123 changes: 11 additions & 112 deletions src/validataclass_search_queries/validators/multi_select_validator.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,27 +4,16 @@
Use of this source code is governed by an MIT-style license that can be found in the LICENSE file.
"""

from collections.abc import Iterable
from enum import Enum
from typing import Any

from validataclass.validators import (
AnyOfValidator,
EnumValidator,
IntegerValidator,
ListValidator,
Validator,
T_ListItem,
T_Enum,
)
from typing import Any, TypeVar

from validataclass.validators import ListValidator, Validator

__all__ = [
'MultiSelectValidator',
'MultiSelectIntegerValidator',
'MultiSelectAnyOfValidator',
'MultiSelectEnumValidator',
]

T_ListItem = TypeVar('T_ListItem')


# TODO: Base on StringToListValidator from upstream validataclass when implemented.
class MultiSelectValidator(ListValidator[T_ListItem]):
Expand All @@ -34,7 +23,7 @@ class MultiSelectValidator(ListValidator[T_ListItem]):
Accepts a string as input, splits it to a list of strings using a delimiter (defaults to ",") and validates the
resulting list using a specified item validator (based on the `ListValidator`).

The validator assumes a minimum list length of 1. A maximum list length can be optionally specified using `max_length`.
The validator assumes a minimum list length of 1. A maximum length can be optionally specified using `max_length`.

The item validator can be any validator that accepts strings as input.

Expand All @@ -60,12 +49,12 @@ def __init__(
max_length: int | None = None,
):
"""
Create a MultiSelectValidator with a given item validator.
Create a `MultiSelectValidator` with a given item validator.

Parameters:
item_validator: Validator, used to validate the items in the list (required)
delimiter: String, specifies the string that separates the list items in the input string (default: ',')
max_length: Integer, specifies maximum length of input list (default: None, no maximum length)
`item_validator`: `Validator`, used to validate the items in the list (required)
`delimiter`: `str`, specifies the string that separates the list items in the input string (default: ',')
`max_length`: `int`, specifies maximum length of input list (default: `None`, no maximum length)
"""
# Initialize base ListValidator
super().__init__(
Expand All @@ -87,96 +76,6 @@ def validate(self, input_data: Any, **kwargs) -> list[T_ListItem]:
else:
# Split string to list
value_list = input_data.split(self.delimiter)

# Validate list items
return super().validate(value_list, **kwargs)


class MultiSelectIntegerValidator(MultiSelectValidator[int]):
"""
Validator for multi-select search parameters that only allows integers.

Shortcut for a `MultiSelectValidator` with an `IntegerValidator`.
"""

def __init__(
self,
*,
# Integer validator settings
min_value: int | None = IntegerValidator.DEFAULT_MIN_VALUE,
max_value: int | None = IntegerValidator.DEFAULT_MAX_VALUE,
# List settings
delimiter: str = ',',
max_length: int | None = None,
):
"""
Create a MultiSelectValidator using a IntegerValidator to validate the items.
"""
# Initialize base MultiSelectValidator and IntegerValidator
super().__init__(
IntegerValidator(
min_value=min_value,
max_value=max_value,
allow_strings=True,
),
delimiter=delimiter,
max_length=max_length,
)


class MultiSelectAnyOfValidator(MultiSelectValidator):
"""
Validator for multi-select search parameters that only allows a specified set of values.

Shortcut for a `MultiSelectValidator` with an `AnyOfValidator`.
"""

def __init__(
self,
# AnyOfValidator settings
allowed_values: Iterable[Any],
# TODO: case_insensitive is deprecated in validataclass and must be removed in a future version.
case_sensitive: bool | None = None,
case_insensitive: bool | None = None,
*,
# List settings
delimiter: str = ',',
max_length: int | None = None,
):
"""
Create a MultiSelectValidator using a AnyOfValidator to validate the items.
"""
super().__init__(
AnyOfValidator(allowed_values, case_sensitive=case_sensitive, case_insensitive=case_insensitive),
delimiter=delimiter,
max_length=max_length,
)


class MultiSelectEnumValidator(MultiSelectValidator[T_Enum]):
"""
Validator for multi-select search parameters that allows values from an Enum class.

Shortcut for a `MultiSelectValidator` with an `EnumValidator`.
"""

def __init__(
self,
# EnumValidator settings
enum_cls: type[Enum],
*,
allowed_values: Iterable[Any] | None = None,
# TODO: case_insensitive is deprecated in validataclass and must be removed in a future version.
case_sensitive: bool | None = None,
case_insensitive: bool | None = None,
# List settings
delimiter: str = ',',
max_length: int | None = None,
):
"""
Create a MultiSelectValidator using a EnumValidator to validate the items.
"""
super().__init__(
EnumValidator(enum_cls, allowed_values=allowed_values, case_sensitive=case_sensitive, case_insensitive=case_insensitive),
delimiter=delimiter,
max_length=max_length,
)
Loading
Loading