Fixup board_randomizer typehints

Invalid `list[str]` type hints were causing errors in the downstream Boggler Flask app
This commit is contained in:
2024-06-14 10:31:17 -04:00
parent e183ce07c0
commit a611f4a7e7
+11 -5
View File
@@ -1,8 +1,14 @@
"""Module to generate random Boggle boards for testing""" """Module to generate random Boggle boards for testing"""
from sys import argv, stderr from sys import argv, stderr
from random import randint, shuffle from random import randint, shuffle
from math import sqrt, floor from math import sqrt, floor
from pathlib import Path from pathlib import Path
from typing import List, TypeAlias
Die: TypeAlias = List[str]
Dice: TypeAlias = List[Die]
def read_dice_file(dice_path: Path): def read_dice_file(dice_path: Path):
@@ -11,17 +17,17 @@ def read_dice_file(dice_path: Path):
return [line.rstrip().split(",") for line in file.readlines() if line[0] != "#"] return [line.rstrip().split(",") for line in file.readlines() if line[0] != "#"]
def roll_die(die: str): def roll_die(die: Die):
"""Return a face of the given die string to simulate rolling a die""" """Return a face of the given die string to simulate rolling a die"""
return str(die[randint(0, len(die) - 1)]) return str(die[randint(0, len(die) - 1)])
def roll_dice(dice: list[str]): def roll_dice(dice: Dice):
"""Return a random roll for each die""" """Return a random roll for each die"""
return [roll_die(die) for die in dice] return [roll_die(die) for die in dice]
def get_random_board(dice: list[str]): def get_random_board(dice: Dice):
shuffle(dice) shuffle(dice)
rolls = roll_dice(dice) rolls = roll_dice(dice)
@@ -33,7 +39,7 @@ def get_random_board(dice: list[str]):
return board return board
def get_random_board_csv(dice: list[str]): def get_random_board_csv(dice: Dice):
board = get_random_board(dice) board = get_random_board(dice)
board = [",".join(row) for row in board] board = [",".join(row) for row in board]
return board return board
@@ -49,4 +55,4 @@ if __name__ == "__main__":
for r in range(0, int(floor(sqrt(len(dice))))): for r in range(0, int(floor(sqrt(len(dice))))):
print(board[r]) print(board[r])
except Exception as e: except Exception as e:
print("Argument must be a valid file path!", file=stderr) print("Argument must be a valid file path.", file=stderr)