Skip to content

Add separator validation #5904

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
Jul 6, 2025
Merged

Conversation

yt2b
Copy link
Contributor

@yt2b yt2b commented Jul 5, 2025

Summary

I've added format separator validation.

>>>>> f"{1:,,}"
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
ValueError: Cannot specify ',' with ','.
>>>>> f"{1:,_}"
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
ValueError: Cannot specify both ',' and '_'.

With this fix, following tests now pass.

  • test_format.py
    • test_with_two_commas_in_format_specifier
    • test_with_two_underscore_in_format_specifier
    • test_with_a_commas_and_an_underscore_in_format_specifier
    • test_with_an_underscore_and_a_comma_in_format_specifier
  • test_fstring.py
    • test_with_two_commas_in_format_specifier
    • test_with_two_underscore_in_format_specifier
    • test_with_a_commas_and_an_underscore_in_format_specifier
    • test_with_an_underscore_and_a_comma_in_format_specifier
  • test_long.py
    • test__format__

Summary by CodeRabbit

  • New Features

    • Improved validation of grouping separators in format specifications, providing immediate feedback on invalid combinations.
    • Added clearer error messages when conflicting grouping separators are specified.
  • Bug Fixes

    • Prevented the use of both comma and underscore as grouping separators in the same format specifier.

Copy link
Contributor

coderabbitai bot commented Jul 5, 2025

Walkthrough

The changes introduce stricter validation for grouping separators in format specifications. A new error variant, ExclusiveFormat, is added to handle conflicting separator usage. Conversion logic between grouping types and their character representations is refactored for clarity, and error handling is updated to provide descriptive messages for these new validation cases.

Changes

File(s) Change Summary
common/src/format.rs Added From<&FormatGrouping> for char implementation, validate_separator method, ExclusiveFormat error variant, and refactored separator handling in FormatSpec::_parse.
vm/src/format.rs Added ExclusiveFormat match arm in IntoPyException for FormatSpecError with descriptive error message.

Poem

A comma or underscore, but never both,
The rules are clear, so don't be loath.
With new checks in place, the code is tight,
Errors now shine with messages bright.
🐇 Formatters rejoice—your specs are right!


📜 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 3c7ec04 and 72a3288.

⛔ Files ignored due to path filters (3)
  • Lib/test/test_format.py is excluded by !Lib/**
  • Lib/test/test_fstring.py is excluded by !Lib/**
  • Lib/test/test_long.py is excluded by !Lib/**
📒 Files selected for processing (2)
  • common/src/format.rs (7 hunks)
  • vm/src/format.rs (1 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/format.rs
  • common/src/format.rs
⏰ Context from checks skipped due to timeout of 90000ms (11)
  • GitHub Check: Run rust tests (windows-latest)
  • GitHub Check: Run tests under miri
  • GitHub Check: Check Rust code with rustfmt and clippy
  • GitHub Check: Check the WASM package and demo
  • GitHub Check: Run snippets and cpython tests on wasm-wasi
  • GitHub Check: Run rust tests (macos-latest)
  • GitHub Check: Run rust tests (ubuntu-latest)
  • GitHub Check: Run snippets and cpython tests (macos-latest)
  • GitHub Check: Run snippets and cpython tests (windows-latest)
  • GitHub Check: Ensure compilation on various targets
  • GitHub Check: Run snippets and cpython tests (ubuntu-latest)
🔇 Additional comments (7)
common/src/format.rs (6)

130-137: Well-implemented conversion trait for FormatGrouping.

The From<&FormatGrouping> for char implementation provides a clean, centralized way to convert grouping types to their character representations. This improves maintainability and reduces code duplication.


303-305: Proper validation placement after grouping option parsing.

The validation is correctly placed immediately after parsing the grouping option, ensuring that invalid separator combinations are caught early in the parsing process.


330-342: Robust separator validation logic with appropriate error handling.

The validate_separator method correctly identifies:

  • Repeated separators (e.g., ,,) → UnspecifiedFormat
  • Mixed separators (e.g., ,_ or _,) → ExclusiveFormat

The logic properly uses the new char::from(grouping) conversion and handles edge cases appropriately.


436-436: Good refactoring to use the new conversion trait.

Replacing the explicit match with char::from(fg) improves consistency and leverages the centralized conversion logic.


747-747: Consistent application of the new conversion pattern.

Another proper usage of the char::from(fg) conversion, maintaining consistency throughout the codebase.


842-842: Appropriate new error variant for exclusive format conflicts.

The ExclusiveFormat(char, char) variant correctly represents the specific case where incompatible separators are used together, distinct from the existing UnspecifiedFormat variant.

vm/src/format.rs (1)

24-27: Correct error message formatting for exclusive format conflicts.

The implementation properly handles the new ExclusiveFormat variant with an appropriate error message that clearly indicates both conflicting separators. The message format "Cannot specify both '{c1}' and '{c2}'." aligns with the expected behavior described in the PR objectives.

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

Copy link

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Summary of Changes

Hello @yt2b, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request enhances the parsing of format specifiers by adding validation for grouping separators. The primary goal is to enforce correct usage of comma (,) and underscore (_) as thousands separators, ensuring that only one type is used and not duplicated, thereby aligning the behavior with standard Python f-string formatting and raising appropriate ValueError exceptions for invalid inputs.

Highlights

  • Format Specifier Validation: I've implemented validation for grouping separators (, and _) in format specifiers to prevent invalid combinations, such as using both or duplicating one (e.g., ,, or ,_).
  • Error Handling: I've introduced a new FormatSpecError::ExclusiveFormat to specifically handle cases where mutually exclusive separators (comma and underscore) are provided, differentiating it from duplicate separator errors.
  • Code Refinement: I've added a From implementation to convert FormatGrouping enum variants directly to their char representation, which simplifies and de-duplicates code where separator characters are retrieved.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in issue comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist is currently in preview and may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments to provide feedback.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request introduces validation for format specifiers to prevent multiple grouping separators, which previously caused a ValueError in Python. The changes add a new error type and validation logic in the format parser.

Comment on lines +331 to +332
let mut chars = text.code_points().peekable();
match chars.peek().and_then(|cp| CodePoint::to_char(*cp)) {

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

Consider using text.chars() to directly iterate over chars, avoiding the need to iterate over code points and convert them. Using peek().copied() on the char iterator will provide an Option<char>, which aligns well with the existing match statement's patterns.

Suggested change
let mut chars = text.code_points().peekable();
match chars.peek().and_then(|cp| CodePoint::to_char(*cp)) {
let mut chars = text.chars().peekable();
match chars.peek().copied() {

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@gemini-code-assist
Type of text is &Wtf8. So text doesn't have a chars function.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You are absolutely correct, yt2b. My apologies. I overlooked that text is of type &Wtf8, which indeed does not expose a chars() method like standard Rust &str or String types. The current approach of iterating over code_points() and then converting to char via CodePoint::to_char is the correct and necessary way to handle character iteration for the Wtf8 type. Thank you for clarifying!

Copy link
Member

@youknowone youknowone left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for contributing!

@youknowone youknowone merged commit 23a5c82 into RustPython:main Jul 6, 2025
22 of 23 checks passed
@yt2b yt2b deleted the separator_validation branch July 6, 2025 14:14
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.

2 participants