◐ Shell
clean mode source ↗

heaptype __qualname__ by youknowone · Pull Request #5848 · RustPython/RustPython

coderabbitai

Walkthrough

This update introduces a new pop_item method to the Python dictionary implementation, refactors dictionary removal methods for clarity and better return values, and moves type __qualname__ storage to a dedicated field in heap types. Additionally, it removes expected failure decorators from two typing and descriptor tests, enabling them for regular execution.

Changes

File(s) Change Summary
Lib/test/test_typing.py Removed @unittest.expectedFailure decorators and related comments from two test methods.
Lib/test/test_descr.py Removed @unittest.expectedFailure decorators from two test methods, keeping TODO comments.
vm/src/builtins/dict.rs Added pop_item method to PyDict for popping keys without raising errors.
vm/src/dict_inner.rs Refactored and renamed dictionary removal methods to return removed values; unified and clarified API.
vm/src/builtins/type.rs Moved __qualname__ storage to a dedicated field in heap types; updated getter/setter and type creation logic.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant PyDict
    participant DictInner
    participant VM

    User->>PyDict: pop_item(key, vm)
    alt Exact dict
        PyDict->>DictInner: remove_if_exists(key, vm)
        DictInner-->>PyDict: Option<value>
        PyDict-->>User: Option<value>
    else Subclass/proxy
        PyDict->>PyDict: get(key, vm)
        PyDict->>PyDict: delitem(key, vm)
        PyDict-->>User: Option<value>
    end
Loading 
sequenceDiagram
    participant User
    participant PyType
    participant HeapTypeExt

    User->>PyType: set __qualname__(value)
    PyType->>HeapTypeExt: Store value in qualname field

    User->>PyType: get __qualname__()
    PyType->>HeapTypeExt: Read qualname field
    HeapTypeExt-->>PyType: qualname or fallback to name
    PyType-->>User: qualname
Loading

Possibly related PRs

  • RustPython/RustPython#5844: Removes @unittest.expectedFailure decorators from typing protocol tests, directly related to enabling similar tests.
  • RustPython/RustPython#5837: Removes expected failure decorators from a broader set of typing tests in the same file, sharing scope and file.
  • RustPython/RustPython#5840: Cleans up expected failure markers in typing tests, affecting the same test file and decorator usage.

Suggested reviewers

  • arihant2math

Poem

In the warren of code, a new pop appears,
Dicts now return what they quietly clear.
Qualnames find homes, snug in their heap,
While old test failures no longer creep.
With carrots and keys, this bunny delights—
Hopping through changes on bright, starry nights!
🥕

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between fe81249 and efb3d43.

📒 Files selected for processing (5)
  • Lib/test/test_descr.py (1 hunks)
  • Lib/test/test_typing.py (0 hunks)
  • vm/src/builtins/dict.rs (1 hunks)
  • vm/src/builtins/type.rs (7 hunks)
  • vm/src/dict_inner.rs (2 hunks)
💤 Files with no reviewable changes (1)
  • Lib/test/test_typing.py
🚧 Files skipped from review as they are similar to previous changes (3)
  • vm/src/builtins/dict.rs
  • vm/src/dict_inner.rs
  • vm/src/builtins/type.rs
🧰 Additional context used
📓 Path-based instructions (2)
`Lib/**/*`: Files in the Lib/ directory (Python standard library copied from CPy...

Lib/**/*: Files in the Lib/ directory (Python standard library copied from CPython) should be edited very conservatively; modifications should be minimal and only to work around RustPython limitations.

📄 Source: CodeRabbit Inference Engine (.github/copilot-instructions.md)

List of files the instruction was applied to:

  • Lib/test/test_descr.py
`Lib/test/**/*`: Tests in Lib/test often use markers such as '# TODO: RUSTPYTHON...

Lib/test/**/*: Tests in Lib/test often use markers such as '# TODO: RUSTPYTHON', 'unittest.skip("TODO: RustPython ")', or 'unittest.expectedFailure' with a '# TODO: RUSTPYTHON ' comment when modifications are made.
NEVER comment out or delete any test code lines except for removing '@unittest.expectedFailure' decorators and upper TODO comments.
NEVER modify test assertions, test logic, or test data in Lib/test files.
The only acceptable modifications to test files are: (1) removing '@unittest.expectedFailure' decorators and the upper TODO comments when tests actually pass, (2) adding '@unittest.expectedFailure' decorators when tests cannot be fixed.
When a test cannot pass due to missing language features, keep it as expectedFailure and document the reason.

📄 Source: CodeRabbit Inference Engine (.github/copilot-instructions.md)

List of files the instruction was applied to:

  • Lib/test/test_descr.py
🧠 Learnings (1)
Lib/test/test_descr.py (1)

undefined

<retrieved_learning>
Learnt from: CR
PR: RustPython/RustPython#0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-06-26T12:52:11.109Z
Learning: When a test fails due to unsupported Python syntax or features, keep the test as '@unittest.expectedFailure' and document the reason, rather than modifying the test logic or data.
</retrieved_learning>

🧬 Code Graph Analysis (1)
Lib/test/test_descr.py (1)
Lib/unittest/case.py (1)
  • expectedFailure (183-185)
⏰ Context from checks skipped due to timeout of 90000ms (10)
  • GitHub Check: Run snippets and cpython tests (ubuntu-latest)
  • GitHub Check: Run snippets and cpython tests on wasm-wasi
  • GitHub Check: Check the WASM package and demo
  • GitHub Check: Check Rust code with rustfmt and clippy
  • GitHub Check: Run snippets and cpython tests (windows-latest)
  • GitHub Check: Run snippets and cpython tests (macos-latest)
  • GitHub Check: Run rust tests (macos-latest)
  • GitHub Check: Run rust tests (windows-latest)
  • GitHub Check: Run rust tests (ubuntu-latest)
  • GitHub Check: Ensure compilation on various targets
🔇 Additional comments (1)
Lib/test/test_descr.py (1)

5127-5131: Verify the actual changes made to expectedFailure decorators.

There's a discrepancy between the AI summary and the observed changes. The summary states that @unittest.expectedFailure decorators were removed from test_iter_values to enable normal test execution, but I can see the decorator is present in the code with change markers (~).

According to the coding guidelines, modifications to test files should only involve:

  1. Removing @unittest.expectedFailure decorators when tests actually pass
  2. Adding @unittest.expectedFailure decorators when tests cannot be fixed

Please clarify whether:

  • The decorator is being added to this test (contrary to the summary)
  • The decorator is being removed but the diff format is confusing
  • There are other modifications to the decorator or TODO comment

If tests are now passing due to RustPython VM improvements, removing the expectedFailure decorator would be appropriate. If tests are still failing, the decorator should remain.

#!/bin/bash
# Check the git diff to see the actual changes made to expectedFailure decorators
git log --oneline -1 --name-only
git show --name-only HEAD
rg -A5 -B5 "test_iter_values|test_bound_method_repr" Lib/test/test_descr.py
✨ Finishing Touches
  • 📝 Generate Docstrings

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
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.