Add link about Python 2 GZip workaround #133
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
Lest we or others wonder what this workaround is doing. Link back to the PR comment for details. TL;DR - GZip on Python 2 (and Python pre-3.5) determines the number of bytes included via `len`, which is needed for the GZip footer. This will be incorrect if the data is not flattened and using a single byte type. Hence we cast to `uint8` here to satisfy this constraint. On Python 3.5+ this is not needed as it casts the data to a `memoryview` and accesses the `nbytes` attribute to determine this. ref: #128 (comment)
alimanfoo
approved these changes
Nov 27, 2018
|
Good move, thanks. |
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.
Lest we or others wonder what this workaround is doing. Link back to the PR comment for details.
TL;DR - GZip on Python 2 (and Python pre-3.5) determines the number of bytes included via
len, which is needed for the GZip footer. This will be incorrect if the data is not flattened and using a single byte type. Hence we cast touint8here to satisfy this constraint. On Python 3.5+ this is not needed as it casts the data to amemoryviewand accesses thenbytesattribute to determine this.ref: #128 (comment)
[Description of PR]
TODO:
tox -e py37passes locallytox -e py27passes locallytox -e docspasses locally