search

deepmodeling / dpdispatcher

generate HPC scheduler systems jobs input scripts and submit these scripts to HPC systems and poke until they finish
https://docs.deepmodeling.com/projects/dpdispatcher/
GNU Lesser General Public License v3.0
42 stars 56 forks source link

feat: `dpdisp run` #456

Closed njzjz closed 4 months ago

njzjz commented 4 months ago

Summary by CodeRabbit

coderabbitai[bot] commented 4 months ago
Walkthrough ## Walkthrough The update enhances the `dpdispatcher` package by enabling the execution of Python scripts with PEP 723 metadata. It includes correcting a spelling error in the README and adding a new term in the documentation. The core changes involve implementing features for script execution, handling script metadata, creating submission instances for script execution, and integrating these enhancements into the existing command-line interface. ## Changes | Files | Change Summary | |-------|----------------| | `README.md` | Corrected a spelling error in the reference section. | | `doc/index.rst` | Added a new term "run" to the documentation. | | `dpdispatcher/dpdisp.py`, `dpdispatcher/entrypoints/run.py`, `dpdispatcher/run.py` | Added functionality for running Python scripts with PEP 723 metadata. | | `examples/dpdisp_run.py`, `tests/hello_world.py` | Introduced configuration settings and basic operational tests. | | `pyproject.toml` | Updated dependencies to include `tomli` for Python versions below 3.11. | | `tests/context.py`, `tests/test_cli.py`, `tests/test_run.py` | Updated and added tests to support new `run` functionality. |
Recent Review Details **Configuration used: CodeRabbit UI** **Review profile: CHILL**
Commits Files that changed from the base of the PR and between 62c71189aad69886ee5cbc97d9f6308ea44bed12 and 1fa57e31ce8bc70af2ac4e8eeae9e53f9e4b909e.
Files selected for processing (2) * doc/run.md (1 hunks) * dpdispatcher/run.py (1 hunks)
Additional Context Used
LanguageTool (2)
doc/run.md (2)
Near line 2: Possible spelling mistake found. Context: # Run Python scripts DPDispatcher can be used to directly run a single Py... --- Near line 17: Possible spelling mistake found. Context: ...: ``` The PEP 723 metadata entries for `tool.dpdispatcher` are defined as follows: ```{eval-rst}...
GitHub Check Runs (1)
codecov/patch success (6)
dpdispatcher/run.py: [warning] 42-42: dpdispatcher/run.py#L42 Added line #L42 was not covered by tests --- dpdispatcher/run.py: [warning] 51-51: dpdispatcher/run.py#L51 Added line #L51 was not covered by tests --- dpdispatcher/run.py: [warning] 139-141: dpdispatcher/run.py#L139-L141 Added lines #L139 - L141 were not covered by tests --- dpdispatcher/run.py: [warning] 145-145: dpdispatcher/run.py#L145 Added line #L145 was not covered by tests --- dpdispatcher/run.py: [warning] 166-166: dpdispatcher/run.py#L166 Added line #L166 was not covered by tests
--- 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.` 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](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.
codecov[bot] commented 4 months ago

Codecov Report

Attention: Patch coverage is 88.15789% with 9 lines in your changes are missing coverage. Please review.

Project coverage is 47.77%. Comparing base (8ac13da) to head (1fa57e3).

Files Patch % Lines
dpdispatcher/run.py 89.39% 7 Missing :warning:
dpdispatcher/dpdisp.py 60.00% 2 Missing :warning:
Additional details and impacted files ```diff @@ Coverage Diff @@ ## master #456 +/- ## =========================================== - Coverage 59.96% 47.77% -12.19% =========================================== Files 36 38 +2 Lines 3662 3738 +76 =========================================== - Hits 2196 1786 -410 - Misses 1466 1952 +486 ```

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