Fix issue #29: Start using pydantic.dataclasses instead of simple dataclasses

Author: Ihor Bilous

examples/testing/projects.py

@@ -1,12 +1,11 @@
-from mailtrap import MailtrapApiClient
+from mailtrap import MailtrapClient
 from mailtrap.models.projects import Project
 
 API_TOKEN = "YOU_API_TOKEN"
 ACCOUNT_ID = "YOU_ACCOUNT_ID"
 
-client = MailtrapApiClient(token=API_TOKEN)
-testing_api = client.testing_api(ACCOUNT_ID)
-projects_api = testing_api.projects
+client = MailtrapClient(token=API_TOKEN, account_id=ACCOUNT_ID)
+projects_api = client.testing_api.projects
 
 
 def list_projects() -> list[Project]:

mailtrap/__init__.py

@@ -1,4 +1,3 @@
-from .client import MailtrapApiClient
 from .client import MailtrapClient
 from .exceptions import APIError
 from .exceptions import AuthorizationError

mailtrap/client.py

@@ -1,11 +1,12 @@
 from typing import NoReturn
 from typing import Optional
 from typing import Union
+from typing import cast
 
 import requests
 
 from mailtrap.api.testing import TestingApi
-from mailtrap.config import GENERAL_ENDPOINT
+from mailtrap.config import GENERAL_HOST
 from mailtrap.exceptions import APIError
 from mailtrap.exceptions import AuthorizationError
 from mailtrap.exceptions import ClientConfigurationError
@@ -26,17 +27,28 @@ def __init__(
         api_port: int = DEFAULT_PORT,
         bulk: bool = False,
         sandbox: bool = False,
+        account_id: Optional[str] = None,
         inbox_id: Optional[str] = None,
     ) -> None:
         self.token = token
         self.api_host = api_host
         self.api_port = api_port
         self.bulk = bulk
         self.sandbox = sandbox
+        self.account_id = account_id
         self.inbox_id = inbox_id
 
         self._validate_itself()
 
+    @property
+    def testing_api(self) -> TestingApi:
+        self._validate_account_id()
+        return TestingApi(
+            account_id=cast(str, self.account_id),
+            inbox_id=self.inbox_id,
+            client=HttpClient(host=GENERAL_HOST, headers=self.headers),
+        )
+
     def send(self, mail: BaseMail) -> dict[str, Union[bool, list[str]]]:
         response = requests.post(
             self.api_send_url, headers=self.headers, json=mail.api_data
@@ -102,21 +114,6 @@ def _validate_itself(self) -> None:
         if self.bulk and self.sandbox:
             raise ClientConfigurationError("bulk mode is not allowed in sandbox mode")
 
-
-class MailtrapApiClient:
-    def __init__(self, token: str) -> None:
-        self.token = token
-
-    def testing_api(self, account_id: str, inbox_id: Optional[str] = None) -> TestingApi:
-        http_client = HttpClient(host=GENERAL_ENDPOINT, headers=self.headers)
-        return TestingApi(account_id=account_id, inbox_id=inbox_id, client=http_client)
-
-    @property
-    def headers(self) -> dict[str, str]:
-        return {
-            "Authorization": f"Bearer {self.token}",
-            "Content-Type": "application/json",
-            "User-Agent": (
-                "mailtrap-python (https://github.com/railsware/mailtrap-python)"
-            ),
-        }
+    def _validate_account_id(self) -> None:
+        if not self.account_id:
+            raise ClientConfigurationError("`account_id` is required for Testing API")

mailtrap/config.py

@@ -1,3 +1,3 @@
-GENERAL_ENDPOINT = "mailtrap.io"
+GENERAL_HOST = "mailtrap.io"
 
 DEFAULT_REQUEST_TIMEOUT = 30  # in seconds

mailtrap/models/common.py

@@ -1,5 +1,6 @@
-from pydantic import BaseModel
+from pydantic.dataclasses import dataclass
 
 
-class DeletedObject(BaseModel):
+@dataclass
+class DeletedObject:
     id: int

mailtrap/models/inboxes.py

@@ -1,11 +1,12 @@
 from typing import Optional
 
-from pydantic import BaseModel
+from pydantic.dataclasses import dataclass
 
 from mailtrap.models.permissions import Permissions
 
 
-class Inbox(BaseModel):
+@dataclass
+class Inbox:
     id: int
     name: str
     username: str

mailtrap/models/permissions.py

@@ -1,7 +1,8 @@
-from pydantic import BaseModel
+from pydantic.dataclasses import dataclass
 
 
-class Permissions(BaseModel):
+@dataclass
+class Permissions:
     can_read: bool
     can_update: bool
     can_destroy: bool

mailtrap/models/projects.py

@@ -1,17 +1,21 @@
-from pydantic import BaseModel
+from typing import Optional
+
+from pydantic.dataclasses import dataclass
 
 from mailtrap.models.inboxes import Inbox
 from mailtrap.models.permissions import Permissions
 
 
-class ShareLinks(BaseModel):
+@dataclass
+class ShareLinks:
     admin: str
     viewer: str
 
 
-class Project(BaseModel):
+@dataclass
+class Project:
     id: int
     name: str
-    share_links: ShareLinks
     inboxes: list[Inbox]
     permissions: Permissions
+    share_links: Optional[ShareLinks] = None

pyproject.toml

@@ -17,10 +17,7 @@ classifiers = [
     "Programming Language :: Python :: 3.13",
 ]
 requires-python = ">=3.9"
-dependencies = [
-    "requests>=2.26.0",
-    "pydantic>=2.11.7",
-]
+dynamic = ["dependencies"]
 
 [project.urls]
 Homepage = "https://mailtrap.io/"
@@ -32,6 +29,9 @@ Repository = "https://github.com/railsware/mailtrap-python.git"
 requires = ["setuptools"]
 build-backend = "setuptools.build_meta"
 
+[tool.setuptools.dynamic]
+dependencies = {file = ["requirements.txt"]}
+
 [tool.isort]
 profile = "black"
 line_length = 90

tests/unit/api/test_projects.py

@@ -4,7 +4,7 @@
 import responses
 
 from mailtrap.api.resources.projects import ProjectsApi
-from mailtrap.config import GENERAL_ENDPOINT
+from mailtrap.config import GENERAL_HOST
 from mailtrap.exceptions import APIError
 from mailtrap.http import HttpClient
 from mailtrap.models.common import DeletedObject
@@ -13,12 +13,12 @@
 
 ACCOUNT_ID = "321"
 PROJECT_ID = 123
-BASE_PROJECTS_URL = f"https://{GENERAL_ENDPOINT}/api/accounts/{ACCOUNT_ID}/projects"
+BASE_PROJECTS_URL = f"https://{GENERAL_HOST}/api/accounts/{ACCOUNT_ID}/projects"
 
 
 @pytest.fixture
 def client() -> ProjectsApi:
-    return ProjectsApi(account_id=ACCOUNT_ID, client=HttpClient(GENERAL_ENDPOINT))
+    return ProjectsApi(account_id=ACCOUNT_ID, client=HttpClient(GENERAL_HOST))
 
 
 @pytest.fixture