Change axl_filename to take a pathlib.Path

Author: gaffney2010

axelrod/load_data_.py

@@ -4,25 +4,21 @@
 import pkg_resources
 
 
-def axl_filename(*axl_path: Text) -> Text:
+def axl_filename(path: pathlib.Path) -> pathlib.Path:
     """Given a path under Axelrod/, return absolute filepath.
 
     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").
+        A pathlib.Path object with the relative directory under Axelrod/
 
     Returns
     -------
-        Absolute path to the given path.
+        A pathlib.Path object with the absolute directory.
     """
     # 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)
+    axl_path = pathlib.Path(__file__).resolve().parent.parent
+    return axl_path / path
 
 
 def load_file(filename: str, directory: str) -> List[List[str]]:

axelrod/plot.py

@@ -4,6 +4,7 @@
 import matplotlib
 import matplotlib.pyplot as plt
 import matplotlib.transforms as transforms
+import pathlib
 import tqdm
 from numpy import arange, median, nan_to_num
 
@@ -324,7 +325,8 @@ def save_all_plots(
 
         for method, name in plots:
             f = getattr(self, method)(title="{} - {}".format(title_prefix, name))
-            f.savefig(axl_filename("{}_{}.{}".format(prefix, method, filetype)))
+            path = pathlib.Path("{}_{}.{}".format(prefix, method, filetype))
+            f.savefig(axl_filename(path))
             plt.close(f)
 
             if progress_bar:

axelrod/tests/integration/test_tournament.py

@@ -1,6 +1,7 @@
 import unittest
 
 import filecmp
+import pathlib
 
 import axelrod as axl
 from axelrod.load_data_ import axl_filename
@@ -49,7 +50,8 @@ def setUpClass(cls):
     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")
+        path = pathlib.Path("test_outputs/test_tournament.csv")
+        filename = axl_filename(path)
         self.assertIsNone(
             tournament.play(progress_bar=False, filename=filename, build_results=False)
         )
@@ -94,9 +96,8 @@ def test_repeat_tournament_deterministic(self):
                 turns=2,
                 repetitions=2,
             )
-            files.append(
-                axl_filename("test_outputs", "stochastic_tournament_{}.csv".format(_))
-            )
+            path = pathlib.Path("test_outputs/stochastic_tournament_{}.csv".format(_))
+            files.append(axl_filename(path))
             tournament.play(progress_bar=False, filename=files[-1], build_results=False)
         self.assertTrue(filecmp.cmp(files[0], files[1]))
 
@@ -119,9 +120,8 @@ def test_repeat_tournament_stochastic(self):
                 turns=2,
                 repetitions=2,
             )
-            files.append(
-                axl_filename("test_outputs", "stochastic_tournament_{}.csv".format(_))
-            )
+            path = pathlib.Path("test_outputs/stochastic_tournament_{}.csv".format(_))
+            files.append(axl_filename(path))
             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

@@ -1,5 +1,6 @@
 import unittest
 import os
+import pathlib
 import pickle
 
 import axelrod as axl
@@ -13,8 +14,10 @@ class TestDeterministicCache(unittest.TestCase):
     def setUpClass(cls):
         cls.test_key = (axl.TitForTat(), axl.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")
+        save_path = pathlib.Path("test_outputs/test_cache_save.txt")
+        cls.test_save_file = axl_filename(save_path)
+        load_path = pathlib.Path("test_outputs/test_cache_load.txt")
+        cls.test_load_file = axl_filename(load_path)
         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 +96,8 @@ 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")
+        path = pathlib.Path("test_outputs/test.cache")
+        filename = axl_filename(path)
         with open(filename, "wb") as io:
             pickle.dump(range(5), io)
 

axelrod/tests/unit/test_fingerprint.py

@@ -2,12 +2,10 @@
 from unittest.mock import patch
 
 import os
-
 from tempfile import mkstemp
-
 import matplotlib.pyplot
-
 import numpy as np
+import pathlib
 
 import axelrod as axl
 from axelrod.fingerprint import AshlockFingerprint, Point, TransitiveFingerprint
@@ -201,7 +199,8 @@ def test_temp_file_creation(self):
 
         RecordedMksTemp.reset_record()
         af = AshlockFingerprint(axl.TitForTat)
-        filename = axl_filename("test_outputs/test_fingerprint.csv")
+        path = pathlib.Path("test_outputs/test_fingerprint.csv")
+        filename = axl_filename(path)
 
         self.assertEqual(RecordedMksTemp.record, [])
 
@@ -217,7 +216,8 @@ 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")
+        path = pathlib.Path("test_outputs/test_fingerprint.csv")
+        filename = axl_filename(path)
         af = AshlockFingerprint(axl.TitForTat)
         af.fingerprint(
             turns=1, repetitions=1, step=0.5, progress_bar=False, filename=filename
@@ -431,7 +431,8 @@ def test_init_with_not_default_number(self):
         )
 
     def test_fingerprint_with_filename(self):
-        filename = axl_filename("test_outputs", "test_fingerprint.csv")
+        path = pathlib.Path("test_outputs/test_fingerprint.csv")
+        filename = axl_filename(path)
         strategy = axl.TitForTat()
         tf = TransitiveFingerprint(strategy)
         tf.fingerprint(turns=1, repetitions=1, progress_bar=False, filename=filename)
@@ -442,10 +443,11 @@ def test_fingerprint_with_filename(self):
     def test_serial_fingerprint(self):
         strategy = axl.TitForTat()
         tf = TransitiveFingerprint(strategy)
+        path = pathlib.Path("test_outputs/test_fingerprint.csv")
         tf.fingerprint(
             repetitions=1,
             progress_bar=False,
-            filename=axl_filename("test_outputs", "tran_fin.csv"),
+            filename=axl_filename(path),
         )
         self.assertEqual(tf.data.shape, (50, 50))
 
@@ -458,7 +460,8 @@ def test_parallel_fingerprint(self):
 
     def test_analyse_cooperation_ratio(self):
         tf = TransitiveFingerprint(axl.TitForTat)
-        filename = axl_filename("test_outputs", "test_fingerprint.csv")
+        path = pathlib.Path("test_outputs/test_fingerprint.csv")
+        filename = axl_filename(path)
         with open(filename, "w") as f:
             f.write(
                 """Interaction index,Player index,Opponent index,Repetition,Player name,Opponent name,Actions

axelrod/tests/unit/test_load_data.py

@@ -1,12 +1,14 @@
 import os
+import pathlib
 import unittest
 
 from axelrod.load_data_ import axl_filename
 
 
 class TestLoadData(unittest.TestCase):
     def test_axl_filename(self):
-        actual_fn = axl_filename("axelrod/strategies/titfortat.py")
+        path = pathlib.Path("axelrod/strategies/titfortat.py")
+        actual_fn = axl_filename(path)
 
         # First go from "unit" up to "tests", then up to "axelrod"
         dirname = os.path.dirname(__file__)

axelrod/tests/unit/test_plot.py

@@ -3,6 +3,7 @@
 import tempfile
 import matplotlib
 import matplotlib.pyplot as plt
+import pathlib
 
 from numpy import mean
 
@@ -13,7 +14,8 @@
 class TestPlot(unittest.TestCase):
     @classmethod
     def setUpClass(cls):
-        cls.filename = axl_filename("test_outputs", "test_results.csv")
+        path = pathlib.Path("test_outputs/test_results.csv")
+        cls.filename = axl_filename(path)
 
         cls.players = [axl.Alternator(), axl.TitForTat(), axl.Defector()]
         cls.repetitions = 3

axelrod/tests/unit/test_resultset.py

@@ -4,6 +4,7 @@
 import pandas as pd
 from dask.dataframe.core import DataFrame
 from numpy import mean, nanmedian, std
+import pathlib
 
 import axelrod as axl
 from axelrod.load_data_ import axl_filename
@@ -19,7 +20,8 @@ class TestResultSet(unittest.TestCase):
     @classmethod
     def setUpClass(cls):
 
-        cls.filename = axl_filename("test_outputs", "test_results.csv")
+        path = pathlib.Path("test_outputs/test_results.csv")
+        cls.filename = str(axl_filename(path))
 
         cls.players = [axl.Alternator(), axl.TitForTat(), axl.Defector()]
         cls.repetitions = 3
@@ -677,7 +679,8 @@ class TestResultSetSpatialStructure(TestResultSet):
     @classmethod
     def setUpClass(cls):
 
-        cls.filename = axl_filename("test_outputs", "test_results_spatial.csv")
+        path = pathlib.Path("test_outputs/test_results_spatial.csv")
+        cls.filename = str(axl_filename(path))
         cls.players = [axl.Alternator(), axl.TitForTat(), axl.Defector()]
         cls.turns = 5
         cls.edges = [(0, 1), (0, 2)]
@@ -857,7 +860,8 @@ class TestResultSetSpatialStructureTwo(TestResultSetSpatialStructure):
     @classmethod
     def setUpClass(cls):
 
-        cls.filename = axl_filename("test_outputs", "test_results_spatial_two.csv")
+        path = pathlib.Path("test_outputs/test_results_spatial_two.csv")
+        cls.filename = str(axl_filename(path))
         cls.players = [
             axl.Alternator(),
             axl.TitForTat(),
@@ -1058,7 +1062,8 @@ class TestResultSetSpatialStructureThree(TestResultSetSpatialStructure):
     @classmethod
     def setUpClass(cls):
 
-        cls.filename = axl_filename("test_outputs", "test_results_spatial_three.csv")
+        path = pathlib.Path("test_outputs/test_results_spatial_three.csv")
+        cls.filename = str(axl_filename(path))
         cls.players = [
             axl.Alternator(),
             axl.TitForTat(),

axelrod/tests/unit/test_tournament.py

@@ -7,6 +7,7 @@
 import io
 import logging
 import os
+import pathlib
 import pickle
 import warnings
 from multiprocessing import Queue, cpu_count
@@ -90,7 +91,8 @@ def setUpClass(cls):
             [200, 200, 1, 200, 200],
         ]
 
-        cls.filename = axl_filename("test_outputs", "test_tournament.csv")
+        path = pathlib.Path("test_outputs/test_tournament.csv")
+        cls.filename = axl_filename(path)
 
     def setUp(self):
         self.test_tournament = axl.Tournament(
@@ -110,9 +112,7 @@ def test_init(self):
             noise=0.2,
         )
         self.assertEqual(len(tournament.players), len(test_strategies))
-        self.assertIsInstance(
-            tournament.players[0].match_attributes["game"], axl.Game
-        )
+        self.assertIsInstance(tournament.players[0].match_attributes["game"], axl.Game)
         self.assertEqual(tournament.game.score((C, C)), (3, 3))
         self.assertEqual(tournament.turns, self.test_turns)
         self.assertEqual(tournament.repetitions, 10)
@@ -415,9 +415,7 @@ def test_progress_bar_play_parallel(self):
     # these two examples were identified by hypothesis.
     @example(
         tournament=axl.Tournament(
-            players=[axl.BackStabber(), axl.MindReader()],
-            turns=2,
-            repetitions=1,
+            players=[axl.BackStabber(), axl.MindReader()], turns=2, repetitions=1,
         )
     )
     @example(
@@ -735,9 +733,8 @@ 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")
-        )
+        path = pathlib.Path("test_outputs/expected_test_tournament.csv")
+        expected_df = pd.read_csv(axl_filename(path))
         self.assertTrue(df.equals(expected_df))
 
     def test_write_to_csv_without_results(self):
@@ -750,9 +747,8 @@ 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")
-        )
+        path = pathlib.Path("test_outputs/expected_test_tournament_no_results.csv")
+        expected_df = pd.read_csv(axl_filename(path))
         self.assertTrue(df.equals(expected_df))
 
 
@@ -808,16 +804,12 @@ def test_init(self):
     # these two examples were identified by hypothesis.
     @example(
         tournament=axl.Tournament(
-            players=[axl.BackStabber(), axl.MindReader()],
-            prob_end=0.2,
-            repetitions=1,
+            players=[axl.BackStabber(), axl.MindReader()], prob_end=0.2, repetitions=1,
         )
     )
     @example(
         tournament=axl.Tournament(
-            players=[axl.ThueMorse(), axl.MindReader()],
-            prob_end=0.2,
-            repetitions=1,
+            players=[axl.ThueMorse(), axl.MindReader()], prob_end=0.2, repetitions=1,
         )
     )
     def test_property_serial_play(self, tournament):