remove ClientOptions and all dependencies

Author: atstaeff

eventsourcingdb/__init__.py

@@ -1,2 +1 @@
 from .client import Client as EsdbClient
-from .client_options import ClientOptions as EsdbClientOptions

eventsourcingdb/client.py

@@ -1,7 +1,6 @@
 from collections.abc import AsyncGenerator
 
 from .client_configuration import ClientConfiguration
-from .client_options import ClientOptions
 from .event.event_candidate import EventCandidate
 from .event.event_context import EventContext
 from .handlers.observe_events.observe_events import observe_events
@@ -27,66 +26,131 @@ def __init__(
         self,
         base_url: str,
         api_token: str,
-        options: ClientOptions = ClientOptions()
     ):
         configuration = ClientConfiguration(
             base_url=base_url,
-            timeout_seconds=options.timeout_seconds,
             api_token=api_token,
-            protocol_version=options.protocol_version,
-            max_tries=options.max_tries
         )
 
         self.__http_client = HttpClient(configuration)
 
+    #TODO: is this necessary? __enter__, __exit__
     async def initialize(self) -> None:
         await self.__http_client.initialize()
 
+     #TODO: is this necessary? magic method __enter__, __exit__
     async def close(self) -> None:
         await self.__http_client.close()
 
     @property
     def http_client(self) -> HttpClient:
         return self.__http_client
 
+    # TODO: should we mix object orientation and functional programming?
     async def ping(self) -> None:
-        return await ping(self)
-
-    async def read_subjects(
+        return await ping(client=self)
+    
+    async def verify_api_token(self) -> None:
+        ...
+    
+    async def write_events(
         self,
-        base_subject: str
-    ) -> AsyncGenerator[str, None]:
-        async for subject in read_subjects(self, base_subject):
-            yield subject
-
+        event_candidates: list[EventCandidate],
+        preconditions: list[Precondition] = None
+    ) -> list[EventContext]: # TODO: list[Event] of Events (complete)
+        if preconditions is None:
+            preconditions = []
+        return await write_events(self, event_candidates, preconditions)
+    
     async def read_events(
         self,
         subject: str,
         options: ReadEventsOptions
-    ) -> AsyncGenerator[StoreItem, None]:
+    ) -> AsyncGenerator[StoreItem, None]: # no StoreItem ... it is a Event
+        #TODO: This is a code snippet for abort read events.
+        """
+        https://github.com/thenativeweb/eventsourcingdb-client-javascript/blob/main/src/Client.ts#L134-L152
+        for await (const event of client.readEvents('/', { recursive: true })) {
+            console.log(event);
+            
+            if (event.ID === '100') {
+                break;
+            }
+        }
+
+
+        function handlePostRequest(abortController) {
+            const signal = abortController.signal;
+
+            for await (const event of client.readEvents('/', { recursive: true }), signal) {
+                console.log(event);
+            }
+            
+            return http.status(200);
+        }
+"""
         async for event in read_events(self, subject, options):
             yield event
 
-    async def read_event_types(self) -> AsyncGenerator[EventType, None]:
-        async for event_type in read_event_types(self):
-            yield event_type
-
-    async def register_event_schema(self, event_type: str, json_schema: str) -> None:
-        await register_event_schema(self, event_type, json_schema)
+    # TODO: run eventql query
+    async def run_eventql_query(self, query: str) -> AsyncGenerator[Event, None]:
+        """
+        the issue like read_events. can be abort or canceled.
+        """
 
     async def observe_events(
         self,
         subject: str,
         options: ObserveEventsOptions
-    ) -> AsyncGenerator[StoreItem, None]:
+    ) -> AsyncGenerator[StoreItem, None]: # no StoreItem ... it is a Event
+        """
+        TODO: the same issue like read_events. contextmanager
+        """
         async for event in observe_events(self, subject, options):
             yield event
 
