◐ Shell
reader mode source ↗
Skip to content

make mro representation fit to CPython#5866

Merged
youknowone merged 1 commit into
RustPython:mainfrom
youknowone:mro
Dec 30, 2025
Merged

make mro representation fit to CPython#5866
youknowone merged 1 commit into
RustPython:mainfrom
youknowone:mro

Conversation

@youknowone

@youknowone youknowone commented Jun 29, 2025

Copy link
Copy Markdown
Member

Summary by CodeRabbit

  • New Features

    • Added utility methods for type checking and subtype determination, enhancing compatibility with Python's type system.
    • Improved handling of method resolution order (MRO) for core types to better reflect inheritance relationships.
  • Refactor

    • Refined class and subclass checking logic for improved correctness and alignment with Python behavior.
    • Optimized single inheritance checks for better performance.
    • Streamlined creation of empty typed tuples by simplifying dependencies.
  • Bug Fixes

    • Corrected initialization of MRO for fundamental types, ensuring accurate inheritance chains.

@coderabbitai

coderabbitai Bot commented Jun 29, 2025

Copy link
Copy Markdown
Contributor

Important

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

📝 Walkthrough

Walkthrough

This set of changes refactors the handling of method resolution order (MRO), type checking, and subclass determination in the Python VM implementation. It introduces more precise MRO management, optimizes subclass checks, updates tuple initialization to use context directly, and aligns error handling and attribute checks with CPython semantics.

Changes

File(s) Change Summary
vm/src/builtins/tuple.rs Changed PyTupleTyped::empty to take &Context instead of &VirtualMachine and updated usage accordingly.
vm/src/frame.rs,
vm/src/vm/mod.rs
Updated calls to PyTupleTyped::empty to pass &vm.ctx instead of the full VM.
vm/src/builtins/type.rs Refined MRO handling: new is_subtype_with_mro, added check, check_exact, and is_subtype methods; adjusted MRO construction and attribute lookup to skip the type itself where appropriate; commented out MRO traversal in Traverse.
vm/src/object/core.rs Updated type hierarchy initialization to set correct MROs for object_type, type_type, and weakref_type.
vm/src/protocol/object.rs Refactored and optimized class and subclass checking: renamed and rewrote check_cls as check_class, added abstract_get_bases, improved abstract_issubclass and recursive_issubclass logic and error handling.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant VM
    participant Context
    participant PyType
    participant PyObject

    User->>VM: import(...)
    VM->>Context: get empty_tuple
    Context-->>VM: empty_tuple
    VM->>PyTupleTyped: empty(&Context)
    PyTupleTyped-->>VM: PyTupleTyped instance

    User->>PyObject: is_subclass_of(cls)
    PyObject->>PyType: check_class()
    PyType-->>PyObject: Ok/Err
    PyObject->>PyType: is_subtype(other)
    PyType->>PyType: is_subtype_with_mro(self.mro, self, other)
    PyType-->>PyObject: true/false
Loading

Suggested reviewers

  • arihant2math

Poem

In the warren of code where the tuples reside,
The MRO bunnies now hop with more pride.
Context brings tuples, not the whole VM,
Type checks are sharper, subclassing’s a gem!
With a twitch of the nose and a hop in the flow,
Python’s inheritance just got more in the know!
🐇✨


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.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Hide comment

Actionable comments posted: 2

🧹 Nitpick comments (2)
vm/src/builtins/type.rs (2)

161-168: Consider removing the unused _a parameter.

The _a parameter is not used in the function body. If it's not needed for future compatibility, consider removing it for clarity.

