pydantic v2 #160

awoimbee · 2023-07-06T08:36:55Z

I may not have the time to complete this PR, feel free to create a new one using this one as inspiration/base !

update minimum python version according to pydantic/pydantic#6426

sphinx 4 was released in 2021

mansenfranzen · 2023-07-06T20:12:35Z

thanks for the PR draft!

I have not run any tests yet but the changes look rather minor and yet promising so far. I hope to get some time off to make progress with the pydantic v2 support. I'm happy for any more contribution :-).

Greetings

Galarzaa90 · 2023-07-12T21:57:01Z

I tried to check this out, I ran all unit tests, they were okay.

But I couldn't build the docs to test that. Had a hard time with graphviz (on Windows)

mansenfranzen · 2023-07-20T15:18:47Z

@awoimbee Thanks so much for continuing your work on this PR!

I will have some time the next days to support you. Could you allow me to push on your branch? I just tried but I don't seem to have permissions.

awoimbee · 2023-07-20T15:41:48Z

Just sent you an invite to the fork, don't hesitate to push commits !
Maybe you'll be able to make some stuff to work that I could not get to (like PydanticConfigClassDocumenter with the new model_config, so I just removed it).

`field1 : Optional[int]` is no longer optional but required in v2.

mansenfranzen · 2023-07-20T16:04:14Z

It works, I can push now.

Regarding PydanticConfigClassDocumenter: This was an exotic feature and as far as I can see, it is not even needed by the model/settings documenter. Hence, since there are many changes for v2, I suggest to remove it to reduce complexity and maintenance costs.

mansenfranzen · 2023-07-20T16:07:12Z

pyproject.toml

-python = ">=3.7.1,<4.0.0"
-Sphinx = ">=3.4"
-pydantic = ">=1.5,<2.0.0"
+python = ">=3.8.0,<4.0.0"


@awoimbee Was there a specific reason to remove support for python 3.7? It is EOL by June 2023, however I would like to keep backwards compatibility if possible.

I thought pydantic would remove py37 support after seeing pydantic/pydantic#6426 but they fixed the issue. I'll add py37 back, there is a workaround needed around importlib_metadata -> importlib.metadata

PriOliveira

I was taking a look at the changes, even though I know it is still a draft, hopefully you don't mind for the comments about some stuff I found along the way

Also in the end the README will also need to be updated, for example:

Supports pydantic >= 1.5.0, < 2.0.0 and sphinx >= 3.4.0

PriOliveira · 2023-07-20T16:51:11Z

docs/source/users/examples.rst

@@ -153,7 +153,7 @@ Asterisk and root validators
 ----------------------------

 This example highlights how `asterisk <https://pydantic-docs.helpmanual.io/usage/validators/#pre-and-per-item-validators>`_
-(``@validator('*')``) and `root validators <https://pydantic-docs.helpmanual.io/usage/validators/#root-validators>`_ (``@root_validator``)
+(``@field_validator('*')``) and `root validators <https://pydantic-docs.helpmanual.io/usage/validators/#root-validators>`_ (``@root_validator``)


Root validator is deprecated

Suggested change

(``@field_validator('*')``) and `root validators <https://pydantic-docs.helpmanual.io/usage/validators/#root-validators>`_ (``@root_validator``)

(``@field_validator('*')``) and `model validators <https://docs.pydantic.dev/latest/usage/validators/#model-validators>`_ (``@model_validator``)

PriOliveira · 2023-07-20T16:57:19Z

sphinxcontrib/autodoc_pydantic/inspection.py

