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 clear kcells #603

Merged
merged 1 commit into from
Feb 9, 2025
Merged

Fix clear kcells #603

merged 1 commit into from
Feb 9, 2025

Conversation

MatthewMckee4
Copy link
Member

@MatthewMckee4 MatthewMckee4 commented Feb 9, 2025

Summary by Sourcery

Bug Fixes:

  • Fixed an issue where clearing kcells would raise an error if the cells were locked.

Copy link
Contributor

sourcery-ai bot commented Feb 9, 2025

Reviewer's Guide by Sourcery

This pull request makes improvements to the clear_kcells function in the Layout object and updates tests accordingly. The main changes include ensuring that all kcels are unlocked before being cleared and adding test assertions to verify that all injected cells are properly destroyed.

Updated class diagram for Layout and KCell (clear_kcells modification)

classDiagram
    class Layout {
      - kcells: dict
      - tkcells: dict
      + top_kcell(): KCell
      + top_kcells(): list~KCell~
      + clear_kcells(): None
    }
    class KCell {
      + locked: bool
      + kdb_cell: KdbCell
    }
    class KdbCell {
      + prune_cell(): None
    }
    Layout --> "*" KCell : contains
    KCell --> KdbCell : manages
    note for Layout "In clear_kcells(), added iteration over kcells to unlock each KCell\nby setting locked = false before pruning."
Loading

File-Level Changes

Change Details Files
Refactored clear_kcells method to unlock all cells before pruning.
  • Iterates over all entries in the kcells dictionary to unlock each cell by setting locked to False.
  • Removes the redundant unlocking of top-level cells inside the iteration over top_kcells, focusing solely on pruning their kdb_cell.
src/kfactory/layout.py
Updated test case for clear_kcells method to validate complete cell clearing.
  • Created a new cell instance and appended a drawn object to it.
  • Modified assertions to check not only that the kcells dictionary is empty but also that the added cell and its contents are properly destroyed.
tests/test_layout.py

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!
  • Generate a plan of action for an issue: Comment @sourcery-ai plan on
    an issue to generate a plan of action for it.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@github-actions github-actions bot added the bug Something isn't working label Feb 9, 2025
Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

We've reviewed this pull request using the Sourcery rules engine. If you would also like our AI-powered code review then let us know.

Copy link

codecov bot commented Feb 9, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 65.96%. Comparing base (4ce39df) to head (70d02bf).
Report is 3 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #603      +/-   ##
==========================================
+ Coverage   65.94%   65.96%   +0.02%     
==========================================
  Files          64       64              
  Lines        9643     9644       +1     
  Branches     1785     1786       +1     
==========================================
+ Hits         6359     6362       +3     
  Misses       2761     2761              
+ Partials      523      521       -2     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@MatthewMckee4 MatthewMckee4 merged commit 65696b7 into main Feb 9, 2025
18 checks passed
@MatthewMckee4 MatthewMckee4 deleted the fix-clear-cells branch February 9, 2025 10:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants