Skip to content

Fix type_params lifetime in symboltable #5844

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 2 commits into from
Jun 27, 2025

Conversation

youknowone
Copy link
Member

@youknowone youknowone commented Jun 27, 2025

Summary by CodeRabbit

  • Tests

    • Enabled several protocol-related typing tests by removing expected failure markers and uncommenting test code, improving coverage for runtime checkable generic protocols and related behaviors.
  • Style

    • Updated comments to clarify terminology, replacing "fortain order" with "column-major order" in memory handling components.
  • Chores

    • Enhanced error tracking for internal panics, improving debugging information for developers.

Copy link

coderabbitai bot commented Jun 27, 2025

Walkthrough

This update removes the @unittest.expectedFailure decorators from several protocol-related tests in Lib/test/test_typing.py, enabling these tests to run and validate protocol and generic behaviors. Additionally, minor comment corrections regarding "column-major order" are made in memory handling code, and a Rust function receives the #[track_caller] attribute for improved error tracking.

Changes

File(s) Change Summary
Lib/test/test_typing.py Removed @unittest.expectedFailure from protocol/generic tests; uncommented protocol test code.
compiler/codegen/src/compile.rs Added #[track_caller] to unwrap_internal; adjusted symbol table pop timing in class compilation.
vm/src/builtins/memory.rs
vm/src/protocol/buffer.rs
Updated comments to refer to "column-major order" instead of "fortain order".

Sequence Diagram(s)

sequenceDiagram
    participant TestRunner
    participant TypingProtocolTests
    TestRunner->>TypingProtocolTests: Run protocol/generic protocol tests
    TypingProtocolTests->>TypingProtocolTests: Perform runtime checks, subclass checks, instantiation checks
    TypingProtocolTests-->>TestRunner: Report test results
Loading

Possibly related PRs

  • typing.TypeVar #5834: Removes @unittest.expectedFailure decorators from typing tests in Lib/test/test_typing.py, similar to this PR.
  • typing ParamSpec #5837: Also enables previously disabled typing-related tests by removing @unittest.expectedFailure decorators in the same file.
  • more typing #5840: Activates protocol-related typing tests in test_typing.py by removing @unittest.expectedFailure decorators, closely mirroring this PR's focus.

Suggested reviewers

  • arihant2math

Poem

In a warren of tests, some failures were planned,
But now those old markers are swept from the land!
Protocols hop freely, their checks running true,
With column-major order, our comments renew.
Rust and Python together, in harmony sing—
Enabled and tidy, let the green checkmarks spring!
🐇✨

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

Copy link

@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

🧹 Nitpick comments (1)
vm/src/protocol/buffer.rs (1)

384-385: Clarify TODO wording

👍 Good catch on fixing the typo.
You may also want to add a brief note explaining that “column-major” here is equivalent to NumPy / Fortran (‘F’) order to avoid ambiguity for future contributors.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between a18029e and 758612b.

📒 Files selected for processing (4)
  • Lib/test/test_typing.py (6 hunks)
  • compiler/codegen/src/compile.rs (2 hunks)
  • vm/src/builtins/memory.rs (1 hunks)
  • vm/src/protocol/buffer.rs (1 hunks)
🧰 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_typing.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_typing.py
🧠 Learnings (2)
📓 Common learnings
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.
Learnt from: CR
PR: RustPython/RustPython#0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-06-26T12:52:11.109Z
Learning: Minimize modifications to CPython standard library files in the Lib/ directory; bug fixes should be made through Rust code modifications whenever possible.
Learnt from: CR
PR: RustPython/RustPython#0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-06-26T12:52:11.109Z
Learning: Follow Rust best practices for error handling and memory management in all RustPython Rust code.
Lib/test/test_typing.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>

⏰ Context from checks skipped due to timeout of 90000ms (11)
  • 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 tests under miri
  • GitHub Check: Run rust tests (macos-latest)
  • GitHub Check: Ensure compilation on various targets
  • 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: Run rust tests (windows-latest)
  • GitHub Check: Run rust tests (ubuntu-latest)
🔇 Additional comments (8)
compiler/codegen/src/compile.rs (2)

233-233: LGTM! Excellent debugging improvement.

Adding #[track_caller] to the unwrap_internal function will provide much better error location tracking when this function panics, showing the caller's location rather than the location inside this function. This significantly improves debugging experience for internal compiler errors.


1727-1730: Good fix! Correct symbol table lifetime management.

Moving the type parameters symbol table pop to after compile_normal_call ensures the symbol table remains available throughout the entire class compilation process, including during the class constructor call compilation. This fixes a potential issue where type parameters might not be accessible when needed during class construction.

The previous timing could have caused type parameter resolution issues during the __build_class__ call.

Lib/test/test_typing.py (6)

2928-2930: LGTM - Protocol code correctly uncommented.

The runtime checkable generic protocol definition is syntactically correct and follows proper PEP 695 generic syntax.


2990-3000: LGTM - Protocol inheritance test code correctly uncommented.

The uncommented code properly tests that protocols cannot inherit from nominal classes, with appropriate TypeError expectations.


3010-3012: Verify consistency between expectedFailure decorator and uncommented code.

Similar to the previous case, there's an @unittest.expectedFailure decorator on line 3010, but protocol code is being uncommented. Ensure the decorator is also removed if the test now passes.


3044-3047: LGTM - Protocol init preservation test code correctly uncommented.

The uncommented protocol code correctly defines a protocol with an __init__ method to test that it doesn't get overridden.


3472-3476: Verify consistency between expectedFailure decorator and uncommented code.

Again, there's an @unittest.expectedFailure decorator on line 3472, but protocol code is being uncommented. This pattern suggests the decorators should also be removed if these tests now pass.


2943-2947: Verify consistency between expectedFailure decorator and uncommented code.

The code shows an @unittest.expectedFailure decorator on line 2943, but protocol code is being uncommented below. If this test now passes (as suggested by the AI summary), the decorator should also be removed.

#!/bin/bash
# Check if expectedFailure decorators are being removed in this PR
# Look for any remaining TODO: RUSTPYTHON comments with expectedFailure decorators
rg -A 2 -B 2 "@unittest\.expectedFailure" Lib/test/test_typing.py

@youknowone youknowone merged commit 6b65345 into RustPython:main Jun 27, 2025
12 checks passed
@youknowone youknowone deleted the type_params branch June 27, 2025 05:32
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