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

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

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

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

@@ -20,7 +20,7 @@ class DataFile:
     @staticmethod
     def default(environment: Optional[str]) -> "DataFile":
         """Creates new instance of `DataFile` initialized with default values"""
-        data_file = DataFile(environment, None, Settings(), {}, CustomDataInfo(None))
+        data_file = DataFile(environment, None, Settings(), {}, {}, CustomDataInfo(None))
         return data_file
 
     @staticmethod
@@ -33,13 +33,13 @@ class DataFile:
         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)
+        data_file = DataFile(environment, last_modified, settings, segments, 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
+            (seg := Segment.from_json(jobj)).id_: seg
             for jobj in configuration.get("segments") or []
         }
 
@@ -58,18 +58,21 @@ class DataFile:
         environment: Optional[str],
         last_modified: Optional[str],
         settings: Settings,
+        segments: Dict[int, Segment],
         feature_flags: Dict[str, FeatureFlag],
         custom_data_info: CustomDataInfo,
         holdout: Optional[Experiment] = None,
     ) -> None:
         KameleoonLogger.debug(
-            "CALL: DataFile(environment: %s, last_modified: %s, settings: %s, feature_flags: %s,"
+            "CALL: DataFile(environment: %s, last_modified: %s, settings: %s, segments, feature_flags,"
             " custom_data_info: %s, holdout: %s)",
-            environment, last_modified, settings, feature_flags, custom_data_info, holdout
+            environment, last_modified, settings, custom_data_info, holdout
         )
         self.__environment = environment  # pylint: disable=W0238
         self.__last_modified = last_modified
         self.__settings = settings
+        self.__segments = segments
+        self.__audience_tracking_segments = [seg for seg in segments.values() if seg.audience_tracking]
         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(
@@ -79,7 +82,6 @@ class DataFile:
             for rule in ff.rules
         )
         self.__variation_by_id: Dict[int, VariationByExposition] = {}
-        self.__rule_by_segment_id: Dict[int, Rule] = {}
         self.__rule_info_by_exp_id: Dict[int, DataFile.RuleInfo] = {}
         self.__feature_flag_by_id: Dict[int, FeatureFlag] = {}
         self.__experiment_ids_with_js_css_variable: Set[int] = set()
@@ -87,9 +89,9 @@ class DataFile:
         self.__custom_data_info = custom_data_info
         self.__holdout = holdout
         KameleoonLogger.debug(
-            "RETURN: DataFile(environment: %s, last_modified: %s, settings: %s, feature_flags: %s,"
+            "RETURN: DataFile(environment: %s, last_modified: %s, settings: %s, segments, feature_flags,"
             " custom_data_info: %s, holdout: %s)",
-            environment, last_modified, settings, feature_flags, custom_data_info, holdout
+            environment, last_modified, settings, custom_data_info, holdout
         )
 
     @property
@@ -102,6 +104,16 @@ class DataFile:
         """Returns settings"""
         return self.__settings
 
+    @property
+    def segments(self) -> Dict[int, Segment]:
+        """Returns segments"""
+        return self.__segments
+
+    @property
+    def audience_tracking_segments(self) -> List[Segment]:
+        """Returns audience tracking segments"""
+        return self.__audience_tracking_segments
+
     @property
     def feature_flags(self) -> Dict[str, FeatureFlag]:
         """Returns dictionary of all feature flags stored by feature keys"""
@@ -117,11 +129,6 @@ class DataFile:
         """Returns dictionary of all feature flags stored by id"""
         return self.__feature_flag_by_id
 
-    @property
-    def rule_by_segment_id(self) -> Dict[int, Rule]:
-        """Returns dictionary of all rule stored by segment id"""
-        return self.__rule_by_segment_id
-
     @property
     def rule_info_by_exp_id(self) -> Dict[int, "DataFile.RuleInfo"]:
         """Returns dictionary of all rule related info stored by experiment id"""
@@ -169,7 +176,6 @@ class DataFile:
             if feature_flag.rules is not None:
                 has_feature_flag_variable_js_css = self.__has_feature_flag_variable_js_css(feature_flag)
                 for rule in feature_flag.rules:
-                    self.__rule_by_segment_id[rule.segment_id] = rule
                     self.__rule_info_by_exp_id[rule.experiment.id_] = DataFile.RuleInfo(feature_flag, rule)
                     if has_feature_flag_variable_js_css:
                         self.__experiment_ids_with_js_css_variable.add(rule.experiment.id_)

{kameleoon-client-python-3.14.0 → kameleoon-client-python-3.15.0}/kameleoon/data/data.py

@@ -24,6 +24,7 @@ class DataType(IntEnum):
     FORCED_FEATURE_VARIATION = 15
     CBS = 16
     PERSONALIZATION = 17
+    TARGETED_SEGMENT = 18
 
 
 class BaseData:

{kameleoon-client-python-3.14.0 → kameleoon-client-python-3.15.0}/kameleoon/data/manager/assigned_variation.py

@@ -62,7 +62,7 @@ class AssignedVariation(BaseData, DuplicationUnsafeSendableBase):
         """Checks if the assigned variation is valid based on the respool time."""
         return (respool_time is None) or (self.assignment_time >= respool_time)
 
-    def __str__(self):
+    def __str__(self) -> str:
         return (
             f"AssignedVariation{{experiment_id:{self.__experiment_id},"
             f"variation_id:{self.__variation_id},"

{kameleoon-client-python-3.14.0 → kameleoon-client-python-3.15.0}/kameleoon/data/manager/visitor.py

@@ -18,6 +18,7 @@ from kameleoon.data.mapping_identifier import MappingIdentifier
 from kameleoon.data.operating_system import OperatingSystem
 from kameleoon.data.page_view import PageView
 from kameleoon.data.personalization import Personalization
+from kameleoon.data.targeted_segment import TargetedSegment
 from kameleoon.data.unique_identifier import UniqueIdentifier
 from kameleoon.data.user_agent import UserAgent
 from kameleoon.data.manager.assigned_variation import AssignedVariation
@@ -142,6 +143,13 @@ class Visitor:  # pylint: disable=R0904
         KameleoonLogger.debug('CALL/RETURN: Visitor.personalizations -> (personalizations: %s)', personalizations)
         return personalizations
 
+    @property
+    def targeted_segments(self) -> Dict[int, TargetedSegment]:
+        """Returns the personalizations associated with this Visitor."""
+        targeted_segments = EMPTY_DICT if self._data.targeted_segments is None else self._data.targeted_segments.copy()
+        KameleoonLogger.debug('CALL/RETURN: Visitor.targeted_segments -> (targeted_segments: %s)', targeted_segments)
+        return targeted_segments
+
     def get_forced_feature_variation(self, feature_key: str) -> Optional[ForcedFeatureVariation]:
         """
         Returns an associated forced feature variation by its feature key if it is present.
@@ -283,6 +291,7 @@ class Visitor:  # pylint: disable=R0904
             self.conversions: Optional[List[Conversion]] = None
             self.variations: Optional[Dict[int, AssignedVariation]] = None
             self.personalizations: Optional[Dict[int, Personalization]] = None
+            self.targeted_segments: Optional[Dict[int, TargetedSegment]] = None
             self.forced_variations: Optional[Dict[int, ForcedExperimentVariation]] = None
             self.simulated_variations: Optional[Dict[str, ForcedFeatureVariation]] = None
             self.kcs_heat: Optional[KcsHeat] = None
@@ -309,6 +318,8 @@ class Visitor:  # pylint: disable=R0904
                 yield from (visit.page_view for visit in list(self.page_view_visits.values()))
             if self.variations is not None:
                 yield from list(self.variations.values())
+            if self.targeted_segments is not None:
+                yield from list(self.targeted_segments.values())
             if self.conversions is not None:
                 yield from list(self.conversions)
 
@@ -331,6 +342,8 @@ class Visitor:  # pylint: disable=R0904
                 count += len(self.page_view_visits)
             if self.variations is not None:
                 count += len(self.variations)
+            if self.targeted_segments is not None:
+                count += len(self.targeted_segments)
             if self.conversions is not None:
                 count += len(self.conversions)
             return count
@@ -374,6 +387,12 @@ class Visitor:  # pylint: disable=R0904
         if context.overwrite or personalization.id not in self._data.personalizations:
             self._data.personalizations[personalization.id] = personalization
 
+    def _add_targeted_segment(self, context: DataAddingContext) -> None:
+        targeted_segment = cast(TargetedSegment, context.data)
+        if self._data.targeted_segments is None:
+            self._data.targeted_segments = {}
+        self._data.targeted_segments[targeted_segment.id] = targeted_segment
+
     def _add_forced_feature_variation(self, context: DataAddingContext) -> None:
         ffv = cast(ForcedFeatureVariation, context.data)
         if self._data.simulated_variations is None:
@@ -471,6 +490,7 @@ class Visitor:  # pylint: disable=R0904
         VisitorVisits: _set_visitor_visits,
         AssignedVariation: _add_variation,
         Personalization: _add_personalization,
+        TargetedSegment: _add_targeted_segment,
         ForcedFeatureVariation: _add_forced_feature_variation,
         ForcedExperimentVariation: _add_forced_experiment_variation,
         UniqueIdentifier: _set_is_unique_identifier,

kameleoon-client-python-3.15.0/kameleoon/data/targeted_segment.py

@@ -0,0 +1,34 @@
+"""Targeted Segment"""
+from kameleoon.data.data import BaseData, DataType
+from kameleoon.network.sendable import DuplicationUnsafeSendableBase
+from kameleoon.network.query_builder import QueryBuilder, QueryParam, QueryParams
+
+
+class TargetedSegment(BaseData, DuplicationUnsafeSendableBase):
+    """Targeted Segment"""
+    EVENT_TYPE = "targetingSegment"
+
+    def __init__(self, id_: int) -> None:
+        super().__init__()
+        self.__id = id_
+
+    @property
+    def id(self) -> int:  # pylint: disable=C0103
+        """Returns the segment ID."""
+        return self.__id
+
+    @property
+    def data_type(self) -> DataType:
+        """Returns the data type for the targeted segment."""
+        return DataType.TARGETED_SEGMENT
+
+    def _add_query_params(self, query_builder: QueryBuilder) -> None:
+        # fmt: off
+        query_builder.extend(
+            QueryParam(QueryParams.EVENT_TYPE, self.EVENT_TYPE),
+            QueryParam(QueryParams.SEGMENT_ID, str(self.__id)),
+        )
+        # fmt: on
+
+    def __str__(self) -> str:
+        return f"TargetedSegment{{id:{self.__id}}}"

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

@@ -17,6 +17,7 @@ from kameleoon.data.manager.assigned_variation import AssignedVariation
 from kameleoon.data.manager.forced_experiment_variation import ForcedExperimentVariation
 from kameleoon.data.manager.visitor import Visitor
 from kameleoon.data.manager.visitor_manager import VisitorManager
+from kameleoon.data.targeted_segment import TargetedSegment
 
 from kameleoon.exceptions import (
     FeatureVariationNotFound,
@@ -1380,7 +1381,7 @@ class KameleoonClient:
             campaign_id,
             rule,
         )
-        targeting = self._targeting_manager.check_targeting(visitor_code, campaign_id, rule)
+        targeting = self._targeting_manager.check_targeting(visitor_code, campaign_id, rule.targeting_segment)
         KameleoonLogger.debug(
             "RETURN: KameleoonClient.__check_targeting(visitor_code: %s, campaign_id: %s, rule: %s) -> "
             "(targeting: %s)",
@@ -1782,3 +1783,25 @@ class KameleoonClient:
             variation_key,
             force_targeting,
         )
+
+    def evaluate_audiences(self, visitor_code: str) -> None:
+        """
+        Evaluates the visitor against all available Audiences Explorer segments and tracks those that match.
+        A detailed analysis of segment performance can then be performed directly in Audiences Explorer.
+
+        :param visitor_code: The unique visitor code identifying the visitor.
+        :type visitor_code: str
+
+        :raises VisitorCodeInvalid: The provided **visitor code** is invalid.
+        """
+        KameleoonLogger.info("CALL: KameleoonClient.evaluate_audiences(visitor_code: %s)", visitor_code)
+        validate_visitor_code(visitor_code)
+        segments = [
+            TargetedSegment(seg.id_)
+            for seg in self._data_manager.data_file.audience_tracking_segments
+            if self._targeting_manager.check_targeting(visitor_code, None, seg)
+        ]
+        if segments:
+            self._visitor_manager.add_data(visitor_code, *segments)
+        self._tracking_manager.add_visitor_code(visitor_code)
+        KameleoonLogger.info("RETURN: KameleoonClient.evaluate_audiences(visitor_code: %s)", visitor_code)

{kameleoon-client-python-3.14.0 → kameleoon-client-python-3.15.0}/kameleoon/network/query_builder.py

@@ -48,6 +48,7 @@ class QueryParams(str, Enum):
     REVENUE = "revenue"
     SDK_NAME = "sdkName"
     SDK_VERSION = "sdkVersion"
+    SEGMENT_ID = "id"
     SITE_CODE = "siteCode"
     STATIC_DATA = "staticData"
     TIME_SINCE_PREVIOUS_VISIT = "timeSincePreviousVisit"

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

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

{kameleoon-client-python-3.14.0 → kameleoon-client-python-3.15.0}/kameleoon/targeting/conditions/exclusive_experiment_condition.py

@@ -35,7 +35,9 @@ class ExclusiveExperimentCondition(TargetingCondition):
         super().__init__(json_condition)
         self.__campaign_type = json_condition.get("campaignType")
 
-    def check(self, data: TargetingData) -> bool:
+    def check(self, data: Any) -> bool:
+        if not isinstance(data, self.TargetingData):
+            return False
         if self.__campaign_type == self.CampaignType.EXPERIMENT:
             return self.__check_experiment(data)
         if self.__campaign_type == self.CampaignType.PERSONALIZATION:

{kameleoon-client-python-3.14.0 → kameleoon-client-python-3.15.0}/kameleoon/targeting/conditions/segment_condition.py

@@ -42,5 +42,5 @@ class SegmentCondition(TargetingCondition):
         return isinstance(data, SegmentCondition.SegmentInfo) and self.__check(data)
 
     def __check(self, segment_info: SegmentInfo) -> bool:
-        rule = segment_info.data_file().rule_by_segment_id.get(self.__segment_id)
-        return rule is not None and rule.targeting_segment.check_tree(segment_info.condition_data())
+        segment = segment_info.data_file().segments.get(self.__segment_id)
+        return segment is not None and segment.check_tree(segment_info.condition_data())

kameleoon-client-python-3.15.0/kameleoon/targeting/models.py

@@ -0,0 +1,28 @@
+"""Targeting Segment"""
+
+from typing import Any, Dict, Optional
+from kameleoon.targeting.tree_builder import create_tree, Tree
+
+
+class Segment:
+    """Segment with targeting data"""
+
+    def __init__(self, id_: int, tree: Optional[Tree], audience_tracking: bool) -> None:
+        self.id_ = id_
+        self.tree = tree
+        self.audience_tracking = audience_tracking
+
+    @staticmethod
+    def from_json(obj: Dict[str, Any]) -> "Segment":
+        """Creates a Segment instance from JSON object"""
+        id_ = obj.get("id", -1)
+        tree = create_tree(obj.get("conditionsData"))
+        audience_tracking = obj.get("audienceTracking", False)
+        return Segment(id_, tree, audience_tracking)
+
+    def check_tree(self, get_targeting_data) -> Optional[bool]:
+        """Checks the targeting throught targeting tree"""
+        return self.tree.check(get_targeting_data) if self.tree else True
+
+    def __str__(self) -> str:
+        return f"Segment{{id:{self.id_},audience_tracking:{self.audience_tracking}}}"

{kameleoon-client-python-3.14.0 → kameleoon-client-python-3.15.0}/kameleoon/targeting/targeting_manager.py

@@ -1,7 +1,6 @@
 """Targeting Segment"""
 
 from typing import Optional
-from kameleoon.configuration.rule import Rule
 from kameleoon.data.manager.visitor import Visitor
 from kameleoon.data.manager.visitor_manager import VisitorManager
 from kameleoon.helpers.functions import enum_from_literal
@@ -16,6 +15,7 @@ from kameleoon.targeting.conditions.target_experiment_condition import TargetExp
 from kameleoon.targeting.conditions.target_personalization_condition import TargetPersonalizationCondition
 from kameleoon.targeting.conditions.targeting_condition import TargetingConditionType
 from kameleoon.targeting.conditions.visit_number_today_condition import VisitNumberTodayCondition
+from kameleoon.targeting.models import Segment
 
 
 class TargetingManager:
@@ -26,22 +26,23 @@ class TargetingManager:
         self.__visitor_manager = visitor_manager
 
     # pylint: disable=W0238
-    def check_targeting(self, visitor_code: str, campaign_id: int, rule: Rule):
+    def check_targeting(self, visitor_code: str, campaign_id: Optional[int], segment: Optional[Segment]):
         """Check if visitor is targeted for rule"""
         KameleoonLogger.debug(
-            "CALL: TargetingManager.check_targeting(visitor_code: %s, campaign_id: %s, rule: %s)",
-            visitor_code, campaign_id, rule
+            "CALL: TargetingManager.check_targeting(visitor_code: %s, campaign_id: %s, segment: %s)",
+            visitor_code, campaign_id, segment
         )
-        segment = rule.targeting_segment
         if segment is None:
             targeting: Optional[bool] = True
         else:
             visitor = self.__visitor_manager.get_visitor(visitor_code)
-            targeting = segment.check_tree(lambda type: self.__get_condition_data(type, visitor, visitor_code,
-                                                                                  campaign_id))
-        KameleoonLogger.debug("RETURN: TargetingManager.check_targeting(visitor_code: %s, campaign_id: %s, "
-                              "rule: %s) -> (targeting: %s)",
-                              visitor_code, campaign_id, rule, targeting)
+            targeting = segment.check_tree(
+                lambda type: self.__get_condition_data(type, visitor, visitor_code, campaign_id)
+            )
+        KameleoonLogger.debug(
+            "RETURN: TargetingManager.check_targeting(visitor_code: %s, campaign_id: %s, "
+            "segment: %s) -> (targeting: %s)", visitor_code, campaign_id, segment, targeting
+        )
         return targeting
 
     # pylint: disable=R0911
@@ -50,7 +51,7 @@ class TargetingManager:
         condition_type_literal: str,
         visitor: Optional[Visitor],
         visitor_code: str,
-        campaign_id: int,
+        campaign_id: Optional[int],
     ):
         # pylint: disable=E1101,W0212
         KameleoonLogger.debug(
@@ -72,9 +73,10 @@ class TargetingManager:
                     lambda type: self.__get_condition_data(type, visitor, visitor_code, campaign_id),
                 )
             elif condition_type == TargetingConditionType.EXCLUSIVE_EXPERIMENT:
-                condition_data = ExclusiveExperimentCondition.TargetingData(
-                    campaign_id, visitor.variations if visitor else {}, visitor.personalizations if visitor else {}
-                )
+                if campaign_id is not None:
+                    condition_data = ExclusiveExperimentCondition.TargetingData(
+                        campaign_id, visitor.variations if visitor else {}, visitor.personalizations if visitor else {}
+                    )
             elif condition_type == TargetingConditionType.VISITOR_CODE:
                 condition_data = visitor_code
             elif condition_type == TargetingConditionType.SDK_LANGUAGE:

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

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

{kameleoon-client-python-3.14.0 → kameleoon-client-python-3.15.0}/kameleoon_client_python.egg-info/SOURCES.txt

@@ -39,6 +39,7 @@ kameleoon/data/mapping_identifier.py
 kameleoon/data/operating_system.py
 kameleoon/data/page_view.py
 kameleoon/data/personalization.py
+kameleoon/data/targeted_segment.py
 kameleoon/data/unique_identifier.py
 kameleoon/data/user_agent.py
 kameleoon/data/visitor_visits.py

kameleoon-client-python-3.14.0/kameleoon/targeting/models.py

@@ -1,29 +0,0 @@
-"""Targeting Segment"""
-
-from typing import Optional
-from kameleoon.exceptions import NotFoundError
-from kameleoon.targeting.tree_builder import create_tree
-
-
-class Segment:
-    """Segment with targeting data"""
-
-    def __init__(self, *args) -> None:
-        if args:
-            if len(args) == 1:
-                if args[0] is None:
-                    raise NotFoundError("arguments for segment")
-                if "id" not in args[0]:
-                    raise NotFoundError("id")
-                self.id_ = int(args[0]["id"])
-                if "conditionsData" not in args[0]:
-                    raise NotFoundError("conditionsData")
-
-                self.tree = create_tree(args[0]["conditionsData"])
-            elif len(args) == 2:
-                self.id_ = args[0]
-                self.tree = args[1]
-
-    def check_tree(self, get_targeting_data) -> Optional[bool]:
-        """Checks the targeting throught targeting tree"""
-        return self.tree.check(get_targeting_data) if self.tree else True