Merge pull request #102 from splitio/development

Python 6.1.0 Release

Author: mredolatti

.github/pull_request_template.md

@@ -0,0 +1,15 @@
+# Python SDK
+
+## Tickets covered:
+* [SDKS-{TICKET}](https://splitio.atlassian.net/browse/SDKS-{TICKET})
+
+## What did you accomplish?
+* Bullet 1
+* Bullet 2
+
+## How to test new changes?
+*
+
+## Extra Notes
+* Bullet 1
+* Bullet 2

.gitignore

@@ -23,6 +23,7 @@ var/
 *.egg-info/
 .installed.cfg
 *.egg
+venv/
 .vscode
 
 # PyInstaller

CHANGES.txt

@@ -1,3 +1,6 @@
+6.1.0 (Sep 25, 2018)
+ - Add custom impression listener feature.
+ - Input Sanitization for track, get_treatment and split.
 6.0.0 (Aug 29, 2018)
  - Add support for redis sentinel
  - UWSGI performance boost (breaking change)

Detailed-README.md

@@ -32,6 +32,120 @@ The following snippet shows you how to create a basic client using the default c
   'SOME_TREATMENT'
 ```
 
+## Logging
+Split SDK uses logging module from Python.
+
+### Logging sample
+```python
+import logging
+logging.basicConfig(level=logging.DEBUG)
+```
+
+## Cache
+Split SDK depends on the popular [redis-py](https://github.com/andymccurdy/redis-py) library.
+
+### Cache Adapter
+The redis-py library is supported as the python interface to the Redis key-value store. This library uses a connection pool to manage connections to a Redis server. For further information about how to configure the ```redis-py``` client, please take a look on [redis-py official docs](https://github.com/andymccurdy/redis-py)
+
+For ```redis``` and their dependencies such as ```jsonpickle``` you can use ```pip``` running the command ```pip install splitio_client[redis,cpphash]==5.5.0```
+
+#### Provided redis-py connection - sample code
+```python
+#Default imports
+from __future__ import print_function
+
+import sys
+
+from splitio import get_factory
+from splitio.exceptions import TimeoutException
+
+# redis-py options
+'''The options below, will be loaded as:
+r = redis.StrictRedis(host='localhost', port=6379, db=0, prefix='')
+'''
+config = {
+    'redisDb' : 0, 
+    'redisHost' : 'localhost',
+    'redisPosrt': 6379,
+    'redisPrefix': ''
+}
+
+# Create the Split Client instance.
+try:
+    factory = get_factory('API_KEY', config=config)
+    split = factory.client()
+except TimeoutException:
+    sys.exit()
+```
+
+#### Provided redis-py connection - sample code for Sentinel Support
+```python
+#Default imports
+from __future__ import print_function
+
+import sys
+
+from splitio import get_factory
+from splitio.exceptions import TimeoutException
+
+# redis-py options
+'''
+The options below, will be loaded as:
+sentinel = Sentinel(redisSentinels, { db: redisDb, socket_timeout: redisSocketTimeout })
+master = sentinel.master_for(redisMasterService)
+'''
+config = {
+    'redisDb': 0,
+    'redisPrefix': '',
+    'redisSentinels': [('IP', PORT), ('IP', PORT), ('IP', PORT)],
+    'redisMasterService': 'SERVICE_MASTER_NAME',
+    'redisSocketTimeout': 3
+}
+
+# Create the Split Client instance.
+try:
+    factory = get_factory('API_KEY', config=config)
+    split = factory.client()
+except TimeoutException:
+    sys.exit()
+```
+
+## Impression Listener
+Split SDKs send impression data back to Split servers periodically and as a result of evaluating splits. In order to additionally send this information to a location of your choice, you could define and attach an Impression Listener. For that purpose, SDK's options have a parameter called `impressionListener` where an implementation of `ImpressionListener` could be added. This implementation **must** define the `log_impression` method and it will receive data in the following schema:
+
+| Name | Type | Description |
+| --- | --- | --- |
+| impression | Impression | Impression object that has the feature_name, treatment result, label, etc. |
+| attributes | Array | A list of attributes passed by the client. |
+| instance-id | String | Corresponds to the IP of the machine where the SDK is running. |
+| sdk-language-version | String | Indicates the version of the sdk. In this case the language will be python plus the version of it. |
+
+### Implementing custom Impression Listener
+Below you could find an example of how implement a custom Impression Listener:
+```python
+# Import ImpressionListener interface
+from splitio.impressions import ImpressionListener
+
+# Implementation Sample for a Custom Impression Listener
+class CustomImpressionListener(ImpressionListener)
+{
+  def log_impression(self, data):
+    # Custom behavior
+}
+```
+
+### Attaching custom Impression Listener
+```python
+factory = get_factory(
+  'YOUR_API_KEY',
+  config={
+    # ...
+    'impressionListener': CustomImpressionListener()
+  },
+  # ...
+)
+split = factory.client()
+
 ## Additional information
 
 You can get more information on how to use this package in the included documentation.

splitio/__init__.py

@@ -2,7 +2,7 @@
     unicode_literals
 
 from .factories import get_factory # noqa
-from .clients import Key # noqa
+from .key import Key # noqa
 from .version import __version__  # noqa
 
 __all__ = ('api', 'brokers', 'cache', 'clients', 'matchers', 'segments',

splitio/brokers.py

@@ -57,12 +57,13 @@ class BaseBroker(object):
 
     __metaclass__ = abc.ABCMeta
 
-    def __init__(self):
+    def __init__(self, config=None):
         """
         Class constructor, only sets up the logger
         """
         self._logger = logging.getLogger(self.__class__.__name__)
         self._destroyed = False
+        self._config = config
 
     def fetch_feature(self, name):
         """
@@ -120,7 +121,7 @@ def destroy(self):
         pass
 
 class JSONFileBroker(BaseBroker):
-    def __init__(self, segment_changes_file_name, split_changes_file_name):
+    def __init__(self, config, segment_changes_file_name, split_changes_file_name):
         """
         A Broker implementation that uses responses from the segmentChanges and
         splitChanges resources to provide access to splits. It is intended to be
@@ -133,7 +134,7 @@ def __init__(self, segment_changes_file_name, split_changes_file_name):
             splitChanges response
         :type split_changes_file_name: str
         """
-        super(JSONFileBroker, self).__init__()
+        super(JSONFileBroker, self).__init__(config)
         self._segment_changes_file_name = segment_changes_file_name
         self._split_changes_file_name = split_changes_file_name
         self._split_fetcher = self._build_split_fetcher()
@@ -310,7 +311,6 @@ def _build_treatment_log(self):
             self._sdk_api,
             max_count=self._max_impressions_log_size,
             interval=self._impressions_interval,
-            listener=self._impression_listener
         )
         return AsyncTreatmentLog(self_updating_treatment_log)
 
@@ -388,7 +388,7 @@ class LocalhostEventStorage(object):
         def log(self, event):
             pass
 
-    def __init__(self, split_definition_file_name=None, auto_refresh_period=2):
+    def __init__(self, config, split_definition_file_name=None, auto_refresh_period=2):
         """
         A broker implementation that builds its configuration from a split
         definition file. By default the definition is taken from $HOME/.split
@@ -398,7 +398,7 @@ def __init__(self, split_definition_file_name=None, auto_refresh_period=2):
         :param auto_refresh_period: Number of seconds between split refresh calls
         :type auto_refresh_period: int
         """
-        super(LocalhostBroker, self).__init__()
+        super(LocalhostBroker, self).__init__(config)
 
         if split_definition_file_name is None:
             self._split_definition_file_name = os.path.join(
@@ -503,11 +503,11 @@ def destroy(self):
 
 
 class RedisBroker(BaseBroker):
-    def __init__(self, redis):
+    def __init__(self, redis, config):
         """A Broker implementation that uses Redis as its backend.
         :param redis: A redis broker
         :type redis: StrctRedis"""
-        super(RedisBroker, self).__init__()
+        super(RedisBroker, self).__init__(config)
 
         split_cache = RedisSplitCache(redis)
         split_fetcher = CacheBasedSplitFetcher(split_cache)
@@ -571,7 +571,7 @@ def __init__(self, uwsgi, config=None):
         :param config: The configuration dictionary
         :type config: dict
         """
-        super(UWSGIBroker, self).__init__()
+        super(UWSGIBroker, self).__init__(config)
 
         split_cache = UWSGISplitCache(uwsgi)
         split_fetcher = CacheBasedSplitFetcher(split_cache)
@@ -712,7 +712,7 @@ def get_self_refreshing_broker(api_key, **kwargs):
     )
 
     if api_key == 'localhost':
-        return LocalhostBroker(**kwargs)
+        return LocalhostBroker(config, **kwargs)
 
     return SelfRefreshingBroker(
         api_key,
@@ -776,11 +776,11 @@ def get_redis_broker(api_key, **kwargs):
     api_key, config, _, _ = _init_config(api_key, **kwargs)
 
     if api_key == 'localhost':
-        return LocalhostBroker(**kwargs)
+        return LocalhostBroker(config, **kwargs)
 
     redis = get_redis(config)
 
-    redis_broker = RedisBroker(redis)
+    redis_broker = RedisBroker(redis, config)
 
     return redis_broker
 
@@ -836,7 +836,7 @@ def get_uwsgi_broker(api_key, **kwargs):
     api_key, config, _, _ = _init_config(api_key, **kwargs)
 
     if api_key == 'localhost':
-        return LocalhostBroker(**kwargs)
+        return LocalhostBroker(config, **kwargs)
 
     uwsgi = get_uwsgi()
     uwsgi_broker = UWSGIBroker(uwsgi, config)