Refactor timeout handling #523
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
farmio
commented
Dec 7, 2020
xknx/knxip/__init__.py
Outdated
Comment on lines
32
to
60
| __all__ = [ | ||
| "KNXIPBody", | ||
| "CEMIFrame", | ||
| "ConnectRequest", | ||
| "ConnectResponse", | ||
| "ConnectionStateRequest", | ||
| "ConnectionStateResponse", | ||
| "DIB", | ||
| "DIBDeviceInformation", | ||
| "DIBGeneric", | ||
| "DIBSuppSVCFamilies", | ||
| "DisconnectRequest", | ||
| "DisconnectResponse", | ||
| "ErrorCode", | ||
| "KNXIPHeader", | ||
| "HPAI", | ||
| "KNXIPFrame", | ||
| "APCICommand", | ||
| "CEMIFlags", | ||
| "CEMIMessageCode", | ||
| "ConnectRequestType", | ||
| "DIBServiceFamily", | ||
| "DIBTypeCode", | ||
| "KNXIPServiceType", | ||
| "KNXMedium", | ||
| "RoutingIndication", | ||
| "SearchRequest", | ||
| "SearchResponse", | ||
| "TunnellingAck", | ||
| "TunnellingRequest", | ||
| ] |
There was a problem hiding this comment.
farmio
commented
Dec 7, 2020
Comment on lines
+43
to
+57
| try: | ||
| await asyncio.wait_for( | ||
| self.response_received_or_timeout.wait(), | ||
| timeout=self.timeout_in_seconds, | ||
| ) | ||
| except asyncio.TimeoutError: | ||
| logger.warning( | ||
| "Error: KNX bus did not respond in time (%s secs) to GroupValueRead request for: %s", | ||
| self.timeout_in_seconds, | ||
| self.group_address, | ||
| ) | ||
| finally: | ||
| # cleanup to not leave callbacks (for asyncio.CancelledError) | ||
| self.xknx.telegram_queue.unregister_telegram_received_cb(cb_obj) |
There was a problem hiding this comment.
The core of this PR is always this pattern.
Instead of using loop.call_later(self.timeout_in_seconds, self.timeout) in self.start_timeout() with self.stop_timeout() and self.timeout()
we use asyncio.wait_for() with a timeout argument and move the contents of self.timeout() into the exception clause so asyncio takes care of handling the timeout for us. This way we can use finally to always remove our callbacks.
farmio
force-pushed
the
timeout-refactor
branch
from
72f492c
to
69435c9
Compare
farmio
force-pushed
the
timeout-refactor
branch
from
69435c9
to
4bcb1b2
Compare
farmio
force-pushed
the
timeout-refactor
branch
from
a64dd0a
to
a978650
Compare
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.
Description
Fixes # (issue)
Type of change
Checklist: