From e4bfedbec2e8b10cc6b7b31442478f05db0ce06d Mon Sep 17 00:00:00 2001 From: cobalt <61329810+RedGuy12@users.noreply.github.com> Date: Fri, 1 Mar 2024 09:02:56 -0600 Subject: [PATCH] fix: Don't move comments while splitting delimiters (#4248) Signed-off-by: RedGuy12 <61329810+RedGuy12@users.noreply.github.com> --- CHANGES.md | 2 + src/black/linegen.py | 25 ++++++++-- tests/data/cases/split_delimiter_comments.py | 51 ++++++++++++++++++++ 3 files changed, 75 insertions(+), 3 deletions(-) create mode 100644 tests/data/cases/split_delimiter_comments.py diff --git a/CHANGES.md b/CHANGES.md index bcf6eb44fdb..e28730a3b5f 100644 --- a/CHANGES.md +++ b/CHANGES.md @@ -10,6 +10,8 @@ +- Don't move comments along with delimiters, which could cause crashes (#4248) + ### Preview style diff --git a/src/black/linegen.py b/src/black/linegen.py index 4b0dc57d544..e34ff040c73 100644 --- a/src/black/linegen.py +++ b/src/black/linegen.py @@ -12,6 +12,7 @@ from black.brackets import ( COMMA_PRIORITY, DOT_PRIORITY, + STRING_PRIORITY, get_leaves_inside_matching_brackets, max_delimiter_priority_in_atom, ) @@ -1143,6 +1144,9 @@ def _safe_add_trailing_comma(safe: bool, delimiter_priority: int, line: Line) -> return line +MIGRATE_COMMENT_DELIMITERS = {STRING_PRIORITY, COMMA_PRIORITY} + + @dont_increase_indentation def delimiter_split( line: Line, features: Collection[Feature], mode: Mode @@ -1187,12 +1191,22 @@ def append_to_line(leaf: Leaf) -> Iterator[Line]: ) current_line.append(leaf) + def append_comments(leaf: Leaf) -> Iterator[Line]: + for comment_after in line.comments_after(leaf): + yield from append_to_line(comment_after) + last_non_comment_leaf = _get_last_non_comment_leaf(line) for leaf_idx, leaf in enumerate(line.leaves): yield from append_to_line(leaf) - for comment_after in line.comments_after(leaf): - yield from append_to_line(comment_after) + previous_priority = leaf_idx > 0 and bt.delimiters.get( + id(line.leaves[leaf_idx - 1]) + ) + if ( + previous_priority != delimiter_priority + or delimiter_priority in MIGRATE_COMMENT_DELIMITERS + ): + yield from append_comments(leaf) lowest_depth = min(lowest_depth, leaf.bracket_depth) if trailing_comma_safe and leaf.bracket_depth == lowest_depth: @@ -1205,8 +1219,13 @@ def append_to_line(leaf: Leaf) -> Iterator[Line]: leaf_priority = bt.delimiters.get(id(leaf)) if leaf_priority == delimiter_priority: - yield current_line + if ( + leaf_idx + 1 < len(line.leaves) + and delimiter_priority not in MIGRATE_COMMENT_DELIMITERS + ): + yield from append_comments(line.leaves[leaf_idx + 1]) + yield current_line current_line = Line( mode=line.mode, depth=line.depth, inside_brackets=line.inside_brackets ) diff --git a/tests/data/cases/split_delimiter_comments.py b/tests/data/cases/split_delimiter_comments.py new file mode 100644 index 00000000000..ea29f7c034f --- /dev/null +++ b/tests/data/cases/split_delimiter_comments.py @@ -0,0 +1,51 @@ +a = ( + 1 + # type: ignore + 2 # type: ignore +) +a = ( + 1 # type: ignore + + 2 # type: ignore +) +bad_split3 = ( + "What if we have inline comments on " # First Comment + "each line of a bad split? In that " # Second Comment + "case, we should just leave it alone." # Third Comment +) +parametrize( + ( + {}, + {}, + ), + ( # foobar + {}, + {}, + ), +) + + + +# output +a = ( + 1 # type: ignore + + 2 # type: ignore +) +a = ( + 1 # type: ignore + + 2 # type: ignore +) +bad_split3 = ( + "What if we have inline comments on " # First Comment + "each line of a bad split? In that " # Second Comment + "case, we should just leave it alone." # Third Comment +) +parametrize( + ( + {}, + {}, + ), + ( # foobar + {}, + {}, + ), +) +