Enforce mypy-cleanliness on trio._core

Author: pquentin

check.sh

@@ -23,6 +23,12 @@ flake8 trio/ \
     --ignore=D,E,W,F401,F403,F405,F821,F822\
     || EXIT_STATUS=$?
 
+# Run mypy
+# We specify Linux so that we get the same results on all platforms. Without
+# that, mypy would complain on macOS that epoll does not exist, and we can't
+# ignore it as it would cause a mypy error on Linux
+mypy -p trio._core --platform linux || EXIT_STATUS=$?
+
 # Finally, leave a really clear warning of any issues and exit
 if [ $EXIT_STATUS -ne 0 ]; then
     cat <<EOF

test-requirements.in

@@ -11,6 +11,7 @@ jedi           # for jedi code completion tests
 black; implementation_name == "cpython"
 flake8
 astor          # code generation
+mypy
 
 # https://github.com/python-trio/trio/pull/654#issuecomment-420518745
 typed_ast; implementation_name == "cpython"

test-requirements.txt

@@ -26,6 +26,8 @@ jedi==0.17.0              # via -r test-requirements.in, ipython
 lazy-object-proxy==1.4.3  # via astroid
 mccabe==0.6.1             # via flake8, pylint
 more-itertools==8.3.0     # via pytest
+mypy-extensions==0.4.3    # via mypy
+mypy==0.780               # via -r test-requirements.in
 outcome==1.0.1            # via -r test-requirements.in
 packaging==20.4           # via pytest
 parso==0.7.0              # via jedi
@@ -53,5 +55,6 @@ toml==0.10.1              # via black, pylint
 traitlets==4.3.3          # via ipython
 trustme==0.6.0            # via -r test-requirements.in
 typed-ast==1.4.1 ; implementation_name == "cpython"  # via -r test-requirements.in, black
+typing-extensions==3.7.4.2  # via mypy
 wcwidth==0.2.4            # via prompt-toolkit, pytest
 wrapt==1.12.1             # via astroid

trio/_core/__init__.py

@@ -4,6 +4,9 @@
 are publicly available in either trio, trio.lowlevel, or trio.testing.
 """
 
+import typing as _t
+import sys
+
 from ._exceptions import (
     TrioInternalError,
     RunFinishedError,
@@ -74,13 +77,18 @@
 from ._mock_clock import MockClock
 
 # Kqueue imports
-try:
-    from ._run import current_kqueue, monitor_kevent, wait_kevent
-except ImportError:
-    pass
+if (
+    sys.platform.startswith("freebsd")
+    or sys.platform.startswith("darwin")
+    or not _t.TYPE_CHECKING
+):
+    try:
+        from ._run import current_kqueue, monitor_kevent, wait_kevent
+    except ImportError:
+        pass
 
 # Windows imports
-try:
+if sys.platform == "win32":
     from ._run import (
         monitor_completion_key,
         current_iocp,
@@ -89,5 +97,3 @@
         write_overlapped,
         readinto_overlapped,
     )
-except ImportError:
-    pass

trio/_core/_io_epoll.py

@@ -1,6 +1,7 @@
 import select
 import attr
 from collections import defaultdict
+from typing import DefaultDict
 
 from .. import _core
 from ._run import _public
@@ -184,8 +185,10 @@ class EpollWaiters:
 class EpollIOManager:
     _epoll = attr.ib(factory=select.epoll)
     # {fd: EpollWaiters}
-    _registered = attr.ib(factory=lambda: defaultdict(EpollWaiters))
-    _force_wakeup = attr.ib(factory=WakeupSocketpair)
+    _registered = attr.ib(
+        factory=lambda: defaultdict(EpollWaiters), type=DefaultDict[int, EpollWaiters]
+    )
+    _force_wakeup = attr.ib(factory=WakeupSocketpair, type=WakeupSocketpair)
     _force_wakeup_fd = attr.ib(default=None)
 
     def __attrs_post_init__(self):

trio/_core/_io_kqueue.py

@@ -19,7 +19,7 @@ class _KqueueStatistics:
 
 @attr.s(slots=True, eq=False)
 class KqueueIOManager:
-    _kqueue = attr.ib(factory=select.kqueue)
+    _kqueue = attr.ib(factory=select.kqueue)  # type: ignore
     # {(ident, filter): Task or UnboundedQueue}
     _registered = attr.ib(factory=dict)
     _force_wakeup = attr.ib(factory=WakeupSocketpair)

trio/_core/_multierror.py

@@ -415,7 +415,7 @@ def traceback_exception_init(
         self.embedded = []
 
 
-traceback.TracebackException.__init__ = traceback_exception_init
+traceback.TracebackException.__init__ = traceback_exception_init  # type: ignore
 traceback_exception_original_format = traceback.TracebackException.format
 
 
@@ -427,7 +427,7 @@ def traceback_exception_format(self, *, chain=True):
         yield from (textwrap.indent(line, " " * 2) for line in exc.format(chain=chain))
 
 
-traceback.TracebackException.format = traceback_exception_format
+traceback.TracebackException.format = traceback_exception_format  # type: ignore
 
 
 def trio_excepthook(etype, value, tb):
@@ -489,7 +489,7 @@ class TrioFakeSysModuleForApport:
 
     fake_sys = TrioFakeSysModuleForApport()
     fake_sys.__dict__.update(sys.__dict__)
-    fake_sys.__excepthook__ = trio_excepthook
+    fake_sys.__excepthook__ = trio_excepthook  # type: ignore
     apport_python_hook.sys = fake_sys
 
     monkeypatched_or_warned = True

trio/_core/_run.py

@@ -16,6 +16,7 @@
 from contextvars import copy_context
 from math import inf
 from time import perf_counter
+from typing import TYPE_CHECKING, Any
 
 from sniffio import current_async_library_cvar
 
@@ -582,7 +583,7 @@ def shield(self):
         """
         return self._shield
 
-    @shield.setter
+    @shield.setter  # type: ignore  # "decorated property not supported"
     @enable_ki_protection
     def shield(self, new_value):
         if not isinstance(new_value, bool):
@@ -1150,7 +1151,7 @@ class GuestState:
     run_sync_soon_not_threadsafe = attr.ib()
     done_callback = attr.ib()
     unrolled_run_gen = attr.ib()
-    unrolled_run_next_send = attr.ib(factory=lambda: Value(None))
+    unrolled_run_next_send = attr.ib(factory=lambda: Value(None), type=object)
 
     def guest_tick(self):
         try:
@@ -2311,13 +2312,17 @@ async def checkpoint_if_cancelled():
     task._cancel_points += 1
 
 
-if os.name == "nt":
+if sys.platform == "win32":
     from ._io_windows import WindowsIOManager as TheIOManager
     from ._generated_io_windows import *
-elif hasattr(select, "epoll"):
+elif sys.platform == "linux" or (not TYPE_CHECKING and hasattr(select, "epoll")):
     from ._io_epoll import EpollIOManager as TheIOManager
     from ._generated_io_epoll import *
-elif hasattr(select, "kqueue"):
+elif (
+    sys.platform == "darwin"
+    or sys.platform.startswith("freebsd")
+    or (not TYPE_CHECKING and hasattr(select, "epoll"))
+):
     from ._io_kqueue import KqueueIOManager as TheIOManager
     from ._generated_io_kqueue import *
 else:  # pragma: no cover

trio/_core/tests/test_multierror.py

@@ -5,8 +5,8 @@
     extract_tb,
     print_exception,
     format_exception,
-    _cause_message,
 )
+from traceback import _cause_message  # type: ignore
 import sys
 import os
 import re