Refactor with statement formatting to have explicit layouts #10296
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
MichaReiser
added
internal
MichaReiser
commented
Mar 8, 2024
|
MichaReiser
commented
Mar 8, 2024
| /// ``` | ||
| /// | ||
| /// Only used for Python 3.9+ | ||
| SingleWithTarget(&'a WithItem), |
There was a problem hiding this comment.
The name here doesn't make sense as of this PR because it could as well be a with item without a target. This gets changed in #10274, and I didn't want to come up with new terminology just for the state between the two PRs.
MichaReiser
changed the title
charliermarsh
approved these changes
Mar 8, 2024
nkxxll
pushed a commit
to nkxxll/ruff
that referenced
this pull request
Mar 10, 2024
…h#10296) ## Summary This PR refactors the with item formatting to use more explicit layouts to make it easier to understand the different formatting cases. The benefit of the explicit layout is that it makes it easier to reasons about layout transition between format runs. For example, today it's possible that `SingleWithTarget` or `ParenthesizeIfExpands` add parentheses around the with items for `with aaaaaaaaaa + bbbbbbbbbbbb: pass`, resulting in `with (aaaaaaaaaa + bbbbbbbbbbbb): pass`. The problem with this is that the next formatting pass uses the `SingleParenthesizedContextExpression` layout that uses `maybe_parenthesize_expression` which is different from `parenthesize_if_expands(&expr)` or `optional_parentheses(&expr)`. ## Test Plan `cargo test` I ran the ecosystem checks locally and there are no changes.
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
This PR refactors the with item formatting to use more explicit layouts to make it easier to understand the different formatting cases.
The benefit of the explicit layout is that it makes it easier to reasons about layout transition between format runs. For example, today it's possible that
SingleWithTargetorParenthesizeIfExpandsadd parentheses around the with items forwith aaaaaaaaaa + bbbbbbbbbbbb: pass, resulting inwith (aaaaaaaaaa + bbbbbbbbbbbb): pass. The problem with this is that the next formatting pass uses theSingleParenthesizedContextExpressionlayout that usesmaybe_parenthesize_expressionwhich is different fromparenthesize_if_expands(&expr)oroptional_parentheses(&expr).Test Plan
cargo testI ran the ecosystem checks locally and there are no changes.