!squash more

Author: tony

libtmux/pane.py

@@ -7,12 +7,12 @@
 """
 import logging
 import typing as t
-from typing import Dict
+from typing import Dict, overload
 
 from libtmux.common import tmux_cmd
 
 from . import exc
-from .common import TmuxMappingObject, TmuxRelationalObject
+from .common import PaneDict, TmuxMappingObject, TmuxRelationalObject
 
 if t.TYPE_CHECKING:
     from .server import Server
@@ -61,22 +61,27 @@ class Pane(TmuxMappingObject, TmuxRelationalObject):
     server: "Server"
     """:class:`libtmux.Server` pane is linked to"""
 
-    def __init__(self, window: "Window", **kwargs) -> None:
+    def __init__(
+        self,
+        window: "Window",
+        # pane_id: t.Optional[t.Union[str, int]] = None,
+        pane_id: t.Union[str, int],
+        **kwargs: t.Any,
+    ) -> None:
         self.window = window
         self.session = self.window.session
         self.server = self.session.server
 
-        self._pane_id = kwargs["pane_id"]
+        self._pane_id = pane_id
 
         self.server._update_panes()
 
     @property
-    def _info(self) -> Dict[str, str]:
-
+    def _info(self) -> PaneDict:
         attrs = {"pane_id": self._pane_id}
 
         # from https://github.com/serkanyersen/underscore.py
-        def by(val) -> bool:
+        def by(val: PaneDict) -> bool:
             for key in attrs.keys():
                 try:
                     if attrs[key] != val[key]:
@@ -85,11 +90,11 @@ def by(val) -> bool:
                     return False
             return True
 
-        # TODO add type hint
-        target_panes = list(filter(by, self.server._panes))
+        target_panes = [s for s in self.server._panes if by(s)]
+
         return target_panes[0]
 
-    def cmd(self, cmd: str, *args, **kwargs) -> tmux_cmd:
+    def cmd(self, cmd: str, *args: t.Any, **kwargs: t.Any) -> tmux_cmd:
         """Return :meth:`Server.cmd` defaulting to ``target_pane`` as target.
 
         Send command to tmux with :attr:`pane_id` as ``target-pane``.
@@ -140,7 +145,19 @@ def send_keys(
         if enter:
             self.enter()
 
-    def display_message(self, cmd, get_text=False):
+    @overload
+    def display_message(
+        self, cmd: str, get_text: t.Literal[True]
+    ) -> t.Union[str, t.List[str]]:
+        ...
+
+    @overload
+    def display_message(self, cmd: str, get_text: t.Literal[False]) -> None:
+        ...
+
+    def display_message(
+        self, cmd: str, get_text: bool = False
+    ) -> t.Optional[t.Union[str, t.List[str]]]:
         """
         ``$ tmux display-message`` to the pane.
 
@@ -161,10 +178,11 @@ def display_message(self, cmd, get_text=False):
         """
         if get_text:
             return self.cmd("display-message", "-p", cmd).stdout
-        else:
-            self.cmd("display-message", cmd)
 
-    def clear(self):
+        self.cmd("display-message", cmd)
+        return None
+
+    def clear(self) -> None:
         """Clear pane."""
         self.send_keys("reset")
 
@@ -174,7 +192,11 @@ def reset(self) -> None:
         self.cmd("send-keys", r"-R \; clear-history")
 
     def split_window(
-        self, attach=False, vertical=True, start_directory=None, percent=None
+        self,
+        attach: bool = False,
+        vertical: bool = True,
+        start_directory: t.Optional[str] = None,
+        percent: t.Optional[int] = None,
     ) -> "Pane":
         """
         Split window at pane and return newly created :class:`Pane`.
@@ -224,7 +246,7 @@ def set_height(self, height: int) -> None:
         """
         self.resize_pane(height=height)
 
-    def resize_pane(self, *args, **kwargs) -> "Pane":
+    def resize_pane(self, *args: t.Any, **kwargs: t.Any) -> "Pane":
         """
         ``$ tmux resize-pane`` of pane and return ``self``.
 
@@ -248,7 +270,6 @@ def resize_pane(self, *args, **kwargs) -> "Pane":
         ------
         exc.LibTmuxException
         """
-
         if "height" in kwargs:
             proc = self.cmd("resize-pane", "-y%s" % int(kwargs["height"]))
         elif "width" in kwargs:
@@ -270,7 +291,7 @@ def enter(self) -> None:
         """
         self.cmd("send-keys", "Enter")
 
-    def capture_pane(self):
+    def capture_pane(self) -> t.Union[str, t.List[str]]:
         """
         Capture text from pane.
 

libtmux/window.py

@@ -59,7 +59,9 @@ class Window(TmuxMappingObject, TmuxRelationalObject):
     session: "Session"
     """:class:`libtmux.Session` window is linked to"""
 
-    def __init__(self, session: "Session", window_id: str, **kwargs: t.Any) -> None:
+    def __init__(
+        self, session: "Session", window_id: t.Union[int, str], **kwargs: t.Any
+    ) -> None:
         self.session = session
         self.server = self.session.server
 
@@ -396,12 +398,12 @@ def last_pane(self) -> t.Optional[Pane]:
 
     def split_window(
         self,
-        target: None = None,
-        start_directory: None = None,
+        target: Optional[t.Union[int, str]] = None,
+        start_directory: Optional[str] = None,
         attach: bool = True,
         vertical: bool = True,
         shell: Optional[str] = None,
-        percent: None = None,
+        percent: Optional[int] = None,
     ) -> Pane:
         """
         Split window and return the created :class:`Pane`.