Merge branch 'master' into python-del-statement

Author: KateFinegan

python-input-integer/README.md

@@ -0,0 +1,5 @@
+# How to Read Python Input as Integers
+
+Here you can find code examples for the tutorial [How to Read Python Input as Integers](https://realpython.com/python-input-integer/).
+
+The file [`number_input.py`](number_input.py) contains the `get_integer()` function discussed in the tutorial plus some other utility functions for numeric input.

python-input-integer/number_input.py

@@ -0,0 +1,78 @@
+"""Utility functions for prompting users for numeric input.
+
+This file accompanies the Real Python tutorial How To Read User Input As
+Integers. It contains examples of functions that filter user input for valid
+integers and floats.
+"""
+
+
+def get_integer(prompt: str, error_message: str = None) -> int:
+    """Prompts the user for an integer value.
+
+    If the input is invalid, prints error_message (if specified) and then
+    repeats the prompt.
+    """
+    while True:
+        try:
+            return int(input(prompt))
+        except ValueError:
+            if error_message:
+                print(error_message)
+
+
+def get_float(prompt: str, error_message: str = None) -> float:
+    """Prompts the user for a float value.
+
+    If the input is invalid, prints error_message (if specified) and then
+    repeats the prompt.
+    """
+    while True:
+        try:
+            return float(input(prompt))
+        except ValueError:
+            if error_message:
+                print(error_message)
+
+
+def get_integer_with_default(
+    prompt: str, default_value: int, error_message: str = None
+) -> int:
+    """Prompts the user for an integer, and falls back to a default value.
+
+    If the input is an empty string, then the function returns default_value.
+    Otherwise, if the input is not a valid integer, prints error_message (if
+    specified) and then repeats the prompt.
+    """
+    while True:
+        input_string = input(prompt)
+        if not input_string:
+            return default_value
+        try:
+            return int(input_string)
+        except ValueError:
+            if error_message:
+                print(error_message)
+
+
+if __name__ == "__main__":
+    # Test functions when running as a script.
+    print(get_integer("Test get_integer(): "))
+    print(
+        get_integer(
+            "Test get_integer() with an error message: ",
+            error_message="Invalid integer!",
+        )
+    )
+    print(
+        get_float(
+            "Test get_float() with an error message: ",
+            error_message="Invalid float!",
+        )
+    )
+    print(
+        get_integer_with_default(
+            "Test get_integer_with_default(): ",
+            default_value=99,
+            error_message="That's not a valid integer!",
+        )
+    )

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()