ruff(pydocstyle): Run automated fixes

tony · tony · commit 82da0961fa5e · 2023-12-21T11:24:45.000-06:00
`ruff --show-fixes --fix-only .`

Fixed 45 errors:
- docs/_ext/aafig.py:
    7 × D208 (over-indentation)
    1 × D202 (no-blank-line-after-function)
- src/tmuxp/cli/__init__.py:
    2 × D202 (no-blank-line-after-function)
    1 × D209 (new-line-after-last-paragraph)
- src/tmuxp/cli/freeze.py:
    1 × D209 (new-line-after-last-paragraph)
- src/tmuxp/cli/import_config.py:
    2 × D209 (new-line-after-last-paragraph)
- src/tmuxp/cli/load.py:
    2 × D412 (blank-lines-between-header-and-content)
    1 × D406 (new-line-after-section-name)
    1 × D407 (dashed-underline-after-section)
- src/tmuxp/cli/utils.py:
    3 × D202 (no-blank-line-after-function)
- src/tmuxp/exc.py:
    5 × D211 (blank-line-before-class)
- src/tmuxp/log.py:
    1 × D202 (no-blank-line-after-function)
- src/tmuxp/types.py:
    1 × D412 (blank-lines-between-header-and-content)
- src/tmuxp/workspace/builder.py:
    2 × D202 (no-blank-line-after-function)
    1 × D412 (blank-lines-between-header-and-content)
- src/tmuxp/workspace/finders.py:
    1 × D202 (no-blank-line-after-function)
- src/tmuxp/workspace/freezer.py:
    1 × D202 (no-blank-line-after-function)
- src/tmuxp/workspace/importers.py:
    2 × D202 (no-blank-line-after-function)
    1 × D412 (blank-lines-between-header-and-content)
- src/tmuxp/workspace/loader.py:
    2 × D202 (no-blank-line-after-function)
- tests/cli/test_cli.py:
    1 × D202 (no-blank-line-after-function)
- tests/tests/test_helpers.py:
    1 × D202 (no-blank-line-after-function)
- tests/workspace/test_finder.py:
    3 × D202 (no-blank-line-after-function)
- tests/workspace/test_freezer.py:
    1 × D202 (no-blank-line-after-function)
- tests/workspace/test_import_teamocil.py:
    1 × D209 (new-line-after-last-paragraph)

Fixed 45 errors (35 additional fixes available with `--unsafe-fixes`).
diff --git a/docs/_ext/aafig.py b/docs/_ext/aafig.py
@@ -1,14 +1,14 @@
 """
-    sphinxcontrib.aafig
-    ~~~~~~~~~~~~~~~~~~~
+sphinxcontrib.aafig
+~~~~~~~~~~~~~~~~~~~
 
-    Allow embedded ASCII art to be rendered as nice looking images
-    using the aafigure reStructuredText extension.
+Allow embedded ASCII art to be rendered as nice looking images
+using the aafigure reStructuredText extension.
 
-    See the README file for details.
+See the README file for details.
 
-    :author: Leandro Lucarella <llucax@gmail.com>
-    :license: BOLA, see LICENSE for details
+:author: Leandro Lucarella <llucax@gmail.com>
+:license: BOLA, see LICENSE for details
 """
 import logging
 import posixpath
