Annotations

Author: tony

libtmux/session.py

@@ -18,11 +18,13 @@
     has_version,
     session_check_name,
 )
-from .pane import Pane
 from .window import Window
 
 logger = logging.getLogger(__name__)
 
+if t.TYPE_CHECKING:
+    from .pane import Pane
+
 
 class Session(TmuxMappingObject, TmuxRelationalObject, EnvironmentMixin):
     """
@@ -367,7 +369,7 @@ def select_window(self, target_window: str) -> Window:
         return self.attached_window
 
     @property
-    def attached_pane(self) -> t.Optional[Pane]:
+    def attached_pane(self) -> t.Optional["Pane"]:
         """Return active :class:`Pane` object."""
 
         return self.attached_window.attached_pane

libtmux/window.py

@@ -8,6 +8,10 @@
 import os
 import shlex
 import typing as t
+from typing import TYPE_CHECKING, Dict, Optional, Union
+
+from libtmux.common import tmux_cmd
+from libtmux.pane import Pane
 
 from . import exc, formats
 from .common import (
@@ -16,10 +20,12 @@
     TmuxRelationalObject,
     handle_option_error,
 )
-from .pane import Pane
 
 logger = logging.getLogger(__name__)
 
+if TYPE_CHECKING:
+    from libtmux.session import Session
+
 
 class Window(TmuxMappingObject, TmuxRelationalObject):
     """
@@ -46,7 +52,7 @@ class Window(TmuxMappingObject, TmuxRelationalObject):
     #: namespace used :class:`~libtmux.common.TmuxMappingObject`
     formatter_prefix = "window_"
 
-    def __init__(self, session=None, **kwargs):
+    def __init__(self, session: Optional["Session"] = None, **kwargs) -> None:
 
         if not session:
             raise ValueError("Window requires a Session, session=Session")
@@ -69,7 +75,7 @@ def __repr__(self):
         )
 
     @property
-    def _info(self):
+    def _info(self) -> Dict[str, str]:
         attrs = {"window_id": self._window_id}
 
         # from https://github.com/serkanyersen/underscore.py
@@ -91,7 +97,7 @@ def by(val) -> bool:
             target_windows = self.server._windows
         return target_windows[0]
 
-    def cmd(self, cmd, *args, **kwargs):
+    def cmd(self, cmd: str, *args, **kwargs) -> tmux_cmd:
         """Return :meth:`Server.cmd` defaulting ``target_window`` as target.
 
         Send command to tmux with :attr:`window_id` as ``target-window``.
@@ -114,7 +120,7 @@ def cmd(self, cmd, *args, **kwargs):
 
         return self.server.cmd(cmd, *args, **kwargs)
 
-    def select_layout(self, layout=None):
+    def select_layout(self, layout: Optional[str] = None) -> None:
         """Wrapper for ``$ tmux select-layout <layout>``.
 
         Parameters
@@ -153,7 +159,7 @@ def select_layout(self, layout=None):
         if proc.stderr:
             raise exc.LibTmuxException(proc.stderr)
 
-    def set_window_option(self, option, value):
+    def set_window_option(self, option: str, value: Union[int, str]) -> None:
         """
         Wrapper for ``$ tmux set-window-option <option> <value>``.
 
@@ -189,7 +195,9 @@ def set_window_option(self, option, value):
         if isinstance(cmd.stderr, list) and len(cmd.stderr):
             handle_option_error(cmd.stderr[0])
 
-    def show_window_options(self, option=None, g=False):
+    def show_window_options(
+        self, option: Optional[str] = None, g: bool = False
+    ) -> Union[str, Dict[str, Union[str, int]], int, Dict[str, str]]:
         """
         Return a dict of options for the window.
 
@@ -232,7 +240,9 @@ def show_window_options(self, option=None, g=False):
 
         return window_options
 
-    def show_window_option(self, option, g=False):
+    def show_window_option(
+        self, option: str, g: bool = False
+    ) -> Optional[Union[str, int]]:
         """
         Return a list of options for the window.
 
@@ -302,7 +312,7 @@ def rename_window(self, new_name: str) -> "Window":
 
         return self
 
-    def kill_window(self):
+    def kill_window(self) -> None:
         """Kill the current :class:`Window` object. ``$ tmux kill-window``."""
 
         proc = self.cmd(
@@ -316,7 +326,7 @@ def kill_window(self):
 
         self.server._update_windows()
 
-    def move_window(self, destination="", session=None):
+    def move_window(self, destination: str = "", session: Optional[str] = None) -> None:
         """
         Move the current :class:`Window` object ``$ tmux move-window``.
 
@@ -385,12 +395,12 @@ def last_pane(self) -> t.Optional[Pane]:
 
     def split_window(
         self,
-        target=None,
-        start_directory=None,
-        attach=True,
-        vertical=True,
-        shell=None,
-        percent=None,
+        target: None = None,
+        start_directory: None = None,
+        attach: bool = True,
+        vertical: bool = True,
+        shell: Optional[str] = None,
+        percent: None = None,
     ) -> Pane:
         """
         Split window and return the created :class:`Pane`.

tests/test_tmuxobject.py

@@ -1,8 +1,10 @@
 """Tests for libtmux TmuxRelationalObject and TmuxMappingObject."""
 import logging
 
-from libtmux import Pane, Session, Window
+from libtmux.pane import Pane
+from libtmux.session import Session
 from libtmux.test import TEST_SESSION_PREFIX, namer
+from libtmux.window import Window
 
 logger = logging.getLogger(__name__)