Merge branch 'main' into 85-remove-initialize-and-close-from-the-client-class

Author: atstaeff

.github/workflows/qa.yml

@@ -8,13 +8,17 @@ jobs:
     runs-on: ubuntu-latest
     timeout-minutes: 15
 
+    strategy:
+      matrix:
+        version: [ '3.11', '3.12', '3.13' ]
+
     steps:
     - name: Clone repository
       uses: actions/checkout@v4
     - name: Use Python
       uses: actions/setup-python@v5
       with:
-        python-version: '3.13'
+        python-version: ${{ matrix.version }}
     - name: Install dependencies
       run: |
         pip install poetry

eventsourcingdb/client.py

@@ -30,7 +30,7 @@ def __init__(
         self,
         base_url: str,
         api_token: str,
-    ):
+    ) -> None:
         self.__http_client = HttpClient(base_url=base_url, api_token=api_token)
 
     async def __aenter__(self) -> 'Client':
@@ -188,7 +188,8 @@ async def run_eventql_query(self, query: str) -> AsyncGenerator[Any]:
                 message = parse_raw_message(raw_message)
 
                 if is_stream_error(message):
-                    raise ServerError(f'{message['payload']['error']}.')
+                    error_message = message.get('payload', {}).get('error', 'Unknown error')
+                    raise ServerError(f"{error_message}.")
                 # pylint: disable=R2004
                 if message.get('type') == 'row':
                     payload = message['payload']
@@ -197,7 +198,7 @@ async def run_eventql_query(self, query: str) -> AsyncGenerator[Any]:
                     continue
 
                 raise ServerError(
-                    f'Failed to execute EventQL query, an unexpected stream item was received: '
+                    'Failed to execute EventQL query, an unexpected stream item was received: '
                     f'{message}.'
                 )
 

eventsourcingdb/container.py

@@ -12,7 +12,7 @@
 class Container:
     def __init__(
         self,
-    ):
+    ) -> None:
         self._image_name: str = 'thenativeweb/eventsourcingdb'
         self._image_tag: str = 'latest'
         self._api_token: str = 'secret'
@@ -57,7 +57,7 @@ def _create_container(self) -> None:
             detach=True,
         )  # type: ignore
 
-    def _extract_port_from_container_info(self, container_info):
+    def _extract_port_from_container_info(self, container_info) -> int | None:
         port = None
         valid_mapping = True
         port_mappings = None
@@ -95,7 +95,7 @@ def _fetch_mapped_port(self) -> None:
         self._stop_and_remove_container()
         raise RuntimeError('Failed to determine mapped port')
 
-    def _get_container_info(self):
+    def _get_container_info(self) -> dict | None:
         if self._container is None:
             return None
         return self._docker_client.api.inspect_container(self._container.id)
@@ -137,7 +137,12 @@ def start(self) -> 'Container':
         return self
 
     def _pull_or_get_image(self) -> None:
-        """Pull Docker image or use local image if pulling fails."""
+        try:
+            self._docker_client.images.pull(self._image_name, self._image_tag)
+        except errors.APIError as e:
+            self._handle_image_pull_error(e)
+
+    def _handle_image_pull_error(self, error) -> None:
         image_name = f"{self._image_name}:{self._image_tag}"
 
         # First check if the image is already available locally
@@ -230,7 +235,7 @@ def _check_endpoint_available(self, url: str) -> bool:
         return self._check_response_ok(response)
 
     # pylint: disable=R6301
-    def _check_response_ok(self, response) -> bool:
+    def _check_response_ok(self, response: requests.Response) -> bool:
         return response is not None and response.status_code == HTTPStatus.OK
 
     def with_api_token(self, token: str) -> 'Container':

eventsourcingdb/errors/client_error.py

@@ -2,5 +2,5 @@
 
 
 class ClientError(CustomError):
-    def __init__(self, cause: str):
+    def __init__(self, cause: str) -> None:
         super().__init__(f'Client error occurred: {cause}')

eventsourcingdb/errors/internal_error.py

@@ -2,5 +2,5 @@
 
 
 class InternalError(CustomError):
-    def __init__(self, cause: str):
+    def __init__(self, cause: str) -> None:
         super().__init__(f'Internal error occurred: {cause}')

eventsourcingdb/errors/server_error.py

@@ -2,5 +2,5 @@
 
 
 class ServerError(CustomError):
-    def __init__(self, cause: str):
+    def __init__(self, cause: str) -> None:
         super().__init__(f'Server error occurred: {cause}')

eventsourcingdb/errors/validation_error.py

@@ -2,5 +2,5 @@
 
 
 class ValidationError(CustomError):
-    def __init__(self, cause: str):
+    def __init__(self, cause: str) -> None:
         super().__init__(f'Validation error occurred: {cause}')

eventsourcingdb/event/event.py

@@ -1,6 +1,6 @@
 from datetime import datetime
 from dataclasses import dataclass
-from typing import TypeVar
+from typing import TypeVar, Any
 
 from ..errors.internal_error import InternalError
 from ..errors.validation_error import ValidationError
@@ -24,7 +24,7 @@ class Event():
     trace_state: str | None = None
 
     @staticmethod
-    def parse(unknown_object: dict) -> "Event":
+    def parse(unknown_object: dict) -> 'Event':
         source = unknown_object.get('source')
         if not isinstance(source, str):
             raise ValidationError(
@@ -103,7 +103,7 @@ def parse(unknown_object: dict) -> "Event":
             trace_state=trace_state
         )
 
-    def to_json(self):
+    def to_json(self) -> dict[str, Any]:
         json = {
             'specversion': self.spec_version,
             'id': self.event_id,

eventsourcingdb/event/event_candidate.py

@@ -1,5 +1,5 @@
 from dataclasses import dataclass
-
+from typing import Any
 
 @dataclass
 class EventCandidate:
@@ -10,7 +10,7 @@ class EventCandidate:
     trace_parent: str | None = None
     trace_state: str | None = None
 
-    def to_json(self):
+    def to_json(self) -> dict[str, Any]:
         json = {
             'data': self.data,
             'source': self.source,

eventsourcingdb/http_client/http_client.py

@@ -13,13 +13,13 @@ def __init__(
         self,
         base_url: str,
         api_token: str,
-    ):
+    ) -> None:
         self.__base_url = base_url
         self.__api_token = api_token
         self.__session: ClientSession | None = None
 
-    async def __aenter__(self):
-        await self.__initialize()
+    async def __aenter__(self) -> 'HttpClient':
+        await self.initialize()
         return self
 
     async def __aexit__(
@@ -37,7 +37,7 @@ async def __initialize(self) -> None:
 
         self.__session = aiohttp.ClientSession(connector_owner=True)
 
-    async def __close(self):
+    async def close(self) -> None:
         if self.__session is not None:
             await self.__session.close()
             self.__session = None