TYP: Annotate DataobjImage classmethods, clarify get_fdata() return type

Author: effigies

nibabel/analyze.py

@@ -1064,5 +1064,5 @@ def to_file_map(self, file_map=None, dtype=None):
             hdr['scl_inter'] = inter
 
 
-load = AnalyzeImage.load
+load = AnalyzeImage.from_filename
 save = AnalyzeImage.instance_to_filename

nibabel/brikhead.py

@@ -564,4 +564,4 @@ def filespec_to_file_map(klass, filespec):
         return file_map
 
 
-load = AFNIImage.load
+load = AFNIImage.from_filename

nibabel/dataobj_images.py

@@ -20,12 +20,14 @@
 if ty.TYPE_CHECKING:  # pragma: no cover
     import numpy.typing as npt
 
+ArrayImgT = ty.TypeVar('ArrayImgT', bound='DataobjImage')
+
 
 class DataobjImage(FileBasedImage):
     """Template class for images that have dataobj data stores"""
 
     _data_cache: np.ndarray | None
-    _fdata_cache: np.ndarray | None
+    _fdata_cache: np.ndarray[ty.Any, np.dtype[np.floating]] | None
 
     def __init__(
         self,
@@ -222,7 +224,7 @@ def get_fdata(
         self,
         caching: ty.Literal['fill', 'unchanged'] = 'fill',
         dtype: npt.DTypeLike = np.float64,
-    ) -> np.ndarray:
+    ) -> np.ndarray[ty.Any, np.dtype[np.floating]]:
         """Return floating point image data with necessary scaling applied
 
         The image ``dataobj`` property can be an array proxy or an array.  An
@@ -421,12 +423,12 @@ def ndim(self) -> int:
 
     @classmethod
     def from_file_map(
-        klass,
+        klass: type[ArrayImgT],
         file_map: FileMap,
         *,
         mmap: bool | ty.Literal['c', 'r'] = True,
         keep_file_open: bool | None = None,
-    ):
+    ) -> ArrayImgT:
         """Class method to create image from mapping in ``file_map``
 
         Parameters
@@ -460,12 +462,12 @@ def from_file_map(
 
     @classmethod
     def from_filename(
-        klass,
+        klass: type[ArrayImgT],
         filename: FileSpec,
         *,
         mmap: bool | ty.Literal['c', 'r'] = True,
         keep_file_open: bool | None = None,
-    ):
+    ) -> ArrayImgT:
         """Class method to create image from filename `filename`
 
         Parameters

nibabel/freesurfer/mghformat.py

@@ -589,5 +589,5 @@ def _affine2header(self):
         hdr['Pxyz_c'] = c_ras
 
 
-load = MGHImage.load
+load = MGHImage.from_filename
 save = MGHImage.instance_to_filename

nibabel/minc1.py

@@ -334,4 +334,4 @@ def from_file_map(klass, file_map, *, mmap=True, keep_file_open=None):
         return klass(data, affine, header, extra=None, file_map=file_map)
 
 
-load = Minc1Image.load
+load = Minc1Image.from_filename

nibabel/minc2.py

@@ -172,4 +172,4 @@ def from_file_map(klass, file_map, *, mmap=True, keep_file_open=None):
         return klass(data, affine, header, extra=None, file_map=file_map)
 
 
-load = Minc2Image.load
+load = Minc2Image.from_filename

nibabel/spm2analyze.py

@@ -130,5 +130,5 @@ class Spm2AnalyzeImage(spm99.Spm99AnalyzeImage):
     header_class = Spm2AnalyzeHeader
 
 
-load = Spm2AnalyzeImage.load
+load = Spm2AnalyzeImage.from_filename
 save = Spm2AnalyzeImage.instance_to_filename

nibabel/spm99analyze.py

@@ -331,5 +331,5 @@ def to_file_map(self, file_map=None, dtype=None):
             sio.savemat(mfobj, {'M': M, 'mat': mat}, format='4')
 
 
-load = Spm99AnalyzeImage.load
+load = Spm99AnalyzeImage.from_filename
 save = Spm99AnalyzeImage.instance_to_filename