Skip to content

gh-124022: Fix bug where class docstring is removed in interactive mode #124023

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.

Sign up for GitHub

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 9 commits into from
Sep 13, 2024
Merged

gh-124022: Fix bug where class docstring is removed in interactive mode #124023

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
a4da842
gh-124022: Fix extrenous NOP when class docstring is removed in inter…
iritkatriel Sep 12, 2024
e3ed9f4
📜🤖 Added by blurb_it.
blurb-it[bot] Sep 12, 2024
6626973
don't do anything different in interactive mode
iritkatriel Sep 12, 2024
db7f999
update news
iritkatriel Sep 12, 2024
16083e5
Apply suggestions from code review
iritkatriel Sep 12, 2024
0535265
test both func and class
iritkatriel Sep 12, 2024
53a9e48
Fix bug where string literals in REPL got interpreted as docstrings
JelleZijlstra Sep 13, 2024
6de4f83
shorter comment
iritkatriel Sep 13, 2024
5f4c940
even shorter
iritkatriel Sep 13, 2024
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
18 changes: 18 additions & 0 deletions Lib/test/test_compile.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -926,6 +926,24 @@ class C:
dis.dis(code)
self.assertNotIn('NOP' , output.getvalue())

@support.cpython_only
def test_docstring_removed_no_NOP_interactive_mode(self):
# See gh-124022
src = textwrap.dedent("""
class C:
"docstring"
x = 42
""")
for opt in [-1, 0, 1, 2]:
with self.subTest(opt=opt):
code = compile(src, "<test>", "single", optimize=opt)
# make sure the bytecode doesn't have any instruction
# on line 3, where the docstring is, but we have
# instructions for the assignment in line 4.
lines = [line for (_, _, line) in code.co_consts[0].co_lines()]
self.assertNotIn(3, lines)
self.assertIn(4, lines)

def test_dont_merge_constants(self):
# Issue #25843: compile() must not merge constants which are equal
# but have a different type.
Expand Down
8 changes: 4 additions & 4 deletions Python/codegen.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -758,10 +758,10 @@ _PyCodegen_Body(compiler *c, location loc, asdl_stmt_seq *stmts)
return SUCCESS;
}
Py_ssize_t first_instr = 0;
if (!IS_INTERACTIVE(c)) {
PyObject *docstring = _PyAST_GetDocString(stmts);
if (docstring) {
first_instr = 1;
PyObject *docstring = _PyAST_GetDocString(stmts);
if (docstring) {
first_instr = 1;
if (!IS_INTERACTIVE(c)) {
/* set docstring */
assert(OPTIMIZATION_LEVEL(c) < 2);
PyObject *cleandoc = _PyCompile_CleanDoc(docstring);
Expand Down
Loading