Better represent the return of streaming as a generator

Author: keelerm84

ldclient/impl/datasourcev2/__init__.py

@@ -12,7 +12,7 @@
 
 from abc import abstractmethod
 from dataclasses import dataclass
-from typing import Iterable, Mapping, Optional, Protocol, Tuple
+from typing import Generator, Iterable, Mapping, Optional, Protocol, Tuple
 
 from ldclient.impl.datasystem.protocolv2 import ChangeSet, Selector
 from ldclient.impl.util import _Result
@@ -65,7 +65,7 @@ class Synchronizer(Protocol):  # pylint: disable=too-few-public-methods
     """
 
     @abstractmethod
-    def sync(self) -> Iterable[Update]:
+    def sync(self) -> Generator[Update, None, None]:
         """
         sync should begin the synchronization process for the data source, yielding
         Update objects until the connection is closed or an unrecoverable error

ldclient/impl/datasourcev2/streaming.py

@@ -6,16 +6,12 @@
 import json
 from abc import abstractmethod
 from time import time
-from typing import Callable, Iterable, Optional, Protocol, Tuple
+from typing import Callable, Generator, Iterable, Optional, Protocol, Tuple
 from urllib import parse
 
 from ld_eventsource import SSEClient as SSEClientImpl
 from ld_eventsource.actions import Action, Event, Fault
-from ld_eventsource.config import (
-    ConnectStrategy,
-    ErrorStrategy,
-    RetryDelayStrategy
-)
+from ld_eventsource.config import ConnectStrategy, ErrorStrategy, RetryDelayStrategy
 from ld_eventsource.errors import HTTPStatusError
 
 from ldclient.config import Config
@@ -29,18 +25,14 @@
     IntentCode,
     PutObject,
     Selector,
-    ServerIntent
+    ServerIntent,
 )
 from ldclient.impl.http import HTTPFactory, _http_factory
-from ldclient.impl.util import (
-    http_error_message,
-    is_http_error_recoverable,
-    log
-)
+from ldclient.impl.util import http_error_message, is_http_error_recoverable, log
 from ldclient.interfaces import (
     DataSourceErrorInfo,
     DataSourceErrorKind,
-    DataSourceState
+    DataSourceState,
 )
 
 # allows for up to 5 minutes to elapse without any data sent across the stream.
@@ -129,7 +121,7 @@ def __init__(
         self._config = config
         self._sse: Optional[SSEClient] = None
 
-    def sync(self) -> Iterable[Update]:
+    def sync(self) -> Generator[Update, None, None]:
         """
         sync should begin the synchronization process for the data source, yielding
         Update objects until the connection is closed or an unrecoverable error