Roadmap to 1.0 commits #116
Merged
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
Closed
|
I think (if this is good) it can wait a couple of months before being merged (to make fixing any 0.14.0 bugs easier). |
Kriechi
approved these changes
Apr 6, 2019
pgjones
force-pushed
the
typing
branch
2 times, most recently
from
0c7b0bd to
c465c26
Compare
Python 2 will reach end of life on 2020-01-01, before then wsproto will be released dropping Python 2 as progress is made towards a 1.0 release. The UTF-8 Validator isn't required with Python 3 which can do the same via the decode.
This allows for dataclasses to be used (backport for 3.6 exists, but not 3.5) it also allows for the usage of PEP 526 variable annotations in the upcoming typing commit. 3.6.1 Introduces typing for Deque which will be required to type hint the codebase. Sadly PyPy CI has had to be removed as Travis has no PyPy3.6 support yet (although the testing did very little due to performance concerns, see tox.ini).
Now that wsproto supports Python 3.6 or greater dataclasses can be used. Doing so utilises a standard system (rather than the previous bespoke version) for building these Event classes which then allows other tools, such as mypy, to understand the structure of the events.
This fully type hints the wsproto codebase and uses mypy to ensure the type hints are added and correct. This has identified some potential bugs, see 582d052 The additional linting disable is because the mypy TYPE_CHECKING is not understood by pylint.
This should allow the typing included with wsproto to be picked up by mypy and used in projects that use wsproto.
|
@pgjones whats the progress here? |
|
This is good to merge, I was planning to wait another month before doing so - I'm happy to merge though if you are. |
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.
Includes dropping Python 2.7, 3.5 and introducing typing.