Skip to content

perf: compare checksums of input files <= 1MB (before (10KB)#3267

Merged
johanneskoester merged 3 commits intomainfrom
perf/source-caching
Jan 23, 2025
Merged

perf: compare checksums of input files <= 1MB (before (10KB)#3267
johanneskoester merged 3 commits intomainfrom
perf/source-caching

Conversation

@johanneskoester
Copy link
Copy Markdown
Contributor

@johanneskoester johanneskoester commented Jan 23, 2025

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

  • Type Annotations

    • Enhanced type annotations for the mtime method in the HostingProviderFile class.
    • Added Optional[float] return type to improve type safety.
  • Workflow Improvements

    • Updated source cache path generation to use a shared directory.
    • Improved documentation for source cache behavior.
  • Import Modifications

    • Added import statement for the Batch class in snakemake/cli.py.
    • Updated import source for the Batch class in test files.

…rce cache into .snakemake directory in the workdir instead of the user specific app cache (improves multi-user capability of workflows)
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Jan 23, 2025

📝 Walkthrough

Walkthrough

The pull request introduces type annotations and modifies the source cache path determination in Snakemake. In snakemake/sourcecache.py, a type annotation is added to the mtime method of the HostingProviderFile class, explicitly defining its return type as Optional[float]. In snakemake/workflow.py, the source_cache_path property of the Workflow class is updated to return a shared cache directory instead of a user-specific cache directory. Additionally, the Batch class import is adjusted in several files to streamline dependencies.

Changes

File Change Summary
snakemake/sourcecache.py Added Optional import and type annotation for mtime() method, returning Optional[float].
snakemake/workflow.py Modified source_cache_path property to return a shared cache path instead of a user-specific directory.
snakemake/cli.py Added import statement for Batch class from snakemake.dag.
snakemake/dag.py Removed import statement for Batch class from snakemake.settings.types.
tests/test_args.py Updated import for Batch class from snakemake.dag to snakemake.settings.types.
tests/tests.py Added import for Batch class from snakemake.settings.types for multiple test functions.

Possibly related PRs


📜 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 faf5c1b and e794c3c.

📒 Files selected for processing (5)
  • snakemake/cli.py (1 hunks)
  • snakemake/dag.py (1 hunks)
  • snakemake/workflow.py (1 hunks)
  • tests/test_args.py (1 hunks)
  • tests/tests.py (1 hunks)
✅ Files skipped from review due to trivial changes (1)
  • snakemake/dag.py
🚧 Files skipped from review as they are similar to previous changes (1)
  • snakemake/workflow.py
🧰 Additional context used
📓 Path-based instructions (3)
tests/test_args.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.

snakemake/cli.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.

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

⏰ Context from checks skipped due to timeout of 90000ms (31)
  • GitHub Check: testing (10, 3.12)
  • GitHub Check: testing (10, 3.11)
  • GitHub Check: testing (9, 3.12)
  • GitHub Check: testing (9, 3.11)
  • GitHub Check: testing (8, 3.12)
  • GitHub Check: testing (8, 3.11)
  • GitHub Check: testing (7, 3.12)
  • GitHub Check: testing (7, 3.11)
  • GitHub Check: testing (6, 3.12)
  • GitHub Check: testing (6, 3.11)
  • GitHub Check: testing (5, 3.12)
  • GitHub Check: testing-windows (10)
  • GitHub Check: testing (5, 3.11)
  • GitHub Check: testing-windows (9)
  • GitHub Check: testing (4, 3.12)
  • GitHub Check: testing-windows (8)
  • GitHub Check: testing (4, 3.11)
  • GitHub Check: testing-windows (7)
  • GitHub Check: testing (3, 3.12)
  • GitHub Check: testing-windows (6)
  • GitHub Check: testing (3, 3.11)
  • GitHub Check: testing-windows (5)
  • GitHub Check: testing (2, 3.12)
  • GitHub Check: testing-windows (4)
  • GitHub Check: testing (2, 3.11)
  • GitHub Check: testing-windows (3)
  • GitHub Check: testing (1, 3.12)
  • GitHub Check: testing-windows (2)
  • GitHub Check: testing (1, 3.11)
  • GitHub Check: testing-windows (1)
  • GitHub Check: apidocs
🔇 Additional comments (3)
tests/test_args.py (1)

7-7: LGTM! Import statement updated correctly.

The import statement has been updated to reflect the new location of the Batch class in snakemake.settings.types.

tests/tests.py (1)

20-20: LGTM! Import statement added correctly.

The Batch class is imported from snakemake.settings.types and is used by multiple test functions (test_batch, test_batch_final, and test_batch_fail).

snakemake/cli.py (1)

47-47: LGTM! Import statement added correctly.

The Batch class is imported from snakemake.settings.types and is used by the parse_batch function.

✨ Finishing Touches
  • 📝 Generate Docstrings (Beta)

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>, please review it.
    • 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 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 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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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.

@sonarqubecloud
Copy link
Copy Markdown

@johanneskoester johanneskoester changed the title perf: compare checksums of input files < 1MB (before (10KB); move source cache into .snakemake directory in the workdir instead of the user specific app cache (improves multi-user capability of workflows) perf: compare checksums of input files <= 1MB (before (10KB) Jan 23, 2025
@johanneskoester johanneskoester merged commit ba017bb into main Jan 23, 2025
@johanneskoester johanneskoester deleted the perf/source-caching branch January 23, 2025 12:38
johanneskoester pushed a commit that referenced this pull request Feb 12, 2025
🤖 I have created a release *beep* *boop*
---


##
[8.28.0](v8.27.1...v8.28.0)
(2025-02-12)


### Features

* do not fail if --cache is active but no SNAKEMAKE_OUTPUT_CACHE env var
is defined. Instead, print a warning that explains the options.
([#3270](#3270))
([9610f7c](9610f7c))


### Bug Fixes

* do not use outdated metadata for rerun triggers (only warn about it)
([#3259](#3259))
([d766a48](d766a48))
* ensure that exceptions print storage queries instead of local copies
of remote files
([#3258](#3258))
([e5d8ec1](e5d8ec1))
* fix error message of evaluate helper function
([#3282](#3282))
([9483a64](9483a64))
* Revert cleaning of env vars in apptainer
([#3285](#3285))
([e79a51b](e79a51b))


### Performance Improvements

* compare checksums of input files &lt;= 1MB (before (10KB)
([#3267](#3267))
([ba017bb](ba017bb))
* query updated input files in parallel
([#3266](#3266))
([bc4fcee](bc4fcee))


### Documentation

* Adds instructions for using syntax highlighting with lazy.nvim
([#3246](#3246))
([7a75043](7a75043))
* Fix typos in basic API example
([#3277](#3277))
([8782219](8782219))

---
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>
kjohnsen pushed a commit to kjohnsen/snakemake that referenced this pull request Dec 15, 2025
…ke#3267)

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

- **Type Annotations**
- Enhanced type annotations for the `mtime` method in the
`HostingProviderFile` class.
	- Added `Optional[float]` return type to improve type safety.

- **Workflow Improvements**
	- Updated source cache path generation to use a shared directory.
	- Improved documentation for source cache behavior.

- **Import Modifications**
	- Added import statement for the `Batch` class in `snakemake/cli.py`.
	- Updated import source for the `Batch` class in test files.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
kjohnsen pushed a commit to kjohnsen/snakemake that referenced this pull request Dec 15, 2025
🤖 I have created a release *beep* *boop*
---


##
[8.28.0](snakemake/snakemake@v8.27.1...v8.28.0)
(2025-02-12)


### Features

* do not fail if --cache is active but no SNAKEMAKE_OUTPUT_CACHE env var
is defined. Instead, print a warning that explains the options.
([snakemake#3270](snakemake#3270))
([9610f7c](snakemake@9610f7c))


### Bug Fixes

* do not use outdated metadata for rerun triggers (only warn about it)
([snakemake#3259](snakemake#3259))
([d766a48](snakemake@d766a48))
* ensure that exceptions print storage queries instead of local copies
of remote files
([snakemake#3258](snakemake#3258))
([e5d8ec1](snakemake@e5d8ec1))
* fix error message of evaluate helper function
([snakemake#3282](snakemake#3282))
([9483a64](snakemake@9483a64))
* Revert cleaning of env vars in apptainer
([snakemake#3285](snakemake#3285))
([e79a51b](snakemake@e79a51b))


### Performance Improvements

* compare checksums of input files &lt;= 1MB (before (10KB)
([snakemake#3267](snakemake#3267))
([ba017bb](snakemake@ba017bb))
* query updated input files in parallel
([snakemake#3266](snakemake#3266))
([bc4fcee](snakemake@bc4fcee))


### Documentation

* Adds instructions for using syntax highlighting with lazy.nvim
([snakemake#3246](snakemake#3246))
([7a75043](snakemake@7a75043))
* Fix typos in basic API example
([snakemake#3277](snakemake#3277))
([8782219](snakemake@8782219))

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