Skip to content

Commit

Permalink
Add support re.Pattern[str] to pattern field (#9053)
Browse files Browse the repository at this point in the history
Co-authored-by: Jag_k <jag-k@users.noreply.github.com>
  • Loading branch information
jag-k and jag-k committed Mar 25, 2024
1 parent ac9e6ee commit 00c7815
Show file tree
Hide file tree
Showing 3 changed files with 62 additions and 5 deletions.
7 changes: 5 additions & 2 deletions pydantic/fields.py
Expand Up @@ -64,7 +64,7 @@ class _FromFieldInfoInputs(typing_extensions.TypedDict, total=False):
strict: bool | None
min_length: int | None
max_length: int | None
pattern: str | None
pattern: str | typing.Pattern[str] | None
allow_inf_nan: bool | None
max_digits: int | None
decimal_places: int | None
Expand Down Expand Up @@ -680,7 +680,7 @@ def Field( # noqa: C901
init: bool | None = _Unset,
init_var: bool | None = _Unset,
kw_only: bool | None = _Unset,
pattern: str | None = _Unset,
pattern: str | typing.Pattern[str] | None = _Unset,
strict: bool | None = _Unset,
gt: float | None = _Unset,
ge: float | None = _Unset,
Expand Down Expand Up @@ -792,6 +792,9 @@ def Field( # noqa: C901
if regex is not None:
raise PydanticUserError('`regex` is removed. use `pattern` instead', code='removed-kwargs')

if isinstance(pattern, typing.Pattern):
pattern = pattern.pattern

if extra:
warn(
'Using extra keyword arguments on `Field` is deprecated and will be removed.'
Expand Down
7 changes: 4 additions & 3 deletions pydantic/types.py
Expand Up @@ -20,6 +20,7 @@
Hashable,
Iterator,
List,
Pattern,
Set,
TypeVar,
Union,
Expand Down Expand Up @@ -696,7 +697,7 @@ class StringConstraints(annotated_types.GroupedMetadata):
strict: bool | None = None
min_length: int | None = None
max_length: int | None = None
pattern: str | None = None
pattern: str | Pattern[str] | None = None

def __iter__(self) -> Iterator[BaseMetadata]:
if self.min_length is not None:
Expand All @@ -715,7 +716,7 @@ def __iter__(self) -> Iterator[BaseMetadata]:
strip_whitespace=self.strip_whitespace,
to_upper=self.to_upper,
to_lower=self.to_lower,
pattern=self.pattern,
pattern=self.pattern.pattern if isinstance(self.pattern, Pattern) else self.pattern,
)


Expand All @@ -727,7 +728,7 @@ def constr(
strict: bool | None = None,
min_length: int | None = None,
max_length: int | None = None,
pattern: str | None = None,
pattern: str | Pattern[str] | None = None,
) -> type[str]:
"""
!!! warning "Discouraged"
Expand Down
53 changes: 53 additions & 0 deletions tests/test_types.py
Expand Up @@ -3965,6 +3965,59 @@ class Foobar(BaseModel):
}


@pytest.mark.parametrize(
'use_field',
[pytest.param(True, id='Field'), pytest.param(False, id='constr')],
)
def test_compiled_pattern_in_field(use_field):
"""
https://github.com/pydantic/pydantic/issues/9052
https://github.com/pydantic/pydantic/pull/9053
"""
pattern_value = r'^whatev.r\d$'
field_pattern = re.compile(pattern_value)

if use_field:

class Foobar(BaseModel):
str_regex: str = Field(..., pattern=field_pattern)
else:

class Foobar(BaseModel):
str_regex: constr(pattern=field_pattern) = ...

field_general_metadata = Foobar.model_fields['str_regex'].metadata
assert len(field_general_metadata) == 1
field_metadata_pattern = field_general_metadata[0].pattern

if use_field:
# In Field re.Pattern is converted to str instantly
assert field_metadata_pattern == pattern_value
assert isinstance(field_metadata_pattern, str)

else:
# In constr re.Pattern is kept as is
assert field_metadata_pattern == field_pattern
assert isinstance(field_metadata_pattern, re.Pattern)

matching_value = 'whatever1'
f = Foobar(str_regex=matching_value)
assert f.str_regex == matching_value

with pytest.raises(
ValidationError,
match=re.escape("String should match pattern '" + pattern_value + "'"),
):
Foobar(str_regex=' whatever1')

assert Foobar.model_json_schema() == {
'type': 'object',
'title': 'Foobar',
'properties': {'str_regex': {'pattern': pattern_value, 'title': 'Str Regex', 'type': 'string'}},
'required': ['str_regex'],
}


def test_pattern_with_invalid_param():
with pytest.raises(
PydanticSchemaGenerationError,
Expand Down

0 comments on commit 00c7815

Please sign in to comment.