Enforce a blank line after a nested class in stubs #3564

WMOkiishi · 2023-02-11T22:46:11Z

Description

Resolves #2783

The issue was partially resolved by #2820, but only for cases where the inner class body ends with a definition (class or def) and is followed by another definition. This change enforces a blank line after any nested class with a body (other than just ...) in stubs, particularly those ending with or followed by an annotation for an attribute.

I had to make a slight change to EmptyLineTracker.previous_defs in order to not put a blank line after the indented block of an if statement or function def: while typeshed doesn't include anything in function bodies, some of the stubs I'm maintaining include a docstring, and I wouldn't want a blank line added after each method that has one.

Checklist - did you ...

Add an entry in CHANGES.md if necessary?
Add / update tests if necessary?
Add new / update outdated documentation?

github-actions · 2023-02-12T01:31:07Z

diff-shades results comparing this PR (22f6e9d) to main (a3e8247). The full diff is available in the logs under the "Generate HTML diff report" step.

╭─────────────────────── Summary ────────────────────────╮
│ 1 projects & 35 files changed / 43 changes [+43/-0]    │
│                                                        │
│ ... out of 2 418 510 lines, 11 507 files & 23 projects │
╰────────────────────────────────────────────────────────╯

Differences found.

What is this? | Workflow run | diff-shades documentation

AlexWaygood · 2023-03-05T15:45:33Z

I'm not an expert on black internals, but the typeshed changes flagged by diff-shades look like a definite improvement to me!

The idea behind this change is that we stop looking into previous body to determine if there should be a blank before a function or class definition. Input: ```python import sys if sys.version_info > (3, 7): class Nested1: assignment = 1 def function_definition(self): ... def f1(self) -> str: ... class Nested2: def function_definition(self): ... assignment = 1 def f2(self) -> str: ... if sys.version_info > (3, 7): def nested1(): assignment = 1 def function_definition(self): ... def f1(self) -> str: ... def nested2(): def function_definition(self): ... assignment = 1 def f2(self) -> str: ... ``` Stable style ```python import sys if sys.version_info > (3, 7): class Nested1: assignment = 1 def function_definition(self): ... def f1(self) -> str: ... class Nested2: def function_definition(self): ... assignment = 1 def f2(self) -> str: ... if sys.version_info > (3, 7): def nested1(): assignment = 1 def function_definition(self): ... def f1(self) -> str: ... def nested2(): def function_definition(self): ... assignment = 1 def f2(self) -> str: ... ``` In the stable formatting, we have a blank line sometimes, not depending on the previous statement on the same level, but on the last (potentially nested) statement in the previous body. psf#2783/psf#3564 fixes this for classes in preview style: ```python import sys if sys.version_info > (3, 7): class Nested1: assignment = 1 def function_definition(self): ... def f1(self) -> str: ... class Nested2: def function_definition(self): ... assignment = 1 def f2(self) -> str: ... if sys.version_info > (3, 7): def nested1(): assignment = 1 def function_definition(self): ... def f1(self) -> str: ... def nested2(): def function_definition(self): ... assignment = 1 def f2(self) -> str: ... ``` This PR additionally fixes this for function definitions: ```python if sys.version_info > (3, 7): if sys.platform == "win32": assignment = 1 def function_definition(self): ... def f1(self) -> str: ... if sys.platform != "win32": def function_definition(self): ... assignment = 1 def f2(self) -> str: ... if sys.version_info > (3, 8): if sys.platform == "win32": assignment = 1 def function_definition(self): ... class F1: ... if sys.platform != "win32": def function_definition(self): ... assignment = 1 class F2: ... ``` You can see the effect of this change on typeshed in https://github.com/konstin/typeshed/pull/1/files. As baseline, the preview mode changes without this PR are at konstin/typeshed#2.

