ci(ruff): Automated lint fixes

Fixed 81 errors:
- conftest.py:
    1 × I001 (unsorted-imports)
- docs/conf.py:
    2 × RUF100 (unused-noqa)
    1 × SIM108 (if-else-block-instead-of-if-exp)
    1 × I001 (unsorted-imports)
- src/libtmux/_internal/query_list.py:
    6 × ERA001 (commented-out-code)
    1 × SIM118 (in-dict-keys)
- src/libtmux/common.py:
    1 × UP031 (printf-string-formatting)
    1 × C408 (unnecessary-collection-call)
- src/libtmux/formats.py:
    2 × ERA001 (commented-out-code)
- src/libtmux/neo.py:
    3 × ERA001 (commented-out-code)
    1 × C408 (unnecessary-collection-call)
- src/libtmux/pane.py:
    4 × ERA001 (commented-out-code)
    4 × RUF002 (ambiguous-unicode-character-docstring)
    1 × RUF005 (collection-literal-concatenation)
    1 × UP032 (f-string)
- src/libtmux/pytest_plugin.py:
    1 × F841 (unused-variable)
    1 × SIM300 (yoda-conditions)
    1 × TRY201 (verbose-raise)
    1 × ERA001 (commented-out-code)
    1 × SIM105 (suppressible-exception)
    1 × I001 (unsorted-imports)
    1 × SIM118 (in-dict-keys)
    1 × PERF102 (incorrect-dict-iterator)
- src/libtmux/server.py:
    2 × C408 (unnecessary-collection-call)
    1 × RUF005 (collection-literal-concatenation)
    1 × B009 (get-attr-with-constant)
    1 × ERA001 (commented-out-code)
- src/libtmux/session.py:
    5 × C408 (unnecessary-collection-call)
    2 × RUF015 (unnecessary-iterable-allocation-for-first-element)
    1 × UP031 (printf-string-formatting)
    1 × ERA001 (commented-out-code)
    1 × UP032 (f-string)
- src/libtmux/test.py:
    1 × C408 (unnecessary-collection-call)
- src/libtmux/window.py:
    6 × UP032 (f-string)
    4 × ERA001 (commented-out-code)
    3 × C408 (unnecessary-collection-call)
    2 × UP031 (printf-string-formatting)
    1 × RUF005 (collection-literal-concatenation)
    1 × RUF015 (unnecessary-iterable-allocation-for-first-element)
- tests/legacy_api/test_common.py:
    1 × SIM300 (yoda-conditions)
- tests/legacy_api/test_server.py:
    3 × SIM300 (yoda-conditions)
- tests/test_common.py:
    1 × SIM300 (yoda-conditions)
- tests/test_pytest_plugin.py:
    1 × ERA001 (commented-out-code)
    1 × RUF015 (unnecessary-iterable-allocation-for-first-element)
- tests/test_server.py:
    3 × SIM300 (yoda-conditions)

Author: tony

conftest.py

@@ -12,7 +12,6 @@
 import typing as t
 
 import pytest
-
 from _pytest.doctest import DoctestItem
 
 from libtmux.pytest_plugin import USING_ZSH

docs/conf.py

@@ -1,13 +1,12 @@
 # flake8: NOQA: E501
 import contextlib
 import inspect
-import sys
-from os.path import relpath
 import pathlib
+import sys
 import typing as t
+from os.path import relpath
 
-import libtmux  # NOQA
-from libtmux import test  # NOQA
+import libtmux
 
 if t.TYPE_CHECKING:
     from sphinx.application import Sphinx
@@ -166,9 +165,7 @@
 }
 
 
