Fix attribute chain own line comments #5340
Merged
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
|
Current dependencies on/for this PR:
This comment was auto-generated by Graphite. |
PR Check ResultsEcosystem✅ ecosystem check detected no changes. BenchmarkLinuxWindows |
MichaReiser
approved these changes
Jun 26, 2023
Comment on lines
48
to
57
| x21 = ( | ||
| a | ||
| # trailing name own line | ||
| .b | ||
| ) |
There was a problem hiding this comment.
Can you add one example where the outer most attribute chain has leading and trailing comments too?
Comment on lines
+39
to
44
| } else if let Expr::Attribute(expr_attribute) = value.as_ref() { | ||
| // We're in a attribute chain (`a.b.c`). The outermost node adds parentheses if | ||
| // required, the inner ones don't need them so we skip the `Expr` formatting that | ||
| // normally adds the parentheses. | ||
| expr_attribute.format().fmt(f)?; | ||
| } else { |
There was a problem hiding this comment.
Can you add a test case where an inner attribute change is parenthesized? I wonder if we need to preserve the parentheses.
konstin
force-pushed
the
fix_attribute_chain_own_line_comments_rebased
branch
from
37fdcdd
to
8bc2b89
Compare
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.
Motation
Previously,
got formatted as
which is invalid syntax. This fixes that.
Summary
This implements a basic form of attribute chaining (https://black.readthedocs.io/en/stable/the_black_code_style/current_style.html#call-chains) by checking if any inner attribute access contains an own line comment, and if this is the case, adds parentheses around the outermost attribute access while disabling parentheses for all inner attribute expressions. We want to replace this with an implementation that uses recursion or a stack while formatting instead of in
needs_parenthesesand also includes calls rather sooner than later, but i'm fixing this now because i'm uncomfortable with having known invalid syntax generation in the formatter.Test Plan
I added new fixtures.