Merge pull request testing-cabal#593 from stephenfin/typing

jelmer · web-flow · commit 121c3a1b7b1d · 2026-03-26T11:13:17.000Z
Another round of typing fixes
diff --git a/tests/test_assert_that.py b/tests/test_assert_that.py
@@ -74,7 +74,7 @@ def __str__(self) -> str:
         # Create a test class that inherits from the actual test class
         test_self = self
 
-        class Test(test_self.__class__):  # type: ignore[misc,name-defined]
+        class Test(test_self.__class__):
             def test(self):
                 test_self.assert_that_callable("foo", Matcher())
 
diff --git a/tests/test_content.py b/tests/test_content.py
@@ -260,7 +260,7 @@ def test___init___None_errors(self):
         # we are intentionally passing an invalid type
         self.assertThat(
             lambda: TracebackContent(None, None),
-            raises_value_error,  # type: ignore[arg-type]
+            raises_value_error,
         )
 
     def test___init___sets_ivars(self):
diff --git a/tests/test_content_type.py b/tests/test_content_type.py
@@ -54,7 +54,8 @@ def test_json_content(self):
         # The JSON content type represents implictly UTF-8 application/json.
         self.assertThat(JSON.type, Equals("application"))
         self.assertThat(JSON.subtype, Equals("json"))
-        self.assertThat(JSON.parameters, Equals({}))
+        expected_parameters: dict[str, str] = {}
+        self.assertThat(JSON.parameters, Equals(expected_parameters))
 
 
 def test_suite():
diff --git a/tests/test_fixturesupport.py b/tests/test_fixturesupport.py
@@ -23,7 +23,7 @@
 try:
     from fixtures.tests.helpers import LoggingFixture
 except ImportError:
-    LoggingFixture = None  # type: ignore
+    LoggingFixture = None
 
 
 class TestFixtureSupport(TestCase):
diff --git a/tests/test_run.py b/tests/test_run.py
@@ -25,7 +25,7 @@
 try:
     import testresources
 except ImportError:
-    testresources = None  # type: ignore
+    testresources = None
 
 
 if fixtures:
diff --git a/tests/test_testcase.py b/tests/test_testcase.py
@@ -2334,11 +2334,11 @@ def test_other_attribute(self):
         orig = PlaceHolder("foo")
         orig.thing = "fred"  # type: ignore[attr-defined]
         case = DecorateTestCaseResult(orig, self.make_result)
-        self.assertEqual("fred", case.thing)  # type: ignore[attr-defined]
+        self.assertEqual("fred", case.thing)
         self.assertRaises(AttributeError, getattr, case, "other")
-        case.other = "barbara"  # type: ignore[attr-defined]
+        case.other = "barbara"
         self.assertEqual("barbara", orig.other)  # type: ignore[attr-defined]
-        del case.thing  # type: ignore[attr-defined]
+        del case.thing
         self.assertRaises(AttributeError, getattr, orig, "thing")
 
 
diff --git a/tests/test_testresult.py b/tests/test_testresult.py
@@ -2108,11 +2108,13 @@ def setUp(self):
         self.result = TextTestResult(io.StringIO())
 
     def getvalue(self):
+        assert isinstance(self.result.stream, io.StringIO)
         return self.result.stream.getvalue()
 
     def test__init_sets_stream(self):
-        result = TextTestResult("fp")
-        self.assertEqual("fp", result.stream)
+        stream = io.StringIO()
+        result = TextTestResult(stream)
+        self.assertEqual(stream, result.stream)
 
     def reset_output(self):
         self.result.stream = io.StringIO()
@@ -2285,6 +2287,7 @@ def __init__(self, stream):
 
             def addSuccess(self, test, details=None):
                 super().addSuccess(test, details)
+                assert self.stream is not None
                 self.stream.write("CUSTOM_SUCCESS_MARKER\n")
 
         stream = io.StringIO()
@@ -2954,8 +2957,14 @@ def check_outcome_details_to_exec_info(self, outcome, expected=None):
             expected = outcome
         details, _err_str = self.get_details_and_string()
         getattr(self.converter, outcome)(self, details=details)
-        err = self.converter._details_to_exc_info(details)
-        self.assertEqual([(expected, self, err)], self.result._events)
+        expected_err = self.converter._details_to_exc_info(details)
+        self.assertEqual(1, len(self.result._events))
+        event_outcome, event_test, event_err = self.result._events[0]
+        self.assertEqual(expected, event_outcome)
+        self.assertEqual(self, event_test)
+        # Compare exc type and value; traceback objects differ between calls
+        self.assertEqual(expected_err[:2], event_err[:2])
+        self.assertIsNotNone(event_err[2])
 
     def check_outcome_details_to_nothing(self, outcome, expected=None):
         """Call an outcome with a details dict to be swallowed."""
@@ -3556,7 +3565,7 @@ def test_no_details(self):
 
     def test_binary_content(self):
         content = content_from_stream(
-            io.StringIO("foo"), content_type=ContentType("image", "jpeg")
+            io.BytesIO(b"foo"), content_type=ContentType("image", "jpeg")
         )
         string = _details_to_str({"attachment": content})
         self.assertThat(
@@ -3611,16 +3620,16 @@ def test_empty_attachment(self):
         )
 
     def test_lots_of_different_attachments(self):
