chore: rename input/output columns to match system

Author: thekaveman

compiler_admin/commands/time/convert.py

@@ -3,17 +3,17 @@
 import pandas as pd
 
 from compiler_admin import RESULT_SUCCESS
-from compiler_admin.services.harvest import INPUT_COLUMNS as TOGGL_COLUMNS, convert_to_toggl
-from compiler_admin.services.toggl import INPUT_COLUMNS as HARVEST_COLUMNS, convert_to_harvest
+from compiler_admin.services.harvest import HARVEST_COLUMNS, convert_to_toggl
+from compiler_admin.services.toggl import TOGGL_COLUMNS, convert_to_harvest
 
 
 def _get_source_converter(source):
     columns = pd.read_csv(source, nrows=0).columns.tolist()
 
     if set(HARVEST_COLUMNS) <= set(columns):
-        return convert_to_harvest
-    elif set(TOGGL_COLUMNS) <= set(columns):
         return convert_to_toggl
+    elif set(TOGGL_COLUMNS) <= set(columns):
+        return convert_to_harvest
     else:
         raise NotImplementedError("A converter for the given source data does not exist.")
 

compiler_admin/commands/time/download.py

@@ -1,7 +1,7 @@
 from argparse import Namespace
 
 from compiler_admin import RESULT_SUCCESS
-from compiler_admin.services.toggl import INPUT_COLUMNS as TOGGL_COLUMNS, download_time_entries
+from compiler_admin.services.toggl import TOGGL_COLUMNS, download_time_entries
 
 
 def download(args: Namespace, *extras):

compiler_admin/services/harvest.py

@@ -8,10 +8,10 @@
 import compiler_admin.services.files as files
 
 # input CSV columns needed for conversion
-INPUT_COLUMNS = ["Date", "Client", "Project", "Notes", "Hours", "First name", "Last name"]
+HARVEST_COLUMNS = ["Date", "Client", "Project", "Notes", "Hours", "First name", "Last name"]
 
 # default output CSV columns
-OUTPUT_COLUMNS = ["Email", "Start date", "Start time", "Duration", "Project", "Task", "Client", "Billable", "Description"]
+TOGGL_COLUMNS = ["Email", "Start date", "Start time", "Duration", "Project", "Task", "Client", "Billable", "Description"]
 
 
 def _calc_start_time(group: pd.DataFrame):
@@ -34,7 +34,7 @@ def convert_to_toggl(
     source_path: str | TextIO = sys.stdin,
     output_path: str | TextIO = sys.stdout,
     client_name: str = None,
-    output_cols: list[str] = OUTPUT_COLUMNS,
+    output_cols: list[str] = TOGGL_COLUMNS,
 ):
     """Convert Harvest formatted entries in source_path to equivalent Toggl formatted entries.
 
@@ -52,7 +52,7 @@ def convert_to_toggl(
         client_name = _toggl_client_name()
 
     # read CSV file, parsing dates
-    source = files.read_csv(source_path, usecols=INPUT_COLUMNS, parse_dates=["Date"], cache_dates=True)
+    source = files.read_csv(source_path, usecols=HARVEST_COLUMNS, parse_dates=["Date"], cache_dates=True)
 
     # rename columns that can be imported as-is
     source.rename(columns={"Project": "Task", "Notes": "Description", "Date": "Start date"}, inplace=True)

compiler_admin/services/toggl.py

@@ -12,13 +12,12 @@
 
 # cache of previously seen user information, keyed on email
 USER_INFO = files.JsonFileCache("TOGGL_USER_INFO")
-NOT_FOUND = "NOT FOUND"
 
-# input CSV columns needed for conversion
-INPUT_COLUMNS = ["Email", "Project", "Client", "Start date", "Start time", "Duration", "Description"]
+# input columns needed for conversion
+TOGGL_COLUMNS = ["Email", "Project", "Client", "Start date", "Start time", "Duration", "Description"]
 
-# default output CSV columns
-OUTPUT_COLUMNS = ["Date", "Client", "Project", "Task", "Notes", "Hours", "First name", "Last name"]
+# default output CSV columns for Harvest
+HARVEST_COLUMNS = ["Date", "Client", "Project", "Task", "Notes", "Hours", "First name", "Last name"]
 
 
 def _get_first_name(email: str) -> str:
@@ -59,7 +58,7 @@ def convert_to_harvest(
     source_path: str | TextIO = sys.stdin,
     output_path: str | TextIO = sys.stdout,
     client_name: str = None,
-    output_cols: list[str] = OUTPUT_COLUMNS,
+    output_cols: list[str] = HARVEST_COLUMNS,
 ):
     """Convert Toggl formatted entries in source_path to equivalent Harvest formatted entries.
 
