Add SymbolUsage::TypeParams by youknowone · Pull Request #5941 · RustPython/RustPython

coderabbitai

Walkthrough

The changes add explicit support for the TypeParams variant in the symbol table and compiler. Type parameters are treated as cell variables during symbol analysis, registration, and closure building. Additionally, the bytecode execution logic for LoadClassDeref is corrected to properly index cell and free variables.

Changes

File(s)	Change Summary
compiler/codegen/src/symboltable.rs	Added `TypeParams` variant to `SymbolScope` and `TypeParam` to `SymbolUsage`; integrated type parameters as cell variables; updated symbol analysis, registration, and scanning logic.
compiler/codegen/src/compile.rs	Updated `compile_name` and `build_closure` to handle `SymbolScope::TypeParams` like `Cell` scope using `cellvar_cache` and dereference instructions.
vm/src/frame.rs	Fixed indexing logic in `execute_instruction` for `LoadClassDeref` to select variable names correctly from `cellvars` or `freevars`.

Sequence Diagram(s)

sequenceDiagram
    participant Compiler
    participant SymbolTable
    participant CodeObject
    participant VMFrame

    Compiler->>SymbolTable: scan_type_params(type_params)
    SymbolTable-->>Compiler: registers .type_params and individual type params as TypeParam usage

    Compiler->>SymbolTable: analyze_symbol(symbol)
    alt symbol scope is TypeParams
        SymbolTable->>SymbolTable: convert TypeParams scope to Cell scope
    end

    Compiler->>Compiler: compile_name(name, usage)
    alt SymbolScope is TypeParams
        Compiler->>Compiler: treat as Cell scope, use cellvar_cache, emit deref instructions
    end

    Compiler->>Compiler: build_closure(code)
    alt SymbolScope is TypeParams
        Compiler->>Compiler: treat as Cell scope for closure variables
    end

    VMFrame->>VMFrame: execute_instruction(LoadClassDeref)
    alt i < cellvars.len()
        VMFrame->>cellvars: get name at i
    else
        VMFrame->>freevars: get name at i - cellvars.len()
    end

Poem

🐰
TypeParams hop into the cell,
Where closures and symbols dwell.
Names now load with perfect grace,
Derefs found in just the right place.
Bunny’s code runs smooth and bright,
Hopping through frames with pure delight!
🌿✨

📜 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 4894ab4 and 84d1a32.

⛔ Files ignored due to path filters (1)

Lib/test/test_typing.py is excluded by !Lib/**

📒 Files selected for processing (3)

compiler/codegen/src/compile.rs (2 hunks)
compiler/codegen/src/symboltable.rs (7 hunks)
vm/src/frame.rs (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (2)

compiler/codegen/src/compile.rs
compiler/codegen/src/symboltable.rs

🧰 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:

vm/src/frame.rs

⏰ 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). (11)

GitHub Check: Run rust tests (ubuntu-latest)
GitHub Check: Run rust tests (windows-latest)
GitHub Check: Run rust tests (macos-latest)
GitHub Check: Ensure compilation on various targets
GitHub Check: Run snippets and cpython tests on wasm-wasi
GitHub Check: Check the WASM package and demo
GitHub Check: Run snippets and cpython tests (ubuntu-latest)
GitHub Check: Run snippets and cpython tests (macos-latest)
GitHub Check: Run snippets and cpython tests (windows-latest)
GitHub Check: Run tests under miri
GitHub Check: Check Rust code with rustfmt and clippy

🔇 Additional comments (1)

vm/src/frame.rs (1)

599-603: LGTM! Correct indexing logic for cell and free variables.

The change correctly fixes the indexing logic for the LoadClassDeref instruction. The conditional check ensures:

If i < cellvars.len(), use cellvars[i] for the variable name (cell variable)

Otherwise, use freevars[i - cellvars.len()] for the variable name (free variable)

This aligns with how cells_frees is constructed in the new method (lines 146-149), where cell variables are placed first, followed by free variables. The fix properly supports the new TypeParams feature where type parameters are treated as cell variables.

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