refactor: Add mypy annotations (monkeytype + manual edits)

Author: tony

conftest.py

@@ -25,7 +25,7 @@
 
 @pytest.mark.skipif(USING_ZSH, reason="Using ZSH")
 @pytest.fixture(autouse=USING_ZSH, scope="session")
-def zshrc(user_path: pathlib.Path):
+def zshrc(user_path: pathlib.Path) -> pathlib.Path:
     """This quiets ZSH default message.
 
     Needs a startup file .zshenv, .zprofile, .zshrc, .zlogin.
@@ -41,7 +41,7 @@ def home_path_default(monkeypatch: pytest.MonkeyPatch, user_path: pathlib.Path)
 
 
 @pytest.fixture(scope="function")
-def monkeypatch_plugin_test_packages(monkeypatch):
+def monkeypatch_plugin_test_packages(monkeypatch: pytest.MonkeyPatch) -> None:
     paths = [
         "tests/fixtures/pluginsystem/plugins/tmuxp_test_plugin_bwb/",
         "tests/fixtures/pluginsystem/plugins/tmuxp_test_plugin_bs/",
@@ -55,7 +55,7 @@ def monkeypatch_plugin_test_packages(monkeypatch):
 
 
 @pytest.fixture(scope="function")
-def socket_name(request) -> str:
+def socket_name(request: pytest.FixtureRequest) -> str:
     return "tmuxp_test%s" % next(namer)
 
 

src/tmuxp/cli/__init__.py

@@ -26,6 +26,7 @@
 from .load import command_load
 from .shell import command_shell
 from .utils import tmuxp_echo
+from pathlib import PosixPath
 
 logger = logging.getLogger(__name__)
 
@@ -59,7 +60,7 @@ def cli(log_level):
     setup_logger(logger=logger, level=log_level.upper())
 
 
-def startup(config_dir):
+def startup(config_dir: PosixPath) -> None:
     """
     Initialize CLI.
 

src/tmuxp/cli/import_config.py

@@ -1,6 +1,7 @@
 import os
 import pathlib
 import sys
+from typing import Callable
 
 import click
 
@@ -10,7 +11,7 @@
 from .utils import ConfigPath, _validate_choices, get_abs_path, tmuxp_echo
 
 
-def get_tmuxinator_dir():
+def get_tmuxinator_dir() -> str:
     """
     Return tmuxinator configuration directory.
 
@@ -31,7 +32,7 @@ def get_tmuxinator_dir():
     return os.path.expanduser("~/.tmuxinator/")
 
 
-def get_teamocil_dir():
+def get_teamocil_dir() -> str:
     """
     Return teamocil configuration directory.
 
@@ -47,7 +48,7 @@ def get_teamocil_dir():
     return os.path.expanduser("~/.teamocil/")
 
 
-def _resolve_path_no_overwrite(config):
+def _resolve_path_no_overwrite(config: str) -> str:
     path = get_abs_path(config)
     if os.path.exists(path):
         raise click.exceptions.UsageError("%s exists. Pick a new filename." % path)
@@ -59,7 +60,7 @@ def command_import():
     """Import a teamocil/tmuxinator config."""
 
 
-def import_config(configfile, importfunc):
+def import_config(configfile: str, importfunc: Callable):
     existing_config = ConfigReader._from_file(pathlib.Path(configfile))
     new_config = ConfigReader(importfunc(existing_config))
 

src/tmuxp/cli/load.py

@@ -10,20 +10,21 @@
 import pathlib
 import shutil
 import sys
-from typing import List
+from typing import Any, Dict, List, Optional, Union
 
 import click
 
 from libtmux.common import has_gte_version
 from libtmux.server import Server
+from libtmux.session import Session
 from tmuxp import config_reader
 
 from .. import config, exc, log, util
 from ..workspacebuilder import WorkspaceBuilder
 from .utils import ConfigPath, _validate_choices, get_config_dir, tmuxp_echo
 
 
-def set_layout_hook(session, hook_name):
+def set_layout_hook(session: Session, hook_name: str) -> None:
     """Set layout hooks to normalize layout.
 
     References:
@@ -84,7 +85,7 @@ def set_layout_hook(session, hook_name):
     session.cmd(*cmd)
 
 
-def load_plugins(sconf):
+def load_plugins(sconf: Dict[str, Any]) -> List[Any]:
     """
     Load and return plugins in config
     """
@@ -119,7 +120,7 @@ def load_plugins(sconf):
     return plugins
 
 
-def _reattach(builder):
+def _reattach(builder: WorkspaceBuilder):
     """
     Reattach session (depending on env being inside tmux already or not)
 
@@ -148,7 +149,7 @@ def _reattach(builder):
         builder.session.attach_session()
 
 
-def _load_attached(builder, detached):
+def _load_attached(builder: WorkspaceBuilder, detached: bool) -> None:
     """
     Load config in new session
 
@@ -181,7 +182,7 @@ def _load_attached(builder, detached):
             builder.session.attach_session()
 
 
-def _load_detached(builder):
+def _load_detached(builder: WorkspaceBuilder) -> None:
     """
     Load config in new session but don't attach
 
@@ -198,7 +199,7 @@ def _load_detached(builder):
     print("Session created in detached state.")
 
 
-def _load_append_windows_to_current_session(builder):
+def _load_append_windows_to_current_session(builder: WorkspaceBuilder) -> None:
     """
     Load config as new windows in current session
 
@@ -213,7 +214,7 @@ def _load_append_windows_to_current_session(builder):
         set_layout_hook(builder.session, "client-session-changed")
 
 
-def _setup_plugins(builder):
+def _setup_plugins(builder: WorkspaceBuilder) -> Session:
     """
     Runs after before_script
 
@@ -228,16 +229,16 @@ def _setup_plugins(builder):
 
 
 def load_workspace(
-    config_file,
-    socket_name=None,
-    socket_path=None,
-    tmux_config_file=None,
-    new_session_name=None,
-    colors=None,
-    detached=False,
-    answer_yes=False,
-    append=False,
-):
+    config_file: Union[str, pathlib.PosixPath],
+    socket_name: Optional[str] = None,
+    socket_path: None = None,
+    tmux_config_file: None = None,
+    new_session_name: Optional[str] = None,
+    colors: Optional[int] = None,
+    detached: bool = False,
+    answer_yes: bool = False,
+    append: bool = False,
+) -> Session:
     """
     Load a tmux "workspace" session via tmuxp file.
 

src/tmuxp/cli/utils.py

@@ -1,7 +1,9 @@
 import logging
 import os
+import typing as t
 
 import click
+from click.core import Argument, Context
 from click.exceptions import FileError
 
 from .. import config, log
@@ -10,7 +12,12 @@
 logger = logging.getLogger(__name__)
 
 
-def tmuxp_echo(message=None, log_level="INFO", style_log=False, **click_kwargs):
+def tmuxp_echo(
+    message: t.Optional[str] = None,
+    log_level: str = "INFO",
+    style_log: bool = False,
+    **click_kwargs,
+) -> None:
     """
     Combines logging.log and click.echo
     """
@@ -22,7 +29,7 @@ def tmuxp_echo(message=None, log_level="INFO", style_log=False, **click_kwargs):
     click.echo(message, **click_kwargs)
 
 
-def get_config_dir():
+def get_config_dir() -> str:
     """
     Return tmuxp configuration directory.
 
@@ -54,7 +61,7 @@ def get_config_dir():
     return path
 
 
-def _validate_choices(options):
+def _validate_choices(options: t.List[str]) -> t.Callable:
     """
     Callback wrapper for validating click.prompt input.
 
@@ -84,11 +91,13 @@ def func(value):
 
 
 class ConfigPath(click.Path):
-    def __init__(self, config_dir=None, *args, **kwargs):
+    def __init__(
+        self, config_dir: t.Optional[t.Union[t.Callable, str]] = None, *args, **kwargs
+    ) -> None:
         super().__init__(*args, **kwargs)
         self.config_dir = config_dir
 
-    def convert(self, value, param, ctx):
+    def convert(self, value: str, param: Argument, ctx: Context) -> str:
         config_dir = self.config_dir
         if callable(config_dir):
             config_dir = config_dir()
@@ -118,7 +127,7 @@ def scan_config_argument(ctx, param, value, config_dir=None):
     return value
 
 
-def get_abs_path(config):
+def get_abs_path(config: str) -> str:
     path = os.path
     join, isabs = path.join, path.isabs
     dirname, normpath = path.dirname, path.normpath
@@ -131,7 +140,7 @@ def get_abs_path(config):
     return config
 
 
-def scan_config(config, config_dir=None):
+def scan_config(config: str, config_dir: t.Optional[str] = None) -> str:
     """
     Return the real config path or raise an exception.
 
@@ -236,7 +245,7 @@ def scan_config(config, config_dir=None):
     return config
 
 
-def is_pure_name(path):
+def is_pure_name(path: str) -> bool:
     """
     Return True if path is a name and not a file path.
 

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