Skip to content

Bytecode parity#7475

Open
youknowone wants to merge 15 commits intoRustPython:mainfrom
youknowone:bytecode-parity-phase1
Open

Bytecode parity#7475
youknowone wants to merge 15 commits intoRustPython:mainfrom
youknowone:bytecode-parity-phase1

Conversation

@youknowone
Copy link
Member

@youknowone youknowone commented Mar 20, 2026

Summary by CodeRabbit

  • Bug Fixes

    • Fixed container-modifying operations and exception handling so items are placed consistently and attribute lookups behave more reliably.
    • Made boolean evaluation and conditional emission consistent across more expression types.
  • Refactor

    • Made function exit/final-return handling and bytecode optimization ordering more consistent.
  • New Features

    • Added tools to dump and compare bytecode between interpreters for easier regression analysis.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Mar 20, 2026

📝 Walkthrough

Walkthrough

Compiler, IR, VM, symbol-table, and tooling updates: bytecode emission indices for container ops changed, closure/freevar setup emitted earlier, a CFG pass duplicates final returns, VM stack-indexing adjusted, class/module store/load ordering changed, symbol-table now marks classdict needs earlier, and two bytecode-diffing scripts were added.

Changes

Cohort / File(s) Summary
Compiler codegen
crates/codegen/src/compile.rs
Adjusted indices for streaming/append/extend/add ops (e.g., ListAppend/ListExtend/MapAdd/SetAdd/SetUpdate), changed comprehension index math, moved MAKE_CELL+COPY_FREE_VARS emission before RESUME in enter_scope, altered module/class __doc__/__name__/__firstlineno__ load/store ops and ordering, emit __static_attributes__ for classes, special-case storing __classdictcell__, changed compile_jump_if to emit ToBool for non-Compare exprs, and modified attribute/method load behavior for imported module receivers.
IR finalization / CFG pass
crates/codegen/src/ir.rs
Always run dce() during CodeInfo::finalize_code, added duplicate_end_returns() inserted after normalize_jumps() to clone final LoadConst; ReturnValue into eligible fall-through blocks, and reordered post-processing passes accordingly.
VM frame stack indexing
crates/vm/src/frame.rs
Adjusted stack-slot selection for container-modifying instructions by decrementing the index lookup (i.get(arg) - 1) so container target selection matches updated compiler bytecode indices.
Symbol table / classdict logic
crates/codegen/src/symboltable.rs
drop_class_free now sets symbol_table.needs_classdict = true when the class has any immediate function sub-scopes, ensuring classdict is required in those cases.
Tools — bytecode diffing & dumping
scripts/dis_dump.py, scripts/compare_bytecode.py
Added dis_dump.py to compile .py files and produce normalized JSON bytecode dumps; added compare_bytecode.py to run CPython vs RustPython dumps, compare instruction lists recursively, classify diffs/errors, and optionally emit summary JSON and detailed reports.

Sequence Diagram(s)

mermaid
sequenceDiagram
participant Dev as Developer/Compiler
participant IR as CodeInfo/CFG
participant VM as VirtualMachine
participant Tools as Scripts (dis_dump / compare_bytecode)

Dev->>IR: emit bytecode (MAKE_CELL / COPY_FREE_VARS before RESUME;\nadjusted List/Set/Map indices; name/store ordering changes)
IR->>IR: normalize_jumps()\nduplicate_end_returns()
IR->>VM: finalize code object (dce + peephole)
VM->>VM: execute bytecode (adjusted stack-index selection for container ops)
Tools->>VM: collect/run bytecode dumps (compare CPython ↔ RustPython)

Estimated code review effort

🎯 4 (Complex) | ⏱️ ~45 minutes

Possibly related PRs

Suggested reviewers

  • ShaharNaveh

Poem

🐰 I hopped through opcodes, quick and bright,
Moved MAKE_CELL up to set the scope right,
Copied final returns to every neat lane,
Tuned append indices so the stack won't complain,
I nibble bytecode — a rabbit's small byte-night.

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'Bytecode parity' is directly related to the changeset which modifies bytecode generation and stack indexing across multiple compiler modules to align RustPython's bytecode with CPython, and adds bytecode comparison scripts.
Docstring Coverage ✅ Passed Docstring coverage is 86.67% which is sufficient. The required threshold is 80.00%.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@youknowone youknowone force-pushed the bytecode-parity-phase1 branch from ab3cbd9 to 7ff591f Compare March 20, 2026 11:41
@github-actions
Copy link
Contributor

github-actions bot commented Mar 20, 2026

📦 Library Dependencies

The following Lib/ modules were modified. Here are their dependencies:

[ ] test: cpython/Lib/test/test_descr.py (TODO: 40)
[ ] test: cpython/Lib/test/test_descrtut.py (TODO: 3)

dependencies:

dependent tests: (no tests depend on descr)

[x] lib: cpython/Lib/dis.py
[ ] test: cpython/Lib/test/test_dis.py (TODO: 35)

dependencies:

  • dis

