Merge pull request #700 from Axelrod-Python/names_and_PEP8

Strategy names and PEP8

Author: marcharper

axelrod/player.py

@@ -20,12 +20,19 @@ def is_basic(s):
     inspects_source = s.classifier['inspects_source']
     manipulates_source = s.classifier['manipulates_source']
     manipulates_state = s.classifier['manipulates_state']
-    return (not stochastic) and (not inspects_source) and (not manipulates_source) and (not manipulates_state) and (depth in (0, 1))
+    return (
+        not stochastic and
+        not inspects_source and
+        not manipulates_source and
+        not manipulates_state and
+        depth in (0, 1)
+    )
 
 
 def obey_axelrod(s):
     """
-    A function to check if a strategy obeys Axelrod's original tournament rules.
+    A function to check if a strategy obeys Axelrod's original tournament
+    rules.
     """
     classifier = s.classifier
     return not (

axelrod/strategies/cycler.py

@@ -2,6 +2,7 @@
 
 import copy
 
+
 class AntiCycler(Player):
     """
     A player that follows a sequence of plays that contains no cycles:
@@ -67,7 +68,7 @@ def __init__(self, cycle="CCD"):
         """
         Player.__init__(self)
         self.cycle = cycle
-        self.name += " " + cycle
+        self.name = "Cycler {}".format(cycle)
         self.classifier['memory_depth'] = len(cycle) - 1
 
     def strategy(self, opponent):
@@ -77,6 +78,8 @@ def strategy(self, opponent):
 
 
 class CyclerDC(Cycler):
+
+    name = 'Cycler DC'
     classifier = copy.copy(Cycler.classifier)
     classifier['memory_depth'] = 1
 
@@ -86,6 +89,8 @@ def __init__(self, cycle="DC"):
 
 
 class CyclerCCD(Cycler):
+
+    name = 'Cycler CCD'
     classifier = copy.copy(Cycler.classifier)
     classifier['memory_depth'] = 2
 
@@ -95,6 +100,8 @@ def __init__(self, cycle="CCD"):
 
 
 class CyclerDDC(Cycler):
+
+    name = 'Cycler DDC'
     classifier = copy.copy(Cycler.classifier)
     classifier['memory_depth'] = 2
 
@@ -104,6 +111,8 @@ def __init__(self, cycle="DDC"):
 
 
 class CyclerCCCD(Cycler):
+
+    name = 'Cycler CCCD'
     classifier = copy.copy(Cycler.classifier)
     classifier['memory_depth'] = 3
 
@@ -113,6 +122,8 @@ def __init__(self, cycle="CCCD"):
 
 
 class CyclerCCCCCD(Cycler):
+
+    name = 'Cycler CCCCCD'
     classifier = copy.copy(Cycler.classifier)
     classifier['memory_depth'] = 5
 

axelrod/strategies/gobymajority.py

@@ -18,6 +18,7 @@ class GoByMajority(Player):
     default this is 0)
     """
 
+    name = 'Go By Marjority'
     classifier = {
         'stochastic': False,
         'inspects_source': False,
@@ -49,7 +50,8 @@ def __init__(self, memory_depth=float('inf'), soft=True):
         else:
             self.memory = 0
 
-        self.name = 'Go By Majority' + (self.memory > 0) * (": %i" % self.memory)
+        self.name = (
+            'Go By Majority' + (self.memory > 0) * (": %i" % self.memory))
         if self.soft:
             self.name = "Soft " + self.name
         else:
@@ -80,6 +82,7 @@ class GoByMajority40(GoByMajority):
     """
     GoByMajority player with a memory of 40.
     """
+    name = 'Go By Majority 40'
     classifier = copy.copy(GoByMajority.classifier)
     classifier['memory_depth'] = 40
 
@@ -93,6 +96,7 @@ class GoByMajority20(GoByMajority):
     """
     GoByMajority player with a memory of 20.
     """
+    name = 'Go By Majority 20'
     classifier = copy.copy(GoByMajority.classifier)
     classifier['memory_depth'] = 20
 
@@ -106,6 +110,7 @@ class GoByMajority10(GoByMajority):
     """
     GoByMajority player with a memory of 10.
     """
+    name = 'Go By Majority 10'
     classifier = copy.copy(GoByMajority.classifier)
     classifier['memory_depth'] = 10
 
@@ -119,6 +124,7 @@ class GoByMajority5(GoByMajority):
     """
     GoByMajority player with a memory of 5.
     """
+    name = 'Go By Majority 5'
     classifier = copy.copy(GoByMajority.classifier)
     classifier['memory_depth'] = 5
 
@@ -136,6 +142,7 @@ class HardGoByMajority(GoByMajority):
     An optional memory attribute will limit the number of turns remembered (by
     default this is 0)
     """
