Add public load csv API to csv viewer (#40)

akin to how load_config_file is now a non-internal api

Author: ducky64

pyproject.toml

@@ -6,7 +6,7 @@ build-backend = "setuptools.build_meta"
 name = "pyqtgraph-scope-plots"
 description = "Scope like plot utilities for pyqtgraph"
 readme = "README.md"
-version = "1.5.0"
+version = "1.5.1"
 authors = [
     { name = "Richard Lin", email = "[email protected]" }
 ]

pyqtgraph_scope_plots/csv/csv_plots.py

@@ -422,18 +422,18 @@ def _on_load_csv(self) -> None:
         csv_filenames, _ = QFileDialog.getOpenFileNames(None, "Select CSV Files", filter="CSV files (*.csv)")
         if not csv_filenames:  # nothing selected, user canceled
             return
-        self._load_csv(csv_filenames)
+        self._load_csvs(csv_filenames)
 
     def _on_append_csv(self) -> None:
         csv_filenames, _ = QFileDialog.getOpenFileNames(None, "Select CSV Files", filter="CSV files (*.csv)")
         if not csv_filenames:  # nothing selected, user canceled
             return
-        self._load_csv(csv_filenames, append=True)
+        self._load_csvs(csv_filenames, append=True)
 
     def _on_refresh_csv(self) -> None:
         """Reloads all CSVs. Discards data (but not data items) that are no longer present in the reloaded CSVs.
         Does not modify data items (new data items are discarded)."""
-        self._load_csv(
+        self._load_csvs(
             list(self._csv_data_items.keys()),
             colnames=itertools.chain(*self._csv_data_items.values()),
             append=True,
@@ -460,9 +460,13 @@ def _check_watch(self) -> None:
             data_items_to_load.extend(curr_data_items)
 
         if files_to_load:
-            self._load_csv(files_to_load, colnames=data_items_to_load, append=True)
+            self._load_csvs(files_to_load, colnames=data_items_to_load, append=True)
 
-    def _load_csv(
+    def load_csvs(self, csv_filepaths: List[str], *, append: bool = False) -> None:
+        """Public API for loading CSV files"""
+        self._load_csvs(csv_filepaths, append=append)
+
+    def _load_csvs(
         self,
         csv_filepaths: List[str],
         append: bool = False,
@@ -607,7 +611,7 @@ def _do_load_config(self, filename: str, model: CsvLoaderStateModel) -> None:
                     f"Some CSV files not found: {', '.join(missing_csv_files)}",
                     QMessageBox.StandardButton.Ok,
                 )
-            self._load_csv(found_csv_files, update=False)
+            self._load_csvs(found_csv_files, update=False)
 
         data = self._data
         self._set_data({})  # blank the data while updates happen, for performance

tests/test_csv_viewer.py

@@ -36,17 +36,17 @@ def plot(qtbot: QtBot) -> CsvLoaderPlotsTableWidget:
 
 
 def test_load_mixed_csv(qtbot: QtBot, plot: CsvLoaderPlotsTableWidget) -> None:
-    plot._load_csv([os.path.join(os.path.dirname(__file__), "data", "test_csv_viewer_data.csv")])
+    plot._load_csvs([os.path.join(os.path.dirname(__file__), "data", "test_csv_viewer_data.csv")])
     qtbot.waitUntil(lambda: plot._plots.count() == 3)  # just make sure it loads
 
 
 def test_load_sparse_csv(qtbot: QtBot, plot: CsvLoaderPlotsTableWidget) -> None:
-    plot._load_csv([os.path.join(os.path.dirname(__file__), "data", "test_csv_viewer_data_sparse.csv")])
+    plot._load_csvs([os.path.join(os.path.dirname(__file__), "data", "test_csv_viewer_data_sparse.csv")])
     qtbot.waitUntil(lambda: plot._plots.count() == 3)  # just make sure it loads
 
 
 def test_load_multiple_csv(qtbot: QtBot, plot: CsvLoaderPlotsTableWidget) -> None:
-    plot._load_csv(
+    plot._load_csvs(
         [
             os.path.join(os.path.dirname(__file__), "data", "test_csv_viewer_data.csv"),
             os.path.join(os.path.dirname(__file__), "data", "test_csv_viewer_data_diffcols.csv"),
@@ -56,16 +56,16 @@ def test_load_multiple_csv(qtbot: QtBot, plot: CsvLoaderPlotsTableWidget) -> Non
 
 
 def test_append_csv(qtbot: QtBot, plot: CsvLoaderPlotsTableWidget) -> None:
-    plot._load_csv([os.path.join(os.path.dirname(__file__), "data", "test_csv_viewer_data.csv")])
+    plot._load_csvs([os.path.join(os.path.dirname(__file__), "data", "test_csv_viewer_data.csv")])
     qtbot.waitUntil(lambda: plot._plots.count() == 3)
-    plot._load_csv([os.path.join(os.path.dirname(__file__), "data", "test_csv_viewer_data_diffcols.csv")], append=True)
+    plot._load_csvs([os.path.join(os.path.dirname(__file__), "data", "test_csv_viewer_data_diffcols.csv")], append=True)
     qtbot.waitUntil(lambda: plot._plots.count() == 4)  # test that the new data is appended
 
 
 def test_watch_stability(qtbot: QtBot, plot: CsvLoaderPlotsTableWidget) -> None:
-    plot._load_csv([os.path.join(os.path.dirname(__file__), "data", "test_csv_viewer_data.csv")])
+    plot._load_csvs([os.path.join(os.path.dirname(__file__), "data", "test_csv_viewer_data.csv")])
     qtbot.waitUntil(lambda: plot._plots.count() == 3)
-    with mock.patch.object(CsvLoaderPlotsTableWidget, "_load_csv") as mock_load_csv, mock.patch.object(
+    with mock.patch.object(CsvLoaderPlotsTableWidget, "_load_csvs") as mock_load_csv, mock.patch.object(
         os.path, "getmtime"
     ) as mock_getmtime:
         mock_getmtime.return_value = time.time() - 10  # unchanged file
@@ -84,7 +84,7 @@ def test_save_model_csvs(qtbot: QtBot, plot: CsvLoaderPlotsTableWidget) -> None:
     model = plot._do_save_config(os.path.join(os.path.dirname(__file__), "config.yml"))
     assert model.csv_files == []  # relpath
 
-    plot._load_csv([os.path.join(os.path.dirname(__file__), "data", "test_csv_viewer_data.csv")])
+    plot._load_csvs([os.path.join(os.path.dirname(__file__), "data", "test_csv_viewer_data.csv")])
 
     # test saving in relpath mode
     model = plot._do_save_config(os.path.join(os.path.dirname(__file__), "config.yml"))
@@ -101,19 +101,19 @@ def test_save_model_csvs(qtbot: QtBot, plot: CsvLoaderPlotsTableWidget) -> None:
 def test_load_model_csvs_relpath(qtbot: QtBot, plot: CsvLoaderPlotsTableWidget) -> None:
     model = plot._do_save_config("/config.yml")
 
-    with mock.patch.object(CsvLoaderPlotsTableWidget, "_load_csv") as mock_load_csv:
+    with mock.patch.object(CsvLoaderPlotsTableWidget, "_load_csvs") as mock_load_csv:
         model.csv_files = None
         plot._do_load_config(os.path.join(os.path.dirname(__file__), "config.yml"), model)
         mock_load_csv.assert_not_called()
 
-    with mock.patch.object(CsvLoaderPlotsTableWidget, "_load_csv") as mock_load_csv:
+    with mock.patch.object(CsvLoaderPlotsTableWidget, "_load_csvs") as mock_load_csv:
         model.csv_files = [os.path.join("data", "test_csv_viewer_data.csv")]  # relpath
         plot._do_load_config(os.path.join(os.path.dirname(__file__), "config.yml"), model)
         mock_load_csv.assert_called_with(
             [os.path.join(os.path.dirname(__file__), "data", "test_csv_viewer_data.csv")], update=False
         )
 
-    with mock.patch.object(CsvLoaderPlotsTableWidget, "_load_csv") as mock_load_csv:
+    with mock.patch.object(CsvLoaderPlotsTableWidget, "_load_csvs") as mock_load_csv:
         model.csv_files = [os.path.join(os.path.dirname(__file__), "data", "test_csv_viewer_data.csv")]  # abspath
         plot._do_load_config(os.path.join(os.path.dirname(__file__), "config.yml"), model)
         mock_load_csv.assert_called_with(