-        def jpg(x):
-            return content_from_stream(io.StringIO(x), ContentType("image", "jpeg"))
+        def jpg(x: bytes) -> Content:
+            return content_from_stream(io.BytesIO(x), ContentType("image", "jpeg"))
 
         attachments = {
             "attachment": text_content("foo"),
             "attachment-1": text_content("traceback"),
-            "attachment-2": jpg("pic1"),
+            "attachment-2": jpg(b"pic1"),
             "attachment-3": text_content("bar"),
             "attachment-4": text_content(""),
-            "attachment-5": jpg("pic2"),
+            "attachment-5": jpg(b"pic2"),
         }
         string = _details_to_str(attachments, special="attachment-1")
         self.assertThat(
@@ -3648,7 +3657,7 @@ def setUp(self):
         self.log = []
         self.result = TestByTestResult(self.on_test)
         now = iter(range(5))
-        self.result._now = lambda: next(now)  # type: ignore[method-assign]
+        self.result._now = lambda: next(now)  # type: ignore[method-assign,assignment,return-value]
 
     def assertCalled(self, **kwargs):
         defaults = {
diff --git a/tests/test_testsuite.py b/tests/test_testsuite.py
@@ -391,7 +391,7 @@ class TestIterateTests(TestCase):
     def test_iterate_suite(self):
         a = PlaceHolder("a")
         b = PlaceHolder("b")
-        suite = unittest.TestSuite([a, b])  # type: ignore[list-item]
+        suite = unittest.TestSuite([a, b])
         self.assertEqual([a, b], list(iterate_tests(suite)))
 
     def test_iterate_single_test(self):
@@ -413,7 +413,7 @@ class Subclass(unittest.TestSuite):
             def sort_tests(self):
                 self._tests = sorted_tests(self, True)
 
-        input_suite = Subclass([b, a])  # type: ignore[list-item]
+        input_suite = Subclass([b, a])
         suite = sorted_tests(input_suite)
         self.assertEqual([a, b], list(iterate_tests(suite)))
         self.assertEqual([input_suite], list(iter(suite)))
@@ -425,22 +425,22 @@ def test_custom_suite_without_sort_tests_works(self):
         class Subclass(unittest.TestSuite):
             pass
 
-        input_suite = Subclass([b, a])  # type: ignore[list-item]
+        input_suite = Subclass([b, a])
         suite = sorted_tests(input_suite)
         self.assertEqual([b, a], list(iterate_tests(suite)))
         self.assertEqual([input_suite], list(iter(suite)))
 
     def test_sorts_simple_suites(self):
         a = PlaceHolder("a")
         b = PlaceHolder("b")
-        suite = sorted_tests(unittest.TestSuite([b, a]))  # type: ignore[list-item]
+        suite = sorted_tests(unittest.TestSuite([b, a]))
         self.assertEqual([a, b], list(iterate_tests(suite)))
 
     def test_duplicate_simple_suites(self):
         a = PlaceHolder("a")
         b = PlaceHolder("b")
         c = PlaceHolder("a")
-        self.assertRaises(ValueError, sorted_tests, unittest.TestSuite([a, b, c]))  # type: ignore[list-item]
+        self.assertRaises(ValueError, sorted_tests, unittest.TestSuite([a, b, c]))
 
     def test_multiple_duplicates(self):
         # If there are multiple duplicates on a test suite, we report on them
@@ -450,9 +450,7 @@ def test_multiple_duplicates(self):
         c = PlaceHolder("a")
         d = PlaceHolder("b")
         error = self.assertRaises(
-            ValueError,
-            sorted_tests,
-            unittest.TestSuite([a, b, c, d]),  # type: ignore[list-item]
+            ValueError, sorted_tests, unittest.TestSuite([a, b, c, d])
         )
         self.assertThat(
             str(error),
diff --git a/tests/twistedsupport/test_runtest.py b/tests/twistedsupport/test_runtest.py
@@ -45,21 +45,21 @@
         flush_logged_errors,
     )
 except ImportError:
-    assert_fails_with = None  # type: ignore[assignment,misc]
+    assert_fails_with = None  # type: ignore[assignment]
     AsynchronousDeferredRunTest = None  # type: ignore[assignment,misc]
-    flush_logged_errors = None  # type: ignore[assignment,misc]
+    flush_logged_errors = None  # type: ignore[assignment]
     SynchronousDeferredRunTest = None  # type: ignore[assignment,misc]
 
 try:
     from twisted.internet import defer
 except ImportError:
-    defer = None  # type: ignore[assignment,misc]
+    defer = None  # type: ignore[assignment]
 
 try:
     from twisted.python import failure, log
 except ImportError:
-    failure = None  # type: ignore[assignment,misc]
-    log = None  # type: ignore[assignment,misc]
+    failure = None  # type: ignore[assignment]
+    log = None  # type: ignore[assignment]
 
 try:
     from twisted.internet.base import DelayedCall
@@ -69,7 +69,7 @@
 try:
     from testtools.twistedsupport._runtest import _get_global_publisher_and_observers
 except ImportError:
-    _get_global_publisher_and_observers = None  # type: ignore[assignment,misc]
+    _get_global_publisher_and_observers = None  # type: ignore[assignment]
 
 
 class X:
@@ -306,7 +306,7 @@ def test_something(self):
 
         def fire_deferred():
             self.assertThat(call_log, Equals(["setUp"]))
-            d.callback(marker)  # type: ignore[arg-type]
+            d.callback(marker)
 
         test = SomeCase("test_something")
         timeout = self.make_timeout()
diff --git a/testtools/_types.py b/testtools/_types.py
@@ -0,0 +1,8 @@
+# Copyright (c) 2026 testtools developers. See LICENSE for details.
+
+from types import TracebackType
+from typing import TypeAlias
+
+# Type for exc_info tuples from sys.exc_info()
+ExcInfo: TypeAlias = tuple[type[BaseException], BaseException, TracebackType]
+OptExcInfo: TypeAlias = ExcInfo | tuple[None, None, None]
diff --git a/testtools/content.py b/testtools/content.py
@@ -21,6 +21,7 @@
 from collections.abc import Callable, Iterable, Iterator
 from typing import IO, Any, Protocol, TypeAlias, runtime_checkable
 
+from testtools._types import OptExcInfo
 from testtools.content_type import JSON, UTF8_TEXT, ContentType
 
 # Type for JSON-serializable data
@@ -197,8 +198,7 @@ class TracebackContent(Content):
 
     def __init__(
         self,
-        err: tuple[type[BaseException], BaseException, types.TracebackType | None]
-        | tuple[None, None, None],
+        err: OptExcInfo,
         test: _TestCase | None,
         capture_locals: bool = False,
     ) -> None:
diff --git a/testtools/matchers/_exception.py b/testtools/matchers/_exception.py
@@ -7,19 +7,15 @@
 ]
 
 import sys
-import types
 from collections.abc import Callable
-from typing import TypeAlias, TypeVar
+from typing import TypeVar
+
+from testtools._types import ExcInfo
 
 from ._basic import MatchesRegex
 from ._higherorder import AfterPreprocessing
 from ._impl import Matcher, Mismatch
 
-# Type for exc_info tuples
-ExcInfo: TypeAlias = tuple[
-    type[BaseException], BaseException, types.TracebackType | None
-]
-
 T = TypeVar("T", bound=BaseException)
 
 _error_repr = BaseException.__repr__
@@ -38,10 +34,10 @@ class MatchesException(Matcher[ExcInfo]):
 
     def __init__(
         self,
-        exception: BaseException
-        | type[BaseException]
-        | tuple[type[BaseException], ...],
-        value_re: "str | Matcher[BaseException] | None" = None,
+        exception: (
+            BaseException | type[BaseException] | tuple[type[BaseException], ...]
+        ),
+        value_re: str | Matcher[object] | None = None,
     ) -> None:
         """Create a MatchesException that will match exc_info's for exception.
 
@@ -58,7 +54,7 @@ def __init__(
         """
         Matcher.__init__(self)
         self.expected = exception
-        value_matcher: Matcher[BaseException] | None
+        value_matcher: Matcher[object] | None
         if isinstance(value_re, str):
             value_matcher = AfterPreprocessing(str, MatchesRegex(value_re), False)
         else:
@@ -118,7 +114,7 @@ class Raises(Matcher[Callable[[], object]]):
     Raises.match call unless they are explicitly matched.
     """
 
-    def __init__(self, exception_matcher: "Matcher[ExcInfo] | None" = None) -> None:
+    def __init__(self, exception_matcher: Matcher[ExcInfo] | None = None) -> None:
         """Create a Raises matcher.
 
         :param exception_matcher: Optional validator for the exception raised
diff --git a/testtools/runtest.py b/testtools/runtest.py
@@ -11,8 +11,8 @@
 from collections.abc import Callable
 from typing import TYPE_CHECKING, Any, NoReturn
 
+from testtools._types import ExcInfo
 from testtools.testresult import (
-    ExcInfo,
     ExtendedToOriginalDecorator,
     TestResult,
 )
diff --git a/testtools/testcase.py b/testtools/testcase.py
diff --git a/testtools/testresult/__init__.py b/testtools/testresult/__init__.py
diff --git a/testtools/testresult/doubles.py b/testtools/testresult/doubles.py
diff --git a/testtools/testresult/real.py b/testtools/testresult/real.py

Original file line number	Diff line number	Diff line change
`@@ -260,7 +260,7 @@ def test___init___None_errors(self):`
`260`	`260`	`# we are intentionally passing an invalid type`
`261`	`261`	`self.assertThat(`
`262`	`262`	`lambda: TracebackContent(None, None),`
`263`		`- raises_value_error, # type: ignore[arg-type]`
	`263`	`+ raises_value_error,`
`264`	`264`	`)`
`265`	`265`
`266`	`266`	`def test___init___sets_ivars(self):`