scripts improvements

Author: rene-d

scripts/aoc.py

@@ -4,14 +4,45 @@
 
 import os
 import subprocess
+import sys
 from dataclasses import dataclass
 from pathlib import Path
 
 try:
     import click
 except ImportError:
     print("This script requires the « click » module.")
-    exit(1)
+
+    if "VIRTUAL_ENV" in os.environ:
+        print("VirtualEnv detected: try to install from PyPi...")
+        if os.system(f"{sys.executable} -mpip install click") != 0:
+            sys.exit(1)
+    elif sys.platform == "linux":
+        distro = "unknown"
+        r = Path("/etc/os-release")
+        if r.is_file():
+            for line in r.read_text("utf-8").splitlines():
+                if line.startswith("ID="):
+                    distro = line[3:].strip().strip('"').strip("'")
+                    break
+        if distro == "debian" or distro == "ubuntu":
+            print("Debian/Ubuntu detected: try to install packages...")
+            if os.system("sudo apt-get install -y python3-click") != 0:
+                sys.exit(1)
+        elif distro == "alpine":
+            print("Alpine detected: try to install packages...")
+            if os.system("sudo apk add --no-cache py3-click") != 0:
+                sys.exit(1)
+        elif distro == "fedora":
+            print("Fedora detected: try to install packages...")
+            if os.system("sudo dnf install -y python3-click") != 0:
+                sys.exit(1)
+        else:
+            sys.exit(0)
+    else:
+        sys.exit(1)
+
+    import click
 
 
 class AliasedGroup(click.Group):
@@ -61,6 +92,15 @@ def resolve_command(self, ctx, args):
         return cmd.name, cmd, args
 
 
+def get_cli_path():
+    if os.getuid() == 0:
+        # probably into a container
+        cli = Path("/usr/local/bin/aoc")
+    else:
+        cli = Path("~/.local/bin/aoc")
+    return cli
+
+
 @dataclass
 class AocProject:
     scripts_dir: Path
@@ -80,15 +120,8 @@ def pass_thru(self, tool: str, args: list, cwd=None):
 
 
 @click.group(
-    invoke_without_command=False,
-    cls=AliasedGroup.aliases(
-        {
-            "r": "run",
-            "p": "private-leaderboard",
-            "i": "inputs",
-            "in": "inputs",
-        }
-    ),
+    invoke_without_command=True,
+    cls=AliasedGroup.aliases({"r": "run", "p": "private-leaderboard", "i": "inputs", "in": "inputs"}),
 )
 @click.pass_context
 def aoc(ctx: click.Context):
@@ -103,6 +136,12 @@ def aoc(ctx: click.Context):
     if ctx.invoked_subcommand:
         return
 
+    if not get_cli_path().expanduser().is_file():
+        ctx.invoke(aoc_install)
+    else:
+        click.echo(ctx.get_help())
+        ctx.exit()
+
 
 @aoc.command(name="install")
 @click.pass_context
@@ -115,20 +154,13 @@ def aoc_install(ctx: click.Context):
     if f.is_symlink():
         raise click.ClickException("Launch command with the real file, not the symlink.")
 
-    if os.getuid() == 0:
-        # probably into a container
-        cli = Path("/usr/local/bin/aoc").expanduser()
-        cli.unlink(True)
-        cli.parent.mkdir(parents=True, exist_ok=True)
-        cli.symlink_to(f)
-        click.echo("Command aoc has been installed in /usr/local/bin .")
-
-    else:
-        cli = Path("~/.local/bin/aoc").expanduser()
-        cli.unlink(True)
-        cli.parent.mkdir(parents=True, exist_ok=True)
-        cli.symlink_to(f)
-        click.echo("Command aoc has been installed in ~/.local/bin .")
+    cli_path = get_cli_path()
+    cli = cli_path.expanduser()
+    if cli.exists():
+        cli.unlink()
+    cli.parent.mkdir(parents=True, exist_ok=True)
+    cli.symlink_to(f)
+    click.echo(f"Command aoc has been installed in {cli_path} .")
 
 
 @aoc.command(name="private-leaderboard")