dependent tests: (70 tests)

  • dis: test__opcode test_ast test_code test_compile test_compiler_assemble test_dis test_dtrace test_fstring test_inspect test_monitoring test_opcache test_patma test_peepholer test_positional_only_arg
    • bdb: test_bdb
    • inspect: test_abc test_argparse test_asyncgen test_buffer test_builtin test_collections test_coroutines test_decimal test_enum test_functools test_generators test_grammar test_ntpath test_operator test_posixpath test_pydoc test_signal test_sqlite3 test_traceback test_type_annotations test_types test_typing test_unittest test_yield_from test_zipimport test_zoneinfo
      • ast: test_compiler_codegen test_future_stmt test_site test_ssl test_type_comments test_ucn test_unparse
      • asyncio: test_asyncio test_contextlib_async test_logging test_os test_sys_settrace test_unittest
      • cmd: test_cmd
      • dataclasses: test__colorize test_copy test_ctypes test_genericalias test_pprint test_regrtest
      • importlib.metadata: test_importlib
      • pkgutil: test_pkgutil test_runpy
      • rlcompleter: test_rlcompleter
      • trace: test_trace
      • xmlrpc.server: test_docxmlrpc test_xmlrpc
    • modulefinder: test_importlib test_modulefinder

Legend:

  • [+] path exists in CPython
  • [x] up-to-date, [ ] outdated

@youknowone youknowone marked this pull request as ready for review March 20, 2026 12:18
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 2

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@crates/codegen/src/compile.rs`:
- Around line 6732-6735: The comment above the ToBool emission is misleading
because ast::Expr::Compare may produce non-bool values; update the comment near
the if !matches!(expression, ast::Expr::Compare) check to state that the Compare
fast path is safe due to the jump opcode’s truthiness handling (not because
Compare always yields a bool), and clarify that everything else needs
Instruction::ToBool before branching; reference the emit!(self,
Instruction::ToBool) call and the ast::Expr::Compare pattern in the comment.
- Around line 4626-4649: The current block always emits and stores an empty
tuple to __static_attributes__ because enter_scope() initializes
static_attributes to Some(empty) but nothing is added before this emit; update
compile.rs to skip emitting/storing __static_attributes__ when the collected
attrs vector is empty (i.e., check the
code_stack.last().unwrap().static_attributes contents and only call
emit_load_const/Instruction::StoreName/name("__static_attributes__") if attrs is
non-empty), or alternatively change enter_scope() to initialize
static_attributes as None and only create/populate it when the collector runs;
target the symbols static_attributes, enter_scope, emit_load_const,
Instruction::StoreName and name("__static_attributes__") when making the change.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yml

Review profile: CHILL

Plan: Pro

Run ID: df81d4bb-8612-4e9c-a28a-4f556bc8453f

📥 Commits

Reviewing files that changed from the base of the PR and between 2ef77f8 and 7ff591f.

⛔ Files ignored due to path filters (4)
  • Lib/test/test_descr.py is excluded by !Lib/**
  • crates/codegen/src/snapshots/rustpython_codegen__compile__tests__if_ands.snap is excluded by !**/*.snap
  • crates/codegen/src/snapshots/rustpython_codegen__compile__tests__if_mixed.snap is excluded by !**/*.snap
  • crates/codegen/src/snapshots/rustpython_codegen__compile__tests__if_ors.snap is excluded by !**/*.snap
📒 Files selected for processing (1)
  • crates/codegen/src/compile.rs

Comment on lines +4626 to +4649
// Emit __static_attributes__ tuple
{
let attrs: Vec<String> = self
.code_stack
.last()
.unwrap()
.static_attributes
.as_ref()
.map(|s| s.iter().cloned().collect())
.unwrap_or_default();
self.emit_load_const(ConstantData::Tuple {
elements: attrs
.into_iter()
.map(|s| ConstantData::Str { value: s.into() })
.collect(),
});
let static_attrs_name = self.name("__static_attributes__");
emit!(
self,
Instruction::StoreName {
namei: static_attrs_name
}
);
}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟠 Major

__static_attributes__ is always serialized as () here.

enter_scope() initializes every class with Some(IndexSet::default()) on Line 1120, but this file never inserts into that set before reaching this block. The new store therefore overwrites every class body’s __static_attributes__ with an empty tuple, including any explicit assignment made in body. Either populate static_attributes before this point or skip the store until the set is non-empty.

Minimal guard to avoid clobbering classes until the collector exists
-        // Emit __static_attributes__ tuple
-        {
-            let attrs: Vec<String> = self
-                .code_stack
-                .last()
-                .unwrap()
-                .static_attributes
-                .as_ref()
-                .map(|s| s.iter().cloned().collect())
-                .unwrap_or_default();
-            self.emit_load_const(ConstantData::Tuple {
-                elements: attrs
-                    .into_iter()
-                    .map(|s| ConstantData::Str { value: s.into() })
-                    .collect(),
-            });
-            let static_attrs_name = self.name("__static_attributes__");
-            emit!(
-                self,
-                Instruction::StoreName {
-                    namei: static_attrs_name
-                }
-            );
-        }
+        if let Some(attrs) = self
+            .code_stack
+            .last()
+            .and_then(|info| info.static_attributes.as_ref())
+            .filter(|attrs| !attrs.is_empty())
+        {
+            self.emit_load_const(ConstantData::Tuple {
+                elements: attrs
+                    .iter()
+                    .cloned()
+                    .map(|s| ConstantData::Str { value: s.into() })
+                    .collect(),
+            });
+            let static_attrs_name = self.name("__static_attributes__");
+            emit!(self, Instruction::StoreName { namei: static_attrs_name });
+        }
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@crates/codegen/src/compile.rs` around lines 4626 - 4649, The current block
always emits and stores an empty tuple to __static_attributes__ because
enter_scope() initializes static_attributes to Some(empty) but nothing is added
before this emit; update compile.rs to skip emitting/storing
__static_attributes__ when the collected attrs vector is empty (i.e., check the
code_stack.last().unwrap().static_attributes contents and only call
emit_load_const/Instruction::StoreName/name("__static_attributes__") if attrs is
non-empty), or alternatively change enter_scope() to initialize
static_attributes as None and only create/populate it when the collector runs;
target the symbols static_attributes, enter_scope, emit_load_const,
Instruction::StoreName and name("__static_attributes__") when making the change.

