Concrete top level classes #982
Merged
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
dlech
commented
Sep 6, 2022
bdraco
reviewed
Sep 12, 2022
bdraco
reviewed
Sep 21, 2022
dlech
force-pushed
the
concrete-top-level-classes
branch
3 times, most recently
from
a193c4f to
c5191b7
Compare
This allows us to put all of the documentation, including platform- specific quirks, for BleakScanner and BleakClient in one place. Docs for these classes are move to new sub-pages of the API docs page and the backend docs are moved to the backend pages of the docs. It will also allow us to eventually eliminate quite a bit of duplicated code from the backends by moving it to these shared classes. Several methods that provided duplicate functionality have been deprecated (previously they were required because of backend implementation details but can now be safely removed from the top-level classes).
Much of the information on this page is outdated. The information that is still relevant is now covered on the new dedicated BleakScanner class page.
This can be useful for custom backends and testing.
dlech
force-pushed
the
concrete-top-level-classes
branch
from
c5191b7 to
e759b45
Compare
Since we were importing `bleak` in conf.py, it required some runtime dependencies to be installed. We can avoid this by just reading the version from the pyproject.toml file instead.
bdraco
reviewed
Sep 21, 2022
| def __init__( | ||
| self, | ||
| device_or_address: Union[BLEDevice, str], | ||
| disconnected_callback: Optional[Callable[[BleakClient], None]] = None, |
There was a problem hiding this comment.
Looks like this keyword arg snuck in before the *
pylint was complaining when I was doing testing keyword-arg-before-vararg
There was a problem hiding this comment.
no, this is intentional, the arg is now positional or keyword
Closed
dlech
added a commit
that referenced
this pull request
Sep 23, 2022
This was missed in #982 since BaseBleakClient didn't have an abstract property for this. This adds the base abstract property to the backends, fixes the missing property in BleakClient client and adds it to the documentation.
dlech
added a commit
that referenced
this pull request
Sep 23, 2022
This was missed in #982 since BaseBleakClient didn't have an abstract property for this. This adds the base abstract property to the backends, fixes the missing property in BleakClient client and adds it to the documentation.
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.
This is a partial alternative to some of the code changes in #904. It implements the suggestion of creating new
BleakScannerandBleakClientobjects. This solves some of the documentation complications compared to the approach in #904 of using multiple inheritance. Also it will allow us to refactor some duplicated code between the backends in the future, like checking if a device is still connected and wrapping coroutine callbacks.It is not a complete alternative to #904 as there are some really nice documentation improvements there that I think we should still pick up. And there are some other classes that are not backend-specific that could be moved out of the
backendsmodule, but they can be handled one at a time and at a later date.cc: @jackjansen
Fixes: #582.