kameleoon-client-python 3.8.0__tar.gz → 3.9.0__tar.gz

{kameleoon-client-python-3.8.0 → kameleoon-client-python-3.9.0}/PKG-INFO

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

{kameleoon-client-python-3.8.0 → kameleoon-client-python-3.9.0}/kameleoon/configuration/data_file.py

@@ -1,10 +1,11 @@
 """Kameleoon Configuration"""
 
-from typing import Any, Dict, Optional, Set
+from typing import Any, Dict, Iterable, List, Optional, Set
 from kameleoon.configuration import Variable
 from kameleoon.configuration.custom_data_info import CustomDataInfo
 from kameleoon.configuration.experiment import Experiment
 from kameleoon.configuration.feature_flag import FeatureFlag
+from kameleoon.configuration.me_group import MEGroup
 from kameleoon.configuration.rule import Rule
 from kameleoon.configuration.settings import Settings
 from kameleoon.configuration.variation_by_exposition import VariationByExposition
@@ -52,6 +53,7 @@ class DataFile:
         self.__environment = environment  # pylint: disable=W0238
         self.__settings = settings
         self.__feature_flags: Dict[str, FeatureFlag] = feature_flags
+        self.__me_groups = self.__make_me_groups(feature_flags.values())
         self.__has_any_targeted_delivery_rule = any(
             rule.is_targeted_delivery
             for ff in self.__feature_flags.values()
@@ -81,6 +83,11 @@ class DataFile:
         """Returns dictionary of all feature flags stored by feature keys"""
         return self.__feature_flags
 
+    @property
+    def me_groups(self) -> Dict[str, MEGroup]:
+        """Returns the mutually exclusive groups by their names"""
+        return self.__me_groups
+
     @property
     def feature_flag_by_id(self) -> Dict[int, FeatureFlag]:
         """Returns dictionary of all feature flags stored by id"""
@@ -146,6 +153,18 @@ class DataFile:
                         if variation.variation_id is not None:
                             self.__variation_by_id[variation.variation_id] = variation
 
+    @staticmethod
+    def __make_me_groups(feature_flags: Iterable[FeatureFlag]) -> Dict[str, MEGroup]:
+        me_group_lists: Dict[str, List[FeatureFlag]] = {}
+        for feature_flag in feature_flags:
+            if feature_flag.me_group_name:
+                me_group_list = me_group_lists.get(feature_flag.me_group_name)
+                if me_group_list:
+                    me_group_list.append(feature_flag)
+                else:
+                    me_group_lists[feature_flag.me_group_name] = [feature_flag]
+        return {me_group_name: MEGroup(me_group_list) for me_group_name, me_group_list in me_group_lists.items()}
+
     @staticmethod
     def __has_feature_flag_variable_js_css(feature_flag: FeatureFlag) -> bool:
         variations = feature_flag.variations

{kameleoon-client-python-3.8.0 → kameleoon-client-python-3.9.0}/kameleoon/configuration/feature_flag.py

@@ -17,10 +17,11 @@ class 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]):
+    def __init__(self, dict_json: Dict[str, Any]) -> 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", "")
+        self.me_group_name: Optional[str] = dict_json.get("mutuallyExclusiveGroup")
         self.variations: List[Variation] = Variation.from_array(
             dict_json.get("variations", [])
         )
@@ -39,6 +40,7 @@ class FeatureFlag:
             f"environment_enabled:{self.environment_enabled},"
             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"}}"
         )

kameleoon-client-python-3.9.0/kameleoon/configuration/me_group.py

@@ -0,0 +1,24 @@
+"""Kameleoon Configuration"""
+
+from typing import List
+from kameleoon.configuration.feature_flag import FeatureFlag
+
+
+class MEGroup:
+    """Represents a mutually exclusive group"""
+
+    def __init__(self, feature_flags: List[FeatureFlag]) -> None:
+        feature_flags.sort(key=lambda ff: ff.id_)
+        self.__feature_flags = feature_flags
+
+    @property
+    def feature_flags(self) -> List[FeatureFlag]:
+        """Returns the feature flags"""
+        return self.__feature_flags
+
+    def get_feature_flag_by_hash(self, hash_double: float) -> FeatureFlag:
+        """Finds a feature flag by the given hash"""
+        idx = int(hash_double * len(self.__feature_flags))
+        if idx >= len(self.__feature_flags):
+            idx = len(self.__feature_flags) - 1
+        return self.__feature_flags[idx]

{kameleoon-client-python-3.8.0 → kameleoon-client-python-3.9.0}/kameleoon/exceptions.py

@@ -70,7 +70,7 @@ class FeatureNotFound(NotFoundError):
         super().__init__(self.message)
 
 
-class FeatureExperimentNotFound(NotFoundError):  # //~ Derived from FeatureError in other SDKs
+class FeatureExperimentNotFound(NotFoundError):
     """Exception indicating that the requested experiment has not been found.
     Check that the experiment's ID matches the provided one."""
 

{kameleoon-client-python-3.8.0 → kameleoon-client-python-3.9.0}/kameleoon/helpers/hasher.py

@@ -19,6 +19,11 @@ class Hasher:
             identifier += str(respool_time)
         return Hasher._calculate(identifier)
 
