ruff(pydocstyle): Run automated fixes

tony · tony · commit f32527d459e3 · 2023-11-25T13:17:13.000-06:00
`ruff --show-fixes --fix-only .`

Fixed 72 errors:
- src/libtmux/_internal/dataclasses.py:
     2 × D412 (blank-lines-between-header-and-content)
- src/libtmux/_vendor/version.py:
     1 × D202 (no-blank-line-after-function)
- src/libtmux/common.py:
     3 × D412 (blank-lines-between-header-and-content)
     2 × D211 (blank-line-before-class)
- src/libtmux/exc.py:
    16 × D211 (blank-line-before-class)
- src/libtmux/pane.py:
     2 × D412 (blank-lines-between-header-and-content)
     1 × D202 (no-blank-line-after-function)
- src/libtmux/server.py:
     1 × D202 (no-blank-line-after-function)
- src/libtmux/session.py:
     5 × D202 (no-blank-line-after-function)
- src/libtmux/test.py:
     1 × D202 (no-blank-line-after-function)
- src/libtmux/window.py:
     3 × D202 (no-blank-line-after-function)
     2 × D412 (blank-lines-between-header-and-content)
- tests/legacy_api/test_pane.py:
     1 × D202 (no-blank-line-after-function)
- tests/legacy_api/test_server.py:
     1 × D209 (new-line-after-last-paragraph)
- tests/legacy_api/test_session.py:
     5 × D202 (no-blank-line-after-function)
- tests/legacy_api/test_tmuxobject.py:
     4 × D202 (no-blank-line-after-function)
- tests/legacy_api/test_window.py:
     4 × D202 (no-blank-line-after-function)
     1 × D403 (first-line-capitalized)
- tests/test_pane.py:
     1 × D202 (no-blank-line-after-function)
- tests/test_server.py:
     2 × D209 (new-line-after-last-paragraph)
- tests/test_session.py:
     5 × D202 (no-blank-line-after-function)
- tests/test_tmuxobject.py:
     4 × D202 (no-blank-line-after-function)
- tests/test_window.py:
     4 × D202 (no-blank-line-after-function)
     1 × D403 (first-line-capitalized)

Fixed 72 errors (77 additional fixes available with `--unsafe-fixes`).
diff --git a/src/libtmux/_internal/dataclasses.py b/src/libtmux/_internal/dataclasses.py
@@ -18,14 +18,12 @@ class SkipDefaultFieldsReprMixin:
 
     Notes
     -----
-
     Credit: Pietro Oldrati, 2022-05-08, Unilicense
 
     https://stackoverflow.com/a/72161437/1396928
 
     Examples
     --------
-
     >>> @dataclasses.dataclass()
     ... class Item:
     ...     name: str
diff --git a/src/libtmux/_vendor/version.py b/src/libtmux/_vendor/version.py
@@ -194,7 +194,6 @@ def __init__(self, version: str) -> None:
             If the ``version`` does not conform to PEP 440 in any way then this
             exception will be raised.
         """
-
         # Validate the version and parse it into pieces
         match = self._regex.search(version)
         if not match:
diff --git a/src/libtmux/common.py b/src/libtmux/common.py
@@ -36,7 +36,6 @@
 
 
 class EnvironmentMixin:
-
     """
     Mixin class for managing session and server level environment variables in
     tmux.
@@ -194,13 +193,11 @@ def getenv(self, name: str) -> Optional[t.Union[str, bool]]:
 
 
 class tmux_cmd:
-
     """
     :term:`tmux(1)` command via :py:mod:`subprocess`.
 
     Examples
     --------
-
     .. code-block:: python
 
         proc = tmux_cmd('new-session', '-s%' % 'my session')
@@ -220,7 +217,6 @@ class tmux_cmd:
 
     Notes
     -----
-
     .. versionchanged:: 0.8
         Renamed from ``tmux`` to ``tmux_cmd``.
     """
@@ -413,7 +409,6 @@ def has_minimum_version(raises: bool = True) -> bool:
 
     Notes
     -----
-
     .. versionchanged:: 0.7.0
         No longer returns version, returns True or False
 
diff --git a/src/libtmux/exc.py b/src/libtmux/exc.py
@@ -13,17 +13,14 @@
 
 
 class LibTmuxException(Exception):
-
     """Base Exception for libtmux Errors."""
 
 
 class TmuxSessionExists(LibTmuxException):
-
     """Session does not exist in the server."""
 
 
 class TmuxCommandNotFound(LibTmuxException):
-
     """Application binary for tmux not found."""
 
 
