Adding type hints to methods returning self and child objects

Author: otherJL0

libtmux/window.py

@@ -7,9 +7,15 @@
 import logging
 import os
 import shlex
+import typing as t
 
 from . import exc, formats
-from .common import TmuxMappingObject, TmuxRelationalObject, handle_option_error
+from .common import (
+    PaneDict,
+    TmuxMappingObject,
+    TmuxRelationalObject,
+    handle_option_error,
+)
 from .pane import Pane
 
 logger = logging.getLogger(__name__)
@@ -270,7 +276,7 @@ def show_window_option(self, option, g=False):
 
         return option[1]
 
-    def rename_window(self, new_name):
+    def rename_window(self, new_name: str) -> "Window":
         """
         Return :class:`Window` object ``$ tmux rename-window <new_name>``.
 
@@ -335,7 +341,7 @@ def move_window(self, destination="", session=None):
 
         self.server._update_windows()
 
-    def select_window(self):
+    def select_window(self) -> "Window":
         """
         Select window. Return ``self``.
 
@@ -349,7 +355,7 @@ def select_window(self):
         """
         return self.session.select_window(self.index)
 
-    def select_pane(self, target_pane):
+    def select_pane(self, target_pane: str) -> Pane:
         """
         Return selected :class:`Pane` through ``$ tmux select-pane``.
 
@@ -373,7 +379,7 @@ def select_pane(self, target_pane):
 
         return self.attached_pane
 
-    def last_pane(self):
+    def last_pane(self) -> Pane:
         """Return last pane."""
         return self.select_pane("-l")
 
@@ -385,7 +391,7 @@ def split_window(
         vertical=True,
         shell=None,
         percent=None,
-    ):
+    ) -> Pane:
         """
         Split window and return the created :class:`Pane`.
 
@@ -486,7 +492,7 @@ def split_window(
         return Pane(window=self, **pane)
 
     @property
-    def attached_pane(self):
+    def attached_pane(self) -> Pane:
         """
         Return the attached :class:`Pane`.
 
@@ -504,20 +510,20 @@ def attached_pane(self):
 
         return []
 
-    def _list_panes(self):
+    def _list_panes(self) -> t.List[PaneDict]:
         panes = self.server._update_panes()._panes
 
         panes = [p for p in panes if p["session_id"] == self.get("session_id")]
         panes = [p for p in panes if p["window_id"] == self.id]
         return panes
 
     @property
-    def _panes(self):
+    def _panes(self) -> t.List[PaneDict]:
         """Property / alias to return :meth:`~._list_panes`."""
 
         return self._list_panes()
 
-    def list_panes(self):
+    def list_panes(self) -> t.List[Pane]:
         """
         Return list of :class:`Pane` for the window.
 
@@ -529,7 +535,7 @@ def list_panes(self):
         return [Pane(window=self, **pane) for pane in self._panes]
 
     @property
-    def panes(self):
+    def panes(self) -> t.List[Pane]:
         """Property / alias to return :meth:`~.list_panes`."""
         return self.list_panes()