♻️ Adaptations to make the installation of Pydantic optional

Author: robert-nogueira

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = 'squarecloud-api'
-version = '3.5.1'
+version = '3.6.2'
 description = 'SquareCloud API wrapper'
 authors = ['Robert Nogueira <robertlucasnogueira@gmail.com>']
 repository = 'https://github.com/squarecloudofc/wrapper-api-py'
@@ -12,8 +12,11 @@ packages = [{ include = 'squarecloud' }]
 [tool.poetry.dependencies]
 python = '^3.9'
 aiohttp = "3.9.5"
-pydantic = '^2.5.2'
 taskipy = "^1.13.0"
+pydantic = {version = "^2.8.2", optional = true}
+
+[tool.poetry.extras]
+pydantic = ["pydantic"]
 
 [tool.poetry.group.dev.dependencies]
 pytest = '^7.4.3'
@@ -26,6 +29,8 @@ ruff = '^0.0.289'
 memory-profiler = '^0.61.0'
 requests = '^2.31.0'
 pytest-rerunfailures = "^13.0"
+python-dotenv = "^1.0.1"
+rich = "^13.7.1"
 
 [build-system]
 requires = ['poetry-core']

squarecloud/__init__.py

@@ -21,4 +21,4 @@
 from .file import File
 from .http.endpoints import Endpoint
 
-__version__ = '3.5.1'
+__version__ = '3.6.2'

squarecloud/app.py

@@ -4,8 +4,6 @@
 from io import BytesIO
 from typing import TYPE_CHECKING, Any, Callable
 
