refactor utility functions

Author: rene-d

README.md

@@ -35,12 +35,12 @@ Calendar | Solutions | Stars | Rust | Python | 🎁
 [Advent of Code 2024](https://adventofcode.com/2024) | [Solutions](src/year2024/README.md) |  50⭐ |  25 |  11 |   3
 [Advent of Code 2023](https://adventofcode.com/2023) | [Solutions](src/year2023/README.md) |  50⭐ |  25 |  10 |   2
 [Advent of Code 2022](https://adventofcode.com/2022) | [Solutions](src/year2022/README.md) |  50⭐ |  25 |  18 |   1
-[Advent of Code 2021](https://adventofcode.com/2021) | [Solutions](src/year2021/README.md) |  50⭐ |  25 |  11 |
-[Advent of Code 2020](https://adventofcode.com/2020) | [Solutions](src/year2020/README.md) |  50⭐ |  25 |  23 |
+[Advent of Code 2021](https://adventofcode.com/2021) | [Solutions](src/year2021/README.md) |  50⭐ |  25 |  11 |    
+[Advent of Code 2020](https://adventofcode.com/2020) | [Solutions](src/year2020/README.md) |  50⭐ |  25 |  23 |    
 [Advent of Code 2019](https://adventofcode.com/2019) | [Solutions](src/year2019/README.md) |  50⭐ |  25 |  23 |   2
 [Advent of Code 2018](https://adventofcode.com/2018) | [Solutions](src/year2018/README.md) |  50⭐ |  25 |   4 |   1
-[Advent of Code 2017](https://adventofcode.com/2017) | [Solutions](src/year2017/README.md) |  50⭐ |  25 |  17 |
-[Advent of Code 2016](https://adventofcode.com/2016) | [Solutions](src/year2016/README.md) |  50⭐ |  25 |   0 |
+[Advent of Code 2017](https://adventofcode.com/2017) | [Solutions](src/year2017/README.md) |  50⭐ |  25 |  17 |    
+[Advent of Code 2016](https://adventofcode.com/2016) | [Solutions](src/year2016/README.md) |  50⭐ |  25 |   0 |    
 [Advent of Code 2015](https://adventofcode.com/2015) | [Solutions](src/year2015/README.md) |  50⭐ |  25 |   5 |   1
 
 ## Bonus 🎁

scripts/answers.py

@@ -16,19 +16,15 @@
 
 import requests
 
+# ---------
+
 
 @lru_cache(maxsize=None)
-def aoc_available_puzzles(
-    year: int | None = None, seconds: float | None = None
-) -> t.Union[dict[int, list[int]], list[int]]:
+def aoc_available_puzzles_dict(seconds: float | None = None) -> dict[int, list[int]]:
     """
-    Returns a dict of available puzzles by year or the list of available puzzles for the given year.
+    Returns a dict of available puzzles by year.
     """
 
-    if year is not None:
-        years = aoc_available_puzzles(seconds=seconds)
-        return years.get(year, [])
-
     now = time.gmtime(seconds)
 
     # available years
@@ -45,13 +41,63 @@ def aoc_available_puzzles(
             last_day = now.tm_mday - 1 if now.tm_hour < 5 else now.tm_mday
         else:
             last_day = 25
-        last_day = min(last_day, 25 if year <= 2024 else 12)
+        last_day = min(last_day, aoc_puzzles_by_year(year))
 
         puzzles[year] = list(range(1, last_day + 1))
 
     return puzzles
 
 
+def aoc_puzzles_by_year(year: int) -> int:
+    """
+    Returns the maximum number of puzzles for the given year.
+    """
+    if 2015 <= year <= 2024:
+        return 25
+    if year >= 2025:
+        return 12
+    return 0
+
+
+def aoc_nb_answers(year: int, day: int) -> int:
+    """
+    Returns the number of answers.
+    """
+    if 1 <= day < aoc_puzzles_by_year(year):
+        return 2
+    elif day == aoc_puzzles_by_year(year):
+        return 1
+    else:
+        return 0
+
+
+def aoc_available_years():
+    """
+    Generator over all available years.
+    """
+    for year in aoc_available_puzzles_dict():
+        yield year
+
+
+def aoc_available_days(year: int):
+    """
+    Generator over all available days for the given year.
+    """
+    for year in aoc_available_puzzles_dict().get(year, []):
+        yield year
+
+
+def aoc_available_puzzles(filter_year: int = 0):
+    for year, days in aoc_available_puzzles_dict().items():
+        if filter_year is not None and filter_year != 0 and filter_year != year:
+            continue
+        for day in days:
+            yield year, day
+
+
+# ---------
+
+
 class AocSession:
     last_submit_time = 0  # submissions must be at least 5 seconds apart
     rootdir = Path(__file__).parent.parent
@@ -165,11 +211,11 @@ def is_available(year, day):
     def iter_all(func, b=None):
         def wrapper(self, year=None, day=None, *args, **kwargs):
             if year is None:
-                for year in aoc_available_puzzles():
+                for year in aoc_available_years():
                     wrapper(self, year, day)
             elif day is None:
                 # iterate over every days
-                for day in aoc_available_puzzles(year):
+                for day in aoc_available_days(year):
                     wrapper(self, year, day)
             elif day == 0:
                 # special case to iterate only on years
@@ -431,7 +477,7 @@ def print_stars(self, year=None, day=None):
     def print_stars_year(self, year=None):
         @AocSession.iter_all
         def iterate(self, year, day):
-            nb_stars = sum(self.get_stars(year, day) for day in aoc_available_puzzles(year))
+            nb_stars = sum(self.get_stars(year, day) for day in aoc_available_days(year))
             print(f"{self.prefix} Stars for {year}: {nb_stars:2}⭐")
 
         iterate(self, year, 0)
@@ -530,7 +576,7 @@ def make_readme(args):
     def readme(self, year, _day):
         puzzles = []
         now = datetime.now(UTC)
-        for day in aoc_available_puzzles(year):
+        for day in aoc_available_days(year):
             available_date = datetime(year, 12, day, 5, 0, 0, 0, tzinfo=UTC)
             if available_date > now:
                 continue
@@ -599,7 +645,7 @@ def make_readme_main(args):
     @AocSession.iter_all
     def parse(self, year, _day):
         now = datetime.now(UTC)
-        for day in aoc_available_puzzles(year):
+        for day in aoc_available_days(year):
             available_date = datetime(year, 12, day, 5, 0, 0, 0, tzinfo=UTC)
             if available_date > now:
                 continue
@@ -639,7 +685,7 @@ def parse(self, year, _day):
     total_rust = sum(rust.values())
     total_python = sum(python.values())
     total_stars = sum(all_stars.values())
-    current_calendar = max(aoc_available_puzzles())
+    current_calendar = max(aoc_available_years())
 
     rows = []
     for year in sorted(all_stars.keys(), reverse=True):

scripts/inputs.py

@@ -2,7 +2,6 @@
 
 import argparse
 import time
-import typing as t
 from collections import Counter
 from functools import lru_cache
 from pathlib import Path
@@ -25,18 +24,15 @@
 CLEAR_EOL = "\033[0K"
 
 
+# ---------
+
+
 @lru_cache(maxsize=None)
-def aoc_available_puzzles(
-    year: int | None = None, seconds: float | None = None
-) -> t.Union[dict[int, list[int]], list[int]]:
+def aoc_available_puzzles_dict(seconds: float | None = None) -> dict[int, list[int]]:
     """
-    Returns a dict of available puzzles by year or the list of available puzzles for the given year.
+    Returns a dict of available puzzles by year.
     """
 
-    if year is not None:
-        years = aoc_available_puzzles(seconds=seconds)
-        return years.get(year, [])
-
     now = time.gmtime(seconds)
 
     # available years
@@ -53,21 +49,63 @@ def aoc_available_puzzles(
             last_day = now.tm_mday - 1 if now.tm_hour < 5 else now.tm_mday
         else:
             last_day = 25
-        last_day = min(last_day, 25 if year <= 2024 else 12)
+        last_day = min(last_day, aoc_puzzles_by_year(year))
 
         puzzles[year] = list(range(1, last_day + 1))
 
     return puzzles
 
 
 def aoc_puzzles_by_year(year: int) -> int:
+    """
+    Returns the maximum number of puzzles for the given year.
+    """
     if 2015 <= year <= 2024:
         return 25
     if year >= 2025:
         return 12
     return 0
 
 
+def aoc_nb_answers(year: int, day: int) -> int:
+    """
+    Returns the number of answers.
+    """
+    if 1 <= day < aoc_puzzles_by_year(year):
+        return 2
+    elif day == aoc_puzzles_by_year(year):
+        return 1
+    else:
+        return 0
+
+
+def aoc_available_years():
+    """
+    Generator over all available years.
+    """
+    for year in aoc_available_puzzles_dict():
+        yield year
+
+
+def aoc_available_days(year: int):
+    """
+    Generator over all available days for the given year.
+    """
+    for year in aoc_available_puzzles_dict().get(year, []):
+        yield year
+
+
+def aoc_available_puzzles(filter_year: int = 0):
+    for year, days in aoc_available_puzzles_dict().items():
+        if filter_year is not None and filter_year != 0 and filter_year != year:
+            continue
+        for day in days:
+            yield year, day
+
+
+# ---------
+
+
 def transpose(m):
     rows = range(len(m))
     cols = range(len(m[0]))
@@ -88,14 +126,14 @@ def transpose(m):
 datadir = Path(__file__).parent.parent / "data"
 
 data = []
-for year in aoc_available_puzzles():
+for year in aoc_available_years():
     values = []
 
     min_inputs = float("inf")
     max_inputs = 0
     nb_inputs = 0
 
-    available_days = aoc_available_puzzles(year)
+    available_days = aoc_available_days(year)
 
     for day in range(1, 26):
         if day > aoc_puzzles_by_year(year):
@@ -158,7 +196,7 @@ def transpose(m):
 print(
     tabulate.tabulate(
         data,
-        headers=["Day"] + [year for year in aoc_available_puzzles()],
+        headers=["Day"] + [year for year in aoc_available_years()],
         stralign="right",
         tablefmt="rounded_outline",
     )