Skip to content

fix forward type reference in Pydantic schemas #1171

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.

Sign up for GitHub

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

Closed
wants to merge 2 commits into from
Closed

fix forward type reference in Pydantic schemas #1171

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
eb03758
fix forward type reference in Pydantic schemas
eli-bl Nov 27, 2024
3c52cac
docs
eli-bl Nov 27, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions .changeset/pydantic-cycle-fix.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
default: patch
---

# Fix for rare Pydantic error

Fixed a subtle issue with forward type references in Pydantic classes that could, in very rare cases, cause the parser to fail with the error "`Parameter` is not fully defined".
7 changes: 7 additions & 0 deletions openapi_python_client/schema/openapi_schema_pydantic/header.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,3 +29,10 @@ class Header(Parameter):
]
},
)


# Calling model_rebuild() here helps Pydantic to resolve the forward references that were used
# in defining Parameter and Encoding. Without this call, any subtle change to the loading order
# of schema submodules could result in an error like "Parameter is not fully defined".
# See: https://docs.pydantic.dev/latest/concepts/models/#rebuilding-model-schema
Parameter.model_rebuild()