refactor(tox): add tox action to github workflows and make sure that project passes all tox tests

required eliminating some "newer" features such as `X
Y` unions and match-case blocks

Author: Karl Wooster

.github/workflows/tox_check.yml

@@ -0,0 +1,28 @@
+name: Tox Check
+
+on: [push, pull_request]
+
+jobs:
+  tox:
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install libjpeg-dev (used for Pillow library)
+        run: sudo apt-get install libjpeg-dev
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          version: 0.6.12
+
+      - name: Install Python using uv
+        run: uv python install
+
+      - name: Install Packages using uv
+        run: uv sync --all-groups --all-extras
+
+      - name: Run Tox
+        run: uv run tox

README.md

@@ -34,7 +34,7 @@ A program to annotate YNAB transactions with Amazon order info
      ```bash
      # Basic installation (without AI features)
      uv sync
-     
+
      # Installation with AI features
      uv sync --extra ai
      ```

src/ynamazon/amazon/models.py

@@ -3,7 +3,7 @@
 import datetime as dt
 import uuid
 from decimal import Decimal
-from typing import Annotated, Any
+from typing import Annotated, Any, Union
 
 from amazonorders.session import AmazonSession
 from amazonorders.transactions import AmazonTransactions
@@ -27,12 +27,12 @@ class Entity(BaseClone, abc.ABC):
 class Item(Entity):
     title: str
     link: HttpUrl
-    price: Decimal | None = None
-    seller: AmazonSellerType | None = None
-    condition: str | None = None
-    return_eligible_date: dt.date | None = None
-    image_link: HttpUrl | None = None
-    quantity: int | None = None
+    price: Union[Decimal, None] = None
+    seller: Union[AmazonSellerType, None] = None
+    condition: Union[str, None] = None
+    return_eligible_date: Union[dt.date, None] = None
+    image_link: Union[HttpUrl, None] = None
+    quantity: Union[int, None] = None
 
     def __str__(self) -> str:
         if settings.ynab_use_markdown:
@@ -59,15 +59,15 @@ def address_from_str(cls, data: Any) -> Any:
 
 class Recipient(Entity):
     name: str
