report.py

"""CSV reporting utilities for StockBot trade plans."""

from __future__ import annotations

import csv
from pathlib import Path
from typing import Sequence, Tuple

from config import REPORT_CSV_PATH


TradeRow = Tuple[str, float, float]


def write_csv(
    sell_plan: Sequence[TradeRow],
    buy_plan: Sequence[TradeRow],
    path: Path = REPORT_CSV_PATH,
) -> None:
    """Persist the provided trade plan to ``path`` in CSV format."""

    with Path(path).open("w", newline="", encoding="utf-8") as handle:
        writer = csv.writer(handle)
        writer.writerow(["Action", "Ticker", "Quantity", "Price", "Allocated Amount (€)"])

        for ticker, quantity, price in sell_plan:
            allocated = quantity * price
            writer.writerow(["SELL", ticker, quantity, price, allocated])

        for ticker, quantity, price in buy_plan:
            allocated = quantity * price
            writer.writerow(["BUY", ticker, quantity, price, allocated])