Enforcing styling through Travis and pep8 (#59)

aliabbasrizvi · web-flow · commit b637f4db132b · 2017-06-13T16:41:22.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/decision_service.py b/optimizely/decision_service.py
@@ -151,7 +151,8 @@ def get_variation(self, experiment, user_id, attributes, ignore_user_profile=Fal
     return None
 
   def get_variation_for_layer(self, layer, user_id, attributes=None, ignore_user_profile=False):
-    """ Determine which variation the user is in for a given layer. Returns the variation of the first experiment the user qualifies for.
+    """ Determine which variation the user is in for a given layer.
+    Returns the variation of the first experiment the user qualifies for.
 
     Args:
       layer: Layer for which we are getting the variation.
@@ -169,7 +170,8 @@ def get_variation_for_layer(self, layer, user_id, attributes=None, ignore_user_p
         experiment = self.config.get_experiment_from_key(experiment_dict['key'])
         variation = self.get_variation(experiment, user_id, attributes, ignore_user_profile)
         if variation:
-          self.logger.log(enums.LogLevels.DEBUG, 'User "%s" is in variation %s of experiment %s.' % (user_id, variation.key, experiment.key))
+          self.logger.log(enums.LogLevels.DEBUG,
+                          'User "%s" is in variation %s of experiment %s.' % (user_id, variation.key, experiment.key))
           # Return as soon as we get a variation
           return variation
 
@@ -197,7 +199,8 @@ def get_variation_for_feature(self, feature, user_id, attributes=None):
           variation = self.get_variation(experiment, user_id, attributes)
 
           if variation:
-            self.logger.log(enums.LogLevels.DEBUG, 'User "%s" is in variation %s of experiment %s.' % (user_id, variation.key, experiment.key))
+            self.logger.log(enums.LogLevels.DEBUG,
+                            'User "%s" is in variation %s of experiment %s.' % (user_id, variation.key, experiment.key))
       else:
         self.logger.log(enums.LogLevels.ERROR, enums.Errors.INVALID_GROUP_ID_ERROR.format('_get_variation_for_feature'))
 
@@ -209,7 +212,8 @@ def get_variation_for_feature(self, feature, user_id, attributes=None):
         variation = self.get_variation(experiment, user_id, attributes)
 
         if variation:
-          self.logger.log(enums.LogLevels.DEBUG, 'User "%s" is in variation %s of experiment %s.' % (user_id, variation.key, experiment.key))
+          self.logger.log(enums.LogLevels.DEBUG,
+                          'User "%s" is in variation %s of experiment %s.' % (user_id, variation.key, experiment.key))
 
     # Next check if user is part of a rollout
     if not variation and feature.layerId:
@@ -243,4 +247,3 @@ def get_experiment_in_group(self, group, user_id):
                     (user_id, group.id))
 
     return None
-
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):
@@ -68,6 +69,7 @@ def __init__(self, id, key, experimentIds, layerId, variables, groupId=None, **k
     self.variables = variables
     self.groupId = groupId
 
+
 class Group(BaseEntity):
 
   def __init__(self, id, policy, experiments, trafficAllocation, **kwargs):
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
@@ -191,7 +191,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/project_config.py b/optimizely/project_config.py
@@ -90,7 +90,9 @@ def __init__(self, datafile, logger, error_handler):
       for variation in self.variation_key_map.get(experiment.key).values():
         self.variation_id_map[experiment.key][variation.id] = variation
         if variation.variables:
-          self.variation_variable_usage_map[variation.id] = self._generate_key_map(variation.variables, 'id', entities.Variation.VariableUsage)
+          self.variation_variable_usage_map[variation.id] = self._generate_key_map(
+            variation.variables, 'id', entities.Variation.VariableUsage
+          )
 
     self.feature_key_map = self._generate_key_map(self.features, 'key', entities.Feature)
     for feature in self.feature_key_map.values():
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
@@ -15,6 +15,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
@@ -872,7 +872,8 @@ def test_init__with_v4_datafile(self):
         'group_exp_2_variation': entities.Variation('28906', 'group_exp_2_variation')
       },
       'test_rollout_exp_1': {
-        'test_rollout_exp_1_default': entities.Variation('211113', 'test_rollout_exp_1_default', [{'id': '131', 'value': '15'}])
+        'test_rollout_exp_1_default': entities.Variation('211113', 'test_rollout_exp_1_default',
+                                                         [{'id': '131', 'value': '15'}])
       }
     }
     expected_variation_id_map = {
@@ -954,7 +955,8 @@ def test_init__with_v4_datafile(self):
       }
     }
     self.maxDiff = None
-    self.assertEqual(expected_variation_variable_usage_map['28901'], project_config.variation_variable_usage_map['28901'])
+    self.assertEqual(expected_variation_variable_usage_map['28901'],
+                     project_config.variation_variable_usage_map['28901'])
     self.assertEqual(expected_group_id_map, project_config.group_id_map)
     self.assertEqual(expected_experiment_key_map, project_config.experiment_key_map)
     self.assertEqual(expected_experiment_id_map, project_config.experiment_id_map)
