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.

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

👽️ Support Pydantic version 2.10 #1215

Draft
wants to merge 3 commits into
base: main
Choose a base branch
from
Draft

👽️ Support Pydantic version 2.10 #1215

wants to merge 3 commits into from

Conversation

mtr
Copy link

@mtr mtr commented Nov 15, 2024

Without this fix, any SQLModel-based model with table=True and a Field that sets default_factory=... will brake with the following error message: ValueError: 'validated_data' must be provided if 'call_default_factory' is True.

To reproduce, before this fix is applied:

  • Install all project dependencies, then upgrade Pydantic:

    pip install -r requirements.txt
    pip install pydantic==2.10.0b2
  • Run the test suite:

    python -m pytest tests

… which will give the following output:

[…]
=================================================================== short test summary info ====================================================================
FAILED tests/test_annotated_uuid.py::test_annotated_optional_types - ValueError: 'validated_data' must be provided if 'call_default_factory' is True.
FAILED tests/test_advanced/test_uuid/test_tutorial001.py::test_tutorial - ValueError: 'validated_data' must be provided if 'call_default_factory' is True.
FAILED tests/test_advanced/test_uuid/test_tutorial001_py310.py::test_tutorial - ValueError: 'validated_data' must be provided if 'call_default_factory' is True.
FAILED tests/test_advanced/test_uuid/test_tutorial002.py::test_tutorial - ValueError: 'validated_data' must be provided if 'call_default_factory' is True.
FAILED tests/test_advanced/test_uuid/test_tutorial002_py310.py::test_tutorial - ValueError: 'validated_data' must be provided if 'call_default_factory' is True.
===================================================== 5 failed, 250 passed, 3 skipped, 7 warnings in 9.37s =====================================================

mtr added 2 commits November 15, 2024 10:39
Without this fix, any SQLModel-based model with `table=True` and a `Field` that sets `default_factory=...` will brake with the following error message: `ValueError: 'validated_data' must be provided if 'call_default_factory' is True.`
Without this fix, any SQLModels with a `Field` that uses `default_factory=...` will brake with the following error message: `ValueError: 'validated_data' must be provided if 'call_default_factory' is True`.

Made the fix backwards compatible.
@Viicos
Copy link

Viicos commented Nov 26, 2024

Note that we added a quick fix in 2.10.1 to not raise the error. But indeed, SQLModel should support default factories taking a validated_data argument.

The BaseModel.model_construct implementation was updated to take into account this feature, so it might be good looking at how we did it. Might be good looking at the other fixes that were introduced since then (e.g. pydantic/pydantic#9223).

(I'll also note that having SQModel relying so much on Pydantic is a bit scary, but well..)

@svlandeg svlandeg changed the title Support upcoming changes in Pydantic version 2.10 👽️ Support Pydantic version 2.10 Feb 20, 2025
Copy link
Member

@svlandeg svlandeg left a comment

Choose a reason for hiding this comment

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

Hi @mtr, thanks for the contribution!

It looks like this PR was made from https://github.com/encount/sqlmodel/tree/main and I can't push to that branch to make this PR up-to-date with the latest changes in the CI. Would you be able to change those permissions? Typically, maintainers of a repo should be allowed push access on a PR for the reviewing process to go more smoothly. Thanks!

Just FYI - you should see a box like this on your right hand side of the PR screen:

image

@svlandeg svlandeg added the bug Something isn't working label Feb 24, 2025
@svlandeg svlandeg marked this pull request as draft February 24, 2025 10:40
@mtr
Copy link
Author

mtr commented Feb 24, 2025

Hi, @svlandeg.

Where can I find that setting that you showed an image of? I didn't find it, but ran a quick (automatic) sync with upstream repo. Hope that helps in the meantime.

@svlandeg
Copy link
Member

svlandeg commented Feb 28, 2025

@mtr: it should be on the right-hand side of the main PR screen, below the sections "Milestone", "Development" and "participants" (you can ctrl-F those). If you don't see such a box, that may be because this PR was created from the fork over at https://github.com/encount/sqlmodel/. I'm not sure how to fix things if that's the case - usually users create PRs from their own forks 🤔

Comment on lines +85 to +87
PYDANCTIC_FIELD_GET_DEFAULT_REQUIRES_VALIDATED_DATA = (
"validated_data" in inspect.signature(FieldInfo.get_default).parameters
)
Copy link

@Viicos Viicos Feb 28, 2025

Choose a reason for hiding this comment

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

Can't a version check be done instead? I think it would clearer with a comment:

Suggested change
PYDANCTIC_FIELD_GET_DEFAULT_REQUIRES_VALIDATED_DATA = (
"validated_data" in inspect.signature(FieldInfo.get_default).parameters
)
# Pydantic 2.10 added support for default factories taking validated data:
PYDANCTIC_FIELD_GET_DEFAULT_REQUIRES_VALIDATED_DATA = IS_PYDANTIC_210

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants