Skip to content

chore: assert that jobcount is unrestricted if no max-jobs-per-timespan is set#3066

Merged
johanneskoester merged 2 commits intomainfrom
chore/assert_unrestricted_jobcount
Sep 4, 2024
Merged

chore: assert that jobcount is unrestricted if no max-jobs-per-timespan is set#3066
johanneskoester merged 2 commits intomainfrom
chore/assert_unrestricted_jobcount

Conversation

@johanneskoester
Copy link
Copy Markdown
Contributor

@johanneskoester johanneskoester commented Sep 4, 2024 •
edited by coderabbitai bot
Loading

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

  • New Features

    • Enhanced job scheduling logic for improved job submission management.
    • Added safeguards to ensure no restrictions on job submissions when certain conditions are met.

  • Bug Fixes

    • Addressed potential issues related to job count limitations during execution.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Sep 4, 2024 •
edited
Loading

Walkthrough

The changes in the Snakemake scheduler involve modifications to the initialization process and job selection logic. The assignment of self.max_jobs_per_second has been removed, indicating a change in job submission rate management. Additionally, the _free_resources method has been updated to exclude the _job_count resource from processing, and an assertion has been added in the job_selector method to ensure that the _job_count resource is set to sys.maxsize when the job_rate_limiter is absent.

Changes

Files Change Summary
snakemake/scheduler.py Removed assignment of self.max_jobs_per_second in the __init__ method; refined resource checking in _free_resources to exclude _job_count; added assertion in job_selector method to check _job_count when job_rate_limiter is not present.

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

@johanneskoester johanneskoester mentioned this pull request Sep 4, 2024
Merged
2 tasks
coderabbitai[bot]
coderabbitai bot reviewed Sep 4, 2024
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

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 3a8bd36 and c11597d.

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

477-478: LGTM!

The assertion correctly ensures that the _job_count resource is unrestricted when no job rate limiting is configured.

Line range hint 1-1: LGTM!

Excluding the _job_count resource from being updated in update_available_resources is the correct behavior since it's now managed by the JobRateLimiter before scheduling.

@sonarqubecloud
Copy link
Copy Markdown

sonarqubecloud bot commented Sep 4, 2024

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud

coderabbitai[bot]
coderabbitai bot reviewed Sep 4, 2024
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

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between c11597d and 53159a6.

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

@johanneskoester johanneskoester merged commit 947518b into main Sep 4, 2024
@johanneskoester johanneskoester deleted the chore/assert_unrestricted_jobcount branch September 4, 2024 09:44
This was referenced Sep 9, 2024
Merged
Merged
@coderabbitai coderabbitai bot mentioned this pull request Sep 19, 2024
Merged
2 tasks
This was referenced Oct 4, 2024
Merged
Closed
@coderabbitai coderabbitai bot mentioned this pull request Oct 14, 2024
Merged
2 tasks
@coderabbitai coderabbitai bot mentioned this pull request Nov 12, 2024
Closed
2 tasks
@coderabbitai coderabbitai bot mentioned this pull request Aug 18, 2025
Merged
2 tasks
@coderabbitai coderabbitai bot mentioned this pull request Sep 29, 2025
Draft
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

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@johanneskoester