questdb/py-questdb-client

.pyi type hints

Open

#84 opened on Apr 14, 2024

View on GitHub
 (3 comments) (1 reaction) (0 assignees)Python (14 forks)auto 404
good first issue

Repository metrics

Stars
 (71 stars)
PR merge metrics
 (PR metrics pending)

Description

We have a Cython package that doesn't do a great job of exposing typing information to PyCharm. It looks like this needs additional .pyi files to get it working:

https://stackoverflow.com/questions/41734836/what-does-i-represent-in-python-pyi-extension

Shame, since pretty much all the typing is already on the signatures in Cython and usually works just fine in VS Code. Oh well :-)

Contributor guide

Research direction
Create .pyi stub files for the Cython module to expose type hints. Identify public API functions and classes in .pyx/.pxd files, then hand write .pyi files with proper type annotations matching the Cython signatures.
Tech stack
python
Domain
developer experience
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80