last_received_report will be removed in Circuitpython 8.0.0 #100
Conversation
This file contains 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
tekktrik
reviewed
Aug 18, 2022
| @@ -162,7 +162,8 @@ def _remove_keycode_from_report(self, keycode: int) -> None: | |||
| @property | |||
| def led_status(self) -> bytes: | |||
| """Returns the last received report""" | |||
| return self._keyboard_device.last_received_report | |||
| # get_last_received_report() returns None when nothing was received | |||
| return self._keyboard_device.get_last_received_report() or b"\x00" | |||
There was a problem hiding this comment.
The documentation says that last_received_report also returned None, so is the or b"\00" just a bugfix? I'm assuming it MUST be a bytes object return instead of Optional based on usage in led_on. Just wanted to check before merging so I get the semver correct.
There was a problem hiding this comment.
Yes, it makes the code compatible with the documentation. In reality last_received_report and get_last_received_report() never return None as currently implemented, but I added that to future-proof it a little in case that's fixed.
There might be bigger changes coming in 8.0.0 though, so that might be revisited soon.
See adafruit/circuitpython#6767
tekktrik
approved these changes
Aug 18, 2022
adafruit-adabot
added a commit
to adafruit/Adafruit_CircuitPython_Bundle
that referenced
this pull request
Aug 19, 2022
Updating https://github.com/adafruit/Adafruit_CircuitPython_VCNL4040 to 1.2.12 from 1.2.11: > Merge pull request adafruit/Adafruit_CircuitPython_VCNL4040#15 from sokratisvas/add-type-annotations > Fix version strings in workflow files > Update version string Updating https://github.com/adafruit/Adafruit_CircuitPython_HID to 5.3.0 from 5.2.5: > Merge pull request adafruit/Adafruit_CircuitPython_HID#100 from Neradoc/get-last-received-report > Fix version strings in workflow files > Update version string Updating https://github.com/adafruit/Adafruit_CircuitPython_MiniMQTT to 5.4.0 from 5.3.3: > Merge pull request adafruit/Adafruit_CircuitPython_MiniMQTT#116 from vladak/socket_timeout_tunable > Fix version strings in workflow files > Update version string
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.
Switch to get_last_received_report().