refactor: Refactor all exceptions (#857)

* refactor: change the library's error handling

* ci: fix

* ok that didn't work out well

* ok that didn't work out well

* Update request.py

* ci: correct from checks.

* Update interactions/api/models/misc.py

Co-authored-by: Toricane <73972068+Toricane@users.noreply.github.com>

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Toricane <73972068+Toricane@users.noreply.github.com>

Author: 3 people

interactions/api/error.py

@@ -7,6 +7,11 @@
 
 
 class LibraryException(Exception):
+    """
+    A class object representing all errors.
+    If you want more information on what a specific code means, use `e.lookup(code)`
+    """
+
     code: Optional[int]
     severity: int
 
@@ -33,11 +38,11 @@ def _inner(v, parent):
                 else:
                     for k, v in v.items():
                         if isinstance(v, dict):
-                            _inner(v, parent + "." + k)
+                            _inner(v, f"{parent}.{k}")
                         elif isinstance(v, list):
                             for e in v:
                                 if isinstance(e, dict):
-                                    _errors.append((e["code"], e["message"], parent + "." + k))
+                                    _errors.append((e["code"], e["message"], f"{parent}.{k}"))
             elif isinstance(v, list) and parent == "_errors":
                 for e in v:
                     _errors.append((e["code"], e["message"], parent))
@@ -84,6 +89,8 @@ def lookup(code: int) -> str:
             9: "Incorrect data was passed to a slash command data object.",
             10: "The interaction was already responded to.",
             11: "Error creating your command.",
+            12: "Invalid set of arguments specified.",
+            13: "No HTTPClient set!",
             # HTTP errors
             400: "Bad Request. The request was improperly formatted, or the server couldn't understand it.",
             401: "Not authorized. Double check your token to see if it's valid.",
@@ -276,9 +283,15 @@ def __init__(self, message: str = None, code: int = 0, severity: int = 0, **kwar
         ):
             _fmt_error: List[tuple] = self._parse(self.data["errors"])
 
-        super().__init__(
-            f"{self.message} (code: {self.code}, severity {self.severity})\n"
-            + "\n".join([f"Error at {e[2]}: {e[0]} - {e[1]}" for e in _fmt_error])
-            if _fmt_error
-            else None
-        )
+        self.log(self.message)
+
+        if _fmt_error:
+            super().__init__(
+                f"{self.message} (code: {self.code}, severity {self.severity})\n"
+                + "\n".join([f"Error at {e[2]}: {e[0]} - {e[1]}" for e in _fmt_error])
+            )
+        else:
+            super().__init__(
+                f"An error occurred:\n"
+                f"{self.message}, with code '{self.code}' and severity '{self.severity}'"
+            )

interactions/api/error.pyi

@@ -4,11 +4,11 @@ class LibraryException(Exception):
     message: Optional[str]
     code: Optional[int]
     severity: Optional[int]
+    data: Optional[dict]
 
+    def __init__(self, message: str = None, code: int = 0, severity: int = 0, **kwargs): ...
     @staticmethod
     def _parse(_data: dict) -> List[tuple]: ...
-
     def log(self, message: str, *args) -> None: ...
-
     @staticmethod
     def lookup(code: int) -> str: ...

interactions/api/http/channel.py

@@ -1,6 +1,7 @@
 from typing import Dict, List, Optional, Union
 
 from ...api.cache import Cache, Item
+from ..error import LibraryException
 from ..models.channel import Channel
 from ..models.message import Message
 from .request import _Request
@@ -75,8 +76,9 @@ async def get_channel_messages(
             params["around"] = around
 
         if params_used > 1:
-            raise ValueError(
-                "`before`, `after` and `around` are mutually exclusive. Please pass only one of them."
+            raise LibraryException(
+                message="`before`, `after` and `around` are mutually exclusive. Please pass only one of them.",
+                code=12,
             )
 
         request = await self._req.request(

interactions/api/http/request.py

@@ -1,6 +1,7 @@
 import asyncio
 import traceback
 from asyncio import AbstractEventLoop, Lock, get_event_loop, get_running_loop, new_event_loop
+from contextlib import suppress
 from json import dumps
 from logging import Logger
 from sys import version_info
@@ -162,7 +163,6 @@ async def request(self, route: Route, **kwargs) -> Optional[Any]:
                     if _bucket is not None:
                         self.buckets[route.endpoint] = _bucket
                         # real-time replacement/update/add if needed.
-
                     if isinstance(data, dict) and (
                         data.get("errors") or (data.get("code") and data.get("code") != 429)
                     ):
@@ -171,8 +171,19 @@ async def request(self, route: Route, **kwargs) -> Optional[Any]:
                         )
                         # This "redundant" debug line is for debug use and tracing back the error codes.
 
-                        raise LibraryException(message=data["message"], code=data["code"])
+                        raise LibraryException(
+                            message=data["message"], code=data["code"], severity=40, data=data
+                        )
+                    elif isinstance(data, dict) and data.get("code") == 0 and data.get("message"):
+                        log.debug(
+                            f"RETURN {response.status}: {dumps(data, indent=4, sort_keys=True)}"
+                        )
+                        # This "redundant" debug line is for debug use and tracing back the error codes.
 
+                        raise LibraryException(
+                            message=f"'{data['message']}'. Make sure that your token is set properly.",
+                            severity=50,
+                        )
                     if response.status == 429:
                         if not is_global:
                             log.warning(
@@ -206,18 +217,16 @@ async def request(self, route: Route, **kwargs) -> Optional[Any]:
                 if tries < 4 and e.errno in (54, 10054):
                     await asyncio.sleep(2 * tries + 1)
                     continue
-                try:
+                with suppress(RuntimeError):
                     _limiter.lock.release()
-                except RuntimeError:
-                    pass
                 raise
 
             # For generic exceptions we give a traceback for debug reasons.
             except Exception as e:
-                try:
+                with suppress(RuntimeError):
                     _limiter.lock.release()
-                except RuntimeError:
-                    pass
+                if isinstance(e, LibraryException):
+                    raise
                 log.error("".join(traceback.format_exception(type(e), e, e.__traceback__)))
                 break
 

interactions/api/models/channel.py

@@ -2,6 +2,7 @@
 from enum import IntEnum
 from typing import Any, Callable, List, Optional, Union
 
+from ..error import LibraryException
 from .attrs_utils import (
     MISSING,
     ClientSerializerMixin,
@@ -210,7 +211,7 @@ async def send(
         :rtype: Message
         """
         if not self._client:
-            raise AttributeError("HTTPClient not found!")
+            raise LibraryException(code=13)
         from ...client.models.component import _build_components
         from .message import Message
 
@@ -264,7 +265,7 @@ async def delete(self) -> None:
         Deletes the channel.
         """
         if not self._client:
-            raise AttributeError("HTTPClient not found!")
+            raise LibraryException(code=13)
         await self._client.delete_channel(channel_id=int(self.id))
 
     async def modify(
@@ -319,7 +320,7 @@ async def modify(
         :rtype: Channel
         """
         if not self._client:
-            raise AttributeError("HTTPClient not found!")
+            raise LibraryException(code=13)
         _name = self.name if name is MISSING else name
         _topic = self.topic if topic is MISSING else topic
         _bitrate = self.bitrate if bitrate is MISSING else bitrate
@@ -359,7 +360,7 @@ async def modify(
         if (
             archived is not MISSING or auto_archive_duration is not MISSING or locked is not MISSING
         ) and not self.thread_metadata:
-            raise ValueError("The specified channel is not a Thread!")
+            raise LibraryException(message="The specified channel is not a Thread!", code=12)
 
         if archived is not MISSING:
             payload["archived"] = archived
@@ -434,7 +435,7 @@ async def set_bitrate(
         """
 
         if self.type != ChannelType.GUILD_VOICE:
-            raise TypeError("Bitrate is only available for VoiceChannels")
+            raise LibraryException(message="Bitrate is only available for VoiceChannels", code=12)
 
         return await self.modify(bitrate=bitrate, reason=reason)
 
@@ -456,7 +457,9 @@ async def set_user_limit(
         """
 
         if self.type != ChannelType.GUILD_VOICE:
-            raise TypeError("user_limit is only available for VoiceChannels")
+            raise LibraryException(
+                message="user_limit is only available for VoiceChannels", code=12
+            )
 
         return await self.modify(user_limit=user_limit, reason=reason)
 
@@ -604,11 +607,9 @@ async def add_member(
         :type member_id: int
         """
         if not self._client:
-            raise AttributeError("HTTPClient not found!")
+            raise LibraryException(code=13)
         if not self.thread_metadata:
-            raise TypeError(
-                "The Channel you specified is not a thread!"
-            )  # TODO: Move to new error formatter.
+            raise LibraryException(message="The Channel you specified is not a thread!", code=12)
 
         _member_id = (
             int(member_id) if isinstance(member_id, (int, Snowflake)) else int(member_id.id)
@@ -627,7 +628,7 @@ async def pin_message(
         :type message_id: Union[int, Snowflake, "Message"]
         """
         if not self._client:
-            raise AttributeError("HTTPClient not found!")
+            raise LibraryException(code=13)
 
         _message_id = (
             int(message_id) if isinstance(message_id, (int, Snowflake)) else int(message_id.id)
@@ -646,7 +647,7 @@ async def unpin_message(
         :type message_id: Union[int, Snowflake, "Message"]
         """
         if not self._client:
-            raise AttributeError("HTTPClient not found!")
+            raise LibraryException(code=13)
 
         _message_id = (
             int(message_id) if isinstance(message_id, (int, Snowflake)) else int(message_id.id)
@@ -666,7 +667,7 @@ async def publish_message(
         :rtype: Message
         """
         if not self._client:
-            raise AttributeError("HTTPClient not found!")
+            raise LibraryException(code=13)
         from .message import Message
 
         _message_id = (
@@ -685,7 +686,7 @@ async def get_pinned_messages(self) -> List["Message"]:  # noqa
         :rtype: List[Message]
         """
         if not self._client:
-            raise AttributeError("HTTPClient not found!")
+            raise LibraryException(code=13)
         from .message import Message
 
         res = await self._client.get_pinned_messages(int(self.id))
@@ -744,7 +745,7 @@ def check_pinned(message):
         :rtype: List[Message]
         """
         if not self._client:
-            raise AttributeError("HTTPClient not found!")
+            raise LibraryException(code=13)
         from .message import Message
 
         _before = None if before is MISSING else before
@@ -942,13 +943,13 @@ async def create_thread(
         :rtype: Channel
         """
         if not self._client:
-            raise AttributeError("HTTPClient not found!")
+            raise LibraryException(code=13)
         if type not in [
             ChannelType.GUILD_NEWS_THREAD,
             ChannelType.GUILD_PUBLIC_THREAD,
             ChannelType.GUILD_PRIVATE_THREAD,
         ]:
-            raise AttributeError("type must be a thread type!")
+            raise LibraryException(message="type must be a thread type!", code=12)
 
         _auto_archive_duration = None if auto_archive_duration is MISSING else auto_archive_duration
         _invitable = None if invitable is MISSING else invitable
@@ -1009,7 +1010,7 @@ async def create_invite(
         """
 
         if not self._client:
-            raise AttributeError("HTTPClient not found!")
+            raise LibraryException(code=13)
 
         payload = {
             "max_age": max_age,
@@ -1021,16 +1022,17 @@ async def create_invite(
         if (target_user_id is not MISSING and target_user_id) and (
             target_application_id is not MISSING and target_application_id
         ):
-            raise ValueError(
-                "target user id and target application are mutually exclusive!"
-            )  # TODO: move to custom error formatter
+            raise LibraryException(
+                message="target user id and target application are mutually exclusive!", code=12
+            )
 
         elif (
             (target_user_id is not MISSING and target_user_id)
             or (target_application_id is not MISSING and target_application_id)
         ) and not target_type:
-            raise ValueError(
-                "you have to specify a target_type if you specify target_user-/target_application_id"
+            raise LibraryException(
+                message="you have to specify a target_type if you specify target_user-/target_application_id",
+                code=12,
             )
 
         if target_user_id is not MISSING:
@@ -1066,7 +1068,7 @@ async def get_history(self, limit: int = 100) -> Optional[List["Message"]]:  # n
         """
 
         if not self._client:
-            raise AttributeError("HTTPClient not found!")
+            raise LibraryException(code=13)
 
         from .message import Message
 
@@ -1115,7 +1117,7 @@ async def get_webhooks(self) -> List[Webhook]:
         """
 
         if not self._client:
-            raise AttributeError("HTTPClient not found!")
+            raise LibraryException(code=13)
 
         res = await self._client.get_channel_webhooks(int(self.id))
         return [Webhook(**_, _client=self._client) for _ in res]