fixes #111, pathlib compatibility

Author: betaBison

gnss_lib_py/parsers/android.py

@@ -30,7 +30,7 @@ def __init__(self, input_path, remove_timing_outliers=True):
 
         Parameters
         ----------
-        input_path : string
+        input_path : string or path-like
             Path to measurement csv file
         remove_timing_outliers : bool
             Flag for whether to remove measures that are too close or
@@ -157,7 +157,7 @@ def __init__(self, input_path):
 
         Parameters
         ----------
-        input_path : string
+        input_path : string or path-like
             Path to measurement csv file
         """
         super().__init__(csv_path=input_path)
@@ -255,7 +255,7 @@ def __init__(self, input_path):
 
         Parameters
         ----------
-        input_path : string
+        input_path : string or path-like
             Path to measurement csv file
         """
 
@@ -369,7 +369,7 @@ def preprocess(self, input_path):
 
         Parameters
         ----------
-        input_path : string
+        input_path : string or path-like
             File location of data file to read.
 
         Returns
@@ -380,6 +380,12 @@ def preprocess(self, input_path):
             Dataframe that contains the gyro measurements from the log.
 
         """
+
+        if not isinstance(input_path, (str, os.PathLike)):
+            raise TypeError("input_path must be string or path-like")
+        if not os.path.exists(input_path):
+            raise FileNotFoundError("file not found")
+
         with open(input_path, encoding="utf8") as csvfile:
             reader = csv.reader(csvfile)
             for row in reader:
@@ -435,7 +441,7 @@ def preprocess(self, input_path):
 
         Parameters
         ----------
-        input_path : string
+        input_path : string or path-like
             File location of data file to read.
 
         Returns
@@ -444,6 +450,12 @@ def preprocess(self, input_path):
             Dataframe that contains the location fixes from the log.
 
         """
+
+        if not isinstance(input_path, (str, os.PathLike)):
+            raise TypeError("input_path must be string or path-like")
+        if not os.path.exists(input_path):
+            raise FileNotFoundError("file not found")
+
         with open(input_path, encoding="utf8") as csvfile:
             reader = csv.reader(csvfile)
             for row in reader:
@@ -463,7 +475,7 @@ def make_csv(input_path, output_directory, field, show_path=False):
 
     Parameters
     ----------
-    input_path : string
+    input_path : string or path-like
         File location of data file to read.
     output_directory : string
         Directory where new csv file should be created
@@ -488,6 +500,12 @@ def make_csv(input_path, output_directory, field, show_path=False):
     output_path = os.path.join(output_directory, field + ".csv")
     with open(output_path, 'w', encoding="utf8") as out_csv:
         writer = csv.writer(out_csv)
+
+        if not isinstance(input_path, (str, os.PathLike)):
+            raise TypeError("input_path must be string or path-like")
+        if not os.path.exists(input_path):
+            raise FileNotFoundError("file not found")
+
         with open(input_path, 'r', encoding="utf8") as in_txt:
             for line in in_txt:
                 # Comments in the log file

gnss_lib_py/parsers/navdata.py

@@ -24,7 +24,7 @@ class NavData():
 
     Parameters
     ----------
-    csv_path : string
+    csv_path : string or path-like
         Path to csv file containing data
     pandas_df : pd.DataFrame
         Data used to initialize NavData instance.
@@ -93,7 +93,7 @@ def from_csv_path(self, csv_path, **kwargs):
 
         Parameters
         ----------
-        csv_path : string
+        csv_path : string or path-like
             Path to csv file containing data
         header : string, int, or None
             "infer" uses the first row as column names, setting to
