chore: Reorganize import structure to align with compatibility expectations

Author: keelerm84

ldclient/config.py

@@ -10,7 +10,6 @@
 
 from ldclient.feature_store import InMemoryFeatureStore
 from ldclient.hook import Hook
-from ldclient.impl.datasystem import Initializer, Synchronizer
 from ldclient.impl.util import (
     log,
     validate_application_info,
@@ -22,6 +21,8 @@
     DataStoreMode,
     EventProcessor,
     FeatureStore,
+    Initializer,
+    Synchronizer,
     UpdateProcessor
 )
 from ldclient.plugin import Plugin

ldclient/impl/datasystem/config.py ldclient/datasystem.pyldclient/impl/datasystem/config.py renamed to ldclient/datasystem.py

@@ -16,8 +16,12 @@
     StreamingDataSource,
     StreamingDataSourceBuilder
 )
-from ldclient.impl.datasystem import Initializer, Synchronizer
-from ldclient.interfaces import DataStoreMode, FeatureStore
+from ldclient.interfaces import (
+    DataStoreMode,
+    FeatureStore,
+    Initializer,
+    Synchronizer
+)
 
 T = TypeVar("T")
 
@@ -92,7 +96,7 @@ def build(self) -> DataSystemConfig:
         )
 
 
-def polling_ds_builder() -> Builder[PollingDataSource]:
+def __polling_ds_builder() -> Builder[PollingDataSource]:
     def builder(config: LDConfig) -> PollingDataSource:
         requester = Urllib3PollingRequester(config)
         polling_ds = PollingDataSourceBuilder(config)
@@ -103,7 +107,7 @@ def builder(config: LDConfig) -> PollingDataSource:
     return builder
 
 
-def fdv1_fallback_ds_builder() -> Builder[PollingDataSource]:
+def __fdv1_fallback_ds_builder() -> Builder[PollingDataSource]:
     def builder(config: LDConfig) -> PollingDataSource:
         requester = Urllib3FDv1PollingRequester(config)
         polling_ds = PollingDataSourceBuilder(config)
@@ -114,7 +118,7 @@ def builder(config: LDConfig) -> PollingDataSource:
     return builder
 
 
-def streaming_ds_builder() -> Builder[StreamingDataSource]:
+def __streaming_ds_builder() -> Builder[StreamingDataSource]:
     def builder(config: LDConfig) -> StreamingDataSource:
         return StreamingDataSourceBuilder(config).build()
 
@@ -135,9 +139,9 @@ def default() -> ConfigBuilder:
     for updates.
     """
 
-    polling_builder = polling_ds_builder()
-    streaming_builder = streaming_ds_builder()
-    fallback = fdv1_fallback_ds_builder()
+    polling_builder = __polling_ds_builder()
+    streaming_builder = __streaming_ds_builder()
+    fallback = __fdv1_fallback_ds_builder()
 
     builder = ConfigBuilder()
     builder.initializers([polling_builder])
@@ -154,8 +158,8 @@ def streaming() -> ConfigBuilder:
     with no additional latency.
     """
 
-    streaming_builder = streaming_ds_builder()
-    fallback = fdv1_fallback_ds_builder()
+    streaming_builder = __streaming_ds_builder()
+    fallback = __fdv1_fallback_ds_builder()
 
     builder = ConfigBuilder()
     builder.synchronizers(streaming_builder)
@@ -171,8 +175,8 @@ def polling() -> ConfigBuilder:
     streaming, but may be necessary in some network environments.
     """
 
-    polling_builder: Builder[Synchronizer] = polling_ds_builder()
-    fallback = fdv1_fallback_ds_builder()
+    polling_builder: Builder[Synchronizer] = __polling_ds_builder()
+    fallback = __fdv1_fallback_ds_builder()
 
     builder = ConfigBuilder()
     builder.synchronizers(polling_builder)

ldclient/impl/datasourcev2/__init__.py

@@ -1,6 +1,6 @@
 """
-This module houses FDv2 types and implementations of synchronizers and
-initializers for the datasystem.
+This module houses FDv2 implementations of synchronizers and initializers for
+the datasystem.
 
 All types and implementations in this module are considered internal
 and are not part of the public API of the LaunchDarkly Python SDK.
@@ -9,7 +9,3 @@
 
 You have been warned.
 """
-
-from .polling import PollingResult, Requester
-
-__all__: list[str] = ["PollingResult", "Requester"]

ldclient/impl/datasourcev2/polling.py

@@ -15,19 +15,10 @@
 
 from ldclient.config import Config
 from ldclient.impl.datasource.feature_requester import LATEST_ALL_URI
-from ldclient.impl.datasystem import BasisResult, SelectorStore, Update
 from ldclient.impl.datasystem.protocolv2 import (
-    Basis,
-    ChangeSet,
-    ChangeSetBuilder,
     DeleteObject,
     EventName,
-    IntentCode,
-    ObjectKind,
-    Payload,
-    PutObject,
-    Selector,
-    ServerIntent
+    PutObject
 )
 from ldclient.impl.http import _http_factory
 from ldclient.impl.repeating_task import RepeatingTask
@@ -44,11 +35,22 @@
     log
 )
 from ldclient.interfaces import (
+    Basis,
+    BasisResult,
+    ChangeSet,
+    ChangeSetBuilder,
     DataSourceErrorInfo,
     DataSourceErrorKind,
-    DataSourceState
+    DataSourceState,
+    Initializer,
+    IntentCode,
+    ObjectKind,
+    Selector,
+    SelectorStore,
+    ServerIntent,
+    Synchronizer,
+    Update
 )
-from ldclient.versioned_data_kind import FEATURES, SEGMENTS
 
 POLLING_ENDPOINT = "/sdk/poll"
 
@@ -78,7 +80,7 @@ def fetch(self, selector: Optional[Selector]) -> PollingResult:
 CacheEntry = namedtuple("CacheEntry", ["data", "etag"])
 
 
-class PollingDataSource:
+class PollingDataSource(Initializer, Synchronizer):
     """
     PollingDataSource is a data source that can retrieve information from
     LaunchDarkly either as an Initializer or as a Synchronizer.
@@ -235,7 +237,7 @@ def _poll(self, ss: SelectorStore) -> BasisResult:
 
 
 # pylint: disable=too-few-public-methods
-class Urllib3PollingRequester:
+class Urllib3PollingRequester(Requester):
     """
     Urllib3PollingRequester is a Requester that uses urllib3 to make HTTP
     requests.
@@ -401,7 +403,7 @@ def build(self) -> PollingDataSource:
 
 
 # pylint: disable=too-few-public-methods
-class Urllib3FDv1PollingRequester:
+class Urllib3FDv1PollingRequester(Requester):
     """
     Urllib3PollingRequesterFDv1 is a Requester that uses urllib3 to make HTTP
     requests.

ldclient/impl/datasourcev2/status.py

@@ -18,23 +18,13 @@
 from ld_eventsource.errors import HTTPStatusError
 
 from ldclient.config import Config
-from ldclient.impl.datasystem import (
-    DiagnosticAccumulator,
-    DiagnosticSource,
-    SelectorStore,
-    Synchronizer,
-    Update
-)
+from ldclient.impl.datasystem import DiagnosticAccumulator, DiagnosticSource
 from ldclient.impl.datasystem.protocolv2 import (
-    ChangeSetBuilder,
     DeleteObject,
     Error,
     EventName,
     Goodbye,
-    IntentCode,
-    PutObject,
-    Selector,
-    ServerIntent
+    PutObject
 )
 from ldclient.impl.http import HTTPFactory, _http_factory
 from ldclient.impl.util import (
@@ -45,9 +35,16 @@
     log
 )
 from ldclient.interfaces import (
+    ChangeSetBuilder,
     DataSourceErrorInfo,
     DataSourceErrorKind,
-    DataSourceState
+    DataSourceState,
+    IntentCode,
+    Selector,
+    SelectorStore,
+    ServerIntent,
+    Synchronizer,
+    Update
 )
 
 # allows for up to 5 minutes to elapse without any data sent across the stream.