tektronix / tektronix/tm_data_types
[BUG]: Pyright failures due to numpy typing
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 8
- Forks
- 14
- Avg merge
- 3d 10h
- Merged PRs (30d)
- 4
Description
Description of the bug
Currently pyright fails with a massive amount of warnings.
This is due to the nature of generic types and how numpy applies type hinting.
The problem is figuring out how to apply generic dtype type hinting for arrays, such as ndarrays. There also needs to be a way to properly type hint the dtype itself. Solving this will improve type safety and clarity when working with arrays in the code.
Steps To Reproduce
Run pyright
Environment Information
Ensure pyright is installed in the virtual environment.
Activate the virtual environment.
Additional Information
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
Activate the virtual environment and run pyright to capture the current warnings. Review the existing array and dtype annotations, then define and validate a typing approach that handles generic ndarray dtypes and dtype objects while resolving the reported pyright failures.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- numpy, python
- Domain
- tooling
- Issue type
- Bug
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100