fix: add missing types for interface methods

[johanneskoester]

Summary by CodeRabbit

• Refactor
  • Improved code clarity by adding explicit return type annotations to several properties in job executor interfaces. No changes to functionality or user experience.

[coderabbitai]

📝 Walkthrough

Walkthrough

This change adds explicit return type annotations to several abstract property methods within the SingleJobExecutorInterface and GroupJobExecutorInterface classes in snakemake_interface_executor_plugins/jobs.py. The update clarifies the expected return types for these properties without altering any underlying logic or method bodies.

Changes

File	Change Summary
snakemake_interface_executor_plugins/jobs.py	Added explicit return type annotations to multiple abstract property methods in two executor interface classes.

Sequence Diagram(s)

No sequence diagram generated as the changes are limited to type annotations and do not affect control flow or feature logic.

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

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

snakemake_interface_executor_plugins/jobs.py (1)

118-118: Complex nested type is explicit and correct.

Sequence[Sequence[SingleJobExecutorInterface]] precisely reflects a topologically-sorted grouping. Consider introducing a type alias if this appears in multiple places for readability, but not blocking.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 1b64873 and aaabbfd.

📒 Files selected for processing (1)

• snakemake_interface_executor_plugins/jobs.py (1 hunks)

🧰 Additional context used

📓 Path-based instructions (1)

`**/*.py`: Do not try to improve formatting. Do not suggest type annotations for...

**/*.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.

⚙️ Source: CodeRabbit Configuration File

List of files the instruction was applied to:

• snakemake_interface_executor_plugins/jobs.py

🔇 Additional comments (3)

snakemake_interface_executor_plugins/jobs.py (3)

104-104: Annotation looks correct.

Adding Optional[str] accurately captures that message may be unset. No further concerns.

---

110-110: Good use of precise iterable typing.

Iterable[SingleJobExecutorInterface] conveys the expected element type without constraining the concrete container. 👍

---

114-114: Return type clarified.

groupid being explicitly typed as str removes ambiguity; ensure all call-sites already treat it as such (e.g. no int comparisons).