fix: ensure that CLI help is formatted deterministically and set defaults are displayed properly (based on preliminary work by @keszybz) by johanneskoester · Pull Request #3081 · snakemake/snakemake

johanneskoester · 2024-09-09T14:43:51Z

QC

The PR contains a test case for the changes or the changes are already covered by an existing test case.
The documentation (docs/) is updated to reflect the changes or this is not necessary (e.g. if the change does neither modify the language nor the behavior or functionalities of Snakemake).

Summary by CodeRabbit

New Features
- Improved command-line help messages by including default values for arguments, enhancing usability.
Bug Fixes
- Streamlined the argument parser by removing a custom formatter and adopting a standardized implementation, ensuring consistent behavior.

…ults are displayed properly

coderabbitai · 2024-09-09T14:44:00Z

Walkthrough

The pull request involves the removal of a custom ArgumentDefaultsHelpFormatter class from snakemake/cli.py and the introduction of a new ArgumentDefaultsHelpFormatter class in snakemake/common/argparse.py. The new formatter enhances help message formatting for command-line arguments by including default values while excluding certain types. The argument parser in get_argument_parser now uses the new formatter, maintaining overall functionality but potentially altering how default values are displayed.

Changes

Files	Change Summary
`snakemake/cli.py`	Removed custom `ArgumentDefaultsHelpFormatter` class; modified `get_argument_parser` to use the new formatter from `snakemake.common.argparse`.
`snakemake/common/argparse.py`	Added new `ArgumentDefaultsHelpFormatter` class that formats help messages with default values.

Possibly related PRs

feat: fix job rate limiting with --max-jobs-per-second and introduce the more flexible --max-jobs-per-timespan #3010: Modifies the argument parser in snakemake/cli.py, directly related to the changes in the main PR.
fix: Allow hyphens in config keys given on the command line. #2998: Modifies the parse_config function in snakemake/cli.py, potentially affecting command-line argument handling.
chore: assert that jobcount is unrestricted if no max-jobs-per-timespan is set #3066: Adds an assertion in job scheduling logic in snakemake/scheduler.py, which may relate to command-line argument handling.
fix: fix issues with misinterpretation of max-jobs-per-timespan and max-jobs-per-seconds #3067: Addresses issues with job scheduling parameters, relevant to command-line interface changes in the main PR.

Tip

New features

Walkthrough comment now includes:

Possibly related PRs: A list of potentially related PRs to help you recall past context.
Suggested labels: CodeRabbit can now suggest labels by learning from your past PRs. You can also provide custom labeling instructions in the UI or configuration file.

Notes:

Please share any feedback in the discussion post on our Discord.
Possibly related PRs, automatic label suggestions based on past PRs, learnings, and possibly related issues require data opt-in (enabled by default).

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

coderabbitai

Actionable comments posted: 0

Outside diff range, codebase verification and nitpick comments (1)

snakemake/common/argparse.py (1)

61-87: Well-implemented class for custom help formatting.

The ArgumentDefaultsHelpFormatter class is well-implemented with clear documentation and purpose. The method _get_help_string effectively handles various default types and conditions to enhance the CLI help output.

Consider adding a brief comment within the _get_help_string method to explain the logic behind each major conditional block for future maintainability.

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 4fb71b3 and b6acb19.

Files selected for processing (2)

snakemake/cli.py (2 hunks)
snakemake/common/argparse.py (2 hunks)

Additional context used

Path-based instructions (2)

snakemake/common/argparse.py (1)

Pattern **/*.py: Do not try to improve formatting.
Do not suggest type annotations for functions that are defined inside of functions or methods.
Do not suggest type annotation of the self argument of methods.
Do not suggest type annotation of the cls argument of classmethods.
Do not suggest return type annotation if a function or method does not contain a return statement.

snakemake/cli.py (1)

Pattern **/*.py: Do not try to improve formatting.
Do not suggest type annotations for functions that are defined inside of functions or methods.
Do not suggest type annotation of the self argument of methods.
Do not suggest type annotation of the cls argument of classmethods.
Do not suggest return type annotation if a function or method does not contain a return statement.

