Added messages to all asserts in the platform. (#126)

* Added messages to all asserts in the platform.

---------

Co-authored-by: Michael Cochez <[email protected]>

Author: miselico

src/schnapsen/bots/alphabeta.py

@@ -118,7 +118,7 @@ def value(
                 beta = min(beta, best_value)  # alphabeta pruning
                 if beta <= alpha:
                     break
-        assert best_move  # We are sure the best_move can no longer be None. We assert to make sure we did not make a logical mistake
+        assert best_move, "We are sure the best_move can no longer be None"  # We assert to make sure we did not make a logical mistake
         return best_value, best_move
 
 

src/schnapsen/bots/example_bot.py

@@ -49,7 +49,7 @@ def get_move(self, perspective: PlayerPerspective, leader_move: Optional[Move])
         elif one_move.is_trump_exchange():
             exchange = one_move
             jack: Card = exchange.cards[0]
-            assert jack.rank == Rank.JACK
+            assert jack.rank == Rank.JACK, f"The rank of the card in a trump exchange must always be a {Rank.JACK}"
         else:
             normal_move = one_move
             card: Card = normal_move.cards[0]

src/schnapsen/bots/gui/guibot.py

@@ -93,7 +93,7 @@ def _get_move(self, botname: str, perspective: PlayerPerspective, leader_move: O
         # we now wait for the browser to make the move
         state_exchange.is_move_ready.wait()
         move = state_exchange.browser_move
-        assert move is not None
+        assert move is not None, "Browser move must not be None if a move has been exchanged"
         return move
 
     def __sendmove(self, botname: str) -> str:
@@ -195,11 +195,11 @@ def convert_move(old_move: tuple[Optional[int], Optional[int]]) -> Move:
         if not old_move[0]:
             assert old_move[1] is not None, "In the old endinge, all moves with the first part not set must be Trump exchanges"
             return TrumpExchange(_Old_GUI_Compatibility.old_engine_order[old_move[1]])
-        assert old_move[0] and old_move[1]
+        assert old_move[0] and old_move[1], "If it is not a regular move, and not an exchange, it must be a marriage, so expect both cards to be set"
         if _Old_GUI_Compatibility.old_engine_order[old_move[0]].rank == Rank.KING:
             # swap
             old_move = (old_move[1], old_move[0])
-        assert old_move[0] is not None and old_move[1] is not None
+        assert old_move[0] is not None and old_move[1] is not None, "After potential swap, if it is not a regular move, and not an exchange, it must be a marriage, so expect both cards to be set"
         return Marriage(queen_card=_Old_GUI_Compatibility.old_engine_order[old_move[0]], king_card=_Old_GUI_Compatibility.old_engine_order[old_move[1]])
 
     @staticmethod
@@ -230,7 +230,7 @@ def player_game_state_to_json(perspective: PlayerPerspective, leader_move: Optio
             if leader_move.is_regular_move():
                 partial_move_down = leader_move.as_regular_move().card
             else:
-                assert leader_move.is_marriage()
+                assert leader_move.is_marriage(), "Expected the move to be a marriage at this point."
                 partial_move_down = leader_move.as_marriage().underlying_regular_move().card
         else:
             partial_move_down = None
@@ -271,8 +271,8 @@ def player_game_state_to_json(perspective: PlayerPerspective, leader_move: Optio
                 else:
                     this_card_state = 'P2H'
 
-            assert this_card_state
-            assert this_p1_perspective
+            assert this_card_state, "Whatever happened, the state for this card must be set in one of the branches."
+            assert this_p1_perspective, "Whatever happened, the perspective information for this card must be set in one of the branches."
 
             card_state[index] = this_card_state
             p1_perspective[index] = this_p1_perspective

src/schnapsen/bots/minimax.py

@@ -116,7 +116,7 @@ def value(
             elif not maximizing and value < best_value:
                 best_move = move
                 best_value = value
-        assert best_move  # We are sure the best_move can no longer be None. We assert to make sure we did not make a logical mistake
+        assert best_move, "We are sure the best_move can no longer be None."  # We assert to make sure we did not make a logical mistake
         return best_value, best_move
 
 

src/schnapsen/bots/ml_bot.py

@@ -53,12 +53,12 @@ def get_move(self, perspective: PlayerPerspective, leader_move: Optional[Move])
         model_output = self.__model.predict_proba(action_state_representations)
         winning_probabilities_of_moves = [outcome_prob[1] for outcome_prob in model_output]
         highest_value: float = -1
-        best_move: Move
+        best_move = None
         for index, value in enumerate(winning_probabilities_of_moves):
             if value > highest_value:
                 highest_value = value
                 best_move = my_valid_moves[index]
-        assert best_move is not None
+        assert best_move is not None, "We went over all the moves, selecting the one we expect to lead to the highest average score. Simce there must have been at least one move at the start, this can never be None"
         return best_move
 
 

src/schnapsen/bots/rdeep.py

@@ -44,7 +44,7 @@ def get_move(self, perspective: PlayerPerspective, leader_move: Optional[Move])
             if average_score > best_score:
                 best_score = average_score
                 best_move = move
-        assert best_move is not None
+        assert best_move is not None, "We went over all the moves, selecting the one we expect to lead to the highest average score. Simce there must have been at least one move at the start, this can never be None"
         return best_move
 
     def __evaluate(self, gamestate: GameState, engine: GamePlayEngine, leader_move: Optional[Move], my_move: Move) -> float:

src/schnapsen/deck.py

@@ -316,7 +316,7 @@ def filter_suit(self, suit: Suit) -> list[Card]:
         :return: (list[Card]): An Iterable of cards with the provided suit.
         """
 
-        assert suit in Suit
+        assert suit in Suit, f"The provided suit {suit} is not a valid {Suit} "
         results: list[Card] = [card for card in self._cards if card.suit is suit]
         return results
 
@@ -327,7 +327,7 @@ def filter_rank(self, rank: Rank) -> list[Card]:
         :param rank: (Rank): The rank to filter on.
         :return: (list[Card]): An Iterable of cards with the provided rank.
         """
-        assert rank in Rank
+        assert rank in Rank, f"The provided rank {rank} is not a valid {Rank} "
         results: list[Card] = [card for card in self._cards if card.rank is rank]
         return results
 

tests/bots/test_minimax_alphabeta_bot.py

@@ -120,11 +120,11 @@ def test_second_phase(self) -> None:
                 randbot = RandBot(random.Random(j))
                 if outcome[0] == minimaxA:
                     outcome2 = engine.play_game_from_state_with_new_bots(state, new_leader=minimaxA, new_follower=randbot, leader_move=None)
-                    assert outcome2[0] == minimaxA
+                    assert outcome2[0] == minimaxA, "expected minimax to win from random in a sitatuon that is winnable"
                 else:
                     # minimaxB won
                     outcome2 = engine.play_game_from_state_with_new_bots(state, new_leader=randbot, new_follower=minimaxB, leader_move=None)
-                    assert outcome2[0] == minimaxB
+                    assert outcome2[0] == minimaxB, "expected minimax to win from random in a sitatuon that is winnable"
 
 
 class MiniMaxBotAlphaBetaPhaseTwoEasy(TestCase):

tests/test_schnapsen_implementation.py

@@ -27,11 +27,11 @@ def test_dealing(self) -> None:
         self.assertEqual(len(hand2), 5, "Hand 2 must contain 5 cards")
         self.assertEqual(len(rest), 10, "There must be 10 cards left after dealing")
         for i in [0, 2, 4, 6, 8]:
-            assert cards[i] in hand1
-            assert cards[i + 1] in hand2
-            assert cards[i] not in rest
-            assert cards[i + 1] not in rest
+            assert cards[i] in hand1, f"card {cards[i]} expected to be in hand 1 {hand1} after dealing from {shuffled_deck}"
+            assert cards[i + 1] in hand2, f"card {cards[i + 1]} expected to be in hand 2 {hand2} after dealing from {shuffled_deck}"
+            assert cards[i] not in rest, f"card {cards[i]} not expected to be in the rest {rest} after dealing from {shuffled_deck}"
+            assert cards[i + 1] not in rest, f"card {cards[i]} not expected to be in the rest {rest} after dealing from {shuffled_deck}"
         for i in range(10, 20):
-            assert cards[i] in rest
-            assert cards[i] not in hand1
-            assert cards[i] not in hand2
+            assert cards[i] in rest, f"card {cards[i]} expected to be in the rest {rest} after dealing from {shuffled_deck}"
+            assert cards[i] not in hand1, f"card {cards[i]} not expected to be in the hand1 {hand1} after dealing from {shuffled_deck}"
+            assert cards[i] not in hand2, f"card {cards[i]} not expected to be in the hand2 {hand2} after dealing from {shuffled_deck}"