mastermind.game package

class mastermind.game.board.GameBoard(number_of_colors: int, number_of_dots: int)

Bases: object

Represents the game board for a Mastermind game.

The GameBoard class manages the game’s guesses and feedbacks, allowing players to make guesses, retrieve past guesses and feedbacks, and clear the board.

NUMBER_OF_COLORS

The number of colors available in the game.

Type:

int

NUMBER_OF_DOTS

The number of dots (or pegs) in each guess.

Type:

int

_number_of_guesses_made

The number of guesses made so far.

Type:

int

_guesses

A stack of the guesses made so far.

Type:

Stack

_feedbacks

A stack of the feedbacks received for the guesses made so far.

Type:

Stack

Raises:

EmptyBoardError – If there are no guesses to retrieve or remove.

exception EmptyBoardError

Bases: Exception

Exception raised when trying to access the game board when it is empty.

add_guess(guess: Tuple[int, ...], feedback: Tuple[int, ...]) → None

Adds a new guess and its corresponding feedback to the game board.

Parameters:

• guess (Tuple[int, ...]) – The new guess.

• feedback (Tuple[int, ...]) – The feedback for the new guess.

clear() → None

Clears the game board, removing all guesses and feedbacks.

last_feedback() → Tuple

Returns the feedback for the last guess made on the game board.

Returns:

A tuple representation of the last feedback.

Return type:

Tuple

Raises:

EmptyBoardError – If there are no guesses on the game board.

last_guess() → Tuple

Returns the last guess made on the game board.

Returns:

A tuple representation of the last guess.

Return type:

Tuple

Raises:

EmptyBoardError – If there are no guesses on the game board.

remove_last() → Tuple

Removes the last guess and feedback from the game board.

Returns:

The removed guess and feedback.

Return type:

Tuple

Raises:

EmptyBoardError – If there are no guesses on the game board.

class mastermind.game.game.Game(number_of_colors, number_of_dots, maximum_attempts, game_mode)

Bases: object

The main entry point for the Mastermind game.

Parameters:

• number_of_colors (int) – The number of colors in the game.

• number_of_dots (int) – The number of dots in each combination.

• maximum_attempts (int) – The maximum number of attempts allowed in the game.

• game_mode (str) – The game mode, such as “HvH”, “HvAI”, “AIvH”, or “AIvAI”.

property game_mode: str

Returns the game mode.

property maximum_attempts: int

Returns the maximum number of attempts allowed in the game.

property number_of_colors: int

Returns the number of colors in the game.

property number_of_dots: int

Returns the number of dots in each combination.

resume_game() → str | None

Resumes the game.

Returns:

A command from the player, if any.

Return type:

Optional[str]

start_game() → str | None

Starts the game.

Returns:

A command from the player, if any.

Return type:

Optional[str]

class mastermind.game.game_flow.GameFlow(game_state: GameParameter, player_logic: PlayerLogic)

Bases: object

Manages the flow of the Mastermind game.

Parameters:

• game_state (GameState) – The state of the game.

• player_logic (PlayerLogic) – The logic for the players.

output_result() → None

Outputs the result of the game.

resume_game() → str | None

Resumes the game.

Returns:

A command from the player, if any.

Return type:

Optional[str]

start_game() → str | None

Starts the game.

Returns:

A command from the player, if any.

Return type:

Optional[str]

class mastermind.game.game_parameter.GameParameter(number_of_colors: int, number_of_dots: int, maximum_attempts: int, game_mode: str)

Bases: ValidatedClass

Represents the state of the Mastermind game.

Parameters:

• number_of_colors (int) – The number of colors in the game.

• number_of_dots (int) – The number of dots in each combination.

• maximum_attempts (int) – The maximum number of attempts allowed in the game.

• game_mode (str) – The game mode, such as “HvH”, “HvAI”, “AIvH”, or “AIvAI”.

check_and_update_win_status() → bool | None

Checks the game state and updates the win status.

Returns:

The win status, or None if the game is still in progress.

Return type:

bool | None

property number_of_colors: int

property number_of_dots: int

property win_status: bool | None

class mastermind.game.player_logic.PlayerLogic(game_state: GameParameter)

Bases: object

Manages the logic for the players in the Mastermind game.

Parameters:

game (GameState) – The state of the game.

property GAME_MODE: str

initialize_players() → None

Initializes the players based on the game mode.

process_player_guessing() → str | None

Processes the player’s guessing logic.

Returns:

A command from the player, if any.

Return type:

Optional[str]

submit_guess(guess: Tuple[int, ...], feedback: Tuple[int, ...]) → None

Submits a guess and its corresponding feedback to the game board.

Parameters:

• guess (Tuple[int, ...]) – The guess to be submitted.

• feedback (Tuple[int, ...]) – The feedback for the guess.

Raises:

NotImplementedError – If the game has ended.