chipiron.games package

Subpackages

• chipiron.games.game package
  • Submodules
  • chipiron.games.game.final_game_result module
    • FinalGameResult
      • FinalGameResult.DRAW
      • FinalGameResult.WIN_FOR_BLACK
      • FinalGameResult.WIN_FOR_WHITE
    • GameReport
      • GameReport.fen_history
      • GameReport.final_game_result
      • GameReport.move_history
  • chipiron.games.game.game module
    • Game
      • Game.board
      • Game.fen_history
      • Game.is_paused()
      • Game.is_play()
      • Game.move_history
      • Game.play_move()
      • Game.playing_status
      • Game.rewind_one_move()
      • Game.set_pause_status()
      • Game.set_play_status()
    • ObservableGame
      • ObservableGame.board
      • ObservableGame.fen_history
      • ObservableGame.game
      • ObservableGame.is_paused()
      • ObservableGame.is_play()
      • ObservableGame.mailboxes_display
      • ObservableGame.move_functions
      • ObservableGame.move_history
      • ObservableGame.notify_display()
      • ObservableGame.notify_status()
      • ObservableGame.play_move()
      • ObservableGame.playing_status
      • ObservableGame.query_move_from_players()
      • ObservableGame.register_display()
      • ObservableGame.register_player()
      • ObservableGame.rewind_one_move()
      • ObservableGame.set_pause_status()
      • ObservableGame.set_play_status()
  • chipiron.games.game.game_args module
    • GameArgs
      • GameArgs.starting_position
      • GameArgs.max_half_moves
      • GameArgs.each_player_has_its_own_thread
      • GameArgs.each_player_has_its_own_thread
      • GameArgs.max_half_moves
      • GameArgs.starting_position
  • chipiron.games.game.game_args_factory module
    • GameArgsFactory
      • GameArgsFactory.args_game
      • GameArgsFactory.args_match
      • GameArgsFactory.args_player_one
      • GameArgsFactory.args_player_two
      • GameArgsFactory.game_number
      • GameArgsFactory.generate_game_args()
      • GameArgsFactory.is_match_finished()
      • GameArgsFactory.seed_
  • chipiron.games.game.game_manager module
    • GameManager
      • GameManager.args
      • GameManager.display_board_evaluator
      • GameManager.external_eval()
      • GameManager.game
      • GameManager.game_continue_conditions()
      • GameManager.main_thread_mailbox
      • GameManager.move_factory
      • GameManager.output_folder_path
      • GameManager.play_one_game()
      • GameManager.play_one_move()
      • GameManager.player_color_to_id
      • GameManager.players
      • GameManager.print_to_file()
      • GameManager.processing_mail()
      • GameManager.progress_collector
      • GameManager.rewind_one_move()
      • GameManager.simple_results()
      • GameManager.syzygy
      • GameManager.tell_results()
      • GameManager.terminate_processes()
  • chipiron.games.game.game_manager_factory module
    • GameManagerFactory
      • GameManagerFactory.board_factory
      • GameManagerFactory.create()
      • GameManagerFactory.game_manager_board_evaluator
      • GameManagerFactory.implementation_args
      • GameManagerFactory.main_thread_mailbox
      • GameManagerFactory.move_factory
      • GameManagerFactory.output_folder_path
      • GameManagerFactory.subscribe()
      • GameManagerFactory.subscribers
      • GameManagerFactory.syzygy_table
      • GameManagerFactory.universal_behavior
  • chipiron.games.game.game_playing_status module
    • GamePlayingStatus
      • GamePlayingStatus.is_paused()
      • GamePlayingStatus.is_play()
      • GamePlayingStatus.pause()
      • GamePlayingStatus.play()
      • GamePlayingStatus.status
    • PlayingStatus
      • PlayingStatus.PAUSE
      • PlayingStatus.PLAY
  • chipiron.games.game.observable_game_playing_status module
    • ObservableGamePlayingStatus
      • ObservableGamePlayingStatus.is_paused()
      • ObservableGamePlayingStatus.is_play()
      • ObservableGamePlayingStatus.notify()
      • ObservableGamePlayingStatus.pause()
      • ObservableGamePlayingStatus.play()
      • ObservableGamePlayingStatus.status
      • ObservableGamePlayingStatus.subscribe()
  • chipiron.games.game.progress_collector module
    • PlayerProgressCollector
      • PlayerProgressCollector.progress_black
      • PlayerProgressCollector.progress_black_
      • PlayerProgressCollector.progress_white
      • PlayerProgressCollector.progress_white_
    • PlayerProgressCollectorObservable
      • PlayerProgressCollectorObservable.notify()
      • PlayerProgressCollectorObservable.progress_black()
      • PlayerProgressCollectorObservable.progress_collector
      • PlayerProgressCollectorObservable.progress_white()
      • PlayerProgressCollectorObservable.subscribers
    • PlayerProgressCollectorP
      • PlayerProgressCollectorP.progress_black()
      • PlayerProgressCollectorP.progress_white()
  • chipiron.games.game.test_game module
  • Module contents
    • Game
      • Game.board
      • Game.fen_history
      • Game.is_paused()
      • Game.is_play()
      • Game.move_history
      • Game.play_move()
      • Game.playing_status
      • Game.rewind_one_move()
      • Game.set_pause_status()
      • Game.set_play_status()
    • GameArgs
      • GameArgs.starting_position
      • GameArgs.max_half_moves
      • GameArgs.each_player_has_its_own_thread
      • GameArgs.each_player_has_its_own_thread
      • GameArgs.max_half_moves
      • GameArgs.starting_position
    • GameArgsFactory
      • GameArgsFactory.args_game
      • GameArgsFactory.args_match
      • GameArgsFactory.args_player_one
      • GameArgsFactory.args_player_two
      • GameArgsFactory.game_number
      • GameArgsFactory.generate_game_args()
      • GameArgsFactory.is_match_finished()
      • GameArgsFactory.seed_
    • ObservableGame
      • ObservableGame.board
      • ObservableGame.fen_history
      • ObservableGame.game
      • ObservableGame.is_paused()
      • ObservableGame.is_play()
      • ObservableGame.mailboxes_display
      • ObservableGame.move_functions
      • ObservableGame.move_history
      • ObservableGame.notify_display()
      • ObservableGame.notify_status()
      • ObservableGame.play_move()
      • ObservableGame.playing_status
      • ObservableGame.query_move_from_players()
      • ObservableGame.register_display()
      • ObservableGame.register_player()
      • ObservableGame.rewind_one_move()
      • ObservableGame.set_pause_status()
      • ObservableGame.set_play_status()
• chipiron.games.match package
  • Submodules
  • chipiron.games.match.MatchTag module
    • MatchConfigTag
      • MatchConfigTag.Cubo
      • MatchConfigTag.Duda
      • MatchConfigTag.Jime
      • MatchConfigTag.Tron
      • MatchConfigTag.get_match_settings_args()
      • MatchConfigTag.get_yaml_file_path()
  • chipiron.games.match.match_args module
    • MatchArgs
      • MatchArgs.match_setting
      • MatchArgs.player_one
      • MatchArgs.player_two
  • chipiron.games.match.match_factories module
    • create_match_manager()
    • create_match_manager_from_args()
  • chipiron.games.match.match_manager module
    • MatchManager
      • MatchManager.play_one_game()
      • MatchManager.play_one_match()
      • MatchManager.print_info()
      • MatchManager.print_stats_to_file()
      • MatchManager.save_match_report_to_file()
      • MatchManager.subscribe()
  • chipiron.games.match.match_results module
    • IMatchResults
      • IMatchResults.add_result_one_game()
      • IMatchResults.finish()
      • IMatchResults.get_simple_result()
    • MatchReport
      • MatchReport.match_move_history
      • MatchReport.match_results
    • MatchResults
      • MatchResults.add_result_one_game()
      • MatchResults.finish()
      • MatchResults.get_draws()
      • MatchResults.get_player_one_wins()
      • MatchResults.get_player_two_wins()
      • MatchResults.get_simple_result()
      • MatchResults.match_finished
      • MatchResults.number_of_games
      • MatchResults.player_one_is_white_black_wins
      • MatchResults.player_one_is_white_draws
      • MatchResults.player_one_is_white_white_wins
      • MatchResults.player_one_name_id
      • MatchResults.player_two_is_white_black_wins
      • MatchResults.player_two_is_white_draws
      • MatchResults.player_two_is_white_white_wins
      • MatchResults.player_two_name_id
    • SimpleResults
      • SimpleResults.draws
      • SimpleResults.player_one_wins
      • SimpleResults.player_two_wins
  • chipiron.games.match.match_results_factory module
    • MatchResultsFactory
      • MatchResultsFactory.player_one_name
      • MatchResultsFactory.player_two_name
      • MatchResultsFactory.subscribers
      • MatchResultsFactory.create()
      • MatchResultsFactory.create()
      • MatchResultsFactory.player_one_name
      • MatchResultsFactory.player_two_name
      • MatchResultsFactory.subscribe()
      • MatchResultsFactory.subscribers
  • chipiron.games.match.match_settings_args module
    • MatchSettingsArgs
      • MatchSettingsArgs.game_setting_file
      • MatchSettingsArgs.number_of_games_player_one_black
      • MatchSettingsArgs.number_of_games_player_one_white
  • chipiron.games.match.observable_match_result module
    • ObservableMatchResults
      • ObservableMatchResults.match_results
      • ObservableMatchResults.mailboxes
      • ObservableMatchResults.copy_match_result()
      • ObservableMatchResults.notify_new_results()
      • ObservableMatchResults.get_simple_result()
      • ObservableMatchResults.finish()
      • ObservableMatchResults.__str__()
      • ObservableMatchResults.add_result_one_game()
      • ObservableMatchResults.copy_match_result()
      • ObservableMatchResults.finish()
      • ObservableMatchResults.get_simple_result()
      • ObservableMatchResults.mailboxes
      • ObservableMatchResults.match_results
      • ObservableMatchResults.notify_new_results()
      • ObservableMatchResults.subscribe()
  • chipiron.games.match.utils module
    • fetch_match_games_args_convert_and_save()
  • Module contents
    • MatchSettingsArgs
      • MatchSettingsArgs.game_setting_file
      • MatchSettingsArgs.number_of_games_player_one_black
      • MatchSettingsArgs.number_of_games_player_one_white
    • create_match_manager()

