Repository navigation
Update mmap stubs for newer Python versions - #4244
Merged
Merged
Conversation
Based on the Python stdlib documentation:
- Since Python 3.5, mmap.{find,rfind,write} all accept any bytes-like.
I've used the _typeshed.ReadableBuffer alias defined in python#4232.
- Since Python 3.6, mmap.write returns the number of bytes written.
- Since Python 3.3, mmap.read allows None as the parameter; while in
Python 2 the argument cannot be omitted.
Contributor
Author
|
Incidentally, I don't really follow why master defines |
srittau
reviewed
Jun 19, 2020
Comment on lines
+66
to
+70
| if sys.version_info >= (3, 5): | ||
| def find(self, sub: ReadableBuffer, start: int = ..., stop: int = ...) -> int: ... | ||
| def rfind(self, sub: ReadableBuffer, start: int = ..., stop: int = ...) -> int: ... | ||
| else: | ||
| def rfind(self, sub: bytes, start: int = ..., stop: int = ...) -> int: ... |
Collaborator
There was a problem hiding this comment.
Since typeshed only supports Python 2.7 and 3.5+, you can leave out the version check and the else branch.
Contributor
Author
There was a problem hiding this comment.
Thanks, I've used that to simplify/clean up things a bit further.
Collaborator
|
Generally, some type stubs are rather old and use conventions that predate modern typeshed conventions. They also often have been patched several times by multiple people. So if you find something amiss, it's often due to these factors, and cleanups are most welcome. Checking the output of |
bmerry
added a commit
to bmerry/typeshed
that referenced
this pull request
Jun 19, 2020
This is a follow-up on python#4232. memoryview, hashlib, and hmac are updated to use ReadableBuffer type instead of their own home-spun unions of bytes, bytearray and whatever else each use case used. mmap is being handled in python#4244, and I'll leave BinaryIO for another day (or possibly another person) because it's going to require some messy code duplication because the relevant methods are defined in IO[AnyStr]. There's one corner case I'm not quite sure how best to handle: the documentation for hmac.digest claim that the parmaeters have the same meanings as in hmac.new, but in CPython the latter has an explicit check that `key` is bytes or bytearray while the former works with a memory-view. For now I've matched the documentation. Also, the documentation for HMAC.update says that `msg` can be any type supported by hashlib from Python 3.4; but I can't see anything in the Python 2.7 implementation that would prevent it also taking bytes-like objects, so I've not tried to treat Python 2 any different to Python 3.
Use the fact that Python 3.0-3.4 are no longer supported to clean up the version-dependent logic. Functions that always have different signatures in Python 2/3 are moved from the base _mmap[bytes] to the mmap subclass.
JelleZijlstra
approved these changes
Jun 21, 2020
JelleZijlstra
left a comment
Member
There was a problem hiding this comment.
This all looks correct.
I'm wondering what's going on with the "_mmap" class. It doesn't exist at runtime in either Python 2 or 3—the mmap.mmap type inherits only from object. Maybe it exists so that we can share some methods between Python 2 and 3, but that doesn't explain why it's generic over AnyStr.
Contributor
Author
Glad it's not just me that's confused. I'm pretty tempted to just reorganise it as a single class with |
JelleZijlstra
pushed a commit
that referenced
this pull request
Jun 22, 2020
This is a follow-up on #4232. memoryview, hashlib, and hmac are updated to use ReadableBuffer type instead of their own home-spun unions of bytes, bytearray and whatever else each use case used. mmap is being handled in #4244, and I'll leave BinaryIO for another day (or possibly another person) because it's going to require some messy code duplication because the relevant methods are defined in IO[AnyStr]. There's one corner case I'm not quite sure how best to handle: the documentation for hmac.digest claim that the parmaeters have the same meanings as in hmac.new, but in CPython the latter has an explicit check that `key` is bytes or bytearray while the former works with a memory-view. For now I've matched the documentation. Also, the documentation for HMAC.update says that `msg` can be any type supported by hashlib from Python 3.4; but I can't see anything in the Python 2.7 implementation that would prevent it also taking bytes-like objects, so I've not tried to treat Python 2 any different to Python 3.
vishalkuo
pushed a commit
to vishalkuo/typeshed
that referenced
this pull request
Jun 26, 2020
* Update mmap stubs for newer Python versions
Based on the Python stdlib documentation:
- Since Python 3.5, mmap.{find,rfind,write} all accept any bytes-like.
I've used the _typeshed.ReadableBuffer alias defined in python#4232.
- Since Python 3.6, mmap.write returns the number of bytes written.
- Since Python 3.3, mmap.read allows None as the parameter; while in
Python 2 the argument cannot be omitted.
* Further clean up mmap.pyi
Use the fact that Python 3.0-3.4 are no longer supported to clean up the
version-dependent logic. Functions that always have different signatures
in Python 2/3 are moved from the base _mmap[bytes] to the mmap subclass.
vishalkuo
pushed a commit
to vishalkuo/typeshed
that referenced
this pull request
Jun 26, 2020
This is a follow-up on python#4232. memoryview, hashlib, and hmac are updated to use ReadableBuffer type instead of their own home-spun unions of bytes, bytearray and whatever else each use case used. mmap is being handled in python#4244, and I'll leave BinaryIO for another day (or possibly another person) because it's going to require some messy code duplication because the relevant methods are defined in IO[AnyStr]. There's one corner case I'm not quite sure how best to handle: the documentation for hmac.digest claim that the parmaeters have the same meanings as in hmac.new, but in CPython the latter has an explicit check that `key` is bytes or bytearray while the former works with a memory-view. For now I've matched the documentation. Also, the documentation for HMAC.update says that `msg` can be any type supported by hashlib from Python 3.4; but I can't see anything in the Python 2.7 implementation that would prevent it also taking bytes-like objects, so I've not tried to treat Python 2 any different to Python 3.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 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.
Based on the Python stdlib documentation:
I've used the _typeshed.ReadableBuffer alias defined in Introduce ReadableBuffer and WriteableBuffer Union aliases #4232.
Python 2 the argument cannot be omitted.