Add type hints #487
Closed
Add type hints #487
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
| Hi! Do we have any news here? @ambv |
| @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 |
| 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
4 participants
Add this suggestion to a batch that can be applied as a single commit. This suggestion is invalid because no changes were made to the code. Suggestions cannot be applied while the pull request is closed. Suggestions cannot be applied while viewing a subset of changes. Only one suggestion per line can be applied in a batch. Add this suggestion to a batch that can be applied as a single commit. Applying suggestions on deleted lines is not supported. You must change the existing code in this line in order to create a valid suggestion. Outdated suggestions cannot be applied. This suggestion has been applied or marked resolved. Suggestions cannot be applied from pending reviews. Suggestions cannot be applied on multi-line comments. Suggestions cannot be applied while the pull request is queued to merge. Suggestion cannot be applied right now. Please check back later.
Adds type hints for methods that have them documented. Addresses #387.