+    @staticmethod
+    def obtain_hash_for_me_group(visitor_code: str, me_group_name: str) -> float:
+        """Calculate the hash value for a mutually exclusive group for a given visitor code"""
+        return Hasher._calculate(visitor_code + me_group_name)
+
     @staticmethod
     def _calculate(str_to_hash: str) -> float:
         return int(hashlib.sha256(str_to_hash.encode("UTF-8")).hexdigest(), 16) / math.pow(2, 256)

{kameleoon-client-python-3.8.0 → kameleoon-client-python-3.9.0}/kameleoon/kameleoon_client.py

@@ -612,7 +612,8 @@ class KameleoonClient:
         forced_variation = visitor.get_forced_feature_variation(feature_flag.feature_key) if visitor else None
         if forced_variation:
             eval_exp = EvaluatedExperiment.from_forced_variation(forced_variation)
-        elif self.__is_visitor_not_in_holdout(visitor, visitor_code, track, save):
+        elif self.__is_visitor_not_in_holdout(visitor, visitor_code, track, save) 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):
             self.__save_variation(visitor_code, eval_exp, track)
@@ -622,26 +623,52 @@ class KameleoonClient:
         )
         return eval_exp
 
+    def __is_ff_unrestricted_by_me_group(
+        self, visitor: Optional[Visitor], visitor_code: str, feature_flag: FeatureFlag
+    ) -> bool:
+        if feature_flag.me_group_name is None:
+            return True
+        KameleoonLogger.debug(
+            "CALL: KameleoonClient.__is_ff_unrestricted_by_me_group(visitor, visitor_code: %s, feature_flag: %s)",
+            visitor_code, feature_flag
+        )
+        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)
+            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",
+                me_group_hash, code_for_hash, feature_flag.me_group_name
+            )
+            unrestricted = me_group.get_feature_flag_by_hash(me_group_hash) == feature_flag
+        KameleoonLogger.debug(
+            "RETURN: KameleoonClient.__is_ff_unrestricted_by_me_group(visitor, visitor_code: %s, feature_flag: %s)"
+            " -> (unrestricted: %s)", visitor_code, feature_flag, unrestricted
+        )
+        return unrestricted
+
     def __is_visitor_not_in_holdout(
         self, visitor: Optional[Visitor], visitor_code: str, track: bool, save: bool
     ) -> 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
         )
-        holdout = self._data_manager.data_file.holdout
         is_not_in_holdout = True
-        if holdout:
-            code_for_hash = self.__get_code_for_hash(visitor, visitor_code)
-            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)
-            if var_by_exp:
-                is_not_in_holdout = var_by_exp.variation_key != in_holdout_variation_key
-                if save:
-                    eval_exp = EvaluatedExperiment(var_by_exp, holdout, RuleType.EXPERIMENTATION)
-                    self.__save_variation(visitor_code, eval_exp)
+        code_for_hash = self.__get_code_for_hash(visitor, visitor_code)
+        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)
+        if var_by_exp:
+            is_not_in_holdout = var_by_exp.variation_key != in_holdout_variation_key
+            if save:
+                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)",

{kameleoon-client-python-3.8.0 → kameleoon-client-python-3.9.0}/kameleoon/sdk_version.py

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

{kameleoon-client-python-3.8.0 → kameleoon-client-python-3.9.0}/kameleoon_client_python.egg-info/PKG-INFO

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

{kameleoon-client-python-3.8.0 → kameleoon-client-python-3.9.0}/kameleoon_client_python.egg-info/SOURCES.txt

@@ -18,6 +18,7 @@ kameleoon/configuration/custom_data_info.py
 kameleoon/configuration/data_file.py
 kameleoon/configuration/experiment.py
 kameleoon/configuration/feature_flag.py
+kameleoon/configuration/me_group.py
 kameleoon/configuration/rule.py
 kameleoon/configuration/rule_type.py
 kameleoon/configuration/settings.py

{kameleoon-client-python-3.8.0 → kameleoon-client-python-3.9.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]
-requests<3.0.0,>=2.25
-pytest-ordering==0.6
-types-python-dateutil==2.8.2
-flake8==4.0.1
-twine==3.4.1
-pylint==2.12.*
 pytest-asyncio==0.21.*
+pytest-ordering==0.6
+aiohttp<4.0.0,>=3.8.0
 wheel==0.36.2
-pyyaml<6.1.0,>=5.4.0
-Django==3.2.4
+mypy==0.991
+pytest-pythonpath==0.7.3
+requests<3.0.0,>=2.25
+types-PyYAML==5.4.3
+types-requests==2.25.0
 freezegun==1.1.0
-aioresponses==0.7.*
-aiohttp<4.0.0,>=3.8.0
 pytest-django==4.4.0
+flake8==4.0.1
+Django==3.2.4
 pytest-cov==2.12.1
-mypy==0.991
-types-requests==2.25.0
-types-PyYAML==5.4.3
+twine==3.4.1
+types-python-dateutil==2.8.2
+pylint==2.12.*
 Werkzeug==2.0.1
 sseclient-py<1.9.0,>=1.7.0
-pytest-pythonpath==0.7.3
+pyyaml<6.1.0,>=5.4.0
+aioresponses==0.7.*