Skip to content

__repr__ in typing #5870

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 30, 2025
Merged

__repr__ in typing #5870

merged 2 commits into from
Jun 30, 2025

Conversation

youknowone
Copy link
Member

@youknowone youknowone commented Jun 30, 2025

Summary by CodeRabbit

  • Bug Fixes

    • Updated string representations for certain typing-related classes to improve consistency and clarity.
  • Tests

    • Adjusted test expectations so that previously failing typing tests are now expected to pass.

Copy link

coderabbitai bot commented Jun 30, 2025

Walkthrough

This update removes the @unittest.expectedFailure decorator from four tests in Lib/test/test_typing.py, indicating these tests are now expected to pass. Additionally, the ParamSpec and TypeVarTuple classes in typing.rs gain or adjust custom string representations, and the Generic class's pyclass attributes are updated.

Changes

File(s) Change Summary
Lib/test/test_typing.py Removed @unittest.expectedFailure decorators and related comments from four test methods.
vm/src/stdlib/typing.rs Added/modified Representable trait for ParamSpec and TypeVarTuple. Updated Generic pyclass attributes.

Sequence Diagram(s)

sequenceDiagram
    participant TestSuite as test_typing.py
    participant RustPythonVM as typing.rs
    TestSuite->>RustPythonVM: Create ParamSpec/TypeVarTuple/Generic instance
    RustPythonVM-->>TestSuite: Return custom string representation via Representable trait
Loading

Possibly related PRs

  • typing ParamSpec #5837: Also removes @unittest.expectedFailure decorators from tests in Lib/test/test_typing.py, overlapping in purpose and file.
  • more typing #5840: Removes expected failure decorators and TODOs from typing tests, focusing on similar test annotation cleanup.
  • typing.TypeVar #5834: Changes expected failure markers in Lib/test/test_typing.py, including in GenericTests and TypeVarTests.

Suggested reviewers

  • arihant2math

Poem

In the warren of tests, some failures once lay,
But now with a hop, those troubles away!
ParamSpec and friends, with new names to show,
Generic’s attire, now proper in tow.
A rabbit applauds with a jubilant cheer—
Typing is clearer, and all tests sincere!
🐇✨


📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between b6ff541 and 5640365.

📒 Files selected for processing (2)
  • Lib/test/test_typing.py (0 hunks)
  • vm/src/stdlib/typing.rs (4 hunks)
💤 Files with no reviewable changes (1)
  • Lib/test/test_typing.py
🧰 Additional context used
🧠 Learnings (2)
📓 Common learnings
Learnt from: CR
PR: RustPython/RustPython#0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-06-26T12:52:11.138Z
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.
vm/src/stdlib/typing.rs (2)
Learnt from: CR
PR: RustPython/RustPython#0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-06-26T12:52:11.138Z
Learning: When implementing a Python module in Rust for RustPython, use the #[pymodule] attribute and expose functions and classes using #[pyfunction], #[pyclass], and #[pymethod] as appropriate.
Learnt from: CR
PR: RustPython/RustPython#0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-06-26T12:52:11.138Z
Learning: Use the macro system (such as 'pyclass', 'pymodule', 'pyfunction') when implementing Python functionality in Rust for RustPython.
🔇 Additional comments (4)
vm/src/stdlib/typing.rs (4)

346-346: LGTM! Consistent trait implementation pattern.

Adding Representable to ParamSpec's traits aligns with the existing pattern used by TypeVar and TypeVarTuple classes.


558-564: LGTM! Correct ParamSpec representation format.

The implementation correctly returns ~{name} format for ParamSpec, which is the expected representation for parameter specifications in Python's typing system.


750-750: LGTM! Corrected TypeVarTuple representation.

Removing the "*" prefix is correct - the asterisk is syntactic sugar for unpacking usage (e.g., Generic[*Ts]) but shouldn't appear in the TypeVarTuple object's string representation itself.


971-971: LGTM! Improved consistency with explicit class attributes.

Explicitly setting name and module attributes brings Generic in line with the pattern used by other typing classes in this file and ensures proper introspection.

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

@youknowone youknowone marked this pull request as ready for review June 30, 2025 01:18
@youknowone youknowone merged commit b59a666 into RustPython:main Jun 30, 2025
12 checks passed
@youknowone youknowone deleted the typing-repr branch June 30, 2025 01:36
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