apollo/maze-solver
1
0
Fork 0
Code Pull requests Projects Releases Packages Activity Actions
maze-solver/maze.py

101 lines
3.1 KiB
Python
Raw Normal View History

feat: add the Maze class The Maze class stored a 2-dimensional grid of Cells. When the Maze is initialised, the Cell's are created and drawn onto the canvas.
2024-02-13 12:18:47 +00:00
from typing import List
from time import sleep
checkpoint: setting up breaking of walls
2024-02-13 18:06:46 +00:00
import random
feat: add the Maze class The Maze class stored a 2-dimensional grid of Cells. When the Maze is initialised, the Cell's are created and drawn onto the canvas.
2024-02-13 12:18:47 +00:00
from graphics import Window
from cell import Cell
class Maze:
"""
Maze represents a two-dimensional grid of Cells.
"""
def __init__(
self,
x_position: int,
y_position: int,
test: add tests for the Maze class Add some tests to test the Maze constructor.
2024-02-13 14:21:35 +00:00
num_cell_rows: int,
num_cells_per_row: int,
feat: add the Maze class The Maze class stored a 2-dimensional grid of Cells. When the Maze is initialised, the Cell's are created and drawn onto the canvas.
2024-02-13 12:18:47 +00:00
cell_size_x: int,
cell_size_y: int,
fix: only draw the graphics if the window exists Optionally pass in the reference of the Window to the Maze and Cell classes, and only draw the graphics if the reference exists. Use a single underscore instead of the double underscore for private Class members.
2024-02-13 13:39:25 +00:00
window: Window = None,
checkpoint: setting up breaking of walls
2024-02-13 18:06:46 +00:00
seed=None,
fix: only draw the graphics if the window exists Optionally pass in the reference of the Window to the Maze and Cell classes, and only draw the graphics if the reference exists. Use a single underscore instead of the double underscore for private Class members.
2024-02-13 13:39:25 +00:00
) -> None:
self._x_position = x_position
self._y_position = y_position
test: add tests for the Maze class Add some tests to test the Maze constructor.
2024-02-13 14:21:35 +00:00
self._num_cell_rows = num_cell_rows
self._num_cells_per_row = num_cells_per_row
fix: only draw the graphics if the window exists Optionally pass in the reference of the Window to the Maze and Cell classes, and only draw the graphics if the reference exists. Use a single underscore instead of the double underscore for private Class members.
2024-02-13 13:39:25 +00:00
self._cell_size_x = cell_size_x
self._cell_size_y = cell_size_y
self._window = window
checkpoint: setting up breaking of walls
2024-02-13 18:06:46 +00:00
self._seed = None
# Generate the seed if it does not exist
if seed:
self._seed = seed
else:
random.seed(self._seed)
feat: add the Maze class The Maze class stored a 2-dimensional grid of Cells. When the Maze is initialised, the Cell's are created and drawn onto the canvas.
2024-02-13 12:18:47 +00:00
# Create the Maze's cells
test: add tests for the Maze class Add some tests to test the Maze constructor.
2024-02-13 14:21:35 +00:00
self._cells: List[List[Cell]] = [None for i in range(self._num_cell_rows)]
fix: only draw the graphics if the window exists Optionally pass in the reference of the Window to the Maze and Cell classes, and only draw the graphics if the reference exists. Use a single underscore instead of the double underscore for private Class members.
2024-02-13 13:39:25 +00:00
self._create_cells()
refactor: a bit of refactoring - Move the custom exceptions to errors.py - Created enums to label the cell walls. Replaces the constants defined in the Cell class.
2024-02-14 10:14:27 +00:00
self._open_entrance_and_exit()
feat: add the Maze class The Maze class stored a 2-dimensional grid of Cells. When the Maze is initialised, the Cell's are created and drawn onto the canvas.
2024-02-13 12:18:47 +00:00
refactor: a bit of refactoring - Move the custom exceptions to errors.py - Created enums to label the cell walls. Replaces the constants defined in the Cell class.
2024-02-14 10:14:27 +00:00
def _create_cells(self) -> None:
"""
creates all the cells and draws them.
"""
fix: only draw the graphics if the window exists Optionally pass in the reference of the Window to the Maze and Cell classes, and only draw the graphics if the reference exists. Use a single underscore instead of the double underscore for private Class members.
2024-02-13 13:39:25 +00:00
cursor_x = self._x_position
cursor_y = self._y_position
feat: add the Maze class The Maze class stored a 2-dimensional grid of Cells. When the Maze is initialised, the Cell's are created and drawn onto the canvas.
2024-02-13 12:18:47 +00:00
test: add tests for the Maze class Add some tests to test the Maze constructor.
2024-02-13 14:21:35 +00:00
for i in range(self._num_cell_rows):
cells: List[Cell] = [None for j in range(self._num_cells_per_row)]
for j in range(self._num_cells_per_row):
feat: add the Maze class The Maze class stored a 2-dimensional grid of Cells. When the Maze is initialised, the Cell's are created and drawn onto the canvas.
2024-02-13 12:18:47 +00:00
cell = Cell(
cursor_x,
cursor_y,
fix: only draw the graphics if the window exists Optionally pass in the reference of the Window to the Maze and Cell classes, and only draw the graphics if the reference exists. Use a single underscore instead of the double underscore for private Class members.
2024-02-13 13:39:25 +00:00
(cursor_x + self._cell_size_x),
(cursor_y + self._cell_size_y),
self._window
feat: add the Maze class The Maze class stored a 2-dimensional grid of Cells. When the Maze is initialised, the Cell's are created and drawn onto the canvas.
2024-02-13 12:18:47 +00:00
)
test: add tests for the Maze class Add some tests to test the Maze constructor.
2024-02-13 14:21:35 +00:00
cells[j] = cell
if j == self._num_cells_per_row - 1:
fix: only draw the graphics if the window exists Optionally pass in the reference of the Window to the Maze and Cell classes, and only draw the graphics if the reference exists. Use a single underscore instead of the double underscore for private Class members.
2024-02-13 13:39:25 +00:00
cursor_x = self._x_position
feat: add the Maze class The Maze class stored a 2-dimensional grid of Cells. When the Maze is initialised, the Cell's are created and drawn onto the canvas.
2024-02-13 12:18:47 +00:00
else:
fix: only draw the graphics if the window exists Optionally pass in the reference of the Window to the Maze and Cell classes, and only draw the graphics if the reference exists. Use a single underscore instead of the double underscore for private Class members.
2024-02-13 13:39:25 +00:00
cursor_x += self._cell_size_x
test: add tests for the Maze class Add some tests to test the Maze constructor.
2024-02-13 14:21:35 +00:00
self._cells[i] = cells
fix: only draw the graphics if the window exists Optionally pass in the reference of the Window to the Maze and Cell classes, and only draw the graphics if the reference exists. Use a single underscore instead of the double underscore for private Class members.
2024-02-13 13:39:25 +00:00
cursor_y += self._cell_size_y
feat: add the Maze class The Maze class stored a 2-dimensional grid of Cells. When the Maze is initialised, the Cell's are created and drawn onto the canvas.
2024-02-13 12:18:47 +00:00
fix: only draw the graphics if the window exists Optionally pass in the reference of the Window to the Maze and Cell classes, and only draw the graphics if the reference exists. Use a single underscore instead of the double underscore for private Class members.
2024-02-13 13:39:25 +00:00
if self._window:
self._draw_cells()
feat: add the Maze class The Maze class stored a 2-dimensional grid of Cells. When the Maze is initialised, the Cell's are created and drawn onto the canvas.
2024-02-13 12:18:47 +00:00
refactor: a bit of refactoring - Move the custom exceptions to errors.py - Created enums to label the cell walls. Replaces the constants defined in the Cell class.
2024-02-14 10:14:27 +00:00
def _open_entrance_and_exit(self) -> None:
"""
opens the maze's entrance and exit cells by breaking their respective
walls. The entrance is located at the top left and the exit is located
at the bottom right of the maze.
"""
feat: add entrance, exit to the maze. - Add an entrance and exit to the maze. The entrance will always be on the top left and the exit will always be on the bottom right. - Add a simple GitHub actions workflow to run the Python tests.
2024-02-13 15:52:28 +00:00
self._cells[0][0].configure_walls(top=False)
self._cells[0][0].draw()
refactor: a bit of refactoring - Move the custom exceptions to errors.py - Created enums to label the cell walls. Replaces the constants defined in the Cell class.
2024-02-14 10:14:27 +00:00
feat: add entrance, exit to the maze. - Add an entrance and exit to the maze. The entrance will always be on the top left and the exit will always be on the bottom right. - Add a simple GitHub actions workflow to run the Python tests.
2024-02-13 15:52:28 +00:00
self._cells[self._num_cell_rows - 1][self._num_cells_per_row - 1].configure_walls(bottom=False)
self._cells[self._num_cell_rows - 1][self._num_cells_per_row - 1].draw()
refactor: a bit of refactoring - Move the custom exceptions to errors.py - Created enums to label the cell walls. Replaces the constants defined in the Cell class.
2024-02-14 10:14:27 +00:00
def _draw_cells(self) -> None:
"""
draws all the cells on the maze with a short pause between each cell
for animation purposes.
"""
test: add tests for the Maze class Add some tests to test the Maze constructor.
2024-02-13 14:21:35 +00:00
for i in range(self._num_cell_rows):
for j in range(self._num_cells_per_row):
fix: only draw the graphics if the window exists Optionally pass in the reference of the Window to the Maze and Cell classes, and only draw the graphics if the reference exists. Use a single underscore instead of the double underscore for private Class members.
2024-02-13 13:39:25 +00:00
self._cells[i][j].draw()
self._animate()
feat: add the Maze class The Maze class stored a 2-dimensional grid of Cells. When the Maze is initialised, the Cell's are created and drawn onto the canvas.
2024-02-13 12:18:47 +00:00
refactor: a bit of refactoring - Move the custom exceptions to errors.py - Created enums to label the cell walls. Replaces the constants defined in the Cell class.
2024-02-14 10:14:27 +00:00
def _animate(self) -> None:
"""
redraws the application and pauses for a short period of time to
provide an animation effect.
"""
fix: only draw the graphics if the window exists Optionally pass in the reference of the Window to the Maze and Cell classes, and only draw the graphics if the reference exists. Use a single underscore instead of the double underscore for private Class members.
2024-02-13 13:39:25 +00:00
self._window.redraw()
feat: add the Maze class The Maze class stored a 2-dimensional grid of Cells. When the Maze is initialised, the Cell's are created and drawn onto the canvas.
2024-02-13 12:18:47 +00:00
sleep(0.05)
Copy permalink