Additional comments not posted (1)

snakemake/cli.py (1)
365-365: Correct update of formatter class reference.

The update to use snakemake.common.argparse.ArgumentDefaultsHelpFormatter in the get_argument_parser function is correct and aligns with the goal of using a shared formatter implementation. Ensure that this change is tested to confirm that the CLI help output behaves as expected with the new formatter.

Run the following script to verify the integration of the new formatter class:

Verification successful

Verified integration of the new formatter class.

The snakemake.common.argparse.ArgumentDefaultsHelpFormatter is correctly integrated into the get_argument_parser function in snakemake/cli.py. This change is localized and does not affect other parts of the codebase. Ensure that the CLI help output behaves as expected with this formatter.
Scripts executed

The following scripts were executed for the analysis:

Script:
#!/bin/bash
# Description: Verify the integration of the new formatter class.

# Test: Search for the usage of the new formatter class. Expect: Only occurrences of the new class.
rg --type python -A 5 $'snakemake.common.argparse.ArgumentDefaultsHelpFormatter'
Length of output: 110

Script:
#!/bin/bash
# Description: Verify the integration of the new formatter class.

# Test: Search for the usage of the new formatter class. Expect: Only occurrences of the new class.
rg --glob '*.py' -A 5 'snakemake.common.argparse.ArgumentDefaultsHelpFormatter'
Length of output: 426

sonarqubecloud · 2024-09-09T14:52:23Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud

coderabbitai

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between b6acb19 and 97e28b7.

Files selected for processing (1)

snakemake/common/argparse.py (2 hunks)

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

snakemake/common/argparse.py

@keszybz

🤖 I have created a release *beep* *boop* --- ## [8.20.2](v8.20.1...v8.20.2) (2024-09-09) ### Bug Fixes * ensure that CLI help is formatted deterministically and set defaults are displayed properly (based on preliminary work by [@keszybz](https://github.com/keszybz)) ([#3081](#3081)) ([cbc2e2c](cbc2e2c)) --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please). Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

fix: ensure that CLI help is formatted deterministically and set defa…

b6acb19

…ults are displayed properly

coderabbitai bot reviewed Sep 9, 2024

View reviewed changes

also work with other iterables

97e28b7

johanneskoester mentioned this pull request Sep 9, 2024

feat: make enum listings reproducible and improve formatting snakemake/snakemake-interface-common#49

Closed

coderabbitai bot reviewed Sep 9, 2024

View reviewed changes

johanneskoester changed the title ~~fix: ensure that CLI help is formatted deterministically and set defaults are displayed properly~~ fix: ensure that CLI help is formatted deterministically and set defaults are displayed properly (based on preliminary work by @keszybz) Sep 9, 2024

johanneskoester merged commit cbc2e2c into main Sep 9, 2024

johanneskoester deleted the fix/cli-fmt branch September 9, 2024 15:42

github-actions bot mentioned this pull request Sep 9, 2024

chore(main): release 8.20.2 #3082

Merged

coderabbitai bot mentioned this pull request Oct 16, 2024

docs: Fix missing spaces in CLI help text #3146

Merged

2 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: ensure that CLI help is formatted deterministically and set defaults are displayed properly (based on preliminary work by @keszybz)#3081

fix: ensure that CLI help is formatted deterministically and set defaults are displayed properly (based on preliminary work by @keszybz)#3081
johanneskoester merged 2 commits intomainfrom
fix/cli-fmt

johanneskoester commented Sep 9, 2024 •

edited by coderabbitai bot

Loading

Uh oh!

coderabbitai bot commented Sep 9, 2024 •

edited

Loading

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

coderabbitai bot left a comment

Uh oh!

sonarqubecloud bot commented Sep 9, 2024

Uh oh!

coderabbitai bot left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Conversation

johanneskoester commented Sep 9, 2024 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

QC

Summary by CodeRabbit

Uh oh!

coderabbitai bot commented Sep 9, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Possibly related PRs

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

sonarqubecloud bot commented Sep 9, 2024

Quality Gate passed

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

johanneskoester commented Sep 9, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Sep 9, 2024 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)