Filters on report, and other minor fixes

Author: keul

HISTORY.rst

@@ -1,11 +1,14 @@
 History
 =======
 
-0.7.5 (unreleased)
+0.8.0 (unreleased)
 ------------------
 
-- Nothing changed yet.
-
+- Improved ``read`` logging
+- A bit more verbose messages here and there
+- Added warning when event summary is empty
+- Added warning when ``TIMEZONE`` is not explicitly set
+- Added filters on report (``-f``)
 
 0.7.4 (2024-06-25)
 ------------------

haunts/calendars.py

@@ -115,6 +115,8 @@ def execute_creation():
             f'in date {formatDate(event["start"]["date"], "%d/%m")} '
             f'on calendar {event["organizer"]["displayName"]}'
         )
+    if not summary:
+        click.echo(Back.YELLOW + Fore.BLACK + "Summary is empty!" + Style.RESET_ALL)
 
     event_data = {
         "id": event["id"],

haunts/cli.py

@@ -6,9 +6,10 @@
 import sys
 from pathlib import Path
 from importlib.metadata import version
+from colorama import Fore, Style
 import click
 
-from .ini import create_default, init
+from .ini import create_default, init, get
 from .calendars import init as init_calendars
 from .spreadsheet import sync_report
 from .report import report
@@ -70,6 +71,11 @@
     show_default=True,
     default=False,
 )
+@click.option(
+    "--filter",
+    "-f",
+    help='filter report glob search inside "Activity" columns. ',
+)
 @click.option(
     "--version",
     "-v",
@@ -85,6 +91,7 @@ def main(
     action=[],
     project=[],
     overtime=False,
+    filter=None,
     show_version=False,
 ):
     """
@@ -134,6 +141,17 @@ def main(
         click.echo("All done. You can now start using haunts.")
         sys.exit(0)
 
+    try:
+        get("TIMEZONE")
+    except KeyError:
+        click.echo(
+            Fore.YELLOW
+            + "TIMEZONE not set in configuration. Default is on Etc/GMT but you should customize it"
+            + " (for example: TIMEZONE=Europe/Rome).\n"
+            + "To suppress this warning set TIMEZONE explicitly in haunts.ini."
+            + Style.RESET_ALL
+        )
+
     init_calendars(config_dir)
     if execute == "sync":
         sync_report(
@@ -144,7 +162,14 @@ def main(
             allowed_actions=action,
         )
     elif execute == "report":
-        report(config_dir, sheet, days=day, projects=project, overtime=overtime)
+        report(
+            config_dir,
+            sheet,
+            days=day,
+            projects=project,
+            overtime=overtime,
+            filter=filter,
+        )
     elif execute == "read":
         extract_events(
             config_dir,

haunts/download.py

@@ -85,7 +85,7 @@ def extract_events(config_dir, sheet, day):
     events_service = calendar_service.events()
     sheet_service = spreadsheet_service.spreadsheets()
 
-    click.echo("Checking your calendars…")
+    click.echo(f"Checking your calendars at {day}…")
 
     configured_calendars = get_calendars(
         sheet_service, ignore_alias=True, use_read_col=True
@@ -149,7 +149,10 @@ def extract_events(config_dir, sheet, day):
                 + Style.RESET_ALL
             )
             continue
-        click.echo(f"Adding new event {event_summary} ({project}) to selected sheet")
+        click.echo(
+            f"Adding new event {event_summary} ({project}) "
+            f"{f'at {start_time}' if duration else 'full day'} to selected sheet"
+        )
         append_line(
             sheet_service,
             sheet,

haunts/report.py

@@ -46,6 +46,8 @@ def print_report(report, days=[], projects=[], overtime=False):
         if proj_stats.get("have_full_day", False):
             adjust_full_day(proj_stats)
         for project, stat in proj_stats["projects"].items():
+            if stat.get("ignore"):
+                continue
             overtime_value = stat["overtime"]
             if overtime and overtime_value:
                 # Just want to count the overtime amount
@@ -60,6 +62,8 @@ def print_report(report, days=[], projects=[], overtime=False):
                 and (not days or date in days)
                 # not filtering by overtime, or this is an overtime entry
                 and (not overtime or overtime_value)
+                # not marked has "ignore"
+                and (not proj_stats.get("ignore", False))
             ):
                 rows.append([date, project, total])
                 gran_total += total
@@ -72,7 +76,7 @@ def print_report(report, days=[], projects=[], overtime=False):
     click.echo(tabulate(rows, headers=headers, tablefmt="simple"))
 
 
-def create_report(sheet, sheet_name, data, overtime=False):
+def create_report(sheet, sheet_name, data, overtime=False, filter=None):
     """Create a time consumption report from a sheet."""
     headers_id = get_headers(sheet, sheet_name, indexes=True)
     overtime_from = get("OVERTIME_FROM", default=False)
@@ -138,6 +142,7 @@ def create_report(sheet, sheet_name, data, overtime=False):
                 "total": 0,
                 "overtime": 0,
                 "full_day": False,
+                "ignore": False,
             },
         )
         spent = get_col(row, headers_id["Spent"])
@@ -160,13 +165,17 @@ def create_report(sheet, sheet_name, data, overtime=False):
                 date_stats["have_full_day"] = True
                 prog_stats["full_day"] = True
 
+        # Filter defined, but it doesn't match
+        if filter and filter not in get_col(row, headers_id["Activity"], ""):
+            prog_stats["ignore"] = True
+
         date_stats["projects"][project] = prog_stats
         dates[str(date)] = date_stats
 
     return dates
 
 
-def report(config_dir, sheet_name, days=[], projects=[], overtime=False):
+def report(config_dir, sheet_name, days=[], projects=[], overtime=False, filter=None):
     """Open a sheet, analyze it and extract stats."""
     # The ID and range of the controller timesheet
     creds = get_credentials(config_dir, SCOPES, "sheets-token.json")
@@ -205,10 +214,10 @@ def report(config_dir, sheet_name, days=[], projects=[], overtime=False):
         click.echo(err.error_details)
         sys.exit(1)
 
-    report = create_report(
-        sheet=sheet, sheet_name=sheet_name, data=data, overtime=overtime
+    computed_report = create_report(
+        sheet=sheet, sheet_name=sheet_name, data=data, overtime=overtime, filter=filter
     )
 
     click.echo("")
-    print_report(report, days=days, projects=projects, overtime=overtime)
+    print_report(computed_report, days=days, projects=projects, overtime=overtime)
     click.echo("")

haunts/spreadsheet.py

@@ -17,11 +17,11 @@
 SCOPES = ["https://www.googleapis.com/auth/spreadsheets"]
 
 
-def get_col(row, index):
+def get_col(row, index, default=None):
     try:
         return row[index]
     except IndexError:
-        return None
+        return default
 
 
 def get_headers(sheet, month, indexes=False):