pybricks.common.BLE: Update type hints and add missing documentation #164
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
Update type hint for broadcast_channel to Optional, as None is allowed.
- Add overloads for broadcast(). It accepts either a single value, or a tuple, or a list. - Adjust return type of observe(). It either returns a single value, or a tuple.
dlech
reviewed
Jun 24, 2025
Comment on lines
+92
to
+94
| "broadcast", | ||
| "observe", | ||
| "observe_enable", |
There was a problem hiding this comment.
A couple of these aren't in the docs, so I'm not sure they are meant to be public.
There was a problem hiding this comment.
observe_enable() was undocumented, but mentioned in the release changelog. I could extract that into a separate MR if you'd rather not add it to the public docs.
There was a problem hiding this comment.
Let's wait and see what @laurensvalk says.
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.
Hi @laurensvalk and @dlech
I'm implementing the Pybricks BLE interfaces in my pybricks-ble project, and noticed that some of the type hints are inaccurate/incomplete. That makes the type checker unhappy when trying to mimic Pybricks behaviour, but with the changes in this PR I was able to get everything working (see fkleon/pybricks-ble#9).
Update API docs and code completions for the following changes:
broadcast_channelin the hub constructors, and addition of thebroadcast_enable()method: pybricks.common.BLE: Implement observe_enable() pybricks-micropython#269 (changed inv3.6.0b2)broadcastaccepts either a single value, a tuple, or a list.observeeither returns a single value, or a tuple. (changed inv3.3.0b9)