Skip to content

ucd.is_mirrored #5816

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 1 commit into from
Jun 22, 2025
Merged

ucd.is_mirrored #5816

merged 1 commit into from
Jun 22, 2025

Conversation

youknowone
Copy link
Member

@youknowone youknowone commented Jun 22, 2025

Summary by CodeRabbit

  • New Features

    • Added support for the mirrored attribute in the Unicode data module, allowing users to check if a character is mirrored in bidirectional text.
  • Bug Fixes

    • Enabled the Unicode mirroring test to run as a regular test by removing its expected failure status.

Copy link

coderabbitai bot commented Jun 22, 2025

Walkthrough

A new dependency, unicode-bidi-mirroring, was added to the project configuration. The unicodedata module in Rust now implements the mirrored attribute, enabling detection of mirrored Unicode characters. Corresponding Python tests were updated by removing the expectedFailure decorator, reflecting the new support for this attribute.

Changes

File(s) Change Summary
Cargo.toml, stdlib/Cargo.toml Added unicode-bidi-mirroring as a workspace dependency.
stdlib/src/unicodedata.rs Implemented the mirrored method in the Ucd class; exposed the attribute in module exports.
Lib/test/test_unicodedata.py Removed @unittest.expectedFailure from test_mirrored, enabling the test.

Sequence Diagram(s)

sequenceDiagram
    participant PythonTest
    participant unicodedata (Rust)
    participant unicode_bidi_mirroring (crate)

    PythonTest->>unicodedata (Rust): Call mirrored(character)
    unicodedata (Rust)->>unicode_bidi_mirroring (crate): is_mirroring(character)
    unicode_bidi_mirroring (crate)-->>unicodedata (Rust): true/false
    unicodedata (Rust)-->>PythonTest: Return 1 if mirrored, 0 otherwise
Loading

Poem

In Unicode’s mirrored halls I peek,
Now Rusty magic lets me seek—
Is this glyph flipped in bidirectional flow?
A crate lends wisdom, now I know!
Tests once failed, but now they cheer,
Unicode secrets, crystal 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 44d3124 and 63e721c.

⛔ Files ignored due to path filters (1)
  • Cargo.lock is excluded by !**/*.lock
📒 Files selected for processing (4)
  • Cargo.toml (1 hunks)
  • Lib/test/test_unicodedata.py (0 hunks)
  • stdlib/Cargo.toml (1 hunks)
  • stdlib/src/unicodedata.rs (3 hunks)
💤 Files with no reviewable changes (1)
  • Lib/test/test_unicodedata.py
⏰ Context from checks skipped due to timeout of 90000ms (11)
  • GitHub Check: Check the WASM package and demo
  • GitHub Check: Run snippets and cpython tests on wasm-wasi
  • GitHub Check: Run tests under miri
  • GitHub Check: Run snippets and cpython tests (windows-latest)
  • GitHub Check: Run snippets and cpython tests (ubuntu-latest)
  • GitHub Check: Run snippets and cpython tests (macos-latest)
  • GitHub Check: Check Rust code with rustfmt and clippy
  • GitHub Check: Run rust tests (windows-latest)
  • GitHub Check: Run rust tests (macos-latest)
  • GitHub Check: Run rust tests (ubuntu-latest)
  • GitHub Check: Ensure compilation on various targets
🔇 Additional comments (5)
Cargo.toml (1)

211-211: Verify the dependency version and security status.

The addition of unicode-bidi-mirroring = "0.2" looks correct and is appropriately placed in the Unicode dependencies section. However, please verify that this is the latest stable version and check for any security advisories.

What is the latest version of the unicode-bidi-mirroring crate on crates.io and are there any known security vulnerabilities?
stdlib/Cargo.toml (1)

76-76: LGTM! Correct workspace dependency usage.

The dependency declaration correctly references the workspace dependency and is appropriately placed in the Unicode dependencies section.

stdlib/src/unicodedata.rs (3)

26-26: LGTM! Correct module attribute addition.

Adding "mirrored" to the module attributes list is necessary to expose the method to Python code.


76-76: LGTM! Correct import statement.

The import of is_mirroring function from the unicode_bidi_mirroring crate is properly placed and follows the existing import structure.


198-211: LGTM! Well-implemented mirrored method.

The implementation follows excellent practices:

  • Consistent method signature with other Unicode property methods
  • Proper use of extract_char for input validation and character extraction
  • Appropriate error handling that returns 0 for invalid inputs (consistent with Python's unicodedata behavior)
  • Clear logic flow: extract character → convert to char → check mirroring → return appropriate integer
  • Good inline documentation explaining the Unicode standard compliance

The method correctly implements the Unicode bidirectional mirroring property check as expected by Python's unicodedata.mirrored() function.

✨ 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 youknowone merged commit 4cdb8d1 into RustPython:main Jun 22, 2025
12 checks passed
@youknowone youknowone deleted the unicode-mirror branch June 22, 2025 12:32
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