Skip to content

Commit

Permalink
Treat raw strings like other docstrings (#3947)
Browse files Browse the repository at this point in the history
Fixes #3944
  • Loading branch information
JelleZijlstra authored Oct 16, 2023
1 parent 1648ac5 commit abe57e3
Show file tree
Hide file tree
Showing 4 changed files with 44 additions and 5 deletions.
1 change: 1 addition & 0 deletions CHANGES.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@
multiple lines (#3899)
- Magic trailing commas are now respected in return types. (#3916)
- Require one empty line after module-level docstrings. (#3932)
- Treat raw triple-quoted strings as docstrings (#3947)

### Configuration

Expand Down
15 changes: 10 additions & 5 deletions src/black/lines.py
Original file line number Diff line number Diff line change
Expand Up @@ -193,11 +193,16 @@ def is_class_paren_empty(self) -> bool:
@property
def is_triple_quoted_string(self) -> bool:
"""Is the line a triple quoted string?"""
return (
bool(self)
and self.leaves[0].type == token.STRING
and self.leaves[0].value.startswith(('"""', "'''"))
)
if not self or self.leaves[0].type != token.STRING:
return False
value = self.leaves[0].value
if value.startswith(('"""', "'''")):
return True
if Preview.accept_raw_docstrings in self.mode and value.startswith(
("r'''", 'r"""', "R'''", 'R"""')
):
return True
return False

@property
def opens_block(self) -> bool:
Expand Down
1 change: 1 addition & 0 deletions src/black/mode.py
Original file line number Diff line number Diff line change
Expand Up @@ -188,6 +188,7 @@ class Preview(Enum):
dummy_implementations = auto()
walrus_subscript = auto()
module_docstring_newlines = auto()
accept_raw_docstrings = auto()
fix_power_op_line_length = auto()


Expand Down
32 changes: 32 additions & 0 deletions tests/data/raw_docstring.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# flags: --preview --skip-string-normalization
class C:

r"""Raw"""

def f():

r"""Raw"""

class SingleQuotes:


r'''Raw'''

class UpperCaseR:
R"""Raw"""

# output
class C:
r"""Raw"""


def f():
r"""Raw"""


class SingleQuotes:
r'''Raw'''


class UpperCaseR:
R"""Raw"""

0 comments on commit abe57e3

Please sign in to comment.