Thanks to visit codestin.com
Credit goes to github.com

Skip to content

BaseException.__setstate__ #5821

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

BaseException.__setstate__ #5821

merged 2 commits into from
Jun 23, 2025

Conversation

youknowone
Copy link
Member

@youknowone youknowone commented Jun 22, 2025

Summary by CodeRabbit

  • New Features

    • Added support for setting exception state attributes from a dictionary.
  • Documentation

    • Updated comments to clarify the status of garbage collection, UTF-32 codec support, and upcoming exception features.
  • Refactor

    • Removed an expected failure decorator from a test, allowing it to run normally.

Copy link

coderabbitai bot commented Jun 22, 2025

Walkthrough

This update revises comments in several Python test files to clarify the status of RustPython features and support, particularly regarding garbage collection and Unicode handling. Additionally, a new setstate magic method is introduced to the RustPython exception implementation, enabling state restoration from a dictionary.

Changes

File(s) Change Summary
Lib/test/support/init.py Updated comment on disabled function to clarify lack of GC support in RustPython.
Lib/test/test_array.py Expanded comment in test to specify missing UTF-32 and reconstructor support in RustPython.
Lib/test/test_baseexception.py Clarified comment on IncompleteInputError and removed @unittest.expectedFailure decorator.
vm/src/exceptions.rs Added setstate magic method for restoring exception state from a dictionary.

Sequence Diagram(s)

sequenceDiagram
    participant Caller
    participant ExceptionObj as PyBaseException
    participant VM

    Caller->>ExceptionObj: setstate(state, vm)
    alt state is not None
        ExceptionObj->>VM: Downcast state to dict
        alt Downcast fails
            VM-->>Caller: Raise TypeError
        else Downcast succeeds
            loop For each key-value in dict
                ExceptionObj->>ExceptionObj: Set attribute key to value
            end
            ExceptionObj-->>Caller: Return None
        end
    else state is None
        ExceptionObj-->>Caller: Return None
    end
Loading

Poem

In the warren of code, a new path appears,
With comments now clearer for future frontiers.
Exceptions gain wisdom, their state to restore,
While Unicode dreams still wait at the door.
Hop, hop, little rabbit—onward we go,
With each tiny change, our garden will grow!
🐇✨


📜 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 81753c1 and a288b77.

📒 Files selected for processing (2)
  • Lib/test/test_baseexception.py (1 hunks)
  • vm/src/exceptions.rs (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (2)
  • Lib/test/test_baseexception.py
  • vm/src/exceptions.rs
⏰ Context from checks skipped due to timeout of 90000ms (10)
  • 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 (windows-latest)
  • GitHub Check: Run rust tests (ubuntu-latest)
  • GitHub Check: Ensure compilation on various targets
  • GitHub Check: Run snippets and cpython tests (macos-latest)
  • GitHub Check: Run snippets and cpython tests (ubuntu-latest)
  • GitHub Check: Check Rust code with rustfmt and clippy
  • GitHub Check: Run rust tests (windows-latest)
  • 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/exceptions.rs (1)

651-664: LGTM: Clean implementation of __setstate__ method

The implementation correctly follows Python's __setstate__ pattern for exception objects. The error handling for None state and non-dictionary types is appropriate.

However, consider adding validation for attribute names to prevent potential issues:

  • Setting reserved/special attributes could break exception functionality
  • Invalid Python identifiers as attribute names could cause issues

Consider adding basic attribute name validation:

 for (key, value) in &dict {
     let key_str = key.str(vm)?;
+    // Optional: Validate attribute name
+    if key_str.as_str().starts_with("__") && key_str.as_str().ends_with("__") {
+        // Consider whether to allow setting dunder attributes
+    }
     self.as_object().set_attr(&key_str, value.clone(), vm)?;
 }
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 5d68313 and 81753c1.

📒 Files selected for processing (4)
  • Lib/test/support/__init__.py (1 hunks)
  • Lib/test/test_array.py (1 hunks)
  • Lib/test/test_baseexception.py (1 hunks)
  • vm/src/exceptions.rs (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (10)
  • GitHub Check: Run snippets and cpython tests on wasm-wasi
  • GitHub Check: Check Rust code with rustfmt and clippy
  • GitHub Check: Check the WASM package and demo
  • GitHub Check: Run rust tests (windows-latest)
  • GitHub Check: Run rust tests (ubuntu-latest)
  • GitHub Check: Run snippets and cpython tests (windows-latest)
  • GitHub Check: Ensure compilation on various targets
  • GitHub Check: Run rust tests (macos-latest)
  • GitHub Check: Run snippets and cpython tests (macos-latest)
  • GitHub Check: Run snippets and cpython tests (ubuntu-latest)
🔇 Additional comments (4)
Lib/test/test_array.py (1)

179-179: LGTM: Improved documentation clarity.

The refined comment provides specific details about what functionality is needed for this test to pass, making it easier for future developers to understand the requirements for implementing UTF-32 support in RustPython.

Lib/test/support/__init__.py (1)

936-936: LGTM: Improved documentation clarity.

The updated comment provides more specific information about why the function is disabled, clearly stating that GC (garbage collection) is not supported yet in RustPython. This is more informative than the previous "comment out before" message.

Lib/test/test_baseexception.py (2)

86-86: Comment update aligns with current status

The change from "TODO" to "XXX" appropriately reflects that IncompleteInputError is a known item for future Python versions rather than an active development task.


124-147: Test activation indicates working __setstate__ implementation

The removal of @unittest.expectedFailure (mentioned in AI summary) aligns perfectly with the new setstate method implementation in vm/src/exceptions.rs. This test validates a critical edge case where garbage collection could cause crashes during attribute setting.

The test design is robust - it creates a scenario where:

  1. A custom hash function clears the dictionary during attribute setting
  2. Reference counting could drop below zero without proper handling
  3. Garbage collection would crash if references aren't managed correctly

Verify that this test now passes consistently with the new implementation:

#!/bin/bash
# Run the specific test to confirm it passes
python -m pytest Lib/test/test_baseexception.py::ExceptionClassTests::test_setstate_refcount_no_crash -v

@youknowone youknowone merged commit 9952c97 into RustPython:main Jun 23, 2025
22 of 23 checks passed
@youknowone youknowone deleted the exception branch June 23, 2025 04:50
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