deepmodeling / dpdata

A Python package for manipulating atomistic data of software in computational science
https://docs.deepmodeling.com/projects/dpdata/
GNU Lesser General Public License v3.0
195 stars 129 forks source link

fix: use deepcopy when dumping mixed types #671

Closed iProzd closed 3 months ago

iProzd commented 3 months ago

Use deepcopy when dumping mixed types in system level. Fix #670 .

Typically, users use the following command to dump list of systems to mixed_type:

dpdata.MultiSystems(*systems).to_deepmd_npy_mixed("mixed_dir")

This command will rebuild a new system with a new data dict, thus it does not change the original system.data.

In #670 , when users use

system.to('deepmd/npy/mixed', 'dir') 

on a system in standard format, it would directly convert the original system.data into mixed types, thus the original system.data would be changed.

Use deepcopy to prevent this.

Summary by CodeRabbit

codspeed-hq[bot] commented 3 months ago

CodSpeed Performance Report

Merging #671 will not alter performance

Comparing iProzd:fix_mix_convert (29bcf6a) with devel (4bb4069)

Summary

✅ 2 untouched benchmarks

codecov[bot] commented 3 months ago

Codecov Report

Attention: Patch coverage is 50.00000% with 1 line in your changes missing coverage. Please review.

Project coverage is 84.30%. Comparing base (4bb4069) to head (c58a87f).

:exclamation: Current head c58a87f differs from pull request most recent head 29bcf6a

Please upload reports for the commit 29bcf6a to get more accurate results.

Files Patch % Lines
dpdata/deepmd/mixed.py 50.00% 1 Missing :warning:
Additional details and impacted files ```diff @@ Coverage Diff @@ ## devel #671 +/- ## ========================================== - Coverage 84.31% 84.30% -0.01% ========================================== Files 81 81 Lines 7142 7144 +2 ========================================== + Hits 6022 6023 +1 - Misses 1120 1121 +1 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

coderabbitai[bot] commented 3 months ago
Walkthrough ## Walkthrough The changes introduce a deep copy operation in the `dump` function of `dpdata/deepmd/mixed.py` to prevent data modification during processing. Additionally, new unit tests in `tests/test_deepmd_mixed.py` ensure the correct functionality of dumping single systems in mixed type format, addressing a bug where systems could not be appended to multi-systems after being dumped. ## Changes | File | Change Summary | |---------------------------------|-----------------------------------------------------------------------------------------------------| | dpdata/deepmd/mixed.py | Added `import copy` and `data = copy.deepcopy(data)` within the `dump` function to preserve data. | | tests/test_deepmd_mixed.py | Added `TestMixedSingleSystemsDump` class with `setUp` and `tearDown` methods, and a test for dumping.| ## Assessment against linked issues | Objective (Issue #670) | Addressed | Explanation | |----------------------------------------------------------------------------------------|-----------|--------------------------------------------------------------------------------------------------| | Ensure systems can be appended to multi-systems after being dumped in mixed type format| ✅ | | | Validate the functionality with unit tests | ✅ | |

Recent review details **Configuration used: CodeRabbit UI** **Review profile: CHILL**
Commits Files that changed from the base of the PR and between c58a87f8c93af4a83aaa6059e689568272b7126d and 29bcf6a46e9fa968f005d1ce33997fa671a0db78.
Files selected for processing (1) * tests/test_deepmd_mixed.py (1 hunks)
Additional comments not posted (3)
tests/test_deepmd_mixed.py (3)
`334-336`: Proper cleanup in `tearDown` method. --- `317-337`: The structure of `TestMixedSingleSystemsDump` is well-organized for testing single system dumps. --- `318-333`: Ensure the test dump operation in `setUp` is intended for setup only and not an actual test.
Verification successful --- The test dump operation in `setUp` is only referenced within the `setUp` and `tearDown` methods, confirming it is intended for setup purposes only and not an actual test. - `tests/test_deepmd_mixed.py`: - Line 318: `self.system_1.to("deepmd/npy/mixed", "tmp.deepmd.mixed.single")` - Line 333: `if os.path.exists("tmp.deepmd.mixed.single"):` - Line 334: `shutil.rmtree("tmp.deepmd.mixed.single")`
Scripts executed The following scripts were executed for the analysis: --- Script: ```shell #!/bin/bash # Description: Verify if the test dump operation in `setUp` is used elsewhere or if it should be part of a test method. # Test: Search for references to `tmp.deepmd.mixed.single`. Expect: No references outside of `setUp` and `tearDown`. rg --type python $'tmp.deepmd.mixed.single' ``` Length of output: 73 --- --- Script: ```shell #!/bin/bash # Description: Verify if the test dump operation in `setUp` is used elsewhere or if it should be part of a test method. # Test: Search for references to `tmp.deepmd.mixed.single`. Expect: No references outside of `setUp` and `tearDown`. rg 'tmp.deepmd.mixed.single' --glob '*.py' ``` Length of output: 302
--- 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 - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `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.` - `@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 as 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. 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.