Rename all exceptions from *Exception to *Error (N818)

Rename all custom exception classes to use the Error suffix per PEP 8 naming conventions (ruff N818). Also fix typo NotSuchTokenException to NoSuchTokenError. Enable pep8-naming (N) ruff rules.

Author: iMicknl

docs/action-queue.md

@@ -1,6 +1,6 @@
 # Action queue
 
-The action queue automatically groups rapid, consecutive calls to `execute_action_group()` into a single ActionGroup execution. This minimizes the number of API calls and helps prevent rate limiting issues, such as `TooManyRequestsException`, `TooManyConcurrentRequestsException`, `TooManyExecutionsException`, or `ExecutionQueueFullException` which can occur if actions are sent individually in quick succession.
+The action queue automatically groups rapid, consecutive calls to `execute_action_group()` into a single ActionGroup execution. This minimizes the number of API calls and helps prevent rate limiting issues, such as `TooManyRequestsError`, `TooManyConcurrentRequestsError`, `TooManyExecutionsError`, or `ExecutionQueueFullError` which can occur if actions are sent individually in quick succession.
 
 Important limitation:
 - Gateways only allow a single action per device in each action group. The queue

docs/device-control.md

@@ -198,7 +198,7 @@ await client.execute_action_group(
 
 ## Limitations and rate limits
 
-Gateways impose limits on how many executions can run or be queued simultaneously. If the execution queue is full, the API will raise an `ExecutionQueueFullException`. Most gateways allow up to 10 concurrent executions.
+Gateways impose limits on how many executions can run or be queued simultaneously. If the execution queue is full, the API will raise an `ExecutionQueueFullError`. Most gateways allow up to 10 concurrent executions.
 
 ### Action queue (batching across calls)
 

docs/error-handling.md

@@ -1,14 +1,14 @@
 # Error handling
 
-## Common exceptions
+## Common errors
 
-- `NotAuthenticatedException`
-- `TooManyRequestsException`
-- `TooManyConcurrentRequestsException`
-- `TooManyExecutionsException`
-- `MaintenanceException`
-- `AccessDeniedToGatewayException`
-- `BadCredentialsException`
+- `NotAuthenticatedError`
+- `TooManyRequestsError`
+- `TooManyConcurrentRequestsError`
+- `TooManyExecutionsError`
+- `MaintenanceError`
+- `AccessDeniedToGatewayError`
+- `BadCredentialsError`
 
 ## Retry and backoff guidance
 
@@ -21,9 +21,9 @@ from pyoverkiz.auth.credentials import UsernamePasswordCredentials
 from pyoverkiz.client import OverkizClient
 from pyoverkiz.enums import Server
 from pyoverkiz.exceptions import (
-    NotAuthenticatedException,
-    TooManyConcurrentRequestsException,
-    TooManyRequestsException,
+    NotAuthenticatedError,
+    TooManyConcurrentRequestsError,
+    TooManyRequestsError,
 )
 
 
@@ -38,9 +38,9 @@ async def fetch_devices_with_retry() -> None:
                 devices = await client.get_devices()
                 print(devices)
                 return
-            except (TooManyRequestsException, TooManyConcurrentRequestsException):
+            except (TooManyRequestsError, TooManyConcurrentRequestsError):
                 await asyncio.sleep(0.5 * (attempt + 1))
-            except NotAuthenticatedException:
+            except NotAuthenticatedError:
                 await client.login()
 
 

docs/event-handling.md

@@ -32,8 +32,8 @@ from pyoverkiz.auth.credentials import UsernamePasswordCredentials
 from pyoverkiz.client import OverkizClient
 from pyoverkiz.enums import Server
 from pyoverkiz.exceptions import (
-    InvalidEventListenerIdException,
-    NoRegisteredEventListenerException,
+    InvalidEventListenerIdError,
+    NoRegisteredEventListenerError,
 )
 
 
@@ -48,7 +48,7 @@ async def main() -> None:
         while True:
             try:
                 events = await client.fetch_events()
-            except (InvalidEventListenerIdException, NoRegisteredEventListenerException):
+            except (InvalidEventListenerIdError, NoRegisteredEventListenerError):
                 await asyncio.sleep(1)
                 await client.register_event_listener()
                 continue
@@ -96,6 +96,6 @@ asyncio.run(main())
 
 ## Reconnect tips
 
-- Re-register the listener when you see `InvalidEventListenerIdException`.
+- Re-register the listener when you see `InvalidEventListenerIdError`.
 - Poll occasionally if your network has unstable connectivity.
 - Keep the fetch loop alive to avoid listener timeout.

docs/troubleshooting.md

@@ -17,11 +17,11 @@ If the gateway uses a self-signed certificate, pass `verify_ssl=False` when crea
 ## Rate limits and concurrency
 
 - Reduce polling frequency.
-- Back off on `TooManyRequestsException` or `TooManyConcurrentRequestsException`.
+- Back off on `TooManyRequestsError` or `TooManyConcurrentRequestsError`.
 
 ## Listener drops
 
-- Re-register the event listener when you see `InvalidEventListenerIdException`.
+- Re-register the event listener when you see `InvalidEventListenerIdError`.
 - Ensure your fetch loop is running every few seconds.
 
 ## Device not found

pyoverkiz/auth/strategies.py

@@ -42,14 +42,14 @@
 )
 from pyoverkiz.enums import APIType
 from pyoverkiz.exceptions import (
-    BadCredentialsException,
-    CozyTouchBadCredentialsException,
-    CozyTouchServiceException,
-    InvalidTokenException,
-    NexityBadCredentialsException,
-    NexityServiceException,
-    SomfyBadCredentialsException,
-    SomfyServiceException,
+    BadCredentialsError,
+    CozyTouchBadCredentialsError,
+    CozyTouchServiceError,
+    InvalidTokenError,
+    NexityBadCredentialsError,
+    NexityServiceError,
+    SomfyBadCredentialsError,
+    SomfyServiceError,
 )
 from pyoverkiz.models import ServerConfig
 
