refactor!(typings): Strict annotations (#383)

This also improves code quality in many places. By a lot. Even though
there's still some `Any`'s floating around. This catches a lot of stuff.

Author: tony

.tmuxp.yaml

@@ -12,6 +12,7 @@ windows:
   panes:
   - focus: true
   - pane 
+  - make watch_mypy
   - make watch_test
 - window_name: docs
   layout: main-horizontal

CHANGES

@@ -61,6 +61,14 @@ $ pip install --user --upgrade --pre libtmux
     window.show_window_option('DISPLAY')
     ```
 
+## What's new
+
+- **Improved typings**
+
+  Now [`mypy --strict`] compliant ({issue}`383`)
+
+  [`mypy --strict`]: https://mypy.readthedocs.io/en/stable/command_line.html#cmdoption-mypy-strict
+
 ### Development
 
 - Fix incorrect function name `findWhere()` ({issue}`391`)

Makefile

@@ -56,3 +56,9 @@ watch_mypy:
 
 format_markdown:
 	prettier --parser=markdown -w *.md docs/*.md docs/**/*.md CHANGES
+
+monkeytype_create:
+	poetry run monkeytype run `poetry run which py.test`
+
+monkeytype_apply:
+	poetry run monkeytype list-modules | xargs -n1 -I{} sh -c 'poetry run monkeytype apply {}'

README.md

@@ -1,6 +1,6 @@
 # libtmux
 
-libtmux is a python scripting library for tmux. You can use it to command and control tmux servers,
+libtmux is a [typed](https://docs.python.org/3/library/typing.html) python scripting library for tmux. You can use it to command and control tmux servers,
 sessions, windows, and panes. It is the tool powering [tmuxp], a tmux workspace manager.
 
 [![Python Package](https://img.shields.io/pypi/v/libtmux.svg)](https://pypi.org/project/libtmux/)

docs/about.md

@@ -14,7 +14,7 @@
 
 ```
 
-libtmux is an [abstraction layer] for tmux.
+libtmux is a [typed](https://docs.python.org/3/library/typing.html) [abstraction layer] for tmux.
 
 It builds upon the concept of targets `-t`, to direct commands against
 individual session, windows and panes and `FORMATS`, template variables

docs/conf.py

@@ -4,7 +4,7 @@
 import sys
 from os.path import dirname, relpath
 from pathlib import Path
-from typing import Dict, List
+from typing import Dict, List, Union
 
 import libtmux  # NOQA
 from libtmux import test  # NOQA
@@ -17,7 +17,7 @@
 sys.path.insert(0, str(cwd / "_ext"))
 
 # package data
-about: Dict = {}
+about: Dict[str, str] = {}
 with open("../libtmux/__about__.py") as fp:
     exec(fp.read(), about)
 
@@ -69,8 +69,8 @@
 html_css_files = ["css/custom.css"]
 html_extra_path = ["manifest.json"]
 html_theme = "furo"
-html_theme_path: List = []
-html_theme_options: Dict = {
+html_theme_path: List[str] = []
+html_theme_options: Dict[str, Union[str, List[Dict[str, str]]]] = {
     "light_logo": "img/libtmux.svg",
     "dark_logo": "img/libtmux.svg",
     "footer_icons": [
@@ -162,7 +162,9 @@
 intersphinx_mapping = {"http://docs.python.org/": None}
 
 
-def linkcode_resolve(domain, info):  # NOQA: C901
+def linkcode_resolve(
+    domain: str, info: Dict[str, str]
+) -> Union[None, str]:  # NOQA: C901
     """
     Determine the URL corresponding to Python object
 
@@ -195,7 +197,8 @@ def linkcode_resolve(domain, info):  # NOQA: C901
     except AttributeError:
         pass
     else:
-        obj = unwrap(obj)
+        if callable(obj):
+            obj = unwrap(obj)
 
     try:
         fn = inspect.getsourcefile(obj)

libtmux/__about__.py

@@ -1,7 +1,7 @@
 __title__ = "libtmux"
 __package_name__ = "libtmux"
 __version__ = "0.12.0"
-__description__ = "Scripting library / ORM / API wrapper for tmux"
+__description__ = "Typed scripting library / ORM / API wrapper for tmux"
 __email__ = "[email protected]"
 __author__ = "Tony Narlock"
 __github__ = "https://github.com/tmux-python/libtmux"

libtmux/_compat.py

@@ -1,5 +1,6 @@
 # flake8: NOQA
 import sys
+import types
 import typing as t
 
 console_encoding = sys.__stdout__.encoding
@@ -14,7 +15,12 @@ def console_to_str(s: bytes) -> str:
 
 
 # TODO Consider removing, reraise does not seem to be called anywhere
-def reraise(tp, value, tb=None):
+def reraise(
+    tp: t.Type[BaseException],
+    value: BaseException,
+    tb: types.TracebackType,
+) -> t.NoReturn:
+
     if value.__traceback__ is not tb:
         raise (value.with_traceback(tb))
     raise value