add custom lazy_fixture for pytest 8.0 compatibility

Author: betaBison

tests/conftest.py

@@ -7,6 +7,9 @@
 
 
 import os
+import typing
+import dataclasses
+
 import pytest
 import numpy as np
 import pandas as pd
@@ -214,7 +217,6 @@ def fixture_derived_gps_l1_reversed(android_gps_l1):
 
 
 @pytest.fixture(name="android_state")
-@pytest.mark.filterwarnings("ignore:.*not found*: RuntimeWarning")
 def fixture_android_state(android_derived):
     """State estimate corresponding to Android measurements for GPS L1.
 
@@ -800,3 +802,95 @@ def fixture_solve_wls(derived_2021):
     """
     state_estimate = solve_wls(derived_2021)
     return state_estimate
+
+# lazy_fixture implementation from https://github.com/TvoroG/pytest-lazy-fixture/issues/65
+
+@dataclasses.dataclass
+class LazyFixture:
+    """Lazy fixture dataclass."""
+
+    name: str
+
+def lazy_fixture(name: str) -> LazyFixture:
+    """Mark a fixture as lazy."""
+    return LazyFixture(name)
+
+def is_lazy_fixture(value: object) -> bool:
+    """Check whether a value is a lazy fixture."""
+    return isinstance(value, LazyFixture)
+
+
+def pytest_make_parametrize_id(
+    config: pytest.Config,
+    val: object,
+    argname: str,
+) -> typing.Union[str,None]:
+    """Inject lazy fixture parametrized id.
+
+    Reference:
+    - https://bit.ly/48Off6r
+
+    Args:
+        config (pytest.Config): pytest configuration.
+        value (object): fixture value.
+        argname (str): automatic parameter name.
+
+    Returns:
+        str: new parameter id.
+    """
+    if is_lazy_fixture(val):
+        return typing.cast(LazyFixture, val).name
+    return None
+
+
+@pytest.hookimpl(tryfirst=True)
+def pytest_fixture_setup(
+    fixturedef: pytest.FixtureDef,
+    request: pytest.FixtureRequest,
+) -> typing.Union[object,None]:
+    """Lazy fixture setup hook.
+
+    This hook will never take over a fixture setup but just simply will
+    try to resolve recursively any lazy fixture found in request.param.
+
+    Reference:
+    - https://bit.ly/3SyvsXJ
+
+    Args:
+        fixturedef (pytest.FixtureDef): fixture definition object.
+        request (pytest.FixtureRequest): fixture request object.
+
+    Returns:
+        object | None: fixture value or None otherwise.
+    """
+
+    if hasattr(request, "param"):
+        if isinstance(request.param,np.ndarray) and request.param.size > 0:
+            request.param = _resolve_lazy_fixture(request.param, request)
+        elif isinstance(request.param,np.ndarray) and request.param.size <= 0:
+            return None
+        elif request.param:
+            request.param = _resolve_lazy_fixture(request.param, request)
+    return None
+
+
+def _resolve_lazy_fixture(__val: object, request: pytest.FixtureRequest) -> object:
+    """Lazy fixture resolver.
+
+    Args:
+        __val (object): fixture value object.
+        request (pytest.FixtureRequest): pytest fixture request object.
+
+    Returns:
+        object: resolved fixture value.
+    """
+    if isinstance(__val, tuple):
+        return tuple(_resolve_lazy_fixture(v, request) for v in __val)
+    if isinstance(__val, list):
+        return list(_resolve_lazy_fixture(v, request) for v in __val)
+    if isinstance(__val, typing.Mapping):
+        return {k: _resolve_lazy_fixture(v, request) for k, v in __val.items()}
+    if not is_lazy_fixture(__val):
+        return __val
+    lazy_obj = typing.cast(LazyFixture, __val)
+    return request.getfixturevalue(lazy_obj.name)

tests/navdata/test_navdata.py

@@ -11,8 +11,8 @@
 import pytest
 import numpy as np
 import pandas as pd
-from pytest_lazyfixture import lazy_fixture
 
+from conftest import lazy_fixture
 from gnss_lib_py.navdata.navdata import NavData
 
 def test_init_blank():
@@ -563,168 +563,145 @@ def test_rename_mapper_and_rows(df_simple):
     assert data["floats"].dtype == np.float64
     assert data["strings"].dtype == object
 
