Skip to content

fix: expandvars for special profile keys#3597

Merged
cademirch merged 2 commits intosnakemake:mainfrom
cademirch:fix-expand-profile-envars
May 30, 2025
Merged

fix: expandvars for special profile keys#3597
cademirch merged 2 commits intosnakemake:mainfrom
cademirch:fix-expand-profile-envars

Conversation

@cademirch
Copy link
Copy Markdown
Contributor

@cademirch cademirch commented May 21, 2025

Fixes #3592

Need to still add tests.

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
    • Environment variables within profile configuration values are now automatically expanded, ensuring correct values are used in configurations.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 21, 2025

📝 Walkthrough

Walkthrough

The change updates the profile configuration parser to ensure that all values in one-level and two-level dictionaries are processed with environment variable expansion using os.path.expandvars(). This guarantees that any environment variable references in configuration values are expanded before being used, without altering the public API or control flow.

Changes

File(s) Change Summary
src/snakemake/profiles.py Modified formatting functions for profile config parsing to expand environment variables in values before use.

Assessment against linked issues

Objective Addressed Explanation
Ensure all profile config values (including nested dict values like default-resources: {tmpdir: ...}) support environment variable expansion (#3592)

Note

⚡️ AI Code Reviews for VS Code, Cursor, Windsurf

CodeRabbit now has a plugin for VS Code, Cursor and Windsurf. This brings AI code reviews directly in the code editor. Each commit is reviewed immediately, finding bugs before the PR is raised. Seamless context handoff to your AI code agent ensures that you can easily incorporate review feedback.
Learn more here.


Note

⚡️ Faster reviews with caching

CodeRabbit now supports caching for code and dependencies, helping speed up reviews. This means quicker feedback, reduced wait times, and a smoother review experience overall. Cached data is encrypted and stored securely. This feature will be automatically enabled for all accounts on May 30th. To opt out, configure Review - Disable Cache at either the organization or repository level. If you prefer to disable all data retention across your organization, simply turn off the Data Retention setting under your Organization Settings.
Enjoy the performance boost—your workflow just got faster.


📜 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 86733ee and 26d23f7.

📒 Files selected for processing (1)
  • src/snakemake/profiles.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/profiles.py
⏰ Context from checks skipped due to timeout of 90000ms (36)
  • GitHub Check: tests (10, macos-latest, py312)
  • GitHub Check: tests (10, windows-latest, py312)
  • GitHub Check: tests (10, ubuntu-latest, py312)
  • GitHub Check: tests (10, ubuntu-latest, py311)
  • GitHub Check: tests (9, windows-latest, py312)
  • GitHub Check: tests (9, ubuntu-latest, py312)
  • GitHub Check: tests (9, 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 (7, windows-latest, py312)
  • GitHub Check: tests (7, ubuntu-latest, py312)
  • GitHub Check: tests (7, ubuntu-latest, py311)
  • GitHub Check: tests (6, windows-latest, py312)
  • GitHub Check: tests (6, ubuntu-latest, py312)
  • GitHub Check: tests (6, ubuntu-latest, py311)
  • GitHub Check: tests (5, windows-latest, py312)
  • GitHub Check: tests (5, ubuntu-latest, py312)
  • GitHub Check: tests (5, ubuntu-latest, py311)
  • GitHub Check: tests (4, macos-latest, py312)
  • GitHub Check: tests (4, windows-latest, py312)
  • GitHub Check: tests (4, ubuntu-latest, py312)
  • GitHub Check: tests (4, ubuntu-latest, py311)
  • GitHub Check: tests (3, macos-latest, py312)
  • GitHub Check: tests (3, windows-latest, py312)
  • GitHub Check: tests (3, ubuntu-latest, py312)
  • GitHub Check: tests (3, ubuntu-latest, py311)
  • GitHub Check: tests (2, macos-latest, py312)
  • GitHub Check: tests (2, windows-latest, py312)
  • GitHub Check: tests (2, ubuntu-latest, py312)
  • GitHub Check: tests (2, ubuntu-latest, py311)
  • GitHub Check: tests (1, macos-latest, py312)
  • GitHub Check: tests (1, windows-latest, py312)
  • GitHub Check: tests (1, ubuntu-latest, py312)
  • GitHub Check: tests (1, ubuntu-latest, py311)
  • GitHub Check: apidocs
🔇 Additional comments (3)
src/snakemake/profiles.py (3)

29-29: Improvement to support environment variables in profile configuration.

Good change! This adds os.path.expandvars() to process dictionary values, ensuring environment variables are properly expanded in one-level dictionaries for configuration keys like resources, set-threads, etc.


37-37: Environment variable expansion for nested dictionary values.

Good addition! This ensures environment variables are properly expanded in two-level dictionaries for the set-resources configuration option. The change is consistent with the behavior on line 68 where non-dictionary values are already being expanded.


29-40: Verify the changes with tests.

The implementation looks good, but as mentioned in the PR description, tests should be added to verify this behavior works as expected.

Consider adding tests that:

  1. Define environment variables
  2. Create profile configurations using those variables
  3. Verify the variables are properly expanded in both one-level and two-level dictionaries

This will ensure the fix works correctly and prevent regressions in the future.

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

@johanneskoester
Copy link
Copy Markdown
Contributor

Good idea! Maybe the profile docs should also be extended to explain that $-variables will be expanded.

@cademirch
Copy link
Copy Markdown
Contributor Author

Good idea! Maybe the profile docs should also be extended to explain that $-variables will be expanded.

It is already documented, as pointed out in #3592 (comment). The issue fixed here is to make sure that os.expandvars is called on all profile values.

@cademirch cademirch merged commit 4020188 into snakemake:main May 30, 2025
48 checks passed
johanneskoester pushed a commit that referenced this pull request Jun 16, 2025
🤖 I have created a release *beep* *boop*
---


##
[9.6.0](v9.5.1...v9.6.0)
(2025-06-16)


### Features

* Prefer papermill to nbconvert
([#2857](#2857))
([4263b03](4263b03))


### Bug Fixes

* DeprecationWarning when using snakemake.utils.validate
([#3420](#3420))
([cf72427](cf72427))
* display group jobs on dryrun
([#3435](#3435))
([3bebef4](3bebef4))
* expandvars for special profile keys
([#3597](#3597))
([4020188](4020188))
* fix bug causing --precommand to not being executed before each remote
job ([#3625](#3625))
([e59d125](e59d125))
* improved toggle switch behavior in reports
([#3623](#3623))
([0c4bd23](0c4bd23))
* pass envvars defined via the envvars directive to remote jobs
([#3626](#3626))
([d4890b4](d4890b4))
* remove wms arg, update logging cli docs
([#3622](#3622))
([3a9a5ac](3a9a5ac))
* typo in CondaEnvDirSpec.__eq__ (issue
[#3192](#3192))
([#3613](#3613))
([f4c107f](f4c107f))
* Unclear handling of params overriding with inheritance
([#3624](#3624))
([077ac4a](077ac4a))


### Documentation

* Added snakemake command to execute the rule plot_with_python
([#3608](#3608))
([bd99c11](bd99c11))
* Updated Reporting Section of The Tutorial(Interaction, Visualization,
and Reporting with Snakemake)
([#3606](#3606))
([91e90ba](91e90ba))
* Updated Requirement Section of The Tutorial With Warning of Not
Installing The Tools Manually
([#3607](#3607))
([3bd114b](3bd114b))
* Updated Wrapper Version in Tutorial and Used Simple Rule For
Consistency & Ease
([#3605](#3605))
([b3bcc21](b3bcc21))

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).
@coderabbitai coderabbitai Bot mentioned this pull request Nov 2, 2025
2 tasks
johanneskoester pushed a commit that referenced this pull request Nov 27, 2025
<!--Add a description of your PR here-->
Envvars on resources (e.g. `tmpdir`) are not expanded correctly (e.g.
runtime). This PR fixes that, as well as expansion of envvars on
profiles. For that reason, changes from PR #3597 were reverted.

Tests were also added for both cases.

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

* **New Features**
* Configuration values and resource expressions now expand environment
variables (e.g., $VAR) and user home (~), allowing dynamic paths and
settings.
* **Tests**
* Test workflows updated to validate environment-variable and
home-directory expansion in configs and resource handling.
<!-- 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
Fixes snakemake#3592 




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

- **Bug Fixes**
- Environment variables within profile configuration values are now
automatically expanded, ensuring correct values are used in
configurations.

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


##
[9.6.0](snakemake/snakemake@v9.5.1...v9.6.0)
(2025-06-16)


### Features

* Prefer papermill to nbconvert
([snakemake#2857](snakemake#2857))
([4263b03](snakemake@4263b03))


### Bug Fixes

* DeprecationWarning when using snakemake.utils.validate
([snakemake#3420](snakemake#3420))
([cf72427](snakemake@cf72427))
* display group jobs on dryrun
([snakemake#3435](snakemake#3435))
([3bebef4](snakemake@3bebef4))
* expandvars for special profile keys
([snakemake#3597](snakemake#3597))
([4020188](snakemake@4020188))
* fix bug causing --precommand to not being executed before each remote
job ([snakemake#3625](snakemake#3625))
([e59d125](snakemake@e59d125))
* improved toggle switch behavior in reports
([snakemake#3623](snakemake#3623))
([0c4bd23](snakemake@0c4bd23))
* pass envvars defined via the envvars directive to remote jobs
([snakemake#3626](snakemake#3626))
([d4890b4](snakemake@d4890b4))
* remove wms arg, update logging cli docs
([snakemake#3622](snakemake#3622))
([3a9a5ac](snakemake@3a9a5ac))
* typo in CondaEnvDirSpec.__eq__ (issue
[snakemake#3192](snakemake#3192))
([snakemake#3613](snakemake#3613))
([f4c107f](snakemake@f4c107f))
* Unclear handling of params overriding with inheritance
([snakemake#3624](snakemake#3624))
([077ac4a](snakemake@077ac4a))


### Documentation

* Added snakemake command to execute the rule plot_with_python
([snakemake#3608](snakemake#3608))
([bd99c11](snakemake@bd99c11))
* Updated Reporting Section of The Tutorial(Interaction, Visualization,
and Reporting with Snakemake)
([snakemake#3606](snakemake#3606))
([91e90ba](snakemake@91e90ba))
* Updated Requirement Section of The Tutorial With Warning of Not
Installing The Tools Manually
([snakemake#3607](snakemake#3607))
([3bd114b](snakemake@3bd114b))
* Updated Wrapper Version in Tutorial and Used Simple Rule For
Consistency & Ease
([snakemake#3605](snakemake#3605))
([b3bcc21](snakemake@b3bcc21))

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).
kjohnsen pushed a commit to kjohnsen/snakemake that referenced this pull request Dec 15, 2025
<!--Add a description of your PR here-->
Envvars on resources (e.g. `tmpdir`) are not expanded correctly (e.g.
runtime). This PR fixes that, as well as expansion of envvars on
profiles. For that reason, changes from PR snakemake#3597 were reverted.

Tests were also added for both cases.

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

* **New Features**
* Configuration values and resource expressions now expand environment
variables (e.g., $VAR) and user home (~), allowing dynamic paths and
settings.
* **Tests**
* Test workflows updated to validate environment-variable and
home-directory expansion in configs and resource handling.
<!-- 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.

Not all values in profile config support environment variables

2 participants