Pydantic v2 support #2972

thejaminator · 2023-07-22T22:57:12Z

Description

Types of Changes

Adds initial support for pydantic V2.

This is extremely experimental for wider initial testing.

We do not encourage using this in production systems yet.

Issues Fixed or Closed by This PR

Checklist

My code follows the code style of this project.
My change requires a change to the documentation.
I have updated the documentation accordingly.
I have read the CONTRIBUTING document.
I have added tests to cover my changes.
I have tested the changes and verified that they work and don't break anything (as well as I can manage).

botberry · 2023-07-22T22:59:18Z

Thanks for adding the RELEASE.md file!

Here's a preview of the changelog:

Adds initial support for pydantic V2.

This is extremely experimental for wider initial testing.

We do not encourage using this in production systems yet.

Here's the preview release card for twitter:

Here's the tweet text:

🆕 Release (next) is out! Thanks to James Chua for the PR 👏

Get it here 👉 https://github.com/strawberry-graphql/strawberry/releases/tag/(next)

This reverts commit dc0b9dd.

codecov · 2023-07-22T23:00:02Z

Codecov Report

Merging #2972 (d78d907) into main (1cb0edb) will decrease coverage by 0.03%.
The diff coverage is 96.18%.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #2972      +/-   ##
==========================================
- Coverage   96.50%   96.47%   -0.03%     
==========================================
  Files         467      469       +2     
  Lines       29050    29144      +94     
  Branches     3570     3587      +17     
==========================================
+ Hits        28035    28117      +82     
- Misses        829      840      +11     
- Partials      186      187       +1

codspeed-hq · 2023-07-22T23:02:45Z

CodSpeed Performance Report

Merging #2972 will not alter performance

_{Comparing thejaminator:compat_folder (d78d907) with main (1cb0edb)}

Summary

✅ 12 untouched benchmarks

for more information, see https://pre-commit.ci

thejaminator · 2023-07-22T23:13:57Z

tests/experimental/pydantic/test_fields.py

-    ],
+    ]
+    if IS_PYDANTIC_V1
+    else [],


need to do this trick otherwise it will still getattr on the pydantic namespace and explode

for more information, see https://pre-commit.ci

thejaminator · 2023-07-22T23:43:24Z

strawberry/experimental/pydantic/v2_compat.py

+    allow_none: bool
+    has_alias: bool
+    description: Optional[str]
+


we have a compat file (inspired by how fastapi does it) to work with both versions

for more information, see https://pre-commit.ci

thejaminator · 2023-07-22T23:57:36Z

strawberry/ext/mypy_plugin.py

+                else:
+                    field = PydanticModelField.deserialize(
+                        info=ctx.cls.info, data=data, api=ctx.api
+                    )
                pydantic_fields.add(field)


they also change their plugin

thejaminator · 2023-07-23T00:04:34Z

pyproject.toml

@@ -112,7 +112,7 @@ channels = "^3.0.5"
 Django = ">=3.2"
 fastapi = {version = ">=0.65.0", optional = false}
 flask = ">=1.1"
-pydantic = {version = "<2", optional = false}
+pydantic = {version = ">1.6.1", optional = false}
 pytest-aiohttp = "^1.0.3"


set this back to >1.6.1 and update lock file (am I doing this right?)

for more information, see https://pre-commit.ci

thejaminator · 2023-07-23T00:24:57Z

.github/workflows/test.yml

@@ -159,6 +159,9 @@ jobs:

      - run: poetry install --with integrations
        if: steps.setup-python.outputs.cache-hit != 'true'
+      # Since we are running all the integrations at once, we can't use
+      # pydantic v2. It is not compatible with starlette yet
+      - run: poetry run pip install pydantic==1.10



errr otherwise starlette goes boom

thejaminator · 2023-07-23T00:26:45Z

/pre-release

patrick91

this looks awesome so far! I've left some minor nitpicks

I'm sure @Kludex will be proud 😉

noxfile.py

strawberry/experimental/pydantic/error_type.py

patrick91 · 2023-07-23T18:08:09Z

strawberry/experimental/pydantic/fields.py

+    get_args,
+    get_origin,
+    is_new_type,


I wonder if we should have these on our typing module?

patrick91 · 2023-07-23T18:10:11Z

strawberry/experimental/pydantic/fields.py

+Most of these fields are not supported by pydantic V2
+"""
+FIELDS_MAP = (
+    {
+        getattr(pydantic, field_name): type
+        for field_name, type in ATTR_TO_TYPE_MAP.items()
+        if hasattr(pydantic, field_name)
+    }
+    if not IS_PYDANTIC_V2
+    else {}
+)


I think quite a few are still supported, no?

will investigate further in an issue / PR because i think pydantic v2's types are just normal annotated types that should work out of the box

patrick91 · 2023-07-23T18:11:25Z

strawberry/experimental/pydantic/v2_compat.py

+IS_PYDANTIC_V2: bool = PYDANTIC_VERSION.startswith("2.")
+IS_PYDANTIC_V1: bool = not IS_PYDANTIC_V2


Suggested change

IS_PYDANTIC_V2: bool = PYDANTIC_VERSION.startswith("2.")

IS_PYDANTIC_V1: bool = not IS_PYDANTIC_V2

IS_PYDANTIC_V2: bool = PYDANTIC_VERSION.startswith("2.")

IS_PYDANTIC_V1: bool = PYDANTIC_VERSION.startswith("1.")

we might have this code until v3 :P

strawberry/experimental/pydantic/v2_compat.py

tests/experimental/pydantic/schema/test_defaults.py

tests/experimental/pydantic/test_fields.py

Co-authored-by: Patrick Arminio <[email protected]>

patrick91 · 2023-07-24T18:06:02Z

/pre-release

botberry · 2023-07-24T18:07:01Z

Pre-release

👋

Releasing commit [f17ee94] to PyPi as pre-release! 📦

botberry · 2023-07-24T18:07:12Z

Pre-release

👋

Pre-release 0.196.0.dev.1690222024 [f17ee94] has been released on PyPi! 🚀
You can try it by doing:

poetry add strawberry-graphql==0.196.0.dev.1690222024

for more information, see https://pre-commit.ci

thejaminator · 2023-07-25T04:59:54Z

.github/workflows/test.yml

      - run: |
-          poetry run pytest --cov=. --cov-append --cov-report=xml -n auto --showlocals -vv
-
+          poetry run pytest --cov=. --cov-append --cov-report=xml -n auto --showlocals --ignore tests/mypy -vv
      - name: coverage xml


ignores mypy for windows

patrick91

Let's get this out! Thanks @thejaminator <3

Mark90 · 2023-08-09T07:33:54Z

strawberry/experimental/pydantic/fields.py

@@ -25,6 +32,10 @@
        TypingGenericAlias = ()
    else:
        raise
+    if sys.version_info < (3, 10):


Hi, not sure if anyone will read this comment, but it is related to this change I believe.

On Python 3.9 I'm noticing some issues here when (indirectly) importing from this module:

from strawberry.experimental.pydantic.conversion_types import StrawberryTypeFromPydantic /usr/local/lib/python3.9/site-packages/strawberry/experimental/pydantic/__init__.py:3: in <module> from .object_type import input, interface, type /usr/local/lib/python3.9/site-packages/strawberry/experimental/pydantic/object_type.py:31: in <module> from strawberry.experimental.pydantic.fields import replace_types_recursively /usr/local/lib/python3.9/site-packages/strawberry/experimental/pydantic/fields.py: in <module> from types import UnionType as TypingUnionType E ImportError: cannot import name 'UnionType' from 'types' (/usr/local/lib/python3.9/types.py)

On Python 3.10 and 3.11 it works fine.

From reading the import handling here I think it makes sense because it seems that this is what happens for different python versions;

Python 3.8 -> ImportError on UnionType

TypingGenericAlias = ()

TypingUnionType = ()

Python 3.9 -> ImportError on UnionType

Re-raise error

Python 3.10 -> (no import error)

TypingGenericAlias = typing.GenericAlias

TypingUnionType = types.UnionType

@Mark90 this should be fixed now 😊

Great :) Thanks for notifying me!

* work so far * add modelfield * it works kinda * fix missing type * fix default tesT * skip tests for constrained types * add tests pass? * ruff * Revert "ruff" This reverts commit dc0b9dd. * make most of mypy happy * make linters and mypy happy * fix pydantic v1 import * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * remove extra ruff * fix tests for pydantic v1 * remove weird stuff ruff added * add release file * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * bump pydantic in pyproject.toml * upgrade pydantic lock file * remove unused * fix mypy * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * fix poetry * remove implicit default test * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * force pydantic 1.10 * Update noxfile.py Co-authored-by: Patrick Arminio <[email protected]> * Update tests/experimental/pydantic/schema/test_defaults.py Co-authored-by: Patrick Arminio <[email protected]> * rename v2_compat -> _compat * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * ignore mypy windows tests --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Patrick Arminio <[email protected]>

thejaminator added 9 commits May 20, 2023 17:46

work so far

ee45b97

add modelfield

70c9423

Merge remote-tracking branch 'origin/main' into compat_folder

a66452b

it works kinda

fe52908

fix missing type

356a5fb

fix default tesT

0c45267

skip tests for constrained types

37b8c2e

add tests pass?

f45d576

ruff

dc0b9dd

thejaminator mentioned this pull request Jul 22, 2023

WIP: Pydantic v2 compat #2888

Closed

11 tasks

Revert "ruff"

1171abc

This reverts commit dc0b9dd.

make most of mypy happy

43dcf1d

thejaminator force-pushed the compat_folder branch from 67feb7f to 43dcf1d Compare July 22, 2023 23:05

thejaminator added 2 commits July 22, 2023 16:08

make linters and mypy happy

969112b

fix pydantic v1 import

107ea3c

thejaminator force-pushed the compat_folder branch from c1566a0 to 107ea3c Compare July 22, 2023 23:12

[pre-commit.ci] auto fixes from pre-commit.com hooks

612a30c

for more information, see https://pre-commit.ci

thejaminator commented Jul 22, 2023

View reviewed changes

thejaminator and others added 6 commits July 22, 2023 16:16

remove extra ruff

50d71fb

fix tests for pydantic v1

e5673c1

remove weird stuff ruff added

16c674d

add release file

94d4844

[pre-commit.ci] auto fixes from pre-commit.com hooks

a116364

for more information, see https://pre-commit.ci

bump pydantic in pyproject.toml

58e2f6f

botberry added bot:has-release-file bot:release-type-minor labels Jul 22, 2023

upgrade pydantic lock file

7696efd

thejaminator commented Jul 22, 2023

View reviewed changes

remove unused

79c41d2

thejaminator changed the title ~~WIP: Pydantic v2~~ Pydantic v2 support Jul 22, 2023

thejaminator and others added 2 commits July 22, 2023 16:54

fix mypy

3b3a392

[pre-commit.ci] auto fixes from pre-commit.com hooks

817c325

for more information, see https://pre-commit.ci

thejaminator commented Jul 22, 2023

View reviewed changes

fix poetry

bfd7ac4

thejaminator commented Jul 23, 2023

View reviewed changes

thejaminator and others added 3 commits July 22, 2023 17:10

remove implicit default test

9314609

[pre-commit.ci] auto fixes from pre-commit.com hooks

af3299e

for more information, see https://pre-commit.ci

force pydantic 1.10

8cd57d9

thejaminator commented Jul 23, 2023

View reviewed changes

patrick91 reviewed Jul 23, 2023

View reviewed changes

thejaminator and others added 2 commits July 24, 2023 11:00

Update noxfile.py

eec5c8e

Co-authored-by: Patrick Arminio <[email protected]>

Update tests/experimental/pydantic/schema/test_defaults.py

f17ee94

Co-authored-by: Patrick Arminio <[email protected]>

thejaminator and others added 3 commits July 24, 2023 11:16

rename v2_compat -> _compat

5afee6b

[pre-commit.ci] auto fixes from pre-commit.com hooks

db26d26

for more information, see https://pre-commit.ci

ignore mypy windows tests

01182e2

thejaminator commented Jul 25, 2023

View reviewed changes

thejaminator mentioned this pull request Jul 25, 2023

Pydantic V2 Support #2978

Closed

Merge branch 'main' into compat_folder

d78d907

patrick91 approved these changes Aug 7, 2023

View reviewed changes

patrick91 merged commit 0737532 into strawberry-graphql:main Aug 7, 2023

Mark90 reviewed Aug 9, 2023

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Pydantic v2 support #2972

Pydantic v2 support #2972

thejaminator commented Jul 22, 2023 •

edited

Loading

botberry commented Jul 22, 2023 •

edited

Loading

codecov bot commented Jul 22, 2023 •

edited

Loading

codspeed-hq bot commented Jul 22, 2023 •

edited

Loading

thejaminator Jul 22, 2023

thejaminator Jul 22, 2023

thejaminator Jul 22, 2023

thejaminator Jul 23, 2023 •

edited

Loading

thejaminator Jul 23, 2023

thejaminator commented Jul 23, 2023

patrick91 left a comment

patrick91 Jul 23, 2023

patrick91 Jul 23, 2023

thejaminator Jul 24, 2023

patrick91 Jul 23, 2023

patrick91 commented Jul 24, 2023

botberry commented Jul 24, 2023

botberry commented Jul 24, 2023

thejaminator Jul 25, 2023

patrick91 left a comment

Mark90 Aug 9, 2023 •

edited

Loading

patrick91 Aug 9, 2023

Mark90 Aug 9, 2023

		IS_PYDANTIC_V2: bool = PYDANTIC_VERSION.startswith("2.")
		IS_PYDANTIC_V1: bool = not IS_PYDANTIC_V2

Pydantic v2 support #2972

Pydantic v2 support #2972

Conversation

thejaminator commented Jul 22, 2023 • edited Loading

Description

Types of Changes

Issues Fixed or Closed by This PR

Checklist

botberry commented Jul 22, 2023 • edited Loading

codecov bot commented Jul 22, 2023 • edited Loading

Codecov Report

codspeed-hq bot commented Jul 22, 2023 • edited Loading

Merging #2972 will not alter performance

Summary

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

thejaminator Jul 23, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

thejaminator commented Jul 23, 2023

patrick91 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

patrick91 commented Jul 24, 2023

botberry commented Jul 24, 2023

Pre-release

botberry commented Jul 24, 2023

Pre-release

Choose a reason for hiding this comment

patrick91 left a comment

Choose a reason for hiding this comment

Mark90 Aug 9, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

thejaminator commented Jul 22, 2023 •

edited

Loading

botberry commented Jul 22, 2023 •

edited

Loading

codecov bot commented Jul 22, 2023 •

edited

Loading

codspeed-hq bot commented Jul 22, 2023 •

edited

Loading

thejaminator Jul 23, 2023 •

edited

Loading

Mark90 Aug 9, 2023 •

edited

Loading