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

{kameleoon-client-python-3.15.0 → kameleoon-client-python-3.16.0}/PKG-INFO

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

{kameleoon-client-python-3.15.0 → kameleoon-client-python-3.16.0}/kameleoon/configuration/custom_data_info.py

@@ -18,6 +18,7 @@ class CustomDataInfo:
         self.__local_only = set()
         self.__visitor_scope = set()
         self.__custom_data_index_by_id = {}
+        self.__custom_data_index_by_name = {}
         if custom_data is not None:
             for data in custom_data:
                 index = data.get("index")
@@ -29,6 +30,8 @@ class CustomDataInfo:
                         self.__visitor_scope.add(index)
                     if (id_ := data.get("id")) is not None:
                         self.__custom_data_index_by_id[id_] = index
+                    if (name := data.get("name")) is not None:
+                        self.__custom_data_index_by_name[name] = index
                     if data.get("isMappingIdentifier"):
                         if bool(self.__mapping_identifier_index is not None):
                             KameleoonLogger.warning(
@@ -55,5 +58,9 @@ class CustomDataInfo:
         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"""
+        """Get corresponding custom data index by custom data id"""
         return self.__custom_data_index_by_id.get(custom_data_id)
+
+    def get_custom_data_index_by_name(self, custom_data_name: str) -> Optional[int]:
+        """Get corresponding custom data index by custom data name"""
+        return self.__custom_data_index_by_name.get(custom_data_name)

kameleoon-client-python-3.16.0/kameleoon/data/custom_data.py

@@ -0,0 +1,90 @@
+"""Custom data"""
+
+import json
+from typing import Optional, Tuple, Union
+from kameleoon.data.data import Data, DataType
+from kameleoon.network.sendable import DuplicationUnsafeSendableBase
+from kameleoon.network.query_builder import QueryBuilder, QueryParam, QueryParams
+
+
+class CustomData(Data, DuplicationUnsafeSendableBase):
+    """Custom data"""
+
+    EVENT_TYPE = "customData"
+
+    def __init__(self, index_or_name: Union[int, str], *args: str, overwrite=True) -> None:
+        """
+        :param index_or_name: Index or Name of the custom data. This field is mandatory.
+        :type index_or_name: Union[int, str]
+        :param args: Values of the custom data to be stored. This field is mandatory.
+        :type args: *str
+        :param overwrite: Flag to explicitly control how the values are stored and how they appear in reports.
+        This field is optional, `True` by default.
+        :type overwrite: bool
+        """
+        # pylint: disable=invalid-name,redefined-builtin
+        super().__init__()
+        # pylint: disable=W0511
+        if isinstance(index_or_name, int):
+            self.__index = index_or_name
+            self._name = None
+        else:
+            self.__index = -1
+            self._name = index_or_name
+        self.__values = args
+        self.__overwrite = overwrite
+
+    def _named_to_indexed(self, index: int) -> "CustomData":
+        """Makes an indexed Custom Data instance based on the current instance"""
+        custom_data = CustomData(index, *self.__values, overwrite=self.__overwrite)
+        custom_data._name = self._name
+        return custom_data
+
+    @property
+    def id(self) -> int:  # pylint: disable=C0103
+        """
+        Deprecated. Please use `index` instead.
+
+        Returns index
+        """
+        return self.__index
+
+    @property
+    def index(self) -> int:
+        """Returns index"""
+        return self.__index
+
+    @property
+    def name(self) -> Optional[str]:
+        """Returns name"""
+        return self._name
+
+    @property
+    def values(self) -> Tuple[str, ...]:
+        """Returns values"""
+        return self.__values
+
+    @property
+    def overwrite(self) -> bool:
+        """Returns overwrite"""
+        return self.__overwrite
+
+    @property
+    def data_type(self) -> DataType:
+        return DataType.CUSTOM_DATA
+
+    def _add_query_params(self, query_builder: QueryBuilder) -> None:
+        str_values = json.dumps({v: 1 for v in self.__values}, separators=(",", ":"))
+        query_builder.extend(
+            QueryParam(QueryParams.EVENT_TYPE, self.EVENT_TYPE, False),
+            QueryParam(QueryParams.INDEX, str(self.id), False),
+            QueryParam(QueryParams.VALUES_COUNT_MAP, str_values),
+            QueryParam(QueryParams.OVERWRITE, "true" if self.__overwrite else "false", False),
+        )
+
+    def __str__(self):
+        return (
+            "CustomData{"
+            f"index:{self.__index},name:'{self._name}',values:{self.__values},overwrite:{self.__overwrite}"
+            "}"
+        )

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

@@ -227,6 +227,8 @@ class Visitor:  # pylint: disable=R0904
         KameleoonLogger.debug('CALL: Visitor.add_data(args: %s, overwrite: %s)', args, overwrite)
         with self._data.lock:
             for data in args:
+                if data is None:
+                    continue
                 data_type = type(data)
                 data_adder = self.DATA_ADDERS.get(data_type)
                 if data_adder:
@@ -424,8 +426,8 @@ class Visitor:  # pylint: disable=R0904
         custom_data = cast(CustomData, context.data)
         if self._data.custom_data_dict is None:
             self._data.custom_data_dict = {}
-        if context.overwrite or custom_data.id not in self._data.custom_data_dict:
-            self._data.custom_data_dict[custom_data.id] = custom_data
+        if context.overwrite or custom_data.index not in self._data.custom_data_dict:
+            self._data.custom_data_dict[custom_data.index] = custom_data
 
     def _add_page_view(self, context: DataAddingContext) -> None:
         page_view = cast(PageView, context.data)

{kameleoon-client-python-3.15.0 → kameleoon-client-python-3.16.0}/kameleoon/data/manager/visitor_manager.py

@@ -87,15 +87,20 @@ class VisitorManager:
 
     def __process_custom_data(
         self, visitor_code: str, visitor: Visitor, custom_data_info: CustomDataInfo, custom_data: CustomData
-    ) -> CustomData:
+    ) -> Optional[CustomData]:
         """Processes custom data, potentially modifying or mapping it based on certain conditions."""
+        if custom_data.name is not None:
+            cd_index = custom_data_info.get_custom_data_index_by_name(custom_data.name)
+            if cd_index is None:
+                return None
+            custom_data = custom_data._named_to_indexed(cd_index)
         # We shouldn't send custom data with local only type
-        if custom_data_info.is_local_only(custom_data.id):
+        if custom_data_info.is_local_only(custom_data.index):
             custom_data.mark_as_sent()
         # If mappingIdentifier is passed, we should link anonymous visitor with real unique userId.
         # After authorization, customer must be able to continue work with userId, but hash for variation
         # should be calculated based on anonymous visitor code, that's why set MappingIdentifier to visitor.
-        if custom_data_info.is_mapping_identifier(custom_data.id) and custom_data.values and custom_data.values[0]:
+        if custom_data_info.is_mapping_identifier(custom_data.index) and custom_data.values and custom_data.values[0]:
             visitor.mapping_identifier = visitor_code
             user_id = custom_data.values[0]
             if visitor_code != user_id:

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

@@ -6,7 +6,8 @@ from kameleoon.network.query_builder import QueryBuilder, QueryParam, QueryParam
 class MappingIdentifier(CustomData):
     """Mapping identifier"""
     def __init__(self, custom_data: CustomData) -> None:
-        super().__init__(custom_data.id, *custom_data.values)
+        super().__init__(custom_data.index, *custom_data.values, overwrite=custom_data.overwrite)
+        self._name = custom_data.name
 
     @property
     def unsent(self) -> bool:

{kameleoon-client-python-3.15.0 → kameleoon-client-python-3.16.0}/kameleoon/managers/remote_data/remote_visitor_data.py

@@ -103,7 +103,7 @@ class RemoteVisitorData:
         """Marks data as sent based on the provided `custom_data_info`."""
         if self.__custom_data_dict:
             for data in self.__custom_data_dict.values():
-                if custom_data_info is None or not custom_data_info.is_visitor_scope(data.id):
+                if custom_data_info is None or not custom_data_info.is_visitor_scope(data.index):
                     data.mark_as_sent()
         if self.__experiments:
             for experiment in self.__experiments.values():

{kameleoon-client-python-3.15.0 → kameleoon-client-python-3.16.0}/kameleoon/middleware.py

@@ -32,7 +32,6 @@ class KameleoonWSGIMiddleware:
                 environ["HTTP_COOKIE"] = f"{VISITOR_CODE_COOKIE}={visitor_code}"
 
         def _custom_start_response(status, headers, exc_info=None):
-            # pylint: disable=W0212
             self._client._cookie_manager.update(visitor_code, self._client._is_consent_given(visitor_code), cookies)
             headers.append(("Set-Cookie", cookies.output(header="")))
             return start_response(status, headers, exc_info)

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

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

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

@@ -53,7 +53,7 @@ class TargetingManager:
         visitor_code: str,
         campaign_id: Optional[int],
     ):
-        # pylint: disable=E1101,W0212
+        # pylint: disable=E1101
         KameleoonLogger.debug(
             "CALL: TargetingManager.__get_condition_data(condition_type_literal: %s, visitor, visitor_code: %s, "
             "campaign_id: %s)", condition_type_literal, visitor_code, campaign_id

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

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

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

@@ -1,58 +0,0 @@
-"""Custom data"""
-
-import json
-from typing import Tuple
-from kameleoon.data.data import Data, DataType
-from kameleoon.network.sendable import DuplicationUnsafeSendableBase
-from kameleoon.network.query_builder import QueryBuilder, QueryParam, QueryParams
-
-
-class CustomData(Data, DuplicationUnsafeSendableBase):
-    """Custom data"""
-
-    EVENT_TYPE = "customData"
-
-    def __init__(self, id: int, *args: str) -> None:
-        """
-        :param id: Index / ID of the custom data to be stored. This field is mandatory.
-        :type id: int
-        :param `*args`: Values of the custom data to be stored. This field is optional.
-        :type `*args`: str
-
-        Example:
-
-        .. code-block:: python3
-
-                kameleoon_client.add_data(visitor_code, CustomData(123, "some-value"))
-        """
-        # pylint: disable=invalid-name,redefined-builtin
-        super().__init__()
-        # pylint: disable=W0511
-        self.__id = id
-        self.__values = args
-
-    @property
-    def id(self) -> int:  # pylint: disable=C0103
-        """Returns ID"""
-        return self.__id
-
-    @property
-    def values(self) -> Tuple[str, ...]:
-        """Stored values."""
-        return self.__values
-
-    @property
-    def data_type(self) -> DataType:
-        return DataType.CUSTOM_DATA
-
-    def _add_query_params(self, query_builder: QueryBuilder) -> None:
-        str_values = json.dumps({v: 1 for v in self.__values}, separators=(",", ":"))
-        query_builder.extend(
-            QueryParam(QueryParams.EVENT_TYPE, self.EVENT_TYPE, False),
-            QueryParam(QueryParams.INDEX, str(self.id), False),
-            QueryParam(QueryParams.VALUES_COUNT_MAP, str_values),
-            QueryParam(QueryParams.OVERWRITE, "true", False),
-        )
-
-    def __str__(self):
-        return f"CustomData{{id:{self.__id},values:{self.__values}}}"

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