scripts/lint_python.sh

@@ -4,5 +4,5 @@ set -eu
 
 isort -l120 --profile black .
 black -l120 .
-ruff check --ignore E501 . ${*-}
+ruff check . ${*-}
 # flake8 --max-line-length 120

scripts/timings.py

@@ -1,7 +1,9 @@
 #!/usr/bin/env python3
 
 import argparse
+import os
 import sqlite3
+import sys
 import time
 import typing as t
 from collections import defaultdict
@@ -10,11 +12,46 @@
 from pathlib import Path
 
 try:
+    import curtsies
     import tabulate
-    from curtsies import Input
 except ImportError:
     print("This script requires the « tabulate » and « curtsies » modules.")
-    exit(1)
+
+    if "VIRTUAL_ENV" in os.environ:
+        print("VirtualEnv detected: try to install from PyPi...")
+        if os.system(f"{sys.executable} -mpip install tabulate curtsies") != 0:
+            sys.exit(1)
+    elif sys.platform == "linux":
+        distro = "unknown"
+        r = Path("/etc/os-release")
+        if r.is_file():
+            for line in r.read_text(encoding="utf-8").splitlines():
+                if line.startswith("ID="):
+                    distro = line[3:].strip().strip('"').strip("'")
+                    break
+        if distro == "debian" or distro == "ubuntu":
+            print("Debian/Ubuntu detected: try to install packages...")
+            if os.system("sudo apt-get install -y python3-tabulate python3-curtsies") != 0:
+                sys.exit(1)
+        elif distro == "alpine":
+            print("Alpine detected: try to install packages...")
+            if os.system("sudo apk add --no-cache py3-tabulate") != 0:
+                sys.exit(1)
+        elif distro == "fedora":
+            print("Fedora detected: try to install packages...")
+            if os.system("sudo dnf install -y python3-tabulate python3-curtsies") != 0:
+                sys.exit(1)
+        else:
+            sys.exit(0)
+    else:
+        sys.exit(1)
+
+    import tabulate
+
+    try:
+        import curtsies
+    except ImportError:
+        curtsies = None
 
 
 T1 = 0.5
