25 Commits

Author SHA1 Message Date
da7e 0bd43d21a5 remove con.txt 2026-04-07 11:17:45 +02:00
Maoake Teriierooiterai f5131f0e01 finish the norm 2026-04-06 18:17:45 +02:00
da7e 4d5662c248 lowercase key in config.txt allow 2026-04-04 21:22:39 +02:00
da7e e137389216 Some fix:
- entry/exit negatif
- checker if output file already exist
- config.txt commentary
- maze min size for ft logo generation
- unperfect maze compliance
2026-04-04 21:18:42 +02:00
da7e 21e9aba95f docstring to output file function 2026-04-03 18:34:18 +02:00
da7e 9fa121cdce add export file 2026-04-03 18:30:52 +02:00
da7e 04c28a851f fix Astar solver 2026-04-03 17:59:37 +02:00
da7e 6189d7f321 lint fix 2026-04-03 16:48:51 +02:00
da7e e63c2679a6 Remove test prints 2026-04-03 16:44:49 +02:00
da7e f04381568d wheel file + config 2026-04-03 16:12:36 +02:00
da7e ee4f48a5c0 add limit for height and width 2026-04-03 15:42:20 +02:00
da7e 2532a35e30 add mazegen wheel package 2026-04-03 15:10:17 +02:00
da7e 6f503bdd36 add file format checker for parsing 2026-04-03 15:00:08 +02:00
da7e 5022cfe020 add message when ft logo not display 2026-04-03 14:47:34 +02:00
Maoake Teriierooiterai 11947db62f fix the print on 42 in the maze 2026-04-03 14:20:01 +02:00
da7e 0045def73b SEED implementation 2026-04-03 13:58:41 +02:00
Maoake Teriierooiterai b6067b2045 finish the thing 2026-04-03 12:30:42 +02:00
Maoake Teriierooiterai 9c76914366 makefile update 2026-04-03 11:45:38 +02:00
Maoake Teriierooiterai b38da3fc31 need to verify everything on each files scan every line every pixel cause i like pixel its pretty beautiful 2026-04-03 11:36:40 +02:00
da7e b54e49122c README 2026-04-02 14:15:40 +02:00
maoake 53316f4e32 need to be merge 2026-04-02 12:36:10 +02:00
maoake 732cf25a57 trying a README 2026-04-01 23:20:11 +02:00
maoake 4c1955ace4 changing the import for mypy test 2026-04-01 23:00:08 +02:00
maoake 3e85cbe919 doing again the wheel 2026-04-01 22:41:11 +02:00
maoake 2edf61affa doing the wheel 2026-04-01 22:31:08 +02:00
22 changed files with 813 additions and 112 deletions
-2
View File
@@ -215,5 +215,3 @@ __marimo__/
# Streamlit
.streamlit/secrets.toml
test.txt
mazegen-1.0.0-py3-none-any.whl
+10 -6
View File
@@ -13,23 +13,27 @@ run_windows:
.venv\Scripts\python -m a_maze_ing config.txt
debug:
uv pdb python3 a_maze_ing.py config.txt
uv run python3 -m pdb a_maze_ing.py config.txt
clean:
rm -rf */**/__pycache__ __pycache__ .mypy_cache .venv dist build */**/*.egg-info *.egg-info test.txt
rm -rf */**/__pycache__ */__pycache__ __pycache__ */.mypy_cache .mypy_cache .venv dist build */**/*.egg-info */*.egg-info *.egg-info test.txt
fclean: clean
rm mazegen-1.0.0-py3-none-any.whl
lint:
lint: install
uv run flake8 . --exclude=.venv
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 -p mazegen
uv run env PYTHONPATH=src python3 -m mypy --warn-return-any --warn-unused-ignores --ignore-missing-imports --disallow-untyped-defs --check-untyped-defs -p parsing
uv run env PYTHONPATH=src python3 -m mypy --warn-return-any --warn-unused-ignores --ignore-missing-imports --disallow-untyped-defs --check-untyped-defs src/AMazeIng.py
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: install
uv run flake8 . --exclude=.venv
uv run env PYTHONPATH=src python3 -m mypy --strict src
uv run env PYTHONPATH=src python3 -m mypy --strict -p mazegen
uv run env PYTHONPATH=src python3 -m mypy --strict src/AMazeIng.py
uv run env PYTHONPATH=src python3 -m mypy --strict -p parsing
uv run env PYTHONPATH=src python3 -m mypy --strict tests
uv run env PYTHONPATH=src python3 -m mypy --strict a_maze_ing.py
+614 -2
View File
@@ -1,3 +1,615 @@
The Randomized Kruskal's Algorithm
This project has been created as part of the 42 curriculum by *mteriier*, *dgaillet*
The Randomized Prim's Algorithm
# A-Maze-ing
## Description
A-Maze-ing is a Python project that generates, solves, exports, and displays mazes.
The program:
- reads a configuration file,
- generates a maze according to the requested parameters,
- optionally enforces a **perfect maze** property,
- solves the maze from entry to exit,
- writes the maze to an output file using the required hexadecimal wall encoding,
- and displays the maze visually through an **MLX graphical window**.
This project was designed with **code reusability** in mind.
The maze generation and solving logic is exposed through a reusable Python package named **`mazegen`**, which can be built and installed independently for use in future projects.
---
## Features
- Maze generation from a config file
- Multiple generation algorithms:
- `DFS` (depth-first search / recursive backtracking style)
- `Kruskal`
- Multiple solving algorithms:
- `AStar`
- `DFS`
- Perfect and imperfect maze support
- Maze export using hexadecimal wall encoding
- Graphical rendering with MLX
- Animated generation
- Animated solution path display
- Wall color switching
- Reserved visual **“42” pattern** using fully closed cells when the maze is large enough
- Reusable `mazegen` package
---
## Project Structure
```text
.
├── a_maze_ing.py # Main executable script and MLX display
├── config.txt # Default configuration file
├── Makefile
├── README.md
├── src/
│ ├── AMazeIng.py
│ ├── mazegen/
│ │ ├── __init__.py
│ │ ├── Cell.py
│ │ ├── Maze.py
│ │ ├── MazeGenerator.py
│ │ └── MazeSolver.py
│ └── parsing/
│ └── Parsing.py
└── tests/
```
---
## Instructions
### Requirements
- Python **3.10+**
- `uv`, `pip`
- MLX Python binding used by the project
### Installation
Using the provided `Makefile`:
```bash
make install
```
This installs project dependencies and the MLX wheel used by the graphical display.
---
## Run
```bash
make run
```
---
## Debug
```bash
make debug
```
---
## Lint
Mandatory lint target:
```bash
make lint
```
Strict lint target:
```bash
make lint-strict
```
---
## Clean
```bash
make clean
```
Full cleanup:
```bash
make fclean
```
---
## Configuration File Format
The configuration file contains one `KEY=VALUE` pair per line.
### Mandatory keys
| Key | Description | Example |
|---|---|---|
| `WIDTH` | Maze width in cells | `WIDTH=20` |
| `HEIGHT` | Maze height in cells | `HEIGHT=15` |
| `ENTRY` | Entry coordinates `(x,y)` | `ENTRY=1,1` |
| `EXIT` | Exit coordinates `(x,y)` | `EXIT=20,15` |
| `OUTPUT_FILE` | Output filename | `OUTPUT_FILE=maze.txt` |
| `PERFECT` | Perfect maze or not | `PERFECT=True` |
| `GENERATOR` | Generation algorithm | `GENERATOR=DFS` |
| `SOLVER` | Solving algorithm | `SOLVER=AStar` |
### Supported values
#### GENERATOR
- `DFS`
- `Kruskal`
#### SOLVER
- `AStar`
- `DFS`
#### PERFECT
- `True`
- `False`
### Example config
```ini
WIDTH=20
HEIGHT=15
ENTRY=1,1
EXIT=20,15
OUTPUT_FILE=maze.txt
PERFECT=True
GENERATOR=DFS
SOLVER=AStar
SEED=31766516
```
### Notes
- Coordinates are handled as tuples in the form `x,y`.
- In the current implementation, coordinates are expected to be **inside maze bounds**.
- Entry and exit must be valid cells.
- The parser validates required keys and converts values to the correct Python types.
- You can add a `SEED` value
---
## Output File Format
The generated maze is written row by row using **one hexadecimal digit per cell**.
Each cell stores wall information using this bitmask:
| Bit | Direction |
|---|---|
| `1` | North |
| `2` | East |
| `4` | South |
| `8` | West |
A bit set to `1` means the wall is **closed**.
### Example
- `3` = `0011` → north and east closed
- `A` = `1010` → east and west closed
### Output layout
```text
<maze row 1>
<maze row 2>
...
<maze row n>
<entry coordinates>
<exit coordinates>
<solution path>
```
Example:
```text
FFFF
9A63
8C47
FFFF
1,1
4,4
EESSEN
```
---
## Visual Representation
This project provides a graphical rendering through **MLX**.
The display shows:
- maze walls,
- entry cell,
- exit cell,
- optional shortest path,
- reserved “42” pattern when present.
### Controls
In the MLX window:
- `1` / mapped equivalent: regenerate maze
- `2` / mapped equivalent: show/hide path
- `3` / mapped equivalent: change wall color
- `4` / mapped equivalent: quit
The code includes two key mappings to handle platform/layout differences.
### Visual Features
- animated generation,
- animated path display,
- color cycling for walls,
- separate color cycling for the “42” cells.
---
## Maze Generation Algorithm
This project supports two generation algorithms.
### 1. Depth-First Search (DFS)
This algorithm starts from a cell and repeatedly visits an unvisited neighbour, removing walls as it advances. When it reaches a dead end, it backtracks until it finds a cell with an unvisited neighbour.
#### Why this algorithm was chosen
- simple to implement,
- naturally produces connected mazes,
- works well for animation,
- produces visually interesting long corridors,
- easy to adapt for perfect mazes.
### 2. Kruskal
This algorithm treats each cell as its own set and removes walls between cells only when it connects two different sets. This avoids cycles and guarantees connectivity.
#### Why this algorithm was included
- classic maze generation algorithm,
- good complement to DFS,
- demonstrates modularity and algorithm interchangeability,
- naturally fits the reusable package requirement.
---
## Why These Algorithms Were Chosen
We chose DFS and Kruskal because together they provide:
- two well-known and complementary approaches,
- good pedagogical value,
- simple integration into a reusable class-based architecture,
- deterministic structure when used with a seed,
- compatibility with perfect maze generation.
DFS is particularly suitable for progressive visual rendering.
Kruskal is useful to show a different construction logic based on set merging.
---
## Perfect and Imperfect Mazes
When `PERFECT=True`:
- the maze is generated as a **perfect maze**,
- there is exactly one path between any two reachable cells,
- in particular, entry and exit have a unique valid path.
When `PERFECT=False`:
- additional walls may be removed after initial generation,
- loops can appear,
- the maze remains connected,
- the solver still computes a valid path.
---
## The “42” Pattern
For sufficiently large mazes, the generator reserves a group of fully closed cells to draw a visible **“42”** pattern in the visual rendering.
### Behaviour
- the pattern is added only if the maze is large enough,
- if the maze is too small, the pattern may be omitted,
- this should be reported to the user with a console message.
### Current implementation note
The current code includes support for reserving and rendering the “42” pattern using cells with value `15` (all walls closed).
The pattern is drawn in the central area when dimensions are large enough.
---
## Error Handling
The project is designed to fail gracefully and provide clear messages for common problems such as:
- missing configuration file,
- empty file,
- missing or invalid keys,
- invalid boolean values,
- invalid coordinates,
- invalid maze dimensions,
- solving an uninitialized maze.
The parser catches several common exceptions and prints user-friendly messages before exiting.
---
## Reusable Code
The reusable part of the project is the **`mazegen`** package.
It contains:
- `Cell`: wall bitmask representation,
- `Maze`: maze container and textual/ascii rendering,
- `MazeGenerator`: abstract generator interface,
- `DepthFirstSearch`: DFS-based maze generator,
- `Kruskal`: Kruskal-based maze generator,
- `MazeSolver`: abstract solver interface,
- `AStar`: shortest-path solver,
- `DepthFirstSearchSolver`: DFS-based path solver.
This package can be built as a wheel and reused independently of the MLX application.
---
## How to Use the Reusable Module
### Basic example
```python
from mazegen import Maze
from mazegen import DepthFirstSearch, AStar
generator = DepthFirstSearch(start=(1, 1), end=(10, 10), perfect=True)
solver = AStar(start=(1, 1), end=(10, 10))
maze = Maze()
for grid in generator.generator(height=10, width=10, seed=42):
maze.set_maze(grid)
path = solver.solve(maze, height=10, width=10)
print(maze)
print(path)
```
### With Kruskal
```python
from mazegen import Maze, Kruskal, AStar
generator = Kruskal(start=(1, 1), end=(20, 15), perfect=True)
solver = AStar(start=(1, 1), end=(20, 15))
maze = Maze()
for grid in generator.generator(height=15, width=20, seed=123):
maze.set_maze(grid)
print(solver.solve(maze, height=15, width=20))
```
### Accessing the generated structure
```python
maze_array = maze.get_maze()
```
Each element of `maze_array` is a `Cell` object exposing:
- `get_north()`
- `get_est()`
- `get_south()`
- `get_west()`
- `get_value()`
### Accessing a solution
```python
solution = solver.solve(maze, height=15, width=20)
print(solution) # Example: "EESSWN..."
```
---
## Packaging
The reusable package is distributed as **`mazegen-*`**.
Example expected artifact:
```text
mazegen-1.0.0-py3-none-any.whl
```
Build with:
```bash
make build
```
This produces a wheel suitable for later installation with `pip`/`uv`.
---
## Tests
Unit tests are recommended and partially integrated through `pytest` targets in the Makefile.
Start test with:
```bash
make run_test
```
These tests are useful to validate:
- parsing,
- generation,
- solver behavior,
- edge cases.
---
## Technical Choices
### Language
- Python 3.10+
### Libraries
- `numpy` for grid storage
- `pydantic` for model validation
- `mlx` for graphical rendering
- `pytest` for tests
- `mypy` for static typing
- `flake8` for style checking
### Architecture
The project is separated into three main parts:
1. **Main application**
- parsing,
- orchestration,
- MLX rendering,
- user interaction.
2. **Domain model**
- `AMazeIng`,
- maze configuration and lifecycle.
3. **Reusable package**
- generation,
- solving,
- maze structure.
This separation makes the generation logic portable to other projects.
---
## Team and Project Management
### Team roles
- **mteriier**
- Parsing
- DFS generator / solver
- Makefile
- some pytest
- Fix of mazegen package generation
- MLX
- **dgaillet**
- AMazeIng config class
- AStar solver
- Kruskal generator
- some pytest
- mazegen package generation
- MLX
- Cell / Maze class
### Initial planning
Our initial plan was:
1. define the maze data model,
2. implement one working generation algorithm,
3. export the maze to the required format,
4. implement solving,
5. add graphical rendering,
6. package reusable code,
7. write tests and documentation.
### How planning evolved
In practice:
- the reusable package structure had to be stabilized earlier than expected,
- coordinate handling between parser, generator, solver, and renderer required extra work,
- rendering and animation took longer than planned,
- algorithm modularity made later integration easier.
### What worked well
- clean separation between generation and display,
- abstract base classes for generator and solver,
- Makefile automation,
- packaging the reusable module.
### What could be improved
- stricter normalization of coordinate conventions,
- seed support should be exposed directly from configuration,
- more tests for edge cases and invalid inputs,
### Tools used
- Git
- `uv`
- `flake8`
- `mypy`
- `pytest`
- MLX
- optionally AI assistance for docstrings, README
---
## Resources
### Documentation and references
- [NumPy Documentation](https://numpy.org/doc/)
- [Pydantic Documentation](https://docs.pydantic.dev/)
- [A* Pathfinding explanation](https://matteo-tosato7.medium.com/exploring-the-depths-solving-mazes-with-a-search-algorithm-c15253104899)
- [Kruskal generation](https://medium.com/@anushidesilva28/understanding-kruskals-algorithm-44886bf8ba8b)
### How AI was used
AI was used as an assistant for:
- improving docstrings,
- helping structure the README,
---
## Reusable Module Summary
If you only want the reusable maze engine:
1. build/install `mazegen`,
2. import a generator and a solver,
3. generate a maze,
4. solve it,
5. access the grid through `Maze.get_maze()`.
This part is intended for reuse in future Python projects.
+6 -6
View File
@@ -1,7 +1,8 @@
import os
from typing import Any
from numpy.typing import NDArray
from src.AMazeIng import AMazeIng
from src.parsing.Parsing import DataMaze as Parsing
from AMazeIng import AMazeIng
from parsing.Parsing import DataMaze as Parsing
from mlx import Mlx
import time
@@ -224,7 +225,6 @@ class MazeMLX:
progressively.
"""
path = amazing.solve_path()
print(path)
actual = amazing.entry
actual = (actual[0] - 1, actual[1] - 1)
maze = amazing.maze.get_maze()
@@ -483,12 +483,12 @@ def main() -> None:
"""Run the maze application."""
mlx = None
try:
mlx = MazeMLX(1000, 1000)
os.system("cls" if os.name == "nt" else "clear")
config = Parsing.get_data_maze("config.txt")
amazing = AMazeIng(**config)
mlx = MazeMLX(1600, 2000)
mlx.start(amazing)
with open("test.txt", "w") as output:
output.write(amazing.__str__())
amazing.export_maze()
except Exception as err:
print(err)
finally:
+8 -8
View File
@@ -1,8 +1,8 @@
WIDTH=10
HEIGHT=10
ENTRY=1,1
EXIT=10,10
OUTPUT_FILE=maze.txt
PERFECT=True
GENERATOR=Kruskal
SOLVER=AStar
WIDTH=15
HEIGHT=15
ENTRY=2,1
EXIT=3,5
OUTPUT_FILE=con.txt
PERFECT=False
GENERATOR=DFS
Solver=AStar
Binary file not shown.
+5 -2
View File
@@ -1,5 +1,5 @@
[project]
name = "A-Maze-ing"
name = "mazegen"
version = "0.1.0"
description = "This is the way"
readme = "README.md"
@@ -30,5 +30,8 @@ requires = ["setuptools>=78.1.0", "wheel>=0.45.1"]
build-backend = "setuptools.build_meta"
[tool.setuptools]
package-dir = {"" = "src/amaz_lib"}
package-dir = {"" = "src"}
[tool.setuptools.packages.find]
where = ["src"]
+20 -4
View File
@@ -2,7 +2,7 @@ from typing import Generator
from typing_extensions import Self
from pydantic import BaseModel, Field, model_validator, ConfigDict
from .amaz_lib import Maze, MazeGenerator, MazeSolver
from mazegen import Maze, MazeGenerator, MazeSolver
class AMazeIng(BaseModel):
@@ -12,8 +12,8 @@ class AMazeIng(BaseModel):
model_config = ConfigDict(arbitrary_types_allowed=True)
width: int = Field(ge=4)
height: int = Field(ge=4)
width: int = Field(ge=5, le=100)
height: int = Field(ge=5, le=100)
entry: tuple[int, int]
exit: tuple[int, int]
output_file: str = Field(min_length=3)
@@ -21,6 +21,7 @@ class AMazeIng(BaseModel):
maze: Maze = Field(default=Maze(None))
generator: MazeGenerator
solver: MazeSolver
seed: int | None = Field(default=None)
@model_validator(mode="after")
def check_entry_exit(self) -> Self:
@@ -36,6 +37,14 @@ class AMazeIng(BaseModel):
raise ValueError("Entry coordinates exceed the maze size")
if self.exit[0] > self.width or self.exit[1] > self.height:
raise ValueError("Exit coordinates exceed the maze size")
if self.entry == self.exit:
raise ValueError("Entry and Exit coordinates cant be the same")
if self.exit[0] < 1 or self.exit[1] < 1:
raise ValueError("Exit coordinates to low")
if self.entry[0] < 1 or self.entry[1] < 1:
raise ValueError("Entry coordinates to low")
if self.width < 9 or self.height < 7:
print("Height or width to low for disply forty two logo")
return self
def generate(self) -> Generator[Maze, None, None]:
@@ -46,7 +55,9 @@ class AMazeIng(BaseModel):
Yields:
The current maze state after each generation step.
"""
for array in self.generator.generator(self.height, self.width):
for array in self.generator.generator(
self.height, self.width, self.seed
):
self.maze.set_maze(array)
yield self.maze
return
@@ -59,6 +70,11 @@ class AMazeIng(BaseModel):
"""
return self.solver.solve(self.maze, self.height, self.width)
def export_maze(self) -> None:
"""Export maze, entry, exit and resolved path in output_file"""
with open(self.output_file, "w") as file:
file.write(self.__str__())
def __str__(self) -> str:
"""Return a string representation of the maze and its solution.
-18
View File
@@ -1,18 +0,0 @@
from .Cell import Cell
from .Maze import Maze
from .MazeGenerator import MazeGenerator, DepthFirstSearch
from .MazeGenerator import Kruskal
from .MazeSolver import MazeSolver, AStar, DepthFirstSearchSolver
__version__ = "1.0.0"
__author__ = "us"
__all__ = [
"Cell",
"Maze",
"MazeGenerator",
"DepthFirstSearchSolver",
"MazeSolver",
"AStar",
"Kruskal",
"DepthFirstSearch",
]
@@ -2,7 +2,7 @@ from abc import ABC, abstractmethod
from typing import Generator, Any
import numpy as np
from numpy.typing import NDArray
from .Cell import Cell
from mazegen.Cell import Cell
import math
import random
@@ -20,8 +20,8 @@ class MazeGenerator(ABC):
end: Ending cell coordinates, using 1-based indexing.
perfect: Whether to generate a perfect maze with no loops.
"""
self.start = (start[0] - 1, start[1] - 1)
self.end = (end[0] - 1, end[1] - 1)
self.start = (start[1] - 1, start[0] - 1)
self.end = (end[1] - 1, end[0] - 1)
self.perfect = perfect
@abstractmethod
@@ -105,10 +105,24 @@ class MazeGenerator(ABC):
The modified maze.
"""
def enough_wall(cell: Cell) -> bool:
nb_wall = 0
if cell.get_est():
nb_wall += 1
if cell.get_north():
nb_wall += 1
if cell.get_west():
nb_wall += 1
if cell.get_south():
nb_wall += 1
if nb_wall == 3:
return True
return False
directions = {"N": (0, -1), "S": (0, 1), "W": (-1, 0), "E": (1, 0)}
reverse = {"N": "S", "S": "N", "W": "E", "E": "W"}
min_break = 2
min_break = 1
while True:
count = 0
for y in range(height):
@@ -125,7 +139,9 @@ class MazeGenerator(ABC):
continue
if direc in ["S", "E"]:
continue
if np.random.random() < prob:
if not enough_wall(maze[y][x]):
continue
else:
count += 1
cell = maze[y][x]
cell_n = maze[ny][nx]
@@ -137,7 +153,7 @@ class MazeGenerator(ABC):
maze[y][x] = cell
maze[ny][nx] = cell_n
yield maze
if count > min_break:
if count >= min_break:
break
return maze
@@ -292,9 +308,13 @@ class Kruskal(MazeGenerator):
The final generated maze.
"""
cells_ft = None
if height > 10 and width > 10:
if height >= 7 and width >= 9:
cells_ft = self.get_cell_ft(width, height)
if cells_ft and (self.start in cells_ft or self.end in cells_ft):
print(
"Forty two will not be display. "
"Entry or exit set in the ft logo"
)
cells_ft = None
if seed is not None:
@@ -324,7 +344,6 @@ class Kruskal(MazeGenerator):
len(sets.sets) == 19 and cells_ft is not None
):
break
print(f"nb sets: {len(sets.sets)}")
maze = self.walls_to_maze(walls, height, width)
if self.perfect is False:
gen = Kruskal.unperfect_maze(width, height, maze, cells_ft)
@@ -347,8 +366,8 @@ class DepthFirstSearch(MazeGenerator):
end: Ending cell coordinates, using 1-based indexing.
perfect: Whether to generate a perfect maze with no loops.
"""
self.start = (start[0] - 1, start[1] - 1)
self.end = (end[0] - 1, end[1] - 1)
self.start = (start[1] - 1, start[0] - 1)
self.end = (end[1] - 1, end[0] - 1)
self.perfect = perfect
self.forty_two: set[tuple[int, int]] | None = None
@@ -369,9 +388,9 @@ class DepthFirstSearch(MazeGenerator):
The final generated maze.
"""
if seed is not None:
np.random.seed(seed)
random.seed(seed)
maze = self.init_maze(width, height)
if width > 9 and height > 9:
if width >= 9 and height >= 7:
self.forty_two = self.get_cell_ft(width, height)
visited: NDArray[np.object_] = np.zeros((height, width), dtype=bool)
if (
@@ -380,6 +399,11 @@ class DepthFirstSearch(MazeGenerator):
and self.end not in self.forty_two
):
visited = self.lock_cell_ft(visited, self.forty_two)
else:
print(
"Forty two will not be display. "
"Entry or exit set in the ft logo"
)
path: list[tuple[int, int]] = list()
w_h = (width, height)
coord = (0, 0)
@@ -84,7 +84,8 @@ class AStar(MazeSolver):
start: Start coordinates using 1-based indexing.
end: End coordinates using 1-based indexing.
"""
super().__init__(start, end)
self.start = (start[0] - 1, start[1] - 1)
self.end = (end[0] - 1, end[1] - 1)
def h(self, n: tuple[int, int]) -> int:
"""Compute the Manhattan distance heuristic to the goal.
@@ -196,6 +197,8 @@ class AStar(MazeSolver):
to_check,
)
)
if path == self.end:
break
raise Exception("Path not found")
def get_rev_dir(self, current: Node) -> str:
+18
View File
@@ -0,0 +1,18 @@
from mazegen.Cell import Cell
from mazegen.Maze import Maze
from mazegen.MazeGenerator import MazeGenerator, DepthFirstSearch
from mazegen.MazeGenerator import Kruskal
from mazegen.MazeSolver import MazeSolver, AStar, DepthFirstSearchSolver
__version__ = "1.0.0"
__author__ = "us"
__all__ = [
"Cell",
"Maze",
"MazeGenerator",
"DepthFirstSearchSolver",
"MazeSolver",
"AStar",
"Kruskal",
"DepthFirstSearch",
]
+53 -12
View File
@@ -1,11 +1,27 @@
from ..amaz_lib import DepthFirstSearch, Kruskal
from ..amaz_lib import AStar, DepthFirstSearchSolver
from mazegen import DepthFirstSearch, Kruskal
from mazegen import AStar, DepthFirstSearchSolver
from typing import Any
class DataMaze:
"""Provide helper methods to load and validate maze configuration data."""
@staticmethod
def test_output_file(name_file: str) -> None:
try:
with open(name_file, "r"):
while True:
res = input(
f"{name_file} already exist. Data will"
" be erased. Continue ? (y/n)"
)
if res == "y":
break
elif res == "n":
raise Exception("")
except FileNotFoundError:
return
@staticmethod
def get_file_data(name_file: str) -> str:
"""Read and return the contents of a configuration file.
@@ -38,8 +54,12 @@ class DataMaze:
A dictionary mapping configuration keys to their string values.
"""
tmp = data.split("\n")
tmp2 = [value.split("=", 1) for value in tmp if "=" in value]
data_t = {value[0]: value[1] for value in tmp2}
tmp2 = [
value.split("=", 1)
for value in tmp
if not value.startswith("#") and "=" in value
]
data_t = {value[0].upper(): value[1] for value in tmp2}
return data_t
@staticmethod
@@ -62,14 +82,14 @@ class DataMaze:
"GENERATOR",
"SOLVER",
}
set_key = {key for key in data.keys()}
if len(set_key) != len(key_test):
raise KeyError("Missing some data the len do not correspond")
res_key = {key for key in set_key if key not in key_test}
if len(res_key) != 0:
raise KeyError(
"Some Key " f"do not correspond the keys: {res_key}"
)
i = 0
for key in data:
if key.upper() == "OUTPUT_FILE":
DataMaze.test_output_file(data[key])
if key in key_test:
i += 1
if len(key_test) != i:
raise Exception("Some mandatory key not provide")
@staticmethod
def convert_values(data: dict[str, str]) -> dict[str, Any]:
@@ -88,6 +108,10 @@ class DataMaze:
res: dict[str, Any] = {}
for key in key_int:
res.update({key: int(data[key])})
try:
res.update({"SEED": int(data["SEED"])})
except KeyError:
pass
for key in key_tuple:
res.update({key: DataMaze.convert_tuple(data[key])})
for key in key_bool:
@@ -181,6 +205,22 @@ class DataMaze:
return True
return False
@staticmethod
def test_file_format(file: str) -> None:
with open(file) as data_str:
for line in data_str:
if line.startswith("#"):
continue
if len(line.split("=", 1)) != 2:
raise Exception(
"config file format not respected. excpected format : "
"KEY=VALUE"
)
if not line.split("=", 1)[1] or line.split("=", 1)[1] == "\n":
raise Exception(
f"VALUE not provide for {line.split('=')[0]} key"
)
@staticmethod
def get_data_maze(name_file: str) -> dict[str, Any]:
"""Load, validate, and convert maze configuration data from a file.
@@ -192,6 +232,7 @@ class DataMaze:
A dictionary of validated configuration values with lowercase keys.
"""
try:
DataMaze.test_file_format(name_file)
data_str = DataMaze.get_file_data(name_file)
data_dict = DataMaze.transform_data(data_str)
DataMaze.verif_key_data(data_dict)
+1 -1
View File
@@ -1,4 +1,4 @@
from amaz_lib.Cell import Cell
from mazegen import Cell
def test_cell_setter_getter() -> None:
+2 -2
View File
@@ -1,5 +1,5 @@
from amaz_lib.MazeGenerator import DepthFirstSearch
from amaz_lib.Cell import Cell
from mazegen import DepthFirstSearch
from mazegen import Cell
import numpy as np
+2 -2
View File
@@ -1,6 +1,6 @@
import numpy
from amaz_lib.Cell import Cell
from amaz_lib.Maze import Maze
from mazegen import Cell
from mazegen import Maze
def test_maze_setter_getter() -> None:
+1 -1
View File
@@ -1,5 +1,5 @@
import numpy
from amaz_lib.MazeGenerator import DepthFirstSearch
from mazegen import DepthFirstSearch
class TestMazeGenerator:
+2 -2
View File
@@ -1,6 +1,6 @@
from amaz_lib.Cell import Cell
from mazegen import Cell
import numpy as np
from amaz_lib import AStar, Maze
from mazegen import AStar, Maze
def test_solver() -> None:
Generated
+30 -30
View File
@@ -6,36 +6,6 @@ resolution-markers = [
"python_full_version < '3.11'",
]
[[package]]
name = "a-maze-ing"
version = "0.1.0"
source = { editable = "." }
dependencies = [
{ 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 = "pydantic" },
]
[package.dev-dependencies]
dev = [
{ name = "flake8" },
{ name = "mypy" },
{ name = "pytest" },
]
[package.metadata]
requires-dist = [
{ name = "numpy", specifier = ">=2.2.6" },
{ name = "pydantic", specifier = ">=2.12.5" },
]
[package.metadata.requires-dev]
dev = [
{ name = "flake8", specifier = ">=7.3.0" },
{ name = "mypy", specifier = ">=1.19.1" },
{ name = "pytest", specifier = ">=9.0.2" },
]
[[package]]
name = "annotated-types"
version = "0.7.0"
@@ -174,6 +144,36 @@ wheels = [
{ url = "https://files.pythonhosted.org/packages/b2/c8/d148e041732d631fc76036f8b30fae4e77b027a1e95b7a84bb522481a940/librt-0.8.1-cp314-cp314t-win_arm64.whl", hash = "sha256:bf512a71a23504ed08103a13c941f763db13fb11177beb3d9244c98c29fb4a61", size = 48755, upload-time = "2026-02-17T16:12:47.943Z" },
]
[[package]]
name = "mazegen"
version = "0.1.0"
source = { editable = "." }
dependencies = [
{ 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 = "pydantic" },
]
[package.dev-dependencies]
dev = [
{ name = "flake8" },
{ name = "mypy" },
{ name = "pytest" },
]
[package.metadata]
requires-dist = [
{ name = "numpy", specifier = ">=2.2.6" },
{ name = "pydantic", specifier = ">=2.12.5" },
]
[package.metadata.requires-dev]
dev = [
{ name = "flake8", specifier = ">=7.3.0" },
{ name = "mypy", specifier = ">=1.19.1" },
{ name = "pytest", specifier = ">=9.0.2" },
]
[[package]]
name = "mccabe"
version = "0.7.0"