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 default args for DPort center and orientation #601

Merged
merged 2 commits into from
Feb 8, 2025

Conversation

MatthewMckee4
Copy link
Member

@MatthewMckee4 MatthewMckee4 commented Feb 8, 2025

Summary by Sourcery

Enhancements:

  • Set default center and orientation arguments for DPort.

Copy link
Contributor

sourcery-ai bot commented Feb 8, 2025

Reviewer's Guide by Sourcery

This pull request sets default argument values for the 'orientation' and 'center' parameters in the port initialization, and adjusts the control flow accordingly. It eliminates checks for None values by providing defaults, thereby simplifying the handling of port parameters.

Updated Class Diagram for Port Initialization Parameters

classDiagram
    class Port {
      +str port_type = "optical"
      +kdb.Trans|str|None trans
      +kdb.DCplxTrans|str|None dcplx_trans
      +float orientation = 0
      +tuple center = (0,0)
      +bool mirror_x = false
      +ProtoPort[Any]|None port
      +KCLayout|None kcl
      +__init__(...)
    }
    note for Port "Default values for orientation and center simplify parameter handling by removing explicit None checks."
Loading

File-Level Changes

Change Details Files
Updated default arguments and control flow in port initialization.
  • Changed the 'orientation' parameter default from None to 0.
  • Changed the 'center' parameter default from None to (0, 0).
  • Modified the flow: removed the condition that specifically checks for a non-None orientation, replacing it with an else branch.
  • Eliminated the branch that raised a ValueError when port parameters were missing.
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 enhancement New feature or request label Feb 8, 2025
Copy link

codecov bot commented Feb 8, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 65.85%. Comparing base (2d09f09) to head (80f4c67).
Report is 4 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #601      +/-   ##
==========================================
- Coverage   65.88%   65.85%   -0.03%     
==========================================
  Files          64       64              
  Lines        9644     9642       -2     
  Branches     1786     1785       -1     
==========================================
- Hits         6354     6350       -4     
- Misses       2767     2768       +1     
- Partials      523      524       +1     

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

@MatthewMckee4 MatthewMckee4 merged commit 9c8a33a into main Feb 8, 2025
16 checks passed
@MatthewMckee4 MatthewMckee4 deleted the port-default-args branch February 8, 2025 22:42
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