Enforcing styling through Travis and pep8 (#59)

aliabbasrizvi · alda-optimizely · commit 172482f47f56 · 2017-10-06T14:32:12.000-07:00
diff --git a/.travis.yml b/.travis.yml
@@ -3,6 +3,7 @@ python:
   - "2.7"
   - "3.4"
 install: "pip install -r requirements/core.txt;pip install -r requirements/test.txt"
+before_script: "pep8"
 script: "nosetests --with-coverage --cover-package=optimizely"
 after_success:
   - coveralls
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -21,7 +21,7 @@ We welcome contributions and feedback! All contributors must sign our [Contribut
 
 ## Style
 
-We enforce PEP-8 rules with a few minor deviations.
+We enforce PEP-8 rules with a few minor [deviations](https://github.com/optimizely/python-sdk/blob/master/tox.ini).
 
 ## License
 
diff --git a/optimizely/entities.py b/optimizely/entities.py
@@ -11,6 +11,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+
 class BaseEntity(object):
 
   def __eq__(self, other):
diff --git a/optimizely/error_handler.py b/optimizely/error_handler.py
@@ -11,6 +11,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+
 class BaseErrorHandler(object):
   """ Class encapsulating exception handling functionality.
   Override with your own exception handler providing handle_error method. """
diff --git a/optimizely/exceptions.py b/optimizely/exceptions.py
@@ -11,6 +11,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+
 class InvalidAttributeException(Exception):
   """ Raised when provided attribute is invalid. """
   pass
diff --git a/optimizely/helpers/validator.py b/optimizely/helpers/validator.py
@@ -136,10 +136,10 @@ def is_user_profile_valid(user_profile):
   if not type(user_profile) is dict:
     return False
 
-  if not UserProfile.USER_ID_KEY in user_profile:
+  if UserProfile.USER_ID_KEY not in user_profile:
     return False
 
-  if not UserProfile.EXPERIMENT_BUCKET_MAP_KEY in user_profile:
+  if UserProfile.EXPERIMENT_BUCKET_MAP_KEY not in user_profile:
     return False
 
   experiment_bucket_map = user_profile.get(UserProfile.EXPERIMENT_BUCKET_MAP_KEY)
diff --git a/optimizely/optimizely.py b/optimizely/optimizely.py
@@ -192,7 +192,7 @@ def activate(self, experiment_key, user_id, attributes=None):
 
     return variation.key
 
-  def track(self, event_key, user_id,  attributes=None, event_tags=None):
+  def track(self, event_key, user_id, attributes=None, event_tags=None):
     """ Send conversion event to Optimizely.
 
     Args:
diff --git a/optimizely/user_profile.py b/optimizely/user_profile.py
@@ -2,7 +2,7 @@
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
 # You may obtain a copy of the License at
-# 
+#
 # http://www.apache.org/licenses/LICENSE-2.0
 
 # Unless required by applicable law or agreed to in writing, software
diff --git a/tests/benchmarking/benchmarking_tests.py b/tests/benchmarking/benchmarking_tests.py
@@ -169,7 +169,7 @@ def compute_average(values):
   Returns:
     Average of all values.
   """
-  return float(sum(values))/len(values)
+  return float(sum(values)) / len(values)
 
 
 def compute_median(values):
@@ -185,7 +185,7 @@ def compute_median(values):
   sorted_values = sorted(values)
   num1 = (len(values) - 1) / 2
   num2 = len(values) / 2
-  return float(sorted_values[num1] + sorted_values[num2])/2
+  return float(sorted_values[num1] + sorted_values[num2]) / 2
 
 
 def display_results(results_average, results_median):
diff --git a/tests/helpers_tests/test_event_tag_utils.py b/tests/helpers_tests/test_event_tag_utils.py
@@ -17,6 +17,7 @@
 
 from optimizely.helpers import event_tag_utils
 
+
 class EventTagUtilsTest(unittest.TestCase):
 
   def test_get_revenue_value__invalid_args(self):
diff --git a/tests/test_config.py b/tests/test_config.py
@@ -453,7 +453,6 @@ def test_get_group__valid_id(self):
                                     self.config_dict['groups'][0]['trafficAllocation']),
                      self.project_config.get_group('19228'))
 
-
   def test_get_group__invalid_id(self):
     """ Test that None is returned when provided group ID is invalid. """
 
diff --git a/tests/test_decision_service.py b/tests/test_decision_service.py
@@ -305,3 +305,4 @@ def test_get_variation__user_profile_save_fails(self):
     mock_bucket.assert_called_once_with(experiment, 'test_user')
     mock_save.assert_called_once_with({'user_id': 'test_user',
                                        'experiment_bucket_map': {'111127': {'variation_id': '111129'}}})
+
diff --git a/tox.ini b/tox.ini
@@ -0,0 +1,17 @@
+[pep8]
+# E111 - indentation is not a multiple of four
+# E114 - indentation is not a multiple of four (comment)
+# E121 - continuation line indentation is not a multiple of four
+# E122 - continuation line missing indentation or outdented
+# E124 - closing bracket does not match visual indentation
+# E125 - continuation line does not distinguish itself from next logical line
+# E126 - continuation line over-indented for hanging indent
+# E127 - continuation line over-indented for visual indent
+# E128 - continuation line under-indented for visual indent
+# E129 - visually indented line with same indent as next logical line
+# E131 - continuation line unaligned for hanging indent
+# E265 - block comment should start with '# '
+# E502 - the backslash is redundant between brackets
+ignore = E111,E114,E121,E122,E123,E124,E125,E126,E127,E128,E129,E131,E265,E502
+exclude = optimizely/lib/pymmh3.py,*virtualenv*
+max-line-length = 120
