refactor: Add mypy annotations (monkeytype + manual edits)

Author: tony

src/tmuxp/cli/load.py

@@ -107,7 +107,7 @@ def set_layout_hook(session: Session, hook_name: str) -> None:
     session.cmd(*cmd)
 
 
-def load_plugins(sconf: t.Any) -> t.List[t.Any]:
+def load_plugins(sconf: t.Dict[str, t.Any]) -> t.List[t.Any]:
     """
     Load and return plugins in workspace
     """

src/tmuxp/config_reader.py

@@ -22,11 +22,11 @@ class ConfigReader:
     '{\n  "session_name": "my session"\n}'
     """
 
-    def __init__(self, content: "RawConfigData"):
+    def __init__(self, content: "RawConfigData") -> None:
         self.content = content
 
     @staticmethod
-    def _load(format: "FormatLiteral", content: str):
+    def _load(format: "FormatLiteral", content: str) -> t.Dict[str, t.Any]:
         """Load raw config data and directly return it.
 
         >>> ConfigReader._load("json", '{ "session_name": "my session" }')
@@ -46,7 +46,7 @@ def _load(format: "FormatLiteral", content: str):
             raise NotImplementedError(f"{format} not supported in configuration")
 
     @classmethod
-    def load(cls, format: "FormatLiteral", content: str):
+    def load(cls, format: "FormatLiteral", content: str) -> "ConfigReader":
         """Load raw config data into a ConfigReader instance (to dump later).
 
         >>> cfg = ConfigReader.load("json", '{ "session_name": "my session" }')
@@ -69,7 +69,7 @@ def load(cls, format: "FormatLiteral", content: str):
         )
 
     @classmethod
-    def _from_file(cls, path: pathlib.Path):
+    def _from_file(cls, path: pathlib.Path) -> t.Dict[str, t.Any]:
         r"""Load data from file path directly to dictionary.
 
         **YAML file**
@@ -114,7 +114,7 @@ def _from_file(cls, path: pathlib.Path):
         )
 
     @classmethod
-    def from_file(cls, path: pathlib.Path):
+    def from_file(cls, path: pathlib.Path) -> "ConfigReader":
         r"""Load data from file path
 
         **YAML file**

src/tmuxp/exc.py

@@ -4,6 +4,8 @@
 ~~~~~~~~~
 
 """
+import typing as t
+
 from ._compat import implements_to_string
 
 
@@ -28,7 +30,7 @@ class TmuxpPluginException(TmuxpException):
 
 
 class BeforeLoadScriptNotExists(OSError):
-    def __init__(self, *args, **kwargs):
+    def __init__(self, *args, **kwargs) -> None:
         super().__init__(*args, **kwargs)
 
         self.strerror = "before_script file '%s' doesn't exist." % self.strerror
@@ -41,7 +43,9 @@ class BeforeLoadScriptError(Exception):
     :meth:`tmuxp.util.run_before_script`.
     """
 
-    def __init__(self, returncode, cmd, output=None):
+    def __init__(
+        self, returncode: int, cmd: str, output: t.Optional[str] = None
+    ) -> None:
         self.returncode = returncode
         self.cmd = cmd
         self.output = output

src/tmuxp/log.py

@@ -29,7 +29,9 @@
 }
 
 
-def setup_logger(logger=None, level="INFO"):
+def setup_logger(
+    logger: t.Optional[logging.Logger] = None, level: str = "INFO"
+) -> None:
     """
     Setup logging for CLI use.
 
@@ -49,8 +51,13 @@ def setup_logger(logger=None, level="INFO"):
 
 
 def set_style(
-    message, stylized, style_before=None, style_after=None, prefix="", suffix=""
-):
+    message: str,
+    stylized: bool,
+    style_before: t.Optional[str] = None,
+    style_after: t.Optional[str] = None,
+    prefix: str = "",
+    suffix: str = "",
+) -> str:
     if stylized:
         return prefix + style_before + message + style_after + suffix
 
