refactor!(typings): MonkeyType typings (automated + black + isort)

Author: tony

libtmux/pane.py

@@ -7,6 +7,9 @@
 """
 import logging
 import typing as t
+from typing import Dict
+
+from libtmux.common import tmux_cmd
 
 from . import exc
 from .common import TmuxMappingObject, TmuxRelationalObject
@@ -58,7 +61,7 @@ class Pane(TmuxMappingObject, TmuxRelationalObject):
     server: "Server"
     """:class:`libtmux.Server` pane is linked to"""
 
-    def __init__(self, window: "Window", **kwargs):
+    def __init__(self, window: "Window", **kwargs) -> None:
         self.window = window
         self.session = self.window.session
         self.server = self.session.server
@@ -68,7 +71,7 @@ def __init__(self, window: "Window", **kwargs):
         self.server._update_panes()
 
     @property
-    def _info(self):
+    def _info(self) -> Dict[str, str]:
 
         attrs = {"pane_id": self._pane_id}
 
@@ -86,7 +89,7 @@ def by(val) -> bool:
         target_panes = list(filter(by, self.server._panes))
         return target_panes[0]
 
-    def cmd(self, cmd, *args, **kwargs):
+    def cmd(self, cmd: str, *args, **kwargs) -> tmux_cmd:
         """Return :meth:`Server.cmd` defaulting to ``target_pane`` as target.
 
         Send command to tmux with :attr:`pane_id` as ``target-pane``.
@@ -103,7 +106,13 @@ def cmd(self, cmd, *args, **kwargs):
 
         return self.server.cmd(cmd, *args, **kwargs)
 
-    def send_keys(self, cmd, enter=True, suppress_history=True, literal=False):
+    def send_keys(
+        self,
+        cmd: str,
+        enter: bool = True,
+        suppress_history: bool = True,
+        literal: bool = False,
+    ) -> None:
         """
         ``$ tmux send-keys`` to the pane.
 
@@ -159,7 +168,7 @@ def clear(self):
         """Clear pane."""
         self.send_keys("reset")
 
-    def reset(self):
+    def reset(self) -> None:
         """Reset and clear pane history."""
 
         self.cmd("send-keys", r"-R \; clear-history")
@@ -193,7 +202,7 @@ def split_window(
             percent=percent,
         )
 
-    def set_width(self, width):
+    def set_width(self, width: int) -> None:
         """
         Set width of pane.
 
@@ -204,7 +213,7 @@ def set_width(self, width):
         """
         self.resize_pane(width=width)
 
-    def set_height(self, height):
+    def set_height(self, height: int) -> None:
         """
         Set height of pane.
 
@@ -215,7 +224,7 @@ def set_height(self, height):
         """
         self.resize_pane(height=height)
 
-    def resize_pane(self, *args, **kwargs):
+    def resize_pane(self, *args, **kwargs) -> "Pane":
         """
         ``$ tmux resize-pane`` of pane and return ``self``.
 
@@ -253,7 +262,7 @@ def resize_pane(self, *args, **kwargs):
         self.server._update_panes()
         return self
 
-    def enter(self):
+    def enter(self) -> None:
         """
         Send carriage return to pane.
 

libtmux/server.py

@@ -8,6 +8,9 @@
 import os
 import typing as t
 
+from libtmux.common import tmux_cmd
+from libtmux.session import Session
+
 from . import exc, formats
 from .common import (
     EnvironmentMixin,
@@ -17,9 +20,7 @@
     WindowDict,
     has_gte_version,
     session_check_name,
-    tmux_cmd,
 )
-from .session import Session
 
 logger = logging.getLogger(__name__)
 
@@ -75,12 +76,12 @@ class Server(TmuxRelationalObject, EnvironmentMixin):
 
     def __init__(
         self,
-        socket_name=None,
-        socket_path=None,
-        config_file=None,
-        colors=None,
+        socket_name: t.Optional[str] = None,
+        socket_path: t.Optional[str] = None,
+        config_file: t.Optional[str] = None,
+        colors: t.Optional[int] = None,
         **kwargs,
-    ):
+    ) -> None:
         EnvironmentMixin.__init__(self, "-g")
         self._windows = []
         self._panes = []
@@ -97,7 +98,7 @@ def __init__(
         if colors:
             self.colors = colors
 
-    def cmd(self, *args, **kwargs):
+    def cmd(self, *args, **kwargs) -> tmux_cmd:
         """
         Execute tmux command and return output.
 
@@ -382,7 +383,7 @@ def has_session(self, target_session: str, exact: bool = True) -> bool:
 
         return False
 
-    def kill_server(self):
+    def kill_server(self) -> None:
         """``$ tmux kill-server``."""
         self.cmd("kill-server")
 
@@ -413,7 +414,7 @@ def kill_session(self, target_session=None) -> "Server":
 
         return self
 
-    def switch_client(self, target_session):
+    def switch_client(self, target_session: str):
         """
         ``$ tmux switch-client``.
 
@@ -433,7 +434,7 @@ def switch_client(self, target_session):
         if proc.stderr:
             raise exc.LibTmuxException(proc.stderr)
 
-    def attach_session(self, target_session=None):
+    def attach_session(self, target_session: t.Optional[str] = None):
         """``$ tmux attach-session`` aka alias: ``$ tmux attach``.
 
         Parameters
