format StmtWith #5350
Merged
format StmtWith #5350
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
PR Check ResultsEcosystem✅ ecosystem check detected no changes. BenchmarkLinuxWindows |
MichaReiser
approved these changes
Jun 24, 2023
| with (a): # should remove brackets | ||
| ... | ||
|
|
||
| # TODO: black doesn't wrap this, but maybe we want to anyway? |
There was a problem hiding this comment.
This sounds reasonable to me. We should make it wrap the same as for function definition
# All flat
def test(a, b, c):
pass
# parentheses expanded
def test(
a, b, c
):
pass
# all expanded
def test(
a,
b,
c
):
passYou can achieve this by using two nested groups:
- outer group: For the parentheses and indent
- inner group: Around the with items
There was a problem hiding this comment.
oh wait. when there is an as, wrapping isn't allowed in python < 3.9 (3.8 isn't eol until oct '24)
There was a problem hiding this comment.
We can change that when adding support for targeting different python versions. It's something that we'll need to add to the formatter options.
|
|
||
| with call(arg): | ||
| call(arg) | ||
| # fmt: skip |
There was a problem hiding this comment.
Is this fmt: skip intentional?
There was a problem hiding this comment.
oops, this whole block is leftover from debugging. will remove
Comment on lines
21
to
29
| let dangling_comments = comments.dangling_comments(item.as_any_node_ref()); | ||
| let trailing_items_comments = body.first().map(|body_start| { | ||
| let before_body = dangling_comments | ||
| .partition_point(|comment| comment.slice().end() < body_start.start()); | ||
|
|
||
| let (trailing_items_comments, rest) = dangling_comments.split_at(before_body); | ||
| debug_assert!(rest.is_empty()); | ||
| trailing_items_comments | ||
| }); |
There was a problem hiding this comment.
Do we need the partition_point or can we format all dangling_comments at once? Because it seems there's only a single place where dangling comments can appear (and thus, splitting is unnecessary).
Comment on lines
38
to
34
| group(&format_args![ | ||
| if_group_breaks(&text("(")), | ||
| soft_block_indent(&joined_items), | ||
| if_group_breaks(&text(")")), | ||
| ]), |
There was a problem hiding this comment.
Nit: You can use optional_parentheses(&joined_items) if this lands after #5328
davidszotten
force-pushed
the
format-stmt-with
branch
2 times, most recently
from
8ef512f
to
2458c3f
Compare
without one some (unusual) with statements had unstable formatting
davidszotten
force-pushed
the
format-stmt-with
branch
from
2458c3f
to
cec170a
Compare
MichaReiser
added
internal
3 tasks
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
format
StmtWith(andWithItem)one outstanding todo (see the bottom of
with.py)Test Plan
snapshots