Merge 466767d into fb8dfde

AUTHORS.md

@@ -148,6 +148,7 @@ Multiple contributions by:
 - [Rishikesh Jha](mailto:rishijha424@gmail.com)
 - [Rupert Bedford](mailto:rupert@rupertb.com)
 - Russell Davis
+- [Sagi Shadur](mailto:saroad2@gmail.com)
 - [Rémi Verschelde](mailto:rverschelde@gmail.com)
 - [Sami Salonen](mailto:sakki@iki.fi)
 - [Samuel Cormier-Iijima](mailto:samuel@cormier-iijima.com)

CHANGES.md

@@ -20,6 +20,7 @@
 - Remove redundant parentheses around awaited objects (#2991)
 - Parentheses around return annotations are now managed (#2990)
 - Remove unnecessary parentheses from `with` statements (#2926)
+- Remove trailing newlines after `def` lines (#3035)
 
 ### _Blackd_
 

src/black/lines.py

@@ -513,6 +513,13 @@ def _maybe_empty_lines(self, current_line: Line) -> Tuple[int, int]:
         ):
             return before, 1
 
+        if (
+            Preview.remove_def_trailing_newline in current_line.mode
+            and self.previous_line
+            and self.previous_line.is_def
+            and depth == self.previous_line.depth + 1
+        ):
+            return 0, 0
         return before, 0
 
     def _maybe_empty_lines_for_class_or_def(

src/black/mode.py

@@ -147,6 +147,7 @@ class Preview(Enum):
     remove_redundant_parens = auto()
     one_element_subscript = auto()
     annotation_parens = auto()
+    remove_def_trailing_newline = auto()
 
 
 class Deprecated(UserWarning):

tests/data/newline_after_def1.py

@@ -0,0 +1,8 @@
+def foo():
+
+    print("The newline above me should be deleted!")
+
+# output
+
+def foo():
+    print("The newline above me should be deleted!")

tests/data/newline_after_def2.py

@@ -0,0 +1,10 @@
+def foo():
+
+
+
+    print("All the newlines above me should be deleted!")
+
+# output
+
+def foo():
+    print("All the newlines above me should be deleted!")

tests/data/newline_after_def3.py

@@ -0,0 +1,12 @@
+def f():
+
+    print("No newline above me!")
+
+    print("There is a newline above me, and that's OK!")
+
+# output
+
+def f():
+    print("No newline above me!")
+
+    print("There is a newline above me, and that's OK!")

tests/data/newline_after_def4.py

@@ -0,0 +1,12 @@
+def foo():
+
+    # There is a comment here
+
+    print("The newline above me should not be deleted!")
+
+# output
+
+def foo():
+    # There is a comment here
+
+    print("The newline above me should not be deleted!")

tests/data/newline_after_def5.py

@@ -0,0 +1,10 @@
+class Foo:
+    def bar(self):
+
+        print("The newline above me should be deleted!")
+
+# output
+
+class Foo:
+    def bar(self):
+        print("The newline above me should be deleted!")

tests/test_black.py

@@ -1451,7 +1451,6 @@ def test_newline_comment_interaction(self) -> None:
         black.assert_stable(source, output, mode=DEFAULT_MODE)
 
     def test_bpo_2142_workaround(self) -> None:
-
         # https://bugs.python.org/issue2142
 
         source, _ = read_data("missing_final_newline.py")

tests/test_format.py

@@ -82,6 +82,11 @@
     "cantfit",
     "comments7",
     "comments8",
+    "newline_after_def1",
+    "newline_after_def2",
+    "newline_after_def3",
+    "newline_after_def4",
+    "newline_after_def5",
     "long_strings",
     "long_strings__edge_case",
     "long_strings__regression",