Lab Participation 8

# filename: run.py
from ship import Ship


def create_board() -> list[list[Ship | None]]:
    '''
    Create a 2D list representing the game board. The size will be
    5x5 with all slots set to None.
    '''
    board = [
        [None] * 5,
        [None] * 5,
        [None] * 5,
        [None] * 5,
        [None] * 5
    ]
    return board


def print_board(board: list[list[Ship | None]]) -> None:
    '''
    Prints the game board with the ships.
    You can assume the board is 5x5.
    '''
    pass


# you will need to modify the implementation of this function
def is_finished(board: list[list[Ship | None]]):
    '''
    Check if all ships on the 2D list game board are sunk.
    Returns True if all ships are sunk, otherwise False.
    '''
    i = 0
    while i < 5:
        row = board[i]
        j = 0
        while j < 5:
            ship = row[j]
            if isinstance(ship, Ship):
                # if a ship has not sunk, we know the game is not done
                if not ship.has_sunk():
                    return False
            j += 1
        i += 1
    # if we reach here, all ships have sunk
    return True


def main():
    '''Runs the game.'''
    # 1. Create the list of ships
    ships = Ship.create_ships()

    # 2. Create the 5x5 board
    board = create_board()

    # 3. Place your ships in the board based on their coordinates
    i = 0
    while i < len(ships):
        ship = ships[i]
        x, y = ship.get_coord()
        board[y][x] = ship
        i += 1

    # 4. Continuously prompt the user for input until all ships are sunk.
    #    Whenever a ship is sunk, update the ship's status accordingly.
    print("Game started. Fire at will!")
    attempts = 0
    while attempts < 10:
        user_input = input(f"Enter X, Y coordinate [{attempts+1}/10]: ")
        # fetch the inputs
        tokens = user_input.split(', ')
        x = int(tokens[0])
        y = int(tokens[1])
        # check if the coordinates are valid
        if x < 0 or x >= 5 or y < 0 or y >= 5:
            # go back to the input
            print('Invalid coordinates. Try again.')
            attempts += 1
            continue
         
        # we reach here if valid coordinates are given
        ship = board[y][x]
        if not isinstance(ship, Ship):
            print('Miss!')
            attempts += 1
            continue

        # we reach here if it is a ship
        if ship.has_sunk():
            print('Miss!')
        else:
            ship.got_hit()
            print(f'You sank {ship.get_name()}!')

        if is_finished(board):
            print("Congratulations! All ships are sunk.")
            return

        attempts += 1

    # if we reach here, it means we exited the loop, meaning we've used all attempts
    print('Game over after 10 attempts! Try again next time!')


if __name__ == "__main__":
    main()

# filename: ship.py
class Ship:


    def __init__(self, x: int, y: int, name: str) -> None:
        '''
        Initialize a ship object with given coordinates and name.

        There are 4 attributes of the the ship:
        x (int): The x coordinate of the ship.
        y (int): The y coordinate of the ship.
        name (str): The name or type of the ship.
        sunk (bool): Indicates whether the ship has sunk.
        '''
        self.x = x
        self.y = y
        self.name = name
        self.sunk = False


    def got_hit(self):
        '''
        Update the status of the ship when it gets hit.
        If the ship is hit, it is marked as sunk.
        '''
        self.sunk = True

       
    def has_sunk(self) -> bool:
        '''Get the status of the ship.'''
        return self.sunk


    def get_name(self) -> str:
        '''Get the name of the ship.'''
        return self.name


    def get_coord(self) -> tuple[int, int]:
        '''Get the coordinate of the ship.'''
        return self.x, self.y


    def __repr__(self) -> str:
        '''
        Returns a formatted string representation of the ship.

        The formatted string includes the ship's name followed by its status:
        - If the ship has sunk, the format is "{name}: Sunk".
        - If the ship hasn't sunk, the format is "{name}: Afloat".
        '''
        if self.sunk:
            return f'{self.name}: Sunk'
        else:
            return f'{self.name}: Afloat'

    
    # you will need to modify the implementation of this method
    def create_ships() -> list["Ship"]:
        '''
        Creates a list of ships and returns it.

        Currently, the implementation returns a static list of ships. 
        You will need to change it so the ships are created by the
        user through inputs.       
        '''
        # this is the solution for the previous battleship game
        # however, it requires modification to fit the new description 
        return [
            Ship(1, 4, 'ShipA'),
            Ship(3, 2, 'ShipB'),
            Ship(3, 3, 'ShipC')
        ]

Your program produced the incorrect output.

Creating ships...
> A 0 0
Success! ShipA added at (0, 0)
> B 2 2
Success! ShipB added at (2, 2)
> C 0 0
Error: (0, 0) is already occupied by ShipA
> A 1 1
- Success! ShipA added at (1, 1)
+ Error: symbol 'A' is already taken
> C 2 2
Error: (2, 2) is already occupied by ShipB
> B 3 3
- Success! ShipB added at (3, 3)
+ Error: symbol 'B' is already taken
> END SHIPS
4 ships added.
Traceback (most recent call last):
  File "/home/test_create_ships.py", line 47, in <module>
    test_ships_eq(ships, values)
  File "/home/test_create_ships.py", line 24, in test_ships_eq
    assert len(ships) == len(values), f'number of ships is incorrect.\nExpected: {len(values)}\nGot: {len(ships)}'
           ^^^^^^^^^^^^^^^^^^^^^^^^^
AssertionError: number of ships is incorrect.
Expected: 2
Got: 4
2 ships added.