type: add type annotations to 1D solvers#75
Open
formeo wants to merge 1 commit intodjsilva99:developfrom
Open
Conversation
- Annotate all functions in dimension_1/solvers/ with param + return types - Add TypeError checks for invalid obj/nx arguments - Use TYPE_CHECKING guard to avoid circular Object import - Add 14 unit tests for type validation Related to djsilva99#45
Codecov Report❌ Patch coverage is
@@ Coverage Diff @@
## develop #75 +/- ##
===========================================
+ Coverage 72.79% 73.06% +0.26%
===========================================
Files 22 22
Lines 2272 2294 +22
===========================================
+ Hits 1654 1676 +22
Misses 618 618
🚀 New features to boost your workflow:
|
This file contains hidden or 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
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.
Related to #45
What changed
All 5 files in
dimension_1/solvers/now have full type annotations:TYPE_CHECKINGguard used forObjectimport (avoids circular import)Runtime type checks added to all public functions:
apply_latent_heat()raisesTypeErrorifnxis not alistor
objlacks required thermal attributesTypeErrorifobjis not a thermalObject (checked via
hasattr(obj, 'num_points'))New test file:
test/unit/dimansion_1/test_solvers_1d.pyWhat didn't change
Testing
All 40 tests pass (26 existing + 14 new).
Solver coverage: 97% (explicit/implicit), 68% (_latent_heat).