fix: Don't save dataframe if empty, closes #32

docs/changelog.rst

@@ -1,6 +1,14 @@
 Changelog
 =========
 
+0.3.9 (Unreleased)
+------------------
+
+Changed
+~~~~~~~
+
+-  :func:`~ocdskingfishercolab.save_dataframe_to_sheet` and :func:`save_dataframe_to_spreadsheet` do nothing if the data frame is empty.
+
 0.3.8 (2022-04-27)
 ------------------
 

ocdskingfishercolab/__init__.py

@@ -163,7 +163,11 @@ def save_dataframe_to_sheet(dataframe, sheetname, prompt=True):
     :param str sheetname: a sheet name
     :param bool prompt: whether to prompt the user
     """
-    if prompt is False or input('Save to Google Sheets? (y/N)') == 'y':
+    if dataframe.empty:
+        print('Data frame is empty.')
+        return
+
+    if not prompt or input('Save to Google Sheets? (y/N)') == 'y':
         gc = authenticate_gspread()
         try:
             sheet = gc.open(spreadsheet_name)
@@ -187,6 +191,10 @@ def save_dataframe_to_spreadsheet(dataframe, name):
     :param pandas.DataFrame dataframe: a data frame
     :param str name: the basename of the Excel file to write
     """
+    if dataframe.empty:
+        print('Data frame is empty.')
+        return
+
     write_data_as_json(dataframe['release_package'][0], 'release_package.json')
 
     with warnings.catch_warnings():

tests/test_module.py

@@ -333,7 +333,6 @@ def test_save_dataframe_to_spreadsheet(save, capsys, tmpdir):
         save.assert_called_once_with({'title': 'yet_another_excel_file.xlsx'}, 'flattened.xlsx')
 
 
-@pytest.mark.xfail()
 @patch('ocdskingfishercolab._save_file_to_drive')
 def test_save_dataframe_to_spreadsheet_empty(save, capsys, tmpdir):
     df = pandas.DataFrame()