@@ -79,7 +78,7 @@ def convert_to_harvest(
         client_name = os.environ.get("HARVEST_CLIENT_NAME")
 
     # read CSV file, parsing dates and times
-    source = files.read_csv(source_path, usecols=INPUT_COLUMNS, parse_dates=["Start date"], cache_dates=True)
+    source = files.read_csv(source_path, usecols=TOGGL_COLUMNS, parse_dates=["Start date"], cache_dates=True)
     source["Start time"] = source["Start time"].apply(_str_timedelta)
     source["Duration"] = source["Duration"].apply(_str_timedelta)
     source.sort_values(["Start date", "Start time", "Email"], inplace=True)
@@ -109,7 +108,7 @@ def download_time_entries(
     start_date: datetime,
     end_date: datetime,
     output_path: str | TextIO = sys.stdout,
-    output_cols: list[str] | None = INPUT_COLUMNS,
+    output_cols: list[str] | None = TOGGL_COLUMNS,
     **kwargs,
 ):
     """Download a CSV report from Toggl of detailed time entries for the given date range.

tests/services/test_harvest.py

@@ -10,8 +10,8 @@
 from compiler_admin.services.harvest import (
     __name__ as MODULE,
     files,
-    INPUT_COLUMNS,
-    OUTPUT_COLUMNS,
+    HARVEST_COLUMNS,
+    TOGGL_COLUMNS,
     _calc_start_time,
     _duration_str,
     _toggl_client_name,
@@ -81,14 +81,14 @@ def test_convert_to_toggl_mocked(harvest_file, spy_files, mock_toggl_client_name
     spy_files.read_csv.assert_called_once()
     call_args = spy_files.read_csv.call_args
     assert (harvest_file,) in call_args
-    assert call_args.kwargs["usecols"] == INPUT_COLUMNS
+    assert call_args.kwargs["usecols"] == HARVEST_COLUMNS
     assert call_args.kwargs["parse_dates"] == ["Date"]
     assert call_args.kwargs["cache_dates"] is True
 
     spy_files.write_csv.assert_called_once()
     call_args = spy_files.write_csv.call_args
     assert call_args[0][0] == sys.stdout
-    assert call_args[0][2] == OUTPUT_COLUMNS
+    assert call_args[0][2] == TOGGL_COLUMNS
 
 
 def test_convert_to_toggl_sample(harvest_file, toggl_file):
@@ -100,7 +100,7 @@ def test_convert_to_toggl_sample(harvest_file, toggl_file):
 
     assert output
     assert isinstance(output, str)
-    assert ",".join(OUTPUT_COLUMNS) in output
+    assert ",".join(TOGGL_COLUMNS) in output
 
     order = ["Start date", "Start time", "Email"]
     sample_output_df = pd.read_csv(toggl_file).sort_values(order)

tests/services/test_toggl.py

@@ -11,8 +11,8 @@
 from compiler_admin.services.toggl import (
     __name__ as MODULE,
     files,
-    INPUT_COLUMNS,
-    OUTPUT_COLUMNS,
+    TOGGL_COLUMNS,
+    HARVEST_COLUMNS,
     _get_first_name,
     _get_last_name,
     _str_timedelta,
@@ -145,14 +145,14 @@ def test_convert_to_harvest_mocked(toggl_file, spy_files, mock_google_user_info)
     spy_files.read_csv.assert_called_once()
     call_args = spy_files.read_csv.call_args
     assert (toggl_file,) in call_args
-    assert call_args.kwargs["usecols"] == INPUT_COLUMNS
+    assert call_args.kwargs["usecols"] == TOGGL_COLUMNS
     assert call_args.kwargs["parse_dates"] == ["Start date"]
     assert call_args.kwargs["cache_dates"] is True
 
     spy_files.write_csv.assert_called_once()
     call_args = spy_files.write_csv.call_args
     assert sys.stdout in call_args[0]
-    assert call_args.kwargs["columns"] == OUTPUT_COLUMNS
+    assert call_args.kwargs["columns"] == HARVEST_COLUMNS
 
 
 def test_convert_to_harvest_sample(toggl_file, harvest_file, mock_google_user_info):
@@ -165,7 +165,7 @@ def test_convert_to_harvest_sample(toggl_file, harvest_file, mock_google_user_in
 
     assert output
     assert isinstance(output, str)
-    assert ",".join(OUTPUT_COLUMNS) in output
+    assert ",".join(HARVEST_COLUMNS) in output
 
     order = ["Date", "First name", "Hours"]
     sample_output_df = pd.read_csv(harvest_file).sort_values(order)