Adding type hints to methods returning self and child objects

Author: otherJL0

libtmux/session.py

@@ -6,12 +6,14 @@
 """
 import logging
 import os
+import typing as t
 
 from . import exc, formats
 from .common import (
     EnvironmentMixin,
     TmuxMappingObject,
     TmuxRelationalObject,
+    WindowDict,
     handle_option_error,
     has_version,
     session_check_name,
@@ -129,7 +131,7 @@ def switch_client(self):
         if proc.stderr:
             raise exc.LibTmuxException(proc.stderr)
 
-    def rename_session(self, new_name):
+    def rename_session(self, new_name: str) -> "Session":
         """
         Rename session and return new :class:`Session` object.
 
@@ -171,7 +173,7 @@ def new_window(
         attach=True,
         window_index="",
         window_shell=None,
-    ):
+    ) -> Window:
         """
         Return :class:`Window` from ``$ tmux new-window``.
 
@@ -273,20 +275,18 @@ def kill_window(self, target_window=None):
 
         self.server._update_windows()
 
-    def _list_windows(self):
+    def _list_windows(self) -> t.List[WindowDict]:
         windows = self.server._update_windows()._windows
 
-        windows = [w for w in windows if w["session_id"] == self.id]
-
-        return windows
+        return [w for w in windows if w["session_id"] == self.id]
 
     @property
-    def _windows(self):
+    def _windows(self) -> t.List[WindowDict]:
         """Property / alias to return :meth:`Session._list_windows`."""
 
         return self._list_windows()
 
-    def list_windows(self):
+    def list_windows(self) -> t.List[Window]:
         """Return a list of :class:`Window` from the ``tmux(1)`` session.
 
         Returns
@@ -298,15 +298,15 @@ def list_windows(self):
         return [Window(session=self, **window) for window in windows]
 
     @property
-    def windows(self):
+    def windows(self) -> t.List[Window]:
         """Property / alias to return :meth:`Session.list_windows`."""
         return self.list_windows()
 
     #: Alias :attr:`windows` for :class:`~libtmux.common.TmuxRelationalObject`
     children = windows
 
     @property
-    def attached_window(self):
+    def attached_window(self) -> Window:
         """
         Return active :class:`Window` object.
 
@@ -333,7 +333,7 @@ def attached_window(self):
         if len(self._windows) == int(0):
             raise exc.LibTmuxException("No Windows")
 
-    def select_window(self, target_window):
+    def select_window(self, target_window: str) -> Window:
         """
         Return :class:`Window` selected via ``$ tmux select-window``.