Module contents

Module for managing games.

class chipiron.games.GamePlayingStatus(_status: PlayingStatus = PlayingStatus.PLAY)

Bases: object

Object containing the playing status of a game and the board.

is_paused() → bool

Check if the game is currently paused.

Returns:

True if the game is paused, False otherwise.

Return type:

bool

is_play() → bool

Check if the game is currently playing.

Returns:

True if the game is playing, False otherwise.

Return type:

bool

pause() → None

Set the playing status to ‘PAUSE’.

play() → None

Set the playing status to ‘PLAY’.

property status: PlayingStatus

Get the current playing status of the game.

Returns:

The current playing status.

Return type:

PlayingStatus

class chipiron.games.MatchManager(player_one_id: str, player_two_id: str, game_manager_factory: GameManagerFactory, game_args_factory: GameArgsFactory, match_results_factory: MatchResultsFactory, output_folder_path: str | PathLike[str] | None = None)

Bases: object

Object in charge of playing one match

Parameters:

• player_one_id (str) – The ID of player one.

• player_two_id (str) – The ID of player two.

• game_manager_factory (GameManagerFactory) – The factory for creating game managers.

• game_args_factory (GameArgsFactory) – The factory for creating game arguments.

• match_results_factory (MatchResultsFactory) – The factory for creating match results.

• output_folder_path (path | None, optional) – The path to the output folder. Defaults to None.

play_one_game(player_color_to_factory_args: dict[bool, chipiron.players.player_args.PlayerFactoryArgs], args_game: GameArgs, game_number: int, game_seed: int) → GameReport

Plays one game and returns the game report.

Parameters:

• player_color_to_factory_args (dict[chess.Color, PlayerFactoryArgs]) – A dictionary mapping player colors to their factory arguments.

• args_game (GameArgs) – The arguments for the game.

• game_number (int) – The number of the game.

• game_seed (seed) – The seed for the game.

Returns:

The report of the game.

Return type:

GameReport

play_one_match() → MatchReport

Plays one match and returns the match report.

This method plays a single match, which consists of multiple games. It generates game arguments, plays each game, updates the match results, and saves the match report to a file.

Returns:

The report of the match, including the move history and match results.

Return type:

MatchReport

print_info() → None

Prints the information about the players in the match.

This method prints the IDs of player one and player two.

Parameters:

None –

Returns:

None

print_stats_to_file(match_results: IMatchResults) → None

Prints the match statistics to a file.

Parameters:

match_results (IMatchResults) – The match results object containing the statistics.

save_match_report_to_file(match_report: MatchReport) → None

Save the match report to a file.

Parameters:

match_report (MatchReport) – The match report to be saved.

subscribe(subscriber: Queue[IsDataclass]) → None

Subscribe a subscriber to receive updates from the match manager.

Parameters:

subscriber (queue.Queue[IsDataclass]) – The subscriber to be added to the list of subscribers.

class chipiron.games.ObservableGamePlayingStatus(game_playing_status: GamePlayingStatus)

Bases: object

An observable version of GamePlayingStatus that notifies subscribers. Players and GUI can then decide what to do with this information.

is_paused() → bool

Checks if the game is currently paused.

Returns:

True if the game is paused, False otherwise.

Return type:

bool

is_play() → bool

Checks if the game is currently being played.

Returns:

True if the game is being played, False otherwise.

Return type:

bool

notify() → None

Notifies the subscribers with the current game status.

pause() → None

Pauses the game and notifies the subscribers.

play() → None

Plays the game and notifies the subscribers.

property status: PlayingStatus

Gets the current playing status.

Returns:

The current playing status.

Return type:

PlayingStatus

subscribe(mailboxes: list[queue.Queue[chipiron.utils.communication.gui_messages.game_status_message.GameStatusMessage]]) → None

Subscribes the given mailboxes to receive game status updates.

Parameters:

mailboxes (list[queue.Queue[GameStatusMessage]]) – The mailboxes to subscribe.