refactor!: Add typings from monkeytype

Author: tony

src/tmuxp/workspace/builder.py

@@ -7,6 +7,7 @@
 import logging
 import time
 import typing as t
+from typing import Any, Dict, Iterator, List, Optional
 
 from libtmux._internal.query_list import ObjectDoesNotExist
 from libtmux.common import has_lt_version
@@ -186,7 +187,7 @@ def __init__(
                 pass
 
     @property
-    def session(self):
+    def session(self) -> Session:
         if self._session is None:
             raise ObjectDoesNotExist(
                 "No session object exists for WorkspaceBuilder. "

src/tmuxp/workspace/freezer.py

@@ -1,9 +1,11 @@
+import typing as t
+from typing import Any, Dict
+
 from libtmux.pane import Pane
 from libtmux.session import Session
-import typing as t
 
 
-def inline(workspace_dict):
+def inline(workspace_dict: Dict[str, Any]) -> Any:
     """Return workspace with inlined shorthands. Opposite of :meth:`loader.expand`.
 
     Parameters

src/tmuxp/workspace/loader.py

@@ -6,12 +6,13 @@
 """
 import logging
 import os
-from typing import Dict
+from pathlib import PosixPath
+from typing import Any, Dict, Optional, Union
 
 logger = logging.getLogger(__name__)
 
 
-def expandshell(_path):
+def expandshell(_path: str) -> str:
     """
     Return expanded path based on user's ``$HOME`` and ``env``.
 
@@ -63,7 +64,11 @@ def expand_cmd(p: Dict) -> Dict:
     return p
 
 
-def expand(workspace_dict, cwd=None, parent=None):
+def expand(
+    workspace_dict: Dict[str, Any],
+    cwd: Optional[Union[PosixPath, str]] = None,
+    parent: Optional[Any] = None,
+) -> Dict[str, Any]:
     """Return workspace with shorthand and inline properties expanded.
 
     This is necessary to keep the code in the :class:`WorkspaceBuilder` clean
@@ -183,7 +188,7 @@ def expand(workspace_dict, cwd=None, parent=None):
     return workspace_dict
 
 
-def trickle(workspace_dict):
+def trickle(workspace_dict: Dict[str, Any]) -> Dict[str, Any]:
     """Return a dict with "trickled down" / inherited workspace values.
 
     This will only work if workspace has been expanded to full form with

tests/cli/test_cli.py

@@ -40,7 +40,7 @@ def test_help(
     cli_args: t.List[str],
     tmp_path: pathlib.Path,
     monkeypatch: pytest.MonkeyPatch,
-    capsys: pytest.CaptureFixture,
+    capsys: pytest.CaptureFixture[str],
 ) -> None:
     try:
         cli.cli(cli_args)
@@ -81,7 +81,7 @@ def test_get_teamocil_dir(monkeypatch: pytest.MonkeyPatch) -> None:
 def test_pass_config_dir_ClickPath(
     tmp_path: pathlib.Path,
     monkeypatch: pytest.MonkeyPatch,
-    capsys: pytest.CaptureFixture,
+    capsys: pytest.CaptureFixture[str],
 ) -> None:
 
     configdir = tmp_path / "myconfigdir"

tests/cli/test_debug_info.py

@@ -8,7 +8,7 @@
 def test_debug_info_cli(
     monkeypatch: pytest.MonkeyPatch,
     tmp_path: pathlib.Path,
-    capsys: pytest.CaptureFixture,
+    capsys: pytest.CaptureFixture[str],
 ) -> None:
     monkeypatch.setenv("SHELL", "/bin/bash")
 

tests/cli/test_import.py

@@ -14,7 +14,7 @@ def test_import(
     cli_args: t.List[str],
     tmp_path: pathlib.Path,
     monkeypatch: pytest.MonkeyPatch,
-    capsys: pytest.CaptureFixture,
+    capsys: pytest.CaptureFixture[str],
 ) -> None:
     cli.cli(cli_args)
     result = capsys.readouterr()

tests/cli/test_load.py

@@ -262,7 +262,7 @@ def test_load(
     tmuxp_configdir: pathlib.Path,
     server: "Server",
     session: Session,
-    capsys: pytest.CaptureFixture,
+    capsys: pytest.CaptureFixture[str],
     monkeypatch: pytest.MonkeyPatch,
     test_id: str,
     cli_args: t.List[str],
@@ -322,7 +322,7 @@ def test_regression_00132_session_name_with_dots(
     tmp_path: pathlib.Path,
     server: "Server",
     session: Session,
-    capsys: pytest.CaptureFixture,
+    capsys: pytest.CaptureFixture[str],
 ) -> None:
     yaml_config = FIXTURE_PATH / "workspace/builder" / "regression_00132_dots.yaml"
     cli_args = [str(yaml_config)]
@@ -337,7 +337,7 @@ def test_load_zsh_autotitle_warning(
     cli_args: t.List[str],
     tmp_path: pathlib.Path,
     monkeypatch: pytest.MonkeyPatch,
-    capsys: pytest.CaptureFixture,
+    capsys: pytest.CaptureFixture[str],
     server: "Server",
 ) -> None:
     # create dummy tmuxp yaml so we don't get yelled at
@@ -396,7 +396,7 @@ def test_load_log_file(
     cli_args: t.List[str],
     tmp_path: pathlib.Path,
     monkeypatch: pytest.MonkeyPatch,
-    capsys: pytest.CaptureFixture,
+    capsys: pytest.CaptureFixture[str],
 ) -> None:
     # create dummy tmuxp yaml that breaks to prevent actually loading tmux
     tmuxp_config_path = tmp_path / ".tmuxp.yaml"
@@ -455,7 +455,10 @@ def test_load_plugins(monkeypatch_plugin_test_packages: None) -> None:
     ],
 )
 def test_load_plugins_version_fail_skip(
-    monkeypatch_plugin_test_packages, cli_args, inputs, capsys: pytest.CaptureFixture
+    monkeypatch_plugin_test_packages,
+    cli_args,
+    inputs,
+    capsys: pytest.CaptureFixture[str],
 ) -> None:
     try:
         cli.cli(cli_args)
@@ -480,7 +483,7 @@ def test_load_plugins_version_fail_no_skip(
     cli_args: t.List[str],
     inputs: t.List[str],
     monkeypatch: pytest.MonkeyPatch,
-    capsys: pytest.CaptureFixture,
+    capsys: pytest.CaptureFixture[str],
 ) -> None:
     monkeypatch.setattr("sys.stdin", io.StringIO("".join(inputs)))
 
@@ -500,7 +503,7 @@ def test_load_plugins_version_fail_no_skip(
 def test_load_plugins_plugin_missing(
     monkeypatch_plugin_test_packages: None,
     cli_args: t.List[str],
-    capsys: pytest.CaptureFixture,
+    capsys: pytest.CaptureFixture[str],
 ) -> None:
     try:
         cli.cli(cli_args)
@@ -527,7 +530,7 @@ def test_plugin_system_before_script(
         session_file, socket_name=server.socket_name, detached=True
     )
 
-    assert isinstance(session, libtmux.Session)
+    assert isinstance(session, Session)
     assert session.name == "plugin_test_bs"
 
 

tests/cli/test_ls.py

@@ -9,7 +9,7 @@
 def test_ls_cli(
     monkeypatch: pytest.MonkeyPatch,
     tmp_path: pathlib.Path,
-    capsys: pytest.CaptureFixture,
+    capsys: pytest.CaptureFixture[str],
 ) -> None:
     monkeypatch.setenv("HOME", str(tmp_path))
     monkeypatch.setenv("XDG_CONFIG_HOME", str(tmp_path / ".config"))

tests/cli/test_shell.py

@@ -89,7 +89,7 @@ def test_shell(
     session: Session,
     tmp_path: pathlib.Path,
     monkeypatch: pytest.MonkeyPatch,
-    capsys: pytest.CaptureFixture,
+    capsys: pytest.CaptureFixture[str],
 ) -> None:
     monkeypatch.setenv("HOME", str(tmp_path))
     window_name = "my_window"
@@ -180,7 +180,7 @@ def test_shell_target_missing(
     session: Session,
     tmp_path: pathlib.Path,
     monkeypatch: pytest.MonkeyPatch,
-    capsys: pytest.CaptureFixture,
+    capsys: pytest.CaptureFixture[str],
 ) -> None:
     monkeypatch.setenv("HOME", str(tmp_path))
     window_name = "my_window"
@@ -256,7 +256,7 @@ def test_shell_interactive(
     session: Session,
     tmp_path: pathlib.Path,
     monkeypatch: pytest.MonkeyPatch,
-    capsys: pytest.CaptureFixture,
+    capsys: pytest.CaptureFixture[str],
 ) -> None:
     monkeypatch.setenv("HOME", str(tmp_path))
     window_name = "my_window"

tests/fixtures/workspace/expand1.py

@@ -1,4 +1,5 @@
 import os
+from typing import Dict, List, Union
 
 before_workspace = {
     "session_name": "sample workspace",
@@ -30,7 +31,22 @@
 }
 
 
-def after_workspace():
+def after_workspace() -> Dict[
+    str,
+    Union[
+        str,
+        List[
+            Union[
+                Dict[str, Union[str, List[Dict[str, List[Dict[str, str]]]]]],
+                Dict[
+                    str,
+                    Union[str, Dict[str, bool], List[Dict[str, List[Dict[str, str]]]]],
+                ],
+                Dict[str, List[Dict[str, List[Dict[str, str]]]]],
+            ]
+        ],
+    ],
+]:
     return {
         "session_name": "sample workspace",
         "start_directory": os.path.expanduser("~"),

tests/fixtures/workspace/expand2.py

@@ -3,11 +3,11 @@
 from .. import utils as test_utils
 
 
-def unexpanded_yaml():
+def unexpanded_yaml() -> str:
     return test_utils.read_workspace_file("workspace/expand2-unexpanded.yaml")
 
 
-def expanded_yaml():
+def expanded_yaml() -> str:
     return test_utils.read_workspace_file("workspace/expand2-expanded.yaml").format(
         HOME=os.path.expanduser("~")
     )