Add _WriteStream protocol for MicroPython Buffer write methods #836
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.
Summary
This PR implements reference stubs for the MicroPython Buffer protocol's extended
writesignature, as discussed in micropython/micropython#17938.Changes
Added a new
_WriteStreamProtocol toreference/_mpy_shed/buffer_mp.pyithat defines three overloaded write method signatures:This extended signature is used throughout MicroPython but was previously undocumented in the type stubs. It's commonly found in:
socket.write)machine.UART.write)machine.I2C.write,machine.SPI.write)asyncio.Stream.write)Design
int | Noneto match MicroPython's behavior where non-blocking operations returnNonewhen they would blockAnyReadableBuftype alias for buffer protocol compatibilityBackward Compatibility
No breaking changes. Existing
AnyReadableBufandAnyWritableBuftype aliases remain unchanged. The new protocol is exported from_mpy_shedfor use in other modules.Testing
.pyifiles pass Python compilationCloses #<issue_number>
Original prompt
💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.