Some improvements (#122)

* better usage of py3
* improve hook
* make some parts more idiomatic
* handle some error-prone parts

Author: ferhatelmas

README.md

@@ -168,7 +168,7 @@ LOCAL=true py.test
 Install black and flake8
 
 ```
-pip install .[lint]
+pip install .[ci]
 ```
 
 Install git hooks to avoid pushing invalid code (git commit will run `black` and `flake8`)

dotgit/hooks/pre-commit-format.sh

@@ -2,11 +2,17 @@
 
 set -e
 
-if ! black . --check -q; then
-    black .
+if ! black stream --check -q; then
+    black stream
+    echo
     echo "some files were not formatted correctly (black) commit aborted!"
     echo "your changes are still staged, you can accept formatting changes with git add or ignore them by adding --no-verify to git commit"
     exit 1
 fi
 
-flake8 --ignore=E501,E225,W293,W503 .
+if ! flake8 --ignore=E501,E225,W293,W503 stream; then
+    echo
+    echo "commit is aborted because there are some error prone issues in your changes as printed above"
+    echo "your changes are still staged, you can accept formatting changes with git add or ignore them by adding --no-verify to git commit"
+    exit 1
+fi

stream/__init__.py

@@ -1,5 +1,5 @@
-import re
 import os
+import re
 
 __author__ = "Thierry Schellenbach"
 __copyright__ = "Copyright 2014, Stream.io, Inc"

stream/client.py

@@ -4,16 +4,16 @@
 
 import jwt
 import requests
-from stream.serializer import _datetime_encoder
+from requests import Request
 
 from stream import exceptions, serializer
-from stream.users import Users
-from stream.utils import validate_feed_slug, validate_user_id, validate_foreign_id_time
-from requests import Request
-from stream.reactions import Reactions
 from stream.collections import Collections
-from stream.personalization import Personalization
 from stream.feed import Feed
+from stream.personalization import Personalization
+from stream.reactions import Reactions
+from stream.serializer import _datetime_encoder
+from stream.users import Users
+from stream.utils import validate_feed_slug, validate_foreign_id_time, validate_user_id
 
 try:
     from urllib.parse import urlparse
@@ -23,7 +23,7 @@
 logger = logging.getLogger(__name__)
 
 
-class StreamClient(object):
+class StreamClient:
     def __init__(
         self,
         api_key,
@@ -377,9 +377,7 @@ def get_activities(
         if enrich or reactions is not None:
             endpoint = "enrich/" + endpoint
 
-        query_params = {}
-        for key in params:
-            query_params[key] = params[key]
+        query_params = {**params}
 
         if ids is not None:
             query_params["ids"] = ",".join(ids)
@@ -405,7 +403,7 @@ def get_activities(
         return self.get(endpoint, auth_token, params=query_params)
 
     def activity_partial_update(
-        self, id=None, foreign_id=None, time=None, set={}, unset=[]
+        self, id=None, foreign_id=None, time=None, set=None, unset=None
     ):
         """
         Partial update activity, via activity ID or Foreign ID + timestamp
@@ -426,7 +424,7 @@ def activity_partial_update(
                 "Only one of the id or the foreign_id+time parameters can be provided"
             )
 
-        data = {"set": set, "unset": unset}
+        data = {"set": set or {}, "unset": unset or []}
 
         if id is not None:
             data["id"] = id
@@ -436,7 +434,7 @@ def activity_partial_update(
 
         return self.activities_partial_update(updates=[data])
 
-    def activities_partial_update(self, updates=[]):
+    def activities_partial_update(self, updates=None):
         """
         Partial update activity, via activity ID or Foreign ID + timestamp
 
@@ -460,7 +458,7 @@ def activities_partial_update(self, updates=[]):
 
         auth_token = self.create_jwt_token("activities", "*", feed_id="*")
 
-        data = {"changes": updates}
+        data = {"changes": updates or []}
 
         return self.post("activity/", auth_token, data=data)
 

stream/collections.py

@@ -1,4 +1,4 @@
-class Collections(object):
+class Collections:
     def __init__(self, client, token):
         """
         Used to manipulate data at the 'meta' endpoint
@@ -34,18 +34,17 @@ def upsert(self, collection_name, data):
                                            {"id": '2', "name": "Ruby", "interests": ["Sunbeams", "Surprise Attacks"]}])
         """
 
-        if type(data) != list:
+        if not isinstance(data, list):
             data = [data]
 
         data_json = {collection_name: data}
 
-        response = self.client.post(
+        return self.client.post(
             "collections/",
             service_name="api",
             signature=self.token,
             data={"data": data_json},
         )
-        return response
 
     def select(self, collection_name, ids):
         """
@@ -60,24 +59,20 @@ def select(self, collection_name, ids):
             client.collections.select('user', [1,2,3])
         """
 
-        if type(ids) != list:
+        if not isinstance(ids, list):
             ids = [ids]
-        ids = [str(i) for i in ids]
 
-        foreign_ids = []
-        for i in range(len(ids)):
-            foreign_ids.append("%s:%s" % (collection_name, ids[i]))
-        foreign_ids = ",".join(foreign_ids)
+        foreign_ids = ",".join(
+            "%s:%s" % (collection_name, k) for i, k in enumerate(ids)
+        )
 
-        response = self.client.get(
+        return self.client.get(
             "collections/",
             service_name="api",
             params={"foreign_ids": foreign_ids},
             signature=self.token,
         )
 
-        return response
-
     def delete_many(self, collection_name, ids):
         """
         Delete data from meta.
@@ -90,18 +85,16 @@ def delete_many(self, collection_name, ids):
             client.collections.delete('user', ['1','2','3'])
         """
 
-        if type(ids) != list:
+        if not isinstance(ids, list):
             ids = [ids]
         ids = [str(i) for i in ids]
 
         params = {"collection_name": collection_name, "ids": ids}
 
-        response = self.client.delete(
+        return self.client.delete(
             "collections/", service_name="api", params=params, signature=self.token
         )
 
-        return response
-
     def add(self, collection_name, data, id=None, user_id=None):
         payload = dict(id=id, data=data, user_id=user_id)
         return self.client.post(

stream/feed.py

@@ -1,7 +1,7 @@
-from stream.utils import validate_feed_id, validate_user_id, validate_feed_slug
+from stream.utils import validate_feed_id, validate_feed_slug, validate_user_id
 
 
-class Feed(object):
+class Feed:
     def __init__(self, client, feed_slug, user_id, token):
         """
         Initializes the Feed class
@@ -61,8 +61,7 @@ def add_activity(self, activity_data):
             activity_data["to"] = self.add_to_signature(activity_data["to"])
 
         token = self.create_scope_token("feed", "write")
-        result = self.client.post(self.feed_url, data=activity_data, signature=token)
-        return result
+        return self.client.post(self.feed_url, data=activity_data, signature=token)
 
     def add_activities(self, activity_list):
         """
@@ -87,8 +86,8 @@ def add_activities(self, activity_list):
         token = self.create_scope_token("feed", "write")
         data = dict(activities=activities)
         if activities:
-            result = self.client.post(self.feed_url, data=data, signature=token)
-            return result
+            return self.client.post(self.feed_url, data=data, signature=token)
+        return None
 
     def remove_activity(self, activity_id=None, foreign_id=None):
         """
@@ -106,8 +105,7 @@ def remove_activity(self, activity_id=None, foreign_id=None):
         token = self.create_scope_token("feed", "delete")
         if foreign_id is not None:
             params["foreign_id"] = "1"
-        result = self.client.delete(url, signature=token, params=params)
-        return result
+        return self.client.delete(url, signature=token, params=params)
 
     def get(self, enrich=False, reactions=None, **params):
         """
@@ -143,8 +141,7 @@ def get(self, enrich=False, reactions=None, **params):
             if reactions.get("counts"):
                 params["withReactionCounts"] = True
 
-        response = self.client.get(feed_url, params=params, signature=token)
-        return response
+        return self.client.get(feed_url, params=params, signature=token)
 
     def follow(
         self, target_feed_slug, target_user_id, activity_copy_limit=None, **extra_data
@@ -168,8 +165,7 @@ def follow(
             data["activity_copy_limit"] = activity_copy_limit
         token = self.create_scope_token("follower", "write")
         data.update(extra_data)
-        response = self.client.post(url, data=data, signature=token)
-        return response
+        return self.client.post(url, data=data, signature=token)
 
     def unfollow(self, target_feed_slug, target_user_id, keep_history=False):
         """
@@ -183,31 +179,27 @@ def unfollow(self, target_feed_slug, target_user_id, keep_history=False):
         params = {}
         if keep_history:
             params["keep_history"] = True
-        response = self.client.delete(url, signature=token, params=params)
-        return response
+        return self.client.delete(url, signature=token, params=params)
 
     def followers(self, offset=0, limit=25, feeds=None):
         """
         Lists the followers for the given feed
         """
-        feeds = feeds is not None and ",".join(feeds) or ""
+        feeds = ",".join(feeds) if feeds is not None else ""
         params = {"limit": limit, "offset": offset, "filter": feeds}
         url = self.feed_url + "followers/"
         token = self.create_scope_token("follower", "read")
-        response = self.client.get(url, params=params, signature=token)
-        return response
+        return self.client.get(url, params=params, signature=token)
 
     def following(self, offset=0, limit=25, feeds=None):
         """
         List the feeds which this feed is following
         """
-        if feeds is not None:
-            feeds = feeds is not None and ",".join(feeds) or ""
+        feeds = ",".join(feeds) if feeds is not None else ""
         params = {"offset": offset, "limit": limit, "filter": feeds}
         url = self.feed_url + "follows/"
         token = self.create_scope_token("follower", "read")
-        response = self.client.get(url, params=params, signature=token)
-        return response
+        return self.client.get(url, params=params, signature=token)
 
     def add_to_signature(self, recipients):
         """

stream/personalization.py

@@ -1,4 +1,4 @@
-class Personalization(object):
+class Personalization:
     def __init__(self, client, token):
         """
         Methods to interact with personalized feeds.
@@ -20,13 +20,12 @@ def get(self, resource, **params):
             personalization.get('follow_recommendations', user_id=123, limit=10, offset=10)
         """
 
-        response = self.client.get(
+        return self.client.get(
             resource,
             service_name="personalization",
             params=params,
             signature=self.token,
         )
-        return response
 
     def post(self, resource, **params):
         """
@@ -43,14 +42,13 @@ def post(self, resource, **params):
 
         data = params["data"] or None
 
-        response = self.client.post(
+        return self.client.post(
             resource,
             service_name="personalization",
             params=params,
             signature=self.token,
             data=data,
         )
-        return response
 
     def delete(self, resource, **params):
         """
@@ -60,11 +58,9 @@ def delete(self, resource, **params):
         :return: data that was deleted if successful or not.
         """
 
-        response = self.client.delete(
+        return self.client.delete(
             resource,
             service_name="personalization",
             params=params,
             signature=self.token,
         )
-
-        return response

stream/reactions.py

@@ -1,4 +1,4 @@
-class Reactions(object):
+class Reactions:
     def __init__(self, client, token):
         self.client = client
         self.token = token

stream/serializer.py

@@ -1,5 +1,6 @@
 import datetime
 import json
+
 import pytz
 
 """
@@ -13,11 +14,12 @@
 
 def _datetime_encoder(obj):
     if isinstance(obj, datetime.datetime):
-        if obj.utcoffset() is None:  # support for <= 3.3
+        if obj.utcoffset() is None:  # 3.5
             obj = pytz.utc.localize(obj)
         return datetime.datetime.strftime(obj.astimezone(pytz.utc), DATETIME_FORMAT)
     if isinstance(obj, datetime.date):
         return datetime.datetime.strftime(obj, DATE_FORMAT)
+    return None
 
 
 def _datetime_decoder(dict_):