Add type hints to tournament

axelrod/tournament.py

@@ -8,17 +8,19 @@
 import tqdm
 
 from axelrod import on_windows
+from axelrod.player import Player
 from .game import Game
 from .match import Match
-from .match_generator import RoundRobinMatches, ProbEndRoundRobinMatches, SpatialMatches, ProbEndSpatialMatches
+from .match_generator import RoundRobinMatches, ProbEndRoundRobinMatches, SpatialMatches, ProbEndSpatialMatches, MatchGenerator
 from .result_set import ResultSetFromFile, ResultSet
 
+from typing import List
 
 class Tournament(object):
 
-    def __init__(self, players, match_generator=RoundRobinMatches,
-                 name='axelrod', game=None, turns=200, repetitions=10,
-                 noise=0, with_morality=True):
+    def __init__(self, players: List[Player], match_generator: MatchGenerator=RoundRobinMatches,
+                 name: str='axelrod', game: Game=None, turns: int=200, repetitions: int=10,
+                 noise: float=0, with_morality: bool=True) -> None:
         """
         Parameters
         ----------
@@ -70,9 +72,9 @@ def setup_output(self, filename=None, in_memory=False):
             # Save filename for loading ResultSet later
             self.filename = filename
 
-    def play(self, build_results=True, filename=None,
-             processes=None, progress_bar=True,
-             keep_interactions=False, in_memory=False):
+    def play(self, build_results: bool=True, filename: str=None,
+             processes: int=None, progress_bar: bool=True,
+             keep_interactions: bool=False, in_memory: bool=False) -> ResultSetFromFile:
         """
         Plays the tournament and passes the results to the ResultSet class
 
@@ -130,8 +132,8 @@ def play(self, build_results=True, filename=None,
         elif not in_memory:
             self.outputfile.close()
 
-    def _build_result_set(self, progress_bar=True, keep_interactions=False,
-                          in_memory=False):
+    def _build_result_set(self, progress_bar: bool=True, keep_interactions: bool=False,
+                          in_memory: bool=False):
         """
         Build the result set (used by the play method)
 
@@ -158,7 +160,7 @@ def _build_result_set(self, progress_bar=True, keep_interactions=False,
                 game=self.game)
         return result_set
 
-    def _run_serial(self, progress_bar=False):
+    def _run_serial(self, progress_bar: bool=False) -> bool:
         """
         Run all matches in serial
 
@@ -210,7 +212,7 @@ def _write_interactions_to_dict(self, results):
                     self.interactions_dict[index_pair] = [interaction]
                 self.num_interactions += 1
 
-    def _run_parallel(self, processes=2, progress_bar=False):
+    def _run_parallel(self, processes: int=2, progress_bar: bool=False) -> bool:
         """
         Run all matches in parallel
 
@@ -236,7 +238,7 @@ def _run_parallel(self, processes=2, progress_bar=False):
 
         return True
 
-    def _n_workers(self, processes=2):
+    def _n_workers(self, processes: int=2) -> int:
         """
         Determines the number of parallel processes to use.
 
@@ -250,7 +252,7 @@ def _n_workers(self, processes=2):
             n_workers = cpu_count()
         return n_workers
 
-    def _start_workers(self, workers, work_queue, done_queue):
+    def _start_workers(self, workers: int, work_queue: Queue, done_queue: Queue) -> bool:
         """
         Initiates the sub-processes to carry out parallel processing.
 
@@ -270,7 +272,7 @@ def _start_workers(self, workers, work_queue, done_queue):
             process.start()
         return True
 
-    def _process_done_queue(self, workers, done_queue, progress_bar=False):
+    def _process_done_queue(self, workers: int, done_queue: Queue, progress_bar: bool=False):
         """
         Retrieves the matches from the parallel sub-processes
 
@@ -296,7 +298,7 @@ def _process_done_queue(self, workers, done_queue, progress_bar=False):
                     self.progress_bar.update(1)
         return True
 
-    def _worker(self, work_queue, done_queue):
+    def _worker(self, work_queue: Queue, done_queue: Queue):
         """
         The work for each parallel sub-process to execute.
 
@@ -385,8 +387,8 @@ class SpatialTournament(Tournament):
     A tournament in which the players are allocated in a graph as nodes
     and they players only play the others that are connected to with an edge.
     """
-    def __init__(self, players, edges, name='axelrod', game=None, turns=200,
-                 repetitions=10, noise=0, with_morality=True):
+    def __init__(self, players: List[Player], edges, name: str='axelrod', game: Game=None, turns: int=200,
+                 repetitions: int=10, noise: float=0, with_morality: bool=True) -> None:
         """
         Parameters
         ----------
@@ -420,8 +422,8 @@ class ProbEndSpatialTournament(ProbEndTournament):
     and they players only play the others that are connected to with an edge.
     Players do not know the length of a given match (it is randomly sampled).
     """
-    def __init__(self, players, edges, name='axelrod', game=None, prob_end=.5,
-                 repetitions=10, noise=0, with_morality=True):
+    def __init__(self, players: List[Player], edges, name: str='axelrod', game: Game=None, prob_end: float=.5,
+                 repetitions: int=10, noise: float=0, with_morality: bool=True) -> None:
         """
         Parameters
         ----------

run_mypy.py

@@ -8,6 +8,7 @@
            "axelrod/mock_player.py",
            "axelrod/moran.py",
            "axelrod/plot.py",
+           "axelrod/tournament.py",
            "axelrod/strategies/adaptive.py",
            "axelrod/strategies/alternator.py",
            "axelrod/strategies/ann.py",