fix: move validator to common

Author: giancarloromeo

packages/models-library/src/models_library/api_schemas_webserver/storage.py

@@ -1,7 +1,12 @@
 from pathlib import Path
-from typing import Annotated, Final
+from typing import Annotated
 
-from pydantic import BaseModel, BeforeValidator, Field
+from models_library.utils.common_validators import (
+    MIN_NON_WILDCARD_CHARS,
+    WILDCARD_CHARS,
+    ensure_pattern_has_enough_characters,
+)
+from pydantic import BaseModel, Field
 
 from ..api_schemas_storage.storage_schemas import (
     DEFAULT_NUMBER_OF_PATHS_PER_PAGE,
@@ -11,8 +16,6 @@
 from ..rest_pagination import CursorQueryParameters
 from ._base import InputSchema
 
-MIN_NON_WILDCARD_CHARS: Final[int] = 3
-
 
 class StorageLocationPathParams(BaseModel):
     location_id: LocationID
@@ -46,20 +49,11 @@ class DataExportPost(InputSchema):
     paths: list[PathToExport]
 
 
-def validate_pattern_has_enough_characters(v: str) -> str:
-    non_wildcard_chars = len([c for c in v if c not in ("*", "?")])
-
-    if non_wildcard_chars < MIN_NON_WILDCARD_CHARS:
-        msg = f"Name pattern {v} must contain at least {MIN_NON_WILDCARD_CHARS} non-wildcard characters (not * or ?), got {non_wildcard_chars}"
-        raise ValueError(msg)
-    return v
-
-
 class SearchBodyParams(InputSchema):
     name_pattern: Annotated[
         str,
-        BeforeValidator(validate_pattern_has_enough_characters),
+        ensure_pattern_has_enough_characters(),
         Field(
-            description="Name pattern with wildcard support (* and ?). Minimum of {MIN_NON_WILDCARD_CHARS} non-wildcard characters required.",
+            description=f"Name pattern with wildcard support {tuple(WILDCARD_CHARS)}. Minimum of {MIN_NON_WILDCARD_CHARS} non-wildcard characters required.",
         ),
     ]

packages/models-library/src/models_library/utils/common_validators.py

@@ -18,13 +18,16 @@ class MyModel(BaseModel):
 import enum
 import functools
 import operator
-from typing import Any
+from typing import Any, Final
 
 from common_library.json_serialization import json_loads
 from orjson import JSONDecodeError
 from pydantic import BaseModel, BeforeValidator
 from pydantic.alias_generators import to_camel
 
+WILDCARD_CHARS: Final[set[str]] = {"*", "?"}
+MIN_NON_WILDCARD_CHARS: Final[int] = 3
+
 
 def trim_string_before(max_length: int) -> BeforeValidator:
     def _trim(value: str):
@@ -145,3 +148,21 @@ def to_camel_recursive(data: dict[str, Any]) -> dict[str, Any]:
         else:
             new_dict[new_key] = value
     return new_dict
+
+
+def ensure_pattern_has_enough_characters(
+    min_non_wildcard_chars: int = MIN_NON_WILDCARD_CHARS,
+    wildcard_chars: set[str] | None = None,
+) -> BeforeValidator:
+    if wildcard_chars is None:
+        wildcard_chars = WILDCARD_CHARS
+
+    def _validator(value):
+        non_wildcard_chars = len([c for c in value if c not in wildcard_chars])
+
+        if non_wildcard_chars < min_non_wildcard_chars:
+            msg = f"Pattern {value} must contain at least {min_non_wildcard_chars} non-wildcard characters, got {non_wildcard_chars}"
+            raise ValueError(msg)
+        return value
+
+    return BeforeValidator(_validator)