@@ -102,8 +102,8 @@ def from_csv_path(self, csv_path, **kwargs):
             Delimiter to use when reading in csv file.
 
         """
-        if not isinstance(csv_path, str):
-            raise TypeError("csv_path must be string")
+        if not isinstance(csv_path, (str, os.PathLike)):
+            raise TypeError("csv_path must be string or path-like")
         if not os.path.exists(csv_path):
             raise FileNotFoundError("file not found")
 

gnss_lib_py/parsers/nmea.py

@@ -5,6 +5,7 @@
 __authors__ = "Ashwin Kanhere, Dalton Vega"
 __date__ = "24 Jun, 2023"
 
+import os
 import datetime
 
 import pynmea2
@@ -31,7 +32,7 @@ def __init__(self, filename, msg_types=None,
 
         Parameters
         ----------
-        filename : str
+        filename : str or path-like
             filepath to NMEA file to read.
         msg_types : list
             List of strings describing messages that can be parsed.
@@ -63,6 +64,12 @@ def __init__(self, filename, msg_types=None,
         pd_df = pd.DataFrame()
         field_dict = {}
         prev_timestamp = None
+
+        if not isinstance(filename, (str, os.PathLike)):
+            raise TypeError("filename must be string or path-like")
+        if not os.path.exists(filename):
+            raise FileNotFoundError("file not found")
+
         with open(filename, "r", encoding='UTF-8') as open_file:
             for line in open_file:
                 check_ind = line.find('*')

gnss_lib_py/parsers/precise_ephemerides.py

@@ -66,7 +66,7 @@ def parse_sp3(input_path, constellation = 'gps'):
 
     Parameters
     ----------
-    input_path : string
+    input_path : string or path-like
         Path to sp3 file
     constellation : string
         Key from among {gps, galileo, glonass, beidou, qzss, etc} that
@@ -99,8 +99,8 @@ def parse_sp3(input_path, constellation = 'gps'):
             Accessed as of August 20, 2022
     """
     # Initial checks for loading sp3_path
-    if not isinstance(input_path, str):
-        raise TypeError("input_path must be string")
+    if not isinstance(input_path, (str, os.PathLike)):
+        raise TypeError("input_path must be string or path-like")
     if not os.path.exists(input_path):
         raise FileNotFoundError("file not found")
 
@@ -191,7 +191,7 @@ def parse_clockfile(input_path, constellation = 'gps'):
 
     Parameters
     ----------
-    input_path : string
+    input_path : string or path-like
         Path to clk file
     constellation : string
         Key from among {gps, galileo, glonass, beidou, qzss, etc} that
@@ -225,8 +225,8 @@ def parse_clockfile(input_path, constellation = 'gps'):
     """
 
     # Initial checks for loading sp3_path
-    if not isinstance(input_path, str):
-        raise TypeError("input_path must be string")
+    if not isinstance(input_path, (str, os.PathLike)):
+        raise TypeError("input_path must be string or path-like")
     if not os.path.exists(input_path):
         raise FileNotFoundError("file not found")
 

gnss_lib_py/parsers/smartloc.py

@@ -36,7 +36,7 @@ def __init__(self, input_path):
 
         Parameters
         ----------
-        input_path : string
+        input_path : string or path-like
             Path to measurement csv file
 
         """

tests/parsers/test_android.py

@@ -6,6 +6,7 @@
 __date__ = "10 Nov 2021"
 
 import os
+import pathlib
 
 import pytest
 import numpy as np
@@ -341,9 +342,22 @@ def test_imu_raw(android_raw_path):
     test_imu = android.AndroidRawImu(android_raw_path)
     isinstance(test_imu, NavData)
 
+    test_imu = android.AndroidRawImu(pathlib.Path(android_raw_path))
+    isinstance(test_imu, NavData)
+
+    # raises exception if not a file path
+    with pytest.raises(FileNotFoundError):
+        android.AndroidRawImu("not_a_file.txt")
+    with pytest.raises(FileNotFoundError):
+        android.AndroidRawImu(pathlib.Path("not_a_file.txt"))
+
+    # raises exception if input not string or path-like
+    with pytest.raises(TypeError):
+        android.AndroidRawImu([])
+
 
 def test_fix_raw(android_raw_path):
-    """Test that AndroidRawImu initialization
+    """Test that AndroidRawFixes initialization
 
     Parameters
     ----------
@@ -353,6 +367,19 @@ def test_fix_raw(android_raw_path):
     test_fix = android.AndroidRawFixes(android_raw_path)
     isinstance(test_fix, NavData)
 
