py.typed and type comments #251
Draft
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
|
As draft until all previous are also closed |
83ce322 to
70aa021
Compare
70aa021 to
7697da9
Compare
Codecov Report
Additional details and impacted files@@ Coverage Diff @@
## master #251 +/- ##
==========================================
- Coverage 78.21% 75.28% -2.93%
==========================================
Files 42 42
Lines 4705 5054 +349
==========================================
+ Hits 3680 3805 +125
- Misses 1025 1249 +224 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Added type comments as per PEP 561 to type all public API while staying Python 2 compatible. (type definitions only need to be compatible with non EOL python versions. Using type comments instead of inline-types allows the code to still run on Python 2)
Added a
py.typedmarker to let type checkers know that this package provides its own types. And to not look for external type-stubs.Some dynamic types (like
Struct,Request,Event, ...) are naturally incomplete, but this was more than enough for my needs. And would add a lot of complexity to support.For this to be as accurate as possible, the following should also be looked at:
ReplyRequestandConnectionSetupRequestinherit fromRequest? #244booloverLiteral[0, 1, None]#247parse_binary_valueto bytes #249