MAINT: Cleaner design

pyproject.toml

@@ -5,7 +5,7 @@ description = "File oriented ASV benchmark comparer"
 authors = [
     {name = "Rohit Goswami", email = "[email protected]"},
 ]
-dependencies = ["asv @ git+https://github.com/airspeed-velocity/asv/", "click>=8.1.8", "asv-runner>=0.2.1", "polars>=1.20.0"]
+dependencies = ["asv @ git+https://github.com/airspeed-velocity/asv/", "click>=8.1.8", "asv-runner>=0.2.1", "polars>=1.20.0", "rich-click>=1.8.5"]
 requires-python = ">=3.12"
 readme = "README.md"
 license = {text = "MIT"}

src/asv_spyglass/_asv_ro.py

@@ -1,8 +1,6 @@
 import itertools
-import json
 import re
 from pathlib import Path
-from typing import Iterator, Union
 
 from asv.util import load_json as asv_json_load
 
@@ -14,19 +12,21 @@ class ReadOnlyASVBenchmarks:
 
     api_version = 2
 
-    def __init__(self, benchmarks_file: Path, regex: Union[str, list[str]] = None):
+    def __init__(self, benchmarks_file: Path, regex: str | list[str] = None):
         """
         Initialize and load benchmarks from a JSON file, optionally filtering them.
 
         Args:
             benchmarks_file (Path): Path to the benchmarks JSON file.
-            regex (Union[str, list[str]], optional): Regular expression(s) to filter benchmarks.
-                Defaults to None (all benchmarks included).
+            regex (Union[str, list[str]], optional): Regular expression(s) to
+                filter benchmarks.  Defaults to None (all benchmarks included).
         """
         d = asv_json_load(getstrform(benchmarks_file), api_version=self.api_version)
         self._base_benchmarks = {}  # Store all benchmarks here
         self._benchmark_selection = {}  # Track selected parameter combinations
-        self.filtered_benchmarks = {}  # Store selected benchmarks here after parameter expansion
+        self.filtered_benchmarks = (
+            {}
+        )  # Store selected benchmarks here after parameter expansion
 
         if not regex:
             regex = []

src/asv_spyglass/_num.py

@@ -0,0 +1,90 @@
+import math
+from dataclasses import dataclass
+
+
+@dataclass
+class BenchNum:
+    val: float
+    err: float | None
+    unit: str | None
+
+
+class Ratio:
+    """
+    Represents the ratio between two numeric values (t2 / t1), handling
+    potential issues like division by zero, NaN, and None values. It also
+    supports marking a ratio as insignificant.
+
+    Attributes:
+        _t1 (float | None): The first value (denominator).
+        _t2 (float | None): The second value (numerator).
+        val (float): The calculated ratio, which can be:
+            - The actual ratio if both _t1 and _t2 are valid numbers and _t1 is
+              not zero.
+            - math.inf if either _t1 or _t2 is None or NaN, or if _t1 is zero.
+        is_insignificant (bool): A flag indicating whether the ratio should be
+            considered statistically insignificant. Defaults to False.
+
+    Methods:
+        __init__(self, t1: float | None, t2: float | None):
+            Initializes a Ratio object, calculating the ratio if possible.
+
+        __repr__(self):
+            Returns a string representation of the ratio:
+            - "n/a" if the ratio is undefined (val is math.inf).
+            - "~" followed by the formatted ratio if is_insignificant is True.
+            - A formatted string with 2 decimal places otherwise.
+
+        _is_invalid(self, t1, t2):
+            A private helper method to check if the inputs are invalid for ratio
+            calculation.
+    """
+
+    def __init__(self, t1: float | None, t2: float | None):
+        """
+        Initializes a Ratio object.
+
+        Args:
+            t1 (float | None): The first value (denominator).
+            t2 (float | None): The second value (numerator).
+        """
+        self._t1 = t1
+        self._t2 = t2
+        self.is_insignificant = False
+        self.val = None
+
+        if self._is_invalid(t1, t2):
+            self.val = math.inf
+        else:
+            try:
+                self.val = t2 / t1
+            except ZeroDivisionError:
+                self.val = math.inf
+
+    def __repr__(self):
+        """
+        Returns a string representation of the ratio.
+
+        If val is math.inf, returns "n/a".
+        If is_insignificant is True, returns "~" followed by the formatted ratio.
+        Otherwise, returns the ratio formatted to 2 decimal places.
+        """
+        if self.val == math.inf:
+            return "n/a"
+        elif self.is_insignificant:
+            return "~" + f"{self.val:6.2f}".strip()
+        else:
+            return f"{self.val:6.2f}"
+
+    def _is_invalid(self, t1, t2):
+        """
+        Checks if the inputs are invalid for ratio calculation.
+
+        Args:
+            t1 (float | None): The first value.
+            t2 (float | None): The second value.
+
+        Returns:
+            bool: True if either t1 or t2 is None or NaN, False otherwise.
+        """
+        return t1 is None or t2 is None or math.isnan(t1) or math.isnan(t2)

src/asv_spyglass/changes.py

@@ -0,0 +1,95 @@
+import enum
+from dataclasses import dataclass
+
+
+class ResultColor(enum.StrEnum):
+    DEFAULT = "white"
+    GREEN = enum.auto()
+    RED = enum.auto()
+    LIGHTGREY = "light_grey"
+
+
+class ResultMark(enum.StrEnum):
+    BETTER = "-"
+    WORSE = "+"
+    FAILURE = "!"
+    FIXED = "*"
+    INCOMPARABLE = "x"
+    UNCHANGED = " "
+    INSIGNIFICANT = "~"
+
+
+class AfterIs(enum.Enum):
+    LUKEWARM = 0
+    WORSE = -1
+    BETTER = 1
+
+
+@dataclass
+class ASVChangeInfo:
+    mark: ResultMark
+    color: ResultColor
+    description: str
+    state: AfterIs
+    before: str
+    after: str
+
+
+@dataclass
+class Incomparable(ASVChangeInfo):
+    mark: ResultMark = ResultMark.INCOMPARABLE
+    color: ResultColor = ResultColor.LIGHTGREY
+    description: str = "Not comparable"
+    state: AfterIs = AfterIs.LUKEWARM
+    before: str = ""
+    after: str = ""
+
+
+@dataclass
+class Failure(ASVChangeInfo):
+    mark: ResultMark = ResultMark.FAILURE
+    color: ResultColor = ResultColor.RED
+    description: str = "Introduced a failure"
+    state: AfterIs = AfterIs.WORSE
+    before: str = "Succeeded"
+    after: str = "Failed"
+
+
+@dataclass
+class Fixed(ASVChangeInfo):
+    mark: ResultMark = ResultMark.FIXED
+    color: ResultColor = ResultColor.GREEN
+    description: str = "Fixed a failure"
+    state: AfterIs = AfterIs.BETTER
+    before: str = "Failed"
+    after: str = "Succeeded"
+
+
+@dataclass
+class NoChange(ASVChangeInfo):
+    mark: ResultMark = ResultMark.UNCHANGED
+    color: ResultColor = ResultColor.DEFAULT
+    description: str = "Both failed or either was skipped or no significant change"
+    state: AfterIs = AfterIs.LUKEWARM
+    before: str = ""
+    after: str = ""
+
+
+@dataclass
+class Better(ASVChangeInfo):
+    mark: ResultMark = ResultMark.BETTER
+    color: ResultColor = ResultColor.GREEN
+    description: str = "Relative improvement"
+    state: AfterIs = AfterIs.BETTER
+    before: str = "Worse"
+    after: str = "Better"
+
+
+@dataclass
+class Worse(ASVChangeInfo):
+    mark: ResultMark = ResultMark.WORSE
+    color: ResultColor = ResultColor.RED
+    description: str = "Relatively worse"
+    state: AfterIs = AfterIs.WORSE
+    before: str = "Better"
+    after: str = "Worse"