"""
This module contains the ObservableMatchResults class, which is a wrapper around the MatchResults class.
"""
import copy
import queue
from dataclasses import dataclass, field
from chipiron.games.game.final_game_result import FinalGameResult
from chipiron.utils.communication.gui_messages.gui_messages import MatchResultsMessage
from chipiron.utils.dataclass import IsDataclass
from .match_results import MatchResults, SimpleResults
[docs]@dataclass
class ObservableMatchResults:
"""
The ObservableMatchResults class provides a way to observe and subscribe to changes in the match results.
It maintains a list of mailboxes (queue.Queue) to which it sends notifications whenever there are new match results.
Attributes:
match_results (MatchResults): The underlying MatchResults object that stores the match results.
mailboxes (list[queue.Queue[IsDataclass]]): A list of mailboxes to which notifications are sent.
"""
match_results: MatchResults
mailboxes: "list[queue.Queue[IsDataclass]]" = field(default_factory=list)
[docs] def subscribe(self, mailbox: "queue.Queue[IsDataclass]") -> None:
"""Subscribes a mailbox to receive notifications.
Args:
mailbox (queue.Queue[IsDataclass]): The mailbox to subscribe.
Returns:
None
"""
self.mailboxes.append(mailbox)
[docs] def copy_match_result(self) -> MatchResults:
"""Creates a deep copy of the match results.
Returns:
MatchResults: A deep copy of the match results.
"""
match_result_copy: MatchResults = copy.deepcopy(self.match_results)
return match_result_copy
[docs] def add_result_one_game(
self, white_player_name_id: str, game_result: FinalGameResult
) -> None:
"""Adds the result of a single game to the match results.
Args:
white_player_name_id (str): The ID of the white player.
game_result (FinalGameResult): The result of the game.
Returns:
None
"""
self.match_results.add_result_one_game(white_player_name_id, game_result)
self.notify_new_results()
[docs] def notify_new_results(self) -> None:
"""Notifies all subscribed mailboxes about the new match results.
Returns:
None
"""
for mailbox in self.mailboxes:
match_result_copy: MatchResults = self.copy_match_result()
message: "MatchResultsMessage" = MatchResultsMessage(
match_results=match_result_copy
)
mailbox.put(item=message)
[docs] def get_simple_result(self) -> SimpleResults:
"""Retrieves a simplified version of the match results.
Returns:
SimpleResults: A simplified version of the match results.
"""
simple_results = SimpleResults(
player_one_wins=self.match_results.get_player_one_wins(),
player_two_wins=self.match_results.get_player_two_wins(),
draws=self.match_results.get_draws(),
)
return simple_results
[docs] def finish(self) -> None:
"""Marks the match as finished and notifies all subscribed mailboxes.
Returns:
None
"""
self.match_results.match_finished = True
self.notify_new_results()
[docs] def __str__(self) -> str:
"""Returns a string representation of the match results.
Returns:
str: A string representation of the match results.
"""
return str(self.match_results)