ydb-platform / ydb-platform/ydb-python-sdk
feature: Type annotations and mypy support
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 102
- Forks
- 75
- Avg merge
- 1d 23h
- Merged PRs (30d)
- 13
Description
Feature Request
Describe the Feature Request
Modern python projects use Mypy to do a static type checking. It allows to avoid many problems and make the development process faster and easier. Mypy requires library to be PEP 561 compatible.
Describe Preferred Solution
Configure Mypy type check for this repository and add all PEP 561 required files and stubs.
Describe Alternatives
Another solution is to create a separate ydb-stubs repository only with stubs (*.pyi files).
If the feature request is approved, would you be willing to submit a PR?
No
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 repository's Python package layout and the Mypy documentation on PEP 561-compatible packages. Determine which package files, metadata, and type stubs (*.pyi) are required, then define completion as a configured Mypy check and a PEP 561-compatible distribution; the separate ydb-stubs option remains an alternative in the issue.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- developer-experience
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100