Raise InvalidTokenException on invalid token (#1874)

Invalid checksum raises now a more specialized `InvalidTokenException`. This will allow downstreams to request the user to check the token.
rytilahti · Dec 5, 2023 · 5241bcc · 5241bcc
1 parent dac61d4
commit 5241bcc
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 2 deletions.
diff --git a/miio/__init__.py b/miio/__init__.py
@@ -11,6 +11,7 @@
 from miio.devicestatus import DeviceStatus
 from miio.exceptions import (
     DeviceError,
+    InvalidTokenException,
     DeviceException,
     UnsupportedFeatureException,
     DeviceInfoUnavailableException,

diff --git a/miio/exceptions.py b/miio/exceptions.py
@@ -2,6 +2,10 @@ class DeviceException(Exception):
     """Exception wrapping any communication errors with the device."""
 
 
+class InvalidTokenException(DeviceException):
+    """Exception raised when invalid token is detected."""
+
+
 class PayloadDecodeException(DeviceException):
     """Exception for failures in payload decoding.
 

diff --git a/miio/miioprotocol.py b/miio/miioprotocol.py
@@ -13,7 +13,12 @@
 
 import construct
 
-from .exceptions import DeviceError, DeviceException, RecoverableError
+from .exceptions import (
+    DeviceError,
+    DeviceException,
+    InvalidTokenException,
+    RecoverableError,
+)
 from .protocol import Message
 
 _LOGGER = logging.getLogger(__name__)
@@ -219,7 +224,7 @@ def send(
             except KeyError:
                 return payload
         except construct.core.ChecksumError as ex:
-            raise DeviceException(
+            raise InvalidTokenException(
                 "Got checksum error which indicates use "
                 "of an invalid token. "
                 "Please check your token!"