Merge pull request #365 from realpython/python-maze-solver

Maze Solver SbSp: Materials

Author: KateFinegan

python-maze-solver/README.md

@@ -0,0 +1,33 @@
+# Build a Maze Solver in Python Using Graphs
+
+This is the code for the Real Python tutorial [Build a Maze Solver in Python Using Graphs](https://realpython.com/python-maze-solver/).
+
+## Installation
+
+The code requires Python 3.10 or later and depends on the NetworkX library. You can install the project into an active virtual environment by issuing the following command from the project root folder:
+
+```sh
+(venv) $ python -m pip install .
+```
+
+For development, consider installing the code in editable mode:
+
+```sh
+(venv) $ python -m pip install --editable .
+```
+
+## Running
+
+To run the maze solver, use the `solve` command and provide the path to a maze file:
+
+```sh
+$ solve /path/to/labyrinth.maze
+```
+
+Alternatively, you can use the more explicit yet equivalent command:
+
+```sh
+$ python -m maze_solver /path/to/labyrinth.maze
+```
+
+If the command succeeds, then you should see either a rendered solution in your default web browser or a relevant error message in the console.

python-maze-solver/mazes/impossible.maze

@@ -0,0 +1,38 @@
+# fmt: off
+# flake8: noqa
+from pathlib import Path
+
+from maze_solver.models.border import Border
+from maze_solver.models.maze import Maze
+from maze_solver.models.role import Role
+from maze_solver.models.square import Square
+
+
+def main() -> None:
+    build_maze().dump(Path(__file__).with_suffix(".maze"))
+
+
+def build_maze() -> Maze:
+    return Maze(
+        squares=(
+            Square(0, 0, 0, Border.EMPTY, Role.EXTERIOR),
+            Square(1, 0, 1, Border.TOP | Border.LEFT),
+            Square(2, 0, 2, Border.TOP | Border.BOTTOM),
+            Square(3, 0, 3, Border.TOP | Border.RIGHT),
+            Square(4, 0, 4, Border.BOTTOM | Border.LEFT, Role.EXTERIOR),
+            Square(5, 1, 0, Border.TOP | Border.BOTTOM | Border.RIGHT, Role.EXIT),
+            Square(6, 1, 1, Border.LEFT | Border.RIGHT),
+            Square(7, 1, 2, Border.TOP | Border.BOTTOM | Border.LEFT | Border.RIGHT, Role.WALL),
+            Square(8, 1, 3, Border.LEFT),
+            Square(9, 1, 4, Border.TOP | Border.BOTTOM, Role.ENTRANCE),
+            Square(10, 2, 0, Border.TOP | Border.RIGHT, Role.EXTERIOR),
+            Square(11, 2, 1, Border.BOTTOM | Border.LEFT),
+            Square(12, 2, 2, Border.TOP | Border.BOTTOM),
+            Square(13, 2, 3, Border.BOTTOM | Border.RIGHT),
+            Square(14, 2, 4, Border.TOP | Border.LEFT, Role.EXTERIOR),
+        )
+    )
+
+
+if __name__ == '__main__':
+    main()

python-maze-solver/mazes/impossible.py

@@ -0,0 +1,35 @@
+# fmt: off
+# flake8: noqa
+from pathlib import Path
+
+from maze_solver.models.border import Border
+from maze_solver.models.maze import Maze
+from maze_solver.models.role import Role
+from maze_solver.models.square import Square
+
+
+def main() -> None:
+    build_maze().dump(Path(__file__).with_suffix(".maze"))
+
+
+def build_maze() -> Maze:
+    return Maze(
+        squares=(
+            Square(0, 0, 0, Border.TOP | Border.LEFT),
+            Square(1, 0, 1, Border.TOP | Border.RIGHT),
+            Square(2, 0, 2, Border.LEFT | Border.RIGHT, role=Role.EXIT),
+            Square(3, 0, 3, Border.TOP | Border.LEFT | Border.RIGHT),
+            Square(4, 1, 0, Border.BOTTOM | Border.LEFT | Border.RIGHT),
+            Square(5, 1, 1, Border.LEFT | Border.RIGHT),
+            Square(6, 1, 2, Border.BOTTOM | Border.LEFT),
+            Square(7, 1, 3, Border.RIGHT),
+            Square(8, 2, 0, Border.TOP | Border.LEFT, role=Role.ENTRANCE),
+            Square(9, 2, 1, Border.BOTTOM),
+            Square(10, 2, 2, Border.TOP | Border.BOTTOM),
+            Square(11, 2, 3, Border.BOTTOM | Border.RIGHT),
+        )
+    )
+
+
+if __name__ == '__main__':
+    main()