-from pydantic import PositiveInt
-
 from squarecloud import errors
 
 from .data import (
@@ -170,7 +168,7 @@ def __init__(
         http: HTTPClient,
         id: str,
         name: str,
-        ram: PositiveInt,
+        ram: int,
         lang: str,
         cluster: str,
         domain: str | None,
@@ -203,7 +201,7 @@ def __init__(
         self._domain: str | None = domain
         self._custom: str | None = custom
         self._desc: str | None = desc
-        self._ram: PositiveInt = ram
+        self._ram: int = ram
         self._lang: str = lang
         self._cluster: str = cluster
         self._client: 'Client' = client

squarecloud/data.py

@@ -1,10 +1,13 @@
 from __future__ import annotations
 
 from datetime import datetime
+from importlib.util import find_spec
 from typing import Any, Dict, Literal, Optional
 
-from pydantic import confloat, conint
-from pydantic.dataclasses import dataclass
+if find_spec('pydantic'):
+    from pydantic.dataclasses import dataclass
+else:
+    from dataclasses import dataclass
 
 
 @dataclass(frozen=True)
@@ -67,9 +70,9 @@ class StatusData:
     running: bool
     storage: str
     network: Dict[str, Any]
-    requests: conint(ge=0)
-    uptime: conint(ge=0) | None = None
-    time: conint(ge=0) | None = None
+    requests: int
+    uptime: int | None = None
+    time: int | None = None
 
     def to_dict(self):
         return self.__dict__.copy()
@@ -107,7 +110,7 @@ class AppData:
     id: str
     name: str
     cluster: str
-    ram: confloat(ge=0)
+    ram: float
     language: Optional[str]
     cluster: str
     domain: str | None = None
@@ -128,13 +131,13 @@ class UserData:
     :ivar plan: User plan
     :ivar email: User email
 
-    :type id: conint(ge=0)
+    :type id: int
     :type name: str
     :type plan: PlanData
     :type email: str | None = None
     """
 
-    id: conint(ge=0)
+    id: int
     name: str
     plan: PlanData
     email: str | None = None
@@ -253,9 +256,9 @@ class UploadData:
     id: str
     name: str
     language: Language
-    ram: confloat(ge=0)
-    cpu: confloat(ge=0)
-    subdomain: str | None = None
+    ram: float
+    cpu: float
+    domain: str | None = None
     description: str | None = None
 
     def to_dict(self):
@@ -283,9 +286,9 @@ class FileInfo:
     app_id: str
     type: Literal['file', 'directory']
     name: str
-    lastModified: conint(ge=0) | float
+    lastModified: int | float
     path: str
-    size: confloat(ge=0.0) = 0.0
+    size: int = 0
 
     def to_dict(self):
         return self.__dict__.copy()
@@ -310,17 +313,33 @@ class AnalyticsTotal:
 
 @dataclass(frozen=True)
 class DomainAnalytics:
-    hostname: str
-    total: list[AnalyticsTotal]
-    countries: list[Any]
-    methods: list[Any]
-    referers: list[Any]
-    browsers: list[Any]
-    deviceTypes: list[Any]
-    operatingSystems: list[Any]
-    agents: list[Any]
-    hosts: list[Any]
-    paths: list[Any]
+    @dataclass(frozen=True)
+    class Analytics:
+        total: list[AnalyticsTotal]
+        countries: list[Any]
+        methods: list[Any]
+        referers: list[Any]
+        browsers: list[Any]
+        deviceTypes: list[Any]
+        operatingSystems: list[Any]
+        agents: list[Any]
+        hosts: list[Any]
+        paths: list[Any]
+
+        def to_dict(self):
+            return self.__dict__.copy()
+
+    @dataclass(frozen=True)
+    class Domain:
+        hostname: str
+        analytics: DomainAnalytics.Analytics | None
+
+    @dataclass(frozen=True)
+    class Custom:
+        analytics: DomainAnalytics.Analytics | None
+
+    domain: Domain
+    custom: Custom
 
     def to_dict(self):
         return self.__dict__.copy()

squarecloud/listeners/__init__.py

@@ -1,11 +1,13 @@
 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
 
-import pydantic
-from pydantic import BaseModel
+if find_spec('pydantic'):
+    import pydantic
+    from pydantic import BaseModel
 
 from .. import data, errors
 from ..http.endpoints import Endpoint
@@ -137,9 +139,9 @@ def clear_listeners(self) -> None:
 
     @classmethod
     def cast_to_pydantic_model(
-        cls, model: Type[BaseModel], values: dict[Any, Any]
+        cls, model: Type['BaseModel'], values: dict[Any, Any]
     ):
-        result: BaseModel | None | dict = values
+        result: 'BaseModel' | None | dict = values
         if isinstance(model, types.UnionType):
             for ty in model.__args__:
                 if ty is None:

squarecloud/listeners/capture_listener.py

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

squarecloud/listeners/request_listener.py

@@ -1,9 +1,11 @@
 import inspect
 import logging
 import types
+from importlib.util import find_spec
 from typing import Any
 
-import pydantic
+if using_pydantic := find_spec('pydantic'):
+    import pydantic
 
 from ..http import Endpoint, Response
 from . import ListenerManager
@@ -37,6 +39,7 @@ 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:
@@ -62,6 +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
         ):
             annotation: Any = call_extra_param.annotation
             cast_result = self.cast_to_pydantic_model(annotation, extra)

tests/test_capture_listeners.py

@@ -1,5 +1,9 @@
+from importlib.util import find_spec
+
 import pytest
-from pydantic import BaseModel
+
+if using_pydantic := find_spec('pydantic'):
+    from pydantic import BaseModel
 
 from squarecloud import Endpoint, errors
 from squarecloud.app import Application
@@ -127,6 +131,9 @@ def callback_two():
         assert listener.callback is callback_two
         assert listener.endpoint == Endpoint.app_status()
 
+    @pytest.mark.skipif(
+        'not using_pydantic', reason='pydantic not installed'
+    )
     @_clear_listener_on_rerun(endpoint=Endpoint.app_status())
     async def test_pydantic_cast(self, app: Application):
         class Person(BaseModel):

tests/test_files.py

@@ -18,7 +18,7 @@ async def test_files_type(self, app_files: list[FileInfo]):
             assert isinstance(file, FileInfo)
 
             assert isinstance(file.name, str)
-            assert isinstance(file.size, float)
+            assert isinstance(file.size, int)
             assert isinstance(file.lastModified, int | float)
 
             assert file.type in ('file', 'directory')
@@ -52,7 +52,7 @@ async def test_files_list(
             assert isinstance(file, FileInfo)
 
             assert isinstance(file.name, str)
-            assert isinstance(file.size, float)
+            assert isinstance(file.size, int)
             assert isinstance(file.lastModified, int | float)
 
             assert file.type in ('file', 'directory')

tests/test_request_listeners.py

@@ -1,7 +1,11 @@
+import sys
+from importlib.util import find_spec
 from io import BytesIO
 
 import pytest
-from pydantic import BaseModel
+
+if using_pydantic := bool(find_spec('pydantic')):
+    from pydantic import BaseModel
 
 from squarecloud import Client, Endpoint, File
 from squarecloud.app import Application
@@ -395,6 +399,9 @@ async def test_listener(response: Response):
         assert isinstance(expected_result, str)
         assert isinstance(expected_response, Response)
 
+    @pytest.mark.skipif(
+        'not using_pydantic', reason='pydantic not installed'
+    )
     @_clear_listener_on_rerun(endpoint=Endpoint.app_status())
     async def test_pydantic_cast(self, client: Client, app: Application):
         class Person(BaseModel):