diff --git a/docs/API.rst b/docs/API.rst index aa6a36f..afdfedf 100644 --- a/docs/API.rst +++ b/docs/API.rst @@ -8,7 +8,7 @@ for class names. Reading EDF files ----------------- -.. automodule:: eyelinkio.edf.read_edf +.. automodule:: eyelinkio.edf.read :members: :exclude-members: EDF diff --git a/docs/usage.rst b/docs/usage.rst index 4b19e48..9374bef 100644 --- a/docs/usage.rst +++ b/docs/usage.rst @@ -52,7 +52,7 @@ Example Usage Reading an EDF file ~~~~~~~~~~~~~~~~~~~ -You can read EyeLink EDF files using the :func:`~eyelinkio.edf.read_edf` function, which +You can read EyeLink EDF files using the :func:`~eyelinkio.edf.read.read_edf` function, which returns an :class:`~eyelinkio.EDF` instance. .. code:: python diff --git a/src/eyelinkio/edf/__init__.py b/src/eyelinkio/edf/__init__.py index 60520d3..48aa190 100644 --- a/src/eyelinkio/edf/__init__.py +++ b/src/eyelinkio/edf/__init__.py @@ -1,2 +1,2 @@ # License: BSD (3-clause) -from .read_edf import read_edf, EDF \ No newline at end of file +from .read import read_edf, EDF \ No newline at end of file diff --git a/src/eyelinkio/edf/read_edf.py b/src/eyelinkio/edf/read.py similarity index 100% rename from src/eyelinkio/edf/read_edf.py rename to src/eyelinkio/edf/read.py diff --git a/src/eyelinkio/tests/test_edf.py b/src/eyelinkio/tests/test_edf.py index 16e4b8c..0d66072 100644 --- a/src/eyelinkio/tests/test_edf.py +++ b/src/eyelinkio/tests/test_edf.py @@ -1,3 +1,5 @@ +from unittest.mock import patch + import numpy as np import pytest @@ -163,3 +165,9 @@ def test_to_mne(): np.testing.assert_equal(raw.ch_names, want_chs) else: raise ValueError(f"Unexpected file: {fname}") + +def test_edfapi_not_installed(): + """Test that an error is raised if SR Research's edfapi is not installed.""" + with patch("eyelinkio.edf.read.has_edfapi", False): + with pytest.raises(OSError, match="Could not load EDF api"): + read_edf(fnames[0]) diff --git a/src/eyelinkio/utils/check.py b/src/eyelinkio/utils/check.py index a6f7273..8e0ca49 100644 --- a/src/eyelinkio/utils/check.py +++ b/src/eyelinkio/utils/check.py @@ -3,7 +3,7 @@ def _has_edfapi(): """Determine if a user has edfapi installed.""" - from ..edf.read_edf import has_edfapi + from ..edf.read import has_edfapi return has_edfapi