ioos / ioos/xarray-subset-grid
Add Type checking step?
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 9
- Forks
- 11
- Avg merge
- 3d 7h
- Merged PRs (30d)
- 4
Description
What should we add?
There are a fair bit (complete?, no idea) of type annotations in the code.
It's not a great idea to have the annotations and not be running a type checker on them. Bad / incorrect annotations are worse that no annotations.
I have no experience with type checkers, but it seems MyPy is the most used now (though pyright is also ...).
Here's some advice on how to get started:
https://mypy.readthedocs.io/en/latest/existing_code.html#using-mypy-with-an-existing-codebase
@ocefpaf: Do you have any experience setting this up?
Reference
No response
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
The issue names no files, tests, or automation entry point. Start by surveying the existing Python annotations and project configuration, then compare the MyPy and pyright guidance linked in the issue. Done means a type-checking step is selected, configured, and can evaluate the existing codebase consistently.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- tooling
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Quiet
- Clarity
- Needs clarification
- Newbie friendliness
- 45/100