♻️ refactor: Refactored error handling for improved readability and consistency.

Author: robert-nogueira

squarecloud/cli/main.py

@@ -11,7 +11,7 @@
 from squarecloud.client import Client, create_config_file
 from squarecloud.data import StatisticsData
 
-from .. import ApplicationNotFound, RequestError, SquareException
+from ..errors import RequestError, SquareException
 from . import cli, run_async
 from .app import app_list, upload_app
 from .files import app_group

squarecloud/errors.py

@@ -1,3 +1,6 @@
+from .file import File
+
+
 class SquareException(BaseException):
     """abstract class SquareException"""
 
@@ -11,7 +14,9 @@ def __str__(self):
 class RequestError(SquareException):
     """raised when a request fails"""
 
-    def __init__(self, route: str, status_code: int, code: str):
+    def __init__(
+        self, route: str, status_code: int, code: str, *args, **kwargs
+    ):
         self.route = route
         self.status = status_code
         self.code = code
@@ -102,3 +107,93 @@ class BadMemory(RequestError):
     def __init__(self, *args, **kwargs):
         super().__init__(*args, **kwargs)
         self.message = 'No memory available'
+
+
+class InvalidConfig(RequestError):
+    """
+    raised when the config file is corrupt or invalid.
+    """
+
+    def __init__(self, file: File, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        self.message = f'{file.filename} have a invalid config file'
+
+
+class InvalidDisplayName(InvalidConfig):
+    """
+    raised when the display name in the config file is invalid.
+    """
+
+    def __init__(self, file: File, *args, **kwargs):
+        super().__init__(file=file, *args, **kwargs)
+        self.message = 'Invalid display name in config file'
+
+
+class MissingDisplayName(InvalidConfig):
+    """
+    raised when the display name in the config file is missing.
+    """
+
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        self.message = 'Display name is missing in the config file'
+
+
+class InvalidMain(InvalidConfig):
+    """
+    raised when the main file in the config file is invalid.
+    """
+
+    def __init__(self, file: File, *args, **kwargs):
+        super().__init__(file=file, *args, **kwargs)
+        self.message = 'Invalid main file in config file'
+
+
+class MissingMainFile(InvalidConfig):
+    """
+    raised when the main file in the config file is missing.
+    """
+
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        self.message = 'Main file is missing in the config file'
+
+
+class InvalidMemory(InvalidConfig):
+    """
+    raised when the memory value in the config file is invalid.
+    """
+
+    def __init__(self, file: File, *args, **kwargs):
+        super().__init__(file=file, *args, **kwargs)
+        self.message = 'Invalid memory value in config file'
+
+
+class MissingMemory(InvalidConfig):
+    """
+    raised when the memory value in the config file is missing.
+    """
+
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        self.message = 'Memory value is missing in the config file'
+
+
+class InvalidVersion(InvalidConfig):
+    """
+    raised when the version value in the config file is invalid.
+    """
+
+    def __init__(self, file: File, *args, **kwargs):
+        super().__init__(file=file, *args, **kwargs)
+        self.message = 'Invalid version value in config file'
+
+
+class MissingVersion(InvalidConfig):
+    """
+    raised when the version value in the config file is missing.
+    """
+
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        self.message = 'Version value is missing in the config file'

squarecloud/http/http_client.py

@@ -11,8 +11,16 @@
     BadMemory,
     BadRequestError,
     FewMemory,
+    InvalidDisplayName,
+    InvalidMain,
+    InvalidMemory,
+    InvalidVersion,
     MissingConfigFile,
     MissingDependenciesFile,
+    MissingDisplayName,
+    MissingMainFile,
+    MissingMemory,
+    MissingVersion,
     NotFoundError,
     RequestError,
     TooManyRequests,
@@ -57,12 +65,20 @@ def __repr__(self):
         return f'{Response.__name__}({self.data})'
 
 
-def get_upload_error(code: str) -> Type[RequestError]:
+def _get_upload_error(code: str) -> type[RequestError]:
     errors = {
         'FEW_MEMORY': FewMemory,
         'BAD_MEMORY': BadMemory,
-        'MISSING_CONFIG_FILE': MissingConfigFile,
+        'MISSING_CONFIG': MissingConfigFile,
         'MISSING_DEPENDENCIES_FILE': MissingDependenciesFile,
+        'MISSING_MAIN': MissingMainFile,
+        'INVALID_MAIN': InvalidMain,
+        'INVALID_DISPLAY_NAME': InvalidDisplayName,
+        'MISSING_DISPLAY_NAME': MissingDisplayName,
+        'INVALID_MEMORY': InvalidMemory,
+        'MISSING_MEMORY': MissingMemory,
+        'INVALID_VERSION': InvalidVersion,
+        'MISSING_VERSION': MissingVersion,
     }
     error_class = errors.get(code, None)
     if error_class is None:
@@ -98,9 +114,11 @@ async def request(self, route: Router, **kwargs) -> Response | bytes:
             RawResponseData
         """
         headers = {'Authorization': self.api_key}
+        extra_error_kwargs: dict[str, Any] = {}
 
         if route.endpoint in (Endpoint.commit(), Endpoint.upload()):
             file = kwargs.pop('file')
+            extra_error_kwargs['file'] = file
             form = aiohttp.FormData()
             form.add_field('file', file.bytes, filename=file.filename)
             kwargs['data'] = form
@@ -118,10 +136,16 @@ async def request(self, route: Router, **kwargs) -> Response | bytes:
                 }
                 code: str | None = data.get('code')
                 error: Type[RequestError] | None = None
+
                 if status_code == 200:
                     logger.debug(msg='request to route: ', extra=extra)
-                    if code and route.endpoint == Endpoint.upload():
-                        error = get_upload_error(code)
+                    if code and route.endpoint in (
+                        Endpoint.commit(),
+                        Endpoint.upload(),
+                    ):
+                        error = _get_upload_error(
+                            code,
+                        )
                     extra.pop('code')
                     response: Response = Response(data=data, route=route)
                 elif status_code == 404:
@@ -144,6 +168,7 @@ async def request(self, route: Router, **kwargs) -> Response | bytes:
                     error = RequestError
                 if error:
                     raise error(
+                        **extra_error_kwargs,
                         route=route.endpoint.name,
                         status_code=status_code,
                         code=code,