Comment on lines +6732 to +6735
// Compare already produces a bool; everything else needs TO_BOOL
if !matches!(expression, ast::Expr::Compare(_)) {
emit!(self, Instruction::ToBool);
}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

The Compare rationale is inaccurate.

Rich comparisons can return arbitrary objects; the reason this fast path is safe is the jump opcode’s truthiness handling, not that Compare itself always yields a bool. Please reword the comment so future refactors do not depend on the wrong invariant.

Suggested comment update
-                // Compare already produces a bool; everything else needs TO_BOOL
+                // Rich comparisons may return non-bool objects; skipping TO_BOOL
+                // here is only correct because PopJumpIf* performs truthiness
+                // conversion itself.
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
// Compare already produces a bool; everything else needs TO_BOOL
if !matches!(expression, ast::Expr::Compare(_)) {
emit!(self, Instruction::ToBool);
}
// Rich comparisons may return non-bool objects; skipping TO_BOOL
// here is only correct because PopJumpIf* performs truthiness
// conversion itself.
if !matches!(expression, ast::Expr::Compare(_)) {
emit!(self, Instruction::ToBool);
}
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@crates/codegen/src/compile.rs` around lines 6732 - 6735, The comment above
the ToBool emission is misleading because ast::Expr::Compare may produce
non-bool values; update the comment near the if !matches!(expression,
ast::Expr::Compare) check to state that the Compare fast path is safe due to the
jump opcode’s truthiness handling (not because Compare always yields a bool),
and clarify that everything else needs Instruction::ToBool before branching;
reference the emit!(self, Instruction::ToBool) call and the ast::Expr::Compare
pattern in the comment.

- Emit TO_BOOL before POP_JUMP_IF_TRUE/FALSE in the general case
  of compile_jump_if (Compare expressions excluded since they
  already produce a bool)
- Module-level __doc__: use STORE_NAME instead of STORE_GLOBAL
- Class body __module__: use LOAD_NAME instead of LOAD_GLOBAL
- Class body: store __firstlineno__ before __doc__
Emit MAKE_CELL for each cell variable and COPY_FREE_VARS N for
free variables at the start of each code object, before RESUME.
These instructions are no-ops in the VM but align the bytecode
with CPython 3.14's output.
Store a tuple of attribute names (currently always empty) as
__static_attributes__ in the class namespace, matching CPython
3.14's class body epilogue. Attribute name collection from
self.xxx accesses is a follow-up task.
test_iter_keys, test_iter_values, test_iter_items now pass
because class bodies emit __static_attributes__ and
__firstlineno__, matching the expected dict key set.
Switch LIST_APPEND, LIST_EXTEND, SET_ADD, SET_UPDATE, MAP_ADD
from 0-based to 1-based stack depth argument, matching CPython's
PEEK(oparg) convention. Adjust the VM to subtract 1 before
calling nth_value.
When the call target is an attribute of an imported name (e.g.,
logging.getLogger()), use plain LOAD_ATTR (method_flag=0) with
a separate PUSH_NULL instead of method-mode LOAD_ATTR. This
matches CPython 3.14's behavior which avoids the method call
optimization for module attribute access.
When the last block in a code object is exactly LOAD_CONST None +
RETURN_VALUE (the implicit return), duplicate these instructions
into blocks that would otherwise fall through to it. This matches
CPython 3.14's behavior of giving each code path its own explicit
return instruction.
@youknowone youknowone force-pushed the bytecode-parity-phase1 branch from 7ff591f to 904bdaf Compare March 20, 2026 13:56
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

♻️ Duplicate comments (2)
crates/codegen/src/compile.rs (2)

6732-6735: ⚠️ Potential issue | 🟡 Minor

Reword the Compare fast-path comment.

Rich comparisons can return arbitrary objects. Skipping TO_BOOL here is only safe because PopJumpIf* performs truthiness conversion itself.

Suggested comment update
-                // Compare already produces a bool; everything else needs TO_BOOL
+                // Rich comparisons may return non-bool objects; skipping TO_BOOL
+                // here is only correct because PopJumpIf* performs truthiness
+                // conversion itself.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@crates/codegen/src/compile.rs` around lines 6732 - 6735, Update the comment
above the Compare fast-path to note that rich comparisons may return arbitrary
objects and that we only skip emitting Instruction::ToBool for
ast::Expr::Compare because the subsequent conditional jump opcodes
(PopJumpIfTrue / PopJumpIfFalse / other PopJumpIf* handlers) perform the
truthiness conversion themselves; reference the match on expression
(ast::Expr::Compare), the emit!(self, Instruction::ToBool) call, and the
PopJumpIf* jump handlers to make the reason explicit.

4626-4649: ⚠️ Potential issue | 🟠 Major

__static_attributes__ is still always written as ().

This file only initializes static_attributes; it never populates it before this block runs. As written, every class body overwrites __static_attributes__ with an empty tuple, and it does so after compiling body, so it also clobbers an explicit class-body assignment.

