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

Add concrete iter for InstancePorts and DInstancePorts #597

Merged
merged 1 commit into from
Feb 1, 2025

Conversation

MatthewMckee4
Copy link
Member

@MatthewMckee4 MatthewMckee4 commented Feb 1, 2025

Summary by Sourcery

New Features:

  • Iterate over InstancePorts and DInstancePorts using iter and return Port and Dport objects respectively.

Copy link
Contributor

sourcery-ai bot commented Feb 1, 2025

Reviewer's Guide by Sourcery

This pull request adds the iter method to the InstancePorts and DInstancePorts classes, enabling iteration over their ports. It also adds a test case for the new functionality.

Class diagram showing the changes to InstancePorts hierarchy

classDiagram
    class ProtoTInstancePorts {
      <<abstract>>
      +__getitem__()
      +cell_ports()* TUnit
      +each_port() Iterator[ProtoPort[TUnit]]
      +__iter__()* Iterator[ProtoPort[TUnit]]
      +each_by_array_coord()
    }

    class InstancePorts {
      +__getitem__() Port
      +__iter__() Iterator[Port]
    }

    class DInstancePorts {
      +__getitem__() DPort
      +__iter__() Iterator[DPort]
    }

    ProtoTInstancePorts <|-- InstancePorts
    ProtoTInstancePorts <|-- DInstancePorts

    note for ProtoTInstancePorts "each_port() renamed from __iter__()"
    note for InstancePorts "New concrete __iter__() implementation"
    note for DInstancePorts "New concrete __iter__() implementation"
Loading

File-Level Changes

Change Details Files
Added the __iter__ method to InstancePorts and DInstancePorts.
  • Added an abstract __iter__ method to ProtoTInstancePorts.
  • Implemented the __iter__ method in InstancePorts to iterate over Port objects.
  • Implemented the __iter__ method in DInstancePorts to iterate over DPort objects.
  • The __iter__ methods use the each_port method to get the base ports and then convert them to the correct type.
src/kfactory/instance_ports.py
Added a test case for the __iter__ method.
  • Added a test case test_iter to verify the functionality of the __iter__ method for both InstancePorts and DInstancePorts.
  • The test case asserts that the correct number of ports are returned and that they are of the correct type.
tests/test_instance_ports.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

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.

@github-actions github-actions bot added the enhancement New feature or request label Feb 1, 2025
Copy link

codecov bot commented Feb 1, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 66.03%. Comparing base (7f2f976) to head (8dfad82).
Report is 3 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #597      +/-   ##
==========================================
+ Coverage   65.98%   66.03%   +0.05%     
==========================================
  Files          64       64              
  Lines        9504     9508       +4     
  Branches     1771     1771              
==========================================
+ Hits         6271     6279       +8     
+ Misses       2714     2713       -1     
+ Partials      519      516       -3     

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

@MatthewMckee4 MatthewMckee4 merged commit cb5c7e5 into main Feb 1, 2025
18 checks passed
@MatthewMckee4 MatthewMckee4 deleted the instance-ports-iter branch February 1, 2025 20:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants