Commit 4b449e74 authored by Michael J. Sullivan's avatar Michael J. Sullivan Committed by Jelle Zijlstra
Browse files

Fix unstable formatting with some `# type: ignore`s (#1113)

`type: ignore` shouldn't block collapsing a line, since it will still
apply fine to the merged line. This prevents an issue where a reformat
causes it to shift lines and then be merged on a subsequent pass.

There is a downside to this, which is that it can cause a `type:
ignore` to apply to more code than was originally intended. There
might be a way to apply this in a more limited situation, but I'm not
sure what it is.

Fixes #1061.
parent fb1ac698
Loading
Loading
Loading
Loading
+4 −1
Changes for black.py: 4 added lines, 1 removed line.
Original line number Diff line number Diff line
@@ -1407,7 +1407,10 @@ def contains_uncollapsable_type_comments(self) -> bool:
        for leaf_id, comments in self.comments.items():
            for comment in comments:
                if is_type_comment(comment):
                    if leaf_id not in ignored_ids or comment_seen:
                    if comment_seen or (
                        not is_type_comment(comment, " ignore")
                        and leaf_id not in ignored_ids
                    ):
                        return True

                comment_seen = True
+13 −0
Changes for tests/data/comments2.py: 13 added lines, 0 removed lines.
Original line number Diff line number Diff line
@@ -148,6 +148,12 @@ def inline_comments_in_brackets_ruin_everything():

CONFIG_FILES = [CONFIG_FILE, ] + SHARED_CONFIG_FILES + USER_CONFIG_FILES  # type: Final

class Test:
    def _init_host(self, parsed) -> None:
        if (parsed.hostname is None or  # type: ignore
                not parsed.hostname.strip()):
            pass

#######################
### SECTION COMMENT ###
#######################
@@ -312,6 +318,13 @@ def inline_comments_in_brackets_ruin_everything():

CONFIG_FILES = [CONFIG_FILE,] + SHARED_CONFIG_FILES + USER_CONFIG_FILES  # type: Final


class Test:
    def _init_host(self, parsed) -> None:
        if parsed.hostname is None or not parsed.hostname.strip():  # type: ignore
            pass


#######################
### SECTION COMMENT ###
#######################
+1 −3
Changes for tests/data/comments7.py: 1 added line, 3 removed lines.
Original line number Diff line number Diff line
@@ -93,9 +93,7 @@ def func():


def func():
    c = call(
        0.0123, 0.0456, 0.0789, 0.0123, 0.0789, a[-1],  # type: ignore
    )
    c = call(0.0123, 0.0456, 0.0789, 0.0123, 0.0789, a[-1],)  # type: ignore

    # The type: ignore exception only applies to line length, not
    # other types of formatting.