Skip to content
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

fix: fix Mo when O is also contained #2320

Merged
merged 1 commit into from
Jan 5, 2025
Merged

fix: fix Mo when O is also contained #2320

merged 1 commit into from
Jan 5, 2025

Conversation

njzjz
Copy link
Member

@njzjz njzjz commented Jan 5, 2025

Fix #2318.

Summary by CodeRabbit

  • New Features

    • Added a new test method to validate regular expression functionality for specific atom names
  • Bug Fixes

    • Updated regular expression pattern to improve element wrapping conditions
    • Clarified docstring for convertSMILES method to provide better exception context
  • Tests

    • Modified atom name handling in test cases from list to NumPy array
    • Expanded test coverage for regular expression matching

Fix #2318.

Signed-off-by: Jinzhe Zeng <jinzhe.zeng@rutgers.edu>
Copy link
Contributor

coderabbitai bot commented Jan 5, 2025

📝 Walkthrough

Walkthrough

The pull request introduces modifications to the regular expression handling in the _CollectPaths class within reacnetgenerator/_path.py. The primary change is a subtle adjustment to the regex pattern to improve element wrapping conditions. In the test file tests/test_reacnetgen.py, a new test method is added to validate regex functionality, and the atomname attribute is converted from a list to a NumPy array.

Changes

File Change Summary
reacnetgenerator/_path.py - Modified regex pattern in _re method to handle element wrapping
- Updated docstring for convertSMILES method
tests/test_reacnetgen.py - Converted atomname to NumPy array
- Added test_re_mo method to test regex with Mo atom

Assessment against linked issues

Objective Addressed Explanation
Correct Mo atom recognition [#2318]

The changes appear to directly address the issue of incorrectly recognizing the Mo atom in SMILES representation by modifying the regular expression pattern to handle element wrapping more comprehensively.

Sequence Diagram

sequenceDiagram
    participant Path Generator
    participant Regex Handler
    participant SMILES Converter
    
    Path Generator->>Regex Handler: Apply modified regex pattern
    Regex Handler-->>Path Generator: Process element wrapping
    Path Generator->>SMILES Converter: Convert with improved regex
Loading

The sequence diagram illustrates the enhanced regex handling process for element recognition, particularly focusing on the Mo atom case mentioned in the issue.


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ 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.
    • Generate unit testing code for this file.
    • 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 generate unit testing code for this file.
    • @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 generate unit testing code.
    • @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.

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. (Beta)
  • @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.

Copy link

codecov bot commented Jan 5, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 96.19%. Comparing base (2173d87) to head (7e41c8e).
Report is 1 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #2320   +/-   ##
=======================================
  Coverage   96.19%   96.19%           
=======================================
  Files          17       17           
  Lines        1418     1418           
=======================================
  Hits         1364     1364           
  Misses         54       54           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (1)
tests/test_reacnetgen.py (1)

162-167: Add more coverage for bracketed metals.

While this test effectively confirms that [Mo] is recognized, consider also testing other patterns like "[Mo]O", "[Mo][O]", or embedded forms to ensure the new regex logic is robust for edge cases.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 2173d87 and 7e41c8e.

📒 Files selected for processing (2)
  • reacnetgenerator/_path.py (1 hunks)
  • tests/test_reacnetgen.py (1 hunks)
🔇 Additional comments (2)
tests/test_reacnetgen.py (1)

155-161: Confirm that transitioning atomname to a NumPy array won’t break downstream logic.

This change to use a NumPy array is acceptable and works fine for the subsequent _re calls in this test. However, ensure that other parts of the code relying on atomname do not expect a plain list (e.g., slicing or appending).

reacnetgenerator/_path.py (1)

250-250: Validate broadened regex boundaries.

The updated lookahead (?!H|\]) addresses the issue of elements immediately followed by a closing bracket, but consider verifying collisions between multi-letter elements (e.g., “Mo” vs. “O”). Additional tests may detect unintended bracket expansions.

Copy link

codspeed-hq bot commented Jan 5, 2025

CodSpeed Performance Report

Merging #2320 will not alter performance

Comparing fix-mo (7e41c8e) with master (2173d87)

Summary

✅ 8 untouched benchmarks

@njzjz njzjz added this pull request to the merge queue Jan 5, 2025
Merged via the queue into master with commit dfcf8a8 Jan 5, 2025
25 checks passed
@njzjz njzjz deleted the fix-mo branch January 5, 2025 04:16
@njzjz njzjz mentioned this pull request Jan 5, 2025
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.

Wrong Species Recoginize
1 participant