type check tests

Author: amorison

pyproject.toml

@@ -63,6 +63,7 @@ module = [
     "matplotlib.*",
     "mpl_toolkits.*",
     "pandas.*",
+    "pytest.*",
     "scipy.*",
 ]
 ignore_missing_imports = true

tests/conftest.py

@@ -1,25 +1,25 @@
-import pytest
+from pathlib import Path
 
+from pytest import FixtureRequest, fixture
 
-@pytest.fixture(scope="session")
-def repo_dir():
-    import pathlib
+from stagpy.stagyydata import StagyyData, Step
 
-    return pathlib.Path(__file__).parent.parent.resolve()
 
+@fixture(scope="session")
+def repo_dir() -> Path:
+    return Path(__file__).parent.parent.resolve()
 
-@pytest.fixture(scope="session", params=["ra-100000", "annulus"])
-def example_dir(request, repo_dir):
-    return repo_dir / "Examples" / request.param
 
+@fixture(scope="session", params=["ra-100000", "annulus"])
+def example_dir(request: FixtureRequest, repo_dir: Path) -> Path:
+    return repo_dir / "Examples" / request.param
 
-@pytest.fixture(scope="module")
-def sdat(example_dir):
-    import stagpy.stagyydata
 
-    return stagpy.stagyydata.StagyyData(example_dir)
+@fixture(scope="module")
+def sdat(example_dir: Path) -> StagyyData:
+    return StagyyData(example_dir)
 
 
-@pytest.fixture(scope="module")
-def step(sdat):
+@fixture(scope="module")
+def step(sdat: StagyyData) -> Step:
     return sdat.snaps[-1]

tests/test_args.py

@@ -1,11 +1,12 @@
 import re
 
 import pytest
+from pytest import CaptureFixture
 
 import stagpy.args
 
 
