[pyupgrade] Do not upgrade functional TypedDicts with private field names to the class-based syntax (UP013)
#16219
+32
−3
Conversation
This file contains 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
|
|
CC @AlexWaygood |
AlexWaygood
reviewed
Feb 18, 2025
| @@ -185,7 +184,7 @@ fn fields_from_dict_literal(items: &[ast::DictItem]) -> Option<Vec<Stmt>> { | |||
| if !is_identifier(field.to_str()) { | |||
| return None; | |||
| } | |||
| if is_dunder(field.to_str()) { | |||
| if field.to_str().starts_with("__") { | |||
There was a problem hiding this comment.
I think it would be good to add a comment here explaining why it's not safe to convert TypedDicts with these fields to the class-based syntax. And it might be useful to add a sentence or two to the docs explaining why not all functional TypedDicts can be converted (and that therefore this rule deliberately does not flag them), as well!
AlexWaygood
changed the title
pyupgrade] Do not upgrade functional TypedDicts with private names to the class-based syntax (UP018)
AlexWaygood
changed the title
pyupgrade] Do not upgrade functional TypedDicts with private names to the class-based syntax (UP018)pyupgrade] Do not upgrade functional TypedDicts with private names to the class-based syntax (UP013)
AlexWaygood
changed the title
pyupgrade] Do not upgrade functional TypedDicts with private names to the class-based syntax (UP013)pyupgrade] Do not upgrade functional TypedDicts with private field names to the class-based syntax (UP013)
dcreager
added a commit
that referenced
this pull request
Feb 18, 2025
* main: (60 commits) [`refurb`] Manual timezone monkeypatching (`FURB162`) (#16113) [`pyupgrade`] Do not upgrade functional TypedDicts with private field names to the class-based syntax (`UP013`) (#16219) Improve docs for PYI019 (#16229) Refactor `CallOutcome` to `Result` (#16161) Fix minor punctuation errors (#16228) Include document specific debug info (#16215) Update server to return the debug info as string (#16214) [`airflow`] Group `ImportPathMoved` and `ProviderName` to avoid misusing (`AIR303`) (#16157) Fix unstable formatting of trailing end-of-line comments of parenthesized attribute values (#16187) Ignore source code actions for a notebook cell (#16154) Add FAQ entry for `source.*` code actions in Notebook (#16212) red-knot: move symbol lookups in `symbol.rs` (#16152) better error messages while loading configuration `extend`s (#15658) Format `index.css` (#16207) Improve API exposed on `ExprStringLiteral` nodes (#16192) Update Rust crate tempfile to v3.17.0 (#16202) Update cloudflare/wrangler-action action to v3.14.0 (#16203) Update NPM Development dependencies (#16199) Update Rust crate smallvec to v1.14.0 (#16201) Update Rust crate codspeed-criterion-compat to v2.8.0 (#16200) ...
dhruvmanila
added a commit
that referenced
this pull request
Feb 24, 2025
## Summary This is mainly on me for not noticing this during the last release but I noticed in the last changelog that there's only 1 bug fix which didn't seem correct as I saw multiple of them so I looked at a couple of PRs that are in "Rule changes" section and the PRs that were marked with the `bug` label was categorized there because 1. It _also_ had other labels like `rule` and `fixes` (#16080, #16110, #16219, etc.) 2. Some PRs didn't have the `bug` label (but the issue as marked as `bug`) but _only_ labels like "fixes" (#16011, #16132, etc.)
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.
Summary
CPython mangles private names defined in
TypedDictclass body, so it is not recommended to use class form with such names, see python/cpython#129567But, now
rufftries to warn about converting such examples to class form. See graphql-python/graphql-core#234Test Plan
I included a test case.