refactor(convert): use named kwargs

Author: thekaveman

compiler_admin/commands/time/convert.py

@@ -21,6 +21,6 @@ def _get_source_converter(source):
 def convert(args: Namespace, *extras):
     converter = _get_source_converter(args.input)
 
-    converter(args.input, args.output, args.client)
+    converter(source_path=args.input, output_path=args.output, client_name=args.client)
 
     return RESULT_SUCCESS

compiler_admin/services/harvest.py

@@ -33,8 +33,9 @@ def _toggl_client_name():
 def convert_to_toggl(
     source_path: str | TextIO = sys.stdin,
     output_path: str | TextIO = sys.stdout,
-    client_name: str = None,
     output_cols: list[str] = TOGGL_COLUMNS,
+    client_name: str = None,
+    **kwargs,
 ):
     """Convert Harvest formatted entries in source_path to equivalent Toggl formatted entries.
 

compiler_admin/services/toggl.py

@@ -57,19 +57,20 @@ def _str_timedelta(td: str):
 def convert_to_harvest(
     source_path: str | TextIO = sys.stdin,
     output_path: str | TextIO = sys.stdout,
-    client_name: str = None,
     output_cols: list[str] = HARVEST_COLUMNS,
+    client_name: str = None,
+    **kwargs,
 ):
     """Convert Toggl formatted entries in source_path to equivalent Harvest formatted entries.
 
     Args:
         source_path: The path to a readable CSV file of Toggl time entries; or a readable buffer of the same.
 
-        client_name (str): The value to assign in the output "Client" field
+        output_path: The path to a CSV file where Harvest time entries will be written; or a writeable buffer for the same.
 
         output_cols (list[str]): A list of column names for the output
 
-        output_path: The path to a CSV file where Harvest time entries will be written; or a writeable buffer for the same.
+        client_name (str): The value to assign in the output "Client" field
 
     Returns:
         None. Either prints the resulting CSV data or writes to output_path.

tests/commands/time/test_convert.py

@@ -42,4 +42,6 @@ def test_convert(mock_get_source_converter):
 
     assert res == RESULT_SUCCESS
     mock_get_source_converter.assert_called_once_with(args.input)
-    mock_get_source_converter.return_value.assert_called_once_with(args.input, args.output, args.client)
+    mock_get_source_converter.return_value.assert_called_once_with(
+        source_path=args.input, output_path=args.output, client_name=args.client
+    )

tests/services/test_harvest.py

@@ -95,7 +95,7 @@ def test_convert_to_toggl_sample(harvest_file, toggl_file):
     output = None
 
     with StringIO() as output_data:
-        convert_to_toggl(harvest_file, output_data, "Test Client 123")
+        convert_to_toggl(harvest_file, output_data, client_name="Test Client 123")
         output = output_data.getvalue()
 
     assert output

tests/services/test_toggl.py

@@ -160,7 +160,7 @@ def test_convert_to_harvest_sample(toggl_file, harvest_file, mock_google_user_in
     output = None
 
     with StringIO() as output_data:
-        convert_to_harvest(toggl_file, output_data, "Test Client 123")
+        convert_to_harvest(toggl_file, output_data, client_name="Test Client 123")
         output = output_data.getvalue()
 
     assert output