Skip to content

fix: add .get() for optional values in config instead of dict access #118

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

Merged
merged 2 commits into from
Apr 11, 2025

Conversation

BiancaStoecker
Copy link
Collaborator

@BiancaStoecker BiancaStoecker commented Apr 10, 2025

Config field rename-contigs and genome-build are optional. With direct dictionary access the lookup fails when the value is not set in the config. Now the config dict is queried via .get().

Summary by CodeRabbit

  • Refactor
    • Improved the logic for evaluating specific attributes, ensuring consistent handling and enhancing overall system stability.

@BiancaStoecker BiancaStoecker requested a review from famosab April 10, 2025 14:01
Copy link
Contributor

coderabbitai bot commented Apr 10, 2025

Walkthrough

The update simplifies the logic in several functions related to callsets by changing the way rename-contigs and genome-build attributes are evaluated. The functions get_callset, get_callset_correct_contigs, get_callset_correct_contigs_liftover, and get_rename_contig_file now use truthiness checks and the get method for accessing dictionary values. This approach enhances consistency and clarity in the code. No changes were made to the declarations of exported or public entities.

Changes

File Change Summary
workflow/rules/common.smk Modified get_callset, get_callset_correct_contigs, get_callset_correct_contigs_liftover, and get_rename_contig_file to use truthiness evaluations and the get method for rename-contigs and genome-build.

Sequence Diagram(s)

sequenceDiagram
    participant U as Caller
    participant F as Function (get_callset / others)

    U->>F: Invoke callset function
    alt Check rename-contigs
        F->>F: If rename-contigs is True then proceed with renaming
    else
        F->>F: Skip renaming process
    end
    alt Check genome-build
        F->>F: If genome-build is "grch37" (with default "grch38") then adjust processing
    else
        F->>F: Use default settings (grch38)
    end
    F-->>U: Return processed callset
Loading

Poem

I'm a rabbit, light on my feet,
Hop by hop, I see logic neat.
Equality checks now lead the way,
Bugs nibble off, then scurry away.
Code flows like carrots in the sun—
Joy in every change, my work is fun!
🐇✨

Tip

⚡💬 Agentic Chat (Pro Plan, General Availability)
  • We're introducing multi-step agentic chat in review comments and issue comments, within and outside of PR's. This feature enhances review and issue discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments and add commits to existing pull requests.

📜 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 4cf693d and c6a6b7f.

📒 Files selected for processing (1)
  • workflow/rules/common.smk (4 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • workflow/rules/common.smk

🪧 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.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai plan to trigger planning for file edits and PR creation.
  • @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)
workflow/rules/common.smk (1)

391-406: Improved safety for nested configuration access

The implementation properly handles optional configuration fields in nested dictionary access. This ensures the code behaves as expected even when these configuration options are missing.

One suggestion: Consider extracting repeated accesses like config["variant-calls"][wildcards.callset] into a local variable to improve readability:

-if config["variant-calls"][wildcards.callset].get(
-    "genome-build", "grch38"
-) == "grch37" and config["variant-calls"][wildcards.callset].get(
-    "rename-contigs", False
-):
+callset_config = config["variant-calls"][wildcards.callset]
+if callset_config.get("genome-build", "grch38") == "grch37" and callset_config.get(
+    "rename-contigs", False
+):
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between bf85471 and 4cf693d.

📒 Files selected for processing (1)
  • workflow/rules/common.smk (4 hunks)
🔇 Additional comments (3)
workflow/rules/common.smk (3)

211-213: Robust dictionary access: Good use of .get() method

This change properly implements dictionary's .get() method with default values for the optional configuration fields. The explicit comparison to True ensures the condition only evaluates to true when the value is explicitly set to True, avoiding potential issues with truthy values.


224-226: Using .get() for safer dictionary access

Using .get() with a default value for the optional "rename-contigs" and "genome-build" fields is a good defensive programming practice. This avoids KeyError exceptions when these configuration options are not set.


237-239: Consistent implementation of safer dictionary access

The changes here maintain consistency with the previous changes, safely accessing optional configuration values using the .get() method.

Copy link
Collaborator

@famosab famosab left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM - just one thing for consistency :)

Co-authored-by: Famke Bäuerle <45968370+famosab@users.noreply.github.com>
@BiancaStoecker BiancaStoecker merged commit 94d9294 into main Apr 11, 2025
7 checks passed
@BiancaStoecker BiancaStoecker deleted the fix/genome-build-not-optional branch April 11, 2025 10:15
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.

2 participants