+    test_fix = android.AndroidRawFixes(pathlib.Path(android_raw_path))
+    isinstance(test_fix, NavData)
+
+    # raises exception if not a file path
+    with pytest.raises(FileNotFoundError):
+        android.AndroidRawFixes("not_a_file.txt")
+    with pytest.raises(FileNotFoundError):
+        android.AndroidRawFixes(pathlib.Path("not_a_file.txt"))
+
+    # raises exception if input not string or path-like
+    with pytest.raises(TypeError):
+        android.AndroidRawFixes([])
+
 
 def test_navdata_type(derived):
     """Test that all subclasses inherit from NavData
@@ -449,8 +476,18 @@ def test_csv_equivalence(android_raw_path, root_path, file_type):
         df_slice = test_df[col_name].values
         np.testing.assert_almost_equal(measure_slice, df_slice)
     os.remove(csv_loc)
+    for file in os.listdir(output_directory):
+        os.remove(os.path.join(output_directory, file))
     os.rmdir(output_directory)
 
+    # raises exception if not a file path
+    with pytest.raises(FileNotFoundError):
+        android.make_csv("", output_directory, file_type)
+
+    # raises exception if input not string or path-like
+    with pytest.raises(TypeError):
+        android.make_csv([], output_directory, file_type)
+
 @pytest.fixture(name="android_gtruth_path")
 def fixture_gtruth_path(root_path):
     """Filepath of Android Ground Truth data

tests/parsers/test_navdata.py

@@ -7,6 +7,7 @@
 
 
 import os
+import pathlib
 import itertools
 
 import pytest
@@ -211,7 +212,11 @@ def test_init_csv(csv_path):
 
     # should work when csv is passed
     data = NavData(csv_path=csv_path)
+    # data should contain full csv
+    assert data.shape == (4,6)
 
+    # should work when csv is passed as pathlib object
+    data = NavData(csv_path=pathlib.Path(csv_path))
     # data should contain full csv
     assert data.shape == (4,6)
 

tests/parsers/test_nmea.py

@@ -6,6 +6,7 @@
 __date__ = "24 Jun, 2023"
 
 import os
+import pathlib
 
 import numpy as np
 import pytest
@@ -52,7 +53,6 @@ def fixture_nmea_file_w_correct_checksum(root_path):
     nmea_checksum = os.path.join(root_path, 'nmea_w_correct_checksum.nmea')
     return nmea_checksum
 
-
 @pytest.fixture(name="nmea_wrong_checksum")
 def fixture_nmea_file_w_wrong_checksum(root_path):
     """Location of NMEA file with wrong checksum values.
@@ -130,6 +130,18 @@ def test_nmea_loading(nmea_file, check, row_name, exp_value, eq_decimal):
     nmea_navdata = Nmea(nmea_file, check=check)
     compare_nmea_values(nmea_navdata, row_name, exp_value, eq_decimal)
 
+    nmea_navdata = Nmea(pathlib.Path(nmea_file), check=check)
+
+    # raises exception if not a file path
+    with pytest.raises(FileNotFoundError):
+        Nmea(pathlib.Path("not_a_file.txt"), check=check)
+    with pytest.raises(FileNotFoundError):
+        Nmea("not_a_file.txt", check=check)
+
+    # raises exception if input not string or path-like
+    with pytest.raises(TypeError):
+        Nmea([], check=check)
+
     # Testing loading with raw latitude and longitude preserved
     nmea_raw = Nmea(nmea_file, check=check, keep_raw=True)
     compare_nmea_values(nmea_raw, row_name, exp_value, eq_decimal)

tests/parsers/test_precise_ephemerides.py

@@ -106,6 +106,10 @@ def fixture_load_sp3data_gps(sp3_path):
     """
     sp3data_gps = parse_sp3(sp3_path, constellation = 'gps')
 
+    # raises exception if input not string or path-like
+    with pytest.raises(TypeError):
+        parse_sp3([])
+
     return sp3data_gps
 
 @pytest.fixture(name="clkdata_gps")
@@ -124,6 +128,10 @@ def fixture_load_clkdata_gps(clk_path):
     """
     clkdata_gps = parse_clockfile(clk_path, constellation = 'gps')
 
+    # raises exception if input not string or path-like
+    with pytest.raises(TypeError):
+        parse_clockfile([])
+
     return clkdata_gps
 
 @pytest.fixture(name="sp3data_glonass")