Skip to content
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.

Sign up for GitHub

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

fix: pydantic 2.10.x breaking change #1095

Merged
merged 8 commits into from
Jan 2, 2025
Merged

fix: pydantic 2.10.x breaking change #1095

Show file tree
Hide file tree
Changes from 6 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
4f423b6
fix: breaking change with pydantic 2.10.x
mdaffad Dec 24, 2024
fc2b38a
chore: test on gha
mdaffad Dec 24, 2024
ee11cd9
fix: unify python and json validator schema
mdaffad Dec 27, 2024
b045335
Merge branch 'main' of github.com:mdaffad/beanie into fix-pydantic-2.…
mdaffad Dec 27, 2024
848d14c
fix: revert version checking logic
mdaffad Dec 28, 2024
ce4ab1f
fix: drop on push event on github actions
mdaffad Dec 28, 2024
ae0d0a7
fix: marker logic for pydantic v2.10
mdaffad Dec 28, 2024
04bdc8d
fix: add test pydantic 2.10.4
mdaffad Dec 28, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion .github/workflows/github-actions-tests.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
name: Tests
on: [ pull_request ]
on:
pull_request:

jobs:
pre-commit:
Expand Down
18 changes: 15 additions & 3 deletions beanie/odm/fields.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@
from beanie.odm.utils.parsing import parse_obj
from beanie.odm.utils.pydantic import (
IS_PYDANTIC_V2,
IS_PYDANTIC_V2_10,
get_field_type,
get_model_fields,
parse_object_as,
Expand Down Expand Up @@ -147,9 +148,8 @@ def _validate(cls, v):
def __get_pydantic_core_schema__(
cls, source_type: Type[Any], handler: GetCoreSchemaHandler
) -> CoreSchema:
return json_or_python_schema(
python_schema=no_info_plain_validator_function(cls._validate),
json_schema=no_info_plain_validator_function(
if not IS_PYDANTIC_V2_10:
return no_info_plain_validator_function(
cls._validate,
metadata={
"pydantic_js_input_core_schema": str_schema(
Expand All @@ -158,6 +158,18 @@ def __get_pydantic_core_schema__(
max_length=24,
)
},
serialization=plain_serializer_function_ser_schema(
lambda instance: str(instance),
return_schema=str_schema(),
when_used="json",
),
)
return no_info_plain_validator_function(
cls._validate,
json_schema_input_schema=str_schema(
pattern="^[0-9a-f]{24}$",
min_length=24,
max_length=24,
),
serialization=plain_serializer_function_ser_schema(
lambda instance: str(instance),
Expand Down
11 changes: 10 additions & 1 deletion beanie/odm/utils/encoder.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,11 @@

import beanie
from beanie.odm.fields import Link, LinkTypes
from beanie.odm.utils.pydantic import IS_PYDANTIC_V2, get_model_fields
from beanie.odm.utils.pydantic import (
IS_PYDANTIC_V2,
IS_PYDANTIC_V2_10,
get_model_fields,
)

SingleArgCallable = Callable[[Any], Any]
DEFAULT_CUSTOM_ENCODERS: MutableMapping[type, SingleArgCallable] = {
Expand All @@ -51,6 +55,11 @@

DEFAULT_CUSTOM_ENCODERS[Url] = str

if IS_PYDANTIC_V2_10:
from pydantic import AnyUrl

DEFAULT_CUSTOM_ENCODERS[AnyUrl] = str

BSON_SCALAR_TYPES = (
type(None),
str,
Expand Down
3 changes: 3 additions & 0 deletions beanie/odm/utils/pydantic.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@
from pydantic import BaseModel

IS_PYDANTIC_V2 = int(pydantic.VERSION.split(".")[0]) >= 2
IS_PYDANTIC_V2_10 = (
IS_PYDANTIC_V2 and int(pydantic.VERSION.split(".")[1]) >= 10
) or int(pydantic.VERSION.split(".")[0]) > 2
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would remove this "or" part. Any other major Pydantic version would not necessarily be compatible with Beanie and I think we should not bet on this.
Lets make this check do what it says in the name, to explicitly check for Pydantic v2.10.x (or above, constrained to v2).


if IS_PYDANTIC_V2:
from pydantic import TypeAdapter
Expand Down
Loading