extmod/vfs_blockdev: Support bool return from Python read/write blocks. #16222
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
Commit f4ab9d9 inadvertently broke some Python block devices, for example esp32 and stm32 SDCard classes. Those classes return a bool from their `readblocks` and `writeblocks` methods instead of an integer errno code. With that change, both `False` and `True` return values are now be interpreted as non-zero and hence the block device call fails. The fix in this commit is to allow a bool and explicitly convert `True` to 0 and `False` to `-MP_EIO`. Signed-off-by: Damien George <damien@micropython.org>
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #16222 +/- ##
=======================================
Coverage 98.57% 98.57%
=======================================
Files 164 164
Lines 21345 21347 +2
=======================================
+ Hits 21041 21043 +2
Misses 304 304 ☔ View full report in Codecov by Sentry. |
This was referenced Nov 13, 2024
|
Code size report: |
projectgus
approved these changes
Nov 15, 2024
|
I tested on ESP32 and this patch fixes the issue. |
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.
Summary
Commit f4ab9d9 inadvertently broke some Python block devices, for example esp32 and stm32 SDCard classes. Those classes return a bool from their
readblocksandwriteblocksmethods instead of an integer errno code. With that change, bothFalseandTruereturn values are now be interpreted as non-zero and hence the block device call fails.The fix in this commit is to allow a bool and explicitly convert
Trueto 0 andFalseto-MP_EIO.Fixes issues #16171 and #16214.
Testing
Tested on PYBV11 using:
That would previously fail, but with this patch passes.
Tested also on ESP32 (a Lolin 32 Pro). Wit this patch mounting an SD card passes.
Trade-offs and Alternatives
This is a simple fix and a candidate for a patch release (1.24.1). An alternative is to make the Python blockdev functions return integers instead of bools, but that's an API change.
Edit: see #16223 for the alternative.