fix: set CLI arg type to str if parse_func is provided

[johanneskoester]

Summary by CodeRabbit

• New Features

  • Enhanced command-line argument parsing to include dynamic type specification based on metadata attributes.

• Bug Fixes

  • Improved accuracy in parsing command-line arguments, ensuring they align with intended types.

These updates aim to provide a more flexible and user-friendly command-line interface.

[coderabbitai]

Walkthrough

The recent update introduces enhanced argument parsing in the register_cli_args method of the Plugin class. By adding a conditional check for a new metadata attribute, parse_func, the method now dynamically adjusts the argument type based on this metadata. This improvement allows for more flexible command-line interface configurations, facilitating correct argument parsing according to their intended types and enhancing user experience.

Changes

Files	Change Summary
snakemake_interface_common/plugin_registry/plugin.py	Enhanced register_cli_args method to conditionally set argument type to str based on parse_func metadata.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Plugin
    participant ArgParser

    User->>Plugin: Request to register CLI args
    Plugin->>ArgParser: Check metadata for parse_func
    alt parse_func exists
        Plugin->>ArgParser: Set argument type to str
    else parse_func not found
        Plugin->>ArgParser: Set default argument type
    end
    ArgParser-->>User: CLI args registered

Loading

---

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
• Mastodon
• Reddit
• LinkedIn

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

Review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE

Commits

Files that changed from the base of the PR and between 00bc4ca and 8ece9ea.

Files selected for processing (1)

• snakemake_interface_common/plugin_registry/plugin.py (1 hunks)

Additional context used

Path-based instructions (1)

snakemake_interface_common/plugin_registry/plugin.py (1)

Pattern **/*.py: Do not suggest to add trailing commas.
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.

Additional comments not posted (1)

snakemake_interface_common/plugin_registry/plugin.py (1)

168-170: Verify the impact of setting argument type to str when parse_func is present.

Ensure that this change aligns with the intended behavior of parse_func and doesn't inadvertently affect other argument types that might require different handling.

Verification successful

---

The change aligns with the intended behavior of parse_func.

The conditional check for parse_func and setting the argument type to str is consistent with its usage in the codebase. This ensures that values are correctly treated as strings before being processed by parse_func.

• The parse_func is used to transform values, and its presence in metadata is checked before application.
• There is a requirement for an unparse_func when parse_func is present, indicating a structured approach to parsing and unparsing.

Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify the usage of `parse_func` in the codebase to ensure it aligns with the new behavior.

# Test: Search for `parse_func` usage. Expect: Consistent usage with the new behavior.
rg --type python $'parse_func'

Length of output: 60

---

Script:

#!/bin/bash
# Description: Corrected command to verify the usage of `parse_func` in the codebase.

# Test: Search for `parse_func` usage in the codebase. Expect: Consistent usage with the new behavior.
rg 'parse_func'

Length of output: 901