Fix crash on docstrings ending with "\ " (#2142)

Co-authored-by: Łukasz Langa <lukasz@langa.pl>

diff --git a/CHANGES.md b/CHANGES.md
index 9fe6b7e3fa4afd403ef25879267b7b745267be27..814956c80ba0729b813a63e6876797716eb5b127 100644 (file)
--- a/CHANGES.md
+++ b/CHANGES.md
@@ -4,6 +4,8 @@
 
 #### _Black_
 
 
 #### _Black_
 

+- Fix crash on docstrings ending with "\ ". (#2142)
+

 - Reflect the `--skip-magic-trailing-comma` and `--experimental-string-processing` flags
   in the name of the cache file. Without this fix, changes in these flags would not take
   effect if the cache had already been populated. (#2131)
 - Reflect the `--skip-magic-trailing-comma` and `--experimental-string-processing` flags
   in the name of the cache file. Without this fix, changes in these flags would not take
   effect if the cache had already been populated. (#2131)

diff --git a/src/black/__init__.py b/src/black/__init__.py
index 99afc7d3c507fe06d0f21a1f1f50ea4a4b0577ad..051de5d13df58bfe7c0b6b300cfe629da27018d9 100644 (file)
--- a/src/black/__init__.py
+++ b/src/black/__init__.py
@@ -2186,7 +2186,13 @@ class LineGenerator(Visitor[Line]):
                 if docstring[0] == quote_char:
                     docstring = " " + docstring
                 if docstring[-1] == quote_char:
                 if docstring[0] == quote_char:
                     docstring = " " + docstring
                 if docstring[-1] == quote_char:

-                    docstring = docstring + " "
+                    docstring += " "
+                if docstring[-1] == "\\":
+                    backslash_count = len(docstring) - len(docstring.rstrip("\\"))
+                    if backslash_count % 2:
+                        # Odd number of tailing backslashes, add some padding to
+                        # avoid escaping the closing string quote.
+                        docstring += " "

             else:
                 # Add some padding if the docstring is empty.
                 docstring = " "
             else:
                 # Add some padding if the docstring is empty.
                 docstring = " "

diff --git a/tests/data/docstring.py b/tests/data/docstring.py
index 9e1c2441e0e2ebb344fe5ad793b7c6a3e44c0a2a..ee6d0c051d700bff8953ea5b1402a31896950450 100644 (file)
--- a/tests/data/docstring.py
+++ b/tests/data/docstring.py
@@ -158,6 +158,22 @@ def docstring_with_inline_tabs_and_tab_indentation():
        """
        pass
 
        """
        pass
 

+
+def backslash_space():
+    """\ """
+
+
+def multiline_backslash_1():
+  '''
+  hey\there\
+  \ '''
+
+
+def multiline_backslash_2():
+  '''
+  hey there \ '''
+
+

 # output
 
 class MyClass:
 # output
 
 class MyClass:


@@ -316,3 +332,18 @@ def docstring_with_inline_tabs_and_tab_indentation():
     line ends with some tabs
     """
     pass
     line ends with some tabs
     """
     pass

+
+
+def backslash_space():
+    """\ """
+
+
+def multiline_backslash_1():
+    """
+  hey\there\
+  \ """
+
+
+def multiline_backslash_2():
+    """
+    hey there \ """