@@ -57,7 +94,8 @@ def aoc_available_puzzles(
     return puzzles
 
 
-def fmt_elapsed(elapsed: float, tablefmt) -> str:
+def fmt_elapsed(elapsed: float, _tablefmt) -> str:
+    """Format elapsed time with color-coded ANSI escape sequences based on duration thresholds."""
     if elapsed < T1:
         return f"\033[32m{elapsed:.3f}\033[0m"
     elif elapsed < T2:
@@ -70,37 +108,52 @@ def fmt_elapsed(elapsed: float, tablefmt) -> str:
 
 @dataclass
 class Stats:
+    """Container for timing statistics data including headers, table data, and solution timings."""
+
     headers: list
     data: dict
     solutions: dict
 
 
 class Timings:
+    """Manages and analyzes execution timing statistics for Advent of Code solutions."""
+
     def __init__(self, db: sqlite3.Connection):
         self.year_begin = min(aoc_available_puzzles())
         self.year_end = max(aoc_available_puzzles())
 
         self.user_inputs = defaultdict(set)
-        for key_input, hash in db.execute("select key,crc32 from inputs"):
+        for key_input, crc32 in db.execute("select key,crc32 from inputs"):
             year, day, user = key_input.split(":")
             year = int(year)
             day = int(day)
-            self.user_inputs[hash].add(user)
+            self.user_inputs[crc32].add(user)
 
         self.solutions = defaultdict(lambda: defaultdict(dict))
         for key_solution, elapsed, status in db.execute("select key,elapsed,status from solutions"):
             if status == "ok":
-                year, day, hash, binary, language = key_solution.split(":")
+                year, day, crc32, _binary, language = key_solution.split(":")
                 year = int(year)
                 day = int(day)
                 elapsed /= 1_000_000_000
 
                 # manage multiple solutions in different dayXX_xxx directories
                 day_sols = self.solutions[year, day][language]
-                other_elapsed = day_sols.get(hash, float("inf"))
-                day_sols[hash] = min(elapsed, other_elapsed)
+                other_elapsed = day_sols.get(crc32, float("inf"))
+                day_sols[crc32] = min(elapsed, other_elapsed)
 
     def get_stats(self, user: str, lang: str, tablefmt: str) -> Stats:
+        """
+        Compute and return execution timing statistics for a given user and language.
+
+        Args:
+            user: User identifier or aggregation mode ('mean', 'min', 'max', 'minmax')
+            lang: Programming language identifier
+            tablefmt: Table format for output formatting
+
+        Returns:
+            Stats object containing headers, data, and solutions timing information.
+        """
         stats = Stats(
             headers=["day"] + [i for i in range(self.year_begin, self.year_end + 1)],
             data=[[i] + [None] * (self.year_end - self.year_begin + 1) for i in range(1, 26)],
@@ -112,12 +165,12 @@ def get_stats(self, user: str, lang: str, tablefmt: str) -> Stats:
             min_elapsed = float("inf")
             max_elapsed = 0
             nb_elapsed = 0
-            for hash, elapsed in languages[lang].items():
+            for key_hash, elapsed in languages[lang].items():
                 if min_elapsed > elapsed:
                     min_elapsed = elapsed
                 if max_elapsed < elapsed:
                     max_elapsed = elapsed
-                if user in ("mean", "min", "max", "minmax") or user in self.user_inputs[hash]:
+                if user in ("mean", "min", "max", "minmax") or user in self.user_inputs[key_hash]:
                     total_elapsed += elapsed
                     nb_elapsed += 1
 
@@ -145,15 +198,16 @@ def get_stats(self, user: str, lang: str, tablefmt: str) -> Stats:
         return stats
 
     def print_stats(self, user: str, lang: str, tablefmt: str = "rounded_outline"):
+        """Print timing statistics in a formatted table with performance breakdown."""
         stats = self.get_stats(user, lang, tablefmt)
 
         print(tabulate.tabulate(stats.data, stats.headers, tablefmt, floatfmt=".3f"))
 
-        # Don't care of E731... lambda are elegant.
-        timing = lambda a, b: sum(1 for _ in filter(lambda x: a <= x < b, stats.solutions.values()))  # noqa
-        ids = lambda a, b: " ".join(
-            f"{y}:{d:<2}" for (y, d), v in sorted(stats.solutions.items()) if a <= v < b
-        )  # noqa
+        def timing(a, b):
+            return sum(1 for _ in filter(lambda x: a <= x < b, stats.solutions.values()))
+
+        def ids(a, b):
+            return " ".join(f"{y}:{d:<2}" for (y, d), v in sorted(stats.solutions.items()) if a <= v < b)
 
         inf = float("inf")
         print()
@@ -181,6 +235,7 @@ def print_stats(self, user: str, lang: str, tablefmt: str = "rounded_outline"):
 
 
 def main():
+    """Main entry point for the timings script. Parses command-line arguments and displays timing statistics."""
     parser = argparse.ArgumentParser()
     parser.add_argument("-u", "--user", help="User ID")
     parser.add_argument("-l", "--lang", default="Rust", help="Language")
@@ -206,6 +261,9 @@ def main():
         if not args.browse:
             timings.print_stats(args.user, args.lang)
 
+        elif curtsies is None:
+            print("Install the « curtsies » module.")
+
         else:
             sql = "select distinct key from inputs order by key"
             users = list(sorted(set(map(lambda row: row[0].split(":")[2], db.execute(sql)))))
@@ -246,7 +304,7 @@ def main():
                 print()
                 print("← → : switch user     ↓ ↑ : switch language")
 
-                with Input(keynames="curses") as input_generator:
+                with curtsies.Input(keynames="curses") as input_generator:
                     for e in input_generator:
                         if e in ("q", "Q", "x", "X", "\033"):
                             done = True