Enforce type annotations on functions

Author: amorison

pyproject.toml

@@ -5,7 +5,7 @@ build-backend = "setuptools.build_meta"
 [tool.setuptools_scm]
 
 [tool.mypy]
-check_untyped_defs = true
+disallow_untyped_defs = true
 
 [[tool.mypy.overrides]]
 module = [

stagpy/__init__.py

@@ -22,13 +22,17 @@
 import shutil
 import signal
 import sys
+import typing
 
 from pkg_resources import get_distribution, DistributionNotFound
 from setuptools_scm import get_version
 from loam.manager import ConfigurationManager
 
 from . import config
 
+if typing.TYPE_CHECKING:
+    from typing import NoReturn, Any
+
 
 def _env(var: str) -> bool:
     """Return whether var is set to True."""
@@ -40,7 +44,7 @@ def _env(var: str) -> bool:
 ISOLATED = _env('STAGPY_ISOLATED')
 
 
-def sigint_handler(*_):
+def sigint_handler(*_: Any) -> NoReturn:
     """Handler of SIGINT signal.
 
     It is set when you use StagPy as a command line tool to handle gracefully
@@ -50,7 +54,7 @@ def sigint_handler(*_):
     sys.exit()
 
 
-def _check_config():
+def _check_config() -> None:
     """Create config files as necessary."""
     config.CONFIG_DIR.mkdir(parents=True, exist_ok=True)
     verfile = config.CONFIG_DIR / '.version'
@@ -67,7 +71,7 @@ def _check_config():
             shutil.copy(str(stfile_local), str(stfile_conf))
 
 
-def load_mplstyle():
+def load_mplstyle() -> None:
     """Try to load conf.plot.mplstyle matplotlib style."""
     import matplotlib.pyplot as plt
     if conf.plot.mplstyle:

stagpy/__main__.py

@@ -7,7 +7,7 @@
 from . import DEBUG, sigint_handler
 
 
-def main():
+def main() -> None:
     """Implement StagPy entry point."""
     if not DEBUG:
         signal.signal(signal.SIGINT, sigint_handler)

stagpy/_helpers.py

@@ -9,7 +9,7 @@
 from . import conf
 
 if TYPE_CHECKING:
-    from typing import Optional, Any, List, Callable
+    from typing import Optional, Any, List, Callable, NoReturn
     from matplotlib.figure import Figure
     from numpy import ndarray
 
@@ -52,7 +52,7 @@ def scilabel(value: float, precision: int = 2) -> str:
 
 
 def saveplot(fig: Figure, *name_args: Any, close: bool = True,
-             **name_kwargs: Any):
+             **name_kwargs: Any) -> None:
     """Save matplotlib figure.
 
     You need to provide :data:`stem` as a positional or keyword argument (see
@@ -109,7 +109,7 @@ def list_of_vars(arg_plot: str) -> List[List[List[str]]]:
     return [lov for lov in lovs if lov]
 
 
-def find_in_sorted_arr(value: Any, array: ndarray, after=False) -> int:
+def find_in_sorted_arr(value: Any, array: ndarray, after: bool = False) -> int:
     """Return position of element in a sorted array.
 
     Returns:
@@ -150,7 +150,7 @@ def __init__(self, thunk: Callable[[T], V]):
         self._cache_name = f'_cropped_{self._name}'
         self.__doc__ = thunk.__doc__
 
-    def __get__(self, instance: T, _) -> V:
+    def __get__(self, instance: T, _: Any) -> V:
         try:
             return getattr(instance, self._cache_name)
         except AttributeError:
@@ -159,6 +159,6 @@ def __get__(self, instance: T, _) -> V:
         setattr(instance, self._cache_name, cached_value)
         return cached_value
 
-    def __set__(self, instance: T, _):
+    def __set__(self, instance: T, _: Any) -> NoReturn:
         raise AttributeError(
             f'Cannot set {self._name} property of {instance!r}')

stagpy/_step.py

@@ -19,7 +19,7 @@
 
 if typing.TYPE_CHECKING:
     from typing import (Dict, Any, Mapping, List, Iterator, Tuple, Optional,
-                        Callable)
+                        Callable, NoReturn)
     from numpy import ndarray
     from pandas import DataFrame, Series
     from .datatypes import Varf
@@ -148,7 +148,7 @@ def p_centers(self) -> ndarray:
     y_walls = p_walls
     y_centers = p_centers
 
-    def _init_shape(self):
+    def _init_shape(self) -> None:
         """Determine shape of geometry."""
         shape = self._step.sdat.par['geometry']['shape'].lower()
         aspect = self._header['aspect']
@@ -280,7 +280,7 @@ def _present_fields(self) -> List[str]:
     def __iter__(self) -> Iterator[str]:
         return iter(self._present_fields)
 
-    def __contains__(self, item) -> bool:
+    def __contains__(self, item: Any) -> bool:
         try:
             return self[item] is not None
         except error.MissingDataError:
@@ -289,7 +289,7 @@ def __contains__(self, item) -> bool:
     def __len__(self) -> int:
         return len(self._present_fields)
 
-    def __eq__(self, other) -> bool:
+    def __eq__(self, other: object) -> bool:
         return self is other
 
     def _get_raw_data(self, name: str) -> Tuple[List[str], Any]:
@@ -327,7 +327,7 @@ def _get_raw_data(self, name: str) -> Tuple[List[str], Any]:
                     break
         return list_fvar, parsed_data
 
-    def _set(self, name: str, fld: ndarray):
+    def _set(self, name: str, fld: ndarray) -> None:
         sdat = self.step.sdat
         col_fld = sdat._collected_fields
         col_fld.append((self.step.istep, name))
@@ -337,7 +337,7 @@ def _set(self, name: str, fld: ndarray):
                 del sdat.steps[istep].fields[fld_name]
         self._data[name] = Field(fld, self._vars[name])
 
-    def __delitem__(self, name):
+    def __delitem__(self, name: str) -> None:
         if name in self._data:
             del self._data[name]
 
@@ -404,7 +404,7 @@ def __getitem__(self, name: str) -> Optional[List[ndarray]]:
             self._data[name] = None
         return self._data[name]
 
-    def __iter__(self):
+    def __iter__(self) -> NoReturn:
         raise TypeError('tracers collection is not iterable')
 
 

stagpy/args.py

@@ -24,7 +24,7 @@ def _sub(cmd: Any, *sections: str) -> Subcmd:
     return Subcmd(baredoc(cmd), *sections, func=cmd_func)
 
 
-def _bare_cmd():
+def _bare_cmd() -> None:
     """Print help message when no arguments are given."""
     print(doc_module)
     print('Run `stagpy -h` for usage')

stagpy/commands.py

@@ -23,7 +23,7 @@
     from .datatypes import Varf, Varr, Vart
 
 
-def info_cmd():
+def info_cmd() -> None:
     """Print basic information about StagYY run.
 
     Other Parameters:
@@ -74,7 +74,8 @@ def info_cmd():
 
 
 def _pretty_print(key_val: Sequence[Tuple[str, str]], sep: str = ': ',
-                  min_col_width: int = 39, text_width: Optional[int] = None):
+                  min_col_width: int = 39,
+                  text_width: Optional[int] = None) -> None:
     """Print a iterable of key/values.
 
     Args:
@@ -117,14 +118,14 @@ def _pretty_print(key_val: Sequence[Tuple[str, str]], sep: str = ': ',
 
 
 def _layout(dict_vars: Mapping[str, Union[Varf, Varr, Vart]],
-            dict_vars_extra: Mapping[str, Callable]):
+            dict_vars_extra: Mapping[str, Callable]) -> None:
     """Print nicely [(var, description)] from phyvars."""
     desc = [(v, m.description) for v, m in dict_vars.items()]
     desc.extend((v, baredoc(m)) for v, m in dict_vars_extra.items())
     _pretty_print(desc, min_col_width=26)
 
 
-def var_cmd():
+def var_cmd() -> None:
     """Print a list of available variables.
 
     See :mod:`stagpy.phyvars` where the lists of variables organized by command
@@ -153,7 +154,7 @@ def var_cmd():
         print()
 
 
-def version_cmd():
+def version_cmd() -> None:
     """Print StagPy version.
 
     Use :data:`stagpy.__version__` to obtain the version in a script.
@@ -162,7 +163,7 @@ def version_cmd():
 
 
 def report_parsing_problems(
-        parsing_out: Tuple[Any, Sequence[Path], Sequence[Path]]):
+        parsing_out: Tuple[Any, Sequence[Path], Sequence[Path]]) -> None:
     """Output message about potential parsing problems."""
     _, empty, faulty = parsing_out
     if CONFIG_FILE in empty or CONFIG_FILE in faulty:
@@ -177,7 +178,7 @@ def report_parsing_problems(
               sep='\n', end='\n\n', file=sys.stderr)
 
 
-def config_pp(subs: Iterable[str]):
+def config_pp(subs: Iterable[str]) -> None:
     """Pretty print of configuration options.
 
     Args:
@@ -198,7 +199,7 @@ def config_pp(subs: Iterable[str]):
             print()
 
 
-def config_cmd():
+def config_cmd() -> None:
     """Configuration handling.
 
     Other Parameters:

stagpy/config.py

@@ -33,9 +33,9 @@ def _slice_or_int(arg: str) -> Union[slice, int]:
     return int(arg)
 
 
-def _list_of(from_str: Callable[[str], T]) -> Callable[[str], Tuple[T]]:
+def _list_of(from_str: Callable[[str], T]) -> Callable[[str], Tuple[T, ...]]:
     """Return fn parsing a str as a comma-separated list of given type."""
-    def parser(arg):
+    def parser(arg: str) -> Tuple[T, ...]:
         return tuple(from_str(v) for v in map(str.strip, arg.split(',')) if v)
     return parser
 

stagpy/field.py

@@ -18,6 +18,9 @@
     from typing import Tuple, Optional, Any, Iterable, Dict
     from numpy import ndarray
     from matplotlib.axes import Axes
+    from matplotlib.figure import Figure
+    from matplotlib.collections import QuadMesh
+    from matplotlib.colorbar import Colorbar
     from .datatypes import Varf
     from ._step import Step
 
@@ -154,7 +157,8 @@ def get_meshes_vec(
 
 
 def plot_scalar(step: Step, var: str, field: Optional[ndarray] = None,
-                axis: Optional[Axes] = None, **extra: Any):
+                axis: Optional[Axes] = None, **extra: Any
+                ) -> Tuple[Figure, Axes, QuadMesh, Colorbar]:
     """Plot scalar field.
 
     Args:
@@ -255,7 +259,7 @@ def plot_scalar(step: Step, var: str, field: Optional[ndarray] = None,
     return fig, axis, surf, cbar
 
 
-def plot_iso(axis: Axes, step: Step, var: str, **extra: Any):
+def plot_iso(axis: Axes, step: Step, var: str, **extra: Any) -> None:
     """Plot isocontours of scalar field.
 
     Args:
@@ -280,7 +284,7 @@ def plot_iso(axis: Axes, step: Step, var: str, **extra: Any):
     axis.contour(xmesh, ymesh, fld, **extra_opts)
 
 
-def plot_vec(axis: Axes, step: Step, var: str):
+def plot_vec(axis: Axes, step: Step, var: str) -> None:
     """Plot vector field.
 
     Args:
@@ -322,7 +326,7 @@ def _findminmax(
     return minmax
 
 
-def cmd():
+def cmd() -> None:
     """Implementation of field subcommand.
 
     Other Parameters:

stagpy/parfile.py

@@ -626,7 +626,7 @@
 })
 
 
-def _enrich_with_par(par_nml: Namelist, par_file: Path):
+def _enrich_with_par(par_nml: Namelist, par_file: Path) -> None:
     """Enrich a par namelist with the content of a file."""
     par_new = f90nml.read(str(par_file))
     for section, content in par_new.items():