kameleoon-client-python 3.13.0__tar.gz → 3.14.0__tar.gz

{kameleoon-client-python-3.13.0/kameleoon_client_python.egg-info → kameleoon-client-python-3.14.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: kameleoon-client-python
-Version: 3.13.0
+Version: 3.14.0
 Summary: Kameleoon Client Python Software Development Kit.
 Home-page: https://developers.kameleoon.com/python-sdk.html
 Author: Kameleoon

{kameleoon-client-python-3.13.0 → kameleoon-client-python-3.14.0}/kameleoon/configuration/custom_data_info.py

@@ -17,6 +17,7 @@ class CustomDataInfo:
         self.__mapping_identifier_index = None
         self.__local_only = set()
         self.__visitor_scope = set()
+        self.__custom_data_index_by_id = {}
         if custom_data is not None:
             for data in custom_data:
                 index = data.get("index")
@@ -26,6 +27,8 @@ class CustomDataInfo:
                         self.__local_only.add(index)
                     if data.get("scope") == self.SCOPE_VISITOR:
                         self.__visitor_scope.add(index)
+                    if (id_ := data.get("id")) is not None:
+                        self.__custom_data_index_by_id[id_] = index
                     if data.get("isMappingIdentifier"):
                         if bool(self.__mapping_identifier_index is not None):
                             KameleoonLogger.warning(
@@ -50,3 +53,7 @@ class CustomDataInfo:
     def mapping_identifier_index(self) -> Optional[int]:
         """Take mapping identifier index"""
         return self.__mapping_identifier_index
+
+    def get_custom_data_index_by_id(self, custom_data_id: int) -> Optional[int]:
+        """Get corresponding custom data id by custom data index"""
+        return self.__custom_data_index_by_id.get(custom_data_id)

{kameleoon-client-python-3.13.0 → kameleoon-client-python-3.14.0}/kameleoon/configuration/data_file.py

@@ -11,6 +11,7 @@ from kameleoon.configuration.settings import Settings
 from kameleoon.configuration.variation_by_exposition import VariationByExposition
 from kameleoon.exceptions import FeatureNotFound, FeatureEnvironmentDisabled
 from kameleoon.logging.kameleoon_logger import KameleoonLogger
+from kameleoon.targeting.models import Segment
 
 
 class DataFile:
@@ -28,15 +29,29 @@ class DataFile:
     ) -> "DataFile":
         """Creates new instance of `DataFile` initialized from the specified configuration JSON"""
         settings = Settings(configuration.get("configuration"))
-        feature_flags = {
-            (feature_flag := FeatureFlag(jobj)).feature_key: feature_flag
-            for jobj in configuration.get("featureFlags") or []
-        }
+        segments = DataFile.__parse_segments(configuration)
         custom_data_info = CustomDataInfo(configuration.get("customData"))
+        feature_flags = DataFile.__parse_feature_flags(configuration, segments, custom_data_info)
         holdout = Experiment.from_json(configuration["holdout"]) if "holdout" in configuration else None
         data_file = DataFile(environment, last_modified, settings, feature_flags, custom_data_info, holdout)
         return data_file
 
+    @staticmethod
+    def __parse_segments(configuration: Dict[str, Any]) -> Dict[int, Segment]:
+        return {
+            (seg := Segment(jobj)).id_: seg
+            for jobj in configuration.get("segments") or []
+        }
+
+    @staticmethod
+    def __parse_feature_flags(
+        configuration: Dict[str, Any], segments: Dict[int, Segment], cdi: CustomDataInfo
+    ) -> Dict[str, FeatureFlag]:
+        return {
+            (ff := FeatureFlag(jobj, segments, cdi)).feature_key: ff  # pylint: disable=C0103
+            for jobj in configuration.get("featureFlags") or []
+        }
+
     # pylint: disable=R0913
     def __init__(
         self,

{kameleoon-client-python-3.13.0 → kameleoon-client-python-3.14.0}/kameleoon/configuration/feature_flag.py

@@ -2,9 +2,11 @@
 
 from typing import Any, List, Dict, Optional
 
+from kameleoon.configuration.custom_data_info import CustomDataInfo
 from kameleoon.configuration.rule import Rule
 from kameleoon.configuration.variation import Variation
 from kameleoon.helpers.string_utils import StringUtils
+from kameleoon.targeting.models import Segment
 
 
 class FeatureFlag:
@@ -12,12 +14,7 @@ class FeatureFlag:
     FeatureFlag is used for operating feature flags with rules
     """
 
-    @staticmethod
-    def from_array(array: List[Dict[str, Any]]) -> List["FeatureFlag"]:
-        """Create a list of FeatureFlags from the json array"""
-        return [FeatureFlag(item) for item in array]
-
-    def __init__(self, dict_json: Dict[str, Any]) -> None:
+    def __init__(self, dict_json: Dict[str, Any], segments: Dict[int, Segment], cdi: CustomDataInfo) -> None:
         self.id_: int = dict_json.get("id", 0)
         self.feature_key: str = dict_json.get("featureKey", "")
         self.default_variation_key: str = dict_json.get("defaultVariationKey", "")
@@ -26,7 +23,9 @@ class FeatureFlag:
             dict_json.get("variations", [])
         )
         self.environment_enabled = dict_json.get("environmentEnabled", False)
-        self.rules: List[Rule] = Rule.from_array(dict_json.get("rules", []))
+        self.rules: List[Rule] = Rule.from_array(dict_json.get("rules", []), segments)
+        bucketing_cd_id = dict_json.get("bucketingCustomDataId")
+        self.bucketing_custom_data_index = cdi.get_custom_data_index_by_id(bucketing_cd_id) if bucketing_cd_id else None
 
     def get_variation(self, key: str) -> Optional[Variation]:
         """Retrun a variation for the given key"""
@@ -41,6 +40,7 @@ class FeatureFlag:
             f"variations:{StringUtils.object_to_string(self.variations)},"
             f"default_variation_key:'{self.default_variation_key}',"
             f"me_group_name:'{self.me_group_name}',"
-            f"rules:{len(self.rules)}"
+            f"rules:{len(self.rules)},"
+            f"bucketing_custom_data_index:{self.bucketing_custom_data_index}"
             f"}}"
         )

{kameleoon-client-python-3.13.0 → kameleoon-client-python-3.14.0}/kameleoon/configuration/rule.py

@@ -12,12 +12,11 @@ class Rule:
     """
 
     @staticmethod
-    def from_array(array: List[Dict[str, Any]]) -> List["Rule"]:
+    def from_array(array: List[Dict[str, Any]], segments: Dict[int, Segment]) -> List["Rule"]:
         """Create a list of Rules from the json array"""
+        return [Rule(item, segments) for item in array]
 
-        return [Rule(item) for item in array]
-
-    def __init__(self, dict_json: Dict[str, Any]):
+    def __init__(self, dict_json: Dict[str, Any], segments: Dict[int, Segment]) -> None:
         self.id_: int = dict_json["id"]
         self.order: int = dict_json.get("order", 0)
         type_literal: str = dict_json.get("type", "")
@@ -25,21 +24,19 @@ class Rule:
         self.exposition: float = dict_json.get("exposition", 0.0)
         self.experiment = Experiment.from_json(dict_json)
         self.respool_time: Optional[int] = dict_json.get("respoolTime", None)
-        segment = dict_json.get("segment")
-        self.targeting_segment: Optional[Segment] = Segment(segment) if segment else None
-        self.segment_id: int = self.targeting_segment.id_ if self.targeting_segment else -1
+        segment_id = dict_json.get("segmentId")
+        self.segment_id: int = segment_id or -1
+        self.targeting_segment: Optional[Segment] = segments.get(segment_id) if segment_id else None
 
     @property
     def is_experimentation(self) -> bool:
         """Return `true` if rule is `experimentation` type"""
-
         return self.type == RuleType.EXPERIMENTATION
 
     @property
     def is_targeted_delivery(self) -> bool:
         """Return `true` if rule is `targeted delivery` type"""
-
         return self.type == RuleType.TARGETED_DELIVERY
 
-    def __str__(self):
+    def __str__(self) -> str:
         return f"Rule{{id:{self.id_}}}"

{kameleoon-client-python-3.13.0 → kameleoon-client-python-3.14.0}/kameleoon/kameleoon_client.py

@@ -674,7 +674,7 @@ class KameleoonClient:
         if forced_variation:
             eval_exp = EvaluatedExperiment.from_forced_variation(forced_variation)
         elif self.__is_visitor_not_in_holdout(
-            visitor, visitor_code, track, save
+            visitor, visitor_code, track, save, feature_flag.bucketing_custom_data_index
         ) and self.__is_ff_unrestricted_by_me_group(visitor, visitor_code, feature_flag):
             eval_exp = self.__calculate_variation_rule_for_feature(visitor_code, feature_flag)
         if save and not (forced_variation and forced_variation.simulated):
@@ -703,7 +703,7 @@ class KameleoonClient:
         unrestricted = True
         me_group = self._data_manager.data_file.me_groups.get(feature_flag.me_group_name)
         if me_group:
-            code_for_hash = self.__get_code_for_hash(visitor, visitor_code)
+            code_for_hash = self.__get_code_for_hash(visitor, visitor_code, feature_flag.bucketing_custom_data_index)
             me_group_hash = Hasher.obtain_hash_for_me_group(code_for_hash, feature_flag.me_group_name)
             KameleoonLogger.debug(
                 "Calculated ME group hash %s for code: %s, meGroup: %s",
@@ -722,20 +722,18 @@ class KameleoonClient:
         return unrestricted
 
     def __is_visitor_not_in_holdout(
-        self, visitor: Optional[Visitor], visitor_code: str, track: bool, save: bool
+        self, visitor: Optional[Visitor], visitor_code: str, track: bool, save: bool, bucketing_cd_index: Optional[int]
     ) -> bool:
         holdout = self._data_manager.data_file.holdout
         if holdout is None:
             return True
         in_holdout_variation_key = "in-holdout"
         KameleoonLogger.debug(
-            "CALL: KameleoonClient.__is_visitor_not_in_holdout(visitor, visitor_code: %s, track: %s, save: %s)",
-            visitor_code,
-            track,
-            save,
+            "CALL: KameleoonClient.__is_visitor_not_in_holdout(visitor, visitor_code: %s, track: %s, save: %s, "
+            "bucketing_cd_index: %s)", visitor_code, track, save, bucketing_cd_index
         )
         is_not_in_holdout = True
-        code_for_hash = self.__get_code_for_hash(visitor, visitor_code)
+        code_for_hash = self.__get_code_for_hash(visitor, visitor_code, bucketing_cd_index)
         variation_hash = Hasher.obtain(code_for_hash, holdout.id_)
         KameleoonLogger.debug("Calculated holdout hash %s for code %s", variation_hash, code_for_hash)
         var_by_exp = holdout.get_variation(variation_hash)
@@ -745,12 +743,9 @@ class KameleoonClient:
                 eval_exp = EvaluatedExperiment(var_by_exp, holdout, RuleType.EXPERIMENTATION)
                 self.__save_variation(visitor_code, eval_exp)
         KameleoonLogger.debug(
-            "RETURN: KameleoonClient.__is_visitor_not_in_holdout(visitor, visitor_code: %s, track: %s, save: %s)"
-            " -> (is_not_in_holdout: %s)",
-            visitor_code,
-            track,
-            save,
-            is_not_in_holdout,
+            "RETURN: KameleoonClient.__is_visitor_not_in_holdout(visitor, visitor_code: %s, track: %s, save: %s, "
+            "bucketing_cd_index: %s) -> (is_not_in_holdout: %s)",
+            visitor_code, track, save, bucketing_cd_index, is_not_in_holdout
         )
         return is_not_in_holdout
 
@@ -1601,21 +1596,25 @@ class KameleoonClient:
         )
 
     @staticmethod
-    def __get_code_for_hash(visitor: Optional[Visitor], visitor_code: str) -> str:
-        # use mapping_identifier instead of visitor_code if it was set up
-        return (
-            visitor.mapping_identifier
-            if visitor is not None and visitor.mapping_identifier is not None
-            else visitor_code
-        )
+    def __get_code_for_hash(visitor: Optional[Visitor], visitor_code: str, bucketing_cd_index: Optional[int]) -> str:
+        if visitor is None:
+            return visitor_code
+        # 1. Try to use the bucketing custom data's value if bucketingCustomDataId is defined
+        if bucketing_cd_index:
+            bucketing_custom_data = visitor.custom_data.get(bucketing_cd_index)
+            if bucketing_custom_data and (len(bucketing_custom_data.values) > 0):
+                return bucketing_custom_data.values[0]
+        # 2. Use mappingIdentifier instead of visitorCode if it was set up
+        return visitor.mapping_identifier or visitor_code
 
     def __evaluate_cbscores(
-        self, visitor: Optional[Visitor], visitor_code: str, rule: Rule
+        self, visitor: Optional[Visitor], visitor_code: str, rule: Rule, bucketing_cd_index: Optional[int]
     ) -> Optional[EvaluatedExperiment]:
         if (visitor is None) or (visitor.cbscores is None):
             return None
         KameleoonLogger.debug(
-            "CALL: KameleoonClient.__evaluate_cbscores(visitor, visitor_code: %s, rule: %s)", visitor_code, rule
+            "CALL: KameleoonClient.__evaluate_cbscores(visitor, visitor_code: %s, rule: %s, bucketing_cd_index: %s)",
+            visitor_code, rule, bucketing_cd_index
         )
         eval_exp = None
         var_id_group_by_scores = visitor.cbscores.values.get(rule.experiment.id_)
@@ -1633,16 +1632,14 @@ class KameleoonClient:
                 size = len(var_by_exp_in_cbs)
                 idx = 0
                 if size > 1:
-                    code_for_hash = self.__get_code_for_hash(visitor, visitor_code)
+                    code_for_hash = self.__get_code_for_hash(visitor, visitor_code, bucketing_cd_index)
                     variation_hash = Hasher.obtain(code_for_hash, rule.experiment.id_, rule.respool_time)
                     KameleoonLogger.debug("Calculated CBS hash %s for code %s", variation_hash, code_for_hash)
                     idx = min(int(variation_hash * size), size - 1)
                 eval_exp = EvaluatedExperiment.from_var_by_exp_rule(var_by_exp_in_cbs[idx], rule)
         KameleoonLogger.debug(
-            "RETURN: KameleoonClient.__evaluate_cbscores(visitor, visitor_code: %s, rule: %s) -> (eval_exp: %s)",
-            visitor_code,
-            rule,
-            eval_exp,
+            "RETURN: KameleoonClient.__evaluate_cbscores(visitor, visitor_code: %s, rule: %s, bucketing_cd_index: %s)"
+            " -> (eval_exp: %s)", visitor_code, rule, bucketing_cd_index, eval_exp
         )
         return eval_exp
 
@@ -1656,7 +1653,7 @@ class KameleoonClient:
             feature_flag,
         )
         visitor = self._visitor_manager.get_visitor(visitor_code)
-        code_for_hash = self.__get_code_for_hash(visitor, visitor_code)
+        code_for_hash = self.__get_code_for_hash(visitor, visitor_code, feature_flag.bucketing_custom_data_index)
         eval_exp = None
         for rule in feature_flag.rules:
             forced_variation = visitor.get_forced_experiment_variation(rule.experiment.id_) if visitor else None
@@ -1676,7 +1673,9 @@ class KameleoonClient:
             KameleoonLogger.debug("Calculated rule hash %s for code %s", hash_rule, code_for_hash)
             # check main expostion for rule with hashRule
             if hash_rule <= rule.exposition:
-                eval_exp = self.__evaluate_cbscores(visitor, visitor_code, rule)
+                eval_exp = self.__evaluate_cbscores(
+                    visitor, visitor_code, rule, feature_flag.bucketing_custom_data_index
+                )
                 if eval_exp:
                     break
                 if rule.is_targeted_delivery:

{kameleoon-client-python-3.13.0 → kameleoon-client-python-3.14.0}/kameleoon/network/services/data_service_impl.py

@@ -23,7 +23,7 @@ class DataServiceImpl(DataService, ServiceImpl):
         if timeout is None:
             timeout = self.network_manager.call_timeout
         url = self.network_manager.url_provider.make_tracking_url()
-        request = Request(HttpMethod.POST, url, timeout, body=lines)
+        request = Request(HttpMethod.POST, url, timeout, body=lines, headers={"Content-Type": "*/*"})
         response = self._make_call(
             request, True, self.NUMBER_OF_RECONNECTION_ON_FAILURE_UNCRITICAL, self._TRACKING_CALL_RETRY_DELAY
         )

{kameleoon-client-python-3.13.0 → kameleoon-client-python-3.14.0}/kameleoon/network/url_provider.py

@@ -14,7 +14,7 @@ class UrlProvider:
     _EXPERIMENTS_CONFIGURATIONS_PATH = "/visit/experimentsConfigurations"
     _GET_DATA_PATH = "/map/map"
     _POST_DATA_PATH = "/map/maps"
-    _CONFIGURATION_API_URL_FORMAT = "https://{0}/{1}"
+    _CONFIGURATION_API_URL_FORMAT = "https://{0}/v3/{1}"
     _RT_CONFIGURATION_URL_FORMAT = "https://{0}:8110/sse?{1}"
     _ACCESS_TOKEN_URL_FORMAT = "https://{0}/oauth/token"
     _DATA_API_URL_FORMAT = "https://{0}{1}?{2}"

{kameleoon-client-python-3.13.0 → kameleoon-client-python-3.14.0}/kameleoon/sdk_version.py

@@ -4,7 +4,7 @@ from typing import Optional, Tuple
 
 from kameleoon.logging.kameleoon_logger import KameleoonLogger
 
-version_info = (3, 13, 0)
+version_info = (3, 14, 0)
 __version__ = ".".join(str(v) for v in version_info)  # uses in scripts
 
 

{kameleoon-client-python-3.13.0 → kameleoon-client-python-3.14.0/kameleoon_client_python.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: kameleoon-client-python
-Version: 3.13.0
+Version: 3.14.0
 Summary: Kameleoon Client Python Software Development Kit.
 Home-page: https://developers.kameleoon.com/python-sdk.html
 Author: Kameleoon

{kameleoon-client-python-3.13.0 → kameleoon-client-python-3.14.0}/kameleoon_client_python.egg-info/requires.txt

@@ -4,24 +4,24 @@ sseclient-py<1.9.0,>=1.7.0
 aiohttp<4.0.0,>=3.8.0
 
 [test]
-pytest-asyncio==0.21.*
-pylint==2.12.*
-flake8==4.0.1
-aioresponses==0.7.*
-types-python-dateutil==2.8.2
-mypy==0.991
-sseclient-py<1.9.0,>=1.7.0
-types-PyYAML==5.4.3
 twine==3.4.1
 Django==3.2.4
-freezegun==1.1.0
 requests<3.0.0,>=2.25
+types-requests==2.25.0
+flake8==4.0.1
+sseclient-py<1.9.0,>=1.7.0
+pytest-django==4.4.0
+pyyaml<6.1.0,>=5.4.0
+pytest-asyncio==0.21.*
+types-python-dateutil==2.8.2
+aioresponses==0.7.*
+pylint==2.12.*
+pytest-cov==2.12.1
+types-PyYAML==5.4.3
 wheel==0.36.2
-aiohttp<4.0.0,>=3.8.0
 pytest-pythonpath==0.7.3
 Werkzeug==2.0.1
 pytest-ordering==0.6
-pytest-cov==2.12.1
-types-requests==2.25.0
-pytest-django==4.4.0
-pyyaml<6.1.0,>=5.4.0
+freezegun==1.1.0
+mypy==0.991
+aiohttp<4.0.0,>=3.8.0