Repository navigation
Support Pydantic v1 field metadata - #901
Open
cristianchiriac wants to merge 2 commits into
Open
cristianchiriac wants to merge 2 commits into
cristianchiriac wants to merge 2 commits into
Conversation
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
pdoc assumes every Pydantic model exposes the v2
__pydantic_fields__metadata. On Pydantic v1, rendering a model raisesAttributeError. Read__fields__when v2 metadata is absent, including field defaults and descriptions, while keeping the v2 computed-field path unchanged.Fixes #864.
Tests
ruff check .: passed.mypy pdoc test: two existing errors in unchangedtest/testdata/misc_py313.pyandpdoc/doc_ast.pyon Python 3.12; no new errors from this change.