Mypy types for autocomplete.py

thomasballinger · thomasballinger · commit 5835bbfc443d · 2021-10-07T12:02:43.000-07:00
Running mypy in CI on this one file.
diff --git a/.github/workflows/lint.yaml b/.github/workflows/lint.yaml
@@ -26,3 +26,20 @@ jobs:
       with:
         skip: '*.po'
         ignore_words_list: ba,te,deltion
+
+  mypy:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python
+      uses: actions/setup-python@v2
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install mypy
+        pip install -r requirements.txt
+        pip install urwid twisted watchdog "jedi >=0.16" babel "sphinx >=1.5"
+        pip install types-backports types-requests types-setuptools types-toml
+    - name: Check with mypy
+      # for now only run on a few files to avoid slipping backward
+      run: mypy --ignore-missing-imports bpython/autocomplete.py
diff --git a/bpython/args.py b/bpython/args.py
@@ -197,7 +197,7 @@ def callback(group):
     logger.info(f"curtsies: {curtsies.__version__}")
     logger.info(f"cwcwidth: {cwcwidth.__version__}")
     logger.info(f"greenlet: {greenlet.__version__}")
-    logger.info(f"pygments: {pygments.__version__}")
+    logger.info(f"pygments: {pygments.__version__}")  # type: ignore
     logger.info(f"requests: {requests.__version__}")
     logger.info(
         "environment:\n{}".format(
diff --git a/bpython/autocomplete.py b/bpython/autocomplete.py
@@ -33,7 +33,18 @@
 import builtins
 
 from enum import Enum
-from typing import Any, Dict, Iterator, List, Match, NoReturn, Set, Union, Tuple
+from typing import (
+    Any,
+    Dict,
+    Iterator,
+    List,
+    Match,
+    Set,
+    Union,
+    Tuple,
+    Type,
+    Sequence,
+)
 from . import inspection
 from . import line as lineparts
 from .line import LinePart
@@ -180,15 +191,15 @@ def few_enough_underscores(current, match) -> bool:
     return not match.startswith("_")
 
 
-def method_match_none(word, size, text) -> bool:
+def method_match_none(word: str, size: int, text: str) -> bool:
     return False
 
 
-def method_match_simple(word, size, text) -> bool:
+def method_match_simple(word: str, size: int, text: str) -> bool:
     return word[:size] == text
 
 
-def method_match_substring(word, size, text) -> bool:
+def method_match_substring(word: str, size: int, text: str) -> bool:
     return text in word
 
 
@@ -265,16 +276,20 @@ def shown_before_tab(self) -> bool:
 class CumulativeCompleter(BaseCompletionType):
     """Returns combined matches from several completers"""
 
-    def __init__(self, completers, mode=AutocompleteModes.SIMPLE) -> None:
+    def __init__(
+        self,
+        completers: Sequence[BaseCompletionType],
+        mode: AutocompleteModes = AutocompleteModes.SIMPLE,
+    ) -> None:
         if not completers:
             raise ValueError(
                 "CumulativeCompleter requires at least one completer"
             )
-        self._completers = completers
+        self._completers: Sequence[BaseCompletionType] = completers
 
         super().__init__(True, mode)
 
-    def locate(self, current_offset: int, line: str) -> Union[None, NoReturn]:
+    def locate(self, current_offset, line):
         for completer in self._completers:
             return_value = completer.locate(current_offset, line)
             if return_value is not None:
@@ -573,7 +588,7 @@ def matches(self, cursor_offset, line, **kwargs) -> Union[Set, None]:
     import jedi
 except ImportError:
 
-    class MultilineJediCompletion(BaseCompletionType):
+    class MultilineJediCompletion(BaseCompletionType):  # type: ignore [no-redef]
         def matches(self, cursor_offset, line, **kwargs) -> None:
             return None
 
@@ -630,7 +645,7 @@ def locate(self, cursor_offset: int, line: str) -> LinePart:
             end = cursor_offset
             return LinePart(start, end, line[start:end])
 
-    class MultilineJediCompletion(JediCompletion):
+    class MultilineJediCompletion(JediCompletion):  # type: ignore [no-redef]
         def matches(self, cursor_offset, line, **kwargs) -> Union[Set, None]:
             if "current_block" not in kwargs or "history" not in kwargs:
                 return None
diff --git a/bpython/curtsiesfrontend/filewatch.py b/bpython/curtsiesfrontend/filewatch.py
@@ -14,7 +14,7 @@ def ModuleChangedEventHandler(*args):
 
 else:
 
-    class ModuleChangedEventHandler(FileSystemEventHandler):
+    class ModuleChangedEventHandler(FileSystemEventHandler):  # type: ignore [no-redef]
         def __init__(self, paths, on_change):
             self.dirs = defaultdict(set)
             self.on_change = on_change
diff --git a/bpython/lazyre.py b/bpython/lazyre.py
@@ -21,12 +21,12 @@
 # THE SOFTWARE.
 
 import re
-from typing import Optional, Iterator
+from typing import Optional, Iterator, Pattern, Match, Optional
 
 try:
     from functools import cached_property
 except ImportError:
-    from backports.cached_property import cached_property  # type: ignore
+    from backports.cached_property import cached_property  # type: ignore [no-redef]
 
 
 class LazyReCompile:
@@ -40,7 +40,7 @@ def __init__(self, regex: str, flags: int = 0) -> None:
         self.flags = flags
 
     @cached_property
-    def compiled(self):
+    def compiled(self) -> Pattern[str]:
         return re.compile(self.regex, self.flags)
 
     def finditer(self, *args, **kwargs):
@@ -49,7 +49,7 @@ def finditer(self, *args, **kwargs):
     def search(self, *args, **kwargs):
         return self.compiled.search(*args, **kwargs)
 
-    def match(self, *args, **kwargs):
+    def match(self, *args, **kwargs) -> Optional[Match[str]]:
         return self.compiled.match(*args, **kwargs)
 
     def sub(self, *args, **kwargs) -> str:
diff --git a/bpython/patch_linecache.py b/bpython/patch_linecache.py
@@ -64,7 +64,7 @@ def _bpython_clear_linecache():
 
 # Monkey-patch the linecache module so that we're able
 # to hold our command history there and have it persist
-linecache.cache = BPythonLinecache(linecache.cache)
+linecache.cache = BPythonLinecache(linecache.cache)  # type: ignore
 linecache.clearcache = _bpython_clear_linecache
 
 
diff --git a/bpython/repl.py b/bpython/repl.py
@@ -33,11 +33,13 @@
 import textwrap
 import time
 import traceback
+from abc import abstractmethod
 from itertools import takewhile
 from pathlib import Path
 from pygments.lexers import Python3Lexer
 from pygments.token import Token
 from types import ModuleType
+from typing import cast
 
 have_pyperclip = True
 try:
@@ -451,11 +453,11 @@ def __init__(self, interp, config):
 
     @property
     def ps1(self) -> str:
-        return getattr(sys, "ps1", ">>> ")
+        return cast(str, getattr(sys, "ps1", ">>> "))
 
     @property
     def ps2(self) -> str:
-        return getattr(sys, "ps2", "... ")
+        return cast(str, getattr(sys, "ps2", "... "))
 
     def startup(self):
         """
@@ -769,6 +771,10 @@ def line_is_empty(line):
             indentation = 0
         return indentation
 
+    @abstractmethod
+    def getstdout(self) -> str:
+        raise NotImplementedError()
+
     def get_session_formatted_for_file(self) -> str:
         """Format the stdout buffer to something suitable for writing to disk,
         i.e. without >>> and ... at input lines and with "# OUT: " prepended to
diff --git a/bpython/translations/__init__.py b/bpython/translations/__init__.py
@@ -2,13 +2,14 @@
 import locale
 import os.path
 import sys
+from typing import cast
 
 from .. import package_dir
 
-translator = None
+translator: gettext.GNUTranslations = cast(gettext.GNUTranslations, None)
 
 
-def _(message):
+def _(message) -> str:
     return translator.gettext(message)
 
 
diff --git a/setup.cfg b/setup.cfg
@@ -65,3 +65,12 @@ msgid_bugs_address = https://github.com/bpython/bpython/issues
 builder = man
 source_dir = doc/sphinx/source
 build_dir = build
+
+[mypy]
+warn_return_any = True
+warn_unused_configs = True
+mypy_path=stubs
+files=bpython
+
+[mypy-jedi]
+ignore_missing_imports = True
diff --git a/stubs/blessings.pyi b/stubs/blessings.pyi
@@ -0,0 +1,47 @@
+from typing import ContextManager, Text, IO
+
+class Terminal:
+    def __init__(self, stream=None, force_styling=False):
+        # type: (IO, bool) -> None
+        pass
+    def location(self, x=None, y=None):
+        # type: (int, int) -> ContextManager
+        pass
+    @property
+    def hide_cursor(self):
+        # type: () -> Text
+        pass
+    @property
+    def normal_cursor(self):
+        # type: () -> Text
+        pass
+    @property
+    def height(self):
+        # type: () -> int
+        pass
+    @property
+    def width(self):
+        # type: () -> int
+        pass
+    def fullscreen(self):
+        # type: () -> ContextManager
+        pass
+    def move(self, y, x):
+        # type: (int, int) -> Text
+        pass
+    @property
+    def clear_eol(self):
+        # type: () -> Text
+        pass
+    @property
+    def clear_bol(self):
+        # type: () -> Text
+        pass
+    @property
+    def clear_eos(self):
+        # type: () -> Text
+        pass
+    @property
+    def clear_eos(self):
+        # type: () -> Text
+        pass
diff --git a/stubs/cwcwidth.pyi b/stubs/cwcwidth.pyi
@@ -0,0 +1,4 @@
+# official typing seems to require a second arg
+def wcswidth(s: str, n=100000000): ...
+
+__version__: str
diff --git a/stubs/msvcrt.pyi b/stubs/msvcrt.pyi
@@ -0,0 +1,7 @@
+# The real types seem only available on the Windows platform,
+# but it seems annoying to need to run typechecking once per platform
+# https://github.com/python/typeshed/blob/master/stdlib/msvcrt.pyi
+def locking(__fd: int, __mode: int, __nbytes: int) -> None: ...
+
+LK_NBLCK: int
+LK_UNLCK: int
diff --git a/stubs/rlcompleter.pyi b/stubs/rlcompleter.pyi
@@ -0,0 +1,3 @@
+from typing import Any
+
+def get_class_members(class_: Any): ...
