Ruff rules: Stricter code quality rules (#879)

The boosts linting stringency and includes sorting of imports.

Docs:
- https://beta.ruff.rs/docs/rules/
- https://beta.ruff.rs/docs/settings/

See also: tmux-python/libtmux#488

Author: tony

CHANGES

@@ -19,6 +19,14 @@ $ pipx install --suffix=@next 'tmuxp' --pip-args '\--pre' --force
 
 <!-- Maintainers, insert changes / features for the next release here -->
 
+### Development
+
+- Code quality improved via [ruff] rules (#879)
+
+  This includes fixes made by hand alongside ruff's automated fixes. The more
+  stringent rules include import sorting, and still runs almost instantly
+  against the whole codebase.
+
 ## tmuxp 1.29.1 (2023-09-02)
 
 ### Development

conftest.py

@@ -10,10 +10,9 @@
 import typing as t
 
 import pytest
-
 from _pytest.doctest import DoctestItem
-
 from libtmux.test import namer
+
 from tests.fixtures import utils as test_utils
 from tmuxp.workspace.finders import get_workspace_dir
 
@@ -24,7 +23,7 @@
 USING_ZSH = "zsh" in os.getenv("SHELL", "")
 
 
-@pytest.mark.skipif(USING_ZSH, reason="Using ZSH")
+@pytest.mark.skipif(not USING_ZSH, reason="Using ZSH")
 @pytest.fixture(autouse=USING_ZSH, scope="session")
 def zshrc(user_path: pathlib.Path) -> pathlib.Path:
     """This quiets ZSH default message.
@@ -70,7 +69,7 @@ def monkeypatch_plugin_test_packages(monkeypatch: pytest.MonkeyPatch) -> None:
         "tests/fixtures/pluginsystem/plugins/tmuxp_test_plugin_fail/",
     ]
     for path in paths:
-        monkeypatch.syspath_prepend(os.path.abspath(os.path.relpath(path)))
+        monkeypatch.syspath_prepend(str(pathlib.Path(path).resolve()))
 
 
 @pytest.fixture(scope="function")

docs/_ext/aafig.py

@@ -12,6 +12,7 @@
 """
 import logging
 import posixpath
+import typing as t
 from hashlib import sha1 as sha
 from os import path
 
@@ -28,11 +29,11 @@
 
 logger = logging.getLogger(__name__)
 
-DEFAULT_FORMATS = dict(html="svg", latex="pdf", text=None)
+DEFAULT_FORMATS = {"html": "svg", "latex": "pdf", "text": None}
 
 
 def merge_dict(dst, src):
-    for (k, v) in src.items():
+    for k, v in src.items():
         if k not in dst:
             dst[k] = v
     return dst
@@ -58,22 +59,22 @@ class AafigDirective(images.Image):
 
     has_content = True
     required_arguments = 0
-    own_option_spec = dict(
-        line_width=float,
-        background=str,
-        foreground=str,
-        fill=str,
-        aspect=nonnegative_int,
-        textual=flag,
-        proportional=flag,
-    )
+    own_option_spec: t.ClassVar = {
+        "line_width": float,
+        "background": str,
+        "foreground": str,
+        "fill": str,
+        "aspect": nonnegative_int,
+        "textual": flag,
+        "proportional": flag,
+    }
     option_spec = images.Image.option_spec.copy()
     option_spec.update(own_option_spec)
 
     def run(self):
-        aafig_options = dict()
-        own_options_keys = [self.own_option_spec.keys()] + ["scale"]
-        for (k, v) in self.options.items():
+        aafig_options = {}
+        own_options_keys = [self.own_option_spec.keys(), "scale"]
+        for k, v in self.options.items():
             if k in own_options_keys:
                 # convert flags to booleans
                 if v is None:
@@ -88,7 +89,7 @@ def run(self):
         if isinstance(image_node, nodes.system_message):
             return [image_node]
         text = "\n".join(self.content)
-        image_node.aafig = dict(options=aafig_options, text=text)
+        image_node.aafig = {"options": aafig_options, "text": text}
         return [image_node]
 
 
@@ -138,13 +139,18 @@ def render_aafig_images(app, doctree):
                 img["height"] = height
 
 
+class AafigureNotInstalled(AafigError):
+    def __init__(self, *args: object, **kwargs: object) -> None:
+        return super().__init__("aafigure module not installed", *args, **kwargs)
+
+
 def render_aafigure(app, text, options):
     """
     Render an ASCII art figure into the requested format output file.
     """
 
     if aafigure is None:
-        raise AafigError("aafigure module not installed")
+        raise AafigureNotInstalled()
 
     fname = get_basename(text, options)
     fname = "{}.{}".format(get_basename(text, options), options["format"])
@@ -173,10 +179,10 @@ def render_aafigure(app, text, options):
                 f = None
                 try:
                     try:
-                        f = open(metadata_fname)
-                        extra = f.read()
-                    except Exception:
-                        raise AafigError()
+                        with open(metadata_fname) as f:
+                            extra = f.read()
+                    except Exception as e:
+                        raise AafigError() from e
                 finally:
                     if f is not None:
                         f.close()
@@ -190,14 +196,13 @@ def render_aafigure(app, text, options):
         (visitor, output) = aafigure.render(text, outfn, options)
         output.close()
     except aafigure.UnsupportedFormatError as e:
-        raise AafigError(str(e))
+        raise AafigError(str(e)) from e
 
     extra = None
     if options["format"].lower() == "svg":
         extra = visitor.get_size_attrs()
-        f = open(metadata_fname, "w")
-        f.write(extra)
-        f.close()
+        with open(metadata_fname, "w") as f:
+            f.write(extra)
 
     return relfn, outfn, id, extra
 
@@ -206,7 +211,7 @@ def setup(app):
     app.add_directive("aafig", AafigDirective)
     app.connect("doctree-read", render_aafig_images)
     app.add_config_value("aafig_format", DEFAULT_FORMATS, "html")
-    app.add_config_value("aafig_default_options", dict(), "html")
+    app.add_config_value("aafig_default_options", {}, "html")
 
 
 # vim: set expandtab shiftwidth=4 softtabstop=4 :

docs/conf.py

@@ -1,10 +1,10 @@
 # flake8: NOQA: E501
 import contextlib
 import inspect
+import pathlib
 import sys
 import typing as t
 from os.path import relpath
-import pathlib
 
 import tmuxp
 
@@ -172,12 +172,12 @@
 }
 
 # aafig format, try to get working with pdf
-aafig_format = dict(latex="pdf", html="gif")
+aafig_format = {"latex": "pdf", "html": "gif"}
 
-aafig_default_options = dict(scale=0.75, aspect=0.5, proportional=True)
+aafig_default_options = {"scale": 0.75, "aspect": 0.5, "proportional": True}
 
 
-def linkcode_resolve(domain, info):  # NOQA: C901
+def linkcode_resolve(domain, info):
     """
     Determine the URL corresponding to Python object
 
@@ -200,7 +200,7 @@ def linkcode_resolve(domain, info):  # NOQA: C901
     for part in fullname.split("."):
         try:
             obj = getattr(obj, part)
-        except Exception:
+        except Exception:  # NOQA: PERF203
             return None
 
     # strip decorators, which would resolve to the source of the decorator
@@ -224,10 +224,7 @@ def linkcode_resolve(domain, info):  # NOQA: C901
     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(tmuxp.__file__).parent)
 

pyproject.toml

@@ -155,6 +155,35 @@ module = [
 ]
 ignore_missing_imports = true
 
+[tool.ruff]
+target-version = "py37"
+select = [
+  "E", # pycodestyle
+  "F", # pyflakes
+  "I", # isort
+  "UP",  # pyupgrade
+  "B", # flake8-bugbear
+  "C4", # flake8-comprehensions
+  "Q", # flake8-quotes
+  "PTH", # flake8-use-pathlib
+  "SIM",  # flake8-simplify
+  "TRY", # Trycertatops
+  "PERF", # Perflint
+  "RUF" # Ruff-specific rules
+]
+
+[tool.ruff.isort]
+known-first-party = [
+  "tmuxp"
+]
+combine-as-imports = true
+
+[tool.ruff.per-file-ignores]
+"*/__init__.py" = ["F401"]
+"src/tmuxp/workspace/finders.py" = ["PTH"]
+"src/tmuxp/cli/*.py" = ["PTH"]
+"docs/_ext/aafig.py" = ["PTH"]
+
 [build-system]
 requires = ["poetry_core>=1.0.0"]
 build-backend = "poetry.core.masonry.api"

src/tmuxp/cli/convert.py

@@ -6,6 +6,7 @@
 from tmuxp.config_reader import ConfigReader
 from tmuxp.workspace.finders import find_workspace_file, get_workspace_dir
 
+from .. import exc
 from .utils import prompt_yes_no
 
 if t.TYPE_CHECKING:
@@ -40,6 +41,13 @@ def create_convert_subparser(
     return parser
 
 
+class ConvertUnknownFileType(exc.TmuxpException):
+    def __init__(self, ext: str, *args: object, **kwargs: object) -> None:
+        return super().__init__(
+            f"Unknown filetype: {ext} (valid: [.json, .yaml, .yml])"
+        )
+
+
 def command_convert(
     workspace_file: t.Union[str, pathlib.Path],
     answer_yes: bool,
@@ -61,7 +69,7 @@ def command_convert(
     elif ext in [".yaml", ".yml"]:
         to_filetype = "json"
     else:
-        raise Exception(f"Unknown filetype: {ext} (valid: [.json, .yaml, .yml])")
+        raise ConvertUnknownFileType(ext)
 
     configparser = ConfigReader.from_file(workspace_file)
     newfile = workspace_file.parent / (str(workspace_file.stem) + f".{to_filetype}")
@@ -72,13 +80,14 @@ def command_convert(
         **{"default_flow_style": False} if to_filetype == "yaml" else {},
     )
 
-    if not answer_yes:
-        if prompt_yes_no(f"Convert to <{workspace_file}> to {to_filetype}?"):
-            if prompt_yes_no("Save workspace to %s?" % newfile):
-                answer_yes = True
+    if (
+        not answer_yes
+        and prompt_yes_no(f"Convert to <{workspace_file}> to {to_filetype}?")
+        and prompt_yes_no("Save workspace to %s?" % newfile)
+    ):
+        answer_yes = True
 
     if answer_yes:
-        buf = open(newfile, "w")
-        buf.write(new_workspace)
-        buf.close()
+        with open(newfile, "w") as buf:
+            buf.write(new_workspace)
         print(f"New workspace file saved to <{newfile}>.")

src/tmuxp/cli/debug_info.py

@@ -7,7 +7,6 @@
 import typing as t
 
 from colorama import Fore
-
 from libtmux.__about__ import __version__ as libtmux_version
 from libtmux.common import get_version, tmux_cmd
 
@@ -34,7 +33,7 @@ def prepend_tab(strings):
         """
         Prepend tab to strings in list.
         """
-        return list(map(lambda x: "\t%s" % x, strings))
+        return ["\t%s" % x for x in strings]
 
     def output_break():
         """

src/tmuxp/cli/freeze.py

@@ -5,11 +5,12 @@
 import typing as t
 
 from libtmux.server import Server
+
 from tmuxp.config_reader import ConfigReader
 from tmuxp.exc import TmuxpException
 from tmuxp.workspace.finders import get_workspace_dir
 
-from .. import util
+from .. import exc, util
 from ..workspace import freezer
 from .utils import prompt, prompt_choices, prompt_yes_no
 
@@ -105,7 +106,7 @@ def command_freeze(
             session = util.get_session(server)
 
         if not session:
-            raise TmuxpException("Session not found.")
+            raise exc.SessionNotFound()
     except TmuxpException as e:
         print(e)
         return
@@ -194,9 +195,8 @@ def extract_workspace_format(
         destdir = os.path.dirname(dest)
         if not os.path.isdir(destdir):
             os.makedirs(destdir)
-        buf = open(dest, "w")
-        buf.write(workspace)
-        buf.close()
+        with open(dest, "w") as buf:
+            buf.write(workspace)
 
         if not args.quiet:
             print("Saved to %s." % dest)