[feature]: Generating type hints for API
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 2.1k
- Forks
- 815
- Avg merge
- 2d 13h
- Merged PRs (30d)
- 2
Description
Issue Summary
Currently the library doesn't have inline type hints or type stubs so we can't type check library usage
Since this library supports python 2.7 the inline type hints would need to follow the comment syntax
Another option is to package separate type stubs (.pyi files) alongside the existing code
Steps to Reproduce
Run your type checker of choice and see warnings about missing types / type stubs
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 reviewing the library's existing API code and the linked mypy guidance for Python 2.7 comment syntax and .pyi stubs. Determine which approach covers the public API, then run a type checker against library usage; done means the supported API has usable type information and the reported missing-type warnings are addressed.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- api
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100