TYP: Inline typing annotations#136
Merged
Kai-Striega merged 14 commits intonumpy:mainfrom May 20, 2025
Merged
Conversation
Member
|
Thanks for including this, @jorenham it looks like great progress. I'm going to be busy this week, however I'll try to review it next weekend in depth. |
Kai-Striega
approved these changes
May 10, 2025
Member
Kai-Striega
left a comment
There was a problem hiding this comment.
This looks great! I've played around with it and seems to follow my intuition about what the types should be doing.
As this is quite a large PR, I'm going to leave it open for another week or so to see if there's any community feedback. Otherwise I'll merge it next weekend.
Thanks for your work @jorenham
Member
|
Merged, thank you @jorenham |
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.
I intentionally annotated the input types to (also) accept the overly-loose
numpy.typing.ArrayLiketype. Because even though that also accepts invalid input, it would avoid breaking user code likewhich I'm guessing is the primary use-case of
numpy_financial(or maybe that was just me).Anyway, there's still quite a bit of room for improvement. For example, by making
mypyandpyrightpass is strict mode. But getting there wll take quite a bit of effort for diminishing returns.Closes #133