◐ Shell
clean mode source ↗

Exception.set_traceback_typed by youknowone · Pull Request #5832 · RustPython/RustPython

youknowone

Walkthrough

This change updates how exception tracebacks are set and validated. It introduces stricter type checking in the Rust backend, ensuring only valid traceback objects or None can be assigned to exceptions. The Python test for invalid traceback assignment is now treated as a normal test, no longer marked as an expected failure.

Changes

File(s) Change Summary
Lib/test/test_exceptions.py Removed @unittest.expectedFailure decorator from testInvalidTraceback test method.
vm/src/exceptions.rs Refactored traceback setter: added type checking, new helper method, updated method signatures.
vm/src/frame.rs, vm/src/import.rs Switched to using the new typed traceback setter method for assigning tracebacks.

Sequence Diagram(s)

sequenceDiagram
    participant PythonTest
    participant PyBaseException
    participant VirtualMachine

    PythonTest->>PyBaseException: Set __traceback__ (invalid value)
    PyBaseException->>PyBaseException: set_traceback(value, vm)
    alt value is None or PyTraceback
        PyBaseException->>PyBaseException: set_traceback_typed(traceback)
        PyBaseException-->>PythonTest: Success
    else value is invalid
        PyBaseException-->>PythonTest: Raise TypeError
    end
Loading

Possibly related PRs

  • RustPython/RustPython#5807: Removes the @unittest.expectedFailure decorator from other test methods in test_exceptions.py, related by theme and file.

Poem

In the warren of code where exceptions dwell,
A rabbit ensures type checks are done well.
No more sneaky integers in traceback's lair—
Only tracebacks or None shall enter there!
With tests now honest, no failures to feign,
The code hops forward, clear and plain.
🐇✨

📜 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 a8c9703 and f3e4b4f.

📒 Files selected for processing (4)
  • Lib/test/test_exceptions.py (0 hunks)
  • vm/src/exceptions.rs (3 hunks)
  • vm/src/frame.rs (1 hunks)
  • vm/src/import.rs (1 hunks)
💤 Files with no reviewable changes (1)
  • Lib/test/test_exceptions.py
🧰 Additional context used
📓 Path-based instructions (1)
`**/*.rs`: Follow the default rustfmt code style; use 'cargo fmt' to format Rust code. Always run clippy to lint Rust code ('cargo clippy') before completing tasks, and fix any war...

**/*.rs: Follow the default rustfmt code style; use 'cargo fmt' to format Rust code.
Always run clippy to lint Rust code ('cargo clippy') before completing tasks, and fix any warnings or lints introduced by your changes.

  • vm/src/import.rs
  • vm/src/frame.rs
  • vm/src/exceptions.rs
⏰ Context from checks skipped due to timeout of 90000ms (11)
  • GitHub Check: Run snippets and cpython tests on wasm-wasi
  • GitHub Check: Run tests under miri
  • GitHub Check: Run rust tests (macos-latest)
  • GitHub Check: Run snippets and cpython tests (windows-latest)
  • 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: Ensure compilation on various targets
  • GitHub Check: Run rust tests (ubuntu-latest)
  • GitHub Check: Run rust tests (windows-latest)
  • GitHub Check: Check Rust code with rustfmt and clippy
🔇 Additional comments (6)
vm/src/import.rs (1)

216-216: LGTM: Clean refactor to use typed traceback setter.

The change from set_traceback to set_traceback_typed aligns with the broader refactor to enforce stricter type checking for traceback assignment. The method signature and behavior remain consistent while improving type safety.

vm/src/frame.rs (1)

390-390: LGTM: Consistent use of typed traceback setter in exception handling.

The change to set_traceback_typed is consistent with the codebase refactor and maintains the same behavior for critical exception handling. The parameter type and conversion logic remain unchanged.

vm/src/exceptions.rs (4)

7-8: LGTM: Import additions support the traceback type checking enhancements.

The imports for PyTraceback and PyTracebackRef are necessary for the stricter type validation being introduced.

328-328: Good use of the new typed internal method.

Using set_traceback_typed for internal VM operations avoids unnecessary validation overhead and provides type safety at compile time.

588-603: Excellent implementation of input validation with proper error handling.

The public setter now properly validates that only None or valid PyTraceback objects can be assigned, providing clear error messages for invalid types. The separation between validation (here) and actual assignment (delegated to set_traceback_typed) follows good design principles.

The validation logic correctly:

  • Handles None values appropriately
  • Attempts type-safe downcasting to PyTraceback
  • Returns meaningful TypeError with a clear message
  • Delegates to the type-safe internal method

605-608: Well-designed internal helper method for type-safe operations.

The set_traceback_typed method provides a clean, type-safe interface for internal VM operations without validation overhead. The pub(crate) visibility is appropriate for internal use.

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