-def linkcode_resolve(
-    domain: str, info: t.Dict[str, str]
-) -> t.Union[None, str]:  # NOQA: C901
+def linkcode_resolve(domain: str, info: t.Dict[str, str]) -> t.Union[None, str]:
     """
     Determine the URL corresponding to Python object
 
@@ -216,10 +213,7 @@ def linkcode_resolve(
     except Exception:
         lineno = None
 
-    if lineno:
-        linespec = "#L%d-L%d" % (lineno, lineno + len(source) - 1)
-    else:
-        linespec = ""
+    linespec = "#L%d-L%d" % (lineno, lineno + len(source) - 1) if lineno else ""
 
     fn = relpath(fn, start=pathlib.Path(libtmux.__file__).parent)
 

src/libtmux/_internal/query_list.py

@@ -123,7 +123,7 @@ def lookup_icontains(
     if isinstance(data, str):
         return rhs.lower() in data.lower()
     if isinstance(data, Mapping):
-        return rhs.lower() in [k.lower() for k in data.keys()]
+        return rhs.lower() in [k.lower() for k in data]
 
     return False
 
@@ -183,7 +183,6 @@ def lookup_in(
             return rhs in data
         # TODO: Add a deep Mappingionary matcher
         # if isinstance(rhs, Mapping) and isinstance(data, Mapping):
-        #     return rhs.items() not in data.items()
     except Exception:
         return False
     return False
@@ -205,7 +204,6 @@ def lookup_nin(
             return rhs not in data
         # TODO: Add a deep Mappingionary matcher
         # if isinstance(rhs, Mapping) and isinstance(data, Mapping):
-        #     return rhs.items() not in data.items()
     except Exception:
         return False
     return False
@@ -293,10 +291,6 @@ def __eq__(
         self,
         other: object,
         # other: Union[
-        #     "QueryList[T]",
-        #     List[Mapping[str, str]],
-        #     List[Mapping[str, int]],
-        #     List[Mapping[str, Union[str, Mapping[str, Union[List[str], str]]]]],
         # ],
     ) -> bool:
         data = other

src/libtmux/common.py

@@ -172,7 +172,7 @@ def getenv(self, name: str) -> Optional[t.Union[str, bool]]:
         str
             Value of environment variable
         """
-        tmux_args: t.Tuple[t.Union[str, int], ...] = tuple()
+        tmux_args: t.Tuple[t.Union[str, int], ...] = ()
 
         tmux_args += ("show-environment",)
         if self._add_option:
@@ -425,9 +425,10 @@ def has_minimum_version(raises: bool = True) -> bool:
     if get_version() < LooseVersion(TMUX_MIN_VERSION):
         if raises:
             raise exc.VersionTooLow(
-                "libtmux only supports tmux %s and greater. This system"
-                " has %s installed. Upgrade your tmux to use libtmux."
-                % (TMUX_MIN_VERSION, get_version())
+                "libtmux only supports tmux {} and greater. This system"
+                " has {} installed. Upgrade your tmux to use libtmux.".format(
+                    TMUX_MIN_VERSION, get_version()
+                )
             )
         else:
             return False

src/libtmux/formats.py