@@ -1115,7 +1117,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
@@ -340,14 +340,15 @@ def test_get_variation_for_feature__returns_variation_for_feature_in_experiment(
     with mock.patch(
       'optimizely.decision_service.DecisionService.get_variation',
       return_value=expected_variation) as mock_decision:
-      self.assertEqual(expected_variation,  decision_service.get_variation_for_feature(feature, 'user1'))
+      self.assertEqual(expected_variation, decision_service.get_variation_for_feature(feature, 'user1'))
 
     mock_decision.assert_called_once_with(
       project_config.get_experiment_from_key('test_experiment'), 'user1', None
     )
 
   def test_get_variation_for_feature__returns_variation_for_feature_in_rollout(self):
-    """ Test that get_variation_for_feature returns the variation of the experiment in the rollout that the user is bucketed into. """
+    """ Test that get_variation_for_feature returns the variation of
+    the experiment in the rollout that the user is bucketed into. """
     optimizely_instance = optimizely.Optimizely(json.dumps(self.config_dict_with_features))
     project_config = optimizely_instance.config
     decision_service = optimizely_instance.decision_service
@@ -364,7 +365,9 @@ def test_get_variation_for_feature__returns_variation_for_feature_in_rollout(sel
     )
 
   def test_get_variation_for_feature__returns_variation_if_user_not_in_experiment_but_in_rollout(self):
-    """ Test that get_variation_for_feature returns the variation of the experiment in the feature's rollout even if the user is not bucketed into the feature's experiment. """
+    """ Test that get_variation_for_feature returns the variation of the
+    experiment in the feature's rollout even if the user is not
+    bucketed into the feature's experiment. """
     optimizely_instance = optimizely.Optimizely(json.dumps(self.config_dict_with_features))
     project_config = optimizely_instance.config
     decision_service = optimizely_instance.decision_service
@@ -381,7 +384,8 @@ def test_get_variation_for_feature__returns_variation_if_user_not_in_experiment_
     mock_decision.assert_any_call(project_config.get_experiment_from_key('test_rollout_exp_1'), 'user1', None, True)
 
   def test_get_variation_for_feature__returns_variation_for_feature_in_group(self):
-    """ Test that get_variation_for_feature returns the variation of the experiment the user is bucketed in the feature's group. """
+    """ Test that get_variation_for_feature returns the variation of
+     the experiment the user is bucketed in the feature's group. """
     optimizely_instance = optimizely.Optimizely(json.dumps(self.config_dict_with_features))
     project_config = optimizely_instance.config
     decision_service = optimizely_instance.decision_service
@@ -395,16 +399,13 @@ def test_get_variation_for_feature__returns_variation_for_feature_in_group(self)
         return_value=expected_variation) as mock_decision:
       self.assertEqual(expected_variation, decision_service.get_variation_for_feature(feature, 'user1'))
 
-    mock_get_experiment_in_group.assert_called_once_with(
-      project_config.get_group('19228'), 'user1'
-    )
+    mock_get_experiment_in_group.assert_called_once_with(project_config.get_group('19228'), 'user1')
 
-    mock_decision.assert_called_once_with(
-      project_config.get_experiment_from_key('group_exp_1'), 'user1', None
-    )
+    mock_decision.assert_called_once_with(project_config.get_experiment_from_key('group_exp_1'), 'user1', None)
 
   def test_get_variation_for_feature__returns_none_for_user_not_in_group(self):
-    """ Test that get_variation_for_feature returns none for user not in group and the feature is not part of a rollout. """
+    """ Test that get_variation_for_feature returns None for
+    user not in group and the feature is not part of a rollout. """
     optimizely_instance = optimizely.Optimizely(json.dumps(self.config_dict_with_features))
     project_config = optimizely_instance.config
     decision_service = optimizely_instance.decision_service
@@ -423,7 +424,7 @@ def test_get_variation_for_feature__returns_none_for_user_not_in_group(self):
     self.assertFalse(mock_decision.called)
 
   def test_get_variation_for_feature__returns_none_for_user_not_in_experiment(self):
-    """ Test that get_variation_for_feature returns none for user not in the associated experiment. """
+    """ Test that get_variation_for_feature returns None for user not in the associated experiment. """
     optimizely_instance = optimizely.Optimizely(json.dumps(self.config_dict_with_features))
     project_config = optimizely_instance.config
     decision_service = optimizely_instance.decision_service
@@ -439,7 +440,7 @@ def test_get_variation_for_feature__returns_none_for_user_not_in_experiment(self
     )
 
   def test_get_variation_for_feature__returns_none_for_user_not_in_rollout(self):
-    """ Test that get_variation_for_feature returns none for the user not in the associated rollout. """
+    """ Test that get_variation_for_feature returns None for the user not in the associated rollout. """
     optimizely_instance = optimizely.Optimizely(json.dumps(self.config_dict_with_features))
     project_config = optimizely_instance.config
     decision_service = optimizely_instance.decision_service
@@ -455,7 +456,8 @@ def test_get_variation_for_feature__returns_none_for_user_not_in_rollout(self):
     )
 
   def test_get_variation_for_feature__returns_none_for_user_in_group_but_experiment_not_associated_with_feature(self):
-    """ Test that if a user is in the mutex group but the experiment is not targeting a feature, the feature should not be enabled. """
+    """ Test that if a user is in the mutex group but the experiment
+    is not targeting a feature, the feature should not be enabled. """
     optimizely_instance = optimizely.Optimizely(json.dumps(self.config_dict_with_features))
     project_config = optimizely_instance.config
     decision_service = optimizely_instance.decision_service
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
