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

style: enable B905 to prevent issues with zip #1580

Draft
wants to merge 2 commits into
base: devel
Choose a base branch
from

Conversation

njzjz
Copy link
Member

@njzjz njzjz commented Jul 8, 2024

This PR explicitly requires the input of zip to have the same length. If not, there should be something wrong.

Summary by CodeRabbit

  • Chores
    • Updated linting rules to improve code quality and maintainability.
    • Enhanced dependency management with new optional dependency groups for testing and GUI functionalities.

This PR explicitly requires the input of zip to have the same length. If not, there should be something wrong.

Signed-off-by: Jinzhe Zeng <[email protected]>
Copy link
Contributor

coderabbitai bot commented Jul 8, 2024

📝 Walkthrough
📝 Walkthrough

Walkthrough

The change involves modifications to the pyproject.toml file, focusing on dependencies, project metadata, and configuration settings. Updates include the introduction of optional dependency groups for testing and GUI functionalities, the addition of a new linting rule ("B905") regarding zip usage, and a ban on module-level imports of the pymatgen module. These changes enhance the project's dependency management and linting configurations.

Changes

File Change Summary
pyproject.toml Updated dependencies with version constraints, added optional dependency groups (test, gui), introduced linting rule "B905", and banned module-level import of pymatgen.

Possibly related PRs


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

@njzjz njzjz marked this pull request as draft July 8, 2024 21:56
@njzjz
Copy link
Member Author

njzjz commented Jul 8, 2024

I just realize strict in new in Python 3.10.

I make the PR a draft until we upgrade the minimal Python version to Python 3.10.

Copy link

codecov bot commented Jul 8, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 49.53%. Comparing base (4a3775d) to head (b515a94).

Additional details and impacted files
@@           Coverage Diff           @@
##            devel    #1580   +/-   ##
=======================================
  Coverage   49.53%   49.53%           
=======================================
  Files          83       83           
  Lines       14849    14849           
=======================================
  Hits         7356     7356           
  Misses       7493     7493           

☔ 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

🧹 Outside diff range and nitpick comments (2)
pyproject.toml (2)

Line range hint 19-20: LGTM! Consider optimizing optional dependencies.

The addition of optional dependency groups and the version-specific GromacsWrapper dependency are good improvements to the project structure. They allow for more flexible installation options and better version compatibility.

Consider removing 'dpgui' from the 'test' group since it's already in the 'gui' group. If 'dpgui' is required for testing, you might want to include the 'gui' group in the 'test' group instead:

[project.optional-dependencies]
gui = [
    "dpgui",
]
test = [
    "coverage",
    "pymatgen-analysis-defects<2023.08.22",
    "gui",
]

This change would reduce redundancy and make the dependencies more maintainable.

Also applies to: 46-55


Line range hint 28-28: Update Python version requirement

The PR objective mentions that the 'strict' option for zip() is new in Python 3.10. However, the requires-python field still allows for Python 3.9+.

Consider updating the Python version requirement to 3.10+ to align with the use of the 'strict' option:

-requires-python = ">=3.9"
+requires-python = ">=3.10"

Also, you may want to update the classifiers to remove Python 3.9 support:

 classifiers = [
-    "Programming Language :: Python :: 3.9",
     "Programming Language :: Python :: 3.10",
     "Programming Language :: Python :: 3.11",
     "License :: OSI Approved :: GNU Lesser General Public License v3 (LGPLv3)",
 ]

These changes will ensure that the project's stated Python version requirements are consistent with the features being used.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between debc069 and b515a94.

📒 Files selected for processing (1)
  • pyproject.toml (1 hunks)
🔇 Additional comments (1)
pyproject.toml (1)

89-90: LGTM! Verify impact of banning pymatgen imports.

The addition of the B905 rule aligns well with the PR objective of preventing issues with zip() usage. The per-file ignore for tests is also a good practice.

Regarding the ban on module-level imports of 'pymatgen', please verify that this change doesn't break existing functionality. Run the following script to check for any remaining module-level imports of pymatgen:

If this script returns any results, those files may need to be updated to comply with the new import restrictions.

Also applies to: 92-94, 101-103

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