reporter.py

"""
This script converts a given pandas DataFrame into a latex table given
a certain specification.
"""

import os
import re
import sys
import calendar
from datetime import date, datetime

import typer

from modules.log_crawler import LogCrawler
from modules.aggregator import Aggregator
from modules.formatter import Formatter
from modules.utils import relative_path, get_timeframe


class NoLogsFoundError(Exception):
    """
    Simple Exception class indicating that no log-files
    could be found by the LogCrawler.
    """


def month_flag(month: str, date_format: str) -> tuple[date]:
    assert re.search(
        r'0[1-9]|1[0-2]', month) is not None, "Month format: 01, 02, ..., 09, 10, 11, 12"

    start = f"2025-{month}-01"
    end_month = calendar.monthrange(datetime.now().year, int(month))[1]
    end = f"2025-{month}-{end_month}"

    return datetime.strptime(start, date_format).date(), datetime.strptime(end, date_format).date()


def full_flag(lc: LogCrawler) -> tuple[date, list]:
    start, end = lc.get_time_span()
    dfs = lc.extract_all_log_data_frames()
    return start, end, dfs


def report(start: str = date.today().replace(day=1).strftime("%Y-%m-%d"),
         end: str = date.today().strftime("%Y-%m-%d"),
         month: str = "",
         full: bool = False):
    """
    Create a Latex booktabs cross-table from daily .csv logs from the beginning of the current
    month until the current day.


    If no date is provided for the --end flag, a report is generated beginning from START
    and ending at todays date.

    If no date is provided for the --start flag, a report is generated beginning from the 
    first day of the current month and ending at the END date.

    With the --month flag the user can specify to get a report by month. For example
    --month 3 would result in a report compiled for all logs created in march.

    The --full flag can only be used on its own and provides a report over all available log
    files.
    """
    date_f = "%Y-%m-%d"
    lc = LogCrawler(log_dir=os.environ['LOG_DIR'], date_format=date_f)
    ag = Aggregator()
    start: date = datetime.strptime(start, date_f).date()
    end: date = datetime.strptime(end, date_f).date()
    dfs = []

    if month != "":
        start, end = month_flag(month, date_f)
    if full:
        start, end, dfs = full_flag(lc)
    else:
        dfs = lc.extract_log_data_frames(start, end)

    try:
        agg = ag.aggregate_over_interval(dfs)
    except NoLogsFoundError as no_logs:
        print(no_logs, file=sys.stderr)
        return

    measured_days = len(lc.get_measured_dates(start, end))
    interval_days = get_timeframe(start, end)
    fm = Formatter(agg, start, end, date_f)

    latex_table = fm.generate_report(measured_days, interval_days)

    if start != end:
        f = open(relative_path(__file__,
                            f"reports/report-{start}-{end}.tex"), mode='w', encoding='utf_8')
        f.write(latex_table)
        print(f"Created report ./reports/report-{start}-{end}.tex")
    else:
        f = open(relative_path(__file__,
                            f"reports/report-{start}.tex"), mode='w', encoding='utf_8')
        f.write(latex_table)
        print(f"Created report ./reports/report-{start}.tex")


if __name__ == "__main__":
    typer.run(report)