@@ -112,10 +119,10 @@ def default_log_template(
 class LogFormatter(logging.Formatter):
     template = default_log_template
 
-    def __init__(self, color=True, *args, **kwargs):
+    def __init__(self, color: bool = True, *args, **kwargs) -> None:
         logging.Formatter.__init__(self, *args, **kwargs)
 
-    def format(self, record):
+    def format(self, record: logging.LogRecord) -> str:
         try:
             record.message = record.getMessage()
         except Exception as e:

src/tmuxp/plugin.py

@@ -1,3 +1,5 @@
+import typing as t
+
 import libtmux
 from libtmux._compat import LegacyVersion as Version
 from libtmux.common import get_version
@@ -27,17 +29,17 @@
 class TmuxpPlugin:
     def __init__(
         self,
-        plugin_name="tmuxp-plugin",
-        tmux_min_version=TMUX_MIN_VERSION,
-        tmux_max_version=TMUX_MAX_VERSION,
-        tmux_version_incompatible=None,
-        libtmux_min_version=LIBTMUX_MIN_VERSION,
-        libtmux_max_version=LIBTMUX_MAX_VERSION,
-        libtmux_version_incompatible=None,
-        tmuxp_min_version=TMUXP_MIN_VERSION,
-        tmuxp_max_version=TMUXP_MAX_VERSION,
-        tmuxp_version_incompatible=None,
-    ):
+        plugin_name: str = "tmuxp-plugin",
+        tmux_min_version: str = TMUX_MIN_VERSION,
+        tmux_max_version: t.Optional[str] = TMUX_MAX_VERSION,
+        tmux_version_incompatible: t.Optional[t.List[str]] = None,
+        libtmux_min_version: str = LIBTMUX_MIN_VERSION,
+        libtmux_max_version: t.Optional[str] = LIBTMUX_MAX_VERSION,
+        libtmux_version_incompatible: t.Optional[t.List[str]] = None,
+        tmuxp_min_version: str = TMUXP_MIN_VERSION,
+        tmuxp_max_version: t.Optional[str] = TMUXP_MAX_VERSION,
+        tmuxp_version_incompatible: t.Optional[t.List[str]] = None,
+    ) -> None:
         """
         Initialize plugin.
 
@@ -114,7 +116,7 @@ def __init__(
 
         self._version_check()
 
-    def _version_check(self):
+    def _version_check(self) -> None:
         """
         Check all dependency versions for compatibility.
         """
@@ -130,7 +132,13 @@ def _version_check(self):
                     )
                 )
 
-    def _pass_version_check(self, version, vmin, vmax, incompatible):
+    def _pass_version_check(
+        self,
+        version: t.Union[str, Version],
+        vmin: str,
+        vmax: t.Optional[str],
+        incompatible: t.List[t.Union[t.Any, str]],
+    ) -> bool:
         """
         Provide affirmative if version compatibility is correct.
         """

src/tmuxp/shell.py

@@ -10,7 +10,7 @@
 logger = logging.getLogger(__name__)
 
 
-def has_ipython():
+def has_ipython() -> bool:
     try:
         from IPython import start_ipython  # NOQA F841
     except ImportError:
@@ -22,7 +22,7 @@ def has_ipython():
     return True
 
 
-def has_ptpython():
+def has_ptpython() -> bool:
     try:
         from ptpython.repl import embed, run_config  # NOQA F841
     except ImportError:
@@ -34,7 +34,7 @@ def has_ptpython():
     return True
 
 
-def has_ptipython():
+def has_ptipython() -> bool:
     try:
         from ptpython.ipython import embed  # NOQA F841
         from ptpython.repl import run_config  # NOQA F841
@@ -48,15 +48,15 @@ def has_ptipython():
     return True
 
 
-def has_bpython():
+def has_bpython() -> bool:
     try:
         from bpython import embed  # NOQA F841
     except ImportError:
         return False
     return True
 
 
-def detect_best_shell():
+def detect_best_shell() -> str:
     if has_ptipython():
         return "ptipython"
     elif has_ptpython():
@@ -220,7 +220,9 @@ def launch_code():
     return launch_code
 
 
-def launch(shell="best", use_pythonrc=False, use_vi_mode=False, **kwargs):
+def launch(
+    shell: str = "best", use_pythonrc: bool = False, use_vi_mode: bool = False, **kwargs
+) -> None:
     # Also allowing passing shell='code' to force using code.interact
     imported_objects = get_launch_args(**kwargs)
 

src/tmuxp/util.py

@@ -6,20 +6,30 @@
 """
 import logging
 import os
+import pathlib
 import shlex
 import subprocess
 import sys
+import typing as t
 
 from libtmux._compat import console_to_str
 
 from . import exc
 
+if t.TYPE_CHECKING:
+    from libtmux.pane import Pane
+    from libtmux.server import Server
+    from libtmux.session import Session
+    from libtmux.window import Window
+
 logger = logging.getLogger(__name__)
 
 PY2 = sys.version_info[0] == 2
 
 
-def run_before_script(script_file, cwd=None):
+def run_before_script(
+    script_file: t.Union[str, pathlib.Path], cwd: t.Optional[pathlib.Path] = None
+) -> int:
     """Function to wrap try/except for subprocess.check_call()."""
     try:
         proc = subprocess.Popen(
@@ -50,7 +60,7 @@ def run_before_script(script_file, cwd=None):
             raise e
 
 
-def oh_my_zsh_auto_title():
+def oh_my_zsh_auto_title() -> None:
     """Give warning and offer to fix ``DISABLE_AUTO_TITLE``.
 
     see: https://github.com/robbyrussell/oh-my-zsh/pull/257
@@ -74,7 +84,7 @@ def oh_my_zsh_auto_title():
                 )
 
 
-def get_current_pane(server):
+def get_current_pane(server: "Server") -> t.Optional[t.Dict[str, str]]:
     """Return Pane if one found in env"""
     if os.getenv("TMUX_PANE") is not None:
         try:
@@ -83,7 +93,11 @@ def get_current_pane(server):
             pass
 
 
-def get_session(server, session_name=None, current_pane=None):
+def get_session(
+    server: "Server",
+    session_name: t.Optional[str] = None,
+    current_pane: t.Optional[t.Dict[str, str]] = None,
+) -> "Session":
     try:
         if session_name:
             session = server.sessions.get(session_name=session_name)
@@ -107,7 +121,11 @@ def get_session(server, session_name=None, current_pane=None):
     return session
 
 
-def get_window(session, window_name=None, current_pane=None):
+def get_window(
+    session: "Session",
+    window_name: t.Optional[str] = None,
+    current_pane: t.Optional[t.Dict[str, str]] = None,
+) -> "Window":
     try:
         if window_name:
             window = session.windows.get(window_name=window_name)
@@ -129,7 +147,9 @@ def get_window(session, window_name=None, current_pane=None):
     return window
 
 
-def get_pane(window, current_pane=None):
+def get_pane(
+    window: "Window", current_pane: t.Optional[t.Dict[str, str]] = None
+) -> "Pane":
     try:
         if current_pane is not None:
             pane = window.panes.get(pane_id=current_pane.pane_id)  # NOQA: F841