Stubs: preserve blank line between attributes and methods (#2736)

diff --git a/CHANGES.md b/CHANGES.md
index cb637d94c11231e46096efb7ef87107afa1ccfcd..8bb96bb1f29d2ea9d61a9c038490eb32c9123d00 100644 (file)
--- a/CHANGES.md
+++ b/CHANGES.md
@@ -17,6 +17,8 @@
 - Tuple unpacking on `return` and `yield` constructs now implies 3.8+ (#2700)
 - Unparenthesized tuples on annotated assignments (e.g
   `values: Tuple[int, ...] = 1, 2, 3`) now implies 3.8+ (#2708)
 - Tuple unpacking on `return` and `yield` constructs now implies 3.8+ (#2700)
 - Unparenthesized tuples on annotated assignments (e.g
   `values: Tuple[int, ...] = 1, 2, 3`) now implies 3.8+ (#2708)

+- For stubs, one blank line between class attributes and methods is now kept if there's
+  at least one pre-existing blank line (#2736)

 
 ### Packaging
 
 
 ### Packaging
 

diff --git a/src/black/lines.py b/src/black/lines.py
index f2bdada008a6519275b97ea4eac4a3bbf3befb26..d8617d83bf7656d0f9477b3ce175e3b91d54511f 100644 (file)
--- a/src/black/lines.py
+++ b/src/black/lines.py
@@ -448,7 +448,14 @@ class EmptyLineTracker:
         depth = current_line.depth
         while self.previous_defs and self.previous_defs[-1] >= depth:
             if self.is_pyi:
         depth = current_line.depth
         while self.previous_defs and self.previous_defs[-1] >= depth:
             if self.is_pyi:

-                before = 0 if depth else 1
+                assert self.previous_line is not None
+                if depth and not current_line.is_def and self.previous_line.is_def:
+                    # Empty lines between attributes and methods should be preserved.
+                    before = min(1, before)
+                elif depth:
+                    before = 0
+                else:
+                    before = 1

             else:
                 if depth:
                     before = 1
             else:
                 if depth:
                     before = 1


@@ -532,9 +539,15 @@ class EmptyLineTracker:
             elif (
                 current_line.is_def or current_line.is_decorator
             ) and not self.previous_line.is_def:
             elif (
                 current_line.is_def or current_line.is_decorator
             ) and not self.previous_line.is_def:

-                # Blank line between a block of functions (maybe with preceding
-                # decorators) and a block of non-functions
-                newlines = 1
+                if not current_line.depth:
+                    # Blank line between a block of functions (maybe with preceding
+                    # decorators) and a block of non-functions
+                    newlines = 1
+                else:
+                    # In classes empty lines between attributes and methods should
+                    # be preserved. The +1 offset is to negate the -1 done later as
+                    # this function is indented.
+                    newlines = min(2, before + 1)

             else:
                 newlines = 0
         else:
             else:
                 newlines = 0
         else:

diff --git a/tests/data/stub.pyi b/tests/data/stub.pyi
index 94ba852e01888b8e2a55dc92584a0f9d5486e60e..9a246211284acac31eb3c1e3575ee7083db44fe7 100644 (file)
--- a/tests/data/stub.pyi
+++ b/tests/data/stub.pyi
@@ -2,32 +2,55 @@ X: int
 
 def f(): ...
 
 
 def f(): ...
 

+
+class D: 
+    ...
+
+

 class C:
     ...
 
 class B:
 class C:
     ...
 
 class B:

-    ...
+    this_lack_of_newline_should_be_kept: int
+    def b(self) -> None: ...
+
+    but_this_newline_should_also_be_kept: int

 
 class A:
 
 class A:

+    attr: int
+    attr2: str
+

     def f(self) -> int:
         ...
 
     def g(self) -> str: ...
 
     def f(self) -> int:
         ...
 
     def g(self) -> str: ...
 

+
+

 def g():
     ...
 
 def h(): ...
 
 def g():
     ...
 
 def h(): ...
 

+

 # output
 X: int
 
 def f(): ...
 
 # output
 X: int
 
 def f(): ...
 

+class D: ...

 class C: ...
 class C: ...

-class B: ...
+
+class B:
+    this_lack_of_newline_should_be_kept: int
+    def b(self) -> None: ...
+
+    but_this_newline_should_also_be_kept: int

 
 class A:
 
 class A:

+    attr: int
+    attr2: str
+

     def f(self) -> int: ...
     def g(self) -> str: ...
 
     def f(self) -> int: ...
     def g(self) -> str: ...