Suggested guard until the collector is wired up
-        // Emit __static_attributes__ tuple
-        {
-            let attrs: Vec<String> = self
-                .code_stack
-                .last()
-                .unwrap()
-                .static_attributes
-                .as_ref()
-                .map(|s| s.iter().cloned().collect())
-                .unwrap_or_default();
-            self.emit_load_const(ConstantData::Tuple {
-                elements: attrs
-                    .into_iter()
-                    .map(|s| ConstantData::Str { value: s.into() })
-                    .collect(),
-            });
-            let static_attrs_name = self.name("__static_attributes__");
-            emit!(
-                self,
-                Instruction::StoreName {
-                    namei: static_attrs_name
-                }
-            );
-        }
+        if let Some(attrs) = self
+            .code_stack
+            .last()
+            .and_then(|info| info.static_attributes.as_ref())
+            .filter(|attrs| !attrs.is_empty())
+        {
+            self.emit_load_const(ConstantData::Tuple {
+                elements: attrs
+                    .iter()
+                    .cloned()
+                    .map(|s| ConstantData::Str { value: s.into() })
+                    .collect(),
+            });
+            let static_attrs_name = self.name("__static_attributes__");
+            emit!(self, Instruction::StoreName { namei: static_attrs_name });
+        }
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@crates/codegen/src/compile.rs` around lines 4626 - 4649, The code
unconditionally emits and stores __static_attributes__ as an empty tuple because
static_attributes is never populated; fix by guarding the emit: only call
emit_load_const + Instruction::StoreName for __static_attributes__ when
self.code_stack.last().unwrap().static_attributes is Some(vec) and the vec is
non-empty (i.e., contains attributes), so it doesn't overwrite an explicit
class-body assignment or write an empty tuple; use the existing
name("__static_attributes__"), emit_load_const, and the Instruction::StoreName
path when the Option has data.
🧹 Nitpick comments (1)
crates/vm/src/frame.rs (1)

2512-2512: Encode the new 1-based container depth in one place.

These five handlers now rely on the same subtle rule: the opcode arg is 1-based, nth_value() is 0-based, and the lookup happens after popping the transient operand(s). Repeating raw - 1 here makes that contract easy to miss or accidentally revert later; a tiny helper or short comment would make the parity rule much clearer.

Also applies to: 2522-2522, 2864-2864, 3195-3195, 3205-3205

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@crates/vm/src/frame.rs` at line 2512, Create a small helper to centralize the
1-based→0-based conversion and use it from the handlers instead of repeating `-
1`; for example add a method on the same type (e.g., fn arg_to_index(&self, arg:
u32) -> usize or fn nth_arg_value(&self, arg: u32) -> Value) and replace
occurrences like `let obj = self.nth_value(i.get(arg) - 1);` in the handlers
referenced (the sites at the current diff and the ones you noted: the uses at
~2522, ~2864, ~3195, ~3205) to call that helper so the parity rule is enforced
in one place and clearly named. Ensure the helper documents that opcode args are
1-based and nth_value is 0-based.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@crates/codegen/src/ir.rs`:
- Around line 1652-1660: The return-epilogue predicate (is_return_block) is too
broad — it matches any LOAD_CONST + RETURN_VALUE; narrow it by matching the
actual LoadConst payload to ensure it's specifically loading None: change the
second match clause that currently checks
AnyInstruction::Real(Instruction::LoadConst { .. }) to explicitly match the
constant variant for None (e.g. AnyInstruction::Real(Instruction::LoadConst {
value: Constant::None }) or the equivalent None representation used in this IR),
while keeping the subsequent AnyInstruction::Real(Instruction::ReturnValue)
check; use the existing symbols is_return_block, last_insts,
AnyInstruction::Real, Instruction::LoadConst and Instruction::ReturnValue to
locate and update the condition.

---

Duplicate comments:
In `@crates/codegen/src/compile.rs`:
- Around line 6732-6735: Update the comment above the Compare fast-path to note
that rich comparisons may return arbitrary objects and that we only skip
emitting Instruction::ToBool for ast::Expr::Compare because the subsequent
conditional jump opcodes (PopJumpIfTrue / PopJumpIfFalse / other PopJumpIf*
handlers) perform the truthiness conversion themselves; reference the match on
expression (ast::Expr::Compare), the emit!(self, Instruction::ToBool) call, and
the PopJumpIf* jump handlers to make the reason explicit.
- Around line 4626-4649: The code unconditionally emits and stores
__static_attributes__ as an empty tuple because static_attributes is never
populated; fix by guarding the emit: only call emit_load_const +
Instruction::StoreName for __static_attributes__ when
self.code_stack.last().unwrap().static_attributes is Some(vec) and the vec is
non-empty (i.e., contains attributes), so it doesn't overwrite an explicit
class-body assignment or write an empty tuple; use the existing
name("__static_attributes__"), emit_load_const, and the Instruction::StoreName
path when the Option has data.

---

Nitpick comments:
In `@crates/vm/src/frame.rs`:
- Line 2512: Create a small helper to centralize the 1-based→0-based conversion
and use it from the handlers instead of repeating `- 1`; for example add a
method on the same type (e.g., fn arg_to_index(&self, arg: u32) -> usize or fn
nth_arg_value(&self, arg: u32) -> Value) and replace occurrences like `let obj =
self.nth_value(i.get(arg) - 1);` in the handlers referenced (the sites at the
current diff and the ones you noted: the uses at ~2522, ~2864, ~3195, ~3205) to
call that helper so the parity rule is enforced in one place and clearly named.
Ensure the helper documents that opcode args are 1-based and nth_value is
0-based.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yml

Review profile: CHILL

Plan: Pro

Run ID: 7134ce0a-4869-417e-9966-1ac435da0e6a

📥 Commits

Reviewing files that changed from the base of the PR and between 7ff591f and 904bdaf.

⛔ Files ignored due to path filters (4)
  • Lib/test/test_descr.py is excluded by !Lib/**
  • crates/codegen/src/snapshots/rustpython_codegen__compile__tests__if_ands.snap is excluded by !**/*.snap
  • crates/codegen/src/snapshots/rustpython_codegen__compile__tests__if_mixed.snap is excluded by !**/*.snap
  • crates/codegen/src/snapshots/rustpython_codegen__compile__tests__if_ors.snap is excluded by !**/*.snap
📒 Files selected for processing (3)
  • crates/codegen/src/compile.rs
  • crates/codegen/src/ir.rs
  • crates/vm/src/frame.rs

Comment on lines +1652 to +1660
let is_return_block = last_insts.len() == 2
&& matches!(
last_insts[0].instr,
AnyInstruction::Real(Instruction::LoadConst { .. })
)
&& matches!(
last_insts[1].instr,
AnyInstruction::Real(Instruction::ReturnValue)
);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟠 Major

Return-epilogue detection is too broad for the documented behavior

Line 1652 only checks LOAD_CONST + RETURN_VALUE, but the function is documented to duplicate only LOAD_CONST None + RETURN_VALUE. This can duplicate explicit constant returns as well, which risks bytecode parity/tracing mismatches. Please tighten the predicate to verify the loaded constant is specifically None.

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@crates/codegen/src/ir.rs` around lines 1652 - 1660, The return-epilogue
predicate (is_return_block) is too broad — it matches any LOAD_CONST +
RETURN_VALUE; narrow it by matching the actual LoadConst payload to ensure it's
specifically loading None: change the second match clause that currently checks
AnyInstruction::Real(Instruction::LoadConst { .. }) to explicitly match the
constant variant for None (e.g. AnyInstruction::Real(Instruction::LoadConst {
value: Constant::None }) or the equivalent None representation used in this IR),
while keeping the subsequent AnyInstruction::Real(Instruction::ReturnValue)
check; use the existing symbols is_return_block, last_insts,
AnyInstruction::Real, Instruction::LoadConst and Instruction::ReturnValue to
locate and update the condition.

