Skip to content

Complete tp_repr #5852

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
Jun 27, 2025
Merged

Complete tp_repr #5852

merged 1 commit into from
Jun 27, 2025

Conversation

youknowone
Copy link
Member

@youknowone youknowone commented Jun 27, 2025

Summary by CodeRabbit

  • Refactor

    • Enforced that all objects have a defined __repr__ method for consistent representation.
    • Improved the formatting and output of structured sequence representations for clarity.
  • Bug Fixes

    • Enhanced error messages when an object lacks a valid representation method, providing clearer feedback.

Copy link

coderabbitai bot commented Jun 27, 2025

Walkthrough

The changes refactor how object representations (__repr__) are handled in the codebase. The fallback mechanism for missing __repr__ slots was removed from the core object protocol, enforcing that all classes must define this slot. Additionally, the struct sequence's __repr__ logic was reorganized, introducing a slot-based approach and updating type signatures for improved clarity and type safety.

Changes

File(s) Change Summary
vm/src/protocol/object.rs Removed fallback to dynamic __repr__ method call in PyObject::repr; now returns error if slot missing in MRO.
vm/src/types/structseq.rs Added slot_repr with #[pyslot], changed __repr__ signature to use generic PyObjectRef and return PyStrRef; reorganized formatting and imports.

Poem

In the code, a change so neat,
__repr__ slots now must be complete.
Struct sequences shine with a tidy new face,
Type safety and clarity now in their place.
No more fallback magic, just clear rabbit code—
Hopping forward, lightening the load! 🐇


📜 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 d0ae853 and c9dd446.

📒 Files selected for processing (2)
  • vm/src/protocol/object.rs (1 hunks)
  • vm/src/types/structseq.rs (2 hunks)
🚧 Files skipped from review as they are similar to previous changes (2)
  • vm/src/protocol/object.rs
  • vm/src/types/structseq.rs
⏰ 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: Run snippets and cpython tests (macos-latest)
  • GitHub Check: Run snippets and cpython tests (ubuntu-latest)
  • GitHub Check: Run snippets and cpython tests (windows-latest)
  • GitHub Check: Run tests under miri
  • GitHub Check: Run rust tests (windows-latest)
  • GitHub Check: Check Rust code with rustfmt and clippy
  • GitHub Check: Run rust tests (ubuntu-latest)
  • GitHub Check: Ensure compilation on various targets
  • GitHub Check: Run rust tests (macos-latest)
✨ 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: 0

🧹 Nitpick comments (1)
vm/src/types/structseq.rs (1)

50-54: Verify the downcast approach is robust.

The downcast from &PyObject to PyTuple is necessary for the slot-based approach, but the error message could be more descriptive for debugging purposes.

Consider improving the error message to include the actual type information:

-            .ok_or_else(|| vm.new_type_error("unexpected payload for __repr__"))?;
+            .ok_or_else(|| vm.new_type_error(format!(
+                "expected PyTuple for struct sequence __repr__, got {}",
+                zelf.class().name()
+            )))?;
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between f5ccd4f and d0ae853.

📒 Files selected for processing (2)
  • vm/src/protocol/object.rs (1 hunks)
  • vm/src/types/structseq.rs (2 hunks)
🧰 Additional context used
🧠 Learnings (2)
vm/src/protocol/object.rs (2)
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.
Learnt from: CR
PR: RustPython/RustPython#0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-06-26T12:52:11.109Z
Learning: Use the macro system (such as 'pyclass', 'pymodule', 'pyfunction') when implementing Python functionality in Rust for RustPython.
vm/src/types/structseq.rs (5)
Learnt from: CR
PR: RustPython/RustPython#0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-06-26T12:52:11.109Z
Learning: Use the macro system (such as 'pyclass', 'pymodule', 'pyfunction') when implementing Python functionality in Rust for RustPython.
Learnt from: CR
PR: RustPython/RustPython#0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-06-26T12:52:11.109Z
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.109Z
Learning: Follow Rust best practices for error handling and memory management in all RustPython Rust code.
Learnt from: CR
PR: RustPython/RustPython#0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-06-26T12:52:11.109Z
Learning: When comparing behavior with CPython, use the 'python' command explicitly for CPython and 'cargo run --' for RustPython to avoid confusion.
Learnt from: CR
PR: RustPython/RustPython#0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-06-26T12:52:11.109Z
Learning: To add a Python module to the RustPython interpreter, use 'vm.add_native_module' with the module name and module factory.
⏰ Context from checks skipped due to timeout of 90000ms (6)
  • GitHub Check: Run snippets and cpython tests (windows-latest)
  • GitHub Check: Run tests under miri
  • GitHub Check: Run snippets and cpython tests on wasm-wasi
  • GitHub Check: Run rust tests (macos-latest)
  • GitHub Check: Run rust tests (windows-latest)
  • GitHub Check: Check the WASM package and demo
🔇 Additional comments (5)
vm/src/protocol/object.rs (1)

335-338: Verify this breaking change is intentional and won't cause runtime failures.

The removal of the fallback mechanism for missing __repr__ slots is a significant behavioral change. This now enforces that every object must have a properly defined repr slot, which could cause runtime errors for existing objects that previously relied on the dynamic fallback.

Please verify that all built-in types and user-defined classes have proper repr slots defined:

#!/bin/bash
# Description: Search for pyclass definitions that might be missing repr slots
# Expected: All classes should have either explicit repr slots or inherit them

echo "Searching for pyclass definitions..."
ast-grep --pattern $'#[pyclass]
$$$
trait $NAME {
  $$$
}'

echo -e "\nSearching for explicit slot_repr implementations..."
rg -A 5 "slot_repr|#\[pyslot\].*repr"

echo -e "\nSearching for __repr__ method implementations..."
rg -A 3 "fn __repr__"
vm/src/types/structseq.rs (4)

2-3: Import changes look appropriate.

The addition of PyObject and PyStrRef imports aligns with the new slot-based approach that returns PyStrRef and accepts generic &PyObject parameters.


60-76: LGTM! Recursion guard and formatting logic preserved correctly.

The refactored code maintains the original logic for:

  • Recursion detection using ReprGuard
  • Special handling for single required field with trailing comma
  • Proper field formatting with name-value pairs

The change from zelf.as_ref() is appropriate for the new parameter type.


77-79: Return type change aligns with slot requirements.

The change from returning a String to PyStrRef is correct for the slot-based approach and maintains consistency with other slot implementations.


81-84: Simplified wrapper method is clean and consistent.

The __repr__ method is now appropriately simplified to just delegate to the slot implementation, which follows the established pattern for slot-based methods.

@youknowone youknowone merged commit b9b1c85 into RustPython:main Jun 27, 2025
12 checks passed
@youknowone youknowone deleted the finish-repr branch June 27, 2025 14:14
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