Add typing to test suite

Signed-off-by: Bernát Gábor <bgabor8@bloomberg.net>

Author: gaborbernat

Diff for: .dockerignore

@@ -0,0 +1,6 @@
+.tox*
+.*_cache
+*.egg-info
+Dockerfile
+build
+dist

Diff for: .gitignore

@@ -33,3 +33,4 @@ credentials.json
 pip-wheel-metadata
 .DS_Store
 .coverage.*
+Dockerfile

Diff for: pyproject.toml

@@ -6,8 +6,9 @@ build-backend = "setuptools.build_meta"
 line-length = 120
 
 [tool.isort]
+line_length = 120
 profile = "black"
-known_first_party = ["tox_ini_fmt"]
+known_first_party = ["tox", "tests"]
 
 [tool.setuptools_scm]
 write_to = "src/tox/version.py"

Diff for: setup.cfg

@@ -71,7 +71,7 @@ testing =
     wheel>=0.30
 
 [options.package_data]
-tox_ini_fmt = py.typed
+tox = py.typed
 
 [options.packages.find]
 where = src
@@ -113,5 +113,14 @@ ignore_missing_imports = True
 [mypy-pluggy.*]
 ignore_missing_imports = True
 
+[mypy-psutil.*]
+ignore_missing_imports = True
+
+[mypy-setuptools.*]
+ignore_missing_imports = True
+
 [mypy-virtualenv.*]
 ignore_missing_imports = True
+
+[mypy-wheel.*]
+ignore_missing_imports = True

Diff for: src/tox/config/cli/parser.py

@@ -6,27 +6,9 @@
 import logging
 import os
 import sys
-from argparse import (
-    SUPPRESS,
-    Action,
-    ArgumentDefaultsHelpFormatter,
-    ArgumentParser,
-    Namespace,
-    _SubParsersAction,
-)
+from argparse import SUPPRESS, Action, ArgumentDefaultsHelpFormatter, ArgumentParser, Namespace, _SubParsersAction
 from itertools import chain
-from typing import (
-    Any,
-    Callable,
-    Dict,
-    List,
-    Optional,
-    Sequence,
-    Tuple,
-    Type,
-    TypeVar,
-    cast,
-)
+from typing import Any, Callable, Dict, List, Optional, Sequence, Tuple, Type, TypeVar, cast
 
 from tox.config.source.ini.convert import StrConvert
 from tox.plugin import NAME

Diff for: src/tox/config/sets.py

@@ -137,22 +137,26 @@ def add_config(
         desc: str,
         post_process: Optional[Callable[[V, "Config"], V]] = None,
         overwrite: bool = False,
-    ) -> None:
+    ) -> ConfigDynamicDefinition[V]:
         """
         Add configuration value.
         """
         keys_ = self._make_keys(keys)
         for key in keys_:
             if key in self._defined and overwrite is False:
-                # already added
-                return
+                defined = self._defined[key]
+                if isinstance(defined, ConfigDynamicDefinition):
+                    return defined
+                raise TypeError(f"{keys} already defined with differing type {type(defined).__name__}")
         definition = ConfigDynamicDefinition(keys_, of_type, default, desc, post_process)
         self._add_conf(keys_, definition)
+        return definition
 
-    def add_constant(self, keys: Sequence[str], desc: str, value: V) -> None:
+    def add_constant(self, keys: Sequence[str], desc: str, value: V) -> ConfigConstantDefinition[V]:
         keys_ = self._make_keys(keys)
         definition = ConfigConstantDefinition(keys_, desc, value)
         self._add_conf(keys, definition)
+        return definition
 
     def make_package_conf(self) -> None:
         self._raw.make_package_conf()

Diff for: src/tox/config/source/ini/__init__.py

@@ -222,4 +222,6 @@ def __repr__(self) -> str:
 __all__ = (
     "ToxIni",
     "IniLoader",
+    "filter_for_env",
+    "find_envs",
 )

Diff for: src/tox/execute/local_sub_process/read_via_thread_unix.py

@@ -27,7 +27,10 @@ def _read_stream(self) -> None:
     def _drain_stream(self) -> bytes:
         result = bytearray()  # on closed file read returns empty
         while True:
-            last_result = os.read(self.file_no, 1)
+            try:
+                last_result = os.read(self.file_no, 1)
+            except OSError:  # ignore failing to read the pipe - already closed
+                break
             if last_result:
                 result.append(last_result[0])
             else:

