From 419bf67e9b61f3b38587ad1611dbbdee3e0b6ec7 Mon Sep 17 00:00:00 2001 From: "J. Nick Koston" Date: Thu, 9 Nov 2023 11:12:00 -0600 Subject: [PATCH] Small readability improvements to the plain_text frame helper (#626) --- aioesphomeapi/_frame_helper/plain_text.pxd | 2 ++ aioesphomeapi/_frame_helper/plain_text.py | 26 ++++++++++++---------- 2 files changed, 16 insertions(+), 12 deletions(-) diff --git a/aioesphomeapi/_frame_helper/plain_text.pxd b/aioesphomeapi/_frame_helper/plain_text.pxd index 5175e5e..0ef6fa9 100644 --- a/aioesphomeapi/_frame_helper/plain_text.pxd +++ b/aioesphomeapi/_frame_helper/plain_text.pxd @@ -26,3 +26,5 @@ cdef class APIPlaintextFrameHelper(APIFrameHelper): maybe_msg_type=cython.uint ) cpdef data_received(self, bytes data) + + cpdef _error_on_incorrect_preamble(self, object preamble) diff --git a/aioesphomeapi/_frame_helper/plain_text.py b/aioesphomeapi/_frame_helper/plain_text.py index df1a4f4..bb31c28 100644 --- a/aioesphomeapi/_frame_helper/plain_text.py +++ b/aioesphomeapi/_frame_helper/plain_text.py @@ -95,18 +95,7 @@ class APIPlaintextFrameHelper(APIFrameHelper): length_high = init_bytes[1] maybe_msg_type = init_bytes[2] if preamble != 0x00: - if preamble == 0x01: - self._handle_error_and_close( - RequiresEncryptionAPIError( - f"{self._log_name}: Connection requires encryption" - ) - ) - return - self._handle_error_and_close( - ProtocolAPIError( - f"{self._log_name}: Invalid preamble {preamble:02x}" - ) - ) + self._error_on_incorrect_preamble(preamble) return if length_high & 0x80 != 0x80: @@ -167,3 +156,16 @@ class APIPlaintextFrameHelper(APIFrameHelper): self._remove_from_buffer() self._on_pkt(msg_type_int, packet_data) # If we have more data, continue processing + + def _error_on_incorrect_preamble(self, preamble: _int) -> None: + """Handle an incorrect preamble.""" + if preamble == 0x01: + self._handle_error_and_close( + RequiresEncryptionAPIError( + f"{self._log_name}: Connection requires encryption" + ) + ) + return + self._handle_error_and_close( + ProtocolAPIError(f"{self._log_name}: Invalid preamble {preamble:02x}") + )