-def test_no_args(capsys):
+def test_no_args(capsys: CaptureFixture) -> None:
     stagpy.args.parse_args([])()
     output = capsys.readouterr()
     expected = re.compile(
@@ -14,7 +15,7 @@ def test_no_args(capsys):
     assert expected.fullmatch(output.out)
 
 
-def test_help(capsys):
+def test_help(capsys: CaptureFixture) -> None:
     with pytest.raises(SystemExit):
         stagpy.args.parse_args(["-h"])
     output = capsys.readouterr()
@@ -27,7 +28,7 @@ def test_help(capsys):
     assert expected.fullmatch(output.out)
 
 
-def test_invalid_argument(capsys):
+def test_invalid_argument(capsys: CaptureFixture) -> None:
     with pytest.raises(SystemExit):
         stagpy.args.parse_args(["-dummyinvalidarg"])
     output = capsys.readouterr()
@@ -37,49 +38,49 @@ def test_invalid_argument(capsys):
     assert expected.fullmatch(output.err)
 
 
-def test_invalid_subcmd(capsys):
+def test_invalid_subcmd(capsys: CaptureFixture) -> None:
     with pytest.raises(SystemExit):
         stagpy.args.parse_args(["dummyinvalidcmd"])
     output = capsys.readouterr()
     expected = re.compile(r"^usage: .*error:.*invalid choice:.*\n$", flags=re.DOTALL)
     assert expected.fullmatch(output.err)
 
 
-def test_field_subcmd():
+def test_field_subcmd() -> None:
     func = stagpy.args.parse_args(["field"])
     assert func is stagpy.field.cmd
 
 
-def test_rprof_subcmd():
+def test_rprof_subcmd() -> None:
     func = stagpy.args.parse_args(["rprof"])
     assert func is stagpy.rprof.cmd
 
 
-def test_time_cmd():
+def test_time_cmd() -> None:
     func = stagpy.args.parse_args(["time"])
     assert func is stagpy.time_series.cmd
 
 
-def test_plates_subcmd():
+def test_plates_subcmd() -> None:
     func = stagpy.args.parse_args(["plates"])
     assert func is stagpy.plates.cmd
 
 
-def test_info_subcmd():
+def test_info_subcmd() -> None:
     func = stagpy.args.parse_args(["info"])
     assert func is stagpy.commands.info_cmd
 
 
-def test_var_subcmd():
+def test_var_subcmd() -> None:
     func = stagpy.args.parse_args(["var"])
     assert func is stagpy.commands.var_cmd
 
 
-def test_version_subcmd():
+def test_version_subcmd() -> None:
     func = stagpy.args.parse_args(["version"])
     assert func is stagpy.commands.version_cmd
 
 
-def test_config_subcmd():
+def test_config_subcmd() -> None:
     func = stagpy.args.parse_args(["config"])
     assert func is stagpy.commands.config_cmd

tests/test_cli.py

@@ -1,26 +1,31 @@
+from __future__ import annotations
+
 import re
 import subprocess
+from pathlib import Path
 
-import pytest
+from pytest import FixtureRequest, fixture
 
 
-@pytest.fixture(params=[("ra-100000", 5, 1000), ("annulus", 100, 3000)])
-def dir_isnap(request, repo_dir):
+@fixture(params=[("ra-100000", 5, 1000), ("annulus", 100, 3000)])
+def dir_isnap(request: FixtureRequest, repo_dir: Path) -> tuple[Path, int, int]:
     return (
         repo_dir / "Examples" / request.param[0],
         request.param[1],
         request.param[2],
     )
 
 
-@pytest.fixture(
+@fixture(
     params=[
         ("stagpy field", ["stagpy_T_stream{:05d}.pdf"]),
         ("stagpy field -o=T.v3", ["stagpy_T_v3{:05d}.pdf"]),
         ("stagpy field -o=T-v3", ["stagpy_T{:05d}.pdf", "stagpy_v3{:05d}.pdf"]),
     ]
 )
-def all_cmd_field(request, dir_isnap):
+def all_cmd_field(
+    request: FixtureRequest, dir_isnap: tuple[Path, int, int]
+) -> tuple[str, list[str]]:
     cmd = request.param[0]
     cmd += " -p={}".format(dir_isnap[0])
     expected_files = []
@@ -29,13 +34,15 @@ def all_cmd_field(request, dir_isnap):
     return cmd, expected_files
 
 
-@pytest.fixture(
+@fixture(
     params=[
         ("stagpy rprof", ["stagpy_rprof_Tmean_{}.pdf"]),
         ("stagpy rprof -o=Tmean,vzabs", ["stagpy_rprof_Tmean_vzabs_{}.pdf"]),
     ]
 )
-def all_cmd_rprof(request, dir_isnap):
+def all_cmd_rprof(
+    request: FixtureRequest, dir_isnap: tuple[Path, int, int]
+) -> tuple[str, list[str]]:
     cmd = request.param[0]
     cmd += " -p={}".format(dir_isnap[0])
     expected_files = []
@@ -44,18 +51,20 @@ def all_cmd_rprof(request, dir_isnap):
     return cmd, expected_files
 
 
-@pytest.fixture(
+@fixture(
     params=[
         ("stagpy time -o Tmean.Nutop", ["stagpy_time_Tmean_Nutop.pdf"]),
     ]
 )
-def all_cmd_time(request, dir_isnap):
+def all_cmd_time(
+    request: FixtureRequest, dir_isnap: tuple[str, int, int]
+) -> tuple[str, list[str]]:
     cmd = request.param[0]
     cmd += " -p={}".format(dir_isnap[0])
     return cmd, request.param[1]
 
 
-@pytest.fixture(
+@fixture(
     params=[
         (
             "stagpy plates -o v2.dv2 -continents --field T",
@@ -67,7 +76,9 @@ def all_cmd_time(request, dir_isnap):
         ),
     ]
 )
-def all_cmd_plates(request, dir_isnap):
+def all_cmd_plates(
+    request: FixtureRequest, dir_isnap: tuple[str, int, int]
+) -> tuple[str, list[str]]:
     cmd = request.param[0]
     cmd += " -p={}".format(dir_isnap[0])
     expected_files = []
@@ -76,30 +87,30 @@ def all_cmd_plates(request, dir_isnap):
     return cmd, expected_files
 
 
-def helper_test_cli(all_cmd, tmp):
+def helper_test_cli(all_cmd: tuple[str, list[str]], tmp: Path) -> None:
     subprocess.run(all_cmd[0] + " -n={}/stagpy".format(tmp), shell=True)
     produced_files = sorted(tmp.iterdir())
     expected_files = [tmp / expfile for expfile in sorted(all_cmd[1])]
     assert produced_files == expected_files
 
 
-def test_field_cli(all_cmd_field, tmp_path):
+def test_field_cli(all_cmd_field: tuple[str, list[str]], tmp_path: Path) -> None:
     helper_test_cli(all_cmd_field, tmp_path)
 
 
-def test_rprof_cli(all_cmd_rprof, tmp_path):
+def test_rprof_cli(all_cmd_rprof: tuple[str, list[str]], tmp_path: Path) -> None:
     helper_test_cli(all_cmd_rprof, tmp_path)
 
 
-def test_time_cli(all_cmd_time, tmp_path):
+def test_time_cli(all_cmd_time: tuple[str, list[str]], tmp_path: Path) -> None:
     helper_test_cli(all_cmd_time, tmp_path)
 
 
-def test_plates_cli(all_cmd_plates, tmp_path):
+def test_plates_cli(all_cmd_plates: tuple[str, list[str]], tmp_path: Path) -> None:
     helper_test_cli(all_cmd_plates, tmp_path)
 
 
-def test_err_cli():
+def test_err_cli() -> None:
     subp = subprocess.run("stagpy field", shell=True, stderr=subprocess.PIPE)
     reg = re.compile(rb"^Oops!.*\nPlease.*\n\nNoParFileError.*$")
     assert reg.match(subp.stderr)

tests/test_commands.py

@@ -1,9 +1,12 @@
 import re
+from pathlib import Path
+
+from pytest import CaptureFixture
 
 import stagpy.commands
 
 
-def test_info_cmd(capsys, example_dir):
+def test_info_cmd(capsys: CaptureFixture, example_dir: Path) -> None:
     stagpy.conf.core.path = example_dir
     stagpy.commands.info_cmd()
     output = capsys.readouterr()
@@ -14,21 +17,21 @@ def test_info_cmd(capsys, example_dir):
     del stagpy.conf.core.path
 
 
-def test_var_cmd(capsys):
+def test_var_cmd(capsys: CaptureFixture) -> None:
     stagpy.commands.var_cmd()
     output = capsys.readouterr()
     expected = re.compile(r"field:\n.*\nrprof:\n.*\ntime:\n.*\n.*$", flags=re.DOTALL)
     assert expected.fullmatch(output.out)
 
 
-def test_version_cmd(capsys):
+def test_version_cmd(capsys: CaptureFixture) -> None:
     stagpy.commands.version_cmd()
     output = capsys.readouterr()
     expected = "stagpy version: {}\n".format(stagpy.__version__)
     assert output.out == expected
 
 
-def test_config_cmd(capsys):
+def test_config_cmd(capsys: CaptureFixture) -> None:
     stagpy.commands.config_cmd()
     output = capsys.readouterr()
     expected = "(c|f): available only as CLI argument/in the config file"

tests/test_field.py

@@ -3,48 +3,49 @@
 import stagpy.error
 import stagpy.field
 import stagpy.phyvars
+from stagpy.stagyydata import Step
 
 
-def test_field_unknown(step):
+def test_field_unknown(step: Step) -> None:
     with pytest.raises(stagpy.error.UnknownFieldVarError):
         step.fields["InvalidField"]
         assert "InvalidField" in step.fields
 
 
-def test_field_missing(step):
+def test_field_missing(step: Step) -> None:
     with pytest.raises(stagpy.error.MissingDataError):
         step.fields["rsc"]
     assert "rsc" not in step.fields
 
 
-def test_valid_field_var():
+def test_valid_field_var() -> None:
     for var in stagpy.phyvars.FIELD:
         assert stagpy.field.valid_field_var(var)
     for var in stagpy.phyvars.FIELD_EXTRA:
         assert stagpy.field.valid_field_var(var)
 
 
-def test_valid_field_var_invalid():
+def test_valid_field_var_invalid() -> None:
     assert not stagpy.field.valid_field_var("dummyfieldvar")
 
 
-def test_get_meshes_fld_no_walls(step):
+def test_get_meshes_fld_no_walls(step: Step) -> None:
     xmesh, ymesh, fld, meta = stagpy.field.get_meshes_fld(step, "T", walls=False)
     assert len(fld.shape) == 2
     assert xmesh.shape[0] == ymesh.shape[0] == fld.shape[0]
     assert xmesh.shape[1] == ymesh.shape[1] == fld.shape[1]
     assert meta.description == "Temperature"
 
 
-def test_get_meshes_fld_walls(step):
+def test_get_meshes_fld_walls(step: Step) -> None:
     xmesh, ymesh, fld, meta = stagpy.field.get_meshes_fld(step, "T", walls=True)
     assert len(fld.shape) == 2
     assert xmesh.shape[0] == ymesh.shape[0] == fld.shape[0] + 1
     assert xmesh.shape[1] == ymesh.shape[1] == fld.shape[1] + 1
     assert meta.description == "Temperature"
 
 
-def test_get_meshes_vec(step):
+def test_get_meshes_vec(step: Step) -> None:
     xmesh, ymesh, vec1, vec2 = stagpy.field.get_meshes_vec(step, "v")
     assert len(vec1.shape) == 2
     assert xmesh.shape[0] == ymesh.shape[0] == vec1.shape[0] == vec2.shape[0]

tests/test_helpers.py

@@ -2,19 +2,19 @@
 import stagpy._helpers
 
 
-def test_out_name_conf():
+def test_out_name_conf() -> None:
     oname = "something_fancy"
     stagpy.conf.core.outname = oname
     stem = "teapot"
     assert stagpy._helpers.out_name(stem) == oname + "_" + stem
     del stagpy.conf.core.outname
 
 
-def test_out_name_number():
+def test_out_name_number() -> None:
     assert stagpy._helpers.out_name("T", 123) == "stagpy_T00123"
 
 
-def test_baredoc():
+def test_baredoc() -> None:
     """
        Badly formatted docstring .. .