+    name = 'Hard Go By Majority'
 
     @init_args
     def __init__(self, memory_depth=float('inf'), soft=False):
@@ -147,6 +154,7 @@ class HardGoByMajority40(HardGoByMajority):
     """
     HardGoByMajority player with a memory of 40.
     """
+    name = 'Hard Go By Majority 40'
     classifier = copy.copy(GoByMajority.classifier)
     classifier['memory_depth'] = 40
 
@@ -160,6 +168,7 @@ class HardGoByMajority20(HardGoByMajority):
     """
     HardGoByMajority player with a memory of 20.
     """
+    name = 'Hard Go By Majority 20'
     classifier = copy.copy(GoByMajority.classifier)
     classifier['memory_depth'] = 20
 
@@ -173,6 +182,7 @@ class HardGoByMajority10(HardGoByMajority):
     """
     HardGoByMajority player with a memory of 10.
     """
+    name = 'Hard Go By Majority 10'
     classifier = copy.copy(GoByMajority.classifier)
     classifier['memory_depth'] = 10
 
@@ -186,6 +196,7 @@ class HardGoByMajority5(HardGoByMajority):
     """
     HardGoByMajority player with a memory of 5.
     """
+    name = 'Hard Go By Majority 5'
     classifier = copy.copy(GoByMajority.classifier)
     classifier['memory_depth'] = 5
 

axelrod/strategies/retaliate.py

@@ -10,6 +10,8 @@ class Retaliate(Player):
     A player starts by cooperating but will retaliate once the opponent
     has won more than 10 percent times the number of defections the player has.
     """
+
+    name = 'Retaliate'
     classifier = {
         'memory_depth': float('inf'),  # Long memory
         'stochastic': False,
@@ -52,11 +54,14 @@ def reset(self):
         Player.reset(self)
         self.play_counts = defaultdict(int)
 
+
 class Retaliate2(Retaliate):
     """
     Retaliate player with a threshold of 8 percent.
     """
 
+    name = 'Retaliate 2'
+
     def __init__(self, retaliation_threshold=0.08):
         super(Retaliate2, self).__init__(
             retaliation_threshold=retaliation_threshold)
@@ -67,6 +72,8 @@ class Retaliate3(Retaliate):
     Retaliate player with a threshold of 5 percent.
     """
 
+    name = 'Retaliate 3'
+
     def __init__(self, retaliation_threshold=0.05):
         super(Retaliate3, self).__init__(
             retaliation_threshold=retaliation_threshold)
@@ -80,6 +87,7 @@ class LimitedRetaliate(Player):
     retaliation limit (20 defections).
     """
 
+    name = 'Limited Retaliate'
     classifier = {
         'memory_depth': float('inf'),  # Long memory
         'stochastic': False,
@@ -156,6 +164,8 @@ class LimitedRetaliate2(LimitedRetaliate):
     retaliation limit of 15.
     """
 
