Update Formatting issues for lint

optimizely/optimizely_config.py

@@ -70,22 +70,6 @@ def get_events(self):
  """
  return self.events
 
- def get_attributes(self):
- """ Get the attributes associated with OptimizelyConfig
-
- returns:
- A list of attributes.
- """
- return self.attributes
-
- def get_events(self):
- """ Get the events associated with OptimizelyConfig
-
- returns:
- A list of events.
- """
- return self.events
-
  def get_audiences(self):
  """ Get the audiences associated with OptimizelyConfig
 
@@ -182,7 +166,8 @@ def __init__(self, project_config):
 
  for old_audience in project_config.audiences:
  # check if old_audience.id exists in new_audiences.id from typed_audiences
- if len([new_audience for new_audience in typed_audiences if new_audience.get('id') == old_audience.get('id')]) == 0:
+ if len([new_audience for new_audience in typed_audiences
+ if new_audience.get('id') == old_audience.get('id')]) == 0:
  if old_audience.get('id') == "$opt_dummy_audience":
  continue
  else:
@@ -195,7 +180,7 @@ def __init__(self, project_config):
  for audience in self.audiences:
  audiences_map[audience.get('id')] = audience.get('name')
 
- # Updating each entities.Experiment found in the experiment_key_map
+ # Updating each OptimizelyExperiment based on the ID from entities.Experiment found in the experiment_key_map
  for ent_exp in project_config.experiment_key_map.values():
  experiments_by_key, experiments_by_id = self._get_experiments_maps()
  try:
@@ -206,18 +191,39 @@ def __init__(self, project_config):
  continue
 
  def update_experiment(self, experiment, conditions, audiences_map):
+ '''
+ Gets an OptimizelyExperiment to update, conditions from
+ the corresponding entities.Experiment and an audiences_map
+ in the form of [id:name]
 
+ Updates the OptimizelyExperiment.audiences with a string
+ of conditions and audience names.
+ '''
  audiences = self.replace_ids_with_names(conditions, audiences_map)
  experiment.audiences = audiences
 
  def replace_ids_with_names(self, conditions, audiences_map):
- # Confirm where conditions are coming from...
- if conditions != None:
+ '''
+ Gets conditions and audiences_map [id:name]
+
+ Returns:
+ a string of conditions with id's swapped with names
+ or None if no conditions found.
+
+ '''
+ if conditions is not None:
  return self.stringify_conditions(conditions, audiences_map)
  else:
  return None
 
  def lookup_name_from_id(self, audience_id, audiences_map):
+ '''
+ Gets and audience ID and audiences map
+
+ Returns:
+ The name corresponding to the ID
+ or None if not found
+ '''
  name = ""
  try:
  name = audiences_map[audience_id]
@@ -227,6 +233,14 @@ def lookup_name_from_id(self, audience_id, audiences_map):
  return name
 
  def stringify_conditions(self, conditions, audiences_map):
+ '''
+ Gets a list of conditions from an entities.Experiment
+ and an audiences_map [id:name]
+
+ Returns:
+ A string of conditions and names for the provided
+ list of conditions.
+ '''
  ARGS = ConditionOperatorTypes.operators
  condition = ""
  ret = "("
@@ -248,15 +262,16 @@ def stringify_conditions(self, conditions, audiences_map):
  condition = conditions[i]
  else:
  if type(conditions[i]) == list:
+ # If the next item is a list, recursively call function on list
  if i + 1 < length:
  ret += self.stringify_conditions(conditions[i],
  audiences_map) + ' ' + condition.upper() + ' '
  else:
  ret += self.stringify_conditions(conditions[i], audiences_map)
  else:
- # Handle ID's here - Lookup required
+ # Handle ID's here - Lookup name based on ID
  audience_name = self.lookup_name_from_id(conditions[i], audiences_map)
- if audience_name != None:
+ if audience_name is not None:
  if i + 1 < length:
  ret += '"' + audience_name + '" ' + condition.upper() + ' '
  else:

tests/test_optimizely_config.py

@@ -30,7 +30,26 @@ def setUp(self):
  'environment_key': None,
  'attributes': [{'key': 'test_attribute', 'id': '111094'}],
  'events': [{'key': 'test_event', 'experimentIds': ['111127'], 'id': '111095'}],
