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 config
     """

src/tmuxp/config.py

@@ -6,14 +6,15 @@
 """
 import logging
 import os
-from typing import Dict
+from pathlib import PosixPath
+from typing import Any, Dict, List, Optional, Union
 
 from . import exc
 
 logger = logging.getLogger(__name__)
 
 
-def validate_schema(session_config):
+def validate_schema(session_config: Any) -> bool:
     """
     Return True if config schema is correct.
 
@@ -45,7 +46,9 @@ def validate_schema(session_config):
     return True
 
 
-def is_config_file(filename, extensions=[".yml", ".yaml", ".json"]):
+def is_config_file(
+    filename: str, extensions: List[str] = [".yml", ".yaml", ".json"]
+) -> bool:
     """
     Return True if file has a valid config file type.
 
@@ -65,8 +68,9 @@ def is_config_file(filename, extensions=[".yml", ".yaml", ".json"]):
 
 
 def in_dir(
-    config_dir=os.path.expanduser("~/.tmuxp"), extensions=[".yml", ".yaml", ".json"]
-):
+    config_dir: PosixPath = os.path.expanduser("~/.tmuxp"),
+    extensions: List[str] = [".yml", ".yaml", ".json"],
+) -> List[str]:
     """
     Return a list of configs in ``config_dir``.
 
@@ -90,7 +94,7 @@ def in_dir(
     return configs
 
 
-def in_cwd():
+def in_cwd() -> List[str]:
     """
     Return list of configs in current working directory.
 
@@ -115,7 +119,7 @@ def in_cwd():
     return configs
 
 
-def expandshell(_path):
+def expandshell(_path: str) -> str:
     """
     Return expanded path based on user's ``$HOME`` and ``env``.
 
@@ -134,7 +138,7 @@ def expandshell(_path):
     return os.path.expandvars(os.path.expanduser(_path))
 
 
-def inline(session_config):
+def inline(session_config: Dict[str, Any]) -> Any:
     """
     Return config in inline form, opposite of :meth:`config.expand`.
 
@@ -210,7 +214,11 @@ def expand_cmd(p: Dict) -> Dict:
     return p
 
 
-def expand(session_config, cwd=None, parent=None):
+def expand(
+    session_config: Any,
+    cwd: Optional[Union[str, PosixPath]] = None,
+    parent: Optional[Any] = None,
+) -> Dict[str, Any]:
     """Return config with shorthand and inline properties expanded.
 
     This is necessary to keep the code in the :class:`WorkspaceBuilder` clean
@@ -330,7 +338,7 @@ def expand(session_config, cwd=None, parent=None):
     return session_config
 
 
-def trickle(session_config):
+def trickle(session_config: Dict[str, Any]) -> Dict[str, Any]:
     """Return a dict with "trickled down" / inherited config values.
 
     This will only work if config has been expanded to full form with
@@ -414,7 +422,7 @@ def trickle(session_config):
     return session_config
 
 
-def import_tmuxinator(session_config):
+def import_tmuxinator(session_config: Dict[str, Any]) -> Dict[str, Any]:
     """Return tmuxp config from a `tmuxinator`_ yaml config.
 
     .. _tmuxinator: https://github.com/aziz/tmuxinator
@@ -508,7 +516,7 @@ def import_tmuxinator(session_config):
     return tmuxp_config
 
 
-def import_teamocil(session_config):
+def import_teamocil(session_config: Dict[str, Any]) -> Dict[str, Any]:
     """Return tmuxp config from a `teamocil`_ yaml config.
 
     .. _teamocil: https://github.com/remiprev/teamocil

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,4 @@
+import typing as t
 from distutils.version import LooseVersion
 
 import libtmux
@@ -28,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.
 
@@ -115,7 +116,7 @@ def __init__(
 
         self._version_check()
 
-    def _version_check(self):
+    def _version_check(self) -> None:
         """
         Check all dependency versions for compatibility.
         """
@@ -131,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, LooseVersion],
+        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,12 +6,18 @@
 """
 import logging
 import os
+import pathlib
 import shlex
 import subprocess
 import sys
+import typing as t
 
 from libtmux._compat import console_to_str
 from libtmux.exc import LibTmuxException
+from libtmux.pane import Pane
+from libtmux.server import Server
+from libtmux.session import Session
+from libtmux.window import Window
 
 from . import exc
 
@@ -20,7 +26,9 @@
 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(
@@ -51,7 +59,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
@@ -75,7 +83,7 @@ def oh_my_zsh_auto_title():
                 )
 
 
-def raise_if_tmux_not_running(server):
+def raise_if_tmux_not_running(server: Server) -> None:
     """Raise exception if not running. More descriptive error if no server found."""
     try:
         server.sessions
@@ -92,7 +100,7 @@ def raise_if_tmux_not_running(server):
             raise e
 
 
-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:
@@ -105,7 +113,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:
     if session_name:
         session = server.find_where({"session_name": session_name})
     elif current_pane is not None:
@@ -126,7 +138,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:
     if window_name:
         window = session.find_where({"window_name": window_name})
         if not window:
@@ -139,7 +155,7 @@ 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.find_where({"pane_id": current_pane["pane_id"]})  # NOQA: F841