sqlmodel/main.py

            
                      Original file line number
                      Diff line number
                      Diff line change
                  
    @@ -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,11 @@ 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,

        primary_key: Union[bool, UndefinedType] = Undefined,

    @@ -270,7 +280,11 @@ 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,

        primary_key: Union[bool, UndefinedType] = Undefined,

    @@ -322,7 +336,11 @@ 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,

        sa_column: Union[Column[Any], UndefinedType] = Undefined,

    @@ -355,7 +373,11 @@ 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,

        primary_key: Union[bool, UndefinedType] = Undefined,

    @@ -371,9 +393,19 @@ 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)

        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,

    @@ -394,7 +426,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

-Original file line number
+Diff line change
@@ Expand Up / @@ -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")

✨ Support `pattern` parameter #1231

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open

stickm4n wants to merge 15 commits into fastapi:main from stickm4n:main

+72 −5

-Original file line number
+Diff line change
@@ Expand Up / @@ -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")

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

✨ Support `pattern` parameter #1231

Diff view

Diff view

There are no files selected for viewing

Uh oh!

✨ Support pattern parameter #1231

Are you sure you want to change the base?

✨ Support pattern parameter #1231

Uh oh!

Uh oh!

Diff view

Diff view

There are no files selected for viewing

✨ Support `pattern` parameter #1231

✨ Support `pattern` parameter #1231