Skip to content

chore: improved changes for param inheritance#3627

Merged
johanneskoester merged 1 commit intosnakemake:mainfrom
schrins:chore/params-inheritance-improved
Jun 16, 2025
Merged

chore: improved changes for param inheritance#3627
johanneskoester merged 1 commit intosnakemake:mainfrom
schrins:chore/params-inheritance-improved

Conversation

@schrins
Copy link
Copy Markdown
Contributor

@schrins schrins commented Jun 13, 2025 •
edited by coderabbitai Bot
Loading

Description

Follow-up change on merged PR #3624 , inspired by suggested PR #3496 (probs to @Hocnonsense ).

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

  • Bug Fixes
    • Improved handling of rule parameters to prevent errors when parameters are missing.

@schrins schrins requested a review from johanneskoester as a code owner June 13, 2025 13:29
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Jun 13, 2025 •
edited
Loading

📝 Walkthrough

Walkthrough

The logic for handling the "params" attribute in the ruleinfo modifier was refined to ensure unpacking only occurs when the attribute is present. The code now checks that self.params is not None before attempting to unpack, removing redundant fallback logic.

Changes

File(s) Change Summary
src/snakemake/ruleinfo.py Refined condition for unpacking "params" to check for existence before unpacking; removed redundant fallback logic.

Possibly related PRs

✨ 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
🪧 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[bot]
coderabbitai Bot reviewed Jun 13, 2025
View reviewed changes
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (2)
src/snakemake/ruleinfo.py (2)

79-81: Prefer direct attribute access over __dict__ for clarity.

self.params is already guaranteed to be non-None by the guard on line 75, so the extra indirection through self.__dict__ is unnecessary and slightly obscures intent. A small refactor improves readability without changing behaviour:

-original_positional, original_keyword = self.__dict__["params"]
+original_positional, original_keyword = self.params
🧰 Tools
🪛 Pylint (3.3.7)

[error] 79-79: Attempting to unpack a non-sequence defined at line 24

(E0633)

95-97: Potential silent override when original params is None.

If the original rule has no params, the else branch assigns value wholesale. That’s fine, but it silently discards any positional/keyword separation logic you implemented above. Consider documenting this behaviour or logging a debug message so users understand that inheritance becomes a full replacement in this edge case.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between d4890b4 and dc7d56d.

📒 Files selected for processing (1)
  • src/snakemake/ruleinfo.py (1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
`**/*.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 `s...

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

  • src/snakemake/ruleinfo.py
🪛 Pylint (3.3.7)
src/snakemake/ruleinfo.py

[error] 79-79: Attempting to unpack a non-sequence defined at line 24

(E0633)

⏰ Context from checks skipped due to timeout of 90000ms (36)
  • GitHub Check: tests (10, windows-latest, py312)
  • GitHub Check: tests (9, ubuntu-latest, py312)
  • GitHub Check: tests (10, ubuntu-latest, py312)
  • GitHub Check: tests (9, windows-latest, py312)
  • GitHub Check: tests (9, ubuntu-latest, py311)
  • GitHub Check: tests (10, ubuntu-latest, py311)
  • GitHub Check: tests (8, windows-latest, py312)
  • GitHub Check: tests (8, ubuntu-latest, py312)
  • GitHub Check: tests (8, ubuntu-latest, py311)
  • GitHub Check: tests (6, windows-latest, py312)
  • GitHub Check: tests (7, ubuntu-latest, py312)
  • GitHub Check: tests (7, macos-latest, py312)
  • GitHub Check: tests (5, windows-latest, py312)
  • GitHub Check: tests (6, macos-latest, py312)
  • GitHub Check: tests (7, windows-latest, py312)
  • GitHub Check: tests (4, windows-latest, py312)
  • GitHub Check: tests (7, ubuntu-latest, py311)
  • GitHub Check: tests (6, ubuntu-latest, py311)
  • GitHub Check: tests (5, macos-latest, py312)
  • GitHub Check: tests (6, ubuntu-latest, py312)
  • GitHub Check: tests (4, ubuntu-latest, py311)
  • GitHub Check: tests (5, ubuntu-latest, py311)
  • GitHub Check: tests (4, macos-latest, py312)
  • GitHub Check: tests (3, windows-latest, py312)
  • GitHub Check: tests (5, ubuntu-latest, py312)
  • GitHub Check: tests (4, ubuntu-latest, py312)
  • GitHub Check: tests (2, macos-latest, py312)
  • GitHub Check: tests (2, windows-latest, py312)
  • GitHub Check: tests (3, ubuntu-latest, py311)
  • GitHub Check: tests (1, windows-latest, py312)
  • GitHub Check: tests (1, ubuntu-latest, py311)
  • GitHub Check: tests (2, ubuntu-latest, py311)
  • GitHub Check: tests (3, ubuntu-latest, py312)
  • GitHub Check: tests (2, ubuntu-latest, py312)
  • GitHub Check: tests (1, ubuntu-latest, py312)
  • GitHub Check: apidocs
🔇 Additional comments (1)
src/snakemake/ruleinfo.py (1)

72-79: Guard condition fixes a potential TypeError – good catch!

Replacing the check on value with self.params is not None prevents unpacking None and eliminates the TypeError flagged by pylint.
No further issues observed in this block.

🧰 Tools
🪛 Pylint (3.3.7)

[error] 79-79: Attempting to unpack a non-sequence defined at line 24

(E0633)

[refactor] 72-98: Too many nested blocks (6/5)

(R1702)

@johanneskoester johanneskoester merged commit 3416b58 into snakemake:main Jun 16, 2025
49 checks passed
This was referenced Jun 16, 2025
Closed
Closed
kjohnsen pushed a commit to kjohnsen/snakemake that referenced this pull request Dec 15, 2025
@schrins @kjohnsen
chore: improved changes for param inheritance (snakemake#3627)
7fd73c2 
### Description

Follow-up change on merged PR snakemake#3624 , inspired by suggested PR snakemake#3496
(probs to @Hocnonsense ).

### QC

* [x] The PR contains a test case for the changes or the changes are
already covered by an existing test case.
* [x] 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).


<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->

## Summary by CodeRabbit

- **Bug Fixes**
- Improved handling of rule parameters to prevent errors when parameters
are missing.

<!-- end of auto-generated comment: release notes by coderabbit.ai -->
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments

@johanneskoester johanneskoester johanneskoester approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@schrins @johanneskoester