[#154] Handle comments between decorators properly (#166)

diff --git a/black.py b/black.py
index 15a754742cc2212656d324fab4422ddad6982289..a03b9aad7607ffd4107b22b6382b6a00028d204c 100644 (file)
--- a/black.py
+++ b/black.py
@@ -1044,6 +1044,10 @@ class EmptyLineTracker:
                 # Don't insert empty lines between decorators.
                 return 0, 0
 
                 # Don't insert empty lines between decorators.
                 return 0, 0
 

+            if is_decorator and self.previous_line and self.previous_line.is_comment:
+                # Don't insert empty lines between decorator comments.
+                return 0, 0
+

             newlines = 2
             if current_line.depth:
                 newlines -= 1
             newlines = 2
             if current_line.depth:
                 newlines -= 1

diff --git a/tests/comments6.py b/tests/comments6.py
new file mode 100644 (file)
index 0000000..0565015
--- /dev/null
+++ b/tests/comments6.py
@@ -0,0 +1,8 @@
+@property
+# TODO: X
+@property
+# TODO: Y
+# TODO: Z
+@property
+def foo():
+    pass

diff --git a/tests/test_black.py b/tests/test_black.py
index dd3beed99abe0e5b6d7b3f37188fa41420f38493..9c029df7eb7b13a891070c30879f4778e4cca121 100644 (file)
--- a/tests/test_black.py
+++ b/tests/test_black.py
@@ -626,6 +626,14 @@ class BlackTestCase(unittest.TestCase):
             )
             self.assertEqual(result.exit_code, 1)
 
             )
             self.assertEqual(result.exit_code, 1)
 

+    @patch("black.dump_to_file", dump_to_stderr)
+    def test_comment_in_decorator(self) -> None:
+        source, expected = read_data("comments6")
+        actual = fs(source)
+        self.assertFormatEqual(expected, actual)
+        black.assert_equivalent(source, actual)
+        black.assert_stable(source, actual, line_length=ll)
+

 
 if __name__ == "__main__":
     unittest.main()
 
 if __name__ == "__main__":
     unittest.main()