Remove unnecessary string conversions in error message construction #5826

ShaharNaveh · 2025-06-23T08:47:08Z

There are a lot more places where we can remove the call of .to_owned(), but this is just a start.

Did it here for a couple of files just to show how much code we can remove.

Summary by CodeRabbit

Refactor
- Simplified error message creation across multiple modules by removing redundant string conversions.
- Enhanced internal functions to accept more flexible string inputs for error messages.
- Improved efficiency and clarity in error handling without changing user-facing behavior or messages.

coderabbitai · 2025-06-23T08:47:15Z

Walkthrough

This change removes unnecessary string conversions (such as .into(), .to_owned(), and .to_string()) from error message construction throughout the codebase. Error messages are now passed as string slices directly to exception constructors, and some function signatures are updated to accept any impl Into<String> type for error messages. No logic or control flow is altered.

Changes

File(s)	Change Summary
stdlib/src/array.rs, stdlib/src/hashlib.rs	Removed redundant `.into()` calls from error message construction.
vm/src/buffer.rs	Removed `.to_owned()` from error messages; updated `new_struct_error` to accept `impl Into<String>`.
vm/src/builtins/classmethod.rs, vm/src/builtins/object.rs, vm/src/builtins/staticmethod.rs	Simplified error message construction by removing `.into()` on string literals.
vm/src/builtins/module.rs	Removed `.into()` from error message in module representation error.
vm/src/exceptions.rs	Uniformly removed `.to_owned()` from error messages; simplified string formatting in one instance.
vm/src/format.rs	Removed `.to_owned()` from error message construction in formatting errors.
vm/src/sequence.rs	Removed `.to_owned()` from memory error message.
vm/src/signal.rs	Simplified error creation by removing `.to_owned()` from error message.
vm/src/stdlib/io.rs	Uniformly removed `.to_owned()` from error messages in IO-related exceptions.
vm/src/vm/vm_new.rs	Updated exception constructors to accept `impl Into<String>` for error messages.
vm/src/vm/vm_ops.rs	Removed `.to_owned()` from error messages; minor refactoring of chained method calls.
vm/src/warn.rs	Removed `.to_string()`/`.to_owned()` from warning and type error messages.
wasm/lib/src/convert.rs	Removed unnecessary `.into()` conversions for error messages.
wasm/lib/src/js_module.rs	Removed `.to_owned()` from error messages in JS module errors.
wasm/lib/src/browser_module.rs	Removed `.into()` from error message in fetch response format error.

Sequence Diagram(s)

sequenceDiagram
    participant Caller
    participant ExceptionConstructor
    Note over Caller,ExceptionConstructor: Previous flow
    Caller->>ExceptionConstructor: new_type_error("msg".to_owned())
    Note over Caller,ExceptionConstructor: New flow
    Caller->>ExceptionConstructor: new_type_error("msg")

Possibly related PRs

RustPython/RustPython#5814: Refactored VirtualMachine exception constructors using a macro, which relates to this PR's changes in error message argument handling in the same functions.

Suggested reviewers

youknowone

Poem

A bunny with a string in paw,
Hopped through code and saw a flaw—
"No need to own, just pass along!
A borrowed slice will do no wrong."
Now errors flow with lighter cheer,
The code is clean, the message clear!
🐇✨

📜 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 ebc88bc and 324b8be.

📒 Files selected for processing (1)

wasm/lib/src/convert.rs (1 hunks)

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

wasm/lib/src/convert.rs

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

GitHub Check: Run snippets and cpython tests on wasm-wasi
GitHub Check: Run rust tests (windows-latest)
GitHub Check: Run rust tests (ubuntu-latest)
GitHub Check: Run rust tests (macos-latest)
GitHub Check: Check the WASM package and demo
GitHub Check: Run tests under miri
GitHub Check: Run snippets and cpython tests (ubuntu-latest)
GitHub Check: Run snippets and cpython tests (macos-latest)
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

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

youknowone · 2025-06-24T01:28:02Z

vm/src/vm/vm_new.rs

+    pub fn new_exception_msg(
+        &self,
+        exc_type: PyTypeRef,
+        msg: impl Into<String>,
+    ) -> PyBaseExceptionRef {
+        self.new_exception(exc_type, vec![self.ctx.new_str(msg.into()).into()])


I couldn't find the issue but we once discussed about this changes. We needed a cut to to reduce binary size. I think most of new_*_error is simple wrappers of this function. Then reverting only this one and new_exception_msg_dict to using String will be good enough keep the balance of DX and having a single code to create params for new_exception.

If one of the goals of the project is to reduce the binary size, I think this PR should be closed then.

I'm all for a clean, and better code as long as it's not hurting the goals of the project:)