- 'audiences': [{'name': 'Test attribute users 1', 'conditions': '["and", ["or", ["or", {"name": "test_attribute", "type": "custom_attribute", "value": "test_value_1"}]]]', 'id': '11154'}, {'name': 'Test attribute users 2', 'conditions': '["and", ["or", ["or", {"name": "test_attribute", "type": "custom_attribute", "value": "test_value_2"}]]]', 'id': '11159'}, {'name': 'Test attribute users 3', 'conditions': '["and", ["or", ["or", {"match": "exact", "name": "experiment_attr", "type": "custom_attribute", "value": "group_experiment"}]]]', 'id': '11160'}],
+ 'audiences': [
+ {
+ 'name': 'Test attribute users 1',
+ 'conditions': '["and", ["or", ["or", '
+ '{"name": "test_attribute", "type": "custom_attribute", "value": "test_value_1"}]]]',
+ 'id': '11154'
+ },
+ {
+ 'name': 'Test attribute users 2',
+ 'conditions': '["and", ["or", ["or", '
+ '{"name": "test_attribute", "type": "custom_attribute", "value": "test_value_2"}]]]',
+ 'id': '11159'
+ },
+ {
+ 'name': 'Test attribute users 3',
+ 'conditions': "[\"and\", [\"or\", [\"or\", {\"match\": \"exact\", \"name\": \
+ \"experiment_attr\", \"type\": \"custom_attribute\", \"value\": \"group_experiment\"}]]]",
+ 'id': '11160',
+ }
+ ],
  'experiments_map': {
  'test_experiment2': {
  'variations_map': {
@@ -899,7 +918,17 @@ def test_get_audiences(self):
  'name': 'Test_Audience',
  'id': '1234',
  'conditions': [
- '["and", ["or", ["or", {"name": "test_attribute", "type": "custom_attribute", "value": "test_value_1"}]]]'
+ ["and",
+ ["or",
+ ["or",
+ {
+ "name": "test_attribute",
+ "type": "custom_attribute",
+ "value": "test_value_1"
+ }
+ ]
+ ]
+ ]
  ]
  }
  ]
@@ -909,30 +938,41 @@ def test_get_audiences(self):
  'name': 'Test_Audience',
  'id': '1234',
  'conditions': [
- '["and", ["or", ["or", {"name": "test_attribute", "type": "custom_attribute", "value": "test_value_1"}]]]'
+ ["and",
+ ["or",
+ ["or",
+ {
+ "name": "test_attribute",
+ "type": "custom_attribute",
+ "value": "test_value_1"
+ }
+ ]
+ ]
+ ]
  ]
  }
  ]
 
  self.assertEqual(expected_value, config.get_audiences())
 
  def test_stringify_conditions(self):
- ''' 
+ '''
  Test to confirm converting from audienceConditions list to String represented conditions
- Note* this also test lookup_name_from_id in OptimizelyConfig 
+ Note* this also test lookup_name_from_id in OptimizelyConfig
  '''
 
  experiment = {'audienceConditions': ['and', ['or', '3468206642', '3988293898'], [
- 'or', '3988293899', '3468206646', '3468206647', '3468206644', '3468206643']], 'audienceIds': ['0'], 'forcedVariations': {}, 'id': '1323241598'}
+ 'or', '3988293899', '3468206646', '3468206647', '3468206644', '3468206643']],
+ 'audienceIds': ['0'], 'forcedVariations': {}, 'id': '1323241598'}
 
  audience_conditions = experiment.get('audienceConditions')
 
  audiences_map = {
- '3468206642': 'US',
- '3988293898': 'FEMALE',
- '3988293899': 'MALE',
- '3468206646': 'THEM',
- '3468206647': 'ANYONE'
+ '3468206642': 'us',
+ '3988293898': 'female',
+ '3988293899': 'male',
+ '3468206646': 'them',
+ '3468206647': 'anyone'
  }
 
  config = optimizely_config.OptimizelyConfig(
@@ -949,7 +989,7 @@ def test_stringify_conditions(self):
 
  result = config_service.stringify_conditions(audience_conditions, audiences_map)
 
- expected_result = '(("US" OR "FEMALE") AND ("MALE" OR "THEM" OR "ANYONE" OR "3468206644" OR "3468206643"))'
+ expected_result = '(("us" OR "female") AND ("male" OR "them" OR "anyone" OR "3468206644" OR "3468206643"))'
 
  self.assertEqual(result, expected_result)