Commit 0c44220e authored by Michael J. Sullivan's avatar Michael J. Sullivan Committed by Jelle Zijlstra
Browse files

Don't allow type comments to be merged behind regular comments (#1027)

Type comments only apply if they are the first comment on the line,
which means that allowing them to be pushed behind a regular comment
when joining lines is a semantic change (and, indeed, one that black
catches and fails on).
parent ae5588cf
Loading
Loading
Loading
Loading
+11 −5
Changes for black.py: 11 added lines, 5 removed lines.
Original line number Diff line number Diff line
@@ -1296,7 +1296,7 @@ def contains_standalone_comments(self, depth_limit: int = sys.maxsize) -> bool:
                    return True
        return False

    def contains_inner_type_comments(self) -> bool:
    def contains_uncollapsable_type_comments(self) -> bool:
        ignored_ids = set()
        try:
            last_leaf = self.leaves[-1]
@@ -1313,14 +1313,20 @@ def contains_inner_type_comments(self) -> bool:
        except IndexError:
            return False

        # A type comment is uncollapsable if it is attached to a leaf
        # that isn't at the end of the line (since that could cause it
        # to get associated to a different argument) or if there are
        # comments before it (since that could cause it to get hidden
        # behind a comment.
        comment_seen = False
        for leaf_id, comments in self.comments.items():
            if leaf_id in ignored_ids:
                continue

            for comment in comments:
                if is_type_comment(comment):
                    if leaf_id not in ignored_ids or comment_seen:
                        return True

            comment_seen = True

        return False

    def contains_multiline_strings(self) -> bool:
@@ -2328,7 +2334,7 @@ def split_line(
    line_str = str(line).strip("\n")

    if (
        not line.contains_inner_type_comments()
        not line.contains_uncollapsable_type_comments()
        and not line.should_explode
        and is_line_short_enough(line, line_length=line_length, line_str=line_str)
    ):
+14 −0
Changes for tests/data/comments6.py: 14 added lines, 0 removed lines.
Original line number Diff line number Diff line
@@ -69,6 +69,20 @@ def f(
    )  # type: int


def f(
    x,  # not a type comment
    y,  # type: int
):
    # type: (...) -> None
    pass


def f(
    x,  # not a type comment
):  # type: (int) -> None
    pass


def func(
    a=some_list[0],  # type: int
):  # type: () -> int