Add @validate decorator to input validation functions

- Import `validate` from `_internal.decorators`.
- Apply `@validate` decorator to methods in `Application` and `Client` to enforce input validation.
- Replace `find_spec('pydantic')` with `USING_PYDANTIC` in conditional Pydantic imports.
- Add logic to log additional errors in `HTTPClient`.

Author: robert-nogueira

squarecloud/app.py

@@ -6,6 +6,7 @@
 
 from squarecloud import errors
 
+from ._internal.decorators import validate
 from .data import (
     AppData,
     Backup,
@@ -526,6 +527,7 @@ async def delete(self) -> Response:
         )
         return response
 
+    @validate
     async def commit(self, file: File) -> Response:
         """
         The commit function is used to commit the application.
@@ -541,6 +543,7 @@ async def commit(self, file: File) -> Response:
         )
         return response
 
+    @validate
     async def files_list(self, path: str) -> list[FileInfo]:
         """
         The files_list function returns a list of files and folders in the
@@ -558,6 +561,7 @@ async def files_list(self, path: str) -> list[FileInfo]:
         )
         return response
 
+    @validate
     async def read_file(self, path: str) -> BytesIO:
         """
         The read_file function reads the contents of a file from an app.
@@ -572,6 +576,7 @@ async def read_file(self, path: str) -> BytesIO:
         )
         return response
 
+    @validate
     async def create_file(self, file: File, path: str) -> Response:
 
         """
@@ -591,6 +596,7 @@ async def create_file(self, file: File, path: str) -> Response:
         )
         return response
 
+    @validate
     async def delete_file(self, path: str) -> Response:
         """
         The delete_file function deletes a file from the app.
@@ -620,6 +626,7 @@ async def last_deploys(self) -> list[list[DeployData]]:
         )
         return response
 
+    @validate
     async def github_integration(self, access_token: str) -> str:
         """
         The create_github_integration function returns a webhook to integrate
@@ -642,6 +649,7 @@ async def domain_analytics(self) -> DomainAnalytics:
         )
         return analytics
 
+    @validate
     async def set_custom_domain(self, custom_domain: str):
         response: Response = await self.client.set_custom_domain(
             self.id, custom_domain, avoid_listener=True
@@ -652,6 +660,7 @@ async def all_backups(self):
         backups: list[BackupInfo] = await self.client.all_app_backups(self.id)
         return backups
 
+    @validate
     async def move_file(self, origin: str, dest: str):
         return await self.client.move_app_file(self.id, origin, dest)
 

squarecloud/client.py

@@ -7,6 +7,7 @@
 
 from typing_extensions import deprecated
 
+from ._internal.decorators import validate
 from .app import Application
 from .data import (
     AppData,
@@ -253,6 +254,7 @@ async def get_logs(self, app_id: str, **_kwargs) -> LogsData:
 
         return logs_data
 
+    @validate
     @_notify_listener(Endpoint.app_status())
     async def app_status(self, app_id: str, **_kwargs) -> StatusData:
         """
@@ -274,6 +276,7 @@ async def app_status(self, app_id: str, **_kwargs) -> StatusData:
         payload: dict[str, Any] = response.response
         return StatusData(**payload)
 
+    @validate
     @_notify_listener(Endpoint.start())
     async def start_app(self, app_id: str, **_kwargs) -> Response:
         """
@@ -293,6 +296,7 @@ async def start_app(self, app_id: str, **_kwargs) -> Response:
         """
         return await self._http.start_application(app_id)
 
+    @validate
     @_notify_listener(Endpoint.stop())
     async def stop_app(self, app_id: str, **_kwargs) -> Response:
         """
@@ -312,6 +316,7 @@ async def stop_app(self, app_id: str, **_kwargs) -> Response:
         """
         return await self._http.stop_application(app_id)
 
+    @validate
     @_notify_listener(Endpoint.restart())
     async def restart_app(self, app_id: str, **_kwargs) -> Response:
         """
@@ -331,6 +336,7 @@ async def restart_app(self, app_id: str, **_kwargs) -> Response:
         """
         return await self._http.restart_application(app_id)
 
+    @validate
     @_notify_listener(Endpoint.backup())
     async def backup(self, app_id: str, **_kwargs) -> Backup:
         """
@@ -354,6 +360,7 @@ async def backup(self, app_id: str, **_kwargs) -> Backup:
 
     # async def app_backups(self) -> list[BackupInfo]:
 
+    @validate
     @_notify_listener(Endpoint.delete_app())
     async def delete_app(self, app_id: str, **_kwargs) -> Response:
         """
@@ -373,6 +380,7 @@ async def delete_app(self, app_id: str, **_kwargs) -> Response:
         """
         return await self._http.delete_application(app_id)
 
+    @validate
     @_notify_listener(Endpoint.commit())
     async def commit(self, app_id: str, file: File, **_kwargs) -> Response:
         """
@@ -393,6 +401,7 @@ async def commit(self, app_id: str, file: File, **_kwargs) -> Response:
         """
         return await self._http.commit(app_id, file)
 
+    @validate
     @_notify_listener(Endpoint.user())
     async def app(self, app_id: str, **_kwargs) -> Application:
         """
@@ -454,6 +463,7 @@ async def all_apps(self, **_kwargs) -> list[Application]:
             apps.append(Application(client=self, http=self._http, **data))
         return apps
 
+    @validate
     @_notify_listener(Endpoint.upload())
     async def upload_app(self, file: File, **_kwargs) -> UploadData:
         """
@@ -508,6 +518,7 @@ async def upload_app(self, file: File, **_kwargs) -> UploadData:
         payload: dict[str, Any] = response.response
         return UploadData(**payload)
 
+    @validate
     @_notify_listener(Endpoint.files_list())
     async def app_files_list(
         self, app_id: str, path: str, **_kwargs
@@ -538,6 +549,7 @@ async def app_files_list(
             for data in response.response
         ]
 
+    @validate
     @_notify_listener(Endpoint.files_read())
     async def read_app_file(
         self, app_id: str, path: str, **_kwargs
@@ -563,6 +575,7 @@ async def read_app_file(
         if response.response:
             return BytesIO(bytes(response.response.get('data')))
 
+    @validate
     @_notify_listener(Endpoint.files_create())
     async def create_app_file(
         self, app_id: str, file: File, path: str, **_kwargs
@@ -597,6 +610,7 @@ async def create_app_file(
 
         return response
 
+    @validate
     @_notify_listener(Endpoint.files_delete())
     async def delete_app_file(
         self, app_id: str, path: str, **_kwargs
@@ -620,6 +634,7 @@ async def delete_app_file(
         """
         return await self._http.file_delete(app_id, path)
 
+    @validate
     @_notify_listener(Endpoint.app_data())
     async def app_data(self, app_id: str, **_kwargs) -> AppData:
         """
@@ -640,6 +655,7 @@ async def app_data(self, app_id: str, **_kwargs) -> AppData:
         response: Response = await self._http.get_app_data(app_id)
         return AppData(**response.response)
 
+    @validate
     @_notify_listener(Endpoint.last_deploys())
     async def last_deploys(
         self, app_id: str, **_kwargs
@@ -664,6 +680,7 @@ async def last_deploys(
         data = response.response
         return [[DeployData(**deploy) for deploy in _] for _ in data]
 
+    @validate
     @_notify_listener(Endpoint.github_integration())
     async def github_integration(
         self, app_id: str, access_token: str, **_kwargs
@@ -692,6 +709,7 @@ async def github_integration(
         data = response.response
         return data.get('webhook')
 
+    @validate
     @_notify_listener(Endpoint.custom_domain())
     async def set_custom_domain(
         self, app_id: str, custom_domain: str, **_kwargs
@@ -717,6 +735,7 @@ async def set_custom_domain(
             app_id=app_id, custom_domain=custom_domain
         )
 
+    @validate
     @_notify_listener(Endpoint.domain_analytics())
     async def domain_analytics(
         self, app_id: str, **_kwargs
@@ -742,6 +761,7 @@ async def domain_analytics(
 
         return DomainAnalytics(**response.response)
 
+    @validate
     @_notify_listener(Endpoint.all_backups())
     async def all_app_backups(
         self, app_id: str, **_kwargs
@@ -760,6 +780,7 @@ async def all_apps_status(self, **_kwargs) -> list[ResumedStatus]:
                 all_status.append(ResumedStatus(**status))
         return all_status
 
+    @validate
     @_notify_listener(Endpoint.move_file())
     async def move_app_file(
         self, app_id: str, origin: str, dest: str, **_kwargs
@@ -769,11 +790,13 @@ async def move_app_file(
         )
         return response
 
+    @validate
     @_notify_listener(Endpoint.dns_records())
     async def dns_records(self, app_id: str) -> list[DNSRecord]:
         response: Response = await self._http.dns_records(app_id)
         return [DNSRecord(**data) for data in response.response]
 
+    @validate
     @_notify_listener(Endpoint.current_integration())
     async def current_app_integration(self, app_id: str) -> str | None:
         response: Response = await self._http.get_app_current_integration(

squarecloud/data.py

@@ -1,10 +1,11 @@
 from __future__ import annotations
 
 from datetime import datetime
-from importlib.util import find_spec
 from typing import Any, Dict, Literal, Optional
 
-if find_spec('pydantic'):
+from ._internal.constants import USING_PYDANTIC
+
+if USING_PYDANTIC:
     from pydantic.dataclasses import dataclass
 else:
     from dataclasses import dataclass

squarecloud/http/http_client.py

@@ -216,6 +216,7 @@ async def request(self, route: Router, **kwargs) -> Response | bytes:
                         log_level = logging.ERROR
                         error = TooManyRequests
                     case _:
+                        log_level = logging.ERROR
                         error = RequestError
 
                 if _ := _get_error(code):

squarecloud/listeners/__init__.py

@@ -1,11 +1,12 @@
 import inspect
 import types
 from dataclasses import dataclass
-from importlib.util import find_spec
 from types import MappingProxyType
 from typing import TYPE_CHECKING, Any, Callable, Optional, Type, Union
 
-if find_spec('pydantic'):
+from .._internal.constants import USING_PYDANTIC
+
+if USING_PYDANTIC:
     import pydantic
     from pydantic import BaseModel
 

squarecloud/listeners/capture_listener.py

@@ -1,14 +1,14 @@
 import inspect
 import logging
 import types
-from importlib.util import find_spec
 from typing import Any, Union
 
 from .. import data, errors
+from .._internal.constants import USING_PYDANTIC
 from ..http import Endpoint
 from . import Listener, ListenerManager
 
-if find_spec('pydantic'):
+if USING_PYDANTIC:
     import pydantic
 
 ListenerDataTypes = Union[

squarecloud/listeners/request_listener.py

@@ -1,10 +1,11 @@
 import inspect
 import logging
 import types
-from importlib.util import find_spec
 from typing import Any
 
-if using_pydantic := find_spec('pydantic'):
+from .._internal.constants import USING_PYDANTIC
+
+if USING_PYDANTIC:
     import pydantic
 
 from ..http import Endpoint, Response
@@ -39,7 +40,6 @@ async def notify(
         :param response: Response: Get the response from the endpoint
         :return: The result of the call function
         """
-        global using_pydantic
 
         def filter_annotations(annotations: list[Any]) -> Any:
             for item in annotations:
@@ -65,7 +65,7 @@ def filter_annotations(annotations: list[Any]) -> Any:
             call_extra_param is not None
             and annotation is not None
             and annotation != call_extra_param.empty
-            and using_pydantic
+            and USING_PYDANTIC
         ):
             annotation: Any = call_extra_param.annotation
             cast_result = self.cast_to_pydantic_model(annotation, extra)

squarecloud/utils.py

@@ -1,5 +1,7 @@
 from typing import Any, Literal
 
+from squarecloud._internal.decorators import validate
+
 
 class ConfigFile:
     """
@@ -8,6 +10,7 @@ class ConfigFile:
     https://docs.squarecloud.app/articles/how-to-create-your-squarecloud-configuration-file
     """
 
+    @validate
     def __init__(
         self,
         display_name: str,