Use `raise_if_stop!` macro where possible #5938

ShaharNaveh · 2025-07-10T16:14:36Z

Summary by CodeRabbit

Refactor
- Streamlined internal error handling for built-in enumerate, filter, and map iterators, resulting in more concise and maintainable code. No changes to user-facing functionality.

coderabbitai · 2025-07-10T16:14:43Z

Walkthrough

The changes refactor the next method implementations for PyEnumerate, PyFilter, and PyMap iterators to use the raise_if_stop! macro instead of manually matching on PyIterReturn variants. This streamlines the handling of StopIteration cases without altering the underlying logic or control flow.

Changes

File(s)	Change Summary
vm/src/builtins/enumerate.rs	Replaced explicit match on `PyIterReturn` with `raise_if_stop!` macro in `PyEnumerate::next`.
vm/src/builtins/filter.rs	Refactored `PyFilter`'s `IterNext` to use `raise_if_stop!` macro for `StopIteration` handling.
vm/src/builtins/map.rs	Updated `PyMap`'s `IterNext` to use `raise_if_stop!` macro instead of manual matching.

Sequence Diagram(s)

sequenceDiagram
    participant Caller
    participant Iterator
    participant VM

    Caller->>Iterator: next(vm)
    Iterator->>VM: iterator.next(vm)
    VM-->>Iterator: PyIterReturn (Return or StopIteration)
    Iterator->>Iterator: raise_if_stop!(result)
    alt If StopIteration
        Iterator-->>Caller: StopIteration (early return)
    else If Return
        Iterator-->>Caller: Next item
    end

Possibly related PRs

Add raise_if_stop! macro for protocol/iter.rs #5885: Introduced the raise_if_stop! macro, which this PR now uses to simplify iterator next implementations.

Suggested reviewers

youknowone

Poem

In the land of Rust, where iterators hop,
A macro now helps when the items must stop.
No more matches long and deep,
Just raise_if_stop!—so concise, so neat!
The code now leaps, the code now flows,
Like a rabbit’s path where the green grass grows.
🐇✨

📜 Recent review details

Configuration used: .coderabbit.yml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 089c39f and bf03102.

📒 Files selected for processing (3)

vm/src/builtins/enumerate.rs (2 hunks)
vm/src/builtins/filter.rs (2 hunks)
vm/src/builtins/map.rs (2 hunks)

🧰 Additional context used

📓 Path-based instructions (1)

`**/*.rs`: Follow the default rustfmt code style (`cargo fmt` to format) Always ...

**/*.rs: Follow the default rustfmt code style (cargo fmt to format)
Always run clippy to lint code (cargo clippy) before completing tasks. Fix any warnings or lints that are introduced by your changes
Follow Rust best practices for error handling and memory management
Use the macro system (pyclass, pymodule, pyfunction, etc.) when implementing Python functionality in Rust

📄 Source: CodeRabbit Inference Engine (.github/copilot-instructions.md)

List of files the instruction was applied to:

vm/src/builtins/enumerate.rs
vm/src/builtins/map.rs
vm/src/builtins/filter.rs

🧠 Learnings (3)

vm/src/builtins/enumerate.rs (1)

Learnt from: CR
PR: RustPython/RustPython#0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-06-30T10:08:48.858Z
Learning: Applies to **/*.rs : Use the macro system (`pyclass`, `pymodule`, `pyfunction`, etc.) when implementing Python functionality in Rust

vm/src/builtins/map.rs (1)

Learnt from: CR
PR: RustPython/RustPython#0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-06-30T10:08:48.858Z
Learning: Applies to **/*.rs : Use the macro system (`pyclass`, `pymodule`, `pyfunction`, etc.) when implementing Python functionality in Rust

vm/src/builtins/filter.rs (1)

Learnt from: CR
PR: RustPython/RustPython#0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-06-30T10:08:48.858Z
Learning: Applies to **/*.rs : Use the macro system (`pyclass`, `pymodule`, `pyfunction`, etc.) when implementing Python functionality in Rust

🧬 Code Graph Analysis (1)

vm/src/builtins/map.rs (3)

vm/src/builtins/filter.rs (1)

next (51-69)

vm/src/builtins/enumerate.rs (3)

next (79-85)

next (136-140)

new (103-108)

vm/src/builtins/zip.rs (2)

next (74-111)

zelf (50-54)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (11)

GitHub Check: Run snippets and cpython tests on wasm-wasi
GitHub Check: Run snippets and cpython tests (macos-latest)
GitHub Check: Check the WASM package and demo
GitHub Check: Run snippets and cpython tests (windows-latest)
GitHub Check: Run rust tests (windows-latest)
GitHub Check: Run tests under miri
GitHub Check: Run snippets and cpython tests (ubuntu-latest)
GitHub Check: Check Rust code with rustfmt and clippy
GitHub Check: Run rust tests (macos-latest)
GitHub Check: Run rust tests (ubuntu-latest)
GitHub Check: Ensure compilation on various targets

🔇 Additional comments (7)

vm/src/builtins/enumerate.rs (2)

11-11: LGTM! Import addition is correct.

The raise_if_stop import is properly added to support the macro usage in the IterNext implementation.

80-80: Excellent refactoring using the raise_if_stop! macro.

The macro usage correctly simplifies the handling of PyIterReturn by replacing explicit pattern matching. This maintains the same semantics while making the code more concise and consistent with other iterator implementations.

vm/src/builtins/filter.rs (3)

6-6: LGTM! Import addition is correct.

The raise_if_stop import is properly added to support the macro usage in the IterNext implementation.

54-54: Excellent refactoring using the raise_if_stop! macro.

The macro usage correctly simplifies the handling of PyIterReturn from the iterator's next() method, maintaining the same semantics while making the code more concise.

58-63: Good use of raise_if_stop! for predicate handling.

The macro correctly handles the case where the predicate itself can raise StopIteration, which should stop the filter iteration. The refactoring maintains the original logic while making it more readable and consistent with the iterator handling pattern.

vm/src/builtins/map.rs (2)

8-8: LGTM! Import addition is correct.

The raise_if_stop import is properly added to support the macro usage in the IterNext implementation.

62-62: Excellent refactoring using the raise_if_stop! macro.

The macro usage correctly simplifies the handling of PyIterReturn from each iterator's next() method within the loop. This maintains the same semantics where any iterator reaching StopIteration will cause the entire map iteration to stop, while making the code more concise and consistent with other iterator implementations.

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

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.

Use raise_if_stop! macro where possible

bf03102

youknowone approved these changes Jul 10, 2025

View reviewed changes

youknowone merged commit 01f1506 into RustPython:main Jul 10, 2025
12 checks passed

ShaharNaveh deleted the raise-if-stop-usage branch July 11, 2025 09:26

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Use `raise_if_stop!` macro where possible #5938

Use `raise_if_stop!` macro where possible #5938

Uh oh!

ShaharNaveh commented Jul 10, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

coderabbitai bot commented Jul 10, 2025 •

edited

Loading

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

Documentation and Community

Uh oh!

Uh oh!

Uh oh!

Use raise_if_stop! macro where possible #5938

Use raise_if_stop! macro where possible #5938

Uh oh!

Conversation

ShaharNaveh commented Jul 10, 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 Jul 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Sequence Diagram(s)

Possibly related PRs

Suggested reviewers

Poem

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

Documentation and Community

Uh oh!

Uh oh!

Uh oh!

Use `raise_if_stop!` macro where possible #5938

Use `raise_if_stop!` macro where possible #5938

ShaharNaveh commented Jul 10, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Jul 10, 2025 •

edited

Loading