Merge pull request #285 from fooof-tools/paths

[MNT] - Update for Path support

Author: TomDonoghue

fooof/core/io.py

@@ -38,7 +38,7 @@ def fpath(file_path, file_name):
 
     Parameters
     ----------
-    file_path : str or None
+    file_path : Path or str or None
         Path to the directory where the file is located.
     file_name : str
         Name of the file.
@@ -71,7 +71,7 @@ def save_fm(fm, file_name, file_path=None, append=False,
         Object to save data from.
     file_name : str or FileObject
         File to save data to.
-    file_path : str, optional
+    file_path : Path or str, optional
         Path to directory to save to. If None, saves to current directory.
     append : bool, optional, default: False
         Whether to append to an existing file, if available.
@@ -129,7 +129,7 @@ def save_fg(fg, file_name, file_path=None, append=False,
         Object to save data from.
     file_name : str or FileObject
         File to save data to.
-    file_path : str, optional
+    file_path : Path or str, optional
         Path to directory to load from. If None, loads from current directory.
     append : bool, optional, default: False
         Whether to append to an existing file, if available.
@@ -175,7 +175,7 @@ def load_json(file_name, file_path):
     ----------
     file_name : str or FileObject
         File to load data from.
-    file_path : str
+    file_path : Path or str
         Path to directory to load from.
 
     Returns
@@ -204,7 +204,7 @@ def load_jsonlines(file_name, file_path):
     ----------
     file_name : str
         File to load data from.
-    file_path : str
+    file_path : Path or str
         Path to directory from load from.
 
     Yields

fooof/core/reports.py

@@ -31,7 +31,7 @@ def save_report_fm(fm, file_name, file_path=None, plt_log=False, add_settings=Tr
         Object with results from fitting a power spectrum.
     file_name : str
         Name to give the saved out file.
-    file_path : str, optional
+    file_path : Path or str, optional
         Path to directory to save to. If None, saves to current directory.
     plt_log : bool, optional, default: False
         Whether or not to plot the frequency axis in log space.
@@ -83,7 +83,7 @@ def save_report_fg(fg, file_name, file_path=None, add_settings=True):
         Object with results from fitting a group of power spectra.
     file_name : str
         Name to give the saved out file.
-    file_path : str, optional
+    file_path : Path or str, optional
         Path to directory to save to. If None, saves to current directory.
     add_settings : bool, optional, default: True
         Whether to add a print out of the model settings to the end of the report.

fooof/objs/fit.py

@@ -671,7 +671,7 @@ def load(self, file_name, file_path=None, regenerate=True):
         ----------
         file_name : str or FileObject
             File to load data from.
-        file_path : str or None, optional
+        file_path : Path or str, optional
             Path to directory to load from. If None, loads from current directory.
         regenerate : bool, optional, default: True
             Whether to regenerate the model fit from the loaded data, if data is available.

fooof/objs/group.py

@@ -403,7 +403,7 @@ def load(self, file_name, file_path=None):
         ----------
         file_name : str
             File to load data from.
-        file_path : str, optional
+        file_path : Path or str, optional
             Path to directory to load from. If None, loads from current directory.
         """
 
@@ -533,7 +533,7 @@ def save_model_report(self, index, file_name, file_path=None, plt_log=False,
             Index of the model fit to save out.
         file_name : str
             Name to give the saved out file.
-        file_path : str, optional
+        file_path : Path or str, optional
             Path to directory to save to. If None, saves to current directory.
         plt_log : bool, optional, default: False
             Whether or not to plot the frequency axis in log space.

fooof/plts/fg.py

@@ -31,7 +31,7 @@ def plot_fg(fg, save_fig=False, file_name=None, file_path=None, **plot_kwargs):
         Whether to save out a copy of the plot.
     file_name : str, optional
         Name to give the saved out file.
-    file_path : str, optional
+    file_path : Path or str, optional
         Path to directory to save to. If None, saves to current directory.
 
     Raises

fooof/plts/fm.py

@@ -47,7 +47,7 @@ def plot_fm(fm, plot_peaks=None, plot_aperiodic=True, plt_log=False, add_legend=
         Whether to save out a copy of the plot.
     file_name : str, optional
         Name to give the saved out file.
-    file_path : str, optional
+    file_path : Path or str, optional
         Path to directory to save to. If None, saves to current directory.
     ax : matplotlib.Axes, optional
         Figure axes upon which to plot.

fooof/plts/utils.py

@@ -211,7 +211,7 @@ def save_figure(file_name, file_path=None, close=False, **save_kwargs):
     ----------
     file_name : str
         File name for the figure file to save out.
-    file_path : str or Path
+    file_path : Path or str
         Path for where to save out the figure to.
     close : bool, optional, default: False
         Whether to close the plot after saving.

fooof/tests/core/test_io.py

@@ -1,6 +1,7 @@
 """Tests for fooof.core.io."""
 
 import os
+from pathlib import Path
 
 from fooof.core.items import OBJ_DESC
 
@@ -26,6 +27,7 @@ def test_fpath():
 
     assert fpath(None, 'data.json') == 'data.json'
     assert fpath('/path/', 'data.json') == '/path/data.json'
+    assert fpath(Path('/path/'), 'data.json') == '/path/data.json'
 
 def test_save_fm_str(tfm):
     """Check saving fm data, with file specifiers as strings."""

fooof/utils/download.py

@@ -1,10 +1,13 @@
 """Functions and utilities for downloading example data for fooof."""
 
 import os
+from pathlib import Path
 from urllib.request import urlretrieve
 
 import numpy as np
 
+from fooof.core.io import fpath
+
 ###################################################################################################
 ###################################################################################################
 
@@ -15,7 +18,7 @@ def check_data_folder(folder):
 
     Parameters
     ----------
-    folder : str
+    folder : Path or str
         Name of the folder to check and create if missing.
     """
 
@@ -30,11 +33,13 @@ def check_data_file(filename, folder, url=DATA_URL):
     ----------
     filename : str
         Name of the data file to check and download if missing.
-    folder : str
+    folder : Path or str
         Name of the folder to save the datafile to.
+    url : str, optional
+        The URL to download the data file from.
     """
 
-    filepath = os.path.join(folder, filename)
+    filepath = fpath(folder, filename)
 
     if not os.path.isfile(filepath):
         urlretrieve(url + filename, filename=filepath)
@@ -47,7 +52,7 @@ def fetch_fooof_data(filename, folder='data', url=DATA_URL):
     ----------
     filename : str
         Name of the data file to download.
-    folder : str, optional
+    folder : Path or str, optional
         Name of the folder to save the datafile to.
     url : str, optional
         The URL to download the data file from.
@@ -69,7 +74,7 @@ def load_fooof_data(filename, folder='data', url=DATA_URL):
     ----------
     filename : str
         Name of the data file to download.
-    folder : str, optional
+    folder : Path or str, optional
         Name of the folder to save the datafile to.
     url : str, optional
         The URL to download the data file from.

fooof/utils/io.py

@@ -10,7 +10,7 @@ def load_fooof(file_name, file_path=None, regenerate=True):
     ----------
     file_name : str or FileObject
         File to load the data from.
-    file_path : str or None, optional
+    file_path : Path or str, optional
         Path to directory to load from. If None, loads from current directory.
     regenerate : bool, optional, default: True
         Whether to regenerate the model fit from the loaded data, if data is available.
@@ -38,7 +38,7 @@ def load_fooofgroup(file_name, file_path=None):
     ----------
     file_name : str
         File to load data data.
-    file_path : str, optional
+    file_path : Path or str, optional
         Path to directory to load from. If None, loads from current directory.
 
     Returns