- scripts/dis_dump.py: Dumps normalized bytecode for Python files,
  usable with both CPython and RustPython. Normalizes code object
  reprs, COMPARE_OP argrepr, and LOAD_FAST_BORROW opnames.
- scripts/compare_bytecode.py: Orchestrates CPython vs RustPython
  bytecode comparison across Lib/, reports match rate and diffs.

Current baseline: 176/1515 files match (11.6%).
Set needs_classdict=true for class scopes that contain function
definitions (def/async def), matching CPython 3.14's behavior for
PEP 649 deferred annotation support. Also restore the Compare
expression check in compile_jump_if to skip TO_BOOL for comparison
operations.
Store the __classdict__ cell reference as __classdictcell__ in
the class namespace when the class has __classdict__ as a cell
variable. Uses LOAD_DEREF (RustPython separates cell vars from
fast locals unlike CPython's unified array).
Run basic dead code elimination (truncating instructions after
RETURN_VALUE/RAISE/JUMP within blocks) at all optimization
levels, not just optimize > 0. CPython always removes this dead
code during assembly.
Only use plain LOAD_ATTR + PUSH_NULL for imports at module or
class scope. Function-local imports use method call mode LOAD_ATTR,
matching CPython 3.14's behavior.
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 3

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)
crates/codegen/src/compile.rs (1)

3502-3507: ⚠️ Potential issue | 🟡 Minor

The inline stack math still describes the old 0-based operand scheme.

These comments still derive i = 2 / i = 0, but the emitted instructions are now i: 3 / i: 1 because the VM interprets these operands as 1-based depths. Please update the explanation so it matches the code.

Also applies to: 3532-3536

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@crates/codegen/src/compile.rs` around lines 3502 - 3507, The inline comments
in the LIST_APPEND handling are computing stack index using a 0-based operand
scheme while the VM uses 1-based depths; update the explanatory math around
Instruction::ListAppend { i: 3 } (and the analogous block at the location
covering 3532-3536) to show the 1-based depth calculation so the derivation
matches the emitted i values (e.g., explain that nth_value uses 1-based depth so
list is at depth 3 leading to i: 3, and adjust the other comment similarly).
♻️ Duplicate comments (2)
crates/codegen/src/compile.rs (2)

6745-6748: ⚠️ Potential issue | 🟡 Minor

The Compare rationale is still inaccurate.

Rich comparisons can return non-bool objects. The fast path is safe because PopJumpIf* performs truthiness handling, not because Compare itself guarantees a bool.

Suggested comment update
-                // Compare already produces a bool; everything else needs TO_BOOL
+                // Rich comparisons may return non-bool objects; skipping TO_BOOL
+                // here is only safe because PopJumpIf* performs truthiness
+                // conversion itself.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@crates/codegen/src/compile.rs` around lines 6745 - 6748, Update the inline
comment above the ToBool emission to correctly state that Compare may return
non-bool objects and that the reason we skip emitting Instruction::ToBool for
ast::Expr::Compare(_) is not that Compare guarantees a bool but because the
fast-path jump instructions (e.g., PopJumpIfTrue/PopJumpIfFalse) perform
truthiness handling themselves; replace the current "Compare already produces a
bool" wording with a note that Compare can return non-bool values and we rely on
PopJumpIf*'s truthiness semantics rather than forcing a ToBool.

4626-4649: ⚠️ Potential issue | 🟠 Major

__static_attributes__ is still always overwritten with ().

Line 4628 builds attrs from static_attributes, but this file never inserts into that set after class scopes initialize it to Some(IndexSet::default()) on Line 1120. Every class body will therefore store an empty tuple here and clobber any explicit __static_attributes__ assignment from body.

Possible guard
-        // Emit __static_attributes__ tuple
-        {
-            let attrs: Vec<String> = self
-                .code_stack
-                .last()
-                .unwrap()
-                .static_attributes
-                .as_ref()
-                .map(|s| s.iter().cloned().collect())
-                .unwrap_or_default();
-            self.emit_load_const(ConstantData::Tuple {
-                elements: attrs
-                    .into_iter()
-                    .map(|s| ConstantData::Str { value: s.into() })
-                    .collect(),
-            });
-            let static_attrs_name = self.name("__static_attributes__");
-            emit!(
-                self,
-                Instruction::StoreName {
-                    namei: static_attrs_name
-                }
-            );
-        }
+        if let Some(attrs) = self
+            .code_stack
+            .last()
+            .and_then(|info| info.static_attributes.as_ref())
+            .filter(|attrs| !attrs.is_empty())
+        {
+            self.emit_load_const(ConstantData::Tuple {
+                elements: attrs
+                    .iter()
+                    .cloned()
+                    .map(|s| ConstantData::Str { value: s.into() })
+                    .collect(),
+            });
+            let static_attrs_name = self.name("__static_attributes__");
+            emit!(self, Instruction::StoreName { namei: static_attrs_name });
+        }
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@crates/codegen/src/compile.rs` around lines 4626 - 4649, The compiler
unconditionally emits and stores __static_attributes__ (via emit_load_const +
Instruction::StoreName with name from name("__static_attributes__")), but
code_stack.last().static_attributes is initialized to Some(empty) and never
populated, so every class body is clobbered with an empty tuple; change the code
in compile.rs so you only emit and StoreName for __static_attributes__ when the
current code_stack.last().static_attributes is present and non-empty (i.e.,
check static_attributes.as_ref().map(|s| !s.is_empty()).unwrap_or(false)) so
explicit assignments in the class body are not overwritten.
🧹 Nitpick comments (2)
scripts/dis_dump.py (1)

20-21: Consider adding a comment clarifying PRECALL is CPython-only.

PRECALL was removed in CPython 3.12 and is not present in RustPython's opcode table. A brief comment would help future readers understand why it's included.

📝 Suggested comment
 # Non-semantic filler instructions to skip
+# Note: PRECALL is CPython 3.10-3.11 only (removed in 3.12), included for compatibility
 SKIP_OPS = frozenset({"CACHE", "PRECALL"})
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@scripts/dis_dump.py` around lines 20 - 21, Add a brief clarifying comment
above the SKIP_OPS definition explaining that the PRECALL opcode is included for
compatibility with older CPython versions, was removed in CPython 3.12, and does
not exist in RustPython’s opcode table; reference the SKIP_OPS constant and the
PRECALL entry so readers know why PRECALL is present even though some Python
implementations (like RustPython) won't have it.
crates/codegen/src/compile.rs (1)

1141-1157: Please add snapshot coverage for the new parity-sensitive shapes.

This file already has disassembly snapshot helpers, but there is no direct coverage here for the prologue reorder before RESUME or the imported-name LOAD_ATTR / PUSH_NULL call path. A tiny snapshot for each would make parity regressions much easier to catch.

Also applies to: 7517-7535

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@crates/codegen/src/compile.rs` around lines 1141 - 1157, Add snapshot tests
to cover the parity-sensitive prologue reorder before RESUME and the
imported-name call path that emits LOAD_ATTR / PUSH_NULL: locate the disassembly
snapshot helpers in crates/codegen/src/compile.rs and add two small snapshots —
one that exercises the MAKE_CELL / CopyFreeVars emission sequence immediately
before RESUME (to catch prologue reorder regressions) and another that builds an
imported-name call site which emits LOAD_ATTR followed by PUSH_NULL (to catch
that call path); wire these into the existing snapshot test harness so they run
with other disassembly snapshots and assert stable output.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@crates/codegen/src/compile.rs`:
- Around line 4651-4662: The code stores the dereferenced dict for
"__classdict__" into the name "__classdictcell__", but it should store the cell
object to match the "__classcell__" pattern; in the block gated by
self.current_symbol_table().needs_classdict (using
get_cell_var_index("__classdict__") and name("__classdictcell__") and the
subsequent emit StoreName), replace the Instruction::LoadDeref { i:
classdict_idx } emission with the cell-loading pseudo-instruction
(PseudoInstruction::LoadClosure { i: classdict_idx.to_u32() } or the equivalent
cell loader) so the actual cell object is stored under "__classdictcell__"
rather than the dereferenced dict.

In `@crates/codegen/src/symboltable.rs`:
- Around line 295-307: The code currently sets symbol_table.needs_classdict
whenever any immediate child scope is CompilerScope::Function or
::AsyncFunction; change this so needs_classdict is set only when there is an
actual classdict demand—i.e., check each child scope for evidence of needing
__classdict__ (for example inspect the child's newfree/cell capture flags or an
annotation/type-parameter marker used for PEP 649) instead of just matching on
CompilerScope::Function/AsyncFunction; update the loop over
symbol_table.sub_tables to test the child's fields (e.g., t.newfree or a
dedicated annotation/type-param flag) and only set symbol_table.needs_classdict
= true when those indicators are present.

