update docstrings to accept str or os.PathLike

Author: CRiddler

nibabel/filebasedimages.py

@@ -246,7 +246,7 @@ def set_filename(self, filename):
 
         Parameters
         ----------
-        filename : str
+        filename : str or os.PathLike
            If the image format only has one file associated with it,
            this will be the only filename set into the image
            ``.file_map`` attribute. Otherwise, the image instance will
@@ -279,7 +279,7 @@ def filespec_to_file_map(klass, filespec):
 
         Parameters
         ----------
-        filespec : str
+        filespec : str or os.PathLike
             Filename that might be for this image file type.
 
         Returns
@@ -321,7 +321,7 @@ def to_filename(self, filename):
 
         Parameters
         ----------
-        filename : str
+        filename : str or os.PathLike
            filename to which to save image.  We will parse `filename`
            with ``filespec_to_file_map`` to work out names for image,
            header etc.
@@ -419,7 +419,7 @@ def _sniff_meta_for(klass, filename, sniff_nbytes, sniff=None):
 
         Parameters
         ----------
-        filename : str
+        filename : str or os.PathLike
             Filename for an image, or an image header (metadata) file.
             If `filename` points to an image data file, and the image type has
             a separate "header" file, we work out the name of the header file,
@@ -466,7 +466,7 @@ def path_maybe_image(klass, filename, sniff=None, sniff_max=1024):
 
         Parameters
         ----------
-        filename : str
+        filename : str or os.PathLike
             Filename for an image, or an image header (metadata) file.
             If `filename` points to an image data file, and the image type has
             a separate "header" file, we work out the name of the header file,

nibabel/filename_parser.py

@@ -21,7 +21,8 @@ def _stringify_path(filepath_or_buffer):
 
     Parameters
     ----------
-    filepath_or_buffer : object to be converted
+    filepath_or_buffer : str or os.PathLike
+    
     Returns
     -------
     str_filepath_or_buffer : maybe a string version of the object
@@ -56,7 +57,7 @@ def types_filenames(template_fname, types_exts,
 
     Parameters
     ----------
-    template_fname : str
+    template_fname : str or os.PathLike
        template filename from which to construct output dict of
        filenames, with given `types_exts` type to extension mapping.  If
        ``self.enforce_extensions`` is True, then filename must have one
@@ -177,7 +178,7 @@ def parse_filename(filename,
 
     Parameters
     ----------
-    filename : str
+    filename : str or os.PathLike
        filename in which to search for type extensions
     types_exts : sequence of sequences
        sequence of (name, extension) str sequences defining type to
@@ -260,7 +261,7 @@ def splitext_addext(filename,
 
     Parameters
     ----------
-    filename : str
+    filename : str or os.PathLike
        filename that may end in any or none of `addexts`
     match_case : bool, optional
        If True, match case of `addexts` and `filename`, otherwise do

nibabel/loadsave.py

@@ -25,7 +25,7 @@ def load(filename, **kwargs):
 
     Parameters
     ----------
-    filename : string
+    filename : str or os.PathLike
        specification of file to load
     \*\*kwargs : keyword arguments
         Keyword arguments to format-specific load
@@ -89,7 +89,7 @@ def save(img, filename):
     ----------
     img : ``SpatialImage``
        image to save
-    filename : str
+    filename : str or os.PathLike
        filename (often implying filenames) to which to save `img`.
 
     Returns