]> git.madduck.net Git - etc/vim.git/commitdiff

madduck's git repository

Every one of the projects in this repository is available at the canonical URL git://git.madduck.net/madduck/pub/<projectpath> — see each project's metadata for the exact URL.

All patches and comments are welcome. Please squash your changes to logical commits before using git-format-patch and git-send-email to patches@git.madduck.net. If you'd read over the Git project's submission guidelines and adhered to them, I'd be especially grateful.

SSH access, as well as push access can be individually arranged.

If you use my repositories frequently, consider adding the following snippet to ~/.gitconfig and using the third clone URL listed for each project:

[url "git://git.madduck.net/madduck/"]
  insteadOf = madduck:

Fix an issue where extra empty lines are added. (#3470)
authorYilei "Dolee" Yang <yileiyang@google.com>
Wed, 21 Dec 2022 01:58:02 +0000 (17:58 -0800)
committerGitHub <noreply@github.com>
Wed, 21 Dec 2022 01:58:02 +0000 (17:58 -0800)
CHANGES.md
src/black/lines.py
tests/data/preview/comments9.py

index e2c5adfda35542ea0a14f7f5e327d54ed0bea89b..c07d81d13204c44adc8da12a54876c8d1fc1aa9f 100644 (file)
@@ -23,6 +23,8 @@
   regular and f-strings start with an empty span (#3463)
 - Fix a crash in preview advanced string processing where a standalone comment is placed
   before a dict's value (#3469)
   regular and f-strings start with an empty span (#3463)
 - Fix a crash in preview advanced string processing where a standalone comment is placed
   before a dict's value (#3469)
+- Fix an issue where extra empty lines are added when a decorator has `# fmt: skip`
+  applied or there is a standalone comment between decorators (#3470)
 - Do not put the closing quotes in a docstring on a separate line, even if the line is
   too long (#3430)
 - Long values in dict literals are now wrapped in parentheses; correspondingly
 - Do not put the closing quotes in a docstring on a separate line, even if the line is
   too long (#3430)
 - Long values in dict literals are now wrapped in parentheses; correspondingly
index 08281bcf370a1a987fcffa9602d54a7fe3d71593..2aa675c3b31c21b8c38438916387da56807499c6 100644 (file)
@@ -520,7 +520,8 @@ class EmptyLineTracker:
                 and (self.semantic_leading_comment is None or before)
             ):
                 self.semantic_leading_comment = block
                 and (self.semantic_leading_comment is None or before)
             ):
                 self.semantic_leading_comment = block
-        elif not current_line.is_decorator:
+        # `or before` means this decorator already has an empty line before
+        elif not current_line.is_decorator or before:
             self.semantic_leading_comment = None
 
         self.previous_line = current_line
             self.semantic_leading_comment = None
 
         self.previous_line = current_line
index 449612c037a7df41469550509c56d778a49c1ef6..77b25556e74aae2dc4a02e4e32f2b7aac460d484 100644 (file)
@@ -114,6 +114,31 @@ class MyClass:
         pass
 
 
         pass
 
 
+# Regression test for https://github.com/psf/black/issues/3454.
+def foo():
+    pass
+    # Trailing comment that belongs to this function
+
+
+@decorator1
+@decorator2  # fmt: skip
+def bar():
+    pass
+
+
+# Regression test for https://github.com/psf/black/issues/3454.
+def foo():
+    pass
+    # Trailing comment that belongs to this function.
+    # NOTE this comment only has one empty line below, and the formatter
+    # should enforce two blank lines.
+
+@decorator1
+# A standalone comment
+def bar():
+    pass
+
+
 # output
 
 
 # output
 
 
@@ -252,3 +277,29 @@ class MyClass:
     # More comments.
     def first_method(self):
         pass
     # More comments.
     def first_method(self):
         pass
+
+
+# Regression test for https://github.com/psf/black/issues/3454.
+def foo():
+    pass
+    # Trailing comment that belongs to this function
+
+
+@decorator1
+@decorator2  # fmt: skip
+def bar():
+    pass
+
+
+# Regression test for https://github.com/psf/black/issues/3454.
+def foo():
+    pass
+    # Trailing comment that belongs to this function.
+    # NOTE this comment only has one empty line below, and the formatter
+    # should enforce two blank lines.
+
+
+@decorator1
+# A standalone comment
+def bar():
+    pass