devcycle-python-server-sdk 3.7.0__tar.gz → 3.8.0__tar.gz

devcycle_python_server_sdk-3.8.0/PKG-INFO

@@ -0,0 +1,25 @@
+Metadata-Version: 2.2
+Name: devcycle-python-server-sdk
+Version: 3.8.0
+Summary: DevCycle Python SDK
+Home-page: https://github.com/devcycleHQ/python-server-sdk
+Author-email: 
+Keywords: DevCycle
+License-File: LICENSE
+Requires-Dist: setuptools>=21.0.0
+Requires-Dist: urllib3>=1.15.1
+Requires-Dist: requests~=2.31
+Requires-Dist: wasmtime==23.0.0
+Requires-Dist: protobuf>=4.23.3
+Requires-Dist: openfeature-sdk>=0.7.0
+Requires-Dist: launchdarkly-eventsource>=1.2.0
+Requires-Dist: responses~=0.23.1
+Requires-Dist: dataclasses~=0.6
+Dynamic: description
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: requires-dist
+Dynamic: summary
+
+    The DevCycle Python SDK used for feature management.
+    

devcycle_python_server_sdk-3.8.0/devcycle_python_sdk/VERSION.txt

@@ -0,0 +1 @@
+3.8.0

{devcycle-python-server-sdk-3.7.0 → devcycle_python_server_sdk-3.8.0}/devcycle_python_sdk/managers/config_manager.py

@@ -1,16 +1,21 @@
+import json
+import logging
 import threading
 import time
-import logging
-import json
+from datetime import datetime
 from typing import Optional
 
-from devcycle_python_sdk.options import DevCycleLocalOptions
-from devcycle_python_sdk.api.local_bucketing import LocalBucketing
+import ld_eventsource.actions
+
 from devcycle_python_sdk.api.config_client import ConfigAPIClient
+from devcycle_python_sdk.api.local_bucketing import LocalBucketing
 from devcycle_python_sdk.exceptions import (
     CloudClientUnauthorizedError,
     CloudClientError,
 )
+from wsgiref.handlers import format_date_time
+from devcycle_python_sdk.options import DevCycleLocalOptions
+from devcycle_python_sdk.managers.sse_manager import SSEManager
 
 logger = logging.getLogger(__name__)
 
@@ -27,7 +32,9 @@ class EnvironmentConfigManager(threading.Thread):
         self._sdk_key = sdk_key
         self._options = options
         self._local_bucketing = local_bucketing
-
+        self._sse_manager: Optional[SSEManager] = None
+        self._sse_polling_interval = 1000 * 60 * 15 * 60
+        self._sse_connected = False
         self._config: Optional[dict] = None
         self._config_etag: Optional[str] = None
         self._config_lastmodified: Optional[str] = None
@@ -41,10 +48,15 @@ class EnvironmentConfigManager(threading.Thread):
     def is_initialized(self) -> bool:
         return self._config is not None
 
-    def _get_config(self):
+    def _get_config(self, last_modified: Optional[float] = None):
         try:
+            lm_header = self._config_lastmodified
+            if last_modified is not None:
+                lm_timestamp = datetime.fromtimestamp(last_modified)
+                lm_header = format_date_time(time.mktime(lm_timestamp.timetuple()))
+
             new_config, new_etag, new_lastmodified = self._config_api_client.get_config(
-                config_etag=self._config_etag, last_modified=self._config_lastmodified
+                config_etag=self._config_etag, last_modified=lm_header
             )
 
             # Abort early if the last modified is before the sent one.
@@ -68,6 +80,14 @@ class EnvironmentConfigManager(threading.Thread):
 
             json_config = json.dumps(self._config)
             self._local_bucketing.store_config(json_config)
+            if not self._options.disable_realtime_updates:
+                if self._sse_manager is None:
+                    self._sse_manager = SSEManager(
+                        self.sse_state,
+                        self.sse_error,
+                        self.sse_message,
+                    )
+                self._sse_manager.update(self._config)
 
             if (
                 trigger_on_client_initialized
@@ -98,7 +118,32 @@ class EnvironmentConfigManager(threading.Thread):
                     logger.warning(
                         f"DevCycle: Error polling for config changes: {str(e)}"
                     )
-            time.sleep(self._options.config_polling_interval_ms / 1000.0)
+            if self._sse_connected:
+                time.sleep(self._sse_polling_interval / 1000.0)
+            else:
+                time.sleep(self._options.config_polling_interval_ms / 1000.0)
+
+    def sse_message(self, message: ld_eventsource.actions.Event):
+        if self._sse_connected is False:
+            self._sse_connected = True
+            logger.info("DevCycle: Connected to SSE stream")
+        logger.info(f"DevCycle: Received message: {message.data}")
+        sse_message = json.loads(message.data)
+        dvc_data = json.loads(sse_message.get("data"))
+        if (
+            dvc_data.get("type") == "refetchConfig"
+            or dvc_data.get("type") == ""
+            or dvc_data.get("type") is None
+        ):
+            logger.info("DevCycle: Received refetchConfig message - updating config")
+            self._get_config(dvc_data["lastModified"])
+
+    def sse_error(self, error: ld_eventsource.actions.Fault):
+        logger.warning(f"DevCycle: Received SSE error: {error}")
+
+    def sse_state(self, state: ld_eventsource.actions.Start):
+        self._sse_connected = True
+        logger.info("DevCycle: Connected to SSE stream")
 
     def close(self):
         self._polling_enabled = False

devcycle_python_server_sdk-3.8.0/devcycle_python_sdk/managers/sse_manager.py

@@ -0,0 +1,63 @@
+import threading
+
+import ld_eventsource
+import ld_eventsource.actions
+import ld_eventsource.config
+from typing import Callable
+
+
+class SSEManager:
+    def __init__(
+        self,
+        handlestate: Callable[[ld_eventsource.actions.Start], None],
+        handleerror: Callable[[ld_eventsource.actions.Fault], None],
+        handlemessage: Callable[[ld_eventsource.actions.Event], None],
+    ):
+        self.client: ld_eventsource.SSEClient = None
+        self.url = ""
+        self.handlestate = handlestate
+        self.handleerror = handleerror
+        self.handlemessage = handlemessage
+
+        self.read_thread = threading.Thread(
+            target=self.read_events,
+            args=(self.handlestate, self.handleerror, self.handlemessage),
+        )
+
+    def read_events(
+        self,
+        handlestate: Callable[[ld_eventsource.actions.Start], None],
+        handleerror: Callable[[ld_eventsource.actions.Fault], None],
+        handlemessage: Callable[[ld_eventsource.actions.Event], None],
+    ):
+        self.client.start()
+        for event in self.client.all:
+            if isinstance(event, ld_eventsource.actions.Start):
+                handlestate(event)
+            elif isinstance(event, ld_eventsource.actions.Fault):
+                handleerror(event)
+            elif isinstance(event, ld_eventsource.actions.Event):
+                handlemessage(event)
+
+    def update(self, config: dict):
+        if self.use_new_config(config["sse"]):
+            self.url = config["sse"]["hostname"] + config["sse"]["path"]
+            if self.client is not None:
+                self.client.close()
+            if self.read_thread.is_alive():
+                self.read_thread.join()
+            self.client = ld_eventsource.SSEClient(
+                connect=ld_eventsource.config.ConnectStrategy.http(self.url),
+                error_strategy=ld_eventsource.config.ErrorStrategy.CONTINUE,
+            )
+            self.read_thread = threading.Thread(
+                target=self.read_events,
+                args=(self.handlestate, self.handleerror, self.handlemessage),
+            )
+            self.read_thread.start()
+
+    def use_new_config(self, config: dict) -> bool:
+        new_url = config["hostname"] + config["path"]
+        if self.url == "" or self.url is None and new_url != "":
+            return True
+        return self.url != new_url

{devcycle-python-server-sdk-3.7.0 → devcycle_python_server_sdk-3.8.0}/devcycle_python_sdk/models/user.py

@@ -125,7 +125,7 @@ class DevCycleUser:
                 if key == "user_id":
                     continue
 
-                if value:
+                if value is not None:
                     if key == "email" and isinstance(value, str):
                         user.email = value
                     elif key == "name" and isinstance(value, str):

{devcycle-python-server-sdk-3.7.0 → devcycle_python_server_sdk-3.8.0}/devcycle_python_sdk/options.py

@@ -45,6 +45,8 @@ class DevCycleLocalOptions:
         event_retry_delay_ms: int = 200,  # milliseconds
         disable_automatic_event_logging: bool = False,
         disable_custom_event_logging: bool = False,
+        enable_beta_realtime_updates: bool = False,
+        disable_realtime_updates: bool = False,
     ):
         self.events_api_uri = events_api_uri
         self.config_cdn_uri = config_cdn_uri