If you think it's a good compromise then I'll implement your suggestions, but I'm afraid that you don't want to offend me by just closing the PR lol

I think the most outer wrappers becomes more cleaner by your way. By only turning new_exception_msg and new_exception_msg_dict back to take only String, other changes will not affect binary size.
They are small functions, so must be inlined before.

The binary sizes:

target main branch diff

debug 226548kb (222M) 226620kb (222M) +72kb

relase 21836kb (22M) 21828kb (22M) -8kb

This change actually reduces the binary size on the release target? can you please verify that that's also the case on your machine?

Interesting.

Build command: cargo build --release --no-default-features (because binary size tweaks usually wants less features)

Before patch: 15196432

After patch: 15213472

It increased 17kb for me.

I rebased this patch on current main before build. My arch is aarch64-apple-darwin

Oh, I built mine on aarch64-linux-android with cargo build (so with the default features).

I can recheck it without the default features, but I don't see the point in that as I assume the majority of RustPython users are not running on an android.

How should I proceed with this PR, if at all?

I am good with reverting only new_exception_msg and new_exception_msg_dict but keeping anything else as you did.

Before patch: 15212688

After patch: 15200016

ShaharNaveh added 6 commits June 23, 2025 11:23

Make new_X_error recv impl Into<String>

e7923f6

Maks the rest of the methods to be generic

485dea2

remove to_owned

93de8d8

Remove .to_owned() from more files

8d7deb2

Make new_struct_error to be generic as well

9e83d43

Remove .to_owned() from more places

704cc8f

coderabbitai bot changed the title ~~@coderabbitai~~ Remove unnecessary string conversions in error message construction Jun 23, 2025

Resolve wasm errors

2eefb81

youknowone reviewed Jun 24, 2025

View reviewed changes

ShaharNaveh added 3 commits June 24, 2025 17:44

Merge remote-tracking branch 'upstream/main' into cln-msg-generic-string

628ee03

Revert changes to new_exception_msg and new_exception_msg_dict

ebc88bc

fix wasm

324b8be

ShaharNaveh requested a review from youknowone June 24, 2025 16:36

youknowone approved these changes Jun 24, 2025

View reviewed changes

youknowone merged commit ab09de8 into RustPython:main Jun 24, 2025
12 checks passed

ShaharNaveh mentioned this pull request Jun 25, 2025

Remove redundent to_owned() and to_string() calls #5836

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Remove unnecessary string conversions in error message construction #5826

Remove unnecessary string conversions in error message construction #5826

ShaharNaveh commented Jun 23, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

coderabbitai bot commented Jun 23, 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!

youknowone Jun 24, 2025

Uh oh!

ShaharNaveh Jun 24, 2025 •

edited

Loading

Uh oh!

youknowone Jun 24, 2025 •

edited

Loading

Uh oh!

ShaharNaveh Jun 24, 2025 •

edited

Loading

Uh oh!

youknowone Jun 24, 2025 •

edited

Loading

Uh oh!

ShaharNaveh Jun 24, 2025

Uh oh!

youknowone Jun 24, 2025

Uh oh!

youknowone Jun 24, 2025

Uh oh!

Uh oh!

Uh oh!

target	main	branch	diff
debug	226548kb (222M)	226620kb (222M)	+72kb
relase	21836kb (22M)	21828kb (22M)	-8kb

Remove unnecessary string conversions in error message construction #5826

Remove unnecessary string conversions in error message construction #5826

Conversation

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

Uh oh!

Summary by CodeRabbit

Summary by CodeRabbit

Uh oh!

coderabbitai bot commented Jun 23, 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

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

youknowone Jun 24, 2025

Choose a reason for hiding this comment

Uh oh!

ShaharNaveh Jun 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

youknowone Jun 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ShaharNaveh Jun 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

youknowone Jun 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ShaharNaveh Jun 24, 2025

Choose a reason for hiding this comment

Uh oh!

youknowone Jun 24, 2025

Choose a reason for hiding this comment

Uh oh!

youknowone Jun 24, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

ShaharNaveh commented Jun 23, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Jun 23, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

ShaharNaveh Jun 24, 2025 •

edited

Loading

youknowone Jun 24, 2025 •

edited

Loading

ShaharNaveh Jun 24, 2025 •

edited

Loading

youknowone Jun 24, 2025 •

edited

Loading