questdb / questdb/py-questdb-client

.pyi type hints

Open
#84 3 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

good first issue
Dominant language
Python
Stars
71
Forks
14
Avg merge
1h 7m
Merged PRs (30d)
1

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

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by inspecting the Cython package's existing signatures and how they are exposed to PyCharm; the issue does not name specific files or tests. Determine which .pyi coverage is missing, then verify that the package's typing information is usable in PyCharm while preserving the behavior already seen in VS Code.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
developer-experience
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Needs clarification
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.