Update axl_filename to use pathlib and take multiple arguments

Author: gaffney2010

axelrod/load_data_.py

@@ -1,17 +1,28 @@
+import pathlib
 from typing import Dict, List, Text, Tuple
 
-import os
 import pkg_resources
 
 
-def axl_filename(axl_path: Text) -> Text:
-    """Get the path to Axelrod/<axl_path> from the working directory."""
-    # Working directory
-    dirname = os.path.dirname(__file__)
+def axl_filename(*axl_path: Text) -> Text:
+    """Given a path under Axelrod/, return absolute filepath.
 
-    # We go up a dir because this code is located in Axelrod/axelrod and
-    # axl_path is from the top-level Axelrod dir.
-    return os.path.join(dirname, "..", axl_path)
+    Parameters
+    ----------
+    axl_path
+        Path to file located under top-level Axelrod directory, with file names
+        separated at "/".  For example, to get the path to "Axelrod/xxx/yyy.py"
+        call this function with axl_filename("xxx", "yyy.py").
+
+    Returns
+    -------
+        Absolute path to the given path.
+    """
+    # We go up a dir because this code is located in Axelrod/axelrod.
+    path = pathlib.Path(__file__).resolve().parent.parent
+    for p in axl_path:
+        path = path / p
+    return str(path)
 
 
 def load_file(filename: str, directory: str) -> List[List[str]]:

axelrod/tests/integration/test_tournament.py

@@ -33,20 +33,22 @@ def setUpClass(cls):
         ]
         cls.expected_outcome.sort()
 
-    @given(tournaments(
-        strategies=axelrod.short_run_time_strategies,
-        min_size=10,
-        max_size=30,
-        min_turns=2,
-        max_turns=210,
-        min_repetitions=1,
-        max_repetitions=4,
-    ))
+    @given(
+        tournaments(
+            strategies=axelrod.short_run_time_strategies,
+            min_size=10,
+            max_size=30,
+            min_turns=2,
+            max_turns=210,
+            min_repetitions=1,
+            max_repetitions=4,
+        )
+    )
     @settings(max_examples=1)
     def test_big_tournaments(self, tournament):
         """A test to check that tournament runs with a sample of non-cheating
         strategies."""
-        filename = axl_filename("test_outputs/test_tournament.csv")
+        filename = axl_filename("test_outputs", "test_tournament.csv")
         self.assertIsNone(
             tournament.play(progress_bar=False, filename=filename, build_results=False)
         )
@@ -91,7 +93,9 @@ def test_repeat_tournament_deterministic(self):
                 turns=2,
                 repetitions=2,
             )
-            files.append(axl_filename("test_outputs/stochastic_tournament_{}.csv".format(_)))
+            files.append(
+                axl_filename("test_outputs", "stochastic_tournament_{}.csv".format(_))
+            )
             tournament.play(progress_bar=False, filename=files[-1], build_results=False)
         self.assertTrue(filecmp.cmp(files[0], files[1]))
 
@@ -114,7 +118,9 @@ def test_repeat_tournament_stochastic(self):
                 turns=2,
                 repetitions=2,
             )
-            files.append(axl_filename("test_outputs/stochastic_tournament_{}.csv".format(_)))
+            files.append(
+                axl_filename("test_outputs", "stochastic_tournament_{}.csv".format(_))
+            )
             tournament.play(progress_bar=False, filename=files[-1], build_results=False)
         self.assertTrue(filecmp.cmp(files[0], files[1]))
 

axelrod/tests/unit/test_deterministic_cache.py

@@ -13,8 +13,8 @@ class TestDeterministicCache(unittest.TestCase):
     def setUpClass(cls):
         cls.test_key = (TitForTat(), Defector())
         cls.test_value = [(C, D), (D, D), (D, D)]
-        cls.test_save_file = axl_filename("test_outputs/test_cache_save.txt")
-        cls.test_load_file = axl_filename("test_outputs/test_cache_load.txt")
+        cls.test_save_file = axl_filename("test_outputs", "test_cache_save.txt")
+        cls.test_load_file = axl_filename("test_outputs", "test_cache_load.txt")
         test_data_to_pickle = {("Tit For Tat", "Defector"): [(C, D), (D, D), (D, D)]}
         cls.test_pickle = pickle.dumps(test_data_to_pickle)
 
@@ -93,7 +93,7 @@ def test_load(self):
         self.assertEqual(self.cache[self.test_key], self.test_value)
 
     def test_load_error_for_inccorect_format(self):