-fn is_subtype_with_mro(a_mro: &[PyTypeRef], _a: &Py<PyType>, b: &Py<PyType>) -> bool {
+fn is_subtype_with_mro(a_mro: &[PyTypeRef], b: &Py<PyType>) -> bool {

Note: If you remove this parameter, update the call site on line 452:

-        is_subtype_with_mro(&self.mro.read(), self, other)
+        is_subtype_with_mro(&self.mro.read(), other)

552-555: Consider using explicit type reference instead of copying from old MRO.

While copying the first element from the old MRO should work (since it's always self), it would be clearer and more robust to use an explicit reference.

-            let mut mro =
-                PyType::resolve_mro(&cls.bases.read()).map_err(|msg| vm.new_type_error(msg))?;
-            mro.insert(0, cls.mro.read()[0].to_owned());
+            let mut mro =
+                PyType::resolve_mro(&cls.bases.read()).map_err(|msg| vm.new_type_error(msg))?;
+            // Get a proper reference to the type
+            let weakref_type = super::PyWeak::static_type();
+            let type_ref = cls.subclasses.read()[0].upgrade()
+                .and_then(|obj| obj.downcast::<PyType>().ok())
+                .unwrap_or_else(|| {
+                    // Fallback to copying from old MRO if we can't get a proper reference
+                    cls.mro.read()[0].clone()
+                });
+            mro.insert(0, type_ref);

Actually, on second thought, the current approach is simpler. You could just add a comment explaining the assumption:

+            // The first element of MRO is always the type itself
             mro.insert(0, cls.mro.read()[0].to_owned());
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 7a6e5c4 and 672e9a4.

📒 Files selected for processing (6)
  • vm/src/builtins/tuple.rs (1 hunks)
  • vm/src/builtins/type.rs (13 hunks)
  • vm/src/frame.rs (1 hunks)
  • vm/src/object/core.rs (2 hunks)
  • vm/src/protocol/object.rs (2 hunks)
  • vm/src/vm/mod.rs (1 hunks)
🧰 Additional context used
🧠 Learnings (4)
vm/src/frame.rs (3)
Learnt from: CR
PR: RustPython/RustPython#0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-06-26T12:52:11.138Z
Learning: To add a Python module to the RustPython interpreter, use 'vm.add_native_module' with the module name and module factory.
Learnt from: CR
PR: RustPython/RustPython#0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-06-26T12:52:11.138Z
Learning: When implementing a Python module in Rust for RustPython, use the #[pymodule] attribute and expose functions and classes using #[pyfunction], #[pyclass], and #[pymethod] as appropriate.
Learnt from: CR
PR: RustPython/RustPython#0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-06-26T12:52:11.138Z
Learning: Use the macro system (such as 'pyclass', 'pymodule', 'pyfunction') when implementing Python functionality in Rust for RustPython.
vm/src/object/core.rs (1)
Learnt from: CR
PR: RustPython/RustPython#0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-06-26T12:52:11.138Z
Learning: Use the macro system (such as 'pyclass', 'pymodule', 'pyfunction') when implementing Python functionality in Rust for RustPython.
vm/src/vm/mod.rs (3)
Learnt from: CR
PR: RustPython/RustPython#0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-06-26T12:52:11.138Z
Learning: To add a Python module to the RustPython interpreter, use 'vm.add_native_module' with the module name and module factory.
Learnt from: CR
PR: RustPython/RustPython#0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-06-26T12:52:11.138Z
Learning: When implementing a Python module in Rust for RustPython, use the #[pymodule] attribute and expose functions and classes using #[pyfunction], #[pyclass], and #[pymethod] as appropriate.
Learnt from: CR
PR: RustPython/RustPython#0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-06-26T12:52:11.138Z
Learning: Use the macro system (such as 'pyclass', 'pymodule', 'pyfunction') when implementing Python functionality in Rust for RustPython.
vm/src/builtins/type.rs (1)
Learnt from: CR
PR: RustPython/RustPython#0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-06-26T12:52:11.138Z
Learning: Use the macro system (such as 'pyclass', 'pymodule', 'pyfunction') when implementing Python functionality in Rust for RustPython.
🧬 Code Graph Analysis (3)
vm/src/frame.rs (1)
vm/src/builtins/tuple.rs (1)
  • empty (540-545)
vm/src/vm/mod.rs (1)
vm/src/builtins/tuple.rs (1)
  • empty (540-545)
vm/src/protocol/object.rs (5)
vm/src/builtins/type.rs (4)
  • __bases__ (515-523)
  • bases (850-867)
  • check (211-213)
  • class (146-148)
vm/src/exceptions.rs (2)
  • try_from_object (396-412)
  • class (43-45)
vm/src/protocol/iter.rs (1)
  • check (25-29)
vm/src/vm/mod.rs (1)
  • class (564-573)
vm/src/builtins/union.rs (1)
  • class (32-34)
⏰ Context from checks skipped due to timeout of 90000ms (11)
  • GitHub Check: Run snippets and cpython tests (macos-latest)
  • GitHub Check: Run snippets and cpython tests (ubuntu-latest)
  • GitHub Check: Run snippets and cpython tests (windows-latest)
  • GitHub Check: Run rust tests (macos-latest)
  • GitHub Check: Run rust tests (windows-latest)
  • GitHub Check: Run tests under miri
  • GitHub Check: Run rust tests (ubuntu-latest)
  • GitHub Check: Check Rust code with rustfmt and clippy
  • GitHub Check: Check the WASM package and demo
  • GitHub Check: Ensure compilation on various targets
  • GitHub Check: Run snippets and cpython tests on wasm-wasi
🔇 Additional comments (12)
vm/src/frame.rs (1)

1384-1389: Updated call uses &vm.ctx – correct and consistent with new API

The call now passes a &Context rather than the full &VirtualMachine, matching the updated PyTupleTyped::empty(ctx: &Context) signature in tuple.rs. This reduces coupling and removes an unnecessary borrow of the whole VM. No further action required.

vm/src/vm/mod.rs (1)

583-583: LGTM!

The update to pass &self.ctx instead of self correctly aligns with the updated PyTupleTyped::empty method signature.

vm/src/builtins/tuple.rs (1)

540-545: Good API simplification!

Changing the parameter from &VirtualMachine to &Context reduces coupling since the method only needs access to empty_tuple from the context.

vm/src/object/core.rs (1)

1255-1255: Correct MRO initialization for core types.

These changes properly set up the MRO vectors to include each type at the front of its own MRO, aligning with Python's MRO semantics where a class always appears first in its resolution order.

Also applies to: 1261-1262, 1278-1278

vm/src/protocol/object.rs (4)

374-388: Clean refactoring of class validation.

The renamed check_class method now properly validates classes by checking for a __bases__ attribute that must be a tuple, using the new abstract_get_bases helper.


390-410: Well-designed abstraction for bases handling.

The abstract_get_bases method properly handles all edge cases with clear documentation of the 4 possible return states. Good choice to mask AttributeError and non-tuple cases as None.


459-480: Excellent CPython-compatible implementation.

The additions improve performance with a fast path for PyType objects and provide CPython-compatible error messages. The check order (union, then class/tuple) matches CPython's behavior.


555-555: Consistent method rename.

The call site is properly updated to use the renamed check_class method.

vm/src/builtins/type.rs (4)

210-213: Well-implemented type checking methods matching CPython semantics.

The check and check_exact methods correctly implement CPython's PyType_Check and PyType_CheckExact macros with clear documentation.

Also applies to: 456-459


335-335: Correct MRO iteration pattern for inheritance lookups.

The code correctly skips the first MRO element (self) when looking for inherited attributes or checking subclass relationships, while including it when collecting all attributes. This matches expected Python semantics.

Also applies to: 384-387, 392-395, 465-465, 493-493


451-453: Clean implementation of subtype checking.

The is_subtype method provides a clear API for checking subtype relationships using the MRO.


271-271: Verify GC traversal of MRO cycle.

Inserting the type into its own MRO is correct, but I noticed in the GC traversal implementation that the mro field isn’t being traced:

  • vm/src/builtins/type.rs around line 263:
    // self.mro.traverse(tracer_fn);

Please confirm that the garbage collector still correctly handles this self-reference (either by tracing MRO elsewhere or by design) to avoid leaking types. This check applies to both types created in new_heap_inner (line 271) and new_static (line 316).

@youknowone youknowone marked this pull request as draft June 29, 2025 05:01
@youknowone

Copy link
Copy Markdown
Member Author

beacuse MRO is currently not weakrefs, this prevent RC=0 to release type objects

@youknowone youknowone marked this pull request as ready for review December 30, 2025 16:12
@youknowone youknowone changed the title Update issubclass and make mro representation fit to CPython Dec 30, 2025
Hide details View details @youknowone youknowone merged commit b98f062 into RustPython:main Dec 30, 2025
13 checks passed
@youknowone youknowone deleted the mro branch December 30, 2025 16:42
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