Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add type hints #487

Closed
wants to merge 3 commits into from
Closed

Add type hints #487

wants to merge 3 commits into from

Conversation

dsluo
Copy link

@dsluo dsluo commented Oct 13, 2019

Adds type hints for methods that have them documented. Addresses #387.

@elprans elprans requested a review from ambv October 15, 2019 16:56
@victoraugustolls
Copy link

Hi! Do we have any news here? @ambv

@ambv
Copy link

ambv commented Nov 12, 2019

@dsluo, how were you checking the annotations are valid? There is no test or CI integration to ensure that the types are correct.

More broadly, what's your goal here? Is this supposed to be used purely as documentation, or as a type check for the asyncpg codebase, or as type check for its users?

If it's the latter, we need to set up the package to use py.typed tags as described by PEP 561.

@dsluo dsluo closed this Sep 11, 2020
@abrahammurciano
Copy link

Can this please be merged? As a user I would find this PR very helpful as it will tell my IDE the types of each object that is returned from any of the library's functions

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants