Add runtime type checking
Open
Nobody has claimed this yet.
CI
enhancement
topic-typing
- Dominant language
- Python
- Stars
- 4.2k
- Forks
- 1.4k
- Avg merge
- 2d 15h
- Merged PRs (30d)
- 14
Description
Is your feature request related to a problem?
Runtime type checking in CI tests may provide the "automated way of checking" suggested at the end of https://github.com/pydata/xarray/issues/9581.
Describe the solution you'd like
Add pytest-beartype to CI tests.
Describe alternatives you've considered
No response
Additional context
I expect this:
- may detect new typing issues beyond static type checking,
- will detect
TYPE_CHECKINGmisuse possibly introduced by the likes of https://github.com/pydata/xarray/pull/9728.
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
Start by locating xarray's CI test configuration and reviewing the pytest-beartype package linked in the issue. Determine how the plugin would run during CI and whether it exposes runtime typing failures, including TYPE_CHECKING misuse. Done means the CI tests use the plugin successfully without introducing unrelated failures.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- ci-cd, testing
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100