MagicStack / MagicStack/asyncpg

[Feature] mypy typings

Open
#569 9 comments 53 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
8.1k
Forks
468
PR merge metrics
No merged PRs in 30d

Description

Currently, `asyncpg` is untyped and has to be ignored as an import when using [`mypy`](https://mypy.readthedocs.io/en/stable/). Because of this, I created an [`asyncpg-stubs` package](https://github.com/bryanforbes/asyncpg-stubs/) generated from `stubgen` that I use in my own projects as a git dependency, but it would be great to have these in the main library (and verified by the developers). If this is something that is desired, I would be willing to create the initial PR.

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 reviewing the existing asyncpg-stubs package generated with stubgen and compare its coverage with the asyncpg library. Confirm how the stubs should be integrated into the main library and how mypy verification will be performed; done means asyncpg exposes maintained typings that are verified by the project.

Written by the indexing model from the issue text.

Assessment

Tech stack
postgresql, python
Domain
database
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.