Several typecheck improvements related to mypy 0.941.

This changes the way we test for specific platforms according to what mypy
understands and it runs mypy in CI against all platforms (linux/win32/darwin).

Author: jonathanslenders

.github/workflows/test.yaml

@@ -32,7 +32,9 @@ jobs:
         # Check wheather the imports were sorted correctly.
         # When this fails, please run ./tools/sort-imports.sh
         run: |
-          mypy --strict prompt_toolkit
+          mypy --strict prompt_toolkit --platform win32
+          mypy --strict prompt_toolkit --platform linux
+          mypy --strict prompt_toolkit --platform darwin
           isort -c --profile black prompt_toolkit examples tests setup.py
           black --check prompt_toolkit examples tests setup.py
       - name: Validate README.md

mypy.ini

@@ -1,6 +1,4 @@
 [mypy]
-platform = win32
-
 # --strict.
 check_untyped_defs = True
 disallow_any_generics = True

prompt_toolkit/application/application.py

@@ -89,7 +89,6 @@
 )
 from prompt_toolkit.utils import Event, in_main_thread
 
-from ..utils import is_windows
 from .current import get_app_session, set_app
 from .run_in_terminal import in_terminal, run_in_terminal
 
@@ -663,7 +662,7 @@ async def run_async(
         """
         assert not self._is_running, "Application is already running."
 
-        if not in_main_thread() or is_windows():
+        if not in_main_thread() or sys.platform == "win32":
             # Handling signals in other threads is not supported.
             # Also on Windows, `add_signal_handler(signal.SIGINT, ...)` raises
             # `NotImplementedError`.

prompt_toolkit/eventloop/inputhook.py

@@ -26,13 +26,12 @@
 import os
 import select
 import selectors
+import sys
 import threading
 from asyncio import AbstractEventLoop
 from selectors import BaseSelector, SelectorKey
 from typing import TYPE_CHECKING, Any, Callable, List, Mapping, Optional, Tuple
 
-from prompt_toolkit.utils import is_windows
-
 from .utils import get_event_loop
 
 __all__ = [
@@ -141,7 +140,7 @@ def input_is_ready() -> bool:
             #       However, if we would ever want to add a select call, it
             #       should use `windll.kernel32.WaitForMultipleObjects`,
             #       because `select.select` can't wait for a pipe on Windows.
-            if not is_windows():
+            if sys.platform != "win32":
                 select.select([self._r], [], [], None)
 
             os.read(self._r, 1024)

prompt_toolkit/eventloop/win32.py

@@ -1,3 +1,7 @@
+import sys
+
+assert sys.platform == "win32"
+
 from ctypes import pointer
 
 from ..utils import SPHINX_AUTODOC_RUNNING

prompt_toolkit/input/defaults.py

@@ -1,8 +1,6 @@
 import sys
 from typing import ContextManager, Optional, TextIO
 
-from prompt_toolkit.utils import is_windows
-
 from .base import DummyInput, Input, PipeInput
 
 __all__ = [
@@ -23,7 +21,7 @@ def create_input(
         `sys.stdin`. (We can open `stdout` or `stderr` for reading, this is how
         a `$PAGER` works.)
     """
-    if is_windows():
+    if sys.platform == "win32":
         from .win32 import Win32Input
 
         # If `stdin` was assigned `None` (which happens with pythonw.exe), use
@@ -61,7 +59,7 @@ def create_pipe_input() -> ContextManager[PipeInput]:
     Breaking change: In prompt_toolkit 3.0.28 and earlier, this was returning
     the `PipeInput` directly, rather than through a context manager.
     """
-    if is_windows():
+    if sys.platform == "win32":
         from .win32_pipe import Win32PipeInput
 
         return Win32PipeInput.create()

prompt_toolkit/input/posix_pipe.py

@@ -1,3 +1,7 @@
+import sys
+
+assert sys.platform != "win32"
+
 import os
 from contextlib import contextmanager
 from typing import ContextManager, Iterator, TextIO, cast

prompt_toolkit/input/vt100.py

@@ -1,6 +1,9 @@
+import sys
+
+assert sys.platform != "win32"
+
 import contextlib
 import io
-import sys
 import termios
 import tty
 from asyncio import AbstractEventLoop

prompt_toolkit/input/win32.py

@@ -7,6 +7,8 @@
 
 from ..utils import SPHINX_AUTODOC_RUNNING
 
+assert sys.platform == "win32"
+
 # Do not import win32-specific stuff when generating documentation.
 # Otherwise RTD would be unable to generate docs for this module.
 if not SPHINX_AUTODOC_RUNNING:

prompt_toolkit/input/win32_pipe.py

@@ -1,3 +1,7 @@
+import sys
+
+assert sys.platform == "win32"
+
 from contextlib import contextmanager
 from ctypes import windll
 from ctypes.wintypes import HANDLE

prompt_toolkit/key_binding/bindings/mouse.py

@@ -1,3 +1,4 @@
+import sys
 from typing import TYPE_CHECKING, FrozenSet
 
 from prompt_toolkit.data_structures import Point
@@ -9,7 +10,6 @@
     MouseEventType,
     MouseModifier,
 )
-from prompt_toolkit.utils import is_windows
 
 from ..key_bindings import KeyBindings
 
@@ -303,41 +303,42 @@ def _mouse(event: E) -> "NotImplementedOrNone":
         """
         Handling of mouse events for Windows.
         """
-        assert is_windows()  # This key binding should only exist for Windows.
-
-        # Parse data.
-        pieces = event.data.split(";")
-
-        button = MouseButton(pieces[0])
-        event_type = MouseEventType(pieces[1])
-        x = int(pieces[2])
-        y = int(pieces[3])
-
-        # Make coordinates absolute to the visible part of the terminal.
-        output = event.app.renderer.output
-
-        from prompt_toolkit.output.win32 import Win32Output
-        from prompt_toolkit.output.windows10 import Windows10_Output
-
-        if isinstance(output, (Win32Output, Windows10_Output)):
-            screen_buffer_info = output.get_win32_screen_buffer_info()
-            rows_above_cursor = (
-                screen_buffer_info.dwCursorPosition.Y - event.app.renderer._cursor_pos.y
-            )
-            y -= rows_above_cursor
-
-            # Call the mouse event handler.
-            # (Can return `NotImplemented`.)
-            handler = event.app.renderer.mouse_handlers.mouse_handlers[y][x]
-
-            return handler(
-                MouseEvent(
-                    position=Point(x=x, y=y),
-                    event_type=event_type,
-                    button=button,
-                    modifiers=UNKNOWN_MODIFIER,
+        # This key binding should only exist for Windows.
+        if sys.platform == "win32":
+            # Parse data.
+            pieces = event.data.split(";")
+
+            button = MouseButton(pieces[0])
+            event_type = MouseEventType(pieces[1])
+            x = int(pieces[2])
+            y = int(pieces[3])
+
+            # Make coordinates absolute to the visible part of the terminal.
+            output = event.app.renderer.output
+
+            from prompt_toolkit.output.win32 import Win32Output
+            from prompt_toolkit.output.windows10 import Windows10_Output
+
+            if isinstance(output, (Win32Output, Windows10_Output)):
+                screen_buffer_info = output.get_win32_screen_buffer_info()
+                rows_above_cursor = (
+                    screen_buffer_info.dwCursorPosition.Y
+                    - event.app.renderer._cursor_pos.y
+                )
+                y -= rows_above_cursor
+
+                # Call the mouse event handler.
+                # (Can return `NotImplemented`.)
+                handler = event.app.renderer.mouse_handlers.mouse_handlers[y][x]
+
+                return handler(
+                    MouseEvent(
+                        position=Point(x=x, y=y),
+                        event_type=event_type,
+                        button=button,
+                        modifiers=UNKNOWN_MODIFIER,
+                    )
                 )
-            )
 
         # No mouse handler found. Return `NotImplemented` so that we don't
         # invalidate the UI.

prompt_toolkit/output/conemu.py

@@ -1,3 +1,7 @@
+import sys
+
+assert sys.platform == "win32"
+
 from typing import Any, Optional, TextIO
 
 from prompt_toolkit.data_structures import Size

prompt_toolkit/output/defaults.py

@@ -5,7 +5,6 @@
     get_bell_environment_variable,
     get_term_environment_variable,
     is_conemu_ansi,
-    is_windows,
 )
 
 from .base import DummyOutput, Output
@@ -68,7 +67,7 @@ def create_output(
     while isinstance(stdout, StdoutProxy):
         stdout = stdout.original_stdout
 
-    if is_windows():
+    if sys.platform == "win32":
         from .conemu import ConEmuOutput
         from .win32 import Win32Output
         from .windows10 import Windows10_Output, is_win_vt100_enabled

prompt_toolkit/output/win32.py

@@ -1,3 +1,7 @@
+import sys
+
+assert sys.platform == "win32"
+
 import os
 from ctypes import ArgumentError, byref, c_char, c_long, c_uint, c_ulong, pointer
 

prompt_toolkit/output/windows10.py

@@ -1,9 +1,12 @@
+import sys
+
+assert sys.platform == "win32"
+
 from ctypes import byref, windll
 from ctypes.wintypes import DWORD, HANDLE
 from typing import Any, Optional, TextIO
 
 from prompt_toolkit.data_structures import Size
-from prompt_toolkit.utils import is_windows
 from prompt_toolkit.win32_types import STD_OUTPUT_HANDLE
 
 from .base import Output
@@ -84,7 +87,7 @@ def is_win_vt100_enabled() -> bool:
     Returns True when we're running Windows and VT100 escape sequences are
     supported.
     """
-    if not is_windows():
+    if sys.platform != "win32":
         return False
 
     hconsole = HANDLE(windll.kernel32.GetStdHandle(STD_OUTPUT_HANDLE))

prompt_toolkit/utils.py

@@ -188,24 +188,27 @@ def is_windows() -> bool:
     """
     True when we are using Windows.
     """
-    return sys.platform.startswith("win")  # E.g. 'win32', not 'darwin' or 'linux2'
+    return sys.platform == "win32"  # Not 'darwin' or 'linux2'
 
 
 def is_windows_vt100_supported() -> bool:
     """
     True when we are using Windows, but VT100 escape sequences are supported.
     """
-    # Import needs to be inline. Windows libraries are not always available.
-    from prompt_toolkit.output.windows10 import is_win_vt100_enabled
+    if sys.platform == "win32":
+        # Import needs to be inline. Windows libraries are not always available.
+        from prompt_toolkit.output.windows10 import is_win_vt100_enabled
 
-    return is_windows() and is_win_vt100_enabled()
+        return is_win_vt100_enabled()
+
+    return False
 
 
 def is_conemu_ansi() -> bool:
     """
     True when the ConEmu Windows console is used.
     """
-    return is_windows() and os.environ.get("ConEmuANSI", "OFF") == "ON"
+    return sys.platform == "win32" and os.environ.get("ConEmuANSI", "OFF") == "ON"
 
 
 def in_main_thread() -> bool:

setup.cfg

@@ -22,6 +22,7 @@ ignore=
   E241,
   E251,
   E301,
+  E402,
   E501,
   E701,
   E702,