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

Cast protoport to port before int angle match #584

Merged
merged 2 commits into from
Jan 28, 2025

Conversation

MatthewMckee4
Copy link
Member

@MatthewMckee4 MatthewMckee4 commented Jan 28, 2025

Summary by Sourcery

Bug Fixes:

  • Fix an issue where protoports were not being cast to ports before matching the integer angle.

Copy link
Contributor

sourcery-ai bot commented Jan 28, 2025

Reviewer's Guide by Sourcery

The pull request modifies the rename_clockwise function to cast a ProtoPort to a Port before accessing the angle property. This ensures that the angle property is an integer, which is required for the match statement.

Sequence diagram for port angle conversion in rename_clockwise

sequenceDiagram
    participant RC as rename_clockwise
    participant PP as ProtoPort
    participant P as Port
    RC->>PP: Get port.angle
    PP->>P: to_port()
    P-->>RC: Return port with integer angle
    Note over RC: Match angle value
    Note over RC: Calculate sort keys
Loading

Class diagram showing ProtoPort and Port relationship

classDiagram
    class ProtoPort {
        +angle: Any
        +trans: Transform
        +to_port() Port
    }
    class Port {
        +angle: int
        +trans: Transform
    }
    ProtoPort ..> Port : converts to
    note for ProtoPort "Holds port data with flexible types"
    note for Port "Concrete port with integer angle"
Loading

File-Level Changes

Change Details Files
Cast ProtoPort to Port before accessing the angle property.
  • Cast port to _port using port.to_port() before accessing the angle property.
  • Use _port.angle instead of port.angle in the match statement.
  • Use _port.angle instead of port.angle in the ValueError message.
  • Use _port.angle instead of port.angle when calculating dir_2.
  • Use _port.trans.disp.x and _port.trans.disp.y instead of port.trans.disp.x and port.trans.disp.y when calculating key_1 and key_2.
src/kfactory/port.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 bug Something isn't working label Jan 28, 2025
Copy link

codecov bot commented Jan 28, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 61.68%. Comparing base (7a9cca5) to head (268071d).
Report is 3 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #584      +/-   ##
==========================================
+ Coverage   61.67%   61.68%   +0.01%     
==========================================
  Files          64       64              
  Lines        9409     9409              
  Branches     1731     1731              
==========================================
+ Hits         5803     5804       +1     
  Misses       3089     3089              
+ Partials      517      516       -1     

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

@sebastian-goeldi sebastian-goeldi merged commit 25ce064 into main Jan 28, 2025
16 checks passed
@sebastian-goeldi sebastian-goeldi deleted the fix-rename-clockwise branch January 28, 2025 15:20
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