-
-
-@pytest.fixture(name="df_rows",
-                params=[
-                        lazy_fixture("df_simple")
-                ])
-def return_df_rows(request):
-    """Extract and return rows from the DataFrame for testing
-
-    Parameters
-    ----------
-    pandas_df : pd.DataFrame
-        Dataframe for testing values
-
-    Returns
-    -------
-    names : np.ndarray
-        String entries in 'names' column of the DataFrame
-    integers : np.ndarray
-        Numeric entries in 'integers' column of the DataFrame
-    floats : np.ndarray
-        Numeric entries in 'floats' column of the DataFrame
-    strings : np.ndarray
-        String entries in 'strings' column of the DataFrame
-    """
-    pandas_df = request.param
-    names = np.asarray(pandas_df['names'].values, dtype=object)
-    integers = np.reshape(np.asarray(pandas_df['integers'].values,
-                                     dtype=np.float64), [1, -1])
-    floats = np.reshape(np.asarray(pandas_df['floats'].values,
-                                   dtype=np.float64), [1, -1])
-    strings = np.asarray(pandas_df['strings'].values, dtype=object)
-    return [names, integers, floats, strings]
-
-
 @pytest.fixture(name="integers")
-def fixture_integers(df_rows):
+def fixture_integers(df_simple):
     """Return data corresponding to the integers label from the test data
 
     Parameters
     ----------
-    df_rows : list
-        List of rows from the testing data
+    df_simple : pd.DataFrame
+        pd.DataFrame to initialize NavData with.
 
     Returns
     -------
     integers : np.ndarray
         Array of numeric entries in 'integers' label of data
     """
-    _, integers, _, _ = df_rows
+    integers = np.reshape(np.asarray(df_simple['integers'].values,
+                                     dtype=np.float64), [1, -1])
+
     return integers
 
 @pytest.fixture(name="floats")
-def fixture_floats(df_rows):
+def fixture_floats(df_simple):
     """Return data corresponding to the floats label from the test data
 
     Parameters
     ----------
-    df_rows : list
-        List of rows from the testing data
+    df_simple : pd.DataFrame
+        pd.DataFrame to initialize NavData with.
 
     Returns
     -------
     floats : np.ndarray
         Array of numeric entries in 'floats' label of data
     """
-    _, _, floats, _ = df_rows
+    floats = np.reshape(np.asarray(df_simple['floats'].values,
+                                   dtype=np.float64), [1, -1])
     return floats
 
 
 @pytest.fixture(name="strings")
-def fixture_strings(df_rows):
+def fixture_strings(df_simple):
     """Return data corresponding to the strings label from the test data
 
     Parameters
     ----------
-    df_rows : list
-        List of rows from the testing data
+    df_simple : pd.DataFrame
+        pd.DataFrame to initialize NavData with.
 
     Returns
     -------
     strings : np.ndarray
         Array of string entries in 'strings' label of data
     """
-    _, _, _, strings = df_rows
+    strings = np.asarray(df_simple['strings'].values, dtype=object)
     return strings
 
 
 @pytest.fixture(name="int_flt")
-def fixture_int_flt(df_rows):
+def fixture_int_flt(df_simple):
     """Return data corresponding to the integers and floats.
 
     Labeled from the test data.
 
     Parameters
     ----------
-    df_rows : list
-        List of rows from the testing data
+    df_simple : pd.DataFrame
+        pd.DataFrame to initialize NavData with.
 
     Returns
     -------
     int_flt : np.ndarray
         2D array of numeric entries in 'integers' and 'floats' labels of data
     """
-    _, integers, floats, _ = df_rows
+    integers = np.reshape(np.asarray(df_simple['integers'].values,
+                                     dtype=np.float64), [1, -1])
+    floats = np.reshape(np.asarray(df_simple['floats'].values,
+                                   dtype=np.float64), [1, -1])
+
     int_flt = np.vstack((integers, floats))
     return int_flt
 
 
 @pytest.fixture(name="nm_str")
-def fixture_nm_str(df_rows):
+def fixture_nm_str(df_simple):
     """Return data corresponding to the names and strings label from the test data
 
     Parameters
     ----------
-    df_rows : list
-        List of rows from the testing data
+    df_simple : pd.DataFrame
+        pd.DataFrame to initialize NavData with.
 
     Returns
     -------
     nm_str : np.ndarray
         2D array of numeric entries in 'names' and 'strings' labels of data
     """
