Skip to content

may_add_dict #6084

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

may_add_dict #6084

wants to merge 1 commit into from

Conversation

youknowone
Copy link
Member

@youknowone youknowone commented Aug 8, 2025

Summary by CodeRabbit

  • Bug Fixes
    • Improved handling of class attribute dictionaries to prevent redundant dictionary support when the base class already provides it. This ensures more accurate behavior when using __slots__ and inheritance.

Copy link
Contributor

coderabbitai bot commented Aug 8, 2025

Walkthrough

The logic for adding dictionary-related feature flags to new types in the type creation process has been refined. The new condition ensures that dictionary support is only added when the base class does not already provide it, or when __dict__ is explicitly included in __slots__.

Changes

Cohort / File(s) Change Summary
Type Feature Flag Logic Refinement
vm/src/builtins/type.rs
Refined the condition for adding HAS_DICT and MANAGED_DICT flags to new types, considering base class dictionary presence and __slots__ configuration.

Sequence Diagram(s)

sequenceDiagram
    participant TypeCreator
    participant BaseClass
    participant NewType

    TypeCreator->>BaseClass: Check HAS_DICT flag
    alt __dict__ in __slots__
        TypeCreator->>NewType: Add HAS_DICT and MANAGED_DICT flags
    else __slots__ not defined AND base lacks HAS_DICT
        TypeCreator->>NewType: Add HAS_DICT and MANAGED_DICT flags
    else
        TypeCreator->>NewType: Do not add dictionary flags
    end
Loading

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~7 minutes

Possibly related PRs

  • Fix __dict__ getset type #6010: Refactors and enhances dictionary descriptor handling and base type dictionary detection in the same file and context, directly related to the refined flag logic in this PR.

Poem

A rabbit hopped through type-land bright,
Tweaking flags with careful might.
No extra dicts where base ones dwell,
Only when slots or needs compel.
With logic crisp and checks anew,
The code runs lean—hoppity-hoo!

Note

🔌 MCP (Model Context Protocol) integration is now available in Early Access!

Pro users can now connect to remote MCP servers under the Integrations page to get reviews and chat conversations that understand additional development context.


📜 Recent review details

Configuration used: .coderabbit.yml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 33ea50c and b269c48.

📒 Files selected for processing (1)
  • vm/src/builtins/type.rs (1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
**/*.rs

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

**/*.rs: Follow the default rustfmt code style (cargo fmt to format)
Always run clippy to lint code (cargo clippy) before completing tasks. Fix any warnings or lints that are introduced by your changes
Follow Rust best practices for error handling and memory management
Use the macro system (pyclass, pymodule, pyfunction, etc.) when implementing Python functionality in Rust

Files:

  • vm/src/builtins/type.rs
🔇 Additional comments (1)
vm/src/builtins/type.rs (1)

1072-1081: may_add_dict guard is an improvement but still leaves a CPython-incompatibility

Nice catch introducing may_add_dict; it stops us from unconditionally slapping MANAGED_DICT onto every heap type whose primary base already owns a dict.

However, note the follow-up flow in new_heap_inner: that helper always OR-propagates PyTypeFlags::HAS_DICT from the base (Lines 246-248).
As a consequence, a subclass that defines __slots__ = () (i.e. intends to drop the instance dict) will nevertheless finish with HAS_DICT set, diverging from CPython where such a subclass has no __dict__.

Consider short-circuiting the propagation when the heap type defined its own __slots__ without "__dict__" (and may_add_dict is false), or deferring the decision entirely to this block so the later OR doesn’t re-introduce the flag.

If you agree, an outline fix would be:

// in new_heap_inner, before propagating
-if base.slots.flags.has_feature(PyTypeFlags::HAS_DICT) {
-    slots.flags |= PyTypeFlags::HAS_DICT
-}
+if base.slots.flags.has_feature(PyTypeFlags::HAS_DICT)
+    && slots.flags.has_feature(PyTypeFlags::HAS_DICT)
+{
+    // only inherit when the heap type decided it wants a dict
+    slots.flags |= PyTypeFlags::HAS_DICT
+}

or equivalent logic moved here.

Please double-check against CPython’s behaviour with:

class A: pass
class B(A): __slots__ = ()

to ensure parity.

✨ Finishing Touches
  • 📝 Generate Docstrings
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment

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.
  • 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.

Support

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

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 generate unit tests to generate unit tests for 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.

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.

@youknowone
Copy link
Member Author

Need test

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