bugfix: chargemol runtime directory and `os.path.exists` fix #3778

chiang-yuan · 2024-04-21T21:38:46Z

Summary

Improve path logic
Allow Chargemol to run in different directory (previously the code has implemented but is not working)
Fix os.path.isfile bug. Change it into os.path.exists

Todos

add test

Checklist

Google format doc strings added. Check with ruff.
Type annotations included. Check with mypy.
Tests added for new features/fixes.

Summary by CodeRabbit

Refactor
- Improved file handling and error checking in the charge calculation module.
- Renamed instances for clarity and added new test methods for enhanced error handling.
- Modified assertions and introduced patches for improved structure handling.

coderabbitai · 2024-04-21T21:38:53Z

Walkthrough

The recent changes in chargemol_caller.py and related files refine Chargemol script execution, improve error handling for missing files, and enhance overall script robustness. These updates aim to streamline Chargemol analysis and strengthen code reliability.

Changes

File	Summary of Changes
`.../chargemol_caller.py` `.../test_chargemol_caller.py`

chargemol_caller.py: Added Pathlib import, updated path handling, refined temporary directory management, and enhanced error checks.
test_chargemol_caller.py: Renamed instances, added test_missing_exe_error, adjusted assertions, and introduced error handling patch. |

Recent Review Details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between e4ccad6 and 8be153a.

Files selected for processing (1)

pymatgen/command_line/chargemol_caller.py (11 hunks)

Files skipped from review as they are similar to previous changes (1)

pymatgen/command_line/chargemol_caller.py

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>.
- 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 generate interesting stats about this repository and render them as a table.
- @coderabbitai show all the console.log statements in this repository.
- @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.

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 as PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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

…pply)

janosh

thanks @chiang-yuan for the os.path.isfile fix! 👍

janosh · 2024-04-21T22:51:28Z

pymatgen/command_line/chargemol_caller.py

+
+            response = subprocess.run(CHARGEMOL_EXE, capture_output=True, check=False)
+            _stdout = response.stdout.decode("utf-8")
+            response.stderr.decode("utf-8")


do these two lines serve a purpose? i don't think these raise when response.returncode != 0? i think we need a test for the previously raised RuntimeError

maybe we can just use check=True? We don't even need to capture response/stdout here as it is not used?

yes, let's use check=True. it's a different error type CalledProcessError which I think is better than RuntimeError anyway but we should still add a test for this behavior.

chiang-yuan · 2024-05-04T07:29:48Z

Try to fix the missing command_line in the test file paths but pre-commit keeps failing due to the pyright issue.
I will leave it a bit until the problem is solved globally or just drop the usage of pyright #3777

…into fix-chargemol-path

chiang-yuan added 2 commits April 16, 2024 13:38

bugfix: allow custom chgcar path

fb3dce4

atomic_densities is a direcotry, not file

637501a

chiang-yuan requested review from shyuep, janosh and mkhorton as code owners April 21, 2024 21:38

janosh added 6 commits April 21, 2024 15:41

refactor TestChargemolAnalysis

ba0f1a9

prefer os.path over pathlib

7a29026

fix default atomic_densities_path (set to None, so if == "" doesn't a…

76324b3

…pply)

fix possibly unbound var in get_charge_transfer

1832070

refactor _from_data_dir

a05635e

test_missing_exe_error

01f0283

janosh requested changes Apr 21, 2024

View reviewed changes

janosh added fix Bug fix PRs analysis Concerning pymatgen.analysis charge Electric charge analysis, partitioning, integrations, etc. labels Apr 21, 2024

remove response

3f3a438

janosh added the needs testing PRs that are not ready to merge due to lacking tests label Apr 25, 2024

janosh added 2 commits April 25, 2024 11:54

Merge branch 'master' into pr/chiang-yuan/3778

e4ccad6

Merge branch 'master' into fix-chargemol-path

8be153a

chiang-yuan added 3 commits May 15, 2024 12:26

Merge branch 'master' of https://github.com/materialsproject/pymatgen …

2d9ffbc

…into fix-chargemol-path

add missing command_line

43b2385

try to use chargemol precompiled binary

6973b7a

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

bugfix: chargemol runtime directory and `os.path.exists` fix #3778

bugfix: chargemol runtime directory and `os.path.exists` fix #3778

chiang-yuan commented Apr 21, 2024 •

edited by coderabbitai bot

coderabbitai bot commented Apr 21, 2024 •

edited

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (`.coderabbit.yaml`)

Documentation and Community

janosh left a comment

janosh Apr 21, 2024

chiang-yuan Apr 23, 2024

janosh Apr 23, 2024

chiang-yuan commented May 4, 2024 •

edited

bugfix: chargemol runtime directory and os.path.exists fix #3778

Are you sure you want to change the base?

bugfix: chargemol runtime directory and os.path.exists fix #3778

Conversation

chiang-yuan commented Apr 21, 2024 • edited by coderabbitai bot

Summary

Todos

Checklist

Summary by CodeRabbit

coderabbitai bot commented Apr 21, 2024 • edited

Walkthrough

Changes

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (.coderabbit.yaml)

Documentation and Community

janosh left a comment

Choose a reason for hiding this comment

janosh Apr 21, 2024

Choose a reason for hiding this comment

chiang-yuan Apr 23, 2024

Choose a reason for hiding this comment

janosh Apr 23, 2024

Choose a reason for hiding this comment

chiang-yuan commented May 4, 2024 • edited

bugfix: chargemol runtime directory and `os.path.exists` fix #3778

bugfix: chargemol runtime directory and `os.path.exists` fix #3778

chiang-yuan commented Apr 21, 2024 •

edited by coderabbitai bot

coderabbitai bot commented Apr 21, 2024 •

edited

CodeRabbit Configration File (`.coderabbit.yaml`)

chiang-yuan commented May 4, 2024 •

edited