11 Commits

Author SHA1 Message Date
da7e be997c5d17 fix lint + black formating + SITULITUPU 2026-04-01 18:02:38 +02:00
da7e a4d8f3fbfe Merge branch 'whl' 2026-04-01 17:44:20 +02:00
da7e 3fe46026ec Merge branch 'docstring' 2026-04-01 17:42:48 +02:00
Maoake Teriierooiterai d2f38468a4 need to be merge to the main and add some line for the makefile 2026-04-01 17:17:20 +02:00
Maoake Teriierooiterai b659871902 finish the mypy 2026-04-01 16:09:42 +02:00
Maoake Teriierooiterai c9e0cf0610 fix some mypy need to fix for the others 2026-04-01 15:25:38 +02:00
Maoake Teriierooiterai aadccfba53 finish the mypy strict 2026-04-01 15:19:46 +02:00
Maoake Teriierooiterai c7c7213fb9 fix some mypy strict on file a_maze_ing.py 2026-04-01 15:03:22 +02:00
da7e 843fe5f80c uv config for build wheel package
add clean and fclean method to Makefile
2026-04-01 14:31:11 +02:00
Maoake Teriierooiterai 03b5f9e6fd fix mypy strict on MazeSolver and Maze Generator 2026-04-01 14:12:39 +02:00
maoake ed16566677 finish to fix parsing mypy 2026-03-31 22:43:03 +02:00
17 changed files with 203 additions and 158 deletions
+1
View File
@@ -216,3 +216,4 @@ __marimo__/
.streamlit/secrets.toml .streamlit/secrets.toml
test.txt test.txt
mazegen-1.0.0-py3-none-any.whl
+17 -4
View File
@@ -1,3 +1,7 @@
build:
uv build --clear --wheel
cp dist/*.whl mazegen-1.0.0-py3-none-any.whl
install: install:
uv sync uv sync
uv pip install mlx-2.2-py3-none-any.whl uv pip install mlx-2.2-py3-none-any.whl
@@ -12,15 +16,22 @@ debug:
uv pdb python3 a_maze_ing.py config.txt uv pdb python3 a_maze_ing.py config.txt
clean: clean:
rm -rf __pycache__ .mypy_cache .venv rm -rf */**/__pycache__ __pycache__ .mypy_cache .venv dist build */**/*.egg-info *.egg-info test.txt
fclean: clean
rm mazegen-1.0.0-py3-none-any.whl
lint: lint:
uv run flake8 . --exclude=.venv uv run flake8 . --exclude=.venv
uv run mypy . --warn-return-any --warn-unused-ignores --ignore-missing-imports --disallow-untyped-defs --check-untyped-defs uv run env PYTHONPATH=src python3 -m mypy --warn-return-any --warn-unused-ignores --ignore-missing-imports --disallow-untyped-defs --check-untyped-defs src
uv run env PYTHONPATH=src python3 -m mypy --warn-return-any --warn-unused-ignores --ignore-missing-imports --disallow-untyped-defs --check-untyped-defs tests
uv run env PYTHONPATH=src python3 -m mypy --warn-return-any --warn-unused-ignores --ignore-missing-imports --disallow-untyped-defs --check-untyped-defs a_maze_ing.py
lint-strict: lint-strict:
uv run flake8 . uv run flake8 . --exclude=.venv
uv run mypy . --strict uv run env PYTHONPATH=src python3 -m mypy --strict src
uv run env PYTHONPATH=src python3 -m mypy --strict tests
uv run env PYTHONPATH=src python3 -m mypy --strict a_maze_ing.py
run_test_parsing: run_test_parsing:
PYTHONPATH=src uv run pytest tests/test_parsing.py PYTHONPATH=src uv run pytest tests/test_parsing.py
@@ -34,3 +45,5 @@ run_test:
uv run pytest uv run pytest
mlx: mlx:
uv run python3 test.py uv run python3 test.py
.PHONY: build install run debug clean fclean lint lint-strict run_test
+30 -22
View File
@@ -1,8 +1,8 @@
from typing import Any from typing import Any
from numpy.typing import NDArray
from src.AMazeIng import AMazeIng from src.AMazeIng import AMazeIng
from src.parsing import Parsing from src.parsing.Parsing import DataMaze as Parsing
from mlx import Mlx from mlx import Mlx
import numpy as np
import time import time
@@ -29,14 +29,12 @@ class MazeMLX:
self.buf, self.bpp, self.size_line, self.format = ( self.buf, self.bpp, self.size_line, self.format = (
self.mlx.mlx_get_data_addr(self.img_ptr) self.mlx.mlx_get_data_addr(self.img_ptr)
) )
self.path_printer = None
self.generator = None
def close(self) -> None: def close(self) -> None:
"""Destroy the image used by the renderer.""" """Destroy the image used by the renderer."""
self.mlx.mlx_destroy_image(self.mlx_ptr, self.img_ptr) self.mlx.mlx_destroy_image(self.mlx_ptr, self.img_ptr)
def close_loop(self, _: Any): def close_loop(self, _: Any) -> None:
"""Stop the MLX event loop. """Stop the MLX event loop.
Args: Args:
@@ -63,7 +61,9 @@ class MazeMLX:
"1: regen; 2: path; 3: color; 4: quit;", "1: regen; 2: path; 3: color; 4: quit;",
) )
def put_pixel(self, x, y, color: list | None = None) -> None: def put_pixel(
self, x: int, y: int, color: list[Any] | None = None
) -> None:
"""Draw a single pixel into the image buffer. """Draw a single pixel into the image buffer.
Args: Args:
@@ -93,7 +93,7 @@ class MazeMLX:
self, self,
start: tuple[int, int], start: tuple[int, int],
end: tuple[int, int], end: tuple[int, int],
color: list | None = None, color: list[Any] | None = None,
) -> None: ) -> None:
"""Draw a horizontal or vertical line. """Draw a horizontal or vertical line.
@@ -115,7 +115,7 @@ class MazeMLX:
self, self,
ul: tuple[int, int], ul: tuple[int, int],
dr: tuple[int, int], dr: tuple[int, int],
color: list | None = None, color: list[Any] | None = None,
) -> None: ) -> None:
"""Draw a filled rectangular block. """Draw a filled rectangular block.
@@ -165,7 +165,7 @@ class MazeMLX:
for color in colors: for color in colors:
yield color yield color
def get_margin_line_len(self, maze: np.ndarray) -> tuple[int, int, int]: def get_margin_line_len(self, maze: NDArray[Any]) -> tuple[int, int, int]:
"""Compute the cell size and margins for centering the maze. """Compute the cell size and margins for centering the maze.
Args: Args:
@@ -188,7 +188,7 @@ class MazeMLX:
return (line_len, margin_x, margin_y) return (line_len, margin_x, margin_y)
def update_maze(self, maze: np.ndarray) -> None: def update_maze(self, maze: NDArray[Any]) -> None:
"""Render the maze walls into the image buffer. """Render the maze walls into the image buffer.
Args: Args:
@@ -272,7 +272,7 @@ class MazeMLX:
self.put_block(ul, dr) self.put_block(ul, dr)
return return
def put_start_end(self, amazing: AMazeIng): def put_start_end(self, amazing: AMazeIng) -> None:
"""Draw highlighted blocks for the maze entry and exit. """Draw highlighted blocks for the maze entry and exit.
Args: Args:
@@ -306,8 +306,11 @@ class MazeMLX:
) )
self.put_block(ul, dr, [0x00, 0xFF, 0x40, 0x9F]) self.put_block(ul, dr, [0x00, 0xFF, 0x40, 0x9F])
def draw_ft(self, maze: np.ndarray, color: list | None = None): def draw_ft(
"""Draw filled cells corresponding to the reserved fully walled pattern. self, maze: NDArray[Any], color: list[Any] | None = None
) -> None:
"""Draw filled cells corresponding to the reserved fully
walled pattern.
Args: Args:
maze: Maze grid to inspect. maze: Maze grid to inspect.
@@ -325,33 +328,36 @@ class MazeMLX:
self.put_block((x0, y0), (x1, y1), color) self.put_block((x0, y0), (x1, y1), color)
def draw_image(self, amazing: AMazeIng) -> None: def draw_image(self, amazing: AMazeIng) -> None:
maze = amazing.maze.get_maze()
"""Main rendering callback used by the MLX loop. """Main rendering callback used by the MLX loop.
Args: Args:
amazing: Maze container to render. amazing: Maze container to render.
""" """
if self.render_maze(amazing): if self.render_maze(amazing):
if self.path_printer and self.print_path: if self.print_path:
if self.render_path(): if self.render_path():
color = next(self.color_gen_ft) color = next(self.color_gen_ft)
self.draw_ft(amazing.maze.get_maze(), color) if maze is not None:
self.draw_ft(maze, color)
next(self.timer_gen) next(self.timer_gen)
else: else:
self.time_gen() self.time_gen()
self.update_maze(amazing.maze.get_maze()) if maze is not None:
self.draw_ft(amazing.maze.get_maze()) self.update_maze(maze)
self.draw_ft(maze)
self.put_start_end(amazing) self.put_start_end(amazing)
self.redraw_image() self.redraw_image()
def shift_color(self): def shift_color(self) -> None:
"""Reset the maze color generator.""" """Reset the maze color generator."""
self.color_gen = self.random_color() self.color_gen = self.random_color()
def shift_color_ft(self): def shift_color_ft(self) -> None:
"""Reset the reserved-pattern color generator.""" """Reset the reserved-pattern color generator."""
self.color_gen_ft = self.random_color_ft() self.color_gen_ft = self.random_color_ft()
def time_gen(self): def time_gen(self) -> None:
"""Reset the timing generator used for animation pacing.""" """Reset the timing generator used for animation pacing."""
self.timer_gen = self.time_generator() self.timer_gen = self.time_generator()
@@ -406,8 +412,10 @@ class MazeMLX:
``True`` if maze generation is complete, otherwise ``False``. ``True`` if maze generation is complete, otherwise ``False``.
""" """
try: try:
maze = amazing.maze.get_maze()
next(self.generator) next(self.generator)
self.update_maze(amazing.maze.get_maze()) if maze is not None:
self.update_maze(maze)
return False return False
except StopIteration: except StopIteration:
pass pass
@@ -476,7 +484,7 @@ def main() -> None:
mlx = None mlx = None
try: try:
mlx = MazeMLX(1000, 1000) mlx = MazeMLX(1000, 1000)
config = Parsing.DataMaze.get_data_maze("config.txt") config = Parsing.get_data_maze("config.txt")
amazing = AMazeIng(**config) amazing = AMazeIng(**config)
mlx.start(amazing) mlx.start(amazing)
with open("test.txt", "w") as output: with open("test.txt", "w") as output:
-25
View File
@@ -1,25 +0,0 @@
# This script does not check for errors or malformed files.
# It only validates that neighbooring cells sharing a wall have
# both the correct encoding.
# Usage: python3 output_validator.py output_maze.txt
import sys
if len(sys.argv) != 2:
print(f"Usage: python3 {sys.argv[0]} <output_file>")
sys.exit(1)
g = []
for line in open(sys.argv[1]):
if line.strip() == '':
break
g.append([int(c, 16) for c in line.strip(' \t\n\r')])
for r in range(len(g)):
for c in range(len(g[0])):
v = g[r][c]
if not all([(r < 1 or v & 1 == (g[r-1][c] >> 2) & 1),
(c >= len(g[0])-1 or (v >> 1) & 1 == (g[r][c+1] >> 3) & 1),
(r >= len(g)-1 or (v >> 2) & 1 == g[r+1][c] & 1),
(c < 1 or (v >> 3) & 1 == (g[r][c-1] >> 1) & 1)]):
print(f'Wrong encoding for ({c},{r})')
+9
View File
@@ -20,6 +20,15 @@ dev = [
[tool.mypy] [tool.mypy]
python_version = "3.10" python_version = "3.10"
explicit_package_bases = true
[tool.pytest.ini_options] [tool.pytest.ini_options]
pythonpath = ["src"] pythonpath = ["src"]
[build-system]
requires = ["setuptools>=78.1.0", "wheel>=0.45.1"]
build-backend = "setuptools.build_meta"
[tool.setuptools]
package-dir = {"" = "src/amaz_lib"}
+4 -2
View File
@@ -2,11 +2,13 @@ from typing import Generator
from typing_extensions import Self from typing_extensions import Self
from pydantic import BaseModel, Field, model_validator, ConfigDict from pydantic import BaseModel, Field, model_validator, ConfigDict
from src.amaz_lib import Maze, MazeGenerator, MazeSolver from .amaz_lib import Maze, MazeGenerator, MazeSolver
class AMazeIng(BaseModel): class AMazeIng(BaseModel):
"""Represent a complete maze configuration, generation, and solving setup.""" """Represent a complete maze configuration, generation,
and solving setup.
"""
model_config = ConfigDict(arbitrary_types_allowed=True) model_config = ConfigDict(arbitrary_types_allowed=True)
+52 -33
View File
@@ -1,14 +1,18 @@
from abc import ABC, abstractmethod from abc import ABC, abstractmethod
from typing import Generator, Set from typing import Generator, Any
import numpy as np import numpy as np
from numpy.typing import NDArray
from .Cell import Cell from .Cell import Cell
import math import math
import random
class MazeGenerator(ABC): class MazeGenerator(ABC):
"""Define the common interface and helpers for maze generators.""" """Define the common interface and helpers for maze generators."""
def __init__(self, start: tuple, end: tuple, perfect: bool) -> None: def __init__(
self, start: tuple[int, int], end: tuple[int, int], perfect: bool
) -> None:
"""Initialize the maze generator. """Initialize the maze generator.
Args: Args:
@@ -23,7 +27,7 @@ class MazeGenerator(ABC):
@abstractmethod @abstractmethod
def generator( def generator(
self, height: int, width: int, seed: int | None = None self, height: int, width: int, seed: int | None = None
) -> Generator[np.ndarray, None, np.ndarray]: ) -> Generator[NDArray[Any], None, NDArray[Any]]:
"""Generate a maze step by step. """Generate a maze step by step.
Args: Args:
@@ -40,7 +44,7 @@ class MazeGenerator(ABC):
... ...
@staticmethod @staticmethod
def get_cell_ft(width: int, height: int) -> set: def get_cell_ft(width: int, height: int) -> set[tuple[int, int]]:
"""Return the coordinates used to reserve the '42' pattern. """Return the coordinates used to reserve the '42' pattern.
Args: Args:
@@ -76,11 +80,12 @@ class MazeGenerator(ABC):
def unperfect_maze( def unperfect_maze(
width: int, width: int,
height: int, height: int,
maze: np.ndarray, maze: NDArray[Any],
forty_two: set | None, forty_two: set[tuple[int, int]] | None,
prob: float = 0.1, prob: float = 0.1,
) -> Generator[np.ndarray, None, np.ndarray]: ) -> Generator[NDArray[Any], None, NDArray[Any]]:
"""Add extra openings to transform a perfect maze into an imperfect one. """Add extra openings to transform a perfect maze into an imperfect
one.
Random walls are removed while optionally preserving the reserved Random walls are removed while optionally preserving the reserved
``forty_two`` area. ``forty_two`` area.
@@ -99,6 +104,7 @@ class MazeGenerator(ABC):
Returns: Returns:
The modified maze. The modified maze.
""" """
directions = {"N": (0, -1), "S": (0, 1), "W": (-1, 0), "E": (1, 0)} directions = {"N": (0, -1), "S": (0, 1), "W": (-1, 0), "E": (1, 0)}
reverse = {"N": "S", "S": "N", "W": "E", "E": "W"} reverse = {"N": "S", "S": "N", "W": "E", "E": "W"}
@@ -139,7 +145,7 @@ class MazeGenerator(ABC):
class Kruskal(MazeGenerator): class Kruskal(MazeGenerator):
"""Generate a maze using a Kruskal-based algorithm.""" """Generate a maze using a Kruskal-based algorithm."""
class Set: class KruskalSet:
"""Represent a connected component of maze cells.""" """Represent a connected component of maze cells."""
def __init__(self, cells: list[int]) -> None: def __init__(self, cells: list[int]) -> None:
@@ -153,7 +159,7 @@ class Kruskal(MazeGenerator):
class Sets: class Sets:
"""Store all connected components used during generation.""" """Store all connected components used during generation."""
def __init__(self, sets: list[Set]) -> None: def __init__(self, sets: list["Kruskal.KruskalSet"]) -> None:
"""Initialize the collection of connected components. """Initialize the collection of connected components.
Args: Args:
@@ -163,8 +169,8 @@ class Kruskal(MazeGenerator):
@staticmethod @staticmethod
def walls_to_maze( def walls_to_maze(
walls: np.ndarray, height: int, width: int walls: list[tuple[int, int]], height: int, width: int
) -> np.ndarray: ) -> NDArray[Any]:
"""Convert a list of remaining walls into a maze grid. """Convert a list of remaining walls into a maze grid.
Args: Args:
@@ -176,7 +182,8 @@ class Kruskal(MazeGenerator):
A two-dimensional array of :class:`Cell` instances representing the A two-dimensional array of :class:`Cell` instances representing the
maze. maze.
""" """
maze: np.ndarray = np.array(
maze: NDArray[Any] = np.array(
[[Cell(value=0) for _ in range(width)] for _ in range(height)] [[Cell(value=0) for _ in range(width)] for _ in range(height)]
) )
for wall in walls: for wall in walls:
@@ -270,7 +277,7 @@ class Kruskal(MazeGenerator):
def generator( def generator(
self, height: int, width: int, seed: int | None = None self, height: int, width: int, seed: int | None = None
) -> Generator[np.ndarray, None, np.ndarray]: ) -> Generator[NDArray[Any], None, NDArray[Any]]:
"""Generate a maze using a Kruskal-based approach. """Generate a maze using a Kruskal-based approach.
Args: Args:
@@ -292,7 +299,7 @@ class Kruskal(MazeGenerator):
if seed is not None: if seed is not None:
np.random.seed(seed) np.random.seed(seed)
sets = self.Sets([self.Set([i]) for i in range(height * width)]) sets = self.Sets([self.KruskalSet([i]) for i in range(height * width)])
walls = [] walls = []
for h in range(height): for h in range(height):
for w in range(width - 1): for w in range(width - 1):
@@ -330,7 +337,9 @@ class Kruskal(MazeGenerator):
class DepthFirstSearch(MazeGenerator): class DepthFirstSearch(MazeGenerator):
"""Generate a maze using a depth-first search backtracking algorithm.""" """Generate a maze using a depth-first search backtracking algorithm."""
def __init__(self, start: bool, end: bool, perfect: bool) -> None: def __init__(
self, start: tuple[int, int], end: tuple[int, int], perfect: bool
) -> None:
"""Initialize the depth-first search generator. """Initialize the depth-first search generator.
Args: Args:
@@ -341,11 +350,11 @@ class DepthFirstSearch(MazeGenerator):
self.start = (start[0] - 1, start[1] - 1) self.start = (start[0] - 1, start[1] - 1)
self.end = (end[0] - 1, end[1] - 1) self.end = (end[0] - 1, end[1] - 1)
self.perfect = perfect self.perfect = perfect
self.forty_two: set | None = None self.forty_two: set[tuple[int, int]] | None = None
def generator( def generator(
self, height: int, width: int, seed: int = None self, height: int, width: int, seed: int | None = None
) -> Generator[np.ndarray, None, np.ndarray]: ) -> Generator[NDArray[Any], None, NDArray[Any]]:
"""Generate a maze using depth-first search. """Generate a maze using depth-first search.
Args: Args:
@@ -364,14 +373,14 @@ class DepthFirstSearch(MazeGenerator):
maze = self.init_maze(width, height) maze = self.init_maze(width, height)
if width > 9 and height > 9: if width > 9 and height > 9:
self.forty_two = self.get_cell_ft(width, height) self.forty_two = self.get_cell_ft(width, height)
visited = np.zeros((height, width), dtype=bool) visited: NDArray[np.object_] = np.zeros((height, width), dtype=bool)
if ( if (
self.forty_two self.forty_two
and self.start not in self.forty_two and self.start not in self.forty_two
and self.end not in self.forty_two and self.end not in self.forty_two
): ):
visited = self.lock_cell_ft(visited, self.forty_two) visited = self.lock_cell_ft(visited, self.forty_two)
path = list() path: list[tuple[int, int]] = list()
w_h = (width, height) w_h = (width, height)
coord = (0, 0) coord = (0, 0)
x, y = coord x, y = coord
@@ -414,7 +423,7 @@ class DepthFirstSearch(MazeGenerator):
return maze return maze
@staticmethod @staticmethod
def init_maze(width: int, height: int) -> np.ndarray: def init_maze(width: int, height: int) -> NDArray[Any]:
"""Create a fully walled maze grid. """Create a fully walled maze grid.
Args: Args:
@@ -422,7 +431,8 @@ class DepthFirstSearch(MazeGenerator):
height: Number of rows in the maze. height: Number of rows in the maze.
Returns: Returns:
A two-dimensional array of cells initialized with all walls present. A two-dimensional array of cells initialized with all
walls present.
""" """
maze = np.array( maze = np.array(
[[Cell(value=15) for _ in range(width)] for _ in range(height)] [[Cell(value=15) for _ in range(width)] for _ in range(height)]
@@ -430,7 +440,9 @@ class DepthFirstSearch(MazeGenerator):
return maze return maze
@staticmethod @staticmethod
def add_cell_visited(coord: tuple, path: set) -> list: def add_cell_visited(
coord: tuple[int, int], path: list[tuple[int, int]]
) -> list[tuple[int, int]]:
"""Append a visited coordinate to the current traversal path. """Append a visited coordinate to the current traversal path.
Args: Args:
@@ -444,7 +456,9 @@ class DepthFirstSearch(MazeGenerator):
return path return path
@staticmethod @staticmethod
def random_cells(visited: np.array, coord: tuple, w_h: tuple) -> list: def random_cells(
visited: NDArray[Any], coord: tuple[int, int], w_h: tuple[int, int]
) -> list[str]:
"""Return the list of unvisited neighboring directions. """Return the list of unvisited neighboring directions.
Args: Args:
@@ -456,7 +470,7 @@ class DepthFirstSearch(MazeGenerator):
A list of direction strings among ``"N"``, ``"S"``, ``"W"``, and A list of direction strings among ``"N"``, ``"S"``, ``"W"``, and
``"E"``. ``"E"``.
""" """
rand_cell = [] rand_cell: list[str] = []
x, y = coord x, y = coord
width, height = w_h width, height = w_h
@@ -474,7 +488,7 @@ class DepthFirstSearch(MazeGenerator):
return rand_cell return rand_cell
@staticmethod @staticmethod
def next_step(rand_cell: list) -> str: def next_step(rand_cell: list[str]) -> str:
"""Select the next direction at random. """Select the next direction at random.
Args: Args:
@@ -483,7 +497,7 @@ class DepthFirstSearch(MazeGenerator):
Returns: Returns:
A randomly selected direction. A randomly selected direction.
""" """
return np.random.choice(rand_cell) return random.choice(rand_cell)
@staticmethod @staticmethod
def broken_wall(cell: Cell, wall: str) -> Cell: def broken_wall(cell: Cell, wall: str) -> Cell:
@@ -507,7 +521,7 @@ class DepthFirstSearch(MazeGenerator):
return cell return cell
@staticmethod @staticmethod
def next_cell(x: int, y: int, next: str) -> tuple: def next_cell(x: int, y: int, next: str) -> tuple[int, int]:
"""Return the coordinates of the adjacent cell in the given direction. """Return the coordinates of the adjacent cell in the given direction.
Args: Args:
@@ -535,8 +549,13 @@ class DepthFirstSearch(MazeGenerator):
return {"N": "S", "S": "N", "W": "E", "E": "W"}[direction] return {"N": "S", "S": "N", "W": "E", "E": "W"}[direction]
@staticmethod @staticmethod
def back_on_step(path: list, w_h: tuple, visited: np.ndarray) -> list: def back_on_step(
"""Backtrack through the path until a cell with unvisited neighbors is found. path: list[tuple[int, int]],
w_h: tuple[int, int],
visited: NDArray[Any],
) -> list[tuple[int, int]]:
"""Backtrack through the path until a cell with unvisited neighbors
is found.
Args: Args:
path: Current traversal path. path: Current traversal path.
@@ -555,8 +574,8 @@ class DepthFirstSearch(MazeGenerator):
@staticmethod @staticmethod
def lock_cell_ft( def lock_cell_ft(
visited: np.ndarray, forty_two: set[tuple[int]] visited: NDArray[Any], forty_two: set[tuple[int, int]]
) -> np.ndarray: ) -> NDArray[Any]:
"""Mark the reserved '42' pattern cells as already visited. """Mark the reserved '42' pattern cells as already visited.
Args: Args:
+37 -23
View File
@@ -2,6 +2,8 @@ from abc import ABC, abstractmethod
from .Maze import Maze from .Maze import Maze
from typing import Any from typing import Any
import numpy as np import numpy as np
from numpy.typing import NDArray
import random
class MazeSolver(ABC): class MazeSolver(ABC):
@@ -83,7 +85,6 @@ class AStar(MazeSolver):
end: End coordinates using 1-based indexing. end: End coordinates using 1-based indexing.
""" """
super().__init__(start, end) super().__init__(start, end)
self.path = []
def h(self, n: tuple[int, int]) -> int: def h(self, n: tuple[int, int]) -> int:
"""Compute the Manhattan distance heuristic to the goal. """Compute the Manhattan distance heuristic to the goal.
@@ -103,9 +104,9 @@ class AStar(MazeSolver):
def get_paths( def get_paths(
self, self,
maze: np.ndarray, maze: NDArray[Any],
actual: tuple[int, int], actual: tuple[int, int],
close: list, close: list["Node"],
) -> list[tuple[int, int]]: ) -> list[tuple[int, int]]:
"""Return all reachable neighboring coordinates. """Return all reachable neighboring coordinates.
@@ -153,7 +154,7 @@ class AStar(MazeSolver):
] ]
return [p for p in path if p is not None] return [p for p in path if p is not None]
def get_path(self, maze: np.ndarray) -> list: def get_path(self, maze: NDArray[Any]) -> list["Node"]:
"""Perform A* exploration until the destination is reached. """Perform A* exploration until the destination is reached.
Args: Args:
@@ -232,7 +233,7 @@ class AStar(MazeSolver):
else: else:
raise Exception("Translate error: AStar path not found") raise Exception("Translate error: AStar path not found")
def translate(self, close: list) -> str: def translate(self, close: list["Node"]) -> str:
"""Translate a node chain into a path string. """Translate a node chain into a path string.
Args: Args:
@@ -263,14 +264,18 @@ class AStar(MazeSolver):
Returns: Returns:
A string representing the path using cardinal directions. A string representing the path using cardinal directions.
""" """
path = self.get_path(maze.get_maze())
maze_arr = maze.get_maze()
if maze_arr is None:
raise Exception("Maze is not initialized")
path: list[AStar.Node] = self.get_path(maze_arr)
return self.translate(path) return self.translate(path)
class DepthFirstSearchSolver(MazeSolver): class DepthFirstSearchSolver(MazeSolver):
"""Solve a maze using depth-first search with backtracking.""" """Solve a maze using depth-first search with backtracking."""
def __init__(self, start, end): def __init__(self, start: tuple[int, int], end: tuple[int, int]):
"""Initialize the depth-first search solver. """Initialize the depth-first search solver.
Args: Args:
@@ -296,16 +301,20 @@ class DepthFirstSearchSolver(MazeSolver):
Exception: If no path can be found. Exception: If no path can be found.
""" """
path_str = "" path_str = ""
visited = np.zeros((height, width), dtype=bool) if height is None or width is None:
path = list() raise Exception("We need Height and Width in the arg")
move = list() visited: NDArray[Any] = np.zeros((height, width), dtype=bool)
path: list[tuple[int, int]] = list()
move: list[str] = list()
maze_s = maze.get_maze() maze_s = maze.get_maze()
if maze_s is None:
raise Exception("Maze is not initializef")
coord = self.start coord = self.start
h_w = (height, width) h_w: tuple[int, int] = (height, width)
while coord != self.end: while coord != self.end:
visited[coord] = True visited[coord] = True
path.append(coord) path.append(coord)
rand_p = self.random_path(visited, coord, maze_s, h_w) rand_p: list[str] = self.random_path(visited, coord, maze_s, h_w)
if not rand_p: if not rand_p:
path, move = self.back_on_step( path, move = self.back_on_step(
@@ -326,8 +335,11 @@ class DepthFirstSearchSolver(MazeSolver):
@staticmethod @staticmethod
def random_path( def random_path(
visited: np.ndarray, coord: tuple, maze: np.ndarray, h_w: tuple visited: NDArray[Any],
) -> list: coord: tuple[int, int],
maze: NDArray[Any],
h_w: tuple[int, int],
) -> list[str]:
"""Return all valid unvisited directions from the current cell. """Return all valid unvisited directions from the current cell.
Args: Args:
@@ -357,7 +369,7 @@ class DepthFirstSearchSolver(MazeSolver):
return random_p return random_p
@staticmethod @staticmethod
def next_path(rand_path: list) -> str: def next_path(rand_path: list[str]) -> str:
"""Select the next move at random. """Select the next move at random.
Args: Args:
@@ -366,16 +378,17 @@ class DepthFirstSearchSolver(MazeSolver):
Returns: Returns:
A randomly selected direction. A randomly selected direction.
""" """
return np.random.choice(rand_path)
return random.choice(rand_path)
@staticmethod @staticmethod
def back_on_step( def back_on_step(
path: list, path: list[tuple[int, int]],
visited: np.ndarray, visited: NDArray[Any],
maze: np.ndarray, maze: NDArray[Any],
h_w: tuple, h_w: tuple[int, int],
move: list, move: list[str],
) -> list: ) -> tuple[list[Any], list[Any]]:
"""Backtrack until a cell with an unexplored path is found. """Backtrack until a cell with an unexplored path is found.
Args: Args:
@@ -388,6 +401,7 @@ class DepthFirstSearchSolver(MazeSolver):
Returns: Returns:
A tuple containing the updated path and move list. A tuple containing the updated path and move list.
""" """
while path: while path:
last = path[-1] last = path[-1]
if DepthFirstSearchSolver.random_path(visited, last, maze, h_w): if DepthFirstSearchSolver.random_path(visited, last, maze, h_w):
@@ -397,7 +411,7 @@ class DepthFirstSearchSolver(MazeSolver):
return path, move return path, move
@staticmethod @staticmethod
def next_cell(coord: tuple, next: str) -> tuple: def next_cell(coord: tuple[int, int], next: str) -> tuple[int, int]:
"""Return the coordinates of the next cell in the given direction. """Return the coordinates of the next cell in the given direction.
Args: Args:
+10 -2
View File
@@ -6,5 +6,13 @@ from .MazeSolver import MazeSolver, AStar, DepthFirstSearchSolver
__version__ = "1.0.0" __version__ = "1.0.0"
__author__ = "us" __author__ = "us"
__all__ = ["Cell", "Maze", "MazeGenerator", "DepthFirstSearchSolver", __all__ = [
"MazeSolver", "AStar", "Kruskal", "DepthFirstSearch"] "Cell",
"Maze",
"MazeGenerator",
"DepthFirstSearchSolver",
"MazeSolver",
"AStar",
"Kruskal",
"DepthFirstSearch",
]
+20 -16
View File
@@ -1,5 +1,6 @@
from src.amaz_lib.MazeGenerator import DepthFirstSearch, Kruskal from ..amaz_lib import DepthFirstSearch, Kruskal
from src.amaz_lib.MazeSolver import AStar, DepthFirstSearchSolver from ..amaz_lib import AStar, DepthFirstSearchSolver
from typing import Any
class DataMaze: class DataMaze:
@@ -25,7 +26,7 @@ class DataMaze:
return data return data
@staticmethod @staticmethod
def transform_data(data: str) -> dict: def transform_data(data: str) -> dict[str, str]:
"""Transform raw configuration text into a dictionary. """Transform raw configuration text into a dictionary.
Each non-empty line containing ``=`` is split into a key-value pair. Each non-empty line containing ``=`` is split into a key-value pair.
@@ -42,7 +43,7 @@ class DataMaze:
return data_t return data_t
@staticmethod @staticmethod
def verif_key_data(data: dict) -> None: def verif_key_data(data: dict[str, str]) -> None:
"""Validate that the configuration contains the expected keys. """Validate that the configuration contains the expected keys.
Args: Args:
@@ -71,20 +72,20 @@ class DataMaze:
) )
@staticmethod @staticmethod
def convert_values(data: dict): def convert_values(data: dict[str, str]) -> dict[str, Any]:
"""Convert configuration values to their appropriate Python types. """Convert configuration values to their appropriate Python types.
Args: Args:
data: Raw configuration dictionary with string values. data: Raw configuration dictionary with string values.
Returns: Returns:
A dictionary containing converted values and instantiated solver and A dictionary containing converted values and instantiated
generator objects. solver and generator objects.
""" """
key_int = {"WIDTH", "HEIGHT"} key_int = {"WIDTH", "HEIGHT"}
key_tuple = {"ENTRY", "EXIT"} key_tuple = {"ENTRY", "EXIT"}
key_bool = {"PERFECT"} key_bool = {"PERFECT"}
res: dict = {} res: dict[str, Any] = {}
for key in key_int: for key in key_int:
res.update({key: int(data[key])}) res.update({key: int(data[key])})
for key in key_tuple: for key in key_tuple:
@@ -104,11 +105,11 @@ class DataMaze:
@staticmethod @staticmethod
def get_solver_generator( def get_solver_generator(
data: dict, data: dict[str, str],
entry: tuple, entry: tuple[int, int],
exit: tuple, exit: tuple[int, int],
perfect: bool, perfect: bool,
) -> dict: ) -> dict[str, Any]:
"""Instantiate the configured maze generator and solver. """Instantiate the configured maze generator and solver.
Args: Args:
@@ -121,11 +122,14 @@ class DataMaze:
A dictionary containing initialized ``GENERATOR`` and ``SOLVER`` A dictionary containing initialized ``GENERATOR`` and ``SOLVER``
objects. objects.
""" """
available_generator = { available_generator: dict[str, Any] = {
"Kruskal": Kruskal, "Kruskal": Kruskal,
"DFS": DepthFirstSearch, "DFS": DepthFirstSearch,
} }
available_solver = {"AStar": AStar, "DFS": DepthFirstSearchSolver} available_solver: dict[str, Any] = {
"AStar": AStar,
"DFS": DepthFirstSearchSolver,
}
res = {} res = {}
res["GENERATOR"] = available_generator[data["GENERATOR"]]( res["GENERATOR"] = available_generator[data["GENERATOR"]](
entry, entry,
@@ -136,7 +140,7 @@ class DataMaze:
return res return res
@staticmethod @staticmethod
def convert_tuple(data: str) -> tuple: def convert_tuple(data: str) -> tuple[int, int]:
"""Convert a comma-separated coordinate string into a tuple. """Convert a comma-separated coordinate string into a tuple.
Args: Args:
@@ -178,7 +182,7 @@ class DataMaze:
return False return False
@staticmethod @staticmethod
def get_data_maze(name_file: str) -> dict: def get_data_maze(name_file: str) -> dict[str, Any]:
"""Load, validate, and convert maze configuration data from a file. """Load, validate, and convert maze configuration data from a file.
Args: Args:
-6
View File
@@ -1,6 +0,0 @@
__version__ = "1.0.0"
__author__ = "mteriier, dgaillet"
from .Parsing import DataMaze
__all__ = ["DataMaze"]
View File
+3 -1
View File
@@ -15,7 +15,9 @@ def test_maze_setter_getter() -> None:
) )
maze.set_maze(test) maze.set_maze(test)
assert numpy.array_equal(maze.get_maze(), test) is True m = maze.get_maze()
assert m is not None
assert numpy.array_equal(m, test) is True
def test_maze_str() -> None: def test_maze_str() -> None:
+1 -5
View File
@@ -1,5 +1,5 @@
import numpy import numpy
from amaz_lib.MazeGenerator import DepthFirstSearch, MazeGenerator from amaz_lib.MazeGenerator import DepthFirstSearch
class TestMazeGenerator: class TestMazeGenerator:
@@ -12,7 +12,3 @@ class TestMazeGenerator:
maze = output maze = output
assert maze.shape == w_h assert maze.shape == w_h
def test_gen_broken(self) -> None:
test = MazeGenerator.gen_broken_set(50, 50)
assert len(test) > 0
+17 -17
View File
@@ -4,71 +4,71 @@ import pytest
class TestParsing: class TestParsing:
def test_get_data_valid(self): def test_get_data_valid(self) -> None:
data = DataMaze.get_file_data("tests/test_txt/config_1.txt") data = DataMaze.get_file_data("tests/test_txt/config_1.txt")
assert isinstance(data, str) is True assert isinstance(data, str) is True
def test_file_error(self): def test_file_error(self) -> None:
with pytest.raises(FileNotFoundError): with pytest.raises(FileNotFoundError):
DataMaze.get_file_data("tete") DataMaze.get_file_data("tete")
# def test_permission_error(self): # def test_permission_error(self) -> None:
# with pytest.raises(PermissionError): # with pytest.raises(PermissionError):
# DataMaze.get_file_data("tests/test_txt/error_1.txt") # DataMaze.get_file_data("tests/test_txt/error_1.txt")
def test_empty_file_error(self): def test_empty_file_error(self) -> None:
with pytest.raises(ValueError): with pytest.raises(ValueError):
DataMaze.get_file_data("tests/test_txt/error_6.txt") DataMaze.get_file_data("tests/test_txt/error_6.txt")
def test_transform_data_valid(self): def test_transform_data_valid(self) -> None:
data = DataMaze.get_file_data("tests/test_txt/config_1.txt") data = DataMaze.get_file_data("tests/test_txt/config_1.txt")
data_2 = DataMaze.transform_data(data) data_2 = DataMaze.transform_data(data)
assert isinstance(data_2, dict) assert isinstance(data_2, dict)
def test_transform__index_error(self): def test_transform__index_error(self) -> None:
with pytest.raises(IndexError): with pytest.raises(IndexError):
DataMaze.transform_data("asdasdasdasdasdasda\nasdasdas=asdasd") DataMaze.transform_data("asdasdasdasdasdasda\nasdasdas=asdasd")
def test_key_data_error(self): def test_key_data_error(self) -> None:
with pytest.raises(KeyError): with pytest.raises(KeyError):
data = DataMaze.get_file_data("tests/test_txt/error_8.txt") data = DataMaze.get_file_data("tests/test_txt/error_8.txt")
data2 = DataMaze.transform_data(data) data2 = DataMaze.transform_data(data)
DataMaze.verif_key_data(data2) DataMaze.verif_key_data(data2)
def test_key_data_error_2(self): def test_key_data_error_2(self) -> None:
with pytest.raises(KeyError): with pytest.raises(KeyError):
data = DataMaze.get_file_data("tests/test_txt/error_9.txt") data = DataMaze.get_file_data("tests/test_txt/error_9.txt")
data2 = DataMaze.transform_data(data) data2 = DataMaze.transform_data(data)
DataMaze.verif_key_data(data2) DataMaze.verif_key_data(data2)
def test_convert_int(self): def test_convert_int(self) -> None:
with pytest.raises(ValueError): with pytest.raises(ValueError):
data = DataMaze.get_file_data("tests/test_txt/error_2.txt") data = DataMaze.get_file_data("tests/test_txt/error_2.txt")
data2 = DataMaze.transform_data(data) data2 = DataMaze.transform_data(data)
DataMaze.convert_values(data2) DataMaze.convert_values(data2)
def test_tuple_error(self): def test_tuple_error(self) -> None:
with pytest.raises(ValueError): with pytest.raises(ValueError):
DataMaze.convert_tuple("0,3,5,5") DataMaze.convert_tuple("0,3,5,5")
def test_tuple_error1(self): def test_tuple_error1(self) -> None:
with pytest.raises(AttributeError): with pytest.raises(AttributeError):
DataMaze.convert_tuple(None) DataMaze.convert_tuple("None")
def test_bool_error(self): def test_bool_error(self) -> None:
with pytest.raises(ValueError): with pytest.raises(ValueError):
DataMaze.convert_bool("Trueeee") DataMaze.convert_bool("Trueeee")
def test_valid_tuple(self): def test_valid_tuple(self) -> None:
assert DataMaze.convert_tuple("7534564654, 78") == (7534564654, 78) assert DataMaze.convert_tuple("7534564654, 78") == (7534564654, 78)
def test_valid_bool(self): def test_valid_bool(self) -> None:
assert DataMaze.convert_bool("False") is False assert DataMaze.convert_bool("False") is False
def test_valid_bool1(self): def test_valid_bool1(self) -> None:
assert DataMaze.convert_bool("True") is True assert DataMaze.convert_bool("True") is True
def test_data_maze(self): def test_data_maze(self) -> None:
data = DataMaze.get_data_maze("tests/test_txt/config_1.txt") data = DataMaze.get_data_maze("tests/test_txt/config_1.txt")
assert data["WIDTH"] == 200 assert data["WIDTH"] == 200
assert data["HEIGHT"] == 100 assert data["HEIGHT"] == 100
Generated
+1 -1
View File
@@ -9,7 +9,7 @@ resolution-markers = [
[[package]] [[package]]
name = "a-maze-ing" name = "a-maze-ing"
version = "0.1.0" version = "0.1.0"
source = { virtual = "." } source = { editable = "." }
dependencies = [ dependencies = [
{ name = "numpy", version = "2.2.6", source = { registry = "https://pypi.org/simple" }, marker = "python_full_version < '3.11'" }, { name = "numpy", version = "2.2.6", source = { registry = "https://pypi.org/simple" }, marker = "python_full_version < '3.11'" },
{ name = "numpy", version = "2.4.3", source = { registry = "https://pypi.org/simple" }, marker = "python_full_version >= '3.11'" }, { name = "numpy", version = "2.4.3", source = { registry = "https://pypi.org/simple" }, marker = "python_full_version >= '3.11'" },