@@ -118,7 +118,7 @@ async def _post_login(self, data: Mapping[str, Any]) -> None:
             ssl=self._ssl,
         ) as response:
             if response.status not in (200, 204):
-                raise BadCredentialsException(
+                raise BadCredentialsError(
                     f"Login failed for {self.server.name}: {response.status}"
                 )
 
@@ -128,7 +128,7 @@ async def _post_login(self, data: Mapping[str, Any]) -> None:
 
             result = await response.json()
             if not result.get("success"):
-                raise BadCredentialsException("Login failed: bad credentials")
+                raise BadCredentialsError("Login failed: bad credentials")
 
 
 class SomfyAuthStrategy(BaseAuthStrategy):
@@ -195,11 +195,11 @@ async def _request_access_token(
             token = await response.json()
 
             if token.get("message") == "error.invalid.grant":
-                raise SomfyBadCredentialsException(token["message"])
+                raise SomfyBadCredentialsError(token["message"])
 
             access_token = token.get("access_token")
             if not access_token:
-                raise SomfyServiceException("No Somfy access token provided.")
+                raise SomfyServiceError("No Somfy access token provided.")
 
             self.context.access_token = cast(str, access_token)
             self.context.refresh_token = token.get("refresh_token")
@@ -233,10 +233,10 @@ async def login(self) -> None:
             token = await response.json()
 
             if token.get("error") == "invalid_grant":
-                raise CozyTouchBadCredentialsException(token["error_description"])
+                raise CozyTouchBadCredentialsError(token["error_description"])
 
             if "token_type" not in token:
-                raise CozyTouchServiceException("No CozyTouch token provided.")
+                raise CozyTouchServiceError("No CozyTouch token provided.")
 
         async with self.session.get(
             f"{COZYTOUCH_ATLANTIC_API}/magellan/accounts/jwt",
@@ -245,7 +245,7 @@ async def login(self) -> None:
             jwt = await response.text()
 
             if not jwt:
-                raise CozyTouchServiceException("No JWT token provided.")
+                raise CozyTouchServiceError("No JWT token provided.")
 
             jwt = jwt.strip('"')
 
@@ -278,7 +278,7 @@ def _client() -> BaseClient:
         except ClientError as error:
             code = error.response.get("Error", {}).get("Code")
             if code in {"NotAuthorizedException", "UserNotFoundException"}:
-                raise NexityBadCredentialsException() from error
+                raise NexityBadCredentialsError() from error
             raise
 
         id_token = tokens["AuthenticationResult"]["IdToken"]
@@ -290,7 +290,7 @@ def _client() -> BaseClient:
             token = await response.json()
 
             if "token" not in token:
-                raise NexityServiceException("No Nexity SSO token provided.")
+                raise NexityServiceError("No Nexity SSO token provided.")
 
             user_id = self.credentials.username.replace("@", "_-_")
             await self._post_login({"ssoToken": token["token"], "userId": user_id})
@@ -314,7 +314,7 @@ def __init__(
     async def login(self) -> None:
         """Validate that a token is provided for local API access."""
         if not self.credentials.token:
-            raise InvalidTokenException("Local API requires a token.")
+            raise InvalidTokenError("Local API requires a token.")
 
     def auth_headers(self, path: str | None = None) -> Mapping[str, str]:
         """Return authentication headers for a request path."""
@@ -385,16 +385,14 @@ async def _exchange_token(self, payload: Mapping[str, str]) -> None:
             if error:
                 description = token.get("error_description") or token.get("message")
                 if description:
-                    raise InvalidTokenException(
+                    raise InvalidTokenError(
                         f"Error retrieving Rexel access token: {description}"
                     )
-                raise InvalidTokenException(
-                    f"Error retrieving Rexel access token: {error}"
-                )
+                raise InvalidTokenError(f"Error retrieving Rexel access token: {error}")
 
             access_token = token.get("access_token")
             if not access_token:
-                raise InvalidTokenException("No Rexel access token provided.")
+                raise InvalidTokenError("No Rexel access token provided.")
 
             self._ensure_consent(access_token)
             self.context.access_token = cast(str, access_token)
@@ -411,9 +409,7 @@ def _ensure_consent(access_token: str) -> None:
         payload = _decode_jwt_payload(access_token)
         consent = payload.get("consent")
         if consent != REXEL_REQUIRED_CONSENT:
-            raise InvalidTokenException(
-                "Consent is missing or revoked for Rexel token."
-            )
+            raise InvalidTokenError("Consent is missing or revoked for Rexel token.")
 
 
 class BearerTokenAuthStrategy(BaseAuthStrategy):
@@ -442,12 +438,12 @@ def _decode_jwt_payload(token: str) -> dict[str, Any]:
     """Decode the payload of a JWT token."""
     parts = token.split(".")
     if len(parts) < 2:
-        raise InvalidTokenException("Malformed JWT received.")
+        raise InvalidTokenError("Malformed JWT received.")
 
     payload_segment = parts[1]
     padding = "=" * (-len(payload_segment) % 4)
     try:
         decoded = base64.urlsafe_b64decode(payload_segment + padding)
         return cast(dict[str, Any], json.loads(decoded))
     except (binascii.Error, json.JSONDecodeError) as error:
-        raise InvalidTokenException("Malformed JWT received.") from error
+        raise InvalidTokenError("Malformed JWT received.") from error

pyoverkiz/client.py

@@ -23,13 +23,13 @@
 from pyoverkiz.const import SUPPORTED_SERVERS
 from pyoverkiz.enums import APIType, CommandMode, Server
 from pyoverkiz.exceptions import (
-    ExecutionQueueFullException,
-    InvalidEventListenerIdException,
-    NoRegisteredEventListenerException,
-    NotAuthenticatedException,
-    OverkizException,
-    TooManyConcurrentRequestsException,
-    TooManyExecutionsException,
+    ExecutionQueueFullError,
+    InvalidEventListenerIdError,
+    NoRegisteredEventListenerError,
+    NotAuthenticatedError,
+    OverkizError,
+    TooManyConcurrentRequestsError,
+    TooManyExecutionsError,
 )
 from pyoverkiz.models import (
     Action,
@@ -74,7 +74,7 @@ async def refresh_listener(invocation: Details) -> None:
 # Reusable backoff decorators to reduce code duplication
 retry_on_auth_error = backoff.on_exception(
     backoff.expo,
-    (NotAuthenticatedException, ServerDisconnectedError),
+    (NotAuthenticatedError, ServerDisconnectedError),
     max_tries=2,
     on_backoff=relogin,
     logger=_LOGGER,
@@ -89,29 +89,29 @@ async def refresh_listener(invocation: Details) -> None:
 
 retry_on_concurrent_requests = backoff.on_exception(
     backoff.expo,
-    TooManyConcurrentRequestsException,
+    TooManyConcurrentRequestsError,
     max_tries=5,
     logger=_LOGGER,
 )
 
 retry_on_too_many_executions = backoff.on_exception(
     backoff.expo,
-    TooManyExecutionsException,
+    TooManyExecutionsError,
     max_tries=10,
     logger=_LOGGER,
 )
 
 retry_on_listener_error = backoff.on_exception(
     backoff.expo,
-    (InvalidEventListenerIdException, NoRegisteredEventListenerException),
+    (InvalidEventListenerIdError, NoRegisteredEventListenerError),
     max_tries=2,
     on_backoff=refresh_listener,
     logger=_LOGGER,
 )
 
 retry_on_execution_queue_full = backoff.on_exception(
     backoff.expo,
-    ExecutionQueueFullException,
+    ExecutionQueueFullError,
     max_tries=5,
     logger=_LOGGER,
 )
@@ -241,7 +241,7 @@ def _normalize_server(server: ServerConfig | Server | str) -> ServerConfig:
         try:
             return SUPPORTED_SERVERS[server_key]
         except KeyError as error:
-            raise OverkizException(
+            raise OverkizError(
                 f"Unknown server '{server_key}'. Provide a supported server key or ServerConfig instance."
             ) from error
 
@@ -629,7 +629,7 @@ async def get_setup_option_parameter(
 
         For example `developerMode-{gateway_id}` and `gatewayId` to understand if developer mode is on.
 
-        If the option is not available, an OverkizException will be thrown.
+        If the option is not available, an OverkizError will be thrown.
         If the parameter is not available you will receive None.
         """
         response = await self._get(f"setup/options/{option}/{parameter}")