Skip to content

Commit

Permalink
Improve AST safety check (#4290)
Browse files Browse the repository at this point in the history
Fixes #4288, regressed by #4270
  • Loading branch information
hauntsaninja authored Mar 23, 2024
1 parent 13bd092 commit 836acad
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 4 deletions.
2 changes: 2 additions & 0 deletions CHANGES.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@

<!-- Changes that affect Black's stable style -->

- Fix unwanted crashes caused by AST equivalency check (#4290)

### Preview style

<!-- Changes that affect Black's preview style -->
Expand Down
6 changes: 2 additions & 4 deletions src/black/parsing.py
Original file line number Diff line number Diff line change
Expand Up @@ -223,11 +223,9 @@ def _stringify_ast(node: ast.AST, parent_stack: List[ast.AST]) -> Iterator[str]:
and field == "value"
and isinstance(value, str)
and len(parent_stack) >= 2
# Any standalone string, ideally this would
# exactly match black.nodes.is_docstring
and isinstance(parent_stack[-1], ast.Expr)
and isinstance(
parent_stack[-2],
(ast.FunctionDef, ast.AsyncFunctionDef, ast.Module, ast.ClassDef),
)
):
# Constant strings may be indented across newlines, if they are
# docstrings; fold spaces after newlines when comparing. Similarly,
Expand Down
16 changes: 16 additions & 0 deletions tests/test_black.py
Original file line number Diff line number Diff line change
Expand Up @@ -2904,6 +2904,22 @@ async def f():
"""docstring"""
''',
)
self.check_ast_equivalence(
"""
if __name__ == "__main__":
" docstring-like "
""",
'''
if __name__ == "__main__":
"""docstring-like"""
''',
)
self.check_ast_equivalence(r'def f(): r" \n "', r'def f(): "\\n"')
self.check_ast_equivalence('try: pass\nexcept: " x "', 'try: pass\nexcept: "x"')

self.check_ast_equivalence(
'def foo(): return " x "', 'def foo(): return "x"', should_fail=True
)

def test_assert_equivalent_fstring(self) -> None:
major, minor = sys.version_info[:2]
Expand Down

0 comments on commit 836acad

Please sign in to comment.