typ: Update type annotations

Author: effigies

templateflow/client.py

@@ -60,7 +60,7 @@ def __getattr__(self, name: str):
         msg = f"'{self.__class__.__name__}' object has no attribute '{name}'"
         raise AttributeError(msg) from None
 
-    def ls(self, template, **kwargs):
+    def ls(self, template, **kwargs) -> list[Path]:
         """
         List files pertaining to one or more templates.
 
@@ -124,7 +124,7 @@ def ls(self, template, **kwargs):
             )
         ]
 
-    def get(self, template, raise_empty=False, **kwargs):
+    def get(self, template, raise_empty=False, **kwargs) -> list[Path]:
         """
         Pull files pertaining to one or more templates down.
 
@@ -228,7 +228,7 @@ def get(self, template, raise_empty=False, **kwargs):
             return out_file[0]
         return out_file
 
-    def templates(self, **kwargs):
+    def templates(self, **kwargs) -> list[str]:
         """
         Return a list of available templates.
 
@@ -260,7 +260,7 @@ def templates(self, **kwargs):
         """
         return sorted(self.get_templates(**kwargs))
 
-    def get_metadata(self, template):
+    def get_metadata(self, template) -> dict[str, str]:
         """
         Fetch one file from one template.
 
@@ -288,7 +288,7 @@ def get_metadata(self, template):
             _datalad_get(filepath)
         return loads(filepath.read_text())
 
-    def get_citations(self, template, bibtex=False):
+    def get_citations(self, template, bibtex=False) -> list[str]:
         """
         Fetch template citations
 
@@ -308,13 +308,10 @@ def get_citations(self, template, bibtex=False):
         if not bibtex:
             return refs
 
-        return [
-            _to_bibtex(ref, template, idx, self.cache.config.timeout).rstrip()
-            for idx, ref in enumerate(refs, 1)
-        ]
+        return [_to_bibtex(ref, template, self.cache.config.timeout).rstrip() for ref in refs]
 
 
-def _datalad_get(config: CacheConfig, filepath: Path):
+def _datalad_get(config: CacheConfig, filepath: Path) -> None:
     if not filepath:
         return
 
@@ -331,7 +328,7 @@ def _datalad_get(config: CacheConfig, filepath: Path):
             raise
 
 
-def _s3_get(config: CacheConfig, filepath: Path):
+def _s3_get(config: CacheConfig, filepath: Path) -> None:
     from sys import stderr
     from urllib.parse import quote
 
@@ -365,7 +362,7 @@ def _s3_get(config: CacheConfig, filepath: Path):
         raise RuntimeError('ERROR, something went wrong')
 
 
-def _to_bibtex(doi, template, idx, timeout):
+def _to_bibtex(doi: str, template: str, timeout: float) -> str:
     if 'doi.org' not in doi:
         return doi
 

templateflow/conf/cache.py

@@ -19,7 +19,7 @@
 
 
 @cache
-def _have_datalad():
+def _have_datalad() -> bool:
     import importlib.util
 
     return importlib.util.find_spec('datalad') is not None
@@ -34,7 +34,7 @@ class CacheConfig:
     autoupdate: bool = field(default_factory=env_to_bool('TEMPLATEFLOW_AUTOUPDATE', True))
     timeout: int = field(default=10)
 
-    def __post_init__(self):
+    def __post_init__(self) -> None:
         global STACKLEVEL
         if self.use_datalad and not _have_datalad():
             self.use_datalad = False
@@ -46,7 +46,7 @@ def __post_init__(self):
 class S3Manager:
     s3_root: str
 
-    def install(self, path: Path, overwrite: bool, timeout: int):
+    def install(self, path: Path, overwrite: bool, timeout: int) -> None:
         from ._s3 import update
 
         update(path, local=True, overwrite=overwrite, silent=True, timeout=timeout)
@@ -56,7 +56,7 @@ def update(self, path: Path, local: bool, overwrite: bool, silent: bool, timeout
 
         return _update_s3(path, local=local, overwrite=overwrite, silent=silent, timeout=timeout)
 
-    def wipe(self, path: Path):
+    def wipe(self, path: Path) -> None:
         from shutil import rmtree
 
         def _onerror(func, path, excinfo):
@@ -72,7 +72,7 @@ def _onerror(func, path, excinfo):
 class DataladManager:
     source: str
 
-    def install(self, path: Path, overwrite: bool, timeout: int):
+    def install(self, path: Path, overwrite: bool, timeout: int) -> None:
         from datalad.api import install
 
         install(path=path, source=self.source, recursive=True)
@@ -91,7 +91,7 @@ def update(self, path: Path, local: bool, overwrite: bool, silent: bool, timeout
             return False
         return True
 
-    def wipe(self, path: Path):
+    def wipe(self, path: Path) -> None:
         print('TemplateFlow is configured in DataLad mode, wipe() has no effect')
 
 
@@ -101,7 +101,7 @@ class TemplateFlowCache:
     precached: bool = field(init=False)
     manager: DataladManager | S3Manager = field(init=False)
 
-    def __post_init__(self):
+    def __post_init__(self) -> None:
         self.manager = (
             DataladManager(self.config.origin)
             if self.config.use_datalad
@@ -133,13 +133,13 @@ def layout(self) -> BIDSLayout:
             ),
         )
 
-    def ensure(self):
+    def ensure(self) -> None:
         if not self.cached:
             self.manager.install(
                 self.config.root, overwrite=self.config.autoupdate, timeout=self.config.timeout
             )
 
-    def update(self, local: bool = False, overwrite: bool = True, silent: bool = False):
+    def update(self, local: bool = False, overwrite: bool = True, silent: bool = False) -> bool:
         if self.manager.update(
             self.config.root,
             local=local,
@@ -151,6 +151,6 @@ def update(self, local: bool = False, overwrite: bool = True, silent: bool = Fal
             return True
         return False
 
-    def wipe(self):
+    def wipe(self) -> None:
         self.__dict__.pop('layout', None)  # Uncache property
         self.manager.wipe(self.config.root)