[python] preserve public model field names - #24131
Merged
wing328 merged 2 commits intoJul 13, 2026
Merged
Conversation
tamird
force-pushed
the
upstream/python-model-public-names
branch
2 times, most recently
from
June 25, 2026 19:19
aa81213 to
1105d36
Compare
tamird
marked this pull request as ready for review
June 25, 2026 19:32
Contributor
Author
|
GitHub does not permit me to request reviews directly in this repository. @fa0311, could you review the Pydantic validation and post-definition @wing328, could you review the Python generator scope and generated-sample |
![cubic-dev-ai[bot]](https://avatars.githubusercontent.com/in/1082092?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
No issues found across 29 files
Tip: cubic can generate docs of your entire codebase and keep them up to date. Try it here.
Re-trigger cubic
tamird
force-pushed
the
upstream/python-model-public-names
branch
3 times, most recently
from
June 26, 2026 00:21
2aaafa2 to
8f41390
Compare
Member
|
thanks for the PR moving forward please cc @cbornet (2017/09) @tomplus (2018/10) @krjakbrjak (2023/02) @fa0311 (2023/10) (python technical committee) |
tamird
force-pushed
the
upstream/python-model-public-names
branch
from
June 26, 2026 11:16
8f41390 to
6ad994f
Compare
Contributor
Author
|
Will do. |
tamird
force-pushed
the
upstream/python-model-public-names
branch
from
June 30, 2026 09:20
6ad994f to
6126d40
Compare
tamird
force-pushed
the
upstream/python-model-public-names
branch
from
July 13, 2026 14:50
6126d40 to
5457355
Compare
Contributor
Author
|
Resolved the merge conflict with #24129. Would appreciate a review! |
tamird
force-pushed
the
upstream/python-model-public-names
branch
from
July 13, 2026 16:35
5457355 to
fdedc98
Compare
nameMappings currently become Pydantic storage names. Mappings such as continue=_continue therefore generate models that cannot import, while mappings that collide with model imports or members can shadow them. Keep OpenAPI wire names, requested public names, and collision-free Pydantic storage names separate. Accept wire or public input, reject payloads containing both, serialize wire names, and expose requested names through forwarding properties. Reject cross-field collisions across generated inheritance hierarchies and collisions with known generated and Pydantic 2.11 members before generation. Install forwarding properties after model definitions and postponed model rebuilds, preserving the Pydantic 2.11 minimum. Models without explicit nameMappings retain existing generation. Normalized storage names remain real Pydantic fields and are observable through attribute access and assignment, introspection, unaliased dumps, and attribute-based validation. Mapping inputs, requests, responses, and generated API surfaces use wire or public names instead. oneOf and anyOf wrapper models retain their existing behavior.
Regenerate the modern Python petstore clients after separating wire, public, and storage names. The fixtures cover leading-underscore names, Pydantic and generated-member collisions, import names, and inherited fields while retaining the Pydantic 2.11 minimum.
tamird
force-pushed
the
upstream/python-model-public-names
branch
from
July 13, 2026 17:04
fdedc98 to
48180dc
Compare
Member
|
no question/feedback from anyone. i think we can give it a try thanks for the PR |
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
2 participants
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.
nameMappingscurrently become Pydantic storage names. A mapping suchas
continue=_continuetherefore generates a model that cannot beimported, while mappings that collide with model imports or members can
shadow them.
Keep OpenAPI wire names, requested public names, and collision-free
Pydantic storage names separate. Accept either wire or public input and
reject payloads containing both instead of assigning silent precedence.
Serialize wire names and expose requested names through forwarding
properties. Reject cross-field collisions across generated inheritance
hierarchies and collisions with known generated and Pydantic 2.11
members before generation.
Install forwarding properties after model definitions and postponed
model rebuilds, preserving the Pydantic 2.11 minimum. The
schemamapping remains an explicit exception because it replaces Pydantic's
deprecated
BaseModel.schema()method. Models without explicitnameMappingsretain their existing output.Normalized storage names remain real Pydantic fields and are observable
through attribute access and assignment, introspection, unaliased dumps,
and attribute-based validation. Mapping inputs, requests, responses, and
generated API surfaces use wire or public names instead.
oneOfandanyOfwrapper models do not receive forwardingproperties or input-name preprocessing.
Closes #24123.