Make mypy stricter

Well, sort of. We immediately disable many of the strict checks for most
modules, but doing things this way allows us to iteratively add types.

Signed-off-by: Stephen Finucane <[email protected]>

Author: stephenfin

pyproject.toml

@@ -57,9 +57,16 @@ __version__ = {version_tuple!r}
 only-include = ["testtools"]
 
 [tool.mypy]
-warn_redundant_casts = true
-warn_unused_configs = true
-check_untyped_defs = true
+python_version = "3.10"
+show_column_numbers = true
+show_error_context = true
+strict = true
+# this is here temporarily due to the rapid changes in typing across
+# dependencies
+warn_unused_ignores = false
+# FIXME(stephenfin): We should remove this
+implicit_reexport = true
+exclude = 'doc'
 
 [[tool.mypy.overrides]]
 module = [
@@ -68,6 +75,30 @@ module = [
 ]
 ignore_missing_imports = true
 
+[[tool.mypy.overrides]]
+module = [
+    # FIXME(stephenfin): We would like to remove all modules from this list
+    # except testtools.tests (we're not sadists)
+    "testtools.assertions",
+    "testtools.compat",
+    "testtools.content",
+    "testtools.content_type",
+    "testtools.matchers.*",
+    "testtools.monkey",
+    "testtools.run",
+    "testtools.runtest",
+    "testtools.tags",
+    "testtools.testcase",
+    "testtools.testresult.*",
+    "testtools.testsuite",
+    "testtools.twistedsupport.*",
+    "testtools.tests.*",
+]
+disallow_untyped_calls = false
+disallow_untyped_defs = false
+disallow_subclassing_any = false
+disallow_any_generics = false
+
 [tool.ruff.lint]
 select = [
     "E",
@@ -78,8 +109,7 @@ select = [
     "RSE",
     "RUF",
 ]
-ignore = [
-]
+ignore = []
 
 [tool.ruff.lint.pydocstyle]
 convention = "google"

testtools/__init__.py

@@ -94,7 +94,7 @@
 )
 
 
-def __get_git_version():
+def __get_git_version() -> str | None:
     import os
     import subprocess
 
@@ -135,9 +135,10 @@ def __get_git_version():
     from ._version import __version__, version
 except ModuleNotFoundError:
     # package is not installed
-    if version := __get_git_version():
+    if v := __get_git_version():
+        version = v
         # we're in a git repo
-        __version__ = tuple([int(v) if v.isdigit() else v for v in version.split(".")])
+        __version__ = tuple([int(x) if x.isdigit() else x for x in version.split(".")])
     else:
         # we're working with a tarball or similar
         version = "0.0.0"

testtools/compat.py

@@ -16,14 +16,20 @@
 import locale
 import os
 import sys
-import typing
+import types
+from typing import Any, NoReturn
 import unicodedata
 
 # Ensure retro-compatibility with older testtools releases
 from io import BytesIO, StringIO
 
 
-def reraise(exc_class, exc_obj, exc_tb, _marker=object()) -> typing.NoReturn:
+def reraise(
+    exc_class: type[BaseException],
+    exc_obj: BaseException,
+    exc_tb: types.TracebackType,
+    _marker: Any = object(),
+) -> NoReturn:
     """Re-raise an exception received from sys.exc_info() or similar."""
     raise exc_obj.with_traceback(exc_tb)
 

testtools/matchers/_dict.py

@@ -4,7 +4,7 @@
     "KeysEqual",
 ]
 
-from typing import ClassVar
+from typing import Any, ClassVar
 
 from ..helpers import (
     dict_subtract,
@@ -132,7 +132,7 @@ def match(self, super_dict):
         return _SubDictOf(super_dict, self.format_value).match(self.sub_dict)
 
 
-def _format_matcher_dict(matchers):
+def _format_matcher_dict(matchers: dict[str, Matcher]) -> str:
     return "{{{}}}".format(
         ", ".join(sorted(f"{k!r}: {v}" for k, v in matchers.items()))
     )
@@ -180,7 +180,7 @@ class MatchesDict(_CombinedMatcher):
         "Differences": _MatchCommonKeys,
     }
 
-    def format_expected(self, expected) -> str:
+    def format_expected(self, expected: dict[str, Matcher]) -> str:
         return _format_matcher_dict(expected)
 
 
@@ -204,7 +204,7 @@ class ContainsDict(_CombinedMatcher):
         "Differences": _MatchCommonKeys,
     }
 
-    def format_expected(self, expected):
+    def format_expected(self, expected: dict[str, Matcher]) -> str:
         return _format_matcher_dict(expected)
 
 
@@ -228,7 +228,7 @@ class ContainedByDict(_CombinedMatcher):
         "Differences": _MatchCommonKeys,
     }
 
-    def format_expected(self, expected):
+    def format_expected(self, expected: dict[str, Matcher]) -> str:
         return _format_matcher_dict(expected)
 
 

testtools/testcase.py

@@ -20,7 +20,7 @@
 import itertools
 import sys
 import unittest
-from typing import Any, Protocol, TypeVar
+from typing import cast, Any, Protocol, TypeVar
 from unittest.case import SkipTest
 
 from testtools import content
@@ -971,11 +971,11 @@ class WithAttributes:
     _get_test_method: Any  # Provided by the class we're mixed with
 
     def id(self) -> str:
-        orig = super().id()  # type: ignore[misc]
+        orig = cast(str, super().id())  # type: ignore[misc]
         # Depends on testtools.TestCase._get_test_method, be nice to support
         # plain unittest.
         fn = self._get_test_method()
-        attributes = getattr(fn, "__testtools_attrs", None)
+        attributes = cast(str, getattr(fn, "__testtools_attrs", None))
         if not attributes:
             return orig
         return orig + "[" + ",".join(sorted(attributes)) + "]"

testtools/testresult/doubles.py

@@ -134,7 +134,9 @@ def startTest(self, test):
         self._tags = TagContext(self._tags)
 
     def stopTest(self, test):
-        self._tags = self._tags.parent
+        # NOTE: In Python 3.12.1 skipped tests may not call startTest()
+        if self._tags is not None and self._tags.parent is not None:
+            self._tags = self._tags.parent
         super().stopTest(test)
 
     @property

testtools/testresult/real.py

@@ -237,7 +237,7 @@ def startTest(self, test):
 
     def stopTest(self, test):
         # NOTE: In Python 3.12.1 skipped tests may not call startTest()
-        if self._tags is not None:
+        if self._tags is not None and self._tags.parent is not None:
             self._tags = self._tags.parent
         super().stopTest(test)
 
@@ -1701,7 +1701,7 @@ def stop(self):
 
     def stopTest(self, test):
         # NOTE: In Python 3.12.1 skipped tests may not call startTest()
-        if self._tags is not None:
+        if self._tags is not None and self._tags.parent is not None:
             self._tags = self._tags.parent
         return self.decorated.stopTest(test)