Skip to content

Add SymbolUsage::TypeParams #5941

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

Conversation

youknowone
Copy link
Member

@youknowone youknowone commented Jul 11, 2025

Summary by CodeRabbit

  • New Features

    • Improved handling of classes declared as global in parent scopes, ensuring correct naming in generated code.
    • Added support for type parameters in symbol table analysis and code generation, treating them as cell variables for better closure and scope management.
  • Bug Fixes

    • Ensured emitted function and class names use the correct qualified name from the code object, improving consistency.
    • Corrected variable name resolution logic for closures involving both cell and free variables, enhancing execution accuracy.
  • Refactor

    • Centralized logic for global class qualification names and unified symbol scope handling for type parameters.

Copy link
Contributor

coderabbitai bot commented Jul 11, 2025

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
Loading

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.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🔭 Outside diff range comments (1)
compiler/codegen/src/symboltable.rs (1)

545-547: Implement TypeParams handling in comprehensions.

The TODO indicates missing implementation for type parameters in comprehensions. This will cause a panic if encountered. Consider implementing this case or documenting why it's not needed.

Would you like me to help implement the TypeParams case or open an issue to track this?

🧹 Nitpick comments (1)
compiler/codegen/src/compile.rs (1)

1558-1566: Consider simplifying lambda qualname handling.

The code retrieves the qualname from the code object, but for lambdas it's already set to "<lambda>" on line 1539. This indirection is unnecessary.

Consider using the constant directly:

-                // Get the qualname from the code object
-                let qualname = code.qualname.clone();
-
                 self.emit_load_const(ConstantData::Code {
                     code: Box::new(code),
                 });
                 self.emit_load_const(ConstantData::Str {
-                    value: qualname.into(),
+                    value: "<lambda>".into(),
                 });
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 2c30e01 and 4894ab4.

📒 Files selected for processing (2)
  • compiler/codegen/src/compile.rs (8 hunks)
  • compiler/codegen/src/symboltable.rs (7 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/symboltable.rs
  • compiler/codegen/src/compile.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 snippets and cpython tests on wasm-wasi
  • GitHub Check: Run snippets and cpython tests (macos-latest)
  • GitHub Check: Run snippets and cpython tests (windows-latest)
  • GitHub Check: Run snippets and cpython tests (ubuntu-latest)
  • GitHub Check: Check the WASM package and demo
  • GitHub Check: Run tests under miri
  • GitHub Check: Check Rust code with rustfmt and clippy
  • GitHub Check: Run rust tests (macos-latest)
  • GitHub Check: Run rust tests (ubuntu-latest)
  • GitHub Check: Run rust tests (windows-latest)
  • GitHub Check: Ensure compilation on various targets
🔇 Additional comments (9)
compiler/codegen/src/symboltable.rs (4)

84-84: LGTM! Consistent enum additions for type parameter support.

The addition of TypeParams to both SymbolTableType and SymbolScope enums is well-integrated, with proper display formatting that matches the pattern of other variants.

Also applies to: 94-94, 116-116


363-366: Correct handling of TypeParams scope conversion.

The conversion of TypeParams scope to Cell scope ensures type parameters are properly treated as cell variables, which aligns with Python's type parameter semantics.


1276-1278: Well-structured type parameter registration.

The registration of .type_params as a special symbol and the consistent use of TypeParam usage for all type parameter variants (TypeVar, ParamSpec, TypeVarTuple) provides clear semantic distinction from regular assignments.

Also applies to: 1288-1288, 1298-1298, 1305-1305


1556-1560: Proper TypeParam registration as cell variables.

The handling correctly sets type parameters as cell variables with the ASSIGNED flag, ensuring they're properly accessible within their scope and consistent with the scope conversion in analyze_symbol.

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

432-434: LGTM! Correct handling of qualname for global classes.

The logic correctly sets the qualname to just the class name for global classes, which aligns with Python's behavior.


664-672: LGTM! Correct implementation of TypeParams scope handling.

The code correctly treats type parameters as cell variables, using the cellvar_cache and Deref operations consistently with the Cell scope handling.


1540-1541: LGTM! Consistent qualname handling for functions.

The code correctly uses the qualname from the compiled code object, ensuring consistency with how the qualname was set during function compilation.

Also applies to: 1625-1628


1761-1771: LGTM! Proper qualname retrieval for classes.

The code correctly retrieves the qualname from the current code info, which was set during push_output with the global class logic applied.


1664-1664: LGTM! Consistent TypeParams handling in closures.

The code correctly handles TypeParams scope in closure building, treating type parameters as cell variables consistently with the rest of the implementation.

@youknowone youknowone merged commit 2f94a63 into RustPython:main Jul 11, 2025
12 checks passed
@youknowone youknowone deleted the typeparams branch July 11, 2025 02:24
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