Merge pull request #270 from Haidra-Org/main

fix; use a default certifi based ssl context

.github/workflows/maintests.yml

@@ -37,9 +37,5 @@ jobs:
         run: |
           python -m pip install --upgrade pip
           pip install --upgrade -r requirements.dev.txt
-      - name: Run pre-commit
-        uses: pre-commit/[email protected]
-        with:
-          extra_args: --all-files
       - name: Run unit tests
         run: tox -e tests-no-api-calls

.github/workflows/prtests.yml

@@ -42,9 +42,5 @@ jobs:
         run: |
           python -m pip install --upgrade pip
           pip install --upgrade -r requirements.dev.txt
-      - name: Run pre-commit
-        uses: pre-commit/[email protected]
-        with:
-          extra_args: --all-files
       - name: Run unit tests
         run: tox -e tests-no-api-calls

horde_sdk/ai_horde_api/ai_horde_clients.py

@@ -10,6 +10,7 @@
 import urllib.parse
 from abc import ABC, abstractmethod
 from collections.abc import Callable, Coroutine
+from ssl import SSLContext
 from typing import cast
 
 import aiohttp
@@ -78,6 +79,7 @@
     GenericAsyncHordeAPISession,
     GenericHordeAPIManualClient,
     GenericHordeAPISession,
+    _default_sslcontext,
 )
 
 
@@ -291,12 +293,18 @@ def delete_pending_image(
 class AIHordeAPIAsyncManualClient(GenericAsyncHordeAPIManualClient, BaseAIHordeClient):
     """An asyncio based API client specifically configured for the AI-Horde API."""
 
-    def __init__(self, aiohttp_session: aiohttp.ClientSession) -> None:
+    def __init__(
+        self,
+        aiohttp_session: aiohttp.ClientSession,
+        *,
+        ssl_context: SSLContext = _default_sslcontext,
+    ) -> None:
         """Create a new instance of the RatingsAPIClient."""
         super().__init__(
             aiohttp_session=aiohttp_session,
             path_fields=AIHordePathData,
             query_fields=AIHordeQueryData,
+            ssl_context=ssl_context,
         )
 
     async def get_generate_check(
@@ -395,12 +403,14 @@ class AIHordeAPIAsyncClientSession(GenericAsyncHordeAPISession):
     def __init__(
         self,
         aiohttp_session: aiohttp.ClientSession,
+        ssl_context: SSLContext = _default_sslcontext,
     ) -> None:
         """Create a new instance of the RatingsAPIClient."""
         super().__init__(
             aiohttp_session=aiohttp_session,
             path_fields=AIHordePathData,
             query_fields=AIHordeQueryData,
+            ssl_context=ssl_context,
         )
 
 

horde_sdk/generic_api/generic_clients.py

@@ -4,10 +4,13 @@
 
 import asyncio
 import os
+import ssl
 from abc import ABC
+from ssl import SSLContext
 from typing import Any, TypeVar
 
 import aiohttp
+import certifi
 import requests
 from loguru import logger
 from pydantic import BaseModel, ValidationError
@@ -32,6 +35,9 @@
     GenericQueryFields,
 )
 
+_default_sslcontext = ssl.create_default_context(cafile=certifi.where())
+"""The default SSL context to use for aiohttp requests."""
+
 
 class ParsedRawRequest(BaseModel):
     """A helper class for passing around the data needed to make an actual web request."""
@@ -59,6 +65,7 @@ class BaseHordeAPIClient(ABC):
 
     # region Private Fields
     _aiohttp_session: aiohttp.ClientSession
+    _ssl_context: SSLContext
 
     _apikey: str | None
 
@@ -82,6 +89,7 @@ def __init__(
         path_fields: type[GenericPathFields] = GenericPathFields,
         query_fields: type[GenericQueryFields] = GenericQueryFields,
         accept_types: type[GenericAcceptTypes] = GenericAcceptTypes,
+        ssl_context: SSLContext = _default_sslcontext,
         **kwargs: Any,  # noqa: ANN401
     ) -> None:
         """Initialize a new `GenericHordeAPIClient` instance.
@@ -97,13 +105,20 @@ def __init__(
                 Defaults to GenericQueryFields.
             accept_types (type[GenericAcceptTypes], optional): Pass this to define the API's accept types.
                 Defaults to GenericAcceptTypes.
+            ssl_context (SSLContext, optional): The SSL context to use for aiohttp requests.
+                Defaults to using `certifi`.
             kwargs: Any additional keyword arguments are ignored.
 
         Raises:
             TypeError: If any of the passed types are not subclasses of their respective `Generic*` class.
         """
         self._apikey = apikey
 
+        if not isinstance(ssl_context, SSLContext):
+            raise TypeError("`ssl_context` must be of type `SSLContext`!")
+
+        self._ssl_context = ssl_context
+
         if not self._apikey:
             self._apikey = ANON_API_KEY
 
@@ -394,6 +409,7 @@ def __init__(  # noqa: D107
         path_fields: type[GenericPathFields] = GenericPathFields,
         query_fields: type[GenericQueryFields] = GenericQueryFields,
         accept_types: type[GenericAcceptTypes] = GenericAcceptTypes,
+        ssl_context: SSLContext = _default_sslcontext,
         **kwargs: Any,  # noqa: ANN401
     ) -> None:
         super().__init__(
@@ -445,6 +461,7 @@ async def submit_request(
                 params=parsed_request.request_queries,
                 json=parsed_request.request_body,
                 allow_redirects=True,
+                ssl=self._ssl_context,
             ) as response,
         ):
             raw_response_json = await response.json()
@@ -657,13 +674,15 @@ def __init__(  # noqa: D107
         path_fields: type[GenericPathFields] = GenericPathFields,
         query_fields: type[GenericQueryFields] = GenericQueryFields,
         accept_types: type[GenericAcceptTypes] = GenericAcceptTypes,
+        ssl_context: SSLContext = _default_sslcontext,
     ) -> None:
         super().__init__(
             aiohttp_session=aiohttp_session,
             header_fields=header_fields,
             path_fields=path_fields,
             query_fields=query_fields,
             accept_types=accept_types,
+            ssl_context=ssl_context,
         )
         self._pending_follow_ups = []
         self._awaiting_requests = []

requirements.txt

@@ -4,6 +4,7 @@ pydantic==2.9.2
 requests
 StrEnum
 loguru
+certifi
 aiohttp
 aiofiles
 aiodns