Fix KCLayout.clear_kcells

[MatthewMckee4]

Summary by Sourcery

Tests:

• Add test_clear_kcells to test clearing kcells in a layout.

[sourcery-ai]

Reviewer's Guide by Sourcery

This pull request addresses issues in the KCLayout.clear_kcells method by ensuring that all cells are properly unlocked and pruned by calling prune_cell on the kdb_cell. In addition, a new test (test_clear_kcells) has been added to confirm that the method fully clears and destroys cells as expected.

Sequence diagram for KCLayout.clear_kcells

sequenceDiagram
    participant L as KCLayout
    participant C as KCell
    participant KDB as KDB_Cell

    L->>C: top_kcells()
    loop For each KCell
        Note over C: Process each cell
        C-->>C: unlocked = False
        C->>KDB: prune_cell()
    end

Loading

Updated class diagram for KCLayout, KCell, and KDB_Cell

classDiagram
    class KCLayout {
      +clear_kcells() : None
      +top_kcells() : List~KCell~
      -tkcells : Dict
    }

    class KCell {
      -locked : bool
      -kdb_cell : KDB_Cell
    }

    class KDB_Cell {
      +prune_cell() : None
    }

    KCLayout --> "0..n" KCell : contains
    KCell --> KDB_Cell : delegates pruning

    note for KCell "Previously: tc.prune_cell()\nNow: tc.locked = False and tc.kdb_cell.prune_cell()"

Loading

File-Level Changes

Change	Details	Files
Improved the clear_kcells method functionality.	Unlocked top-level cell by setting locked to false. Replaced the direct call to prune_cell with a call on the internal kdb_cell. Cleared the top-level kcells by resetting the container.	src/kfactory/layout.py
Added a test to validate the kcells clearance.	Introduced test_clear_kcells to create a cell and verify it is removed. Checked that the cell is properly destroyed after calling clear_kcells.	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

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[sourcery-ai]

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.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 65.93%. Comparing base (9c8a33a) to head (b4c17dc).
Report is 3 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #602      +/-   ##
==========================================
+ Coverage   65.87%   65.93%   +0.05%     
==========================================
  Files          64       64              
  Lines        9642     9643       +1     
  Branches     1785     1785              
==========================================
+ Hits         6352     6358       +6     
+ Misses       2768     2761       -7     
- Partials      522      524       +2     

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