Skip to content

fix: avoid error accessing superclass in ioutils#3056

Merged
johanneskoester merged 2 commits intomainfrom
fix/ioutils-super-class
Aug 29, 2024
Merged

fix: avoid error accessing superclass in ioutils#3056
johanneskoester merged 2 commits intomainfrom
fix/ioutils-super-class

Conversation

@johanneskoester
Copy link
Copy Markdown
Contributor

@johanneskoester johanneskoester commented Aug 29, 2024

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 the method resolution for wildcards, enhancing stability and preventing potential issues in complex inheritance scenarios.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Aug 29, 2024

Walkthrough

The changes involve modifying the needs_wildcards method in the QueryWildcardHandler class within the snakemake/ioutils.py file. The method now explicitly specifies the class when calling the superclass method, improving clarity and addressing potential issues related to multiple inheritance.

Changes

Files Change Summary
snakemake/ioutils.py Modified the needs_wildcards method in QueryWildcardHandler to explicitly specify the class in the super() call.

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 anywhere in the PR title to generate the title automatically.
  • 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.

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.

@github-actions
Copy link
Copy Markdown
Contributor

Please format your code with black: black snakemake tests/*.py.

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

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 86ed3cd and 7183327.

Files selected for processing (1)
  • snakemake/ioutils.py (1 hunks)
Additional context used
Path-based instructions (1)
snakemake/ioutils.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/ioutils.py (1)

90-90: LGTM!

The change to explicitly specify the class when calling the superclass method enhances clarity and prevents potential issues related to multiple inheritance scenarios.

The code changes are approved.

@sonarqubecloud
Copy link
Copy Markdown

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

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 7183327 and 9e5fd68.

Files selected for processing (1)
  • snakemake/ioutils.py (1 hunks)
Files skipped from review as they are similar to previous changes (1)
  • snakemake/ioutils.py

@johanneskoester johanneskoester merged commit a66a5f5 into main Aug 29, 2024
@johanneskoester johanneskoester deleted the fix/ioutils-super-class branch August 29, 2024 07:37
johanneskoester pushed a commit that referenced this pull request Aug 29, 2024
🤖 I have created a release *beep* *boop*
---


##
[8.19.0](v8.18.2...v8.19.0)
(2024-08-29)


### Features

* check consistency of output file mtimes (must be newer than input
files) ([#3050](#3050))
([666cf62](666cf62))
* print host name when executing workflow
([#3048](#3048))
([b0ff787](b0ff787))


### Bug Fixes

* `mem` and `disk` inference fixes
([#3040](#3040))
([7530794](7530794))
* avoid error accessing superclass in ioutils
([#3056](#3056))
([a66a5f5](a66a5f5))
* disable execute after print compilation
([#3041](#3041))
([86ed3cd](86ed3cd))
* download report assets upon package build such that reports become
possible offline (cont. of
[#2904](#2904))
([#3026](#3026))
([e8dad4b](e8dad4b))


### Documentation

* Add 'Editor integrations' section to Installation page
([#3045](#3045))
([9a4006d](9a4006d))
* Fix typo (seesee to see)
([#3037](#3037))
([de201fb](de201fb))
* various documentation fixes
([#3052](#3052))
([b11460c](b11460c))

---
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>
vandalt pushed a commit to vandalt/snakemake that referenced this pull request Aug 29, 2024
<!--Add a description of your PR here-->

### QC
<!-- Make sure that you can tick the boxes below. -->

* [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 the method resolution for wildcards, enhancing stability and
preventing potential issues in complex inheritance scenarios.

<!-- end of auto-generated comment: release notes by coderabbit.ai -->
vandalt pushed a commit to vandalt/snakemake that referenced this pull request Aug 29, 2024
🤖 I have created a release *beep* *boop*
---


##
[8.19.0](snakemake/snakemake@v8.18.2...v8.19.0)
(2024-08-29)


### Features

* check consistency of output file mtimes (must be newer than input
files) ([snakemake#3050](snakemake#3050))
([666cf62](snakemake@666cf62))
* print host name when executing workflow
([snakemake#3048](snakemake#3048))
([b0ff787](snakemake@b0ff787))


### Bug Fixes

* `mem` and `disk` inference fixes
([snakemake#3040](snakemake#3040))
([7530794](snakemake@7530794))
* avoid error accessing superclass in ioutils
([snakemake#3056](snakemake#3056))
([a66a5f5](snakemake@a66a5f5))
* disable execute after print compilation
([snakemake#3041](snakemake#3041))
([86ed3cd](snakemake@86ed3cd))
* download report assets upon package build such that reports become
possible offline (cont. of
[snakemake#2904](snakemake#2904))
([snakemake#3026](snakemake#3026))
([e8dad4b](snakemake@e8dad4b))


### Documentation

* Add 'Editor integrations' section to Installation page
([snakemake#3045](snakemake#3045))
([9a4006d](snakemake@9a4006d))
* Fix typo (seesee to see)
([snakemake#3037](snakemake#3037))
([de201fb](snakemake@de201fb))
* various documentation fixes
([snakemake#3052](snakemake#3052))
([b11460c](snakemake@b11460c))

---
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>
@jakevc jakevc mentioned this pull request Aug 30, 2024
2 tasks
johanneskoester pushed a commit that referenced this pull request Sep 4, 2024
<!--Add a description of your PR here-->

- Fixes pip deployment import path in spawn_jobs.py because
PIP_DEPLOYMENT_PATH was moved to snakemake/__init__.py in #3056

### QC
<!-- Make sure that you can tick the boxes below. -->

* [ ] 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).


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

## Summary by CodeRabbit

- **Chores**
- Simplified import statements for better clarity in the deployment path
reference.
- Improved readability of the code without altering existing
functionality.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant