Add __all__ to more files #594
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Reviewer's Guide by SourceryThis pull request adds all declarations to multiple files to control module exports, refactors type aliasing and type hinting for improved clarity and type safety, and simplifies error handling using match-case statements. Class diagram showing updated type hierarchy for ProtoKCell and related classesclassDiagram
class GeometricObject~TUnit~ {
<<abstract>>
+kcl: KCLayout
+bbox(layer: int|None): BoxLike~TUnit~
+transform(trans: Trans|DTrans|ICplxTrans|DCplxTrans)
}
class ProtoKCell~TUnit,TBaseCell~ {
<<abstract>>
-_base_kcell: TBaseCell
+locked: bool
}
class ProtoTKCell~TUnit~ {
<<abstract>>
}
class VKCell {
-_shapes: dict[int, VShapes]
-_name: str|None
}
GeometricObject <|-- ProtoKCell
ProtoKCell <|-- ProtoTKCell
ProtoKCell <|-- VKCell
note for ProtoKCell "Updated to use generic TBaseCell"
Class diagram showing updated type aliases and relationshipsclassDiagram
class AnyKCell {
<<type alias>>
}
class AnyTKCell {
<<type alias>>
}
class ProtoKCell
class ProtoTKCell
AnyKCell .. ProtoKCell : ProtoKCell[Any, Any]
AnyTKCell .. ProtoTKCell : ProtoTKCell[Any]
note for AnyKCell "New type alias for generic ProtoKCell"
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
There was a problem hiding this comment.
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.
| @@ -766,15 +772,15 @@ def insert_into_flat( | |||
| @overload | |||
| def insert_into_flat( | |||
| self, | |||
| cell: ProtoTKCell[Any] | VKCell, | |||
| cell: AnyKCell, | |||
| *, | |||
| trans: kdb.DCplxTrans | None = None, | |||
| levels: int, | |||
| ) -> None: ... | |||
|
|
|||
| def insert_into_flat( | |||
There was a problem hiding this comment.
issue (code-quality): We've found these issues:
- Swap if/else branches (
swap-if-else-branches) - Merge else clause's nested if statement into elif (
merge-else-if-into-elif) - Low code quality found in VInstance.insert_into_flat - 25% (
low-code-quality)
Explanation
The quality score for this function is below the quality threshold of 25%.
This score is a combination of the method length, cognitive complexity and working memory.
How can you solve this?
It might be worth refactoring this function to make it shorter and more readable.
- Reduce the function length by extracting pieces of functionality out into
their own functions. This is the most important thing you can do - ideally a
function should be less than 10 lines. - Reduce nesting, perhaps by introducing guard clauses to return early.
- Ensure that variables are tightly scoped, so that code using related concepts
sits together within the function rather than being scattered.
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #594 +/- ##
==========================================
+ Coverage 63.50% 63.61% +0.11%
==========================================
Files 64 64
Lines 9573 9561 -12
Branches 1785 1777 -8
==========================================
+ Hits 6079 6082 +3
+ Misses 2943 2928 -15
Partials 551 551 ☔ View full report in Codecov by Sentry. |
sebastian-goeldi
approved these changes
Jan 30, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary by Sourcery
Enhance module encapsulation by adding all declarations to various files, refactor type annotations to use new type aliases AnyKCell and AnyTKCell, and simplify error handling in switch cases.
Enhancements: