Game classes (move): rename parameter

Author: feberts

server/abstract_game.py

@@ -79,7 +79,7 @@ def current_player(self):
         """
         raise NotImplementedError
 
-    def move(self, args, player_id):
+    def move(self, move, player_id):
         """
         Handle a move.
 
@@ -114,7 +114,7 @@ def move(self, args, player_id):
         error object.
 
         Parameters:
-        args (dict): the player's move (must be checked)
+        move (dict): the player's move (must be checked)
         player_id (int): ID of the player submitting the move (no parameter check required)
 
         Returns:

server/games/chat.py

@@ -23,19 +23,19 @@ def max_players():
     def current_player(self):
         return list(range(self._players))
 
-    def move(self, args, player_id):
-        if 'name' in args:
-            name = args['name'].strip()
+    def move(self, move, player_id):
+        if 'name' in move:
+            name = move['name'].strip()
             if name in self._names.values():
                 return 'name already in use'
             if name == '':
                 return 'name must not be an empty string'
             self._names[player_id] = name
 
-        if 'message' in args:
+        if 'message' in move:
             if player_id not in self._names:
                 return 'you must submit your name first'
-            message = args['message'].strip()
+            message = move['message'].strip()
             if message == '':
                 return None
             self._messages.append((self._names[player_id], message))

server/games/echo.py

@@ -28,11 +28,11 @@ def max_players():
     def current_player(self):
         return [0]
 
-    def move(self, args, player_id):
-        if 'msg' not in args:
+    def move(self, move, player_id):
+        if 'msg' not in move:
             return "keyword argument 'msg' missing"
 
-        self._message = args['msg']
+        self._message = move['msg']
 
         if self._message == 'quit':
             self._gameover = True

server/games/template.py

@@ -96,7 +96,7 @@ def current_player(self):
         raise NotImplementedError
         # TODO return a list (!) of player IDs
 
-    def move(self, args, player_id):
+    def move(self, move, player_id):
         """
         Handle a move.
 
@@ -131,7 +131,7 @@ def move(self, args, player_id):
         error object.
 
         Parameters:
-        args (dict): the player's move (must be checked)
+        move (dict): the player's move (must be checked)
         player_id (int): ID of the player submitting the move (no parameter check required)
 
         Returns:

server/games/tictactoe.py

@@ -47,26 +47,26 @@ def state(self, player_id): # override
         """
         return {'board':self._state.board, 'winner':self._state.winner}
 
-    def move(self, args, player_id): # override
+    def move(self, move, player_id): # override
         """
         Submit a move.
 
         The move is passed as a dictionary containing the key 'position' with a
         board position (0-8) as its value.
 
         Parameters:
-        args (dict): the current player's move
+        move (dict): the current player's move
         player_id (int): player ID (unused)
 
         Returns:
         str: error message in case the move was illegal, None otherwise
         """
-        if 'position' not in args:
+        if 'position' not in move:
             return "keyword argument 'position' of type int missing"
-        if type(args['position']) != int:
+        if type(move['position']) != int:
             return "type of argument 'position' must be int"
 
-        pos = int(args['position'])
+        pos = int(move['position'])
         err = self._check_move(pos)
         if err: return err
 

server/games/yahtzee.py

@@ -111,12 +111,12 @@ def _update_scorecard(self, category, points):
 
         return None
 
-    def move(self, args, player_id): # override
+    def move(self, move, player_id): # override
         """
         Handling a player's move.
 
         The type of move is determined and then passed to the corresponding
-        function. The required content of dictionary args depends on the phase
+        function. The required content of dictionary move depends on the phase
         of the game. In the first phase, all players must send their names
         before any turns can be performed. From then on, players can roll their
         dice, add points to their scorecards, or cross out categories.
@@ -128,24 +128,24 @@ def move(self, args, player_id): # override
         'category': name of a category, must be supplied in addition to 'score'
 
         Parameters:
-        args (dict): the current player's move
+        move (dict): the current player's move
         player_id (int): player ID
 
         Returns:
         str: error message in case the move was illegal, None otherwise
         """
-        if 'roll_dice' in args:
-            return self._roll_dice(args['roll_dice'])
-        if 'score' in args:
-            if 'category' not in args:
+        if 'roll_dice' in move:
+            return self._roll_dice(move['roll_dice'])
+        if 'score' in move:
+            if 'category' not in move:
                 return 'a category must be passed'
-            if args['score'] == 'add points':
-                return self._add_points(args['category'])
-            if args['score'] == 'cross out':
-                return self._cross_out(args['category'])
+            if move['score'] == 'add points':
+                return self._add_points(move['category'])
+            if move['score'] == 'cross out':
+                return self._cross_out(move['category'])
             return 'no such score operation'
-        if 'name' in args:
-            return self._set_name(args['name'].strip(), player_id)
+        if 'name' in move:
+            return self._set_name(move['name'].strip(), player_id)
         return 'no such move'
 
     def _roll_dice(self, dice=None):