-    async def write_events(
+    async def register_event_schema(self, event_type: str, json_schema: str) -> None: # TODO: no json_schema is dict no string anymore
+        # no context manager liek read_events
+        await register_event_schema(self, event_type, json_schema)
+
+    async def read_subjects(
         self,
-        event_candidates: list[EventCandidate],
-        preconditions: list[Precondition] = None
-    ) -> list[EventContext]:
-        if preconditions is None:
-            preconditions = []
-        return await write_events(self, event_candidates, preconditions)
+        base_subject: str
+    ) -> AsyncGenerator[str, None]:
+        # TODO: the same issue like read_events. contextmanager
+        async for subject in read_subjects(self, base_subject):
+            yield subject
+
+    
+    async def read_event_types(self) -> AsyncGenerator[EventType, None]:
+        # TODO: the same issue like read_events. contextmanager
+        async for event_type in read_event_types(self):
+            yield event_type
+
+
+
+""" TODO: 
+
+f (response.status !== 200) {
+					throw new Error(
+						`Failed to read event types, got HTTP status code '${response.status}', expected '200'.`,
+					);
+				}
+
+"""
+
+"""
+
+A: Ausdüngen und Exception
+
+B: Contextmanager
+
+C: Neue Methoden
+
+D: Testcontainer: testcontainers.com Python "virtuelle Container für tests"
+- EventSourcingDB(DockerContainer):
+   def __init__(self):
+    https://github.com/thenativeweb/eventsourcingdb-client-javascript/blob/main/src/EventSourcingDbContainer.ts
+"""
+
+Dokumentationslink für Featurecheck: https://docs.eventsourcingdb.io/client-sdks/compliance-criteria/#detailed-requirements

eventsourcingdb/client_configuration.py

@@ -4,7 +4,4 @@
 @dataclass
 class ClientConfiguration:
     base_url: str
-    timeout_seconds: int
     api_token: str
-    protocol_version: str
-    max_tries: int

eventsourcingdb/client_options.py

@@ -4,7 +4,7 @@ build-backend = "poetry.core.masonry.api"
 
 [project]
 name = "eventsourcingdb"
-version = "0.11.0"
+version = "0.10.1"
 description = "The official Python client SDK for EventSourcingDB."
 authors = [
 	{ name = "the native web GmbH", email = "[email protected]" }

pyproject.toml

@@ -1,5 +1,4 @@
 from eventsourcingdb.client import Client
-from eventsourcingdb.client_options import ClientOptions
 
 from .docker.container import Container
 from .docker.image import Image
@@ -27,13 +26,12 @@ async def create(
         image: Image,
         command: [str],
         api_token: str,
-        options: ClientOptions = ClientOptions(),
     ) -> 'ContainerizedTestingDatabase':
         command.extend(['--http-enabled', '--https-enabled=false'])
         container = image.run(command, True, True)
         exposed_port = container.get_exposed_port(3_000)
         base_url = f'http://127.0.0.1:{exposed_port}'
-        client = Client(base_url, api_token=api_token, options=options)
+        client = Client(base_url, api_token=api_token)
         await client.initialize()
 
         await client.ping()

tests/shared/containerized_testing_database.py

@@ -1,7 +1,6 @@
 import uuid
 
 from eventsourcingdb.client import Client
-from eventsourcingdb.client_options import ClientOptions
 
 from .containerized_testing_database import ContainerizedTestingDatabase
 from .docker.image import Image
@@ -32,7 +31,6 @@ async def create(cls) -> 'Database':
             image,
             ['run', '--api-token', f'{api_token}', '--data-directory-temporary'],
             api_token,
-            ClientOptions()
         )
 
         with_invalid_url_client = Client(

tests/shared/database.py

@@ -6,7 +6,6 @@
 from flask import Flask, Response, make_response
 
 from eventsourcingdb.client import Client
-from eventsourcingdb.client_options import ClientOptions
 from eventsourcingdb.util.retry.retry_with_backoff import retry_with_backoff
 from eventsourcingdb.util.retry.retry_result import Retry, Return, RetryResult
 
@@ -77,7 +76,6 @@ def stop_server():
     client = Client(
         f'http://localhost:{local_http_server.port}',
         'access-token',
-        ClientOptions(max_tries=3)  # Increase max_tries from 2 to 3
     )
     await client.initialize()