ruff format (after adding flake8-commas)

tmux-python · tony · Feb 6, 2024 · Feb 6, 2024 · Feb 6, 2024 · Feb 6, 2024
commit 9a138dfe7d2f163b258e01c97a9107a17d44e224
diff --git a/src/libtmux/_internal/query_list.py b/src/libtmux/_internal/query_list.py
@@ -66,7 +66,9 @@ def keygetter(
 
 
 def parse_lookup(
-    obj: "Mapping[str, t.Any]", path: str, lookup: str,
+    obj: "Mapping[str, t.Any]",
+    path: str,
+    lookup: str,
 ) -> t.Optional[t.Any]:
     """Check if field lookup key, e.g. "my__path__contains" has comparator, return val.
 

diff --git a/src/libtmux/_vendor/version.py b/src/libtmux/_vendor/version.py
@@ -33,12 +33,18 @@
     ],
 ]
 CmpKey = Tuple[
-    int, Tuple[int, ...], PrePostDevType, PrePostDevType, PrePostDevType, LocalType,
+    int,
+    Tuple[int, ...],
+    PrePostDevType,
+    PrePostDevType,
+    PrePostDevType,
+    LocalType,
 ]
 VersionComparisonMethod = Callable[[CmpKey, CmpKey], bool]
 
 _Version = collections.namedtuple(
-    "_Version", ["epoch", "release", "dev", "pre", "post", "local"],
+    "_Version",
+    ["epoch", "release", "dev", "pre", "post", "local"],
 )
 
 
@@ -220,7 +226,8 @@ def __init__(self, version: str) -> None:
             release=tuple(int(i) for i in match.group("release").split(".")),
             pre=_parse_letter_version(match.group("pre_l"), match.group("pre_n")),
             post=_parse_letter_version(
-                match.group("post_l"), match.group("post_n1") or match.group("post_n2"),
+                match.group("post_l"),
+                match.group("post_n1") or match.group("post_n2"),
             ),
             dev=_parse_letter_version(match.group("dev_l"), match.group("dev_n")),
             local=_parse_local_version(match.group("local")),
@@ -468,7 +475,8 @@ def micro(self) -> int:
 
 
 def _parse_letter_version(
-    letter: str, number: Union[str, bytes, SupportsInt],
+    letter: str,
+    number: Union[str, bytes, SupportsInt],
 ) -> Optional[Tuple[str, int]]:
     if letter:
         # We consider there to be an implicit 0 in a pre-release if there is

diff --git a/src/libtmux/common.py b/src/libtmux/common.py
@@ -228,7 +228,9 @@ def __init__(self, *args: t.Any, **kwargs: t.Any) -> None:
 
         try:
             self.process = subprocess.Popen(
-                cmd, stdout=subprocess.PIPE, stderr=subprocess.PIPE,
+                cmd,
+                stdout=subprocess.PIPE,
+                stderr=subprocess.PIPE,
             )
             stdout, stderr = self.process.communicate()
             returncode = self.process.returncode
@@ -255,7 +257,8 @@ def __init__(self, *args: t.Any, **kwargs: t.Any) -> None:
 
         logger.debug(
             "self.stdout for {cmd}: {stdout}".format(
-                cmd=" ".join(cmd), stdout=self.stdout,
+                cmd=" ".join(cmd),
+                stdout=self.stdout,
             ),
         )
 
@@ -409,7 +412,8 @@ def has_minimum_version(raises: bool = True) -> bool:
             raise exc.VersionTooLow(
                 "libtmux only supports tmux {} and greater. This system"
                 " has {} installed. Upgrade your tmux to use libtmux.".format(
-                    TMUX_MIN_VERSION, get_version(),
+                    TMUX_MIN_VERSION,
+                    get_version(),
                 ),
             )
         else:

diff --git a/src/libtmux/exc.py b/src/libtmux/exc.py
@@ -51,7 +51,10 @@ class BadSessionName(LibTmuxException):
     """Disallowed session name for tmux (empty, contains periods or colons)."""
 
     def __init__(
-        self, reason: str, session_name: t.Optional[str] = None, *args: object,
+        self,
+        reason: str,
+        session_name: t.Optional[str] = None,
+        *args: object,
     ):
         msg = f"Bad session name: {reason}"
         if session_name is not None:

diff --git a/src/libtmux/neo.py b/src/libtmux/neo.py
@@ -170,7 +170,10 @@ def _refresh(
     ) -> None:
         assert isinstance(obj_id, str)
         obj = fetch_obj(
-            obj_key=obj_key, obj_id=obj_id, list_cmd=list_cmd, server=self.server,
+            obj_key=obj_key,
+            obj_id=obj_id,
+            list_cmd=list_cmd,
+            server=self.server,
         )
         assert obj is not None
         if obj is not None:
@@ -233,7 +236,9 @@ def fetch_obj(
 ) -> OutputRaw:
     """Fetch raw data from tmux command."""
     obj_formatters_filtered = fetch_objs(
-        server=server, list_cmd=list_cmd, list_extra_args=list_extra_args,
+        server=server,
+        list_cmd=list_cmd,
+        list_extra_args=list_extra_args,
     )
 
     obj = None

diff --git a/src/libtmux/pane.py b/src/libtmux/pane.py
@@ -245,7 +245,9 @@ def send_keys(
 
     @overload
     def display_message(
-        self, cmd: str, get_text: "t.Literal[True]",
+        self,
+        cmd: str,
+        get_text: "t.Literal[True]",
     ) -> t.Union[str, t.List[str]]:
         ...
 
@@ -254,7 +256,9 @@ def display_message(self, cmd: str, get_text: "t.Literal[False]") -> None:
         ...
 
     def display_message(
-        self, cmd: str, get_text: bool = False,
+        self,
+        cmd: str,
+        get_text: bool = False,
     ) -> t.Optional[t.Union[str, t.List[str]]]:
         """Display message to pane.
 

diff --git a/src/libtmux/pytest_plugin.py b/src/libtmux/pytest_plugin.py
@@ -185,7 +185,9 @@ def session_params() -> t.Dict[str, t.Any]:
 
 @pytest.fixture(scope="function")
 def session(
-    request: pytest.FixtureRequest, session_params: t.Dict[str, t.Any], server: Server,
+    request: pytest.FixtureRequest,
+    session_params: t.Dict[str, t.Any],
+    server: Server,
 ) -> "Session":
     """Return new, temporary :class:`libtmux.Session`.
 

diff --git a/src/libtmux/server.py b/src/libtmux/server.py
@@ -483,7 +483,8 @@ def new_session(
         )
 
         return Session.from_session_id(
-            server=self, session_id=session_formatters["session_id"],
+            server=self,
+            session_id=session_formatters["session_id"],
         )
 
     #

diff --git a/src/libtmux/session.py b/src/libtmux/session.py
@@ -77,7 +77,9 @@ def refresh(self) -> None:
         """Refresh session attributes from tmux."""
         assert isinstance(self.session_id, str)
         return super()._refresh(
-            obj_key="session_id", obj_id=self.session_id, list_cmd="list-sessions",
+            obj_key="session_id",
+            obj_id=self.session_id,
+            list_cmd="list-sessions",
         )
 
     @classmethod
@@ -169,7 +171,10 @@ def cmd(self, *args: t.Any, **kwargs: t.Any) -> tmux_cmd:
     """
 
     def set_option(
-        self, option: str, value: t.Union[str, int], _global: bool = False,
+        self,
+        option: str,
+        value: t.Union[str, int],
+        _global: bool = False,
     ) -> "Session":
         """Set option ``$ tmux set-option <option> <value>``.
 
@@ -220,7 +225,8 @@ def set_option(
         return self
 
     def show_options(
-        self, _global: t.Optional[bool] = False,
+        self,
+        _global: t.Optional[bool] = False,
     ) -> t.Dict[str, t.Union[str, int]]:
         """Return dict of options for the session.
 
@@ -258,7 +264,9 @@ def show_options(
         return session_options
 
     def show_option(
-        self, option: str, _global: bool = False,
+        self,
+        option: str,
+        _global: bool = False,
     ) -> t.Optional[t.Union[str, int, bool]]:
         """Return option value for the target session.
 
@@ -506,7 +514,8 @@ def new_window(
         )
 
         return Window.from_window_id(
-            server=self.server, window_id=window_formatters["window_id"],
+            server=self.server,
+            window_id=window_formatters["window_id"],
         )
 
     def kill_window(self, target_window: t.Optional[str] = None) -> None:
@@ -604,7 +613,8 @@ def __getitem__(self, key: str) -> t.Any:
 
         """
         warnings.warn(
-            f"Item lookups, e.g. session['{key}'] is deprecated", stacklevel=2,
+            f"Item lookups, e.g. session['{key}'] is deprecated",
+            stacklevel=2,
         )
         return getattr(self, key)
 

diff --git a/src/libtmux/test.py b/src/libtmux/test.py
@@ -28,7 +28,8 @@ class RandomStrSequence:
     """Factory to generate random string."""
 
     def __init__(
-        self, characters: str = "abcdefghijklmnopqrstuvwxyz0123456789_",
+        self,
+        characters: str = "abcdefghijklmnopqrstuvwxyz0123456789_",
     ) -> None:
         """Create a random letter / number generator. 8 chars in length.
 
@@ -141,7 +142,8 @@ def get_test_session_name(server: "Server", prefix: str = TEST_SESSION_PREFIX) -
 
 
 def get_test_window_name(
-    session: "Session", prefix: t.Optional[str] = TEST_SESSION_PREFIX,
+    session: "Session",
+    prefix: t.Optional[str] = TEST_SESSION_PREFIX,
 ) -> str:
     """
     Faker to create a window name that doesn't exist.
@@ -180,7 +182,9 @@ def get_test_window_name(
 
 @contextlib.contextmanager
 def temp_session(
-    server: Server, *args: t.Any, **kwargs: t.Any,
+    server: Server,
+    *args: t.Any,
+    **kwargs: t.Any,
 ) -> t.Generator["Session", t.Any, t.Any]:
     """
     Return a context manager with a temporary session.
@@ -230,7 +234,9 @@ def temp_session(
 
 @contextlib.contextmanager
 def temp_window(
-    session: "Session", *args: t.Any, **kwargs: t.Any,
+    session: "Session",
+    *args: t.Any,
+    **kwargs: t.Any,
 ) -> t.Generator["Window", t.Any, t.Any]:
     """
     Return a context manager with a temporary window.

diff --git a/src/libtmux/window.py b/src/libtmux/window.py
@@ -399,7 +399,9 @@ def show_window_options(self, g: t.Optional[bool] = False) -> "WindowOptionDict"
         return window_options
 
     def show_window_option(
-        self, option: str, g: bool = False,
+        self,
+        option: str,
+        g: bool = False,
     ) -> t.Optional[t.Union[str, int]]:
         """Return option value for the target window.
 
@@ -486,7 +488,9 @@ def kill_window(self) -> None:
             raise exc.LibTmuxException(proc.stderr)
 
     def move_window(
-        self, destination: str = "", session: t.Optional[str] = None,
+        self,
+        destination: str = "",
+        session: t.Optional[str] = None,
     ) -> "Window":
F438        """Move current :class:`Window` object ``$ tmux move-window``.
 

diff --git a/tests/legacy_api/test_common.py b/tests/legacy_api/test_common.py
@@ -215,7 +215,9 @@ class SessionCheckName(t.NamedTuple):
     ],
 )
 def test_session_check_name(
-    session_name: t.Optional[str], raises: bool, exc_msg_regex: t.Optional[str],
+    session_name: t.Optional[str],
+    raises: bool,
+    exc_msg_regex: t.Optional[str],
 ) -> None:
     """Verify session_check_name()."""
     if raises:

diff --git a/tests/legacy_api/test_pane.py b/tests/legacy_api/test_pane.py
@@ -83,7 +83,9 @@ def test_capture_pane(session: Session) -> None:
     pane_contents = "\n".join(pane.capture_pane())
     assert pane_contents == "$"
     pane.send_keys(
-        r'printf "\n%s\n" "Hello World !"', literal=True, suppress_history=False,
+        r'printf "\n%s\n" "Hello World !"',
+        literal=True,
+        suppress_history=False,
     )
     pane_contents = "\n".join(pane.capture_pane())
     assert pane_contents == r'$ printf "\n%s\n" "Hello World !"{}'.format(

diff --git a/tests/legacy_api/test_session.py b/tests/legacy_api/test_session.py
@@ -220,7 +220,10 @@ def test_unset_environment(session: Session) -> None:
     [("hey.period", True), ("hey:its a colon", True), ("hey moo", False)],
 )
 def test_periods_raise_badsessionname(
-    server: Server, session: Session, session_name: str, raises: bool,
+    server: Server,
+    session: Session,
+    session_name: str,
+    raises: bool,
 ) -> None:
     """Verify session names with periods raise BadSessionName."""
     new_name = session_name + "moo"  # used for rename / switch

diff --git a/tests/legacy_api/test_window.py b/tests/legacy_api/test_window.py
@@ -162,7 +162,9 @@ def test_split_window_horizontal(session: Session) -> None:
     [("test", "ha ha ha fjewlkjflwef"), ("test", "hello \\ wazzup 0")],
 )
 def test_window_rename(
-    session: Session, window_name_before: str, window_name_after: str,
+    session: Session,
+    window_name_before: str,
+    window_name_after: str,
 ) -> None:
     """Test Window.rename_window()."""
     window_name_before = "test"