-        filename = axl_filename("test_outputs/test.cache")
+        filename = axl_filename("test_outputs", "test.cache")
         with open(filename, "wb") as io:
             pickle.dump(range(5), io)
 

axelrod/tests/unit/test_fingerprint.py

@@ -212,7 +212,7 @@ def test_temp_file_creation(self):
         self.assertFalse(os.path.isfile(filename))
 
     def test_fingerprint_with_filename(self):
-        filename = axl_filename("test_outputs/test_fingerprint.csv")
+        filename = axl_filename("test_outputs", "test_fingerprint.csv")
         af = AshlockFingerprint(axl.TitForTat)
         af.fingerprint(
             turns=1, repetitions=1, step=0.5, progress_bar=False, filename=filename
@@ -426,7 +426,7 @@ def test_init_with_not_default_number(self):
         )
 
     def test_fingerprint_with_filename(self):
-        filename = axl_filename("test_outputs/test_fingerprint.csv")
+        filename = axl_filename("test_outputs", "test_fingerprint.csv")
         strategy = axl.TitForTat()
         tf = TransitiveFingerprint(strategy)
         tf.fingerprint(turns=1, repetitions=1, progress_bar=False, filename=filename)
@@ -440,7 +440,7 @@ def test_serial_fingerprint(self):
         tf.fingerprint(
             repetitions=1,
             progress_bar=False,
-            filename=axl_filename("test_outputs/tran_fin.csv"),
+            filename=axl_filename("test_outputs", "tran_fin.csv"),
         )
         self.assertEqual(tf.data.shape, (50, 50))
 
@@ -453,7 +453,7 @@ def test_parallel_fingerprint(self):
 
     def test_analyse_cooperation_ratio(self):
         tf = TransitiveFingerprint(axl.TitForTat)
-        filename = axl_filename("test_outputs/test_fingerprint.csv")
+        filename = axl_filename("test_outputs", "test_fingerprint.csv")
         with open(filename, "w") as f:
             f.write(
                 """Interaction index,Player index,Opponent index,Repetition,Player name,Opponent name,Actions

axelrod/tests/unit/test_plot.py

@@ -11,7 +11,7 @@
 class TestPlot(unittest.TestCase):
     @classmethod
     def setUpClass(cls):
-        cls.filename = axl_filename("test_outputs/test_results.csv")
+        cls.filename = axl_filename("test_outputs", "test_results.csv")
 
         cls.players = [axelrod.Alternator(), axelrod.TitForTat(), axelrod.Defector()]
         cls.repetitions = 3

axelrod/tests/unit/test_resultset.py

@@ -648,7 +648,7 @@ class TestResultSetSpatialStructure(TestResultSet):
     @classmethod
     def setUpClass(cls):
 
-        cls.filename = axl_filename("test_outputs/test_results_spatial.csv")
+        cls.filename = axl_filename("test_outputs", "test_results_spatial.csv")
         cls.players = [axelrod.Alternator(), axelrod.TitForTat(), axelrod.Defector()]
         cls.turns = 5
         cls.edges = [(0, 1), (0, 2)]

axelrod/tests/unit/test_tournament.py

@@ -89,7 +89,7 @@ def setUpClass(cls):
             [200, 200, 1, 200, 200],
         ]
 
-        cls.filename = axl_filename("test_outputs/test_tournament.csv")
+        cls.filename = axl_filename("test_outputs", "test_tournament.csv")
 
     def setUp(self):
         self.test_tournament = axelrod.Tournament(
@@ -735,7 +735,7 @@ def test_write_to_csv_with_results(self):
         tournament.play(filename=self.filename, progress_bar=False)
         df = pd.read_csv(self.filename)
         expected_df = pd.read_csv(
-            axl_filename("test_outputs/expected_test_tournament.csv")
+            axl_filename("test_outputs", "expected_test_tournament.csv")
         )
         self.assertTrue(df.equals(expected_df))
 
@@ -750,7 +750,7 @@ def test_write_to_csv_without_results(self):
         tournament.play(filename=self.filename, progress_bar=False, build_results=False)
         df = pd.read_csv(self.filename)
         expected_df = pd.read_csv(
-            axl_filename("test_outputs/expected_test_tournament_no_results.csv")
+            axl_filename("test_outputs", "expected_test_tournament_no_results.csv")
         )
         self.assertTrue(df.equals(expected_df))
 

requirements.txt

@@ -5,6 +5,7 @@ hypothesis==3.2
 matplotlib>=2.0.0
 numpy>=1.9.2
 pandas>=0.18.1
+pathlib>=1.0.1
 prompt-toolkit>=1.0.7
 scipy>=0.19.0
 toolz>=0.8.0