feat: add functionality to infer plugin type from registry class name and use that to provide better CLI help texts

[johanneskoester]

Summary by CodeRabbit

• New Features

  • Improved command-line interface by displaying plugin type in argument group labels for plugin settings.

• Refactor

  • Enhanced internal handling of plugin type detection and argument registration for a more consistent user experience.

[coderabbitai]

📝 Walkthrough

Walkthrough

The changes update the plugin registry and plugin base classes to support passing a plugin type string when registering CLI arguments. The registry now infers the plugin type from its class name and provides it to each plugin during CLI argument registration, allowing plugins to use this information when labeling argument groups.

Changes

File(s)	Change Summary
src/snakemake_interface_common/plugin_registry/init.py	Added get_plugin_type method to infer plugin type from registry class name; updated register_cli_args to pass plugin type to plugins.
src/snakemake_interface_common/plugin_registry/plugin.py	Updated register_cli_args in PluginBase to accept and use a plugin_type parameter for argument group labeling.

Estimated code review effort

2 (10–30 minutes)

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between dc9f2fd and ad90ae5.

📒 Files selected for processing (2)

• src/snakemake_interface_common/plugin_registry/__init__.py (2 hunks)
• src/snakemake_interface_common/plugin_registry/plugin.py (2 hunks)

🧰 Additional context used

📓 Path-based instructions (1)

**/*.py

Instructions used from:

Sources:
⚙️ CodeRabbit Configuration File

🧬 Code Graph Analysis (2)

src/snakemake_interface_common/plugin_registry/plugin.py (1)

src/snakemake_interface_common/plugin_registry/__init__.py (1)

• register_cli_args (65-70)

src/snakemake_interface_common/plugin_registry/__init__.py (1)

src/snakemake_interface_common/plugin_registry/plugin.py (1)

• register_cli_args (133-192)

🔇 Additional comments (5)

src/snakemake_interface_common/plugin_registry/plugin.py (2)

133-133: LGTM: Method signature updated correctly.

The addition of the plugin_type: str parameter properly extends the method signature to support the new functionality. The parameter is appropriately typed and positioned.

---

154-156: LGTM: Improved CLI argument group labeling.

The dynamic argument group label f"{self.name} {plugin_type} plugin settings" provides more descriptive CLI help text by incorporating the plugin type. This enhances user experience by making it clearer what type of plugin the settings belong to.

src/snakemake_interface_common/plugin_registry/__init__.py (3)

7-7: LGTM: Import added for regex functionality.

The re module import is necessary for the new get_plugin_type method's regex pattern matching functionality.

---

68-70: LGTM: Plugin type properly extracted and passed to plugins.

The modification correctly calls get_plugin_type() once and passes the result to each plugin's register_cli_args method. This ensures consistency and avoids redundant regex operations.

---

72-80: LGTM: Robust plugin type inference with proper error handling.

The get_plugin_type method correctly:

• Uses a clear regex pattern (?P<type>.+)PluginRegistry to extract the plugin type
• Converts the result to lowercase for consistency
• Provides descriptive error handling when the class name doesn't follow the expected pattern
• Includes helpful examples in the error message

The regex pattern will correctly match class names like ExecutorPluginRegistry → executor, StoragePluginRegistry → storage, etc.

✨ Finishing Touches

• 📝 Generate Docstrings

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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>, please review it.
  • Explain this complex logic.
  • 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 explain this code block.
  • @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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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.