@@ -47,12 +44,10 @@ def __init__(
 
 
 class VersionTooLow(LibTmuxException):
-
     """Raised if tmux below the minimum version to use libtmux."""
 
 
 class BadSessionName(LibTmuxException):
-
     """Disallowed session name for tmux (empty, contains periods or colons)."""
 
     def __init__(
@@ -65,40 +60,33 @@ def __init__(
 
 
 class OptionError(LibTmuxException):
-
     """Root error for any error involving invalid, ambiguous or bad options."""
 
 
 class UnknownOption(OptionError):
-
     """Option unknown to tmux show-option(s) or show-window-option(s)."""
 
 
 class UnknownColorOption(UnknownOption):
-
     """Unknown color option."""
 
     def __init__(self, *args: object):
         return super().__init__("Server.colors must equal 88 or 256")
 
 
 class InvalidOption(OptionError):
-
     """Option invalid to tmux, introduced in tmux v2.4."""
 
 
 class AmbiguousOption(OptionError):
-
     """Option that could potentially match more than one."""
 
 
 class WaitTimeout(LibTmuxException):
-
     """Function timed out without meeting condition"""
 
 
 class VariableUnpackingError(LibTmuxException):
-
     """Error unpacking variable"""
 
     def __init__(self, variable: t.Optional[t.Any] = None, *args: object):
@@ -119,28 +107,24 @@ def __init__(self, pane_id: t.Optional[str] = None, *args: object):
 
 
 class WindowError(LibTmuxException):
-
     """Any type of window related error"""
 
 
 class MultipleActiveWindows(WindowError):
-
     """Multiple active windows"""
 
     def __init__(self, count: int, *args: object):
         return super().__init__(f"Multiple active windows: {count} found")
 
 
 class NoActiveWindow(WindowError):
-
     """No active window found"""
 
     def __init__(self, *args: object):
         return super().__init__("No active windows found")
 
 
 class NoWindowsExist(WindowError):
-
     """No windows exist for object"""
 
     def __init__(self, *args: object):
diff --git a/src/libtmux/pane.py b/src/libtmux/pane.py
@@ -53,13 +53,11 @@ class Pane(Obj):
 
     Notes
     -----
-
     .. versionchanged:: 0.8
         Renamed from ``.tmux`` to ``.cmd``.
 
     References
     ----------
-
     .. [pane_manual] tmux pane. openbsd manpage for TMUX(1).
            "Each window displayed by tmux may be split into one or more
            panes; each pane takes up a certain area of the display and is
@@ -370,7 +368,6 @@ def clear(self) -> "Pane":
 
     def reset(self) -> "Pane":
         """Reset and clear pane history."""
-
         self.cmd("send-keys", r"-R \; clear-history")
         return self
 
diff --git a/src/libtmux/server.py b/src/libtmux/server.py
@@ -193,7 +193,6 @@ def cmd(self, *args: t.Any, **kwargs: t.Any) -> tmux_cmd:
 
             Renamed from ``.tmux`` to ``.cmd``.
         """
-
         cmd_args: t.List[t.Union[str, int]] = list(args)
         if self.socket_name:
             cmd_args.insert(0, f"-L{self.socket_name}")
diff --git a/src/libtmux/session.py b/src/libtmux/session.py
@@ -290,7 +290,6 @@ def show_option(
 
         Test and return True/False for on/off string.
         """
-
         tmux_args: t.Tuple[str, ...] = ()
 
         if _global:
@@ -337,7 +336,6 @@ def select_window(self, target_window: t.Union[str, int]) -> "Window":
 
             assure ``-l``, ``-n``, ``-p`` work.
         """
-
         # Note that we also provide the session ID here, since cmd()
         # will not automatically add it as there is already a '-t'
         # argument provided.
@@ -383,7 +381,6 @@ def attach_session(self) -> "Session":
 
     def kill_session(self) -> None:
         """``$ tmux kill-session``."""
-
         proc = self.cmd("kill-session", "-t%s" % self.session_id)
 
         if proc.stderr:
@@ -534,7 +531,6 @@ def kill_window(self, target_window: t.Optional[str] = None) -> None:
         target_window : str, optional
             window to kill
         """
-
         if target_window:
             if isinstance(target_window, int):
                 target = "-t%s:%d" % (self.window_name, target_window)
@@ -552,7 +548,6 @@ def kill_window(self, target_window: t.Optional[str] = None) -> None:
     @property
     def attached_pane(self) -> t.Optional["Pane"]:
         """Return active :class:`Pane` object."""
-
         return self.attached_window.attached_pane
 
     #
diff --git a/src/libtmux/test.py b/src/libtmux/test.py
@@ -209,7 +209,6 @@ def temp_session(
     ...     session.new_window(window_name='my window')
     Window(@3 2:my window, Session($... ...))
     """
-
     if "session_name" in kwargs:
         session_name = kwargs.pop("session_name")
     else:
diff --git a/src/libtmux/window.py b/src/libtmux/window.py
@@ -159,7 +159,6 @@ def select_pane(self, target_pane: t.Union[str, int]) -> t.Optional["Pane"]:
         ------
         :class:`Pane`
         """
-
         if target_pane in ["-l", "-U", "-D", "-L", "-R"]:
             proc = self.cmd("select-pane", "-t%s" % self.window_id, target_pane)
         else:
@@ -210,7 +209,6 @@ def split_window(
 
         Notes
         -----
-
         :term:`tmux(1)` will move window to the new pane if the
         ``split-window`` target is off screen. tmux handles the ``-d`` the
         same way as ``new-window`` and ``attach`` in
@@ -454,7 +452,6 @@ def rename_window(self, new_name: str) -> "Window":
 
         Examples
         --------
-
         >>> window = session.attached_window
 
         >>> window.rename_window('My project')
@@ -463,7 +460,6 @@ def rename_window(self, new_name: str) -> "Window":
         >>> window.rename_window('New name')
         Window(@1 1:New name, Session($1 ...))
         """
-
         import shlex
 
         lex = shlex.shlex(new_name)
@@ -482,7 +478,6 @@ def rename_window(self, new_name: str) -> "Window":
 
     def kill_window(self) -> None:
         """Kill the current :class:`Window` object. ``$ tmux kill-window``."""
-
         proc = self.cmd(
             "kill-window",
             f"-t{self.session_id}:{self.window_index}",
diff --git a/tests/legacy_api/test_pane.py b/tests/legacy_api/test_pane.py
@@ -9,7 +9,6 @@
 
 def test_resize_pane(session: Session) -> None:
     """Test Pane.resize_pane()."""
-
     window = session.attached_window
     window.rename_window("test_resize_pane")
 
diff --git a/tests/legacy_api/test_server.py b/tests/legacy_api/test_server.py
@@ -111,7 +111,8 @@ def test_new_session_no_name(server: Server) -> None:
 
 def test_new_session_shell(server: Server) -> None:
     """Server.new_session creates and returns valid session running with
-    specified command"""
+    specified command
+    """
     cmd = "sleep 1m"
     mysession = server.new_session("test_new_session", window_command=cmd)
     window = mysession.list_windows()[0]
diff --git a/tests/legacy_api/test_session.py b/tests/legacy_api/test_session.py
@@ -66,7 +66,6 @@ def test_select_window(session: Session) -> None:
 
 def test_select_window_returns_Window(session: Session) -> None:
     """Session.select_window returns Window object."""
-
     window_count = len(session._windows)
     assert len(session._windows) == window_count
 
@@ -115,14 +114,12 @@ def test_new_session(server: Server) -> None:
 
 def test_show_options(session: Session) -> None:
     """Session.show_options() returns dict."""
-
     options = session.show_options()
     assert isinstance(options, dict)
 
 
 def test_set_show_options_single(session: Session) -> None:
     """Set option then Session.show_options(key)."""
-
     session.set_option("history-limit", 20)
     assert session.show_option("history-limit") == 20
 
@@ -179,14 +176,12 @@ def test_set_option_invalid(session: Session) -> None:
 
 def test_show_environment(session: Session) -> None:
     """Session.show_environment() returns dict."""
-
     _vars = session.show_environment()
     assert isinstance(_vars, dict)
 
 
 def test_set_show_environment_single(session: Session) -> None:
     """Set environment then Session.show_environment(key)."""
-
     session.set_environment("FOO", "BAR")
     assert session.getenv("FOO") == "BAR"
 
diff --git a/tests/legacy_api/test_tmuxobject.py b/tests/legacy_api/test_tmuxobject.py
@@ -42,7 +42,6 @@ def test_find_where(server: Server, session: Session) -> None:
 
 def test_find_where_None(server: Server, session: Session) -> None:
     """.find_where returns None if no results found."""
-
     while True:
         nonexistent_session = TEST_SESSION_PREFIX + next(namer)
 
@@ -54,7 +53,6 @@ def test_find_where_None(server: Server, session: Session) -> None:
 
 def test_find_where_multiple_infos(server: Server, session: Session) -> None:
     """.find_where returns objects with multiple attributes."""
-
     for session in server.sessions:
         session_id = session.get("session_id")
         assert session_id is not None
@@ -99,7 +97,6 @@ def test_find_where_multiple_infos(server: Server, session: Session) -> None:
 
 def test_where(server: Server, session: Session) -> None:
     """Test self.where() returns matching objects."""
-
     window = session.attached_window
     window.split_window()  # create second pane
 
@@ -153,7 +150,6 @@ def test_where(server: Server, session: Session) -> None:
 
 def test_get_by_id(server: Server, session: Session) -> None:
     """Test self.get_by_id() retrieves child object."""
-
     window = session.attached_window
 
     window.split_window()  # create second pane
diff --git a/tests/legacy_api/test_window.py b/tests/legacy_api/test_window.py
diff --git a/tests/test_pane.py b/tests/test_pane.py
diff --git a/tests/test_server.py b/tests/test_server.py
diff --git a/tests/test_session.py b/tests/test_session.py
diff --git a/tests/test_tmuxobject.py b/tests/test_tmuxobject.py
diff --git a/tests/test_window.py b/tests/test_window.py
