Deprecate regex parameter in favor of pattern

Author: YuriiMotov

sqlmodel/main.py

@@ -3,6 +3,7 @@
 import builtins
 import ipaddress
 import uuid
+import warnings
 import weakref
 from collections.abc import Mapping, Sequence, Set
 from datetime import date, datetime, time, timedelta
@@ -11,6 +12,7 @@
 from pathlib import Path
 from typing import (
     TYPE_CHECKING,
+    Annotated,
     Any,
     Callable,
     ClassVar,
@@ -89,6 +91,10 @@
 ]
 OnDeleteType = Literal["CASCADE", "SET NULL", "RESTRICT"]
 
+REGEX_PARAM_DEPRECATION_MSG = (
+    "The `regex` parameter is deprecated. \nUse `pattern` parameter instead."
+)
+
 
 def __dataclass_transform__(
     *,
@@ -227,7 +233,10 @@ def Field(
     min_length: Optional[int] = None,
     max_length: Optional[int] = None,
     allow_mutation: bool = True,
-    regex: Optional[str] = None,
+    regex: Annotated[
+        Optional[str],
+        deprecated(REGEX_PARAM_DEPRECATION_MSG),
+    ] = None,
     pattern: Optional[str] = None,
     discriminator: Optional[str] = None,
     repr: bool = True,
@@ -271,7 +280,10 @@ def Field(
     min_length: Optional[int] = None,
     max_length: Optional[int] = None,
     allow_mutation: bool = True,
-    regex: Optional[str] = None,
+    regex: Annotated[
+        Optional[str],
+        deprecated(REGEX_PARAM_DEPRECATION_MSG),
+    ] = None,
     pattern: Optional[str] = None,
     discriminator: Optional[str] = None,
     repr: bool = True,
@@ -324,7 +336,10 @@ def Field(
     min_length: Optional[int] = None,
     max_length: Optional[int] = None,
     allow_mutation: bool = True,
-    regex: Optional[str] = None,
+    regex: Annotated[
+        Optional[str],
+        deprecated(REGEX_PARAM_DEPRECATION_MSG),
+    ] = None,
     pattern: Optional[str] = None,
     discriminator: Optional[str] = None,
     repr: bool = True,
@@ -358,7 +373,10 @@ def Field(
     min_length: Optional[int] = None,
     max_length: Optional[int] = None,
     allow_mutation: bool = True,
-    regex: Optional[str] = None,
+    regex: Annotated[
+        Optional[str],
+        deprecated(REGEX_PARAM_DEPRECATION_MSG),
+    ] = None,
     pattern: Optional[str] = None,
     discriminator: Optional[str] = None,
     repr: bool = True,
@@ -375,6 +393,14 @@ def Field(
     schema_extra: Optional[dict[str, Any]] = None,
 ) -> Any:
     current_schema_extra = schema_extra or {}
+
+    if regex:
+        warnings.warn(
+            REGEX_PARAM_DEPRECATION_MSG,
+            DeprecationWarning,
+            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)

tests/test_pydantic/test_field.py

@@ -56,12 +56,26 @@ class Model(SQLModel):
     assert "foo=" not in repr(instance)
 
 
-@pytest.mark.parametrize("param", ["regex", "pattern"])
-def test_field_regex_param(param: str):
+def test_field_regex_param():
+    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_field_pattern_param():
     class DateModel(SQLModel):
-        date_1: str = Field(**{param: r"^\d{2}-\d{2}-\d{4}$"})
+        date_1: str = Field(pattern=r"^\d{2}-\d{2}-\d{4}$")
+
+    DateModel(date_1="12-31-2024")
 
-    DateModel(date_1="12-31-2024")  # Validates correctly
+    with pytest.raises(ValidationError):
+        DateModel(date_1="incorrect")
 
 
 def test_field_pattern_via_schema_extra():