✨ Support pattern parameter

sqlmodel/main.py

@@ -2,7 +2,9 @@
 
 import builtins
 import ipaddress
+import re
 import uuid
+import warnings
 from collections.abc import Callable, Mapping, Sequence, Set
 from dataclasses import dataclass
 from datetime import date, datetime, time, timedelta
@@ -11,6 +13,7 @@
 from pathlib import Path
 from typing import (
     TYPE_CHECKING,
+    Annotated,
     Any,
     ClassVar,
     Literal,
@@ -89,6 +92,10 @@
 )
 OnDeleteType = Literal["CASCADE", "SET NULL", "RESTRICT"]
 
+REGEX_PARAM_DEPRECATION_MSG = (
+    "The `regex` parameter is deprecated. \nUse `pattern` parameter instead."
+)
+
 
 def __dataclass_transform__(
     *,
@@ -259,7 +266,11 @@ def Field(
     min_length: int | None = None,
     max_length: int | None = None,
     allow_mutation: bool = True,
-    regex: str | None = None,
+    regex: Annotated[
+        str | None,
+        deprecated(REGEX_PARAM_DEPRECATION_MSG),
+    ] = None,
+    pattern: str | re.Pattern[str] | None = None,
     discriminator: str | None = None,
     repr: bool = True,
     primary_key: bool | UndefinedType = Undefined,
@@ -302,7 +313,11 @@ def Field(
     min_length: int | None = None,
     max_length: int | None = None,
     allow_mutation: bool = True,
-    regex: str | None = None,
+    regex: Annotated[
+        str | None,
+        deprecated(REGEX_PARAM_DEPRECATION_MSG),
+    ] = None,
+    pattern: str | re.Pattern[str] | None = None,
     discriminator: str | None = None,
     repr: bool = True,
     primary_key: bool | UndefinedType = Undefined,
@@ -354,7 +369,11 @@ def Field(
     min_length: int | None = None,
     max_length: int | None = None,
     allow_mutation: bool = True,
-    regex: str | None = None,
+    regex: Annotated[
+        str | None,
+        deprecated(REGEX_PARAM_DEPRECATION_MSG),
+    ] = None,
+    pattern: str | re.Pattern[str] | None = None,
     discriminator: str | None = None,
     repr: bool = True,
     sa_column: Column[Any] | UndefinedType = Undefined,
@@ -387,7 +406,11 @@ def Field(
     min_length: int | None = None,
     max_length: int | None = None,
     allow_mutation: bool = True,
-    regex: str | None = None,
+    regex: Annotated[
+        str | None,
+        deprecated(REGEX_PARAM_DEPRECATION_MSG),
+    ] = None,
+    pattern: str | re.Pattern[str] | None = None,
     discriminator: str | None = None,
     repr: bool = True,
     primary_key: bool | UndefinedType = Undefined,
@@ -403,9 +426,19 @@ def Field(
     schema_extra: dict[str, Any] | None = None,
 ) -> Any:
     current_schema_extra = schema_extra or {}
+
+    if regex:
+        warnings.warn(REGEX_PARAM_DEPRECATION_MSG, DeprecationWarning, stacklevel=2)
+
+    for param_name in ("pattern",):
+        if param_name in current_schema_extra:
+            msg = f"Pass `{param_name}` parameter directly to Field instead of passing it via `schema_extra`"
+            warnings.warn(msg, UserWarning, stacklevel=2)
+
     # Extract possible alias settings from schema_extra so we can control precedence
     schema_validation_alias = current_schema_extra.pop("validation_alias", None)
     schema_serialization_alias = current_schema_extra.pop("serialization_alias", None)
+    current_pattern = pattern or regex or current_schema_extra.pop("pattern", None)
     field_info_kwargs = {
         "alias": alias,
         "title": title,
@@ -426,7 +459,7 @@ def Field(
         "min_length": min_length,
         "max_length": max_length,
         "allow_mutation": allow_mutation,
-        "regex": regex,
+        "pattern": current_pattern,
         "discriminator": discriminator,
         "repr": repr,
         "primary_key": primary_key,

tests/test_pydantic/test_field.py

@@ -54,3 +54,38 @@ class Model(SQLModel):
 
     instance = Model(id=123, foo="bar")
     assert "foo=" not in repr(instance)
+
+
+def test_regex():
+    with pytest.warns(DeprecationWarning, match="The `regex` parameter is deprecated"):
+
+        class DateModel(SQLModel):
+            date_1: str = Field(regex=r"^\d{2}-\d{2}-\d{4}$")
+
+    DateModel(date_1="12-31-2024")
+
+    with pytest.raises(ValidationError):
+        DateModel(date_1="incorrect")
+
+
+def test_pattern():
+    class DateModel(SQLModel):
+        date_1: str = Field(pattern=r"^\d{2}-\d{2}-\d{4}$")
+
+    DateModel(date_1="12-31-2024")
+
+    with pytest.raises(ValidationError):
+        DateModel(date_1="incorrect")
+
+
+def test_pattern_via_schema_extra():
+    with pytest.warns(
+        UserWarning,
+        match="Pass `pattern` parameter directly to Field instead of passing it via `schema_extra`",
+    ):
+
+        class DateModel(SQLModel):
+            date_1: str = Field(schema_extra={"pattern": r"^\d{2}-\d{2}-\d{4}$"})
+
+    with pytest.raises(ValidationError):
+        DateModel(date_1="incorrect")