Error parsing root validators

[mansenfranzen]

Error parsing root validators

[mansenfranzen]

It got fixed with version 1.5.0 #51. Feel free to reopen if the issue still persists on your site.

[mansenfranzen]

@goroderickgo thanks for reporting the bug and the detailed report! Can you provide a minimal example of your pydantic model that causes the error, please? That would be great otherwise I'm having trouble to reproduce it. Additionally, can you check what pydantic version you are using? It could be related to a change in how pydantic stores and manages root validators.

[goroderickgo]

OK! It will take me a couple days to get to this, but it's on my to-do list

[mansenfranzen]

I was able to identify the bug. Root validators come in two flavors via pre=True and pre=False. The default is pre=False which works just fine. However, the former using pre=True causes the error you've been experiencing. Hence, the following does currently not work with pydantic==1.8.2 and sphinx==4.2.0:

from pydantic import BaseModel, root_validator


class ExampleValidators(BaseModel):
    foobar: str

    @root_validator(pre=True)
    def validate_something(cls, values):
        return values

The fix is actually rather simple and will be included in the upcoming 1.5.0 release which will happen very soonish.

[mansenfranzen]

@goroderickgo PR #51 addresses your issue, among other things.

Before merging the related PR, it would be great if you could test the bug fix on your site to confirm that my test case did indeed capture the incorrect behavior which you've encountered. To do so, please install the current dev release in your doc-building-environment via pip install git+git://github.com/mansenfranzen/[email protected] and rebuild your docs.

[mansenfranzen]

@all-contributors please add @goroderickgo for tests

[allcontributors]

@mansenfranzen

I've put up a pull request to add @goroderickgo! 🎉

[goroderickgo]

Thanks (and sorry I didn't get to posting more help before you made the fix)! Looks like the update here does fix the issue for me!