feat: add type annotation in src and test folder (#87)

atstaeff · web-flow · commit ba40f9e0f2a2 · 2025-05-30T21:29:04.000+02:00
* type annotation

* update type annotations

* add type annotation in test
diff --git a/eventsourcingdb/client.py b/eventsourcingdb/client.py
@@ -30,10 +30,10 @@ 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":
+    async def __aenter__(self) -> 'Client':
         await self.__http_client.__aenter__()
         return self
 
diff --git a/eventsourcingdb/container.py b/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)
@@ -142,7 +142,7 @@ def _pull_or_get_image(self) -> None:
         except errors.APIError as e:
             self._handle_image_pull_error(e)
 
-    def _handle_image_pull_error(self, error):
+    def _handle_image_pull_error(self, error) -> None:
         image_name = f"{self._image_name}:{self._image_tag}"
         try:
             self._docker_client.images.get(image_name)
@@ -211,7 +211,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':
diff --git a/eventsourcingdb/errors/client_error.py b/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}')
diff --git a/eventsourcingdb/errors/internal_error.py b/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}')
diff --git a/eventsourcingdb/errors/server_error.py b/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}')
diff --git a/eventsourcingdb/errors/validation_error.py b/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}')
diff --git a/eventsourcingdb/event/event.py b/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,
diff --git a/eventsourcingdb/event/event_candidate.py b/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,
diff --git a/eventsourcingdb/http_client/http_client.py b/eventsourcingdb/http_client/http_client.py
@@ -15,12 +15,12 @@ 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):
+    async def __aenter__(self) -> 'HttpClient':
         await self.initialize()
         return self
 