@@ -308,7 +310,8 @@ def test_select_layout_accepts_no_arg(server: Server, session: Session) -> None:
 
 
 @pytest.mark.skipif(
-    has_lt_version("3.2"), reason="needs filter introduced in tmux >= 3.2",
+    has_lt_version("3.2"),
+    reason="needs filter introduced in tmux >= 3.2",
 )
 def test_empty_window_name(session: Session) -> None:
     """New windows can be created with empty string for window name."""

diff --git a/tests/test_common.py b/tests/test_common.py
@@ -215,7 +215,9 @@ class SessionCheckName(t.NamedTuple):
     ],
 )
 def test_session_check_name(
-    session_name: t.Optional[str], raises: bool, exc_msg_regex: t.Optional[str],
+    session_name: t.Optional[str],
+    raises: bool,
+    exc_msg_regex: t.Optional[str],
 ) -> None:
     """Verify session_check_name()."""
     if raises:

diff --git a/tests/test_pane.py b/tests/test_pane.py
@@ -87,7 +87,9 @@ def test_capture_pane(session: Session) -> None:
     pane_contents = "\n".join(pane.capture_pane())
     assert pane_contents == "$"
     pane.send_keys(
-        r'printf "\n%s\n" "Hello World !"', literal=True, suppress_history=False,
+        r'printf "\n%s\n" "Hello World !"',
+        literal=True,
+        suppress_history=False,
     )
     pane_contents = "\n".join(pane.capture_pane())
     assert pane_contents == r'$ printf "\n%s\n" "Hello World !"{}'.format(

diff --git a/tests/test_session.py b/tests/test_session.py
@@ -231,7 +231,10 @@ class PeriodRaisesBadSessionName(t.NamedTuple):
     ],
 )
 def test_periods_raise_bad_session_name(
-    server: Server, session: Session, session_name: str, raises: bool,
+    server: Server,
+    session: Session,
+    session_name: str,
+    raises: bool,
 ) -> None:
     """Verify session names with periods raise BadSessionName."""
     new_name = session_name + "moo"  # used for rename / switch