Skip to content

CodeInfo::private #5943

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

Merged
merged 1 commit into from
Jul 11, 2025
Merged

CodeInfo::private #5943

merged 1 commit into from
Jul 11, 2025

Conversation

youknowone
Copy link
Member

@youknowone youknowone commented Jul 11, 2025

Summary by CodeRabbit

  • Refactor
    • Improved handling of private name mangling by moving the private name context from a global compiler field to a per-code-object context.
    • Streamlined internal management of class and private names for better alignment with code object scopes.

No user-facing features or visible changes; these updates improve internal consistency and maintainability.

Copy link
Contributor

coderabbitai bot commented Jul 11, 2025

Walkthrough

The changes refactor how the compiler tracks the current class name for private name mangling. Instead of storing the class name in the Compiler struct, a new private field is added to the ir::CodeInfo struct and managed on the code stack, ensuring the private name context is local to each code object.

Changes

File(s) Change Summary
compiler/codegen/src/compile.rs Removed class_name field from Compiler; updated methods to use private field in CodeInfo; refactored class context handling and name mangling logic.
compiler/codegen/src/ir.rs Added private: Option<String> to CodeInfo; updated destructuring in finalize_code to ignore private.

Poem

In the warren of code, a secret we keep,
No more class names in the compiler’s deep.
Now each code stack frame, with a private so neat,
Tracks its own context—oh, what a feat!
The rabbit hops on, with mangling complete.
🐇✨


📜 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 2f94a63 and caa854f.

📒 Files selected for processing (2)
  • compiler/codegen/src/compile.rs (6 hunks)
  • compiler/codegen/src/ir.rs (2 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
`**/*.rs`: Follow the default rustfmt code style (`cargo fmt` to format) Always ...

**/*.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

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

List of files the instruction was applied to:

  • compiler/codegen/src/ir.rs
  • compiler/codegen/src/compile.rs
🧬 Code Graph Analysis (1)
compiler/codegen/src/compile.rs (1)
compiler/codegen/src/symboltable.rs (1)
  • mangle_name (1579-1594)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (10)
  • GitHub Check: Run snippets and cpython tests (windows-latest)
  • GitHub Check: Run snippets and cpython tests (ubuntu-latest)
  • GitHub Check: Run snippets and cpython tests (macos-latest)
  • GitHub Check: Run tests under miri
  • GitHub Check: Run rust tests (windows-latest)
  • GitHub Check: Run snippets and cpython tests on wasm-wasi
  • GitHub Check: Run rust tests (ubuntu-latest)
  • GitHub Check: Check Rust code with rustfmt and clippy
  • GitHub Check: Run rust tests (macos-latest)
  • GitHub Check: Ensure compilation on various targets
🔇 Additional comments (7)
compiler/codegen/src/ir.rs (2)

77-77: Well-designed addition for private name mangling.

The private field is appropriately typed as Option<String> and clearly documented. The placement alongside other metadata fields like obj_name and qualname is logical and maintains good code organization.


105-105: Proper handling of compilation-only field.

Correctly ignoring the private field during finalization is the right approach since this field is only needed during compilation and shouldn't be included in the final CodeObject. The explicit comment makes the intent clear.

compiler/codegen/src/compile.rs (5)

314-314: LGTM!

Correctly initializes the private field to None for module-level code.


411-413: LGTM!

The private name is correctly inherited from the parent scope when creating nested code objects.

Also applies to: 423-423


593-598: Clean refactoring of the mangle function.

The function now correctly retrieves the private name from the current code unit's context rather than from compiler state.


1738-1746: Correct handling of private name context for type parameters.

Type parameters should not be subject to class name mangling, so temporarily clearing the private context while compiling them is the right approach.


1755-1757: LGTM!

Correctly sets the private name to the class name for implementing Python's private name mangling in class scopes.

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

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 youknowone merged commit 9b133b8 into RustPython:main Jul 11, 2025
12 checks passed
@youknowone youknowone deleted the codeinfo-private branch July 11, 2025 04:11
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