The idea behind this change is that we stop looking into previous body to determine if there should be a blank before a function or class definition. Input: ```python import sys if sys.version_info > (3, 7): class Nested1: assignment = 1 def function_definition(self): ... def f1(self) -> str: ... class Nested2: def function_definition(self): ... assignment = 1 def f2(self) -> str: ... if sys.version_info > (3, 7): def nested1(): assignment = 1 def function_definition(self): ... def f1(self) -> str: ... def nested2(): def function_definition(self): ... assignment = 1 def f2(self) -> str: ... ``` Stable style ```python import sys if sys.version_info > (3, 7): class Nested1: assignment = 1 def function_definition(self): ... def f1(self) -> str: ... class Nested2: def function_definition(self): ... assignment = 1 def f2(self) -> str: ... if sys.version_info > (3, 7): def nested1(): assignment = 1 def function_definition(self): ... def f1(self) -> str: ... def nested2(): def function_definition(self): ... assignment = 1 def f2(self) -> str: ... ``` In the stable formatting, we have a blank line sometimes, not depending on the previous statement on the same level, but on the last (potentially nested) statement in the previous body. #2783/#3564 fixes this for classes in preview style: ```python import sys if sys.version_info > (3, 7): class Nested1: assignment = 1 def function_definition(self): ... def f1(self) -> str: ... class Nested2: def function_definition(self): ... assignment = 1 def f2(self) -> str: ... if sys.version_info > (3, 7): def nested1(): assignment = 1 def function_definition(self): ... def f1(self) -> str: ... def nested2(): def function_definition(self): ... assignment = 1 def f2(self) -> str: ... ``` This PR additionally fixes this for function definitions: ```python if sys.version_info > (3, 7): if sys.platform == "win32": assignment = 1 def function_definition(self): ... def f1(self) -> str: ... if sys.platform != "win32": def function_definition(self): ... assignment = 1 def f2(self) -> str: ... if sys.version_info > (3, 8): if sys.platform == "win32": assignment = 1 def function_definition(self): ... class F1: ... if sys.platform != "win32": def function_definition(self): ... assignment = 1 class F2: ... ``` You can see the effect of this change on typeshed in https://github.com/konstin/typeshed/pull/1/files. As baseline, the preview mode changes without this PR are at konstin/typeshed#2. Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>

Enforce a blank line after a nested class in stubs

3086ece

WMOkiishi added 2 commits February 12, 2023 10:31

Don't add a blank line after a class with no body

aace988

Move changes to the preview style

faed181

Merge branch 'main' into stub-nested-classes

22f6e9d

JelleZijlstra approved these changes Mar 18, 2023

View reviewed changes

JelleZijlstra self-assigned this Mar 18, 2023

JelleZijlstra merged commit d7a28dd into psf:main Mar 18, 2023
44 checks passed

WMOkiishi deleted the stub-nested-classes branch March 18, 2023 23:59

yilei added a commit to yilei/black that referenced this pull request Mar 19, 2023

Fix bug introduced in psf#3564.

7e5741f

yilei mentioned this pull request Mar 19, 2023

Fix bug introduced in #3564. #3615

Merged

JelleZijlstra pushed a commit that referenced this pull request Mar 19, 2023

Fix bug introduced in #3564. (#3615)

dba3c26

WMOkiishi mentioned this pull request Mar 31, 2023

What should be the role of idbstubs? WMOkiishi/types-panda3d#2

Closed

konstin mentioned this pull request Sep 6, 2023

Don't inspect the previous body for blank line rules in stub files #3861

Closed

konstin mentioned this pull request Sep 8, 2023

Blank line between nested and function def in stub files. #3862

Merged

3 tasks

hauntsaninja mentioned this pull request Nov 13, 2023

Setting the 2024 stable style #4042

Closed

konstin mentioned this pull request Nov 14, 2023

🏖️ Black 2024 Preview Style astral-sh/ruff#8678

Closed

28 tasks

MichaReiser mentioned this pull request Nov 29, 2023

Formatter: blank_line_after_nested_stub_class preview style astral-sh/ruff#8891

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Enforce a blank line after a nested class in stubs #3564

Enforce a blank line after a nested class in stubs #3564

WMOkiishi commented Feb 11, 2023

github-actions bot commented Feb 12, 2023 •

edited

AlexWaygood commented Mar 5, 2023

Enforce a blank line after a nested class in stubs #3564

Enforce a blank line after a nested class in stubs #3564

Conversation

WMOkiishi commented Feb 11, 2023

Description

Checklist - did you ...

github-actions bot commented Feb 12, 2023 • edited

AlexWaygood commented Mar 5, 2023

github-actions bot commented Feb 12, 2023 •

edited