devcycle-python-server-sdk 3.13.0__py3-none-any.whl → 3.13.1__py3-none-any.whl

devcycle_python_sdk/VERSION.txt

@@ -1 +1 @@
-3.13.0
+3.13.1

devcycle_python_sdk/models/user.py

@@ -1,7 +1,7 @@
 # ruff: noqa: N815
 from dataclasses import dataclass, field
 from datetime import datetime, timezone
-from typing import Dict, Optional, Any
+from typing import Dict, Optional, Any, cast
 from openfeature.evaluation_context import EvaluationContext
 from openfeature.exception import TargetingKeyMissingError, InvalidContextError
 
@@ -114,10 +114,10 @@ class DevCycleUser:
                 user_id = context.targeting_key
                 user_id_source = "targeting_key"
             elif context.attributes and "user_id" in context.attributes.keys():
-                user_id = context.attributes["user_id"]
+                user_id = cast(str, context.attributes["user_id"])
                 user_id_source = "user_id"
             elif context.attributes and "userId" in context.attributes.keys():
-                user_id = context.attributes["userId"]
+                user_id = cast(str, context.attributes["userId"])
                 user_id_source = "userId"
 
         if not user_id:

devcycle_python_sdk/open_feature_provider/provider.py

@@ -1,7 +1,7 @@
 import logging
 import time
 
-from typing import Any, Optional, Union, List
+from typing import Any, Optional, Union, List, Mapping, Sequence
 
 from devcycle_python_sdk import AbstractDevCycleClient
 from devcycle_python_sdk.models.user import DevCycleUser
@@ -9,7 +9,7 @@ from devcycle_python_sdk.models.user import DevCycleUser
 from openfeature.provider import AbstractProvider
 from openfeature.provider.metadata import Metadata
 from openfeature.evaluation_context import EvaluationContext
-from openfeature.flag_evaluation import FlagResolutionDetails, Reason
+from openfeature.flag_evaluation import FlagResolutionDetails, Reason, FlagValueType
 from openfeature.exception import (
     ErrorCode,
     InvalidContextError,
@@ -138,10 +138,12 @@ class DevCycleProvider(AbstractProvider):
     def resolve_object_details(
         self,
         flag_key: str,
-        default_value: Union[dict, list],
+        default_value: Union[Mapping[str, FlagValueType], Sequence[FlagValueType]],
         evaluation_context: Optional[EvaluationContext] = None,
-    ) -> FlagResolutionDetails[Union[dict, list]]:
-        if not isinstance(default_value, dict):
+    ) -> FlagResolutionDetails[
+        Union[Mapping[str, FlagValueType], Sequence[FlagValueType]]
+    ]:
+        if not isinstance(default_value, Mapping):
             raise TypeMismatchError("Default value must be a flat dictionary")
 
         if default_value:

{devcycle_python_server_sdk-3.13.0.dist-info → devcycle_python_server_sdk-3.13.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: devcycle-python-server-sdk
-Version: 3.13.0
+Version: 3.13.1
 Summary: DevCycle Python SDK
 Home-page: https://github.com/devcycleHQ/python-server-sdk
 Author-email: 
@@ -12,7 +12,7 @@ Requires-Dist: urllib3>=1.15.1
 Requires-Dist: requests>=2.32
 Requires-Dist: wasmtime~=30.0.0
 Requires-Dist: protobuf>=4.23.3
-Requires-Dist: openfeature-sdk==0.8.0
+Requires-Dist: openfeature-sdk~=0.8.0
 Requires-Dist: launchdarkly-eventsource>=1.2.1
 Requires-Dist: responses>=0.23.1
 Dynamic: description

{devcycle_python_server_sdk-3.13.0.dist-info → devcycle_python_server_sdk-3.13.1.dist-info}/RECORD

@@ -1,4 +1,4 @@
-devcycle_python_sdk/VERSION.txt,sha256=NxOs_9lT1XG8y-FjlRru-YinX5RcBJt_ulPwgDESZ_o,7
+devcycle_python_sdk/VERSION.txt,sha256=d1t-sfDGOHao5o2Fv5VaJziw754bHVxGJ49Qa9H8BMo,7
 devcycle_python_sdk/__init__.py,sha256=30TcYb9PbvVi97gwk16omCGG1UoUI9lmmU7xpvxNMvc,336
 devcycle_python_sdk/bucketing-lib.release.wasm,sha256=6iooyHRR-GBfrBH0_mleWyaNHr9uM_nVPS-IXGROGCY,224670
 devcycle_python_sdk/cloud_client.py,sha256=dR2ye29Up699hO1cdrAWeoXIOBPVoSvQ4aKe2gSBRno,9414
@@ -30,11 +30,11 @@ devcycle_python_sdk/models/event.py,sha256=Sj3eEopuPp8QwQl_Oz8E6Y9Ph6nLG0HxU7eR7
 devcycle_python_sdk/models/feature.py,sha256=m3wxxIjC5jxhKpPLI4RcsBaNLuy-zsMqoAgc8ySPe0I,852
 devcycle_python_sdk/models/platform_data.py,sha256=nyQsgI6pcTd1FL3Y2ACmpvTYb08R_UtWul25OWZstps,849
 devcycle_python_sdk/models/project_metadata.py,sha256=zRoE_oy_N3isqfrA5hAZ7S-7i5QBTSu9OGigFAvTqi8,602
-devcycle_python_sdk/models/user.py,sha256=mhEk-mnKJRg_tydpBlAVhGDj9rDCacJ-jNwiGeSpZiE,7027
+devcycle_python_sdk/models/user.py,sha256=DgSP4iq9IxEOOBmYIKuCLXi6lVqYkt01_Wm0Z4-QWBo,7055
 devcycle_python_sdk/models/variable.py,sha256=NXubhYWXYRAUEh4kDe2Tu9T5QnZmQ3roYVPbP-u2H3s,3030
 devcycle_python_sdk/models/variable_metadata.py,sha256=oeH5fxDFLgAyc_B1RuOYRp4w68lTaBxTPvNgnXz7alE,583
 devcycle_python_sdk/open_feature_provider/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-devcycle_python_sdk/open_feature_provider/provider.py,sha256=l-psKU5m6jSBE53VwX3fBBas-TztekFDlfYTyTJQm6c,5558
+devcycle_python_sdk/open_feature_provider/provider.py,sha256=Iby2X2YuYgR6-W00NOWE4K7YdSUHODeqjm4Eog7pACc,5693
 devcycle_python_sdk/protobuf/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 devcycle_python_sdk/protobuf/utils.py,sha256=SwsXH5QGAfbSn1FvgwO3x4W8uTYLsL1r3E-P5nDD4Nw,5528
 devcycle_python_sdk/protobuf/variableForUserParams_pb2.py,sha256=SIFCo4AbjtlWQh2DYxkrWCR85PQajA4PIofXoRe4Gds,4956
@@ -42,11 +42,11 @@ devcycle_python_sdk/protobuf/variableForUserParams_pb2.pyi,sha256=OU4ORhjnbXy0Aq
 devcycle_python_sdk/util/__init__.py,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
 devcycle_python_sdk/util/strings.py,sha256=gH0Xm3gIXNqn6hczKPk10Jn5_9knuD7OB5MrB7bqztw,252
 devcycle_python_sdk/util/version.py,sha256=Cz7Us_EuXP-T8GI47g2WHYdBJj_zKo-5y545IDHJAjI,253
-devcycle_python_server_sdk-3.13.0.dist-info/licenses/LICENSE,sha256=tHQMqu-Jic2UpMGqb-vNFbGygysl8IG4l1clnnh0OFo,1071
+devcycle_python_server_sdk-3.13.1.dist-info/licenses/LICENSE,sha256=RlvZsEX5o__wLAA-VE7mG5hzTPjnFzPJKNdXXKvZ854,1071
 example/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 example/cloud_client_example.py,sha256=YD8ZsTv3dPYfbFUKraRpRT0VsJGrPwjm8ZCuA5H54yI,2463
 example/local_bucketing_client_example.py,sha256=TaIfy3VnW9fXii9NPYs5UOuP4fLKruXMjnZApveqzl4,2796
-example/openfeature_example.py,sha256=kO6F-Xk20l6CPiMfIxSRreshEGmHMFHRg3zbeLXa3AI,2410
+example/openfeature_example.py,sha256=8rdEtG_RiEbCwbQQWcCXtfZURz2Z393WoczyperkNug,8105
 test/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 test/test_cloud_client.py,sha256=CoK4xfHPMGyJ4hXrdI98e5f4zEL51vx31u_xmC3FEtc,15957
 test/test_local_client.py,sha256=yg19ddGmg9t1TfjT-4EgHp0cjfxHjfJZOGIFM8mSNX8,18078
@@ -70,7 +70,7 @@ test/util/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 test/util/test_strings.py,sha256=T5H5U0af7_ld1yJC8IdDmay_Mx-iJQ5Fi5fbvKcAc7A,862
 test/util/test_utils.py,sha256=tVBJm_qnqg-4PssLpXIxqlk0JehuiAIPs4zpi2oNVnY,6671
 test/util/test_version.py,sha256=3Xg0_84m0bdHXz6pxd2Z85Oz9DoUC1T0Ol_WqEH_jac,335
-devcycle_python_server_sdk-3.13.0.dist-info/METADATA,sha256=4RisdQtReQqBoSXMquKU0Ui47Z5bbnmAVmrdOLt4hsI,723
-devcycle_python_server_sdk-3.13.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-devcycle_python_server_sdk-3.13.0.dist-info/top_level.txt,sha256=34f8zDzihAHoH7siAFlmscyO_QLNWWq9HApFlwtYL4k,33
-devcycle_python_server_sdk-3.13.0.dist-info/RECORD,,
+devcycle_python_server_sdk-3.13.1.dist-info/METADATA,sha256=1mU8MQraVdQxnwAxNqGvxsQ6GmpBxsVOEk9O_MpAwqA,723
+devcycle_python_server_sdk-3.13.1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+devcycle_python_server_sdk-3.13.1.dist-info/top_level.txt,sha256=34f8zDzihAHoH7siAFlmscyO_QLNWWq9HApFlwtYL4k,33
+devcycle_python_server_sdk-3.13.1.dist-info/RECORD,,

{devcycle_python_server_sdk-3.13.0.dist-info → devcycle_python_server_sdk-3.13.1.dist-info}/licenses/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2021 Taplytics Inc.
+Copyright (c) 2025 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

example/openfeature_example.py

@@ -7,19 +7,32 @@ from devcycle_python_sdk import DevCycleLocalClient, DevCycleLocalOptions
 from openfeature import api
 from openfeature.evaluation_context import EvaluationContext
 
-FLAG_KEY = "test-boolean-variable"
-
 logger = logging.getLogger(__name__)
 
 
 def main():
     """
     Sample usage of the DevCycle OpenFeature Provider along with the Python Server SDK using Local Bucketing.
+
+    This example demonstrates how to use all variable types supported by DevCycle through OpenFeature:
+    - Boolean variables
+    - String variables
+    - Number variables (integer and float)
+    - JSON object variables
+
+    See DEVCYCLE_SETUP.md for instructions on creating the required variables in DevCycle.
     """
     logging.basicConfig(level="INFO", format="%(levelname)s: %(message)s")
 
     # create an instance of the DevCycle Client object
-    server_sdk_key = os.environ["DEVCYCLE_SERVER_SDK_KEY"]
+    server_sdk_key = os.environ.get("DEVCYCLE_SERVER_SDK_KEY")
+    if not server_sdk_key:
+        logger.error("DEVCYCLE_SERVER_SDK_KEY environment variable is not set")
+        logger.error(
+            "Please set it with: export DEVCYCLE_SERVER_SDK_KEY='your-sdk-key'"
+        )
+        exit(1)
+
     devcycle_client = DevCycleLocalClient(server_sdk_key, DevCycleLocalOptions())
 
     # Wait for DevCycle to initialize and load the configuration
@@ -32,6 +45,8 @@ def main():
         logger.error("DevCycle failed to initialize")
         exit(1)
 
+    logger.info("DevCycle initialized successfully!\n")
+
     # set the provider for OpenFeature
     api.set_provider(devcycle_client.get_openfeature_provider())
 
@@ -53,22 +68,168 @@ def main():
         },
     )
 
