Merge pull request #1260 from ReinderVosDeWael/feature/expand-path

ENH: Allow ~/ in paths

Author: effigies

nibabel/filename_parser.py

@@ -10,6 +10,7 @@
 from __future__ import annotations
 
 import os
+import pathlib
 import typing as ty
 
 if ty.TYPE_CHECKING:  # pragma: no cover
@@ -37,9 +38,7 @@ def _stringify_path(filepath_or_buffer: FileSpec) -> str:
     Adapted from:
     https://github.com/pandas-dev/pandas/blob/325dd68/pandas/io/common.py#L131-L160
     """
-    if isinstance(filepath_or_buffer, os.PathLike):
-        return filepath_or_buffer.__fspath__()
-    return filepath_or_buffer
+    return pathlib.Path(filepath_or_buffer).expanduser().as_posix()
 
 
 def types_filenames(

nibabel/freesurfer/tests/test_mghformat.py

@@ -10,6 +10,7 @@
 
 import io
 import os
+import pathlib
 
 import numpy as np
 import pytest
@@ -291,7 +292,7 @@ def test_mgh_load_fileobj():
     # pass the filename to the array proxy, please feel free to change this
     # test.
     img = MGHImage.load(MGZ_FNAME)
-    assert img.dataobj.file_like == MGZ_FNAME
+    assert pathlib.Path(img.dataobj.file_like) == pathlib.Path(MGZ_FNAME)
     # Check fileobj also passed into dataobj
     with ImageOpener(MGZ_FNAME) as fobj:
         contents = fobj.read()

nibabel/tests/test_ecat.py

@@ -8,6 +8,7 @@
 ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ##
 
 import os
+import pathlib
 import warnings
 from unittest import TestCase
 
@@ -183,8 +184,8 @@ class TestEcatImage(TestCase):
     img = image_class.load(example_file)
 
     def test_file(self):
-        assert self.img.file_map['header'].filename == self.example_file
-        assert self.img.file_map['image'].filename == self.example_file
+        assert pathlib.Path(self.img.file_map['header'].filename) == pathlib.Path(self.example_file)
+        assert pathlib.Path(self.img.file_map['image'].filename) == pathlib.Path(self.example_file)
 
     def test_save(self):
         tmp_file = 'tinypet_tmp.v'

nibabel/tests/test_filename_parser.py

@@ -7,10 +7,11 @@
 #
 ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ##
 """Tests for filename container"""
+import pathlib
 
 import pytest
 
-from ..filename_parser import TypesFilenamesError, parse_filename, splitext_addext, types_filenames
+from ..filename_parser import TypesFilenamesError, parse_filename, splitext_addext, types_filenames, _stringify_path
 
 
 def test_filenames():
@@ -123,3 +124,19 @@ def test_splitext_addext():
     assert res == ('..', '', '')
     res = splitext_addext('...')
     assert res == ('...', '', '')
+
+
+def test__stringify_path():
+    res = _stringify_path('fname.ext.gz')
+    assert res == 'fname.ext.gz'
+    res = _stringify_path(pathlib.Path('fname.ext.gz'))
+    assert res == 'fname.ext.gz'
+
+    home = pathlib.Path.home().as_posix()
+    res = _stringify_path(pathlib.Path('~/fname.ext.gz'))
+    assert res == f'{home}/fname.ext.gz'
+
+    res = _stringify_path(pathlib.Path('./fname.ext.gz'))
+    assert res == 'fname.ext.gz'
+    res = _stringify_path(pathlib.Path('../fname.ext.gz'))
+    assert res == '../fname.ext.gz'