@@ -60,6 +62,12 @@ class DevCycleLocalOptions:
         self.on_client_initialized = on_client_initialized
         self.event_request_timeout_ms = event_request_timeout_ms
         self.event_retry_delay_ms = event_retry_delay_ms
+        self.disable_realtime_updates = disable_realtime_updates
+
+        if enable_beta_realtime_updates:
+            logger.warning(
+                "DevCycle: `enable_beta_realtime_updates` is deprecated and will be removed in a future release.",
+            )
 
         if self.flush_event_queue_size >= self.max_event_queue_size:
             logger.warning(

devcycle_python_server_sdk-3.8.0/devcycle_python_sdk/protobuf/variableForUserParams_pb2.pyi

@@ -0,0 +1,120 @@
+from google.protobuf.internal import containers as _containers
+from google.protobuf.internal import enum_type_wrapper as _enum_type_wrapper
+from google.protobuf import descriptor as _descriptor
+from google.protobuf import message as _message
+from typing import ClassVar as _ClassVar, Mapping as _Mapping, Optional as _Optional, Union as _Union
+
+Bool: CustomDataType
+Boolean: VariableType_PB
+DESCRIPTOR: _descriptor.FileDescriptor
+JSON: VariableType_PB
+Null: CustomDataType
+Num: CustomDataType
+Number: VariableType_PB
+Str: CustomDataType
+String: VariableType_PB
+
+class CustomDataValue(_message.Message):
+    __slots__ = ["boolValue", "doubleValue", "stringValue", "type"]
+    BOOLVALUE_FIELD_NUMBER: _ClassVar[int]
+    DOUBLEVALUE_FIELD_NUMBER: _ClassVar[int]
+    STRINGVALUE_FIELD_NUMBER: _ClassVar[int]
+    TYPE_FIELD_NUMBER: _ClassVar[int]
+    boolValue: bool
+    doubleValue: float
+    stringValue: str
+    type: CustomDataType
+    def __init__(self, type: _Optional[_Union[CustomDataType, str]] = ..., boolValue: bool = ..., doubleValue: _Optional[float] = ..., stringValue: _Optional[str] = ...) -> None: ...
+
+class DVCUser_PB(_message.Message):
+    __slots__ = ["appBuild", "appVersion", "country", "customData", "deviceModel", "email", "language", "name", "privateCustomData", "user_id"]
+    APPBUILD_FIELD_NUMBER: _ClassVar[int]
+    APPVERSION_FIELD_NUMBER: _ClassVar[int]
+    COUNTRY_FIELD_NUMBER: _ClassVar[int]
+    CUSTOMDATA_FIELD_NUMBER: _ClassVar[int]
+    DEVICEMODEL_FIELD_NUMBER: _ClassVar[int]
+    EMAIL_FIELD_NUMBER: _ClassVar[int]
+    LANGUAGE_FIELD_NUMBER: _ClassVar[int]
+    NAME_FIELD_NUMBER: _ClassVar[int]
+    PRIVATECUSTOMDATA_FIELD_NUMBER: _ClassVar[int]
+    USER_ID_FIELD_NUMBER: _ClassVar[int]
+    appBuild: NullableDouble
+    appVersion: NullableString
+    country: NullableString
+    customData: NullableCustomData
+    deviceModel: NullableString
+    email: NullableString
+    language: NullableString
+    name: NullableString
+    privateCustomData: NullableCustomData
+    user_id: str
+    def __init__(self, user_id: _Optional[str] = ..., email: _Optional[_Union[NullableString, _Mapping]] = ..., name: _Optional[_Union[NullableString, _Mapping]] = ..., language: _Optional[_Union[NullableString, _Mapping]] = ..., country: _Optional[_Union[NullableString, _Mapping]] = ..., appBuild: _Optional[_Union[NullableDouble, _Mapping]] = ..., appVersion: _Optional[_Union[NullableString, _Mapping]] = ..., deviceModel: _Optional[_Union[NullableString, _Mapping]] = ..., customData: _Optional[_Union[NullableCustomData, _Mapping]] = ..., privateCustomData: _Optional[_Union[NullableCustomData, _Mapping]] = ...) -> None: ...
+
+class NullableCustomData(_message.Message):
+    __slots__ = ["isNull", "value"]
+    class ValueEntry(_message.Message):
+        __slots__ = ["key", "value"]
+        KEY_FIELD_NUMBER: _ClassVar[int]
+        VALUE_FIELD_NUMBER: _ClassVar[int]
+        key: str
+        value: CustomDataValue
+        def __init__(self, key: _Optional[str] = ..., value: _Optional[_Union[CustomDataValue, _Mapping]] = ...) -> None: ...
+    ISNULL_FIELD_NUMBER: _ClassVar[int]
+    VALUE_FIELD_NUMBER: _ClassVar[int]
+    isNull: bool
+    value: _containers.MessageMap[str, CustomDataValue]
+    def __init__(self, value: _Optional[_Mapping[str, CustomDataValue]] = ..., isNull: bool = ...) -> None: ...
+
+class NullableDouble(_message.Message):
+    __slots__ = ["isNull", "value"]
+    ISNULL_FIELD_NUMBER: _ClassVar[int]
+    VALUE_FIELD_NUMBER: _ClassVar[int]
+    isNull: bool
+    value: float
+    def __init__(self, value: _Optional[float] = ..., isNull: bool = ...) -> None: ...
+
+class NullableString(_message.Message):
+    __slots__ = ["isNull", "value"]
+    ISNULL_FIELD_NUMBER: _ClassVar[int]
+    VALUE_FIELD_NUMBER: _ClassVar[int]
+    isNull: bool
+    value: str
+    def __init__(self, value: _Optional[str] = ..., isNull: bool = ...) -> None: ...
+
+class SDKVariable_PB(_message.Message):
+    __slots__ = ["_id", "boolValue", "doubleValue", "evalReason", "key", "stringValue", "type"]
+    BOOLVALUE_FIELD_NUMBER: _ClassVar[int]
+    DOUBLEVALUE_FIELD_NUMBER: _ClassVar[int]
+    EVALREASON_FIELD_NUMBER: _ClassVar[int]
+    KEY_FIELD_NUMBER: _ClassVar[int]
+    STRINGVALUE_FIELD_NUMBER: _ClassVar[int]
+    TYPE_FIELD_NUMBER: _ClassVar[int]
+    _ID_FIELD_NUMBER: _ClassVar[int]
+    _id: str
+    boolValue: bool
+    doubleValue: float
+    evalReason: NullableString
+    key: str
+    stringValue: str
+    type: VariableType_PB
+    def __init__(self, _id: _Optional[str] = ..., type: _Optional[_Union[VariableType_PB, str]] = ..., key: _Optional[str] = ..., boolValue: bool = ..., doubleValue: _Optional[float] = ..., stringValue: _Optional[str] = ..., evalReason: _Optional[_Union[NullableString, _Mapping]] = ...) -> None: ...
+
+class VariableForUserParams_PB(_message.Message):
+    __slots__ = ["sdkKey", "shouldTrackEvent", "user", "variableKey", "variableType"]
+    SDKKEY_FIELD_NUMBER: _ClassVar[int]
+    SHOULDTRACKEVENT_FIELD_NUMBER: _ClassVar[int]
+    USER_FIELD_NUMBER: _ClassVar[int]
+    VARIABLEKEY_FIELD_NUMBER: _ClassVar[int]
+    VARIABLETYPE_FIELD_NUMBER: _ClassVar[int]
+    sdkKey: str
+    shouldTrackEvent: bool
+    user: DVCUser_PB
+    variableKey: str
+    variableType: VariableType_PB
+    def __init__(self, sdkKey: _Optional[str] = ..., variableKey: _Optional[str] = ..., variableType: _Optional[_Union[VariableType_PB, str]] = ..., user: _Optional[_Union[DVCUser_PB, _Mapping]] = ..., shouldTrackEvent: bool = ...) -> None: ...
+
+class VariableType_PB(int, metaclass=_enum_type_wrapper.EnumTypeWrapper):
+    __slots__ = []
+
+class CustomDataType(int, metaclass=_enum_type_wrapper.EnumTypeWrapper):
+    __slots__ = []

devcycle_python_server_sdk-3.8.0/devcycle_python_server_sdk.egg-info/PKG-INFO

@@ -0,0 +1,25 @@
+Metadata-Version: 2.2
+Name: devcycle-python-server-sdk
+Version: 3.8.0
+Summary: DevCycle Python SDK
+Home-page: https://github.com/devcycleHQ/python-server-sdk
+Author-email: 
+Keywords: DevCycle
+License-File: LICENSE
+Requires-Dist: setuptools>=21.0.0
+Requires-Dist: urllib3>=1.15.1
+Requires-Dist: requests~=2.31
+Requires-Dist: wasmtime==23.0.0
+Requires-Dist: protobuf>=4.23.3
+Requires-Dist: openfeature-sdk>=0.7.0
+Requires-Dist: launchdarkly-eventsource>=1.2.0
+Requires-Dist: responses~=0.23.1
+Requires-Dist: dataclasses~=0.6
+Dynamic: description
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: requires-dist
+Dynamic: summary
+
+    The DevCycle Python SDK used for feature management.
+    

{devcycle-python-server-sdk-3.7.0 → devcycle_python_server_sdk-3.8.0}/devcycle_python_server_sdk.egg-info/SOURCES.txt

@@ -3,12 +3,15 @@ README.md
 pyproject.toml
 setup.cfg
 setup.py
+devcycle_python_sdk/VERSION.txt
 devcycle_python_sdk/__init__.py
+devcycle_python_sdk/bucketing-lib.release.wasm
 devcycle_python_sdk/cloud_client.py
 devcycle_python_sdk/devcycle_client.py
 devcycle_python_sdk/exceptions.py
 devcycle_python_sdk/local_client.py
 devcycle_python_sdk/options.py
+devcycle_python_sdk/py.typed
 devcycle_python_sdk/api/__init__.py
 devcycle_python_sdk/api/backoff.py
 devcycle_python_sdk/api/bucketing_client.py
@@ -18,6 +21,7 @@ devcycle_python_sdk/api/local_bucketing.py
 devcycle_python_sdk/managers/__init__.py
 devcycle_python_sdk/managers/config_manager.py
 devcycle_python_sdk/managers/event_queue_manager.py
+devcycle_python_sdk/managers/sse_manager.py
 devcycle_python_sdk/models/__init__.py
 devcycle_python_sdk/models/bucketed_config.py
 devcycle_python_sdk/models/error_response.py
@@ -31,6 +35,7 @@ devcycle_python_sdk/open_feature_provider/provider.py
 devcycle_python_sdk/protobuf/__init__.py
 devcycle_python_sdk/protobuf/utils.py
 devcycle_python_sdk/protobuf/variableForUserParams_pb2.py
+devcycle_python_sdk/protobuf/variableForUserParams_pb2.pyi
 devcycle_python_sdk/util/__init__.py
 devcycle_python_sdk/util/strings.py
 devcycle_python_sdk/util/version.py

{devcycle-python-server-sdk-3.7.0 → devcycle_python_server_sdk-3.8.0}/devcycle_python_server_sdk.egg-info/requires.txt

@@ -4,3 +4,6 @@ requests~=2.31
 wasmtime==23.0.0
 protobuf>=4.23.3
 openfeature-sdk>=0.7.0
+launchdarkly-eventsource>=1.2.0
+responses~=0.23.1
+dataclasses~=0.6

{devcycle-python-server-sdk-3.7.0 → devcycle_python_server_sdk-3.8.0}/pyproject.toml

@@ -28,6 +28,12 @@ ignore_missing_imports = true
 module = 'test.openfeature.*'
 ignore_errors = true
 
+[[tool.mypy.overrides]]
+module = 'ld_eventsource.*'
+ignore_errors = true
+ignore_missing_imports = true
+
+
 [[tool.mypy.overrides]]
 module = 'openfeature.*'
 ignore_errors = true

{devcycle-python-server-sdk-3.7.0 → devcycle_python_server_sdk-3.8.0}/test/managers/test_config_manager.py

@@ -19,7 +19,9 @@ class EnvironmentConfigManagerTest(unittest.TestCase):
     def setUp(self) -> None:
         self.sdk_key = "dvc_server_" + str(uuid.uuid4())
         self.test_local_bucketing = MagicMock()
-        self.test_options = DevCycleLocalOptions(config_polling_interval_ms=500)
+        self.test_options = DevCycleLocalOptions(
+            config_polling_interval_ms=500, disable_realtime_updates=True
+        )
 
         now = datetime.now()
         stamp = mktime(now.timetuple())

{devcycle-python-server-sdk-3.7.0 → devcycle_python_server_sdk-3.8.0}/test/models/test_user.py

@@ -129,7 +129,7 @@ class DevCycleUserTest(unittest.TestCase):
                 "strValue": "hello",
                 "intValue": 123,
                 "floatValue": 3.1456,
-                "boolValue": True,
+                "boolValue": False,
             },
         )
         user = DevCycleUser.create_user_from_context(context)
