Update templates

Author: sanderploegsma

2023/python/aoc_2023/scripts/generator.py

@@ -12,30 +12,28 @@
 OUTPUT_DIR = os.path.join(SCRIPT_DIR, "..")
 
 
-def generate(day: str) -> None:
+def generate(**kwargs) -> None:
     env = Environment(autoescape=False, optimized=False)
 
     def generate_file(template_name: str, output_name: str):
         with open(os.path.join(TEMPLATE_DIR, template_name), "r", encoding="utf-8") as f:
             template = env.from_string(f.read())
 
         with open(os.path.join(OUTPUT_DIR, output_name), "x", encoding="utf-8") as f:
-            template.stream(day=day).dump(f)
+            template.stream(**kwargs).dump(f)
 
+    day = kwargs["day"]
     generate_file("input.txt.j2", f"day{day}.txt")
     generate_file("solution.py.j2", f"day{day}.py")
     generate_file("test.py.j2", f"day{day}_test.py")
 
 
 def main():
-    if len(sys.argv) < 2:
-        print("Please supply a day number")
+    if len(sys.argv) < 3:
+        print("Usage: generate <day> <title of puzzle>")
         exit(1)
 
-    day = int(sys.argv[1])
-    day_padded = f"{day:02}"
-
-    generate(day_padded)
+    generate(day=f"{int(sys.argv[1]):02}", title=sys.argv[2])
 
 
 if __name__ == "__main__":

2023/python/aoc_2023/scripts/templates/solution.py.j2

@@ -1,18 +1,21 @@
-"""Advent of Code 2023 - Day {{ day }}."""
+"""Advent of Code 2023, Day {{ day }}: {{ title}}."""
 
 import sys
 from typing import TextIO
 
 
 def part_one(file: TextIO) -> int:
+    """Solve part one of the puzzle."""
     return -1
 
 
 def part_two(file: TextIO) -> int:
+    """Solve part two of the puzzle."""
     return -1
 
 
 def main():
+    """The main entrypoint for the script."""
     filename = sys.argv[0].replace(".py", ".txt")
 
     with open(filename, encoding="utf-8") as file:
@@ -24,3 +27,4 @@ def main():
 
 if __name__ == "__main__":
     main()
+

2023/python/aoc_2023/scripts/templates/test.py.j2

@@ -1,6 +1,7 @@
-"""Advent of Code 2023 - Day {{ day }}."""
+"""Advent of Code 2023, Day {{ day }}: {{ title }}."""
 
 import io
+from typing import TextIO
 
 import pytest
 
@@ -12,13 +13,16 @@ EXAMPLE = """\
 
 
 @pytest.fixture()
-def example():
+def example() -> TextIO:
     return io.StringIO(EXAMPLE)
 
 
-def test_part_one(example):
+def test_part_one(example: TextIO) -> None:
+    """Test that checks if the solution for part one works on the example input."""
     assert part_one(example) == 42
 
 
-def test_part_two(example):
+def test_part_two(example: TextIO) -> None:
+    """Test that checks if the solution for part two works on the example input."""
     assert part_two(example) == 42
+