@@ -158,7 +158,6 @@ def render_aafigure(
     """
     Render an ASCII art figure into the requested format output file.
     """
-
     if aafigure is None:
         raise AafigureNotInstalled()
 
diff --git a/src/tmuxp/cli/__init__.py b/src/tmuxp/cli/__init__.py
@@ -111,8 +111,8 @@ def cli(_args: t.Optional[t.List[str]] = None) -> None:
 
     Pass the "--help" argument to any command to see detailed help.
     See detailed documentation and examples at:
-    http://tmuxp.git-pull.com/"""
-
+    http://tmuxp.git-pull.com/
+    """
     try:
         has_minimum_version()
     except TmuxCommandNotFound:
@@ -186,6 +186,5 @@ def startup(config_dir: pathlib.Path) -> None:
     ----------
     str : get_workspace_dir(): Config directory to search
     """
-
     if not os.path.exists(config_dir):
         os.makedirs(config_dir)
diff --git a/src/tmuxp/cli/freeze.py b/src/tmuxp/cli/freeze.py
@@ -90,7 +90,8 @@ def command_freeze(
     """Snapshot a tmux session into a tmuxp workspace.
 
     If SESSION_NAME is provided, snapshot that session. Otherwise, use the
-    current session."""
+    current session.
+    """
     server = Server(socket_name=args.socket_name, socket_path=args.socket_path)
 
     try:
diff --git a/src/tmuxp/cli/import_config.py b/src/tmuxp/cli/import_config.py
@@ -176,7 +176,8 @@ def command_import_tmuxinator(
     parser: t.Optional[argparse.ArgumentParser] = None,
 ) -> None:
     """Convert a tmuxinator config from workspace_file to tmuxp format and import
-    it into tmuxp."""
+    it into tmuxp.
+    """
     workspace_file = find_workspace_file(
         workspace_file, workspace_dir=get_tmuxinator_dir()
     )
@@ -188,7 +189,8 @@ def command_import_teamocil(
     parser: t.Optional[argparse.ArgumentParser] = None,
 ) -> None:
     """Convert a teamocil config from workspace_file to tmuxp format and import
-    it into tmuxp."""
+    it into tmuxp.
+    """
     workspace_file = find_workspace_file(
         workspace_file, workspace_dir=get_teamocil_dir()
     )
diff --git a/src/tmuxp/cli/load.py b/src/tmuxp/cli/load.py
@@ -50,8 +50,8 @@ class CLILoadNamespace(argparse.Namespace):
 def set_layout_hook(session: Session, hook_name: str) -> None:
     """Set layout hooks to normalize layout.
 
-    References:
-
+    References
+    ----------
         - tmuxp issue: https://github.com/tmux-python/tmuxp/issues/309
         - tmux issue: https://github.com/tmux/tmux/issues/1106
 
@@ -305,7 +305,6 @@ def load_workspace(
 
     Notes
     -----
-
     tmuxp will check and load a workspace file. The file will use ConfigReader
     to load a JSON/YAML into a :py:obj:`dict`. Then :func:`loader.expand` and
     :func:`loader.trickle` will be used to expand any shorthands, template
diff --git a/src/tmuxp/cli/utils.py b/src/tmuxp/cli/utils.py
@@ -47,7 +47,6 @@ def prompt(
     :param default: default value if no input provided.
     :rtype: string
     """
-
     _prompt = name + (default and " [%s]" % default or "")
     _prompt += name.endswith("?") and " " or ": "
     while True:
@@ -78,7 +77,6 @@ def prompt_bool(
     :param no_choices: default 'n', 'no', '0', 'off', 'false', 'f'
     :rtype: bool
     """
-
     yes_choices = yes_choices or ("y", "yes", "1", "on", "true", "t")
     no_choices = no_choices or ("n", "no", "0", "off", "false", "f")
 
@@ -121,7 +119,6 @@ def prompt_choices(
     :param no_choice: acceptable list of strings for "null choice"
     :rtype: str
     """
-
     _choices: t.List[str] = []
     options: t.List[str] = []
 
diff --git a/src/tmuxp/exc.py b/src/tmuxp/exc.py
@@ -12,12 +12,10 @@
 
 
 class TmuxpException(Exception):
-
     """Base Exception for Tmuxp Errors."""
 
 
 class WorkspaceError(TmuxpException):
-
     """Error parsing tmuxp workspace data."""
 
 
@@ -52,7 +50,6 @@ def __init__(
 
 
 class EmptyWorkspaceException(WorkspaceError):
-
     """Workspace file is empty."""
 
     def __init__(self, *args: object, **kwargs: object) -> None:
@@ -75,7 +72,6 @@ def __init__(self, *args: object, **kwargs: object) -> None:
 
 
 class TmuxpPluginException(TmuxpException):
-
     """Base Exception for Tmuxp Errors."""
 
 
@@ -88,7 +84,6 @@ def __init__(self, *args: object, **kwargs: object) -> None:
 
 @implements_to_string
 class BeforeLoadScriptError(Exception):
-
     """Exception replacing :py:class:`subprocess.CalledProcessError` for
     :meth:`tmuxp.util.run_before_script`.
     """
diff --git a/src/tmuxp/log.py b/src/tmuxp/log.py
@@ -155,7 +155,6 @@ def debug_log_template(
     str
         Log template.
     """
-
     reset = Style.RESET_ALL
     levelname = (
         LEVEL_COLORS.get(record.levelname, "")
diff --git a/src/tmuxp/types.py b/src/tmuxp/types.py
@@ -2,7 +2,6 @@
 
 Notes
 -----
-
 :class:`StrPath` and :class:`StrOrBytesPath` is based on `typeshed's`_.
 
 .. _typeshed's: https://github.com/python/typeshed/blob/9687d5/stdlib/_typeshed/__init__.pyi#L98
diff --git a/src/tmuxp/workspace/builder.py b/src/tmuxp/workspace/builder.py
@@ -33,7 +33,6 @@ class WorkspaceBuilder:
 
     Examples
     --------
-
     >>> import yaml
 
     >>> session_config = yaml.load('''
@@ -161,7 +160,6 @@ def __init__(
         TODO: Initialize :class:`libtmux.Session` from here, in
         ``self.session``.
         """
-
         if plugins is None:
             plugins = []
         if not session_config:
@@ -222,7 +220,6 @@ def build(self, session: t.Optional[Session] = None, append: bool = False) -> No
         append : bool
             append windows in current active session
         """
-
         if not session:
             if not self.server:
                 raise exc.TmuxpException(
diff --git a/src/tmuxp/workspace/finders.py b/src/tmuxp/workspace/finders.py
@@ -113,7 +113,6 @@ def get_workspace_dir() -> str:
     str :
         absolute path to tmuxp config directory
     """
-
     paths = []
     if "TMUXP_CONFIGDIR" in os.environ:
         paths.append(os.environ["TMUXP_CONFIGDIR"])
diff --git a/src/tmuxp/workspace/freezer.py b/src/tmuxp/workspace/freezer.py
@@ -19,7 +19,6 @@ def inline(workspace_dict: t.Dict[str, t.Any]) -> t.Any:
     dict
         workspace with shorthands inlined.
     """
-
     if (
         "shell_command" in workspace_dict
         and isinstance(workspace_dict["shell_command"], list)
diff --git a/src/tmuxp/workspace/importers.py b/src/tmuxp/workspace/importers.py
@@ -15,7 +15,6 @@ def import_tmuxinator(workspace_dict: t.Dict[str, t.Any]) -> t.Dict[str, t.Any]:
     -------
     dict
     """
-
     tmuxp_workspace = {}
 
     if "project_name" in workspace_dict:
@@ -111,7 +110,6 @@ def import_teamocil(workspace_dict: t.Dict[str, t.Any]) -> t.Dict[str, t.Any]:
 
     Notes
     -----
-
     Todos:
 
     - change  'root' to a cd or start_directory
@@ -120,7 +118,6 @@ def import_teamocil(workspace_dict: t.Dict[str, t.Any]) -> t.Dict[str, t.Any]:
     - clear
     - cmd_separator
     """
-
     tmuxp_workspace = {}
 
     if "session" in workspace_dict:
diff --git a/src/tmuxp/workspace/loader.py b/src/tmuxp/workspace/loader.py
@@ -102,7 +102,6 @@ def expand(
     -------
     dict
     """
-
     # Note: cli.py will expand workspaces relative to project's workspace directory
     # for the first cwd argument.
     cwd = pathlib.Path().cwd() if not cwd else pathlib.Path(cwd)
@@ -208,7 +207,6 @@ def trickle(workspace_dict: t.Dict[str, t.Any]) -> t.Dict[str, t.Any]:
     -------
     dict
     """
-
     # prepends a pane's ``shell_command`` list with the window and sessions'
     # ``shell_command_before``.
 
diff --git a/tests/cli/test_cli.py b/tests/cli/test_cli.py
@@ -24,7 +24,6 @@
 
 def test_creates_config_dir_not_exists(tmp_path: pathlib.Path) -> None:
     """cli.startup() creates config dir if not exists."""
-
     cli.startup(tmp_path)
     assert tmp_path.exists()
 
diff --git a/tests/tests/test_helpers.py b/tests/tests/test_helpers.py
@@ -18,7 +18,6 @@ def test_kills_session(server: Server) -> None:
 @pytest.mark.flaky(reruns=5)
 def test_if_session_killed_before(server: Server) -> None:
     """Handles situation where session already closed within context"""
-
     server = server
     session_name = get_test_session_name(server=server)
 
diff --git a/tests/workspace/test_finder.py b/tests/workspace/test_finder.py
@@ -20,7 +20,6 @@
 
 def test_in_dir_from_config_dir(tmp_path: pathlib.Path) -> None:
     """config.in_dir() finds configs config dir."""
-
     cli.startup(tmp_path)
     yaml_config = tmp_path / "myconfig.yaml"
     yaml_config.touch()
@@ -33,7 +32,6 @@ def test_in_dir_from_config_dir(tmp_path: pathlib.Path) -> None:
 
 def test_ignore_non_configs_from_current_dir(tmp_path: pathlib.Path) -> None:
     """cli.in_dir() ignore non-config from config dir."""
-
     cli.startup(tmp_path)
 
     junk_config = tmp_path / "myconfig.psd"
@@ -48,7 +46,6 @@ def test_get_configs_cwd(
     tmp_path: pathlib.Path, monkeypatch: pytest.MonkeyPatch
 ) -> None:
     """config.in_cwd() find config in shell current working directory."""
-
     confdir = tmp_path / "tmuxpconf2"
     confdir.mkdir()
 
diff --git a/tests/workspace/test_freezer.py b/tests/workspace/test_freezer.py
@@ -80,7 +80,6 @@ def test_freeze_config(session: Session) -> None:
 
 def test_inline_workspace() -> None:
     """:meth:`freezer.inline()` shell commands list to string."""
-
     test_workspace = freezer.inline(ibefore_workspace)
     assert test_workspace == iafter_workspace
 
diff --git a/tests/workspace/test_import_teamocil.py b/tests/workspace/test_import_teamocil.py
@@ -59,7 +59,8 @@ def multisession_config() -> (
     """Return loaded multisession teamocil config as a dictionary.
 
     Also prevents re-running assertion the loads the yaml, since ordering of
-    deep list items like panes will be inconsistent."""
+    deep list items like panes will be inconsistent.
+    """
     teamocil_yaml_file = fixtures.layouts.teamocil_yaml_file
     test_config = config_reader.ConfigReader._from_file(teamocil_yaml_file)
     teamocil_dict: t.Dict[str, t.Any] = fixtures.layouts.teamocil_dict
