Convert `new_X_error` to use a macro by ShaharNaveh · Pull Request #5814 · RustPython/RustPython

ShaharNaveh · 2025-06-22T08:20:45Z

Summary by CodeRabbit

Refactor
- Streamlined internal exception creation methods to reduce code duplication and improve maintainability. No changes to user-facing functionality or error messages.

coderabbitai · 2025-06-22T08:20:52Z

Walkthrough

The code refactors the VirtualMachine implementation by removing individually defined exception constructor methods and replacing them with a macro, define_exception_fn!, which generates these functions. This macro-based approach consolidates the creation of exception functions, reducing repetitive code without altering their behavior or logic.

Changes

File(s)	Change Summary
vm/src/vm/vm_new.rs	Removed explicit exception constructor methods; introduced and used `define_exception_fn!` macro to generate equivalent functions for various exceptions, including one with a docstring.

Sequence Diagram(s)

sequenceDiagram
    participant Caller
    participant VirtualMachine

    Caller->>VirtualMachine: new_value_error(msg)
    VirtualMachine->>VirtualMachine: Macro-generated function creates ValueError with msg
    VirtualMachine-->>Caller: PyBaseExceptionRef (ValueError)

Poem

In the warren of code, where exceptions grew tall,
A macro now hops, answering each call.
No more repeating, no more the same—
Just one clever spell to conjure each name.
With every error neat and new,
The VM’s job is easier to do!
🐇✨

📜 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 6ad177a and 6fa026b.

📒 Files selected for processing (1)

vm/src/vm/vm_new.rs (2 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

vm/src/vm/vm_new.rs

⏰ Context from checks skipped due to timeout of 90000ms (4)

GitHub Check: Run snippets and cpython tests (windows-latest)
GitHub Check: Check Rust code with rustfmt and clippy
GitHub Check: Ensure compilation on various targets
GitHub Check: Run snippets and cpython 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.

ShaharNaveh · 2025-06-22T08:23:29Z

vm/src/vm/vm_new.rs

+    define_exception_fn!(
+        new_value_error,
+        value_error,
+        doc = "Create a new python ValueError object.


Thought of have this doc as part of the macro and only put the python exception name to template.
so it can look like:

define_exception_fn!(new_value_error, value_error, ValueError); define_exception_fn!(new_index_error, index_error, IndexEror);

I can do it in a separate PR if you think that it would be beneficial

I agree to auto-generate docs

youknowone

Thank you so much!

vm/src/vm/vm_new.rs

youknowone · 2025-06-22T08:36:29Z

vm/src/vm/vm_new.rs

+    define_exception_fn!(
+        new_value_error,
+        value_error,
+        doc = "Create a new python ValueError object.


I agree to auto-generate docs

Co-authored-by: Jeong, YunWon <[email protected]>

Convert new_X_error to use a macro

8d2ad45

ShaharNaveh commented Jun 22, 2025

View reviewed changes

youknowone requested changes Jun 22, 2025

View reviewed changes

ShaharNaveh and others added 2 commits June 22, 2025 11:50

Update vm/src/vm/vm_new.rs

6ad177a

Co-authored-by: Jeong, YunWon <[email protected]>

Macro now contains doc

6fa026b

ShaharNaveh requested a review from youknowone June 22, 2025 09:07

youknowone approved these changes Jun 22, 2025

View reviewed changes

youknowone merged commit e27263a into RustPython:main Jun 22, 2025
12 checks passed

coderabbitai bot mentioned this pull request Jun 23, 2025

Remove unnecessary string conversions in error message construction #5826

Merged

ShaharNaveh deleted the define-exception-macro branch June 24, 2025 08:05

coderabbitai bot mentioned this pull request Dec 9, 2025

new_last_{os,errno}_error #6381

Merged

coderabbitai bot mentioned this pull request Dec 30, 2025

Add PythonFinallizationError and upgrade multiprocessing #6592

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Convert `new_X_error` to use a macro#5814

Convert `new_X_error` to use a macro#5814
youknowone merged 3 commits intoRustPython:mainfrom
ShaharNaveh:define-exception-macro

ShaharNaveh commented Jun 22, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

coderabbitai bot commented Jun 22, 2025 •

edited

Loading

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

ShaharNaveh Jun 22, 2025

Uh oh!

youknowone Jun 22, 2025

Uh oh!

youknowone left a comment

Uh oh!

Uh oh!

youknowone Jun 22, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

ShaharNaveh commented Jun 22, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

coderabbitai bot commented Jun 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Sequence Diagram(s)

Poem

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

ShaharNaveh Jun 22, 2025

Choose a reason for hiding this comment

Uh oh!

youknowone Jun 22, 2025

Choose a reason for hiding this comment

Uh oh!

youknowone left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

youknowone Jun 22, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

ShaharNaveh commented Jun 22, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Jun 22, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)