-    # Look up the value of the flag
-    if open_feature_client.get_boolean_value(FLAG_KEY, False, context):
-        logger.info(f"Variable {FLAG_KEY} is enabled")
+    logger.info("=" * 60)
+    logger.info("Testing Boolean Variable")
+    logger.info("=" * 60)
+
+    # Test Boolean Variable
+    boolean_details = open_feature_client.get_boolean_details(
+        "test-boolean-variable", False, context
+    )
+    logger.info("Variable Key: test-boolean-variable")
+    logger.info("Value: {boolean_details.value}")
+    logger.info("Reason: {boolean_details.reason}")
+    if boolean_details.value:
+        logger.info("✓ Boolean variable is ENABLED")
     else:
-        logger.info(f"Variable {FLAG_KEY} is not enabled")
+        logger.info("✗ Boolean variable is DISABLED")
+
+    logger.info("\n" + "=" * 60)
+    logger.info("Testing String Variable")
+    logger.info("=" * 60)
 
-    # Fetch a JSON object variable
-    json_object = open_feature_client.get_object_value(
+    # Test String Variable
+    open_feature_client.get_string_details(
+        "test-string-variable", "default string", context
+    )
+    logger.info("Variable Key: test-string-variable")
+    logger.info("Value: {string_details.value}")
+    logger.info("Reason: {string_details.reason}")
+
+    logger.info("\n" + "=" * 60)
+    logger.info("Testing Number Variable (Integer)")
+    logger.info("=" * 60)
+
+    # Test Number Variable (Integer)
+    open_feature_client.get_integer_details("test-number-variable", 0, context)
+    logger.info("Variable Key: test-number-variable")
+    logger.info("Value: {integer_details.value}")
+    logger.info("Reason: {integer_details.reason}")
+
+    logger.info("\n" + "=" * 60)
+    logger.info("Testing Number Variable (Float)")
+    logger.info("=" * 60)
+
+    # Test Number Variable as Float
+    # Note: If the DevCycle variable is an integer, it will be cast to float
+    open_feature_client.get_float_value("test-number-variable", 0.0, context)
+    logger.info("Variable Key: test-number-variable (as float)")
+    logger.info("Value: {float_value}")
+
+    logger.info("\n" + "=" * 60)
+    logger.info("Testing JSON Object Variable")
+    logger.info("=" * 60)
+
+    # Test JSON Object Variable
+    open_feature_client.get_object_details(
         "test-json-variable", {"default": "value"}, context
     )
-    logger.info(f"JSON Object Value: {json_object}")
+    logger.info("Variable Key: test-json-variable")
+    logger.info("Value: {json_details.value}")
+    logger.info("Reason: {json_details.reason}")
+
+    logger.info("\n" + "=" * 60)
+    logger.info("Testing Object Variable - Empty Dictionary")
+    logger.info("=" * 60)
+
+    # Test with empty dictionary default (valid per OpenFeature spec)
+    open_feature_client.get_object_value("test-json-variable", {}, context)
+    logger.info("Variable Key: test-json-variable (with empty default)")
+    logger.info("Value: {empty_dict_result}")
+
+    logger.info("\n" + "=" * 60)
+    logger.info("Testing Object Variable - Mixed Types")
+    logger.info("=" * 60)
+
+    # Test with flat dictionary containing mixed primitive types
+    # OpenFeature allows string, int, float, bool, and None in flat dictionaries
+    mixed_default = {
+        "string_key": "hello",
+        "int_key": 42,
+        "float_key": 3.14,
+        "bool_key": True,
+        "none_key": None,
+    }
+    mixed_result = open_feature_client.get_object_value(
+        "test-json-variable", mixed_default, context
+    )
+    logger.info("Variable Key: test-json-variable (with mixed types)")
+    logger.info("Value: {mixed_result}")
+    logger.info(
+        f"Value types: {[(k, type(v).__name__) for k, v in mixed_result.items()]}"
+    )
+
+    logger.info("\n" + "=" * 60)
+    logger.info("Testing Object Variable - All String Values")
+    logger.info("=" * 60)
+
+    # Test with all string values
+    string_dict_default = {
+        "name": "John Doe",
+        "email": "john@example.com",
+        "status": "active",
+    }
+    open_feature_client.get_object_value(
+        "test-json-variable", string_dict_default, context
+    )
+    logger.info("Variable Key: test-json-variable (all strings)")
+    logger.info("Value: {string_dict_result}")
+
+    logger.info("\n" + "=" * 60)
+    logger.info("Testing Object Variable - Numeric Values")
+    logger.info("=" * 60)
+
+    # Test with numeric values (integers and floats)
+    numeric_dict_default = {"count": 100, "percentage": 85.5, "threshold": 0}
+    open_feature_client.get_object_value(
+        "test-json-variable", numeric_dict_default, context
+    )
+    logger.info("Variable Key: test-json-variable (numeric)")
+    logger.info("Value: {numeric_dict_result}")
+
+    logger.info("\n" + "=" * 60)
+    logger.info("Testing Object Variable - Boolean Flags")
+    logger.info("=" * 60)
+
+    # Test with boolean values
+    bool_dict_default = {"feature_a": True, "feature_b": False, "feature_c": True}
+    open_feature_client.get_object_value(
+        "test-json-variable", bool_dict_default, context
+    )
+    logger.info("Variable Key: test-json-variable (booleans)")
+    logger.info("Value: {bool_dict_result}")
+
+    logger.info("\n" + "=" * 60)
+    logger.info("Testing Object Variable - With None Values")
+    logger.info("=" * 60)
+
+    # Test with None values (valid per OpenFeature spec for flat dictionaries)
+    none_dict_default = {
+        "optional_field": None,
+        "required_field": "value",
+        "nullable_count": None,
+    }
+    open_feature_client.get_object_value(
+        "test-json-variable", none_dict_default, context
+    )
+    logger.info("Variable Key: test-json-variable (with None)")
+    logger.info("Value: {none_dict_result}")
+
+    logger.info("\n" + "=" * 60)
+    logger.info("Testing Non-Existent Variable (Should Return Default)")
+    logger.info("=" * 60)
+
+    # Test non-existent variable to demonstrate default handling
+    open_feature_client.get_string_details(
+        "doesnt-exist", "default fallback value", context
+    )
+    logger.info("Variable Key: doesnt-exist")
+    logger.info("Value: {nonexistent_details.value}")
+    logger.info("Reason: {nonexistent_details.reason}")
 
-    # Retrieve a string variable along with resolution details
-    details = open_feature_client.get_string_details("doesnt-exist", "default", context)
-    logger.info(f"String Value: {details.value}")
-    logger.info(f"Eval Reason: {details.reason}")
+    logger.info("\n" + "=" * 60)
+    logger.info("All tests completed!")
+    logger.info("=" * 60)
 
     devcycle_client.close()