In `@scripts/dis_dump.py`:
- Around line 82-83: The mapping _RP_CMP_OPS currently includes an invalid key 0
duplicating "<"; remove the 0 key from _RP_CMP_OPS and ensure callers use a safe
lookup (for example, replace direct indexing with a .get on _RP_CMP_OPS when
resolving comparison strings, e.g., in the code that computes cmp_str from
inst.arg) so unknown enum values produce a clear default like "?cmp{n}" instead
of silently mapping to "<". This change references _RP_CMP_OPS and the bytecode
ComparisonOperator values (inst.arg) used when resolving cmp_str.

---

Outside diff comments:
In `@crates/codegen/src/compile.rs`:
- Around line 3502-3507: The inline comments in the LIST_APPEND handling are
computing stack index using a 0-based operand scheme while the VM uses 1-based
depths; update the explanatory math around Instruction::ListAppend { i: 3 } (and
the analogous block at the location covering 3532-3536) to show the 1-based
depth calculation so the derivation matches the emitted i values (e.g., explain
that nth_value uses 1-based depth so list is at depth 3 leading to i: 3, and
adjust the other comment similarly).

---

Duplicate comments:
In `@crates/codegen/src/compile.rs`:
- Around line 6745-6748: Update the inline comment above the ToBool emission to
correctly state that Compare may return non-bool objects and that the reason we
skip emitting Instruction::ToBool for ast::Expr::Compare(_) is not that Compare
guarantees a bool but because the fast-path jump instructions (e.g.,
PopJumpIfTrue/PopJumpIfFalse) perform truthiness handling themselves; replace
the current "Compare already produces a bool" wording with a note that Compare
can return non-bool values and we rely on PopJumpIf*'s truthiness semantics
rather than forcing a ToBool.
- Around line 4626-4649: The compiler unconditionally emits and stores
__static_attributes__ (via emit_load_const + Instruction::StoreName with name
from name("__static_attributes__")), but code_stack.last().static_attributes is
initialized to Some(empty) and never populated, so every class body is clobbered
with an empty tuple; change the code in compile.rs so you only emit and
StoreName for __static_attributes__ when the current
code_stack.last().static_attributes is present and non-empty (i.e., check
static_attributes.as_ref().map(|s| !s.is_empty()).unwrap_or(false)) so explicit
assignments in the class body are not overwritten.

---

Nitpick comments:
In `@crates/codegen/src/compile.rs`:
- Around line 1141-1157: Add snapshot tests to cover the parity-sensitive
prologue reorder before RESUME and the imported-name call path that emits
LOAD_ATTR / PUSH_NULL: locate the disassembly snapshot helpers in
crates/codegen/src/compile.rs and add two small snapshots — one that exercises
the MAKE_CELL / CopyFreeVars emission sequence immediately before RESUME (to
catch prologue reorder regressions) and another that builds an imported-name
call site which emits LOAD_ATTR followed by PUSH_NULL (to catch that call path);
wire these into the existing snapshot test harness so they run with other
disassembly snapshots and assert stable output.

In `@scripts/dis_dump.py`:
- Around line 20-21: Add a brief clarifying comment above the SKIP_OPS
definition explaining that the PRECALL opcode is included for compatibility with
older CPython versions, was removed in CPython 3.12, and does not exist in
RustPython’s opcode table; reference the SKIP_OPS constant and the PRECALL entry
so readers know why PRECALL is present even though some Python implementations
(like RustPython) won't have it.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yml

Review profile: CHILL

Plan: Pro

Run ID: e7a2283a-8db4-4f7f-b366-2e756e9fca89

📥 Commits

Reviewing files that changed from the base of the PR and between 904bdaf and c9a5f48.

