[Python] Avoid RuntimeException if APIs with future raise an error (#34354)
Currently, when calling an API which uses a future causes an error
(e.g. CommissionWithCode with an invalid code), then the API call
already returns an error. In this case the call `raise_on_error()` on
the returned PyChipError object make sure that an exception is raised.
However, this also causes the `CallbackContext` context manager to
exit.
At this point the future is initialized but never completed, which
triggers the previously introduced sanity check in `CallbackContext`:
`RuntimeError("CallbackContext future not completed")`.
Remove the RuntimeError as existing the context manager early without
completing the future is a use case (when the call setting up the
callback raises an exception).
Instead, just cancel the future in the context manager if it hasn't
been complete yet, in case someone has a reference to it and expects
it to complete.
Also, since most API calls return PyChipError, this changes
`CallAsync()` to raise an exception by default instead of returning a
PyChipError object. If the PyChipError object is required or an API
returns something else, the CallAsyncWithResult() method can be used.diff --git a/src/controller/python/chip/ChipDeviceCtrl.py b/src/controller/python/chip/ChipDeviceCtrl.py
index d9c9196..5023a19 100644
--- a/src/controller/python/chip/ChipDeviceCtrl.py
+++ b/src/controller/python/chip/ChipDeviceCtrl.py
@@ -249,7 +249,10 @@
async def __aexit__(self, exc_type, exc_value, traceback):
if not self._future.done():
- raise RuntimeError("CallbackContext future not completed")
+ # In case the initial call (which sets up for the callback) fails,
+ # the future will never be used actually. So just cancel it here
+ # for completeness, in case somebody is expecting it to be completed.
+ self._future.cancel()
self._future = None
self._lock.release()
@@ -603,11 +606,10 @@
async with self._commissioning_context as ctx:
self._enablePairingCompleteCallback(True)
- res = await self._ChipStack.CallAsync(
+ await self._ChipStack.CallAsync(
lambda: self._dmLib.pychip_DeviceController_ConnectBLE(
self.devCtrl, discriminator, isShortDiscriminator, setupPinCode, nodeid)
)
- res.raise_on_error()
return await asyncio.futures.wrap_future(ctx.future)
@@ -615,11 +617,11 @@
self.CheckIsActive()
async with self._unpair_device_context as ctx:
- res = await self._ChipStack.CallAsync(
+ await self._ChipStack.CallAsync(
lambda: self._dmLib.pychip_DeviceController_UnpairDevice(
self.devCtrl, nodeid, self.cbHandleDeviceUnpairCompleteFunct)
)
- res.raise_on_error()
+
return await asyncio.futures.wrap_future(ctx.future)
def CloseBLEConnection(self):
@@ -656,8 +658,7 @@
async with self._pase_establishment_context as ctx:
self._enablePairingCompleteCallback(True)
- res = await self._ChipStack.CallAsync(callFunct)
- res.raise_on_error()
+ await self._ChipStack.CallAsync(callFunct)
await asyncio.futures.wrap_future(ctx.future)
async def EstablishPASESessionBLE(self, setupPinCode: int, discriminator: int, nodeid: int) -> None:
@@ -756,13 +757,12 @@
# Discovery is also used during commissioning. Make sure this manual discovery
# and commissioning attempts do not interfere with each other.
async with self._commissioning_lock:
- res = await self._ChipStack.CallAsync(
+ await self._ChipStack.CallAsync(
lambda: self._dmLib.pychip_DeviceController_DiscoverCommissionableNodes(
self.devCtrl, int(filterType), str(filter).encode("utf-8")))
- res.raise_on_error()
async def _wait_discovery():
- while not await self._ChipStack.CallAsync(
+ while not await self._ChipStack.CallAsyncWithResult(
lambda: self._dmLib.pychip_DeviceController_HasDiscoveredCommissionableNode(self.devCtrl)):
await asyncio.sleep(0.1)
return
@@ -776,9 +776,8 @@
# Expected timeout, do nothing
pass
finally:
- res = await self._ChipStack.CallAsync(
+ await self._ChipStack.CallAsync(
lambda: self._dmLib.pychip_DeviceController_StopCommissionableDiscovery(self.devCtrl))
- res.raise_on_error()
return await self.GetDiscoveredDevices()
@@ -796,7 +795,7 @@
self._dmLib.pychip_DeviceController_IterateDiscoveredCommissionableNodes(devCtrl.devCtrl, HandleDevice)
return devices
- return await self._ChipStack.CallAsync(lambda: GetDevices(self))
+ return await self._ChipStack.CallAsyncWithResult(lambda: GetDevices(self))
def GetIPForDiscoveredDevice(self, idx, addrStr, length):
self.CheckIsActive()
@@ -828,11 +827,10 @@
self.CheckIsActive()
async with self._open_window_context as ctx:
- res = await self._ChipStack.CallAsync(
+ await self._ChipStack.CallAsync(
lambda: self._dmLib.pychip_DeviceController_OpenCommissioningWindow(
self.devCtrl, self.pairingDelegate, nodeid, timeout, iteration, discriminator, option)
)
- res.raise_on_error()
return await asyncio.futures.wrap_future(ctx.future)
@@ -896,14 +894,14 @@
''' Returns CommissioneeDeviceProxy if we can find or establish a PASE connection to the specified device'''
self.CheckIsActive()
returnDevice = c_void_p(None)
- res = await self._ChipStack.CallAsync(lambda: self._dmLib.pychip_GetDeviceBeingCommissioned(
+ res = await self._ChipStack.CallAsyncWithResult(lambda: self._dmLib.pychip_GetDeviceBeingCommissioned(
self.devCtrl, nodeid, byref(returnDevice)), timeoutMs)
if res.is_success:
return DeviceProxyWrapper(returnDevice, DeviceProxyWrapper.DeviceProxyType.COMMISSIONEE, self._dmLib)
await self.EstablishPASESession(setupCode, nodeid)
- res = await self._ChipStack.CallAsync(lambda: self._dmLib.pychip_GetDeviceBeingCommissioned(
+ res = await self._ChipStack.CallAsyncWithResult(lambda: self._dmLib.pychip_GetDeviceBeingCommissioned(
self.devCtrl, nodeid, byref(returnDevice)), timeoutMs)
if res.is_success:
return DeviceProxyWrapper(returnDevice, DeviceProxyWrapper.DeviceProxyType.COMMISSIONEE, self._dmLib)
@@ -991,7 +989,7 @@
if allowPASE:
returnDevice = c_void_p(None)
- res = await self._ChipStack.CallAsync(lambda: self._dmLib.pychip_GetDeviceBeingCommissioned(
+ res = await self._ChipStack.CallAsyncWithResult(lambda: self._dmLib.pychip_GetDeviceBeingCommissioned(
self.devCtrl, nodeid, byref(returnDevice)), timeoutMs)
if res.is_success:
LOGGER.info('Using PASE connection')
@@ -1021,10 +1019,9 @@
closure = DeviceAvailableClosure(eventLoop, future)
ctypes.pythonapi.Py_IncRef(ctypes.py_object(closure))
- res = await self._ChipStack.CallAsync(lambda: self._dmLib.pychip_GetConnectedDeviceByNodeId(
+ await self._ChipStack.CallAsync(lambda: self._dmLib.pychip_GetConnectedDeviceByNodeId(
self.devCtrl, nodeid, ctypes.py_object(closure), _DeviceAvailableCallback),
timeoutMs)
- res.raise_on_error()
# The callback might have been received synchronously (during self._ChipStack.CallAsync()).
# In that case the Future has already been set it will return immediately
@@ -1917,11 +1914,10 @@
async with self._commissioning_context as ctx:
self._enablePairingCompleteCallback(False)
- res = await self._ChipStack.CallAsync(
+ await self._ChipStack.CallAsync(
lambda: self._dmLib.pychip_DeviceController_Commission(
self.devCtrl, nodeid)
)
- res.raise_on_error()
return await asyncio.futures.wrap_future(ctx.future)
@@ -2065,11 +2061,10 @@
async with self._commissioning_context as ctx:
self._enablePairingCompleteCallback(True)
- res = await self._ChipStack.CallAsync(
+ await self._ChipStack.CallAsync(
lambda: self._dmLib.pychip_DeviceController_OnNetworkCommission(
self.devCtrl, self.pairingDelegate, nodeId, setupPinCode, int(filterType), str(filter).encode("utf-8") if filter is not None else None, discoveryTimeoutMsec)
)
- res.raise_on_error()
return await asyncio.futures.wrap_future(ctx.future)
@@ -2086,11 +2081,10 @@
async with self._commissioning_context as ctx:
self._enablePairingCompleteCallback(True)
- res = await self._ChipStack.CallAsync(
+ await self._ChipStack.CallAsync(
lambda: self._dmLib.pychip_DeviceController_ConnectWithCode(
self.devCtrl, setupPayload.encode("utf-8"), nodeid, discoveryType.value)
)
- res.raise_on_error()
return await asyncio.futures.wrap_future(ctx.future)
@@ -2106,11 +2100,10 @@
async with self._commissioning_context as ctx:
self._enablePairingCompleteCallback(True)
- res = await self._ChipStack.CallAsync(
+ await self._ChipStack.CallAsync(
lambda: self._dmLib.pychip_DeviceController_ConnectIP(
self.devCtrl, ipaddr.encode("utf-8"), setupPinCode, nodeid)
)
- res.raise_on_error()
return await asyncio.futures.wrap_future(ctx.future)
@@ -2127,11 +2120,11 @@
self.CheckIsActive()
async with self._issue_node_chain_context as ctx:
- res = await self._ChipStack.CallAsync(
+ await self._ChipStack.CallAsync(
lambda: self._dmLib.pychip_DeviceController_IssueNOCChain(
self.devCtrl, py_object(self), csr.NOCSRElements, len(csr.NOCSRElements), nodeId)
)
- res.raise_on_error()
+
return await asyncio.futures.wrap_future(ctx.future)
diff --git a/src/controller/python/chip/ChipStack.py b/src/controller/python/chip/ChipStack.py
index dc4efc2..b717859 100644
--- a/src/controller/python/chip/ChipStack.py
+++ b/src/controller/python/chip/ChipStack.py
@@ -216,7 +216,7 @@
'''
return self.PostTaskOnChipThread(callFunct).Wait(timeoutMs)
- async def CallAsync(self, callFunct, timeoutMs: int = None):
+ async def CallAsyncWithResult(self, callFunct, timeoutMs: int = None):
'''Run a Python function on CHIP stack, and wait for the response.
This function will post a task on CHIP mainloop and waits for the call response in a asyncio friendly manner.
'''
@@ -232,6 +232,11 @@
return await asyncio.wait_for(callObj.future, timeoutMs / 1000 if timeoutMs else None)
+ async def CallAsync(self, callFunct, timeoutMs: int = None) -> None:
+ '''Run a Python function on CHIP stack, and wait for the response.'''
+ res: PyChipError = await self.CallAsyncWithResult(callFunct, timeoutMs)
+ res.raise_on_error()
+
def PostTaskOnChipThread(self, callFunct) -> AsyncCallableHandle:
'''Run a Python function on CHIP stack, and wait for the response.
This function will post a task on CHIP mainloop, and return an object with Wait() method for getting the result.
diff --git a/src/controller/python/chip/clusters/Attribute.py b/src/controller/python/chip/clusters/Attribute.py
index ba4c5d4..ab572cb 100644
--- a/src/controller/python/chip/clusters/Attribute.py
+++ b/src/controller/python/chip/clusters/Attribute.py
@@ -469,7 +469,7 @@
async def TriggerResubscribeIfScheduled(self, reason: str):
handle = chip.native.GetLibraryHandle()
- await builtins.chipStack.CallAsync(
+ await builtins.chipStack.CallAsyncWithResult(
lambda: handle.pychip_ReadClient_TriggerResubscribeIfScheduled(
self._readTransaction._pReadClient, reason.encode("utf-8"))
)
diff --git a/src/controller/python/chip/clusters/Command.py b/src/controller/python/chip/clusters/Command.py
index 9395133..785bb3d 100644
--- a/src/controller/python/chip/clusters/Command.py
+++ b/src/controller/python/chip/clusters/Command.py
@@ -316,7 +316,7 @@
payloadTLV = payload.ToTLV()
ctypes.pythonapi.Py_IncRef(ctypes.py_object(transaction))
- return await builtins.chipStack.CallAsync(
+ return await builtins.chipStack.CallAsyncWithResult(
lambda: handle.pychip_CommandSender_SendCommand(
ctypes.py_object(transaction), device,
c_uint16(0 if timedRequestTimeoutMs is None else timedRequestTimeoutMs), commandPath.EndpointId,
@@ -388,7 +388,7 @@
transaction = AsyncBatchCommandsTransaction(future, eventLoop, responseTypes)
ctypes.pythonapi.Py_IncRef(ctypes.py_object(transaction))
- return await builtins.chipStack.CallAsync(
+ return await builtins.chipStack.CallAsyncWithResult(
lambda: handle.pychip_CommandSender_SendBatchCommands(
py_object(transaction), device,
c_uint16(0 if timedRequestTimeoutMs is None else timedRequestTimeoutMs),