Diff for: src/tox/pytest.py

@@ -7,10 +7,11 @@
 import textwrap
 from contextlib import contextmanager
 from pathlib import Path
-from typing import Any, Callable, Dict, Iterator, List, Optional, Sequence
+from typing import TYPE_CHECKING, Any, Callable, Dict, Iterator, List, Optional, Sequence
 
 import pytest
-from _pytest.capture import CaptureFixture
+from _pytest.capture import CaptureFixture as _CaptureFixture
+from _pytest.logging import LogCaptureFixture
 from _pytest.monkeypatch import MonkeyPatch
 
 import tox.run
@@ -23,6 +24,11 @@
 from tox.session.cmd.run.parallel import ENV_VAR_KEY
 from tox.session.state import State
 
+if TYPE_CHECKING:
+    CaptureFixture = _CaptureFixture[str]
+else:
+    CaptureFixture = _CaptureFixture
+
 
 @pytest.fixture(autouse=True)
 def ensure_logging_framework_not_altered() -> Iterator[None]:
@@ -77,7 +83,7 @@ def __init__(
         self,
         files: Dict[str, Any],
         path: Path,
-        capsys: CaptureFixture[str],
+        capsys: CaptureFixture,
         monkeypatch: MonkeyPatch,
     ) -> None:
         self.path = path
