devcycle-python-server-sdk 3.3.3__tar.gz → 3.6.0__tar.gz

devcycle-python-server-sdk-3.6.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Taplytics Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

{devcycle-python-server-sdk-3.3.3 → devcycle-python-server-sdk-3.6.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 1.0
 Name: devcycle-python-server-sdk
-Version: 3.3.3
+Version: 3.6.0
 Summary: DevCycle Python SDK
 Home-page: https://github.com/devcycleHQ/python-server-sdk
 Author: UNKNOWN

{devcycle-python-server-sdk-3.3.3 → devcycle-python-server-sdk-3.6.0}/README.md

@@ -6,7 +6,7 @@ This SDK allows your application to interface with the [DevCycle Bucketing API](
 
 ## Requirements.
 
-* Python 3.7+
+* Python 3.8+
 
 ## Installation
 
@@ -39,13 +39,28 @@ value = client.variable_value(user, 'variable-key', 'default-value')
 
 The DevCycle client is designed to work as a singleton in your application. You should create a single instance of the client during application initialization
 
+## OpenFeature Support
+
+This SDK provides an alpha implementation of the [OpenFeature](https://openfeature.dev/) Provider interface. Use the `get_openfeature_provider()` function on the DevCycle SDK client to obtain a provider for OpenFeature.
+
+```python
+from openfeature import api
+
+devcycle_client = DevCycleLocalClient('DEVCYCLE_SERVER_SDK_KEY', options)
+api.set_provider(devcycle_client.get_openfeature_provider())
+```
+
+More details are in the [DevCycle Python SDK OpenFeature Provider](OpenFeature.md) guide.
+
+> :warning: **OpenFeature support is in an early release and may have some rough edges**. Please report any issues to us and we'll be happy to help!
+
 ## Usage
 
 To find usage documentation, visit our [docs](https://docs.devcycle.com/docs/sdk/server-side-sdks/python#usage).
 
 ## Development
 
-When developing the SDK it is recommended that you have both a 3.7 and 3.11 python interpreter installed in order to verify changes across different versions of python.
+When developing the SDK it is recommended that you have both a 3.8 and 3.12 python interpreter installed in order to verify changes across different versions of python.
 
 ### Dependencies
 

{devcycle-python-server-sdk-3.3.3 → devcycle-python-server-sdk-3.6.0}/devcycle_python_sdk/__init__.py

@@ -1,5 +1,6 @@
 # Simplify imports for the SDK entry point objects
 
 from devcycle_python_sdk.options import DevCycleCloudOptions, DevCycleLocalOptions
+from devcycle_python_sdk.devcycle_client import AbstractDevCycleClient
 from devcycle_python_sdk.cloud_client import DevCycleCloudClient
 from devcycle_python_sdk.local_client import DevCycleLocalClient

{devcycle-python-server-sdk-3.3.3 → devcycle-python-server-sdk-3.6.0}/devcycle_python_sdk/api/bucketing_client.py

@@ -1,6 +1,5 @@
 import logging
 import time
-from os.path import join
 from typing import Dict, List, Optional
 
 import requests
@@ -16,6 +15,7 @@ from devcycle_python_sdk.models.event import DevCycleEvent
 from devcycle_python_sdk.models.feature import Feature
 from devcycle_python_sdk.models.user import DevCycleUser
 from devcycle_python_sdk.models.variable import Variable
+from devcycle_python_sdk.util.strings import slash_join
 
 logger = logging.getLogger(__name__)
 
@@ -33,7 +33,7 @@ class BucketingAPIClient:
         self.session.max_redirects = 0
 
     def _url(self, *path_args: str) -> str:
-        return join(self.options.bucketing_api_uri, "v1", *path_args)
+        return slash_join(self.options.bucketing_api_uri, "v1", *path_args)
 
     def request(self, method: str, url: str, **kwargs) -> dict:
         retries_remaining = self.options.request_retries + 1

{devcycle-python-server-sdk-3.3.3 → devcycle-python-server-sdk-3.6.0}/devcycle_python_sdk/api/config_client.py

@@ -1,9 +1,8 @@
 import logging
 import time
 from http import HTTPStatus
-from os.path import join
 from typing import Optional, Tuple
-
+import email.utils
 import requests
 
 from devcycle_python_sdk.api.backoff import exponential_backoff
@@ -13,6 +12,7 @@ from devcycle_python_sdk.exceptions import (
     NotFoundError,
     APIClientUnauthorizedError,
 )
+from devcycle_python_sdk.util.strings import slash_join
 
 logger = logging.getLogger(__name__)
 
@@ -29,20 +29,22 @@ class ConfigAPIClient:
         self.session.max_redirects = 0
         self.max_config_retries = 2
         self.config_file_url = (
-            join(self.options.config_cdn_uri, "config", "v1", "server", self.sdk_key)
+            slash_join(
+                self.options.config_cdn_uri, "config", "v1", "server", self.sdk_key
+            )
             + ".json"
         )
 
     def get_config(
-        self, config_etag: Optional[str] = None
-    ) -> Tuple[Optional[dict], Optional[str]]:
+        self, config_etag: Optional[str] = None, last_modified: Optional[str] = None
+    ) -> Tuple[Optional[dict], Optional[str], Optional[str]]:
         """
         Get the config from the server. If the config_etag is provided, the server will only return the config if it
         has changed since the last request. If the config hasn't changed, the server will return a 304 Not Modified
         response.
 
         :param config_etag: The etag of the last config request
-
+        :param last_modified: Last modified RFC1123 Timestamp of the stored config
         :return: A tuple containing the config and the etag of the config. If the config hasn't changed since the last
         request, the config will be None and the etag will be the same as the last request.
         """
@@ -54,6 +56,8 @@ class ConfigAPIClient:
         headers = {}
         if config_etag:
             headers["If-None-Match"] = config_etag
+        if last_modified:
+            headers["If-Modified-Since"] = last_modified
 
         attempts = 1
         while retries_remaining > 0:
@@ -72,7 +76,7 @@ class ConfigAPIClient:
                 elif res.status_code == HTTPStatus.NOT_MODIFIED:
                     # the config hasn't changed since the last request
                     # don't return anything
-                    return None, config_etag
+                    return None, config_etag, last_modified
                 elif res.status_code == HTTPStatus.NOT_FOUND:
                     # Not a retryable error
                     raise NotFoundError(url)
@@ -111,6 +115,16 @@ class ConfigAPIClient:
             raise APIClientError(message="Retries exceeded", cause=request_error)
 
         new_etag = res.headers.get("ETag", None)
+        new_lastmodified = res.headers.get("Last-Modified", None)
+
+        if last_modified and new_lastmodified:
+            stored_lm = email.utils.parsedate_to_datetime(last_modified)
+            response_lm = email.utils.parsedate_to_datetime(new_lastmodified)
+            if stored_lm > response_lm:
+                logger.warning(
+                    "Request returned a last modified header older than the current stored timestamp. not saving config"
+                )
+                return None, None, None
 
         data: dict = res.json()
-        return data, new_etag
+        return data, new_etag, new_lastmodified

{devcycle-python-server-sdk-3.3.3 → devcycle-python-server-sdk-3.6.0}/devcycle_python_sdk/api/event_client.py

@@ -1,7 +1,6 @@
 import json
 import logging
 import time
-from os.path import join
 from typing import Optional, List
 
 import requests
@@ -14,6 +13,7 @@ from devcycle_python_sdk.exceptions import (
     APIClientUnauthorizedError,
 )
 from devcycle_python_sdk.models.event import UserEventsBatchRecord
+from devcycle_python_sdk.util.strings import slash_join
 
 logger = logging.getLogger(__name__)
 
@@ -29,7 +29,7 @@ class EventAPIClient:
         }
         self.session.max_redirects = 0
         self.max_batch_retries = 0  # we don't retry events batches
-        self.batch_url = join(self.options.events_api_uri, "v1/events/batch")
+        self.batch_url = slash_join(self.options.events_api_uri, "v1/events/batch")
 
     def publish_events(self, batch: List[UserEventsBatchRecord]) -> str:
         """

{devcycle-python-server-sdk-3.3.3 → devcycle-python-server-sdk-3.6.0}/devcycle_python_sdk/api/local_bucketing.py

@@ -105,7 +105,7 @@ class LocalBucketing:
 
         def __console_log_func(message_ptr) -> None:
             message: str = self._read_assembly_script_string(message_ptr)
-            logger.warning(f"WASM console: {message!r}")
+            logger.warning(f"DevCycle: WASM console: {message!r}")
 
         wasm_linker.define_func(
             "env", "console.log", FuncType([ValType.i32()], []), __console_log_func

{devcycle-python-server-sdk-3.3.3 → devcycle-python-server-sdk-3.6.0}/devcycle_python_sdk/cloud_client.py

@@ -3,7 +3,7 @@ import platform
 
 from typing import Any, Dict
 
-from devcycle_python_sdk import DevCycleCloudOptions
+from devcycle_python_sdk import DevCycleCloudOptions, AbstractDevCycleClient
 from devcycle_python_sdk.api.bucketing_client import BucketingAPIClient
 from devcycle_python_sdk.exceptions import (
     NotFoundError,
@@ -14,11 +14,18 @@ from devcycle_python_sdk.models.event import DevCycleEvent
 from devcycle_python_sdk.models.variable import Variable
 from devcycle_python_sdk.models.feature import Feature
 from devcycle_python_sdk.util.version import sdk_version
+from devcycle_python_sdk.open_feature_provider.provider import DevCycleProvider
+
+from openfeature.provider import AbstractProvider
 
 logger = logging.getLogger(__name__)
 
 
-class DevCycleCloudClient:
+class DevCycleCloudClient(AbstractDevCycleClient):
+    """
+    The DevCycle Python SDK that utilizes the DevCycle Bucketing API for feature and variable evaluation
+    """
+
     options: DevCycleCloudOptions
     platform: str
     platform_version: str
@@ -37,6 +44,13 @@ class DevCycleCloudClient:
         self.sdk_version = sdk_version()
         self.sdk_type = "server"
         self.bucketing_api = BucketingAPIClient(sdk_key, self.options)
+        self._openfeature_provider = DevCycleProvider(self)
+
+    def get_sdk_platform(self) -> str:
+        return "Cloud"
+
+    def get_openfeature_provider(self) -> AbstractProvider:
+        return self._openfeature_provider
 
     def _add_platform_data_to_user(self, user: DevCycleUser) -> DevCycleUser:
         user.platform = self.platform
@@ -45,6 +59,9 @@ class DevCycleCloudClient:
         user.sdkType = self.sdk_type
         return user
 
+    def is_initialized(self) -> bool:
+        return True
+
     def variable_value(self, user: DevCycleUser, key: str, default_value: Any) -> Any:
         """
         Evaluates a variable for a user and returns the value.  If the user is not bucketed into the variable, the default value will be returned
@@ -73,15 +90,15 @@ class DevCycleCloudClient:
         try:
             variable = self.bucketing_api.variable(key, user)
         except CloudClientUnauthorizedError as e:
-            logger.warning("DevCycle SDK key is invalid, unable to make cloud request")
+            logger.warning("DevCycle: SDK key is invalid, unable to make cloud request")
             raise e
         except NotFoundError:
-            logger.warning(f"Variable not found: {key}")
+            logger.warning(f"DevCycle: Variable not found: {key}")
             return Variable.create_default_variable(
                 key=key, default_value=default_value
             )
         except Exception as e:
-            logger.error(f"Error evaluating variable: {e}")
+            logger.error(f"DevCycle: Error evaluating variable: {e}")
             return Variable.create_default_variable(
                 key=key, default_value=default_value
             )
@@ -91,7 +108,7 @@ class DevCycleCloudClient:
         # Allow default value to be a subclass of the same type as the variable
         if not isinstance(default_value, type(variable.value)):
             logger.warning(
-                f"Variable {key} is type {type(variable.value)}, but default value is type {type(default_value)}",
+                f"DevCycle: Variable {key} is type {type(variable.value)}, but default value is type {type(default_value)}",
             )
             return Variable.create_default_variable(
                 key=key, default_value=default_value
@@ -112,10 +129,10 @@ class DevCycleCloudClient:
         try:
             variable_map = self.bucketing_api.variables(user)
         except CloudClientUnauthorizedError as e:
-            logger.warning("SDK key is invalid, unable to make cloud request")
+            logger.warning("DevCycle: SDK key is invalid, unable to make cloud request")
             raise e
         except Exception as e:
-            logger.error(f"Error retrieving all features for a user: {e}")
+            logger.error(f"DevCycle: Error retrieving all features for a user: {e}")
 
         return variable_map
 
@@ -132,10 +149,10 @@ class DevCycleCloudClient:
         try:
             feature_map = self.bucketing_api.features(user)
         except CloudClientUnauthorizedError as e:
-            logger.warning("SDK key is invalid, unable to make cloud request")
+            logger.warning("DevCycle: SDK key is invalid, unable to make cloud request")
             raise e
         except Exception as e:
-            logger.error(f"Error retrieving all features for a user: {e}")
+            logger.error(f"DevCycle: Error retrieving all features for a user: {e}")
 
         return feature_map
 
@@ -160,10 +177,10 @@ class DevCycleCloudClient:
         try:
             self.bucketing_api.track(user, events)
         except CloudClientUnauthorizedError as e:
-            logger.warning("SDK key is invalid, unable to make cloud request")
+            logger.warning("DevCycle: SDK key is invalid, unable to make cloud request")
             raise e
         except Exception as e:
-            logger.error(f"Error tracking event: {e}")
+            logger.error(f"DevCycle: Error tracking event: {e}")
 
 
 def _validate_sdk_key(sdk_key: str) -> None:

devcycle-python-server-sdk-3.6.0/devcycle_python_sdk/devcycle_client.py

@@ -0,0 +1,40 @@
+import typing
+from abc import abstractmethod
+
+from devcycle_python_sdk.models.user import DevCycleUser
+from devcycle_python_sdk.models.variable import Variable
+
+from openfeature.provider import AbstractProvider
+
+
+class AbstractDevCycleClient:
+    """
+    A common interface for all DevCycle Clients
+    """
+
+    @abstractmethod
+    def is_initialized(self) -> bool:
+        pass
+
+    @abstractmethod
+    def variable(
+        self, user: DevCycleUser, key: str, default_value: typing.Any
+    ) -> Variable:
+        pass
+
+    @abstractmethod
+    def variable_value(
+        self, user: DevCycleUser, key: str, default_value: typing.Any
+    ) -> typing.Any:
+        pass
+
+    @abstractmethod
+    def get_openfeature_provider(self) -> AbstractProvider:
+        """
+        Returns the OpenFeature provider for this client
+        """
+        pass
+
+    @abstractmethod
+    def get_sdk_platform(self) -> str:
+        pass

{devcycle-python-server-sdk-3.3.3 → devcycle-python-server-sdk-3.6.0}/devcycle_python_sdk/local_client.py

@@ -3,7 +3,7 @@ import logging
 from numbers import Real
 from typing import Any, Dict, Union
 
-from devcycle_python_sdk import DevCycleLocalOptions
+from devcycle_python_sdk import DevCycleLocalOptions, AbstractDevCycleClient
 from devcycle_python_sdk.api.local_bucketing import LocalBucketing
 from devcycle_python_sdk.exceptions import VariableTypeMismatchError
 from devcycle_python_sdk.managers.config_manager import EnvironmentConfigManager
@@ -14,11 +14,17 @@ from devcycle_python_sdk.models.feature import Feature
 from devcycle_python_sdk.models.platform_data import default_platform_data
 from devcycle_python_sdk.models.user import DevCycleUser
 from devcycle_python_sdk.models.variable import Variable
+from devcycle_python_sdk.open_feature_provider.provider import DevCycleProvider
+from openfeature.provider import AbstractProvider
 
 logger = logging.getLogger(__name__)
 
 
-class DevCycleLocalClient:
+class DevCycleLocalClient(AbstractDevCycleClient):
+    """
+    The DevCycle Python SDK that utilizes the local bucketing library for feature and variable evaluation
+    """
+
     def __init__(self, sdk_key: str, options: DevCycleLocalOptions):
         _validate_sdk_key(sdk_key)
         self._sdk_key = sdk_key
@@ -42,6 +48,14 @@ class DevCycleLocalClient:
             sdk_key, self.options, self.local_bucketing
         )
 
+        self._openfeature_provider = DevCycleProvider(self)
+
+    def get_sdk_platform(self) -> str:
+        return "Local"
+
+    def get_openfeature_provider(self) -> AbstractProvider:
+        return self._openfeature_provider
+
     def is_initialized(self) -> bool:
         return self.config_manager.is_initialized()
 
@@ -57,7 +71,9 @@ class DevCycleLocalClient:
         are not permitted
         """
         if not self.is_initialized():
-            logger.debug("set_client_custom_data called before client has initialized")
+            logger.debug(
+                "DevCycle: set_client_custom_data called before client has initialized"
+            )
             return
 
         if custom_data:
@@ -65,7 +81,7 @@ class DevCycleLocalClient:
                 custom_data_json = json.dumps(custom_data)
                 self.local_bucketing.set_client_custom_data(custom_data_json)
             except Exception as e:
-                logger.error("Error setting custom data: " + str(e))
+                logger.error("DevCycle: Error setting custom data: " + str(e))
 
     def variable_value(self, user: DevCycleUser, key: str, default_value: Any) -> Any:
         """
@@ -92,7 +108,7 @@ class DevCycleLocalClient:
             raise ValueError("Missing parameter: defaultValue")
 
         if not self.is_initialized():
-            logger.debug("variable called before client has initialized")
+            logger.debug("DevCycle: variable called before client has initialized")
             try:
                 self.event_queue_manager.queue_aggregate_event(
                     event=DevCycleEvent(
@@ -102,7 +118,7 @@ class DevCycleLocalClient:
                 )
             except Exception as e:
                 logger.warning(
-                    f"Unable to track AggVariableDefaulted event for Variable {key}: {e}"
+                    f"DevCycle: Unable to track AggVariableDefaulted event for Variable {key}: {e}"
                 )
             return Variable.create_default_variable(key, default_value)
 
@@ -113,9 +129,9 @@ class DevCycleLocalClient:
             if variable:
                 return variable
         except VariableTypeMismatchError:
-            logger.debug("Variable type mismatch, returning default value")
+            logger.debug("DevCycle: Variable type mismatch, returning default value")
         except Exception as e:
-            logger.warning(f"Error retrieving variable for user: {e}")
+            logger.warning(f"DevCycle: Error retrieving variable for user: {e}")
 
         return Variable.create_default_variable(key, default_value)
 
@@ -137,7 +153,9 @@ class DevCycleLocalClient:
         _validate_user(user)
 
         if not self.is_initialized():
-            logger.warning("all_variables called before client has initialized")
+            logger.warning(
+                "DevCycle: all_variables called before client has initialized"
+            )
             return {}
 
         variable_map: Dict[str, Variable] = {}
@@ -145,7 +163,9 @@ class DevCycleLocalClient:
         try:
             return self.local_bucketing.generate_bucketed_config(user).variables
         except Exception as e:
-            logger.exception(f"Error retrieving all variables for a user: {e}")
+            logger.exception(
+                f"DevCycle: Error retrieving all variables for a user: {e}"
+            )
             return {}
 
         return variable_map
@@ -159,14 +179,16 @@ class DevCycleLocalClient:
         _validate_user(user)
 
         if not self.is_initialized():
-            logger.warning("all_features called before client has initialized")
+            logger.warning(
+                "DevCycle: all_features called before client has initialized"
+            )
             return {}
 
         feature_map: Dict[str, Feature] = {}
         try:
             return self.local_bucketing.generate_bucketed_config(user).features
         except Exception as e:
-            logger.exception(f"Error retrieving all features for a user: {e}")
+            logger.exception(f"DevCycle: Error retrieving all features for a user: {e}")
 
         return feature_map
 
@@ -186,13 +208,13 @@ class DevCycleLocalClient:
             raise ValueError("Missing parameter: type")
 
         if not self.is_initialized():
-            logger.debug("track called before client has initialized")
+            logger.debug("DevCycle: track called before client has initialized")
             return
 
         try:
             self.event_queue_manager.queue_event(user, user_event)
         except Exception as e:
-            logger.error(f"Error tracking event: {e}")
+            logger.error(f"DevCycle: Error tracking event: {e}")
 
     def close(self) -> None:
         """

{devcycle-python-server-sdk-3.3.3 → devcycle-python-server-sdk-3.6.0}/devcycle_python_sdk/managers/config_manager.py

@@ -30,6 +30,7 @@ class EnvironmentConfigManager(threading.Thread):
 
         self._config: Optional[dict] = None
         self._config_etag: Optional[str] = None
+        self._config_lastmodified: Optional[str] = None
 
         self._config_api_client = ConfigAPIClient(self._sdk_key, self._options)
 
@@ -42,17 +43,20 @@ class EnvironmentConfigManager(threading.Thread):
 
     def _get_config(self):
         try:
-            new_config, new_etag = self._config_api_client.get_config(
-                config_etag=self._config_etag
+            new_config, new_etag, new_lastmodified = self._config_api_client.get_config(
+                config_etag=self._config_etag, last_modified=self._config_lastmodified
             )
 
+            # Abort early if the last modified is before the sent one.
+            if new_config is None and new_etag is None and new_lastmodified is None:
+                return
             if new_config is None and new_etag == self._config_etag:
                 # api not returning data and the etag is the same
                 # no change to the config since last request
                 return
             elif new_config is None:
                 logger.warning(
-                    "Config CDN fetch returned no data with a different etag"
+                    "DevCycle: Config CDN fetch returned no data with a different etag"
                 )
                 return
 
@@ -60,6 +64,7 @@ class EnvironmentConfigManager(threading.Thread):
 
             self._config = new_config
             self._config_etag = new_etag
+            self._config_lastmodified = new_lastmodified
 
             json_config = json.dumps(self._config)
             self._local_bucketing.store_config(json_config)
@@ -73,12 +78,14 @@ class EnvironmentConfigManager(threading.Thread):
                 except Exception as e:
                     # consume any error
                     logger.warning(
-                        f"Error received from on_client_initialized callback: {str(e)}"
+                        f"DevCycle: Error received from on_client_initialized callback: {str(e)}"
                     )
         except CloudClientError as e:
-            logger.warning(f"Config fetch failed. Status: {str(e)}")
+            logger.warning(f"DevCycle: Config fetch failed. Status: {str(e)}")
         except CloudClientUnauthorizedError:
-            logger.error("Unauthorized to get config. Aborting config polling.")
+            logger.error(
+                "DevCycle: Unauthorized to get config. Aborting config polling."
+            )
             self._polling_enabled = False
 
     def run(self):
@@ -88,7 +95,9 @@ class EnvironmentConfigManager(threading.Thread):
             except Exception as e:
                 if self._polling_enabled:
                     # Only log a warning if we're still polling
-                    logger.warning(f"Error polling for config changes: {str(e)}")
+                    logger.warning(
+                        f"DevCycle: Error polling for config changes: {str(e)}"
+                    )
             time.sleep(self._options.config_polling_interval_ms / 1000.0)
 
     def close(self):