Remove blank lines before class docstring (#3692)

diff --git a/CHANGES.md b/CHANGES.md
index a1bc7d590205ebf71a83aaeeac69d7af66b2948a..6a9923f8d8d381b8e4682581a3ae35f2de6c8ebf 100644 (file)
--- a/CHANGES.md
+++ b/CHANGES.md
@@ -16,6 +16,7 @@
 
 - Implicitly concatenated strings used as function args are no longer wrapped inside
   parentheses (#3640)
 
 - Implicitly concatenated strings used as function args are no longer wrapped inside
   parentheses (#3640)

+- Remove blank lines between a class definition and its docstring (#3692)

 
 ### Configuration
 
 
 ### Configuration
 

diff --git a/src/black/lines.py b/src/black/lines.py
index 9d33bfa10b434e4075e2124cd41f586512762ffe..daf0444d24e9a7d57c86f290344323fc7397f775 100644 (file)
--- a/src/black/lines.py
+++ b/src/black/lines.py
@@ -634,6 +634,8 @@ class EmptyLineTracker:
             and self.previous_line.is_class
             and current_line.is_triple_quoted_string
         ):
             and self.previous_line.is_class
             and current_line.is_triple_quoted_string
         ):

+            if Preview.no_blank_line_before_class_docstring in current_line.mode:
+                return 0, 1

             return before, 1
 
         if self.previous_line and self.previous_line.opens_block:
             return before, 1
 
         if self.previous_line and self.previous_line.opens_block:

diff --git a/src/black/mode.py b/src/black/mode.py
index 3e37a588e522d5c594c916f874244951526f759b..a5841edb30a791cd17d8ad810542adbd7640e617 100644 (file)
--- a/src/black/mode.py
+++ b/src/black/mode.py
@@ -158,6 +158,7 @@ class Preview(Enum):
     hex_codes_in_unicode_sequences = auto()
     improved_async_statements_handling = auto()
     multiline_string_handling = auto()
     hex_codes_in_unicode_sequences = auto()
     improved_async_statements_handling = auto()
     multiline_string_handling = auto()

+    no_blank_line_before_class_docstring = auto()

     prefer_splitting_right_hand_side_of_assignments = auto()
     # NOTE: string_processing requires wrap_long_dict_values_in_parens
     # for https://github.com/psf/black/issues/3117 to be fixed.
     prefer_splitting_right_hand_side_of_assignments = auto()
     # NOTE: string_processing requires wrap_long_dict_values_in_parens
     # for https://github.com/psf/black/issues/3117 to be fixed.

diff --git a/tests/data/preview/no_blank_line_before_docstring.py b/tests/data/preview/no_blank_line_before_docstring.py
new file mode 100644 (file)
index 0000000..a37362d
--- /dev/null
+++ b/tests/data/preview/no_blank_line_before_docstring.py
@@ -0,0 +1,58 @@
+def line_before_docstring():
+
+    """Please move me up"""
+
+
+class LineBeforeDocstring:
+
+    """Please move me up"""
+
+
+class EvenIfThereIsAMethodAfter:
+
+    """I'm the docstring"""
+    def method(self):
+        pass
+
+
+class TwoLinesBeforeDocstring:
+
+
+    """I want to be treated the same as if I were closer"""
+
+
+class MultilineDocstringsAsWell:
+
+    """I'm so far
+
+    and on so many lines...
+    """
+
+
+# output
+
+
+def line_before_docstring():
+    """Please move me up"""
+
+
+class LineBeforeDocstring:
+    """Please move me up"""
+
+
+class EvenIfThereIsAMethodAfter:
+    """I'm the docstring"""
+
+    def method(self):
+        pass
+
+
+class TwoLinesBeforeDocstring:
+    """I want to be treated the same as if I were closer"""
+
+
+class MultilineDocstringsAsWell:
+    """I'm so far
+
+    and on so many lines...
+    """