@@ -458,12 +459,12 @@ def attach_session(self, target_session=None):
 
     def new_session(
         self,
-        session_name=None,
-        kill_session=False,
-        attach=False,
-        start_directory=None,
-        window_name=None,
-        window_command=None,
+        session_name: t.Optional[str] = None,
+        kill_session: bool = False,
+        attach: bool = False,
+        start_directory: None = None,
+        window_name: None = None,
+        window_command: t.Optional[str] = None,
         *args,
         **kwargs,
     ) -> Session:

libtmux/session.py

@@ -7,6 +7,10 @@
 import logging
 import os
 import typing as t
+from typing import Dict, Optional, Union
+
+from libtmux.common import tmux_cmd
+from libtmux.window import Window
 
 from . import exc, formats
 from .common import (
@@ -18,7 +22,6 @@
     has_version,
     session_check_name,
 )
-from .window import Window
 
 if t.TYPE_CHECKING:
     from .pane import Pane
@@ -58,7 +61,7 @@ class Session(TmuxMappingObject, TmuxRelationalObject, EnvironmentMixin):
     server: "Server"
     """:class:`libtmux.server.Server` session is linked to"""
 
-    def __init__(self, server: "Server", **kwargs):
+    def __init__(self, server: "Server", **kwargs) -> None:
         EnvironmentMixin.__init__(self)
         self.server = server
 
@@ -68,7 +71,7 @@ def __init__(self, server: "Server", **kwargs):
         self.server._update_windows()
 
     @property
-    def _info(self):
+    def _info(self) -> Dict[str, str]:
 
         attrs = {"session_id": str(self._session_id)}
 
@@ -88,7 +91,7 @@ def by(val) -> bool:
         except IndexError as e:
             logger.error(e)
 
-    def cmd(self, *args, **kwargs):
+    def cmd(self, *args, **kwargs) -> tmux_cmd:
         """
         Return :meth:`server.cmd`.
 
@@ -177,11 +180,11 @@ def rename_session(self, new_name: str) -> "Session":
 
     def new_window(
         self,
-        window_name=None,
-        start_directory=None,
-        attach=True,
-        window_index="",
-        window_shell=None,
+        window_name: Optional[str] = None,
+        start_directory: None = None,
+        attach: bool = True,
+        window_index: str = "",
+        window_shell: None = None,
     ) -> Window:
         """
         Return :class:`Window` from ``$ tmux new-window``.
@@ -259,7 +262,7 @@ def new_window(
 
         return window
 
-    def kill_window(self, target_window=None):
+    def kill_window(self, target_window: Optional[str] = None) -> None:
         """Close a tmux window, and all panes inside it, ``$ tmux kill-window``
 
         Kill the current window or the window at ``target-window``. removing it
@@ -378,7 +381,9 @@ def attached_pane(self) -> t.Optional["Pane"]:
 
         return self.attached_window.attached_pane
 
-    def set_option(self, option, value, _global=False):
+    def set_option(
+        self, option: str, value: Union[str, int], _global: bool = False
+    ) -> None:
         """
         Set option ``$ tmux set-option <option> <value>``.
 
@@ -421,7 +426,9 @@ def set_option(self, option, value, _global=False):
         if isinstance(proc.stderr, list) and len(proc.stderr):
             handle_option_error(proc.stderr[0])
 
-    def show_options(self, _global=False):
+    def show_options(
+        self, _global: Optional[bool] = False
+    ) -> Dict[str, Union[str, int]]:
         """
         Return a dict of options for the window.
 
@@ -460,7 +467,9 @@ def show_options(self, _global=False):
 
         return session_options
 
-    def show_option(self, option, _global=False):
+    def show_option(
+        self, option: str, _global: bool = False
+    ) -> Optional[Union[str, int]]:
         """Return a list of options for the window.
 
         Parameters

libtmux/test.py

@@ -7,6 +7,8 @@
 import warnings
 from typing import Callable, Optional
 
+from libtmux.server import Server
+
 from .exc import WaitTimeout
 
 logger = logging.getLogger(__name__)
@@ -17,13 +19,15 @@
 
 
 class RandomStrSequence:
-    def __init__(self, characters: str = "abcdefghijklmnopqrstuvwxyz0123456789_"):
+    def __init__(
+        self, characters: str = "abcdefghijklmnopqrstuvwxyz0123456789_"
+    ) -> None:
         self.characters: str = characters
 
     def __iter__(self):
         return self
 
-    def __next__(self):
+    def __next__(self) -> str:
         return "".join(random.sample(self.characters, k=8))
 
 
@@ -119,7 +123,7 @@ def retry_until(
     return True
 
 
-def get_test_session_name(server, prefix=TEST_SESSION_PREFIX):
+def get_test_session_name(server: Server, prefix: str = TEST_SESSION_PREFIX) -> str:
     """
     Faker to create a session name that doesn't exist.