♻️ refactor: Split ListenerManager into CaptureListenerManager and RequestListenerManager

Author: robert-nogueira

squarecloud/app.py

@@ -8,7 +8,7 @@
 from .errors import SquareException
 from .file import File
 from .http import Endpoint, HTTPClient, Response
-from .listener import Listener, ListenerManager
+from .listeners import CaptureListenerManager
 
 # avoid circular imports
 if TYPE_CHECKING:
@@ -199,7 +199,7 @@ def __init__(
         self._isWebsite: bool = isWebsite
         self._client: 'Client' = client
         self._http: HTTPClient = http
-        self._listener: ListenerManager = Listener
+        self._listener: CaptureListenerManager = CaptureListenerManager()
         self.cache: AppCache = AppCache()
 
     def __repr__(self) -> str:

squarecloud/client.py

@@ -4,7 +4,7 @@
 import logging
 from abc import ABC, abstractmethod
 from io import BytesIO
-from typing import Any, Callable, List, Literal
+from typing import Any, Callable, List, Literal, TextIO
 
 from .app import Application
 from .data import (
@@ -21,15 +21,8 @@
 from .file import File
 from .http import HTTPClient, Response
 from .http.endpoints import Endpoint
-from .listener import Listener, ListenerManager
+from .listeners import RequestListenerManager
 from .logs import logger
-from .payloads import (
-    BackupPayload,
-    LogsPayload,
-    StatusPayload,
-    UploadPayload,
-    UserPayload,
-)
 
 
 class AbstractClient(ABC):
@@ -52,7 +45,7 @@ def create_config_file(
     start: str | None = None,
     auto_restart: bool = False,
     **kwargs,
-) -> str:
+) -> TextIO | str:
     """
     The create_config_file function creates a squarecloud.app file in the
     specified path, with the given parameters.
@@ -124,7 +117,7 @@ def __init__(self, api_key: str, debug: bool = True) -> None:
         self.debug = debug
         self._api_key = api_key
         self._http = HTTPClient(api_key=api_key)
-        self._listener: ListenerManager = Listener
+        self._listener: RequestListenerManager = RequestListenerManager()
         if self.debug:
             logger.setLevel(logging.DEBUG)
 
@@ -180,7 +173,7 @@ async def me(self, **kwargs) -> UserData:
         :return: A userdata object
         """
         response: Response = await self._http.fetch_user_info()
-        payload: UserPayload = response.response
+        payload: dict[str, Any] = response.response
         user_data: UserData = UserData(**payload['user'])
         if not kwargs.get('avoid_listener'):
             endpoint: Endpoint = response.route.endpoint
@@ -202,7 +195,7 @@ async def user_info(
         :return: A UserData object
         """
         response: Response = await self._http.fetch_user_info(user_id=user_id)
-        payload: UserPayload = response.response
+        payload: dict[str, Any] = response.response
         user_data: UserData = UserData(**payload['user'])
         if not kwargs.get('avoid_listener'):
             endpoint: Endpoint = response.route.endpoint
@@ -224,7 +217,7 @@ async def get_logs(self, app_id: str, **kwargs) -> LogsData:
         response: Response | None = await self._http.fetch_logs(app_id)
         if response.code is None:
             return LogsData()
-        payload: LogsPayload = response.response
+        payload: dict[str, Any] = response.response
         logs_data: LogsData = LogsData(**payload)
         if not kwargs.get('avoid_listener'):
             endpoint: Endpoint = response.route.endpoint
@@ -243,7 +236,7 @@ async def app_status(self, app_id: str, **kwargs) -> StatusData:
         :return: A StatusData object
         """
         response: Response = await self._http.fetch_app_status(app_id)
-        payload: StatusPayload = response.response
+        payload: dict[str, Any] = response.response
         status: StatusData = StatusData(**payload)
         if not kwargs.get('avoid_listener'):
             endpoint: Endpoint = response.route.endpoint
@@ -315,7 +308,7 @@ async def backup(self, app_id: str, **kwargs) -> BackupData:
         :return: A BackupData object
         """
         response: Response = await self._http.backup(app_id)
-        payload: BackupPayload = response.response
+        payload: dict[str, Any] = response.response
         backup: BackupData = BackupData(**payload)
         if not kwargs.get('avoid_listener'):
             endpoint: Endpoint = response.route.endpoint
@@ -445,7 +438,7 @@ async def upload_app(self, file: File, **kwargs) -> UploadData:
             await self._listener.on_request(
                 endpoint=endpoint, response=response
             )
-        payload: UploadPayload = response.response
+        payload: dict[str, Any] = response.response
         app: UploadData = UploadData(**payload)
         endpoint: Endpoint = response.route.endpoint
         await self._listener.on_request(endpoint=endpoint, response=response)

squarecloud/http/http_client.py

@@ -26,14 +26,13 @@
     TooManyRequests,
 )
 from ..logs import logger
-from ..payloads import RawResponseData
 from .endpoints import Endpoint, Router
 
 
 class Response:
     """Represents a request response"""
 
-    def __init__(self, data: RawResponseData, route: Router) -> None:
+    def __init__(self, data: dict[str, Any], route: Router) -> None:
         """
         The __init__ function is called when the class is instantiated.
         It sets up the instance of the class, and defines all of its
@@ -127,7 +126,7 @@ async def request(self, route: Router, **kwargs) -> Response | bytes:
                 url=route.url, method=route.method, **kwargs
             ) as resp:
                 status_code = resp.status
-                data: RawResponseData = await resp.json()
+                data: dict[str, Any] = await resp.json()
                 extra = {
                     'status': data.get('status'),
                     'route': route.url,

squarecloud/listener.py squarecloud/listeners.pysquarecloud/listener.py renamed to squarecloud/listeners.py

@@ -5,8 +5,8 @@
 from .http.endpoints import Endpoint
 
 
-class ListenerManager:
-    """ListenerManager"""
+class CaptureListenerManager:
+    """CaptureListenerManager"""
 
     def __init__(self):
         """
@@ -19,7 +19,6 @@ def __init__(self):
         :return: A dictionary of the capture listeners and request listeners
         """
         self.capture_listeners: dict[str, Callable] = {}
-        self.request_listeners: dict[str, Callable] = {}
 
     def get_capture_listener(self, endpoint: Endpoint) -> Callable:
         """
@@ -72,6 +71,39 @@ def clear_capture_listeners(self) -> None:
         """
         self.capture_listeners = None
 
+    async def on_capture(self, endpoint: Endpoint, **kwargs) -> Any:
+        """
+        The on_capture function is called when a capture event occurs.
+
+        :param self: Refer to the class instance
+        :param endpoint: Endpoint: Get the endpoint that is being called
+        :param kwargs: Pass a dictionary of arguments to the function
+        :return: The result of the call function
+        """
+        call: Callable = self.get_capture_listener(endpoint)
+        if not call:
+            return
+        is_coro: bool = asyncio.iscoroutinefunction(call)
+        if is_coro:
+            return await call(**kwargs)
+        return call(**kwargs)
+
+
+class RequestListenerManager:
+    """CaptureListenerManager"""
+
+    def __init__(self):
+        """
+        The __init__ function is called when the class is instantiated.
+        It sets up the instance variables that will be used by other methods
+        in the class.
+
+
+        :param self: Refer to the class instance
+        :return: A dictionary of the capture listeners and request listeners
+        """
+        self.request_listeners: dict[str, Callable] = {}
+
     def get_request_listener(self, endpoint: Endpoint) -> Callable:
         """
         The get_request_listener function is a helper function that returns
@@ -120,24 +152,7 @@ def clear_request_listeners(self) -> None:
         :param self: Refer to the class instance
         :return: None
         """
-        self.capture_listeners = None
-
-    async def on_capture(self, endpoint: Endpoint, **kwargs) -> Any:
-        """
-        The on_capture function is called when a capture event occurs.
-
-        :param self: Refer to the class instance
-        :param endpoint: Endpoint: Get the endpoint that is being called
-        :param kwargs: Pass a dictionary of arguments to the function
-        :return: The result of the call function
-        """
-        call: Callable = self.get_capture_listener(endpoint)
-        if not call:
-            return
-        is_coro: bool = asyncio.iscoroutinefunction(call)
-        if is_coro:
-            return await call(**kwargs)
-        return call(**kwargs)
+        # self.capture_listeners = None
 
     async def on_request(self, endpoint: Endpoint, response: Response) -> Any:
         """
@@ -156,6 +171,3 @@ async def on_request(self, endpoint: Endpoint, response: Response) -> Any:
         if asyncio.iscoroutinefunction(call):
             return await call(response=response)
         return call(response=response)
-
-
-Listener = ListenerManager()