Put blank lines between nested classes in typing stubs #2783

MarkKoz · 2022-01-19T00:23:07Z

Describe the style change

Nested classes in typing stubs should have blank lines between them.

Examples in the current Black style

class A:
    class B:
        attribute: int
    class C:
        attribute: int
    def method(self) -> None: ...
    def method2(self) -> None: ...

Desired style

class A:
    class B:
        attribute: int
    
    class C:
        attribute: int
    
    def method(self) -> None: ...
    def method2(self) -> None: ...

Additional context

See this for a live demo.

JelleZijlstra · 2022-01-19T00:25:41Z

I'm in favor of making this change, but cc fellow typeshed maintainers @srittau @Akuli @hauntsaninja.

hauntsaninja · 2022-01-19T03:02:01Z

Yeah, seems nice.

Somewhat related, the stubs style change I want from black is for top-level code under an if-statement to have the same blank lines as top-level code proper. Example here

JelleZijlstra · 2022-01-19T03:20:04Z

@hauntsaninja we made some changes around that in #2472, but agree that we should space in your example too. Feel free to open a new issue. We also have an unreleased change in #2736.

Akuli · 2022-01-19T08:00:59Z

I'm fine with this change.

JelleZijlstra · 2022-01-19T14:41:32Z

Everyone agrees, so @MarkKoz feel free to go ahead and implement this. Thanks!

jpy-git · 2022-03-16T12:27:51Z

Had a quick look at this and, since there's no special consideration given to whether an indented block is within a class or an if, it seems the work in #2820 and #2796 has partially addressed this issue.
There are however there are a couple other cases that need to be accounted for in both if and class blocks: if example and class example

For stubs, it feels like making any indented block consistent with the top level achieves the goal of this issue and #2784.

Although one place I can see class and if differing is the gap between attributes and methods (example) since this may introduce a lot of changes in typeshed.

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>

MarkKoz added the T: style What do we want Blackened code to look like? label Jan 19, 2022

ichard26 added F: empty lines Wasting vertical space efficiently. S: accepted The changes in this design / enhancement issue have been accepted and can be implemented labels Jan 19, 2022

ichard26 added S: needs discussion Needs further hashing out before ready for implementation (on desirability, feasibility, etc.) and removed S: accepted The changes in this design / enhancement issue have been accepted and can be implemented labels Jan 19, 2022

hauntsaninja mentioned this issue Jan 19, 2022

Blank lines at top level code in stubs should be the same inside an if #2784

Closed

ichard26 added S: accepted The changes in this design / enhancement issue have been accepted and can be implemented and removed S: needs discussion Needs further hashing out before ready for implementation (on desirability, feasibility, etc.) labels Jan 21, 2022

WMOkiishi mentioned this issue Feb 11, 2023

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

Merged

3 tasks

JelleZijlstra closed this as completed in #3564 Mar 18, 2023

konstin mentioned this issue Sep 6, 2023

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

Closed

konstin mentioned this issue Sep 8, 2023

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

Merged

3 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Put blank lines between nested classes in typing stubs #2783

Put blank lines between nested classes in typing stubs #2783

MarkKoz commented Jan 19, 2022

JelleZijlstra commented Jan 19, 2022

hauntsaninja commented Jan 19, 2022 •

edited

JelleZijlstra commented Jan 19, 2022

Akuli commented Jan 19, 2022

JelleZijlstra commented Jan 19, 2022

jpy-git commented Mar 16, 2022

Put blank lines between nested classes in typing stubs #2783

Put blank lines between nested classes in typing stubs #2783

Comments

MarkKoz commented Jan 19, 2022

JelleZijlstra commented Jan 19, 2022

hauntsaninja commented Jan 19, 2022 • edited

JelleZijlstra commented Jan 19, 2022

Akuli commented Jan 19, 2022

JelleZijlstra commented Jan 19, 2022

jpy-git commented Mar 16, 2022

hauntsaninja commented Jan 19, 2022 •

edited