⛔ Files ignored due to path filters (1)
  • Lib/test/test_dis.py is excluded by !Lib/**
📒 Files selected for processing (5)
  • crates/codegen/src/compile.rs
  • crates/codegen/src/ir.rs
  • crates/codegen/src/symboltable.rs
  • scripts/compare_bytecode.py
  • scripts/dis_dump.py
🚧 Files skipped from review as they are similar to previous changes (1)
  • crates/codegen/src/ir.rs

Comment on lines +4651 to +4662
// Store __classdictcell__ if __classdict__ is a cell variable
if self.current_symbol_table().needs_classdict {
let classdict_idx = self.get_cell_var_index("__classdict__")?;
emit!(self, Instruction::LoadDeref { i: classdict_idx });
let classdictcell = self.name("__classdictcell__");
emit!(
self,
Instruction::StoreName {
namei: classdictcell
}
);
}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🔴 Critical

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
set -euo pipefail

echo "# Consumers of __classdictcell__ and __classcell__"
rg -n -C3 '__classdictcell__|__classcell__' .

echo
echo "# Class-body emitters in compile.rs"
rg -n -C2 '__classdictcell__|classdict_idx|__classcell__|classcell_idx' crates/codegen/src/compile.rs

Repository: RustPython/RustPython

Length of output: 14796


🏁 Script executed:

#!/bin/bash
set -euo pipefail

echo "# Search for __classdictcell__ comments or PEP references"
rg -n -B2 -A2 '__classdictcell__' crates/codegen/src/compile.rs

echo
echo "# Git history snippet for the __classdictcell__ block"
git log --oneline -S '__classdictcell__' -- crates/codegen/src/compile.rs | head -5

echo
echo "# Search for any mention of classdict cell design in comments"
rg -n 'classdict.*cell|needs_classdict' crates/codegen/src/compile.rs | head -20

Repository: RustPython/RustPython

Length of output: 1458


Change __classdictcell__ emission to store the cell, not the dereferenced dict.

This block currently dereferences __classdict__ and stores the resulting dict under the name __classdictcell__, but the neighboring __classcell__ block (lines 4664–4673) uses PseudoInstruction::LoadClosure to store the actual cell object. The naming convention and symmetry with __classcell__ indicate that __classdictcell__ should also carry the cell object, not the dict. Change Instruction::LoadDeref { i: classdict_idx } to PseudoInstruction::LoadClosure { i: classdict_idx.to_u32() } (or equivalent cell-loading instruction) to match the pattern.

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@crates/codegen/src/compile.rs` around lines 4651 - 4662, The code stores the
dereferenced dict for "__classdict__" into the name "__classdictcell__", but it
should store the cell object to match the "__classcell__" pattern; in the block
gated by self.current_symbol_table().needs_classdict (using
get_cell_var_index("__classdict__") and name("__classdictcell__") and the
subsequent emit StoreName), replace the Instruction::LoadDeref { i:
classdict_idx } emission with the cell-loading pseudo-instruction
(PseudoInstruction::LoadClosure { i: classdict_idx.to_u32() } or the equivalent
cell loader) so the actual cell object is stored under "__classdictcell__"
rather than the dereferenced dict.

Comment on lines +295 to +307
// If the class has any function definitions, it needs __classdict__
// for PEP 649 deferred annotation evaluation support
if !symbol_table.needs_classdict {
let has_functions = symbol_table.sub_tables.iter().any(|t| {
matches!(
t.typ,
CompilerScope::Function | CompilerScope::AsyncFunction
)
});
if has_functions {
symbol_table.needs_classdict = true;
}
}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟠 Major

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
# 1) Find all production/consumption sites for __classdictcell__/__classdict__.
rg -n -C3 '__classdictcell__|__classdict__'

# 2) Inspect all writes to needs_classdict and related compile-time branching.
rg -n -C3 'needs_classdict\s*=' crates/codegen/src/symboltable.rs crates/codegen/src/compile.rs
rg -n -C3 'if\s+self\.current_symbol_table\(\)\.needs_classdict|if\s+ste\.needs_classdict' crates/codegen/src/compile.rs

Repository: RustPython/RustPython

Length of output: 18389


Avoid promoting needs_classdict for every class that merely has methods.

At lines 297–306, this now sets needs_classdict for any class with immediate Function/AsyncFunction children. The bytecode overhead—LoadLocals -> StoreDeref (compile.rs:4590–4594) and LoadDeref -> StoreName("__classdictcell__") (compile.rs:4651–4658)—applies unconditionally, even for ordinary methods without type parameters or annotation scope usage. The comment cites "PEP 649 deferred annotation evaluation support," which is type-parameter-specific, yet the implementation gates on method presence alone.

Gate this on actual __classdict__ demand (type parameter annotations, explicit child captures in newfree) rather than method presence.

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@crates/codegen/src/symboltable.rs` around lines 295 - 307, The code currently
sets symbol_table.needs_classdict whenever any immediate child scope is
CompilerScope::Function or ::AsyncFunction; change this so needs_classdict is
set only when there is an actual classdict demand—i.e., check each child scope
for evidence of needing __classdict__ (for example inspect the child's
newfree/cell capture flags or an annotation/type-parameter marker used for PEP
649) instead of just matching on CompilerScope::Function/AsyncFunction; update
the loop over symbol_table.sub_tables to test the child's fields (e.g.,
t.newfree or a dedicated annotation/type-param flag) and only set
symbol_table.needs_classdict = true when those indicators are present.

Comment on lines +82 to +83
# RustPython's ComparisonOperator enum values → operator strings
_RP_CMP_OPS = {0: "<", 1: "<", 2: ">", 3: "!=", 4: "==", 5: "<=", 6: ">="}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Key 0 in _RP_CMP_OPS appears incorrect.

According to the ComparisonOperator enum in crates/compiler-core/src/bytecode/oparg.rs, valid values start at 1 (Less = 0b001). There is no variant with value 0. The current mapping duplicates "<" for both keys 0 and 1, which could mask bugs where an invalid comparison operator is encountered.

🛠️ Suggested fix: remove key 0 or handle it explicitly
 # RustPython's ComparisonOperator enum values → operator strings
-_RP_CMP_OPS = {0: "<", 1: "<", 2: ">", 3: "!=", 4: "==", 5: "<=", 6: ">="}
+_RP_CMP_OPS = {1: "<", 2: ">", 3: "!=", 4: "==", 5: "<=", 6: ">="}

If a fallback is needed, use .get() with a default in the calling code instead:

cmp_str = _RP_CMP_OPS.get(inst.arg, "?cmp%d" % inst.arg)
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
# RustPython's ComparisonOperator enum values → operator strings
_RP_CMP_OPS = {0: "<", 1: "<", 2: ">", 3: "!=", 4: "==", 5: "<=", 6: ">="}
# RustPython's ComparisonOperator enum values → operator strings
_RP_CMP_OPS = {1: "<", 2: ">", 3: "!=", 4: "==", 5: "<=", 6: ">="}
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@scripts/dis_dump.py` around lines 82 - 83, The mapping _RP_CMP_OPS currently
includes an invalid key 0 duplicating "<"; remove the 0 key from _RP_CMP_OPS and
ensure callers use a safe lookup (for example, replace direct indexing with a
.get on _RP_CMP_OPS when resolving comparison strings, e.g., in the code that
computes cmp_str from inst.arg) so unknown enum values produce a clear default
like "?cmp{n}" instead of silently mapping to "<". This change references
_RP_CMP_OPS and the bytecode ComparisonOperator values (inst.arg) used when
resolving cmp_str.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant