Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 1 commit into from
Sep 17, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 12 additions & 6 deletions black.py
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand All @@ -1313,13 +1313,19 @@ 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):
return True
if leaf_id not in ignored_ids or comment_seen:
return True

comment_seen = True

return False

Expand Down Expand Up @@ -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)
):
Expand Down
14 changes: 14 additions & 0 deletions tests/data/comments6.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down