Correctly handle fmt: skip comments without internal spaces (#2970)

Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>

diff --git a/CHANGES.md b/CHANGES.md
index e168e24d76e2c0e25c1047ab44197f6721b1c27e..b21c319d5e0e9535c7814df2e9092fd36fb8fdd9 100644 (file)
--- a/CHANGES.md
+++ b/CHANGES.md
@@ -10,6 +10,9 @@
 
 <!-- Changes that affect Black's stable style -->
 
 
 <!-- Changes that affect Black's stable style -->
 

+- Fix unstable formatting involving `# fmt: skip` comments without internal spaces
+  (#2970)
+

 ### Preview style
 
 <!-- Changes that affect Black's preview style -->
 ### Preview style
 
 <!-- Changes that affect Black's preview style -->

diff --git a/src/black/comments.py b/src/black/comments.py
index 455326469f0f3b9c42764b0867fda22d121914dc..23bf87fca7cb8e9a1fea521417cc80241aabfbd6 100644 (file)
--- a/src/black/comments.py
+++ b/src/black/comments.py
@@ -214,8 +214,11 @@ def generate_ignored_nodes(
     container: Optional[LN] = container_of(leaf)
     if comment.value in FMT_SKIP:
         prev_sibling = leaf.prev_sibling
     container: Optional[LN] = container_of(leaf)
     if comment.value in FMT_SKIP:
         prev_sibling = leaf.prev_sibling

-        if comment.value in leaf.prefix and prev_sibling is not None:
-            leaf.prefix = leaf.prefix.replace(comment.value, "")
+        # Need to properly format the leaf prefix to compare it to comment.value,
+        # which is also formatted
+        comments = list_comments(leaf.prefix, is_endmarker=False, preview=preview)
+        if comments and comment.value == comments[0].value and prev_sibling is not None:
+            leaf.prefix = ""

             siblings = [prev_sibling]
             while (
                 "\n" not in prev_sibling.prefix
             siblings = [prev_sibling]
             while (
                 "\n" not in prev_sibling.prefix

diff --git a/tests/data/fmtskip7.py b/tests/data/fmtskip7.py
new file mode 100644 (file)
index 0000000..15ac0ad
--- /dev/null
+++ b/tests/data/fmtskip7.py
@@ -0,0 +1,11 @@
+a =     "this is some code"
+b =     5  #fmt:skip
+c = 9  #fmt: skip
+d = "thisisasuperlongstringthisisasuperlongstringthisisasuperlongstringthisisasuperlongstring"  #fmt:skip
+
+# output
+
+a = "this is some code"
+b =     5  # fmt:skip
+c = 9  # fmt: skip
+d = "thisisasuperlongstringthisisasuperlongstringthisisasuperlongstringthisisasuperlongstring"  # fmt:skip

diff --git a/tests/test_format.py b/tests/test_format.py
index 51d8fb0a1035e2b142609ae804f69c0bfd5153a2..fd5f596b6d54b75065ef4ff0aab0287266936fde 100644 (file)
--- a/tests/test_format.py
+++ b/tests/test_format.py
@@ -44,6 +44,7 @@ SIMPLE_CASES: List[str] = [
     "fmtskip4",
     "fmtskip5",
     "fmtskip6",
     "fmtskip4",
     "fmtskip5",
     "fmtskip6",

+    "fmtskip7",

     "fstring",
     "function",
     "function2",
     "fstring",
     "function",
     "function2",