Skip to content
New issue

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

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

Already on GitHub? # to your account

Fix another case where we format dummy implementation for non-functions/classes #4103

Merged
merged 2 commits into from
Dec 11, 2023
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
2 changes: 1 addition & 1 deletion CHANGES.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
docstring (#4060)
- Fix crash in preview mode when using a short `--line-length` (#4086)
- Keep suites consisting of only an ellipsis on their own lines if they are not
functions or class definitions (#4066)
functions or class definitions (#4066) (#4103)

### Configuration

Expand Down
12 changes: 7 additions & 5 deletions src/black/linegen.py
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@
is_atom_with_invisible_parens,
is_docstring,
is_empty_tuple,
is_function_or_class,
is_lpar_token,
is_multiline_string,
is_name_token,
Expand Down Expand Up @@ -299,11 +300,12 @@ def visit_simple_stmt(self, node: Node) -> Iterator[Line]:
wrap_in_parentheses(node, child, visible=False)
prev_type = child.type

is_suite_like = node.parent and node.parent.type in STATEMENT
if is_suite_like:
if (
self.mode.is_pyi or Preview.dummy_implementations in self.mode
) and is_stub_body(node):
if node.parent and node.parent.type in STATEMENT:
if Preview.dummy_implementations in self.mode:
condition = is_function_or_class(node.parent)
else:
condition = self.mode.is_pyi
if condition and is_stub_body(node):
yield from self.visit_default(node)
else:
yield from self.line(+1)
Expand Down
17 changes: 10 additions & 7 deletions src/black/nodes.py
Original file line number Diff line number Diff line change
Expand Up @@ -736,15 +736,18 @@ def is_funcdef(node: Node) -> bool:
return node.type == syms.funcdef


def is_function_or_class(node: Node) -> bool:
return node.type in {syms.funcdef, syms.classdef, syms.async_funcdef}


def is_stub_suite(node: Node, mode: Mode) -> bool:
"""Return True if `node` is a suite with a stub body."""
if node.parent is not None:
if Preview.dummy_implementations in mode and node.parent.type not in (
syms.funcdef,
syms.async_funcdef,
syms.classdef,
):
return False
if (
node.parent is not None
and Preview.dummy_implementations in mode
and not is_function_or_class(node.parent)
):
return False

# If there is a comment, we want to keep it.
if node.prefix.strip():
Expand Down
5 changes: 5 additions & 0 deletions tests/data/cases/preview_dummy_implementations.py
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,8 @@ def has_comment():
if some_condition:
...

if already_dummy: ...

# output

from typing import NoReturn, Protocol, Union, overload
Expand Down Expand Up @@ -116,3 +118,6 @@ def has_comment(): ... # still a dummy

if some_condition:
...

if already_dummy:
...
Loading