Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: use relpath for configfiles added to the source archive (thanks to @sposadac for the initial solution) #3240

Merged
merged 4 commits into from
Dec 23, 2024

Conversation

johanneskoester
Copy link
Contributor

@johanneskoester johanneskoester commented Dec 23, 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

  • New Features

    • Enhanced logging messages for ignored source files to provide clearer user guidance regarding directory structure.
    • Added functionality to handle configuration file arguments, including support for relative paths based on shared file system usage.
  • Bug Fixes

    • Improved consistency in how configuration file paths are recorded, ensuring they are stored as relative paths.

Copy link
Contributor

coderabbitai bot commented Dec 23, 2024

Warning

Rate limit exceeded

@johanneskoester has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 7 minutes and 9 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between bd13eb1 and ca32992.

📒 Files selected for processing (2)
  • snakemake/spawn_jobs.py (3 hunks)
  • tests/tests.py (1 hunks)
📝 Walkthrough

Walkthrough

The pull request introduces modifications to three files in the Snakemake project: snakemake/dag.py, snakemake/workflow.py, and snakemake/spawn_jobs.py. In dag.py, the get_sources method has been updated to store relative paths for configuration files instead of absolute paths. In workflow.py, the write_source_archive method has been modified to provide a more detailed warning message about source file locations and to update the logging message format to use an f-string. Additionally, in spawn_jobs.py, method renaming and the introduction of a new method for handling configuration file arguments have been implemented.

Changes

File Change Summary
snakemake/dag.py Modified get_sources method to add relative paths for configuration files instead of absolute paths.
snakemake/workflow.py Updated write_source_archive method with:
- Enhanced warning message about source file locations
- Logging message reformatted to use f-string
snakemake/spawn_jobs.py Renamed get_resource_scopes_args to get_resource_scopes_arg and added get_configfiles_arg method.
Updated general_args method to use the new method names for argument construction.

Sequence Diagram

sequenceDiagram
    participant Workflow
    participant DAG
    Workflow->>DAG: get_sources()
    DAG-->>Workflow: Return relative configuration file paths
    Workflow->>Workflow: write_source_archive()
    Workflow-->>User: Display enhanced warning message
Loading

This sequence diagram illustrates the high-level interaction between the Workflow and DAG components, highlighting the changes in path handling and logging mechanisms.


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.

Copy link
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 (1)
snakemake/workflow.py (1)

298-303: Consider refining grammar and consolidating the f-string.

  1. The phrase "spawned jobs will not properly work" can be more standardly phrased as "spawned jobs will not work properly."
  2. (Optional) Use one unified f-string for clearer readability across multiple lines.

A possible edit for grammar:

 logger.warning(
-    f"Ignoring source file {f}! Only files relative "
-    "to the working directory are allowed. Most likely the "
-    "spawned jobs will not properly work. Make sure to start "
-    "the workflow from a directory below which all the sources "
-    "are located (may be in subfolders) and also ensure that any "
-    "config files you refer to are inside that directory."
     f"Ignoring source file {f}! Only files relative to the working "
     f"directory are allowed. Most likely the spawned jobs will not work "
     f"properly. Make sure to start the workflow from a directory below "
     f"which all the sources are located (may be in subfolders), and "
     f"also ensure that any config files you refer to are inside that directory."
 )
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between bac06ba and da6f5c8.

📒 Files selected for processing (2)
  • snakemake/dag.py (1 hunks)
  • snakemake/workflow.py (1 hunks)
✅ Files skipped from review due to trivial changes (1)
  • snakemake/dag.py
🧰 Additional context used
📓 Path-based instructions (1)
snakemake/workflow.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.

Copy link
Contributor

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

@johanneskoester johanneskoester changed the title fix: use relpath for configfiles added to the source archive fix: use relpath for configfiles added to the source archive (thanks to @sposadac for the initial solution) Dec 23, 2024
@johanneskoester johanneskoester merged commit bff3844 into main Dec 23, 2024
39 checks passed
@johanneskoester johanneskoester deleted the fix/config/relpath branch December 23, 2024 19:18
johanneskoester pushed a commit that referenced this pull request Dec 23, 2024
🤖 I have created a release *beep* *boop*
---


##
[8.26.0](v8.25.5...v8.26.0)
(2024-12-23)


### Features

* add helpers for deferred input/output etc. item access
([#2927](#2927))
([2cca9bc](2cca9bc))


### Bug Fixes

* convert parameters so they can be serialized
([#2925](#2925))
([9e653fb](9e653fb))
* correct formatting of R preamble
([#2425](#2425))
([5380cae](5380cae))
* fix modification checks for scripts and and notebooks containing
wildcards or params in their paths
([#2751](#2751))
([773568d](773568d))
* Improved handling of missing output files in group job postprocessing,
accounting for temporary files.
([#1765](#1765))
([bac06ba](bac06ba))
* mtime of script or notebook not triggering workflow without metadata
([#3148](#3148))
([e8a0b83](e8a0b83))
* Pass `host` attribute to `GitlabFile` instantiation within class
methods ([#3155](#3155))
([9ef52de](9ef52de))
* problem with spaces in path
([#3236](#3236))
([2d08c63](2d08c63))
* require current yte release which contains an important bug fix for
cases where numpy/pandas data is passed to templates
([#3227](#3227))
([c3339da](c3339da))
* rerun jobs if previously failed but rule was changed afterwards
(thanks to [@laf070810](https://github.com/laf070810) for bringing this
up) ([#3237](#3237))
([1dc0084](1dc0084))
* use relpath for configfiles added to the source archive (thanks to
[@sposadac](https://github.com/sposadac) for the initial solution)
([#3240](#3240))
([bff3844](bff3844))

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