-    names, _, _, strings = df_rows
+    names = np.asarray(df_simple['names'].values, dtype=object)
+    strings = np.asarray(df_simple['strings'].values, dtype=object)
     nm_str = np.vstack((names, strings))
     return nm_str
 
 
 @pytest.fixture(name="str_nm")
-def fixture_str_nm(df_rows):
+def fixture_str_nm(df_simple):
     """Return data corresponding to the strings and names label from the test data
 
     Parameters
     ----------
-    df_rows : list
-        List of rows from the testing data
+    df_simple : pd.DataFrame
+        pd.DataFrame to initialize NavData with.
 
     Returns
     -------
     str_nm : np.ndarray
         2D array of numeric entries in 'strings' and 'names' labels of data
     """
-    names, _, _, strings = df_rows
+    names = np.asarray(df_simple['names'].values, dtype=object)
+    strings = np.asarray(df_simple['strings'].values, dtype=object)
     str_nm = np.vstack((strings, names))
     return str_nm
 
 
 @pytest.fixture(name="flt_int_slc")
-def fixture_flt_int_slc(df_rows):
+def fixture_flt_int_slc(df_simple):
     """Return data corresponding to the names and strings label from the test data
 
     Parameters
     ----------
-    df_rows : list
-        List of rows from the testing data
+    df_simple : pd.DataFrame
+        pd.DataFrame to initialize NavData with.
 
     Returns
     -------
     flt_int_slc : np.ndarray
         2D array of some numeric entries in 'integers' and 'floats' labels of data
     """
-    _, integers, floats, _ = df_rows
+    integers = np.reshape(np.asarray(df_simple['integers'].values,
+                                     dtype=np.float64), [1, -1])
+    floats = np.reshape(np.asarray(df_simple['floats'].values,
+                                   dtype=np.float64), [1, -1])
     flt_int_slc = np.vstack((integers, floats))[:, 3:]
     return flt_int_slc
 

tests/parsers/test_android.py

@@ -12,8 +12,8 @@
 import pytest
 import numpy as np
 import pandas as pd
-from pytest_lazyfixture import lazy_fixture
 
+from conftest import lazy_fixture
 from gnss_lib_py.parsers import android
 from gnss_lib_py.parsers.google_decimeter import AndroidDerived2023
 from gnss_lib_py.navdata.navdata import NavData

tests/parsers/test_nmea.py

@@ -10,8 +10,8 @@
 
 import numpy as np
 import pytest
-from pytest_lazyfixture import lazy_fixture
 
+from conftest import lazy_fixture
 from gnss_lib_py.parsers.nmea import Nmea
 
 # pylint: disable=protected-access

tests/parsers/test_rinex_obs.py

@@ -9,8 +9,8 @@
 
 import pytest
 import numpy as np
-from pytest_lazyfixture import lazy_fixture
 
+from conftest import lazy_fixture
 from gnss_lib_py.parsers.rinex_obs import RinexObs
 from gnss_lib_py.navdata.operations import loop_time
 

tests/utils/test_coordinates.py

@@ -5,15 +5,12 @@
 __authors__ = "Ashwin Kanhere, Derek Knowles"
 __date__ = "21 Jun 2022"
 
-import os
-
 import pytest
 import numpy as np
-from pytest_lazyfixture import lazy_fixture
 
+from conftest import lazy_fixture
 import gnss_lib_py.utils.constants as consts
 from gnss_lib_py.navdata.navdata import NavData
-from gnss_lib_py.parsers.google_decimeter import AndroidDerived2022
 from gnss_lib_py.utils.coordinates import ecef_to_el_az, add_el_az
 from gnss_lib_py.utils.coordinates import geodetic_to_ecef
 from gnss_lib_py.utils.coordinates import ecef_to_geodetic, LocalCoord

tests/utils/test_dop.py

@@ -9,10 +9,9 @@
 import copy
 
 import pytest
-from pytest_lazyfixture import lazy_fixture
-
 import numpy as np
 
+from conftest import lazy_fixture
 from gnss_lib_py.navdata.navdata import NavData
 from gnss_lib_py.navdata.operations import loop_time