refactor!: Add typings from monkeytype

Author: tony

src/tmuxp/workspace/builder.py

@@ -188,7 +188,7 @@ def __init__(
                 pass
 
     @property
-    def session(self):
+    def session(self) -> Session:
         if self._session is None:
             raise exc.SessionMissingWorkspaceException()
         return self._session

src/tmuxp/workspace/freezer.py

@@ -7,7 +7,7 @@
     from libtmux.window import Window
 
 
-def inline(workspace_dict):
+def inline(workspace_dict: t.Dict[str, t.Any]) -> t.Any:
     """Return workspace with inlined shorthands. Opposite of :meth:`loader.expand`.
 
     Parameters

src/tmuxp/workspace/loader.py

@@ -7,7 +7,7 @@
 import logging
 import os
 import pathlib
-from typing import Dict
+import typing as t
 
 logger = logging.getLogger(__name__)
 
@@ -30,7 +30,7 @@ def expandshell(value: str) -> str:
     return os.path.expandvars(os.path.expanduser(value))  # NOQA: PTH111
 
 
-def expand_cmd(p: Dict) -> Dict:
+def expand_cmd(p: t.Dict) -> t.Dict:
     if isinstance(p, str):
         p = {"shell_command": [p]}
     elif isinstance(p, list):
@@ -66,7 +66,11 @@ def expand_cmd(p: Dict) -> Dict:
     return p
 
 
-def expand(workspace_dict, cwd=None, parent=None):
+def expand(
+    workspace_dict: t.Dict[str, t.Any],
+    cwd: t.Optional[t.Union[pathlib.Path, str]] = None,
+    parent: t.Optional[t.Any] = None,
+) -> t.Dict[str, t.Any]:
     """Return workspace with shorthand and inline properties expanded.
 
     This is necessary to keep the code in the :class:`WorkspaceBuilder` clean
@@ -185,7 +189,7 @@ def expand(workspace_dict, cwd=None, parent=None):
     return workspace_dict
 
 
-def trickle(workspace_dict):
+def trickle(workspace_dict: t.Dict[str, t.Any]) -> t.Dict[str, t.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:
     # In scrunched terminals, prevent width causing differantiation in result.out.
     monkeypatch.setenv("COLUMNS", "100")
@@ -86,7 +86,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"
     configdir.mkdir()

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

@@ -15,7 +15,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],
@@ -318,7 +318,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)]
@@ -333,7 +333,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
@@ -392,7 +392,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"
@@ -450,7 +450,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:
     with contextlib.suppress(SystemExit):
         cli.cli(cli_args)
@@ -474,7 +477,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)))
 
@@ -493,7 +496,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:
     with contextlib.suppress(SystemExit):
         cli.cli(cli_args)
@@ -519,7 +522,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

@@ -90,7 +90,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"
@@ -181,7 +181,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"
@@ -257,7 +257,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 pathlib
+import typing as t
 
 before_workspace = {
     "session_name": "sample workspace",
@@ -30,7 +31,30 @@
 }
 
 
-def after_workspace():
+def after_workspace() -> (
+    t.Dict[
+        str,
+        t.Union[
+            str,
+            t.List[
+                t.Union[
+                    t.Dict[
+                        str, t.Union[str, t.List[t.Dict[str, t.List[t.Dict[str, str]]]]]
+                    ],
+                    t.Dict[
+                        str,
+                        t.Union[
+                            str,
+                            t.Dict[str, bool],
+                            t.List[t.Dict[str, t.List[t.Dict[str, str]]]],
+                        ],
+                    ],
+                    t.Dict[str, t.List[t.Dict[str, t.List[t.Dict[str, str]]]]],
+                ]
+            ],
+        ],
+    ]
+):
     return {
         "session_name": "sample workspace",
         "start_directory": str(pathlib.Path().home()),