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 unrecognized Gaussian input format: *.com and *.gjf #376

Closed
wants to merge 5 commits into from

Conversation

FanwangM
Copy link
Contributor

@FanwangM FanwangM commented Dec 17, 2024

The current implementation does not support .com and *gjf because it used module name instead of "PATTERNS".

Summary by Sourcery

Bug Fixes:

  • Fix support for recognizing Gaussian input formats with extensions .com and .gjf by using patterns instead of module names.

Copy link
Contributor

sourcery-ai bot commented Dec 17, 2024

Reviewer's Guide by Sourcery

The PR fixes a bug in file format recognition for Gaussian input files by modifying how file extensions are mapped to their corresponding format modules. Instead of using the module name as the key, it now uses the file extensions defined in the module's PATTERNS attribute.

Class diagram for format module mapping update

classDiagram
    class FormatModule {
        +PATTERNS: List<String>
    }
    class FormatMapper {
        +_find_format_modules(): Map<String, FormatModule>
    }
    FormatMapper --> FormatModule: uses PATTERNS for mapping
    note for FormatMapper "Now uses file extensions from PATTERNS instead of module names for mapping."
Loading

File-Level Changes

Change Details Files
Modified the format module registration logic to use file extensions from PATTERNS
  • Replaced single module registration with iteration over PATTERNS
  • Changed dictionary key from module name to actual file extension
  • Added support for multiple file extensions per module
iodata/api.py

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time. You can also use
    this command to specify where the summary should be inserted.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link

deepsource-io bot commented Dec 17, 2024

Here's the code health analysis summary for commits f8af4e8..fbde455. View details on DeepSource ↗.

Analysis Summary

AnalyzerStatusSummaryLink
DeepSource Shell LogoShell✅ SuccessView Check ↗
DeepSource Python LogoPython❌ Failure
❗ 1 occurence introduced
View Check ↗

💡 If you’re a repository administrator, you can configure the quality gates from the settings.

Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @FanwangM - I've reviewed your changes - here's some feedback:

Overall Comments:

  • There's a typo in the code: 'replate' should be 'replace'
  • The implementation needs to handle potential conflicts when multiple format modules support the same file extension pattern
Here's what I looked at during the review
  • 🟡 General issues: 1 issue found
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

iodata/api.py Outdated Show resolved Hide resolved
Copy link
Member

@PaulWAyers PaulWAyers left a comment

Choose a reason for hiding this comment

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

Looks OK to me but I'd like an opinion from someone who does a lot more work with IOData.

@FanwangM
Copy link
Contributor Author

I figured out the right way to use the database, and this should not be seen as a bug. So I am closing it here.

@FanwangM FanwangM closed this Dec 19, 2024
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