Use typing.Dict for BaseModel annotations
#11834
Merged
Conversation
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
There is a disclaimer at top of file that mentions using `typing.Dict` for annotations rather than `dict` itself due to `dict` being part of the `BaseModel` namespace (in the form of the deprecated `dict()` method). We correct two violations of this disclaimer in this PR, which currently cause downstream issues in packages that rely heavily on parsing of type-annotations, e.g. mitmproxy/pdoc#792.
jinnovation
commented
May 2, 2025
CodSpeed Performance ReportMerging #11834 will not alter performanceComparing Summary
|
Coverage report
Click to see where and how coverage changed
This report was generated by python-coverage-comment-action |
||||||||||||||||||||||||
|
please review |
Viicos
changed the title
typing.Dict for dunder annotationstyping.Dict for BaseModel annotations
Viicos
approved these changes
May 2, 2025
Viicos
added
relnotes-ignore
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Change Summary
There is a disclaimer at top of file that mentions using
typing.Dictfor annotations rather thandictitself due todictbeing part of theBaseModelnamespace (in the form of the deprecateddict()method). We correct two violations of this disclaimer in this PR, which currently cause downstream issues in packages that rely heavily on parsing of type-annotations, e.g. mitmproxy/pdoc#792.Related issue number
Checklist
Selected Reviewer: @Viicos