[Python] Convert async API functions to python asyncio #33989
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
|
PR #33989: Size comparison from acf823f to 4925772 Full report (85 builds for bl602, bl702, bl702l, cc13x4_26x4, cc32xx, cyw30739, efr32, esp32, linux, mbed, nrfconnect, nxp, psoc6, qpg, stm32, telink, tizen)
|
agners
force-pushed
the
convert-async-commands-to-python-asyncio
branch
from
4925772
to
5051453
Compare
agners
force-pushed
the
convert-async-commands-to-python-asyncio
branch
from
5051453
to
a481baa
Compare
|
PR #33989: Size comparison from bec5fc3 to a481baa Full report (8 builds for cc32xx, mbed, qpg, stm32, tizen)
|
agners
force-pushed
the
convert-async-commands-to-python-asyncio
branch
from
a481baa
to
d23759e
Compare
|
PR #33989: Size comparison from bec5fc3 to d23759e Full report (85 builds for bl602, bl702, bl702l, cc13x4_26x4, cc32xx, cyw30739, efr32, esp32, linux, mbed, nrfconnect, nxp, psoc6, qpg, stm32, telink, tizen)
|
agners
force-pushed
the
convert-async-commands-to-python-asyncio
branch
from
d23759e
to
64f79f6
Compare
|
PR #33989: Size comparison from f6ac926 to 64f79f6 Full report (49 builds for bl602, bl702, bl702l, cc13x4_26x4, cc32xx, cyw30739, linux, mbed, nrfconnect, nxp, psoc6, qpg, stm32, tizen)
|
agners
force-pushed
the
convert-async-commands-to-python-asyncio
branch
from
64f79f6
to
1e0aadc
Compare
|
PR #33989: Size comparison from f6ac926 to 1e0aadc Full report (49 builds for bl602, bl702, bl702l, cc13x4_26x4, cc32xx, cyw30739, linux, mbed, nrfconnect, nxp, psoc6, qpg, stm32, tizen)
|
agners
force-pushed
the
convert-async-commands-to-python-asyncio
branch
from
1e0aadc
to
dc04fc2
Compare
agners
changed the title
|
PR #33989: Size comparison from f6ac926 to dc04fc2 Full report (49 builds for bl602, bl702, bl702l, cc13x4_26x4, cc32xx, cyw30739, linux, mbed, nrfconnect, nxp, psoc6, qpg, stm32, tizen)
|
pullapprove
bot
requested review from
andy31415,
andyg-apple,
anush-apple,
arkq,
bauerschwan,
bzbarsky-apple,
carol-apple,
cecille,
chrisdecenzo,
chshu,
chulspro and
cliffamzn
andy31415
approved these changes
Jun 19, 2024
Use a context manager to handle the commissioning process in the device controller. This will ensure that the commissioning resources are properly cleaned up after completion and removes boiler plate code. Also clear fabricCheckNodeId and mark it internal use by adding the underline prefix. Also call pychip_ScriptDevicePairingDelegate_SetExpectingPairingComplete directly on the Python Thread, as this is an atomic operation. This is will also be more asyncio friendly as it is guaranteed to not block.
Use context managers for all APIs which wait for callbacks. This allows to cleanly wrap the future and add additional handling e.g. locks for asyncio in the future.
Make all commissioning APIs async functions. This avoids the need to use run_in_executor() to call them from asyncio code in a non- blocking way.
Make sure that different asyncio tasks do not run the same function concurrently. This is done by adding an asyncio lock to functions which use callbacks.
agners
force-pushed
the
convert-async-commands-to-python-asyncio
branch
from
907e2bf
to
61d0b1b
Compare
|
PR #33989: Size comparison from 38f664f to 864519d Full report (85 builds for bl602, bl702, bl702l, cc13x4_26x4, cc32xx, cyw30739, efr32, esp32, linux, mbed, nrfconnect, nxp, psoc6, qpg, stm32, telink, tizen)
|
arkq
approved these changes
Jun 20, 2024
|
PR #33989: Size comparison from 38f664f to b29e0cf Increases above 0.2%:
Full report (85 builds for bl602, bl702, bl702l, cc13x4_26x4, cc32xx, cyw30739, efr32, esp32, linux, mbed, nrfconnect, nxp, psoc6, qpg, stm32, telink, tizen)
|
agners
added a commit
to agners/chip-wheels
that referenced
this pull request
Jun 20, 2024
This adds commissioning API updates from the master branch to our 1.3 based branch. This makes the commissioning API more Pythonic and allows to call them from the asyncio event loop directly. Specifically, this integrates changes from the following PRs - project-chip/connectedhomeip#33954 - project-chip/connectedhomeip#33905 - project-chip/connectedhomeip#34011 - project-chip/connectedhomeip#34001 - project-chip/connectedhomeip#33989
agners
added a commit
to home-assistant-libs/chip-wheels
that referenced
this pull request
Jun 20, 2024
This adds commissioning API updates from the master branch to our 1.3 based branch. This makes the commissioning API more Pythonic and allows to call them from the asyncio event loop directly. Specifically, this integrates changes from the following PRs - project-chip/connectedhomeip#33954 - project-chip/connectedhomeip#33905 - project-chip/connectedhomeip#34001 - project-chip/connectedhomeip#33989
austina-csa
pushed a commit
to austina-csa/connectedhomeip
that referenced
this pull request
Jul 10, 2024
…33989) * [Python] Use context manager for Commissioning Use a context manager to handle the commissioning process in the device controller. This will ensure that the commissioning resources are properly cleaned up after completion and removes boiler plate code. Also clear fabricCheckNodeId and mark it internal use by adding the underline prefix. Also call pychip_ScriptDevicePairingDelegate_SetExpectingPairingComplete directly on the Python Thread, as this is an atomic operation. This is will also be more asyncio friendly as it is guaranteed to not block. * [Python] Use context manager for all callbacks Use context managers for all APIs which wait for callbacks. This allows to cleanly wrap the future and add additional handling e.g. locks for asyncio in the future. * [Python] Convert commissioning APIs to async functions Make all commissioning APIs async functions. This avoids the need to use run_in_executor() to call them from asyncio code in a non- blocking way. * [Python] Convert UnpairDevice/OpenCommissioningWindow to asyncio * [Python] Convert EstablishPASESession to asyncio * [Python] Convert IssueNOCChain to asyncio * [Python] Add locking to prevent concurrent access with asyncio Make sure that different asyncio tasks do not run the same function concurrently. This is done by adding an asyncio lock to functions which use callbacks. * [Python] Raise an exception if the future did not complete * [Python] Convert tests in src/controller/python/ to asyncio * [Python] Convert tests in src/python_testing/ to asyncio * Adjust yamltest_with_chip_repl_tester to use asyncio * [Python] Add documentation to the new context managers * [Python] Use asyncio.run() to run async tests
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.
Convert API functions which are waiting for a callback to Python co-routines (async functions). This allows to use this API functions without blocking the asyncio event loop, which is crucial for a responsive asyncio application.
The change takes care of locking the individual functions so that independent asyncio tasks can't interfere with each other: E.g. if two asyncio tasks try to commission a device, the second asyncio task trying to commission too will wait for the first asyncio task to complete commission first.