Fix comments getting removed from inside parenthesized strings (#3909)

Since the id of the old leaf may be
the key to comments, the new leaf
must adopt the old comments

diff --git a/CHANGES.md b/CHANGES.md
index a879ab3e8daf97ef2e64f5e99b413a1761f19498..028a01acd6274d4017bb55a4ff1debc86e99e1e8 100644 (file)
--- a/CHANGES.md
+++ b/CHANGES.md
@@ -17,6 +17,8 @@
 
 <!-- Changes that affect Black's preview style -->
 
 
 <!-- Changes that affect Black's preview style -->
 

+- Fix comments getting removed from inside parenthesized strings (#3909)
+

 ### Configuration
 
 <!-- Changes to how Black can be configured -->
 ### Configuration
 
 <!-- Changes to how Black can be configured -->

diff --git a/src/black/trans.py b/src/black/trans.py
index daed26427d79f2518cec3df0ff32f6e82025506e..c0cc92613acba59996d25dba09701f2137a10985 100644 (file)
--- a/src/black/trans.py
+++ b/src/black/trans.py
@@ -942,6 +942,9 @@ class StringParenStripper(StringTransformer):
                 LL[lpar_or_rpar_idx].remove()  # Remove lpar.
                 replace_child(LL[idx], string_leaf)
                 new_line.append(string_leaf)
                 LL[lpar_or_rpar_idx].remove()  # Remove lpar.
                 replace_child(LL[idx], string_leaf)
                 new_line.append(string_leaf)

+                # replace comments
+                old_comments = new_line.comments.pop(id(LL[idx]), [])
+                new_line.comments.setdefault(id(string_leaf), []).extend(old_comments)

             else:
                 LL[lpar_or_rpar_idx].remove()  # This is a rpar.
 
             else:
                 LL[lpar_or_rpar_idx].remove()  # This is a rpar.
 

diff --git a/tests/data/preview/comments7.py b/tests/data/preview/comments7.py
index 8b1224017e5208878cd7ef51dad87df81bc85eef..0655de999ece6ef8783af25e051b1f620ef0a012 100644 (file)
--- a/tests/data/preview/comments7.py
+++ b/tests/data/preview/comments7.py
@@ -131,6 +131,18 @@ class C:
 
 square = Square(4) # type: Optional[Square]
 
 
 square = Square(4) # type: Optional[Square]
 

+# Regression test for https://github.com/psf/black/issues/3756.
+[
+    (
+        "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"  # aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
+    ),
+]
+[
+    (  # aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
+        "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"  # aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
+    ),
+]
+

 # output
 
 from .config import (
 # output
 
 from .config import (


@@ -282,3 +294,15 @@ class C:
 
 
 square = Square(4)  # type: Optional[Square]
 
 
 square = Square(4)  # type: Optional[Square]

+
+# Regression test for https://github.com/psf/black/issues/3756.
+[
+    (  # aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
+        "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
+    ),
+]
+[
+    (  # aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
+        "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"  # aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
+    ),
+]