Skip to content

[7.4.x] Ensure the docstring is a string #11751

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Dec 31, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions AUTHORS
Original file line number Diff line number Diff line change
Expand Up @@ -376,6 +376,7 @@ Tomer Keren
Tony Narlock
Tor Colvin
Trevor Bekolay
Tushar Sadhwani
Tyler Goodlet
Tyler Smart
Tzu-ping Chung
Expand Down
1 change: 1 addition & 0 deletions changelog/11140.bugfix.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Fix non-string constants at the top of file being detected as docstrings on Python>=3.8.
14 changes: 10 additions & 4 deletions src/_pytest/assertion/rewrite.py
Original file line number Diff line number Diff line change
Expand Up @@ -604,6 +604,13 @@ def _write_and_reset() -> None:
return ret


def _get_ast_constant_value(value: astStr) -> object:
if sys.version_info >= (3, 8):
return value.value
else:
return value.s


class AssertionRewriter(ast.NodeVisitor):
"""Assertion rewriting implementation.

Expand Down Expand Up @@ -700,11 +707,10 @@ def run(self, mod: ast.Module) -> None:
expect_docstring
and isinstance(item, ast.Expr)
and isinstance(item.value, astStr)
and isinstance(_get_ast_constant_value(item.value), str)
):
if sys.version_info >= (3, 8):
doc = item.value.value
else:
doc = item.value.s
doc = _get_ast_constant_value(item.value)
assert isinstance(doc, str)
if self.is_rewrite_disabled(doc):
return
expect_docstring = False
Expand Down
14 changes: 14 additions & 0 deletions testing/test_assertrewrite.py
Original file line number Diff line number Diff line change
Expand Up @@ -2077,3 +2077,17 @@ def test_max_increased_verbosity(self, pytester: Pytester) -> None:
self.create_test_file(pytester, DEFAULT_REPR_MAX_SIZE * 10)
result = pytester.runpytest("-vv")
result.stdout.no_fnmatch_line("*xxx...xxx*")


class TestIssue11140:
def test_constant_not_picked_as_module_docstring(self, pytester: Pytester) -> None:
pytester.makepyfile(
"""\
0

def test_foo():
pass
"""
)
result = pytester.runpytest()
assert result.ret == 0