-    address: Address | None = Field(
+    address: Union[Address, None] = Field(
         repr=False, default=None, description="not parsed properly, don't use"
     )
 
 
 class Shipment(Entity):
     items: list[Item]
-    delivery_status: str | None = None
-    tracking_link: HttpUrl | None = None
+    delivery_status: Union[str, None] = None
+    tracking_link: Union[HttpUrl, None] = None
 
 
 class Order(Entity):
@@ -77,24 +77,24 @@ class Order(Entity):
     shipments: list[Shipment]
     items: list[Item]
     order_number: str
-    order_details_link: HttpUrl | None = None
+    order_details_link: Union[HttpUrl, None] = None
     grand_total: Decimal
     order_placed_date: dt.date
-    recipient: Recipient | None = None
-    payment_method: str | None = None
-    payment_method_last_4: str | None = None
-    total_before_tax: Decimal | None = None
+    recipient: Union[Recipient, None] = None
+    payment_method: Union[str, None] = None
+    payment_method_last_4: Union[str, None] = None
+    total_before_tax: Union[Decimal, None] = None
 
 
 class Orders(SimpleDict[str, Order]):
     @classmethod
     def get_order_history(
         cls,
         config: AmazonConfig,
-        session: AmazonSession | None = None,
-        years: list[int] | int | None = None,
+        session: Union[AmazonSession, None] = None,
+        years: Union[list[int], Union[int, None]] = None,
         *,
-        debug: bool | None = None,
+        debug: Union[bool, None] = None,
     ):
         from ynamazon.amazon_transactions import (
             _fetch_amazon_order_history,  # pyright: ignore[reportPrivateUsage]
@@ -121,14 +121,18 @@ class Transaction(Entity):
     order_number: str
     order_details_link: HttpUrl
     seller_name: Annotated[str, Field(alias="seller")]
-    order: Order | None = None
+    order: Union[Order, None] = None
 
     def match_order(self, orders: Orders) -> None:
         """Matches the transaction with the order."""
         self.order = orders.get(self.order_number)
 
     def getattr_path(
-        self, attr_path: str, *, separator: str = "__", default: Any | Missing = MISSING
+        self,
+        attr_path: str,
+        *,
+        separator: str = "__",
+        default: Union[Any, Missing] = MISSING,
     ) -> Any:
         return getattr_path(self, attr_path, separator=separator, default=default)
 

src/ynamazon/amazon_transactions.py

@@ -78,7 +78,7 @@ class AmazonConfig(BaseModel):
     config: AmazonOrdersConfig = Field(default_factory=lambda: AmazonOrdersConfig())
     debug: bool = False
 
-    def amazon_session(self, *, debug: bool | None = None) -> AmazonSession:
+    def amazon_session(self, *, debug: Union[bool, None] = None) -> AmazonSession:
         """Creates an Amazon session."""
         logger.debug(f"Creating Amazon session for {self.username}")
         return AmazonSession(
@@ -137,7 +137,7 @@ def _fetch_amazon_order_history(
     session: AmazonSession,
     years: Union[Sequence[Union[int, str]], Union[int, str], None] = None,
     debug: bool = False,
-    config: AmazonOrdersConfig | None = None,
+    config: Union[AmazonOrdersConfig, None] = None,
 ) -> list[Order]:
     """Returns a list of Amazon orders.
 
@@ -175,7 +175,7 @@ def _fetch_sorted_amazon_transactions(
     amazon_session: AmazonSession,
     transaction_days: int = 31,
     debug: bool = False,
-    config: AmazonOrdersConfig | None = None,
+    config: Union[AmazonOrdersConfig, None] = None,
 ) -> list[Transaction]:
     """Fetches and sorts Amazon transactions."""
     if not amazon_session.is_authenticated:

src/ynamazon/prompts.py

@@ -47,4 +47,4 @@
 3. Popcorn-shaped Purse"
 
 Do not include the order URL or any additional information - just the item list.
-"""
+"""

src/ynamazon/settings.py

@@ -1,5 +1,6 @@
 from os import PathLike
 from pathlib import Path
+from typing import Union
 
 from pydantic import BaseModel, ConfigDict, EmailStr, SecretStr, model_validator
 from pydantic_settings import BaseSettings, SettingsConfigDict
@@ -45,7 +46,7 @@ class Settings(BaseSettings):
     ynab_budget_id: SecretBudgetId
     amazon_user: EmailStr
     amazon_password: SecretStr
-    openai_api_key: SecretApiKey | None = None
+    openai_api_key: Union[SecretApiKey, None] = None
 
     ynab_payee_name_to_be_processed: str = "Amazon - Needs Memo"
     ynab_payee_name_processing_completed: str = "Amazon"
@@ -70,32 +71,28 @@ class ConfigFile(BaseModel):
     """Configuration file for CLI."""
 
     model_config = ConfigDict(extra="forbid")
-    ynab_api_key: SecretApiKey | None = None
-    ynab_budget_id: SecretBudgetId | None = None
-    amazon_user: EmailStr | None = None
-    amazon_password: SecretStr | None = None
+    ynab_api_key: Union[SecretApiKey, None] = None
+    ynab_budget_id: Union[SecretBudgetId, None] = None
+    amazon_user: Union[EmailStr, None] = None
+    amazon_password: Union[SecretStr, None] = None
 
-    ynab_payee_name_to_be_processed: str | None = None
-    ynab_payee_name_processing_completed: str | None = None
-    ynab_use_markdown: bool | None = None
+    ynab_payee_name_to_be_processed: Union[str, None] = None
+    ynab_payee_name_processing_completed: Union[str, None] = None
+    ynab_use_markdown: Union[bool, None] = None
 
     @classmethod
-    def from_config(cls, file: str | PathLike):
+    def from_config(cls, file: Union[str, PathLike]):
         file_path = Path(file)
         if not file_path.exists():
             raise FileNotFoundError(f"Config file {file_path} does not exist.")
         if not file_path.is_file():
             raise ValueError(f"Config file {file_path} is not a file.")
 
-        match file_path.suffix:
-            case ".yaml":
-                return cls.model_validate_yaml(file_path.read_text())
-            case ".toml":
-                return cls.model_validate_toml(file_path.read_text())
-            case _:
-                raise ValueError(
-                    f"Config file {file_path} must be a .toml or .yaml file."
-                )
+        if file_path.suffix == ".yaml":
+            return cls.model_validate_yaml(file_path.read_text())
+        if file_path.suffix == ".toml":
+            return cls.model_validate_toml(file_path.read_text())
+        raise ValueError(f"Config file {file_path} must be a .toml or .yaml file.")
 
     @classmethod
     def model_validate_yaml(cls, yaml_str: str):

src/ynamazon/utilities/attrpath.py

@@ -1,13 +1,13 @@
 # pyright: strict
 from collections import deque
-from typing import Any
+from typing import Any, Union
 
 from .sentinels import MISSING
 
 
 def getattr_path(
     obj: object, path: str, *, separator: str = "__", default: Any = MISSING
-) -> Any | None:
+) -> Union[Any, None]:
     """Get an attribute path, as defined by a string separated by '__'.
 
     Example:

src/ynamazon/utilities/bases.py

@@ -4,6 +4,7 @@
     Generic,
     SupportsIndex,
     TypeVar,
+    Union,
     overload,
 )
 
@@ -42,14 +43,14 @@ def items(self) -> "dict_items[_KT, _VT]":
         return self.root.items()
 
     @overload  # type: ignore[override]
-    def get(self, key: _KT, /) -> _VT | None: ...
+    def get(self, key: _KT, /) -> Union[_VT, None]: ...
     @overload
     def get(self, key: _KT, default: _VT, /) -> _VT: ...
     @overload
-    def get(self, key: _KT, default: _T, /) -> _VT | _T: ...
+    def get(self, key: _KT, default: _T, /) -> Union[_VT, _T]: ...
     def get(
-        self, key: _KT, default: _T | _VT | Missing = MISSING, /
-    ) -> _VT | _T | None:
+        self, key: _KT, default: Union[_T, _VT, Missing] = MISSING, /
+    ) -> Union[_VT, _T, None]:
         """Return the value for key if key is in the dictionary, else default.
 
         Args:
@@ -65,8 +66,10 @@ def pop(self, key: _KT, /) -> _VT: ...
     @overload
     def pop(self, key: _KT, default: _VT, /) -> _VT: ...
     @overload
-    def pop(self, key: _KT, default: _T, /) -> _VT | _T: ...
-    def pop(self, key: _KT, default: _T | _VT | Missing = MISSING, /) -> _VT | _T:
+    def pop(self, key: _KT, default: _T, /) -> Union[_VT, _T]: ...
+    def pop(
+        self, key: _KT, default: Union[_T, _VT, Missing] = MISSING, /
+    ) -> Union[_VT, _T]:
         """Remove specified key and return the corresponding value.
 
         Args:
@@ -130,13 +133,12 @@ def pop(self, index: int = -1) -> _T:
         return self.root.pop(index)
 
     def __add__(self, other: "SimpleListRoot | Iterable[_T]"):
-        match other:
-            case SimpleListRoot():
-                self.root += other.root
-            case Iterable():
-                self.root += list(other)
-            case _:
-                raise NotImplementedError
+        if isinstance(other, SimpleListRoot):
+            self.root += other.root
+        elif isinstance(other, Iterable):
+            self.root += list(other)
+        else:
+            raise NotImplementedError
 
         return self