@@ -156,7 +162,13 @@ def __init__(self, cmd: Sequence[str], cwd: Path, code: int, out: str, err: str,
         self.code: int = code
         self.out: str = out
         self.err: str = err
-        self.state: Optional[State] = state
+        self._state: Optional[State] = state
+
+    @property
+    def state(self) -> State:
+        if self._state is None:
+            raise RuntimeError("no state")
+        return self._state
 
     @property
     def success(self) -> bool:
@@ -188,7 +200,7 @@ def shell_cmd(self) -> str:
 
 
 @pytest.fixture(name="tox_project")
-def init_fixture(tmp_path: Path, capsys: CaptureFixture[str], monkeypatch: MonkeyPatch) -> ToxProjectCreator:
+def init_fixture(tmp_path: Path, capsys: CaptureFixture, monkeypatch: MonkeyPatch) -> ToxProjectCreator:
     def _init(files: Dict[str, Any]) -> ToxProject:
         """create tox  projects"""
         return ToxProject(files, tmp_path, capsys, monkeypatch)
@@ -201,3 +213,14 @@ def empty_project(tox_project: ToxProjectCreator, monkeypatch: MonkeyPatch) -> T
     project = tox_project({"tox.ini": ""})
     monkeypatch.chdir(project.path)
     return project
+
+
+__all__ = (
+    "CaptureFixture",
+    "LogCaptureFixture",
+    "MonkeyPatch",
+    "ToxRunOutcome",
+    "ToxProject",
+    "ToxProjectCreator",
+    "check_os_environ",
+)

Diff for: src/tox/session/cmd/show_config.py

@@ -19,7 +19,7 @@ def tox_add_option(parser: ToxParser) -> None:
     env_list_flag(our)
 
 
-def display_config(state: State) -> None:
+def display_config(state: State) -> int:
     first = True
     if not state.options.env:
         print("[tox]")
@@ -33,6 +33,7 @@ def display_config(state: State) -> None:
         print(f"[testenv:{name}]")
         print(f"type = {type(tox_env).__name__}")
         print_conf(tox_env.conf)
+    return 0
 
 
 def print_conf(conf: ConfigSet) -> None:

Diff for: src/tox/tox_env/python/api.py

@@ -4,17 +4,7 @@
 import sys
 from abc import ABC, abstractmethod
 from pathlib import Path
-from typing import (
-    Any,
-    Dict,
-    List,
-    NamedTuple,
-    NoReturn,
-    Optional,
-    Sequence,
-    Union,
-    cast,
-)
+from typing import Any, Dict, List, NamedTuple, NoReturn, Optional, Sequence, Union, cast
 
 from packaging.requirements import Requirement
 from virtualenv.discovery.py_spec import PythonSpec

Diff for: src/tox/tox_env/python/virtual_env/package/api.py

@@ -17,10 +17,7 @@
 from ..api import VirtualEnv
 
 try:
-    from importlib.metadata import (  # type: ignore[attr-defined]
-        Distribution,
-        PathDistribution,
-    )
+    from importlib.metadata import Distribution, PathDistribution  # type: ignore[attr-defined]
 except ImportError:
     from importlib_metadata import Distribution, PathDistribution  # noqa
 

Diff for: tests/__init__.py

@@ -1,13 +1,14 @@
 import sys
+from typing import Callable
 
 import pytest
 
 pytest_plugins = "tox.pytest"
 
 
 @pytest.fixture(scope="session")
-def value_error():
-    def _fmt(msg):
+def value_error() -> Callable[[str], str]:
+    def _fmt(msg: str) -> str:
         return f'ValueError("{msg}"{"," if sys.version_info < (3, 7) else ""})'
 
     return _fmt

Diff for: tests/conftest.py

@@ -3,7 +3,7 @@
 from tox.pytest import ToxProjectCreator
 
 
-def test_setuptools_package_py_project(tox_project: ToxProjectCreator):
+def test_setuptools_package_py_project(tox_project: ToxProjectCreator) -> None:
     project = tox_project(
         {
             "tox.ini": """

Diff for: tests/integration/__init__.py

@@ -1,13 +1,16 @@
+from typing import Callable, Dict
+
 import pytest
 
 from tox.session.cmd.list_env import list_env
 from tox.session.cmd.run.parallel import run_parallel
 from tox.session.cmd.run.sequential import run_sequential
 from tox.session.cmd.show_config import display_config
+from tox.session.state import State
 
 
 @pytest.fixture()
-def core_handlers():
+def core_handlers() -> Dict[str, Callable[[State], int]]:
     return {
         "config": display_config,
         "c": display_config,

Diff for: tests/integration/tox_env/__init__.py

@@ -1,20 +1,24 @@
+from typing import Callable, Dict
+
 import pytest
 
 from tox.config.cli.parse import get_options
 from tox.config.override import Override
+from tox.pytest import CaptureFixture, LogCaptureFixture, MonkeyPatch
+from tox.session.state import State
 
 
-def test_verbose(monkeypatch):
+def test_verbose(monkeypatch: MonkeyPatch) -> None:
     parsed, _, __ = get_options("-v", "-v")
     assert parsed.verbosity == 4
 
 
-def test_verbose_compound(monkeypatch):
+def test_verbose_compound(monkeypatch: MonkeyPatch) -> None:
     parsed, _, __ = get_options("-vv")
     assert parsed.verbosity == 4
 
 
-def test_verbose_no_test_skip_missing(monkeypatch):
+def test_verbose_no_test_skip_missing(monkeypatch: MonkeyPatch) -> None:
     parsed, _, __ = get_options("--notest", "-vv", "--skip-missing-interpreters", "false", "--runner", "virtualenv")
     assert vars(parsed) == {
         "colored": "no",
@@ -29,7 +33,9 @@ def test_verbose_no_test_skip_missing(monkeypatch):
     }
 
 
-def test_env_var_exhaustive_parallel_values(monkeypatch, core_handlers):
+def test_env_var_exhaustive_parallel_values(
+    monkeypatch: MonkeyPatch, core_handlers: Dict[str, Callable[[State], int]]
+) -> None:
     monkeypatch.setenv("TOX_COMMAND", "run-parallel")
     monkeypatch.setenv("TOX_VERBOSE", "5")
     monkeypatch.setenv("TOX_QUIET", "1")
@@ -60,7 +66,7 @@ def test_env_var_exhaustive_parallel_values(monkeypatch, core_handlers):
     assert handlers == core_handlers
 
 
-def test_ini_help(monkeypatch, capsys):
+def test_ini_help(monkeypatch: MonkeyPatch, capsys: CaptureFixture) -> None:
     monkeypatch.setenv("TOX_VERBOSE", "5")
     monkeypatch.setenv("TOX_QUIET", "1")
     with pytest.raises(SystemExit) as context:
@@ -72,7 +78,9 @@ def test_ini_help(monkeypatch, capsys):
     assert "from env var TOX_QUIET" in out
 
 
-def test_bad_env_var(monkeypatch, capsys, caplog, value_error):
+def test_bad_env_var(
+    monkeypatch: MonkeyPatch, capsys: CaptureFixture, caplog: LogCaptureFixture, value_error: Callable[[str], str]
+) -> None:
     monkeypatch.setenv("TOX_VERBOSE", "should-be-number")
     monkeypatch.setenv("TOX_QUIET", "1.00")
     parsed, _, __ = get_options()