@@ -41,14 +41,12 @@
 ]
 
 WINDOW_FORMATS = [
-    # format_window()
     "window_id",
     "window_name",
     "window_width",
     "window_height",
     "window_layout",
     "window_panes",
-    # format_winlink()
     "window_index",
     "window_flags",
     "window_active",

src/libtmux/neo.py

@@ -40,16 +40,13 @@ class Obj:
     alternate_saved_x: t.Union[str, None] = None
     alternate_saved_y: t.Union[str, None] = None
     # See QUIRK_TMUX_3_1_X_0001
-    # buffer_created: t.Union[str, None] = None
     buffer_name: t.Union[str, None] = None
     buffer_sample: t.Union[str, None] = None
     buffer_size: t.Union[str, None] = None
     # See QUIRK_TMUX_3_1_X_0001
-    # client_activity: t.Union[str, None] = None
     client_cell_height: t.Union[str, None] = None
     client_cell_width: t.Union[str, None] = None
     # See QUIRK_TMUX_3_1_X_0001
-    # client_created: t.Union[str, None] = None
     client_discarded: t.Union[str, None] = None
     client_flags: t.Union[str, None] = None
     client_height: t.Union[str, None] = None
@@ -182,11 +179,13 @@ def _refresh(
 
 
 def fetch_objs(
-    server: "Server", list_cmd: "ListCmd", list_extra_args: "ListExtraArgs" = None
+    server: "Server",
+    list_cmd: "ListCmd",
+    list_extra_args: "t.Optional[ListExtraArgs]" = None,
 ) -> OutputsRaw:
     formats = list(Obj.__dataclass_fields__.keys())
 
-    cmd_args: t.List[t.Union[str, int]] = list()
+    cmd_args: t.List[t.Union[str, int]] = []
 
     if server.socket_name:
         cmd_args.insert(0, f"-L{server.socket_name}")
@@ -229,7 +228,7 @@ def fetch_obj(
     obj_key: str,
     obj_id: str,
     list_cmd: "ListCmd" = "list-panes",
-    list_extra_args: "ListExtraArgs" = None,
+    list_extra_args: "t.Optional[ListExtraArgs]" = None,
 ) -> OutputRaw:
     obj_formatters_filtered = fetch_objs(
         server=server, list_cmd=list_cmd, list_extra_args=list_extra_args

src/libtmux/pane.py

@@ -103,7 +103,6 @@ def session(self) -> "Session":
         return self.window.session
 
     #
-    # Command (pane-scoped)
     #
     def cmd(self, cmd: str, *args: t.Any, **kwargs: t.Any) -> tmux_cmd:
         """Return :meth:`Server.cmd` defaulting to ``target_pane`` as target.
@@ -114,12 +113,11 @@ def cmd(self, cmd: str, *args: t.Any, **kwargs: t.Any) -> tmux_cmd:
         ``args`` will override using the object's ``pane_id`` as target.
         """
         if not any(arg.startswith("-t") for arg in args):
-            args = ("-t", self.pane_id) + args
+            args = ("-t", self.pane_id, *args)
 
         return self.server.cmd(cmd, *args, **kwargs)
 
     #
-    # Commands (tmux-like)
     #
     def resize_pane(self, *args: t.Any, **kwargs: t.Any) -> "Pane":
         """
@@ -174,14 +172,14 @@ def capture_pane(
             Zero is the first line of the visible pane.
             Positive numbers are lines in the visible pane.
             Negative numbers are lines in the history.
-            ‘-’ is the start of the history.
+            `-` is the start of the history.
             Default: None
         end: [str,int]
             Specify the ending line number.
             Zero is the first line of the visible pane.
             Positive numbers are lines in the visible pane.
             Negative numbers are lines in the history.
-            ‘-’ is the end of the visible pane
+            `-` is the end of the visible pane
             Default: None
         """
         cmd = ["capture-pane", "-p"]
@@ -277,7 +275,6 @@ def display_message(
         return None
 
     #
-    # Commands ("climber"-helpers)
     #
     # These are commands that climb to the parent scope's methods with
     # additional scoped window info.
@@ -326,7 +323,6 @@ def split_window(
         )
 
     #
-    # Commands (helpers)
     #
     def set_width(self, width: int) -> "Pane":
         """
@@ -380,7 +376,7 @@ def __eq__(self, other: object) -> bool:
         return self.pane_id == other.pane_id
 
     def __repr__(self) -> str:
-        return "{}({} {})".format(self.__class__.__name__, self.pane_id, self.window)
+        return f"{self.__class__.__name__}({self.pane_id} {self.window})"
 
     #
     # Aliases

src/libtmux/pytest_plugin.py

@@ -1,3 +1,4 @@
+import contextlib
 import getpass
 import logging
 import os
@@ -80,7 +81,7 @@ def clear_env(monkeypatch: pytest.MonkeyPatch) -> None:
 
     tmux show-environment tests were being interrupted due to a lot of crazy env vars.
     """
-    for k, v in os.environ.items():
+    for k in os.environ:
         if not any(
             needle in k.lower()
             for needle in [
@@ -226,8 +227,8 @@ def session(
 
     try:
         session = server.new_session(session_name=TEST_SESSION_NAME, **session_params)
-    except exc.LibTmuxException as e:
-        raise e
+    except exc.LibTmuxException:
+        raise
 
     """
     Make sure that tmuxp can :ref:`test_builder_visually` and switches to
@@ -236,16 +237,13 @@ def session(
     session_id = session.session_id
     assert session_id is not None
 
-    try:
+    with contextlib.suppress(exc.LibTmuxException):
         server.switch_client(target_session=session_id)
-    except exc.LibTmuxException:
-        # server.attach_session(session.get('session_id'))
-        pass
 
     for old_test_session in old_test_sessions:
         logger.debug(f"Old test test session {old_test_session} found. Killing it.")
         server.kill_session(old_test_session)
-    assert TEST_SESSION_NAME == session.session_name
+    assert session.session_name == TEST_SESSION_NAME
     assert TEST_SESSION_NAME != "tmuxp"
 
     return session

src/libtmux/server.py

@@ -169,7 +169,7 @@ def raise_if_dead(self) -> None:
         if self.config_file:
             cmd_args.insert(0, f"-f{self.config_file}")
 
-        subprocess.check_call([tmux_bin] + cmd_args)
+        subprocess.check_call([tmux_bin, *cmd_args])
 
     #
     # Command
@@ -227,7 +227,7 @@ def attached_sessions(self) -> t.List[Session]:
         """
         try:
             sessions = self.sessions
-            attached_sessions = list()
+            attached_sessions = []
 
             for session in sessions:
                 attached = session.session_attached
@@ -239,7 +239,6 @@ def attached_sessions(self) -> t.List[Session]:
                     continue
 
             return attached_sessions
-            # return [Session(**s) for s in attached_sessions] or None
         except Exception:
             return []
 
@@ -339,7 +338,7 @@ def attach_session(self, target_session: t.Optional[str] = None) -> None:
         """
         session_check_name(target_session)
 
-        tmux_args: t.Tuple[str, ...] = tuple()
+        tmux_args: t.Tuple[str, ...] = ()
         if target_session:
             tmux_args += ("-t%s" % target_session,)
 
@@ -572,10 +571,7 @@ def __repr__(self) -> str:
                 f"(socket_name={getattr(self, 'socket_name', 'default')})"
             )
         elif self.socket_path is not None:
-            return (
-                f"{self.__class__.__name__}"
-                f"(socket_path={getattr(self, 'socket_path')})"
-            )
+            return f"{self.__class__.__name__}" f"(socket_path={self.socket_path})"
         return f"{self.__class__.__name__}" f"(socket_path=/tmp/tmux-1000/default)"
 
     #

src/libtmux/session.py

@@ -151,7 +151,7 @@ def cmd(self, *args: t.Any, **kwargs: t.Any) -> tmux_cmd:
         # if -t is not set in any arg yet
         if not any("-t" in str(x) for x in args):
             # insert -t immediately after 1st arg, as per tmux format
-            new_args: t.Tuple[str, ...] = tuple()
+            new_args: t.Tuple[str, ...] = ()
             new_args += (args[0],)
             assert isinstance(self.session_id, str)
             new_args += (
@@ -163,7 +163,6 @@ def cmd(self, *args: t.Any, **kwargs: t.Any) -> tmux_cmd:
         return self.server.cmd(*args, **kwargs)
 
     #
-    # Commands (tmux-like)
     #
     def set_option(
         self, option: str, value: t.Union[str, int], _global: bool = False
@@ -197,7 +196,7 @@ def set_option(
         elif isinstance(value, bool) and not value:
             value = "off"
 
-        tmux_args: t.Tuple[t.Union[str, int], ...] = tuple()
+        tmux_args: t.Tuple[t.Union[str, int], ...] = ()
 
         if _global:
             tmux_args += ("-g",)
@@ -240,7 +239,7 @@ def show_options(
         Uses ``_global`` for keyword name instead of ``global`` to avoid
         colliding with reserved keyword.
         """
-        tmux_args: t.Tuple[str, ...] = tuple()
+        tmux_args: t.Tuple[str, ...] = ()
 
         if _global:
             tmux_args += ("-g",)
@@ -288,7 +287,7 @@ def show_option(
         Test and return True/False for on/off string.
         """
 
-        tmux_args: t.Tuple[str, ...] = tuple()
+        tmux_args: t.Tuple[str, ...] = ()
 
         if _global:
             tmux_args += ("-g",)
@@ -303,7 +302,7 @@ def show_option(
         if not len(cmd.stdout):
             return None
 
-        value_raw: t.List[str] = [item.split(" ") for item in cmd.stdout][0]
+        value_raw: t.List[str] = next(item.split(" ") for item in cmd.stdout)
 
         assert isinstance(value_raw[0], str)
         assert isinstance(value_raw[1], str)
@@ -362,7 +361,7 @@ def attached_window(self) -> "Window":
                 active_windows.append(window)
 
         if len(active_windows) == 1:
-            return list(active_windows)[0]
+            return next(iter(active_windows))
         elif len(active_windows) == 0:
             raise exc.LibTmuxException("no active windows found")
         else:
@@ -476,7 +475,7 @@ def new_window(
         -------
         :class:`Window`
         """
-        window_args: t.Tuple[str, ...] = tuple()
+        window_args: t.Tuple[str, ...] = ()
 
         if not attach:
             window_args += ("-d",)
@@ -494,8 +493,7 @@ def new_window(
 
         window_args += (
             # empty string for window_index will use the first one available
-            "-t%s:%s"
-            % (self.session_id, window_index),
+            f"-t{self.session_id}:{window_index}",
         )
 
         if environment: