chore: add generic type hints for remaining modules + mark project as typed. #380
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.
Problem
Completion of the work started on #377 of adding generic type hints to the Gazu codebase - more information can be found on that PR and linked discussion.
Solution
This PR adds type hints to the remaining modules in the API, and finally adds the
py.typedfile indicating that the module has type annotations.As with the last PRs, along the way I've also made some minor fixes/additions to docstrings, in cases where I didn't find the types or behaviours of the arguments immediately obvious - or there was incorrect/missing info in the docstrings.
And in or two instances have added
normalize_model_parameter()calls to parameters so that their functionality matches the previous docstring.I've also standardised model parameter docstrings from
dict / IDtostr / dictin a couple of places so they're all the same.