Merge branch 'main' into signals

CHANGELOG.md

@@ -5,6 +5,9 @@
 ### Changed
 - Exclude EDF+ annotation signals from `Edf.signals`, `Edf.num_signals`, and `Edf.drop_signals()` ([#25](https://github.com/the-siesta-group/edfio/pull/25)).
 
+### Added
+- Expand `~` (tilde) to the user's home directory in `edf_file` argument of `read_edf()` and `target` argument of `Edf.write()` ([#23](https://github.com/the-siesta-group/edfio/pull/23)).
+
 ### Fixed
 - Avoid floating point errors sometimes preventing the creation of an Edf with signals that are actually compatible in duration ([#15](https://github.com/the-siesta-group/edfio/pull/15)).
 - Allow reading EDF+ startdate and birthdate with non-uppercase month ([#19](https://github.com/the-siesta-group/edfio/pull/19)).

edfio/edf.py

@@ -835,7 +835,7 @@ def write(self, target: Path | str | io.BufferedWriter | io.BytesIO) -> None:
             target.write(header_record)
             target.write(data_record.tobytes())
         else:
-            with target.open("wb") as file:
+            with target.expanduser().open("wb") as file:
                 file.write(header_record)
                 data_record.tofile(file)
 
@@ -1559,6 +1559,7 @@ def _read_edf(edf_file: Any) -> Edf:
 @_read_edf.register
 def _(edf_file: Path) -> Edf:
     edf = object.__new__(Edf)
+    edf_file = edf_file.expanduser()
     with edf_file.open("rb") as file:
         edf._read_header(file)
     edf._load_data(edf_file)

tests/test_edf.py

@@ -619,6 +619,11 @@ def test_read_edf_str():
     assert read_edf(str(EDF_FILE)).num_signals == 7
 
 
+def test_read_edf_expanduser():
+    with pytest.raises(FileNotFoundError, match="^[^~]*$"):
+        read_edf("~/edfio_testfile_that_should_not_exist.edf")
+
+
 @pytest.mark.parametrize("mode", ["rb", "r+b"])
 def test_read_edf_file_object(mode):
     with EDF_FILE.open(mode) as edf_file: