gh-135862: fix asyncio socket partial writes of non-1d-binary arrays #135974
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
…rrays The :mod:`asyncio` code is writing binary data to a :class:`socket.socket`, and advancing through the buffer after a partial write by doing ``memoryview(data)[n:]``, where ``n`` is the number of bytes written. This assumes the :class:`memoryview` is a one dimensional buffer of bytes, which is not the case e.g. for a :class:`memoryview` of an :class:`array.array` of non-bytes, or an ``ndarray`` with more than one dimension. Partial writes of such :class:`memoryview`s will corrupt the stream, repeating or omitting some data. When creating a :class:`memoryview` from a :class:`memoryview`, first convert it to a one-dimensional array of bytes before taking the remaining slice, thus avoiding these issues. Add an assertion that the remaining data is bytes, to guard against possible regressions if additional types of data are allowed in the future.
duaneg
requested review from
1st1,
asvetlov,
kumaraditya303 and
willingc
as code owners
Hopefully this will fix the windows compile failures...
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.
The
asynciocode is writing binary data to asocket.socket, and advancing through the buffer after a partial write by doingmemoryview(data)[n:], wherenis the number of bytes written.This assumes the
memoryviewis a one dimensional buffer of bytes, which is not the case e.g. for amemoryviewof anarray.arrayof non-bytes, or anndarraywith more than one dimension. Partial writes of suchmemoryviews will corrupt the stream, repeating or omitting some data.When creating a
memoryviewfrom amemoryview, first convert it to a one-dimensional array of bytes before taking the remaining slice, thus avoiding these issues.Add an assertion that the remaining data is bytes, to guard against possible regressions if additional types of data are allowed in the future.