@@ -35,7 +35,7 @@ async def __aexit__(
     async def initialize(self) -> None:
         self.__session = aiohttp.ClientSession()
 
-    async def close(self):
+    async def close(self) -> None:
         if self.__session is not None:
             await self.__session.close()
             self.__session = None
diff --git a/eventsourcingdb/http_client/response.py b/eventsourcingdb/http_client/response.py
@@ -8,21 +8,20 @@
 
 
 class Response:
-    def __init__(self, response: aiohttp.ClientResponse):
+    def __init__(self, response: aiohttp.ClientResponse) -> None:
         self.__response: aiohttp.ClientResponse = response
 
-    async def __aenter__(self):
-        # Properly await any async initialization if needed
+    async def __aenter__(self) -> 'Response':
         return self
 
-    async def __aexit__(self, exc_type, exc_val, exc_tb):
+    async def __aexit__(self, exc_type, exc_val, exc_tb) -> None:
         if not self.__response.closed:
             self.__response.close()
 
-    def __enter__(self):
+    def __enter__(self) -> 'Response':
         return self
 
-    def __exit__(self, exc_type, exc_val, exc_tb):
+    def __exit__(self, exc_type, exc_val, exc_tb) -> None:
         if not self.__response.closed:
             self.__response.close()
 
diff --git a/eventsourcingdb/observe_events/observe_from_latest_event.py b/eventsourcingdb/observe_events/observe_from_latest_event.py
@@ -1,4 +1,5 @@
 from dataclasses import dataclass
+from typing import Any
 
 from .if_event_is_missing_during_observe import IfEventIsMissingDuringObserve
 
@@ -9,7 +10,7 @@ class ObserveFromLatestEvent:
     type: str
     if_event_is_missing: IfEventIsMissingDuringObserve
 
-    def to_json(self):
+    def to_json(self) -> dict[str, Any]:
         return {
             'subject': self.subject,
             'type': self.type,
diff --git a/eventsourcingdb/read_event_types/event_type.py b/eventsourcingdb/read_event_types/event_type.py
@@ -13,7 +13,7 @@ class EventType:
     schema: dict[str, Any] | None = None
 
     @staticmethod
-    def parse(unknown_object: dict) -> "EventType":
+    def parse(unknown_object: dict) -> 'EventType':
         event_type = unknown_object.get('eventType')
         if not isinstance(event_type, str):
             raise ValidationError(
@@ -38,7 +38,7 @@ def parse(unknown_object: dict) -> "EventType":
             schema=schema,
         )
 
-    def __hash__(self):
+    def __hash__(self) -> str:
         # Convert dictionary schema to a hashable form (tuple of items)
         if isinstance(self.schema, dict):
             # Sort items to ensure consistent hashing
diff --git a/eventsourcingdb/read_events/read_from_latest_event.py b/eventsourcingdb/read_events/read_from_latest_event.py
@@ -1,4 +1,5 @@
 from dataclasses import dataclass
+from typing import Any
 
 from .if_event_is_missing_during_read import IfEventIsMissingDuringRead
 
@@ -9,7 +10,7 @@ class ReadFromLatestEvent:
     type: str
     if_event_is_missing: IfEventIsMissingDuringRead
 
-    def to_json(self):
+    def to_json(self) -> dict[str, Any]:
         return {
             'subject': self.subject,
             'type': self.type,
diff --git a/eventsourcingdb/write_events/preconditions.py b/eventsourcingdb/write_events/preconditions.py
@@ -1,18 +1,19 @@
 from abc import ABC, abstractmethod
+from typing import Any
 from dataclasses import dataclass
 
 
 class Precondition(ABC):
     @abstractmethod
-    def to_json(self):
+    def to_json(self)-> Any:
         raise NotImplementedError()
 
 
 @dataclass
 class IsSubjectPristine(Precondition):
     subject: str
 
-    def to_json(self):
+    def to_json(self) -> dict[str, Any]:
         return {
             'type': 'isSubjectPristine',
             'payload': {
@@ -26,7 +27,7 @@ class IsSubjectOnEventId(Precondition):
     subject: str
     event_id: str
 
-    def to_json(self):
+    def to_json(self) -> dict[str, Any]:
         return {
             'type': 'isSubjectOnEventId',
             'payload': {
diff --git a/tests/conftest.py b/tests/conftest.py
@@ -4,7 +4,7 @@
 
 
 @pytest_asyncio.fixture
-async def database():
+async def database() -> Database:
     testing_db = await Database.create()
     yield testing_db
 
diff --git a/tests/shared/database.py b/tests/shared/database.py
@@ -19,21 +19,21 @@ def __init__(
         create_key,
         with_authorization_client: Client,
         with_invalid_url_client: Client,
-    ):
+    ) -> None:
         assert create_key == Database.__create_key, \
             'Database objects must be created using Database.create.'
         self.__with_authorization_client: Client = with_authorization_client
         self.__with_invalid_url_client: Client = with_invalid_url_client
 
     @classmethod
-    def _create_container(cls, api_token, image_tag):
+    def _create_container(cls, api_token, image_tag) -> Container:
         cls.__container = Container()
         cls.__container.with_image_tag(image_tag)
         cls.__container.with_api_token(api_token)
         return cls.__container
 
     @staticmethod
-    async def _initialize_clients(container, api_token):
+    async def _initialize_clients(container, api_token) -> tuple[Client, Client]:
         with_authorization_client = container.get_client()
         await with_authorization_client.initialize()
 
@@ -95,7 +95,7 @@ async def create(cls, max_retries=3, retry_delay=2.0) -> 'Database':
         raise RuntimeError('Failed to create database: Unexpected error during retry loop')
 
     @staticmethod
-    def _get_image_tag_from_dockerfile():
+    def _get_image_tag_from_dockerfile() -> str:
         dockerfile_path = os.path.join(
             os.path.dirname(__file__),
             'docker/eventsourcingdb/Dockerfile')
diff --git a/tests/shared/event/assert_event.py b/tests/shared/event/assert_event.py
@@ -15,7 +15,7 @@ def assert_event_equals(
         data: dict,
         trace_parent: str | None,
         trace_state: str | None
-):
+) -> None:
     assert event.source == source
     assert event.subject == subject
     assert event.type == type_
diff --git a/tests/shared/start_local_http_server.py b/tests/shared/start_local_http_server.py
@@ -15,11 +15,11 @@
 
 
 class LocalHttpServer():
-    def __init__(self, attach_handlers: AttachHandlers):
+    def __init__(self, attach_handlers: AttachHandlers) -> None:
         self.port = get_random_available_port()
         self.app = Flask('local')
 
-        def attach_handler(route: str, method: str, handler: Handler):
+        def attach_handler(route: str, method: str, handler: Handler) -> None:
             @self.app.route(route, methods=[method])
             def attached_handler():
                 response = make_response()
@@ -32,7 +32,7 @@ def ping():
             return "OK"
 
     @staticmethod
-    def start(this: 'LocalHttpServer'):
+    def start(this: 'LocalHttpServer') -> None:
         this.app.run(host='localhost', port=this.port)
 
 
@@ -43,7 +43,7 @@ async def start_local_http_server(attach_handlers: AttachHandlers) -> tuple[Clie
     server = multiprocessing.Process(target=LocalHttpServer.start, args=(local_http_server, ))
     server.start()
 
-    async def ping_app():
+    async def ping_app() -> bool:
         max_retries = 5
         retry_delay = 0.5
 
@@ -65,7 +65,7 @@ async def ping_app():
         server.join()
         raise RuntimeError(f"Failed to start HTTP server on port {local_http_server.port}")
 
-    def stop_server():
+    def stop_server() -> None:
         server.terminate()
         server.join()
 
diff --git a/tests/test_observe_events.py b/tests/test_observe_events.py
diff --git a/tests/test_ping.py b/tests/test_ping.py
diff --git a/tests/test_read_event_types.py b/tests/test_read_event_types.py
diff --git a/tests/test_read_events.py b/tests/test_read_events.py
diff --git a/tests/test_read_subjects.py b/tests/test_read_subjects.py
diff --git a/tests/test_register_event_schema.py b/tests/test_register_event_schema.py
diff --git a/tests/test_run_eventql_query.py b/tests/test_run_eventql_query.py
diff --git a/tests/test_verify_api_token.py b/tests/test_verify_api_token.py
diff --git a/tests/test_write_events.py b/tests/test_write_events.py