@@ -143,7 +143,7 @@ class DevCycleUserTest(unittest.TestCase):
                 "strValue": "hello",
                 "intValue": 123,
                 "floatValue": 3.1456,
-                "boolValue": True,
+                "boolValue": False,
             },
         )
         self.assertEqual(user.privateCustomData, None)

{devcycle-python-server-sdk-3.7.0 → devcycle_python_server_sdk-3.8.0}/test/test_local_client.py

@@ -40,6 +40,7 @@ class DevCycleLocalClientTest(unittest.TestCase):
             config_cdn_uri="http://localhost/",
             disable_custom_event_logging=True,
             disable_automatic_event_logging=True,
+            disable_realtime_updates=True,
         )
         self.test_user = DevCycleUser(user_id="test_user_id")
         self.test_user_empty_id = DevCycleUser(user_id="")

devcycle-python-server-sdk-3.7.0/PKG-INFO

@@ -1,12 +0,0 @@
-Metadata-Version: 1.0
-Name: devcycle-python-server-sdk
-Version: 3.7.0
-Summary: DevCycle Python SDK
-Home-page: https://github.com/devcycleHQ/python-server-sdk
-Author: UNKNOWN
-Author-email: UNKNOWN
-License: UNKNOWN
-Description:     The DevCycle Python SDK used for feature management.
-            
-Keywords: DevCycle
-Platform: UNKNOWN

devcycle-python-server-sdk-3.7.0/devcycle_python_server_sdk.egg-info/PKG-INFO

@@ -1,12 +0,0 @@
-Metadata-Version: 1.0
-Name: devcycle-python-server-sdk
-Version: 3.7.0
-Summary: DevCycle Python SDK
-Home-page: https://github.com/devcycleHQ/python-server-sdk
-Author: UNKNOWN
-Author-email: UNKNOWN
-License: UNKNOWN
-Description:     The DevCycle Python SDK used for feature management.
-            
-Keywords: DevCycle
-Platform: UNKNOWN