Unverified Commit 557b54aa authored by Jelle Zijlstra's avatar Jelle Zijlstra Committed by GitHub
Browse files

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

Co-authored-by: default avatarŁukasz Langa <lukasz@langa.pl>
parent 97c24664
Loading
Loading
Loading
Loading
+2 −0
Changes for CHANGES.md: 2 added lines, 0 removed lines.
Original line number Diff line number Diff line
@@ -4,6 +4,8 @@

#### _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)
+7 −1
Changes for src/black/__init__.py: 7 added lines, 1 removed line.
Original line number Diff line number Diff line
@@ -2186,7 +2186,13 @@ def visit_STRING(self, leaf: Leaf) -> Iterator[Line]:
                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 = " "
+31 −0
Changes for tests/data/docstring.py: 31 added lines, 0 removed lines.
Original line number Diff line number Diff line
@@ -158,6 +158,22 @@ def docstring_with_inline_tabs_and_tab_indentation():
	"""
	pass


def backslash_space():
    """\ """


def multiline_backslash_1():
  '''
  hey\there\
  \ '''


def multiline_backslash_2():
  '''
  hey there \ '''


# output

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


def backslash_space():
    """\ """


def multiline_backslash_1():
    """
  hey\there\
  \ """


def multiline_backslash_2():
    """
    hey there \ """