Merge pull request #155 from GriceTurrble/chore/2024-03-py-scaffolded

chore: 2024 day 03 python scaffolded

2024/python/pyproject.toml

@@ -26,6 +26,7 @@ cli = "grice_py_aoc_2024.cli:cli"
 day01 = "grice_py_aoc_2024.day01.main:main"
 day02 = "grice_py_aoc_2024.day02.main:main"
 day03 = "grice_py_aoc_2024.day03.main:main"
+day04 = "grice_py_aoc_2024.day04.main:main"
 
 [tool.pytest.ini_options]
 addopts = "--verbose"

2024/python/src/grice_py_aoc_2024/cli.py

@@ -36,7 +36,8 @@ def _create_day_files(day: int) -> None:
     day_path.mkdir()
     (day_path / "__init__.py").touch()
     (day_path / "inputs.txt").touch()
-    (day_path / "test_inputs.txt").touch()
+    (day_path / "test_inputs_p1.txt").touch()
+    (day_path / "test_inputs_p2.txt").touch()
     _create_templates(day=day, path=day_path)
 
 

2024/python/src/grice_py_aoc_2024/day04/main.py

@@ -0,0 +1,32 @@
+from __future__ import annotations
+
+import time
+from pathlib import Path
+
+FILE = Path(__file__).parent / "inputs.txt"
+
+
+def part1(contents: str):
+    return "Not done yet!"
+
+
+def part2(contents: str):
+    return "Not done yet!"
+
+
+def main():
+    contents = FILE.read_text()
+
+    _start1 = time.perf_counter()
+    result1 = part1(contents)
+    _delta1 = time.perf_counter() - _start1
+    print(f">> Part 1: {result1} ({_delta1:.6f}s)")
+
+    _start2 = time.perf_counter()
+    result2 = part2(contents)
+    _delta2 = time.perf_counter() - _start2
+    print(f">> Part 2: {result2} ({_delta2:.6f}s)")
+
+
+if __name__ == "__main__":
+    main()

2024/python/src/grice_py_aoc_2024/day04/test_day04.py

@@ -0,0 +1,22 @@
+from __future__ import annotations
+
+from pathlib import Path
+
+from .main import part1, part2
+
+TEST_FILE_P1 = Path(__file__).parent / "test_inputs_p1.txt"
+TEST_FILE_P2 = Path(__file__).parent / "test_inputs_p2.txt"
+EXPECTED_PART_1 = "Now it's done!"
+EXPECTED_PART_2 = "Now it's done!"
+
+
+def test_part1():
+    contents = TEST_FILE_P1.read_text()
+    result = part1(contents)
+    assert result == EXPECTED_PART_1
+
+
+def test_part2():
+    contents = TEST_FILE_P2.read_text()
+    result = part2(contents)
+    assert result == EXPECTED_PART_2

2024/python/src/grice_py_aoc_2024/templates/main.py-tpl

@@ -1,33 +1,29 @@
 from __future__ import annotations
 
 import time
-import typing
 from pathlib import Path
 
-if typing.TYPE_CHECKING:
-    from io import TextIOWrapper
-
 FILE = Path(__file__).parent / "inputs.txt"
 
 
-def part1(inputs: TextIOWrapper):
+def part1(contents: str):
     return "Not done yet!"
 
 
-def part2(inputs: TextIOWrapper):
+def part2(contents: str):
     return "Not done yet!"
 
 
 def main():
+    contents = FILE.read_text()
+
     _start1 = time.perf_counter()
-    with open(FILE) as f:
-        result1 = part1(f)
+    result1 = part1(contents)
     _delta1 = time.perf_counter() - _start1
     print(f">> Part 1: {result1} ({_delta1:.6f}s)")
 
     _start2 = time.perf_counter()
-    with open(FILE) as f:
-        result2 = part2(f)
+    result2 = part2(contents)
     _delta2 = time.perf_counter() - _start2
     print(f">> Part 2: {result2} ({_delta2:.6f}s)")
 

2024/python/src/grice_py_aoc_2024/templates/test_day.py-tpl

@@ -4,18 +4,19 @@ from pathlib import Path
 
 from .main import part1, part2
 
-TEST_FILE = Path(__file__).parent / "test_inputs.txt"
-RESULT_PART_1 = "Now it's done!"
-RESULT_PART_2 = "Now it's done!"
+TEST_FILE_P1 = Path(__file__).parent / "test_inputs_p1.txt"
+TEST_FILE_P2 = Path(__file__).parent / "test_inputs_p2.txt"
+EXPECTED_PART_1 = "Now it's done!"
+EXPECTED_PART_2 = "Now it's done!"
 
 
 def test_part1():
-    with open(TEST_FILE) as f:
-        result = part1(f)
-    assert result == RESULT_PART_1
+    contents = TEST_FILE_P1.read_text()
+    result = part1(contents)
+    assert result == EXPECTED_PART_1
 
 
 def test_part2():
-    with open(TEST_FILE) as f:
-        result = part2(f)
-    assert result == RESULT_PART_2
+    contents = TEST_FILE_P2.read_text()
+    result = part2(contents)
+    assert result == EXPECTED_PART_2