+    name = 'Limited Retaliate 2'
+
     def __init__(self, retaliation_threshold=0.08, retaliation_limit=15):
         super(LimitedRetaliate2, self).__init__(
             retaliation_threshold=retaliation_threshold,
@@ -168,6 +178,8 @@ class LimitedRetaliate3(LimitedRetaliate):
     retaliation limit of 20.
     """
 
+    name = 'Limited Retaliate 3'
+
     def __init__(self, retaliation_threshold=0.05, retaliation_limit=20):
         super(LimitedRetaliate3, self).__init__(
             retaliation_threshold=retaliation_threshold,

axelrod/tests/integration/test_names.py

@@ -0,0 +1,13 @@
+import unittest
+from axelrod import all_strategies
+
+
+class TestNames(unittest.TestCase):
+
+    def test_all_strategies_have_names(self):
+        names = [s.name for s in all_strategies if s.name]
+        self.assertEqual(len(names), len(all_strategies))
+
+    def test_all_names_are_unique(self):
+        names = set(s.name for s in all_strategies)
+        self.assertEqual(len(names), len(all_strategies))

axelrod/tests/unit/test_classification.py

@@ -17,7 +17,8 @@ def test_known_classifiers(self):
 
         for s in axelrod.all_strategies:
             s = s()
-            self.assertTrue(None not in [s.classifier[key] for key in known_keys])
+            self.assertTrue(
+                None not in [s.classifier[key] for key in known_keys])
 
     def test_multiple_instances(self):
         """Certain instances of classes of strategies will have different
@@ -184,7 +185,8 @@ def test_meta_inclusion(self):
         self.assertTrue(axelrod.MetaMajority in axelrod.strategies)
 
         self.assertTrue(axelrod.MetaHunter in axelrod.strategies)
-        self.assertFalse(axelrod.MetaHunter in axelrod.long_run_time_strategies)
+        self.assertFalse(
+            axelrod.MetaHunter in axelrod.long_run_time_strategies)
 
     def test_demo_strategies(self):
         demo_strategies = [axelrod.Cooperator,

axelrod/tests/unit/test_player.py

@@ -1,10 +1,11 @@
+# -*- coding: utf-8 -*-
 import copy
 import inspect
 import random
 import unittest
 
 import axelrod
-from axelrod import DefaultGame, Game, Player, simulate_play
+from axelrod import DefaultGame, Player, simulate_play
 
 
 C, D = axelrod.Actions.C, axelrod.Actions.D
@@ -13,6 +14,7 @@
 def cooperate(self):
     return C
 
+
 def defect(self):
     return D
 
@@ -71,7 +73,9 @@ def test_noisy_play(self):
         self.assertEqual(p2.history[0], D)
 
     def test_strategy(self):
-        self.assertRaises(NotImplementedError, self.player().strategy, self.player())
+        self.assertRaises(
+            NotImplementedError, self.player().strategy, self.player())
+
 
 def test_responses(test_class, P1, P2, history_1, history_2, responses,
                    random_seed=None, attrs=None):
@@ -128,8 +132,9 @@ def test_initialisation(self):
         if self.__class__ != TestPlayer:
             player = self.player()
             self.assertEqual(player.history, [])
-            self.assertEqual(player.match_attributes,
-                    {'length': -1, 'game': DefaultGame, 'noise': 0})
+            self.assertEqual(
+                player.match_attributes,
+                {'length': -1, 'game': DefaultGame, 'noise': 0})
             self.assertEqual(player.cooperations, 0)
             self.assertEqual(player.defections, 0)
             self.classifier_test(self.expected_class_classifier)
@@ -242,7 +247,6 @@ def responses_test(self, history_1, history_2, responses, random_seed=None,
             self, P1, P2, history_1, history_2, responses,
             random_seed=random_seed, attrs=attrs)
 
-
     def classifier_test(self, expected_class_classifier=None):
         """Test that the keys in the expected_classifier dictionary give the
         expected values in the player classifier dictionary. Also checks that
@@ -261,10 +265,11 @@ def classifier_test(self, expected_class_classifier=None):
         self.assertTrue('stochastic' in player.classifier,
                         msg="stochastic not in classifier")
         for key in TestOpponent.classifier:
-            self.assertEqual(player.classifier[key],
-                             self.expected_classifier[key],
-                             msg="%s - Behaviour: %s != Expected Behaviour: %s" %
-                             (key, player.classifier[key], self.expected_classifier[key]))
+            self.assertEqual(
+                player.classifier[key],
+                self.expected_classifier[key],
+                msg="%s - Behaviour: %s != Expected Behaviour: %s" %
+                (key, player.classifier[key], self.expected_classifier[key]))
 
 
 class TestHeadsUp(unittest.TestCase):