+        self.attribute: Dict[str, Decorator[ValidatorDecoratorInfo]] = dict(
+            **self.model.__pydantic_decorators__.validators,
+            **self.model.__pydantic_decorators__.field_validators,
+            **self.model.__pydantic_decorators__.root_validators


Since root_validator got deprecated, probably this should be also updated

PriOliveira · 2023-07-20T17:08:15Z

sphinxcontrib/autodoc_pydantic/inspection.py

-            mapping["*"].append(ValidatorAdapter(func=func,
-                                                 root_post=True))
+        # root validators
+        for validator in model_decorators.root_validators.values():


Suggested change

for validator in model_decorators.root_validators.values():

for validator in model_decorators.model_validators.values():

PriOliveira · 2023-07-20T17:09:18Z

tests/roots/test-base/target/configuration.py

@@ -1,6 +1,7 @@
 from typing import Optional

-from pydantic import BaseModel, validator, Field, BaseSettings, root_validator
+from pydantic import BaseModel, field_validator, Field, model_validator, ConfigDict, root_validator


Suggested change

from pydantic import BaseModel, field_validator, Field, model_validator, ConfigDict, root_validator

from pydantic import BaseModel, field_validator, Field, model_validator, ConfigDict

PriOliveira · 2023-07-20T17:11:51Z

tests/roots/test-base/target/configuration.py

    def check(cls, v):
        """Check."""
        return v

-    @root_validator
+    @root_validator(skip_on_failure=True)


Suggested change

@root_validator(skip_on_failure=True)

@model_validator

PriOliveira · 2023-07-20T17:15:46Z

tests/roots/test-base/target/example_generics.py

@@ -24,7 +24,7 @@ class Response(GenericModel, Generic[DataT]):
    data: Optional[DataT]
    error: Optional[Error]

-    @validator('error', always=True)
+    @field_validator('error', always=True)


By the migration docs, it seems field_validator doesn't have always anymore, but I couldn't find what would be equivalent

PriOliveira · 2023-07-20T17:18:31Z

tests/roots/test-base/target/example_validators.py

@@ -1,4 +1,4 @@
-from pydantic import BaseModel, validator, root_validator
+from pydantic import BaseModel, field_validator, root_validator


Suggested change

from pydantic import BaseModel, field_validator, root_validator

from pydantic import BaseModel, field_validator, model_validator

PriOliveira · 2023-07-20T17:19:48Z

tests/roots/test-base/target/usage_autosummary.py

-        env_prefix = "foo_"
-        allow_mutation = True
-
+    model_config = ConfigDict(frozen=False)


Suggested change

model_config = ConfigDict(frozen=False)

model_config = SettingsConfigDict(env_prefix="foo_", frozen=False)

PriOliveira · 2023-07-20T17:21:51Z

tests/roots/test-events-add-css-fallback/add_css_fallback.py

-        """Dummy DocString"""
-        env_prefix = "foo_"
-        allow_mutation = True
+    model_config = ConfigDict(frozen=False)


Suggested change

model_config = ConfigDict(frozen=False)

model_config = SettingsConfigDict(env_prefix="foo_", frozen=False)

mansenfranzen · 2023-07-21T10:39:36Z

I was taking a look at the changes, even though I know it is still a draft, hopefully you don't mind for the comments about some stuff I found along the way

Also in the end the README will also need to be updated, for example:

Supports pydantic >= 1.5.0, < 2.0.0 and sphinx >= 3.4.0

Thanks @PriOliveira - all comments are more than appreciated.

codecov-commenter · 2023-07-22T14:09:52Z

Codecov Report

Patch coverage has no change and project coverage change: -96.55 ⚠️

Comparison is base (bc07bf3) 96.54% compared to head (d6ef69f) 0.00%.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #160       +/-   ##
==========================================
- Coverage   96.54%   0.00%   -96.55%     
==========================================
  Files          12      12               
  Lines        1071    1040       -31     
==========================================
- Hits         1034       0     -1034     
- Misses         37    1040     +1003

Impacted Files	Coverage Δ
sphinxcontrib/autodoc_pydantic/__init__.py	`0.00% <0.00%> (-100.00%)`	⬇️
...rib/autodoc_pydantic/directives/autodocumenters.py	`0.00% <0.00%> (-98.13%)`	⬇️
...xcontrib/autodoc_pydantic/directives/directives.py	`0.00% <ø> (-98.24%)`	⬇️
.../autodoc_pydantic/directives/options/definition.py	`0.00% <ø> (-100.00%)`	⬇️
sphinxcontrib/autodoc_pydantic/events.py	`0.00% <ø> (-100.00%)`	⬇️
sphinxcontrib/autodoc_pydantic/inspection.py	`0.00% <0.00%> (-98.70%)`	⬇️

... and 6 files with indirect coverage changes

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

mansenfranzen · 2023-07-22T14:45:05Z

I'm going merge this PR into the new "main-2.x" branch even though it is still WIP. Almost all tests have passed now. I will generate the new docs based on pydantic v2 which help to further improve the docs and update outdated information.

awoimbee added 7 commits July 6, 2023 09:05

update pydantic dep

b56fe0a

update minimum python version according to pydantic/pydantic#6426

poetry lock

ffd7fbb

up sphinx default to 4

6785aa6

sphinx 4 was released in 2021

poetry lock

40111d7

pyproject: add pydantic-settings

ecf9486

ock

84d3493

pydantic v2 early compat

cb9c3d8

yfukai mentioned this pull request Jul 9, 2023

Autosegmentation peng-lab/BaSiCPy#130

Merged

awoimbee and others added 3 commits July 13, 2023 00:26

no import error, limited warnings

caa1401

more tests passing

786b84b

Remove poetry.lock

c22c76d

Order of constraints is now alphabetical in v2.

0582abe

Franz Wöllert added 2 commits July 20, 2023 17:42

Fix ignore additional kwargs in Field for v2.

b7e02fd

Adapt to changed behavior of optional/required field values.

c905902

`field1 : Optional[int]` is no longer optional but required in v2.

mansenfranzen temporarily deployed to ci July 20, 2023 15:59 — with GitHub Actions Inactive

mansenfranzen temporarily deployed to CI July 20, 2023 15:59 — with GitHub Actions Inactive

mansenfranzen reviewed Jul 20, 2023

View reviewed changes

PriOliveira reviewed Jul 20, 2023

View reviewed changes

Franz Wöllert added 3 commits July 21, 2023 14:53

Add Optional[int] as required field in v2.

2233774

Change None to PydanticUndefined to due changed semantics in v2.

9a90075

Respect order of parameters in ConfigDict.

869c382

mansenfranzen temporarily deployed to CI July 21, 2023 13:07 — with GitHub Actions Inactive

mansenfranzen temporarily deployed to CI July 22, 2023 12:08 — with GitHub Actions Inactive

mansenfranzen temporarily deployed to ci July 22, 2023 12:09 — with GitHub Actions Inactive

mansenfranzen temporarily deployed to CI July 22, 2023 12:09 — with GitHub Actions Inactive

Franz Wöllert added 8 commits July 22, 2023 14:21

Update test matrix for latest features versions.

d57cfd4

Fix sphinx version dependant type annotation.

1ab16b3

Remove erdantic version number from test.

71ccfc7

Allow python 3.7.1. Bump version to 2.0.0.

1c04090

Add separate test for JSON warning/coerce.

19ba844

Catch PydanticInvalidForJsonSchema in v2.

ff6b73d

Move schema generation after error checks.

881f50f

Remove reference to config documenter.

17ea809

mansenfranzen temporarily deployed to CI July 22, 2023 14:08 — with GitHub Actions Inactive

mansenfranzen temporarily deployed to ci July 22, 2023 14:08 — with GitHub Actions Inactive

mansenfranzen temporarily deployed to CI July 22, 2023 14:08 — with GitHub Actions Inactive

mansenfranzen temporarily deployed to ci July 22, 2023 14:08 — with GitHub Actions Inactive

Bump version - ci skip.

d6ef69f

mansenfranzen temporarily deployed to CI July 22, 2023 14:29 — with GitHub Actions Inactive

mansenfranzen temporarily deployed to ci July 22, 2023 14:29 — with GitHub Actions Inactive

mansenfranzen changed the base branch from main to main-2.x July 22, 2023 14:41

mansenfranzen marked this pull request as ready for review July 22, 2023 14:42

mansenfranzen self-assigned this Jul 22, 2023

mansenfranzen added documentation Improvements or additions to documentation enhancement New feature or request help wanted Extra attention is needed labels Jul 22, 2023

mansenfranzen merged commit c0b011a into mansenfranzen:main-2.x Jul 22, 2023
7 of 11 checks passed

mansenfranzen mentioned this pull request Jul 23, 2023

Support pydantic v2 & test on pre-releases? #146

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

pydantic v2 #160

pydantic v2 #160

awoimbee commented Jul 6, 2023

mansenfranzen commented Jul 6, 2023

Galarzaa90 commented Jul 12, 2023

mansenfranzen commented Jul 20, 2023

awoimbee commented Jul 20, 2023

mansenfranzen commented Jul 20, 2023

mansenfranzen Jul 20, 2023 •

edited

Loading

awoimbee Jul 20, 2023

PriOliveira left a comment •

edited

Loading

PriOliveira Jul 20, 2023

PriOliveira Jul 20, 2023

PriOliveira Jul 20, 2023

PriOliveira Jul 20, 2023

PriOliveira Jul 20, 2023

PriOliveira Jul 20, 2023

PriOliveira Jul 20, 2023

PriOliveira Jul 20, 2023

PriOliveira Jul 20, 2023

mansenfranzen commented Jul 21, 2023

codecov-commenter commented Jul 22, 2023 •

edited

Loading

mansenfranzen commented Jul 22, 2023

	(``@field_validator('*')``) and `root validators <https://pydantic-docs.helpmanual.io/usage/validators/#root-validators>`_ (``@root_validator``)
	(``@field_validator('*')``) and `model validators <https://docs.pydantic.dev/latest/usage/validators/#model-validators>`_ (``@model_validator``)

	for validator in model_decorators.root_validators.values():
	for validator in model_decorators.model_validators.values():

	from pydantic import BaseModel, field_validator, Field, model_validator, ConfigDict, root_validator
	from pydantic import BaseModel, field_validator, Field, model_validator, ConfigDict

		@@ -1,4 +1,4 @@
		from pydantic import BaseModel, validator, root_validator
		from pydantic import BaseModel, field_validator, root_validator

	model_config = ConfigDict(frozen=False)
	model_config = SettingsConfigDict(env_prefix="foo_", frozen=False)

pydantic v2 #160

pydantic v2 #160

Conversation

awoimbee commented Jul 6, 2023

mansenfranzen commented Jul 6, 2023

Galarzaa90 commented Jul 12, 2023

mansenfranzen commented Jul 20, 2023

awoimbee commented Jul 20, 2023

mansenfranzen commented Jul 20, 2023

mansenfranzen Jul 20, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

PriOliveira left a comment • edited Loading

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

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

mansenfranzen commented Jul 21, 2023

codecov-commenter commented Jul 22, 2023 • edited Loading

Codecov Report

mansenfranzen commented Jul 22, 2023

mansenfranzen Jul 20, 2023 •

edited

Loading

PriOliveira left a comment •

edited

Loading

codecov-commenter commented Jul 22, 2023 •

edited

Loading