Toughen rough linting (#907)

# Changes

## ruff linting

### flake8-commas (COM)

- https://docs.astral.sh/ruff/rules/#flake8-commas-com
- https://pypi.org/project/flake8-commas/

### flake8-builtins (A)

- https://docs.astral.sh/ruff/rules/#flake8-builtins-a
- https://pypi.org/project/flake8-builtins/

### flake8-errmsg (EM)

- https://docs.astral.sh/ruff/rules/#flake8-errmsg-em
- https://pypi.org/project/flake8-errmsg/

Author: tony

CHANGES

@@ -25,6 +25,25 @@ $ pipx install --suffix=@next 'tmuxp' --pip-args '\--pre' --force
 
   Doc string + linting stringency updates.
 
+### Development
+
+- Strengthen linting (#907)
+
+  - Add flake8-commas (COM)
+
+    - https://docs.astral.sh/ruff/rules/#flake8-commas-com
+    - https://pypi.org/project/flake8-commas/
+
+  - Add flake8-builtins (A)
+
+    - https://docs.astral.sh/ruff/rules/#flake8-builtins-a
+    - https://pypi.org/project/flake8-builtins/
+
+  - Add flake8-errmsg (EM)
+
+    - https://docs.astral.sh/ruff/rules/#flake8-errmsg-em
+    - https://pypi.org/project/flake8-errmsg/
+
 ## tmuxp 1.34.0 (2023-12-21)
 
 _Maintenance only, no bug fixes or new features_

conftest.py

@@ -28,13 +28,14 @@
 USING_ZSH = "zsh" in os.getenv("SHELL", "")
 
 
-@pytest.mark.skipif(not USING_ZSH, reason="Using ZSH")
 @pytest.fixture(autouse=USING_ZSH, scope="session")
-def zshrc(user_path: pathlib.Path) -> pathlib.Path:
+def zshrc(user_path: pathlib.Path) -> t.Optional[pathlib.Path]:
     """Quiets ZSH default message.
 
     Needs a startup file .zshenv, .zprofile, .zshrc, .zlogin.
     """
+    if not USING_ZSH:
+        return None
     p = user_path / ".zshrc"
     p.touch()
     return p
@@ -59,7 +60,8 @@ def tmuxp_configdir(user_path: pathlib.Path) -> pathlib.Path:
 
 @pytest.fixture
 def tmuxp_configdir_default(
-    monkeypatch: pytest.MonkeyPatch, tmuxp_configdir: pathlib.Path
+    monkeypatch: pytest.MonkeyPatch,
+    tmuxp_configdir: pathlib.Path,
 ) -> None:
     """Set tmuxp configuration directory for ``TMUXP_CONFIGDIR``."""
     monkeypatch.setenv("TMUXP_CONFIGDIR", str(tmuxp_configdir))

docs/_ext/aafig.py

@@ -38,7 +38,8 @@
 
 
 def merge_dict(
-    dst: t.Dict[str, t.Optional[str]], src: t.Dict[str, t.Optional[str]]
+    dst: t.Dict[str, t.Optional[str]],
+    src: t.Dict[str, t.Optional[str]],
 ) -> t.Dict[str, t.Optional[str]]:
     for k, v in src.items():
         if k not in dst:
@@ -47,14 +48,16 @@ def merge_dict(
 
 
 def get_basename(
-    text: str, options: t.Dict[str, str], prefix: t.Optional[str] = "aafig"
+    text: str,
+    options: t.Dict[str, str],
+    prefix: t.Optional[str] = "aafig",
 ) -> str:
     options = options.copy()
     if "format" in options:
         del options["format"]
     hashkey = text + str(options)
-    id = sha(hashkey.encode("utf-8")).hexdigest()
-    return f"{prefix}-{id}"
+    _id = sha(hashkey.encode("utf-8")).hexdigest()
+    return f"{prefix}-{_id}"
 
 
 class AafigError(SphinxError):
@@ -106,7 +109,7 @@ def render_aafig_images(app: "Sphinx", doctree: nodes.Node) -> None:
     if aafigure is None:
         logger.warn(
             "aafigure module not installed, ASCII art images "
-            "will be rendered as literal text"
+            "will be rendered as literal text",
         )
     for img in doctree.traverse(nodes.image):
         if not hasattr(img, "aafig"):
@@ -115,23 +118,23 @@ def render_aafig_images(app: "Sphinx", doctree: nodes.Node) -> None:
             continue
         options = img.aafig["options"]
         text = img.aafig["text"]
-        format = app.builder.format
+        _format = app.builder.format
         merge_dict(options, app.builder.config.aafig_default_options)
-        if format in format_map:
-            options["format"] = format_map[format]
+        if _format in format_map:
+            options["format"] = format_map[_format]
         else:
             logger.warn(
                 'unsupported builder format "%s", please '
                 "add a custom entry in aafig_format config "
-                "option for this builder" % format
+                "option for this builder" % _format,
             )
             img.replace_self(nodes.literal_block(text, text))
             continue
         if options["format"] is None:
             img.replace_self(nodes.literal_block(text, text))
             continue
         try:
-            fname, outfn, id, extra = render_aafigure(app, text, options)
+            fname, outfn, _id, extra = render_aafigure(app, text, options)
         except AafigError as exc:
             logger.warn("aafigure error: " + str(exc))
             img.replace_self(nodes.literal_block(text, text))
@@ -152,7 +155,9 @@ def __init__(self, *args: object, **kwargs: object) -> None:
 
 
 def render_aafigure(
-    app: "Sphinx", text: str, options: t.Dict[str, str]
+    app: "Sphinx",
+    text: str,
+    options: t.Dict[str, str],
 ) -> t.Tuple[str, str, t.Optional[str], t.Optional[str]]:
     """Render an ASCII art figure into the requested format output file."""
     if aafigure is None:
@@ -172,7 +177,7 @@ def render_aafigure(
                 "aafig: the builder format %s is not officially "
                 "supported, aafigure images could not work. "
                 "Please report problems and working builder to "
-                "avoid this warning in the future" % app.builder.format
+                "avoid this warning in the future" % app.builder.format,
             )
         relfn = fname
         outfn = path.join(app.builder.outdir, fname)

docs/conf.py

@@ -56,7 +56,7 @@
 master_doc = "index"
 
 project = about["__title__"]
-copyright = about["__copyright__"]
+project_copyright = about["__copyright__"]
 
 version = "%s" % (".".join(about["__version__"].split("."))[:2])
 release = "%s" % (about["__version__"])
@@ -99,7 +99,7 @@
         "sidebar/navigation.html",
         "sidebar/projects.html",
         "sidebar/scroll-end.html",
-    ]
+    ],
 }
 
 # linkify_issues

pyproject.toml

@@ -140,8 +140,11 @@ select = [
   "F", # pyflakes
   "I", # isort
   "UP", # pyupgrade
+  "A", # flake8-builtins
   "B", # flake8-bugbear
   "C4", # flake8-comprehensions
+  "COM", # flake8-commas
+  "EM", # flake8-errmsg
   "Q", # flake8-quotes
   "PTH", # flake8-use-pathlib
   "SIM", # flake8-simplify
@@ -150,6 +153,9 @@ select = [
   "RUF", # Ruff-specific rules
   "D", # pydocstyle
 ]
+ignore = [
+  "COM812", # missing trailing comma, ruff format conflict
+]
 
 [tool.ruff.lint.isort]
 known-first-party = [

src/tmuxp/_internal/config_reader.py

@@ -27,7 +27,7 @@ def __init__(self, content: "RawConfigData") -> None:
         self.content = content
 
     @staticmethod
-    def _load(format: "FormatLiteral", content: str) -> t.Dict[str, t.Any]:
+    def _load(fmt: "FormatLiteral", content: str) -> t.Dict[str, t.Any]:
         """Load raw config data and directly return it.
 
         >>> ConfigReader._load("json", '{ "session_name": "my session" }')
@@ -36,21 +36,22 @@ def _load(format: "FormatLiteral", content: str) -> t.Dict[str, t.Any]:
         >>> ConfigReader._load("yaml", 'session_name: my session')
         {'session_name': 'my session'}
         """
-        if format == "yaml":
+        if fmt == "yaml":
             return t.cast(
                 t.Dict[str, t.Any],
                 yaml.load(
                     content,
                     Loader=yaml.SafeLoader,
                 ),
             )
-        elif format == "json":
+        elif fmt == "json":
             return t.cast(t.Dict[str, t.Any], json.loads(content))
         else:
-            raise NotImplementedError(f"{format} not supported in configuration")
+            msg = f"{fmt} not supported in configuration"
+            raise NotImplementedError(msg)
 
     @classmethod
-    def load(cls, format: "FormatLiteral", content: str) -> "ConfigReader":
+    def load(cls, fmt: "FormatLiteral", content: str) -> "ConfigReader":
         """Load raw config data into a ConfigReader instance (to dump later).
 
         >>> cfg = ConfigReader.load("json", '{ "session_name": "my session" }')
@@ -67,7 +68,7 @@ def load(cls, format: "FormatLiteral", content: str) -> "ConfigReader":
         """
         return cls(
             content=cls._load(
-                format=format,
+                fmt=fmt,
                 content=content,
             ),
         )
@@ -106,14 +107,15 @@ def _from_file(cls, path: pathlib.Path) -> t.Dict[str, t.Any]:
         content = path.open().read()
 
         if path.suffix in [".yaml", ".yml"]:
-            format: "FormatLiteral" = "yaml"
+            fmt: "FormatLiteral" = "yaml"
         elif path.suffix == ".json":
-            format = "json"
+            fmt = "json"
         else:
-            raise NotImplementedError(f"{path.suffix} not supported in {path}")
+            msg = f"{path.suffix} not supported in {path}"
+            raise NotImplementedError(msg)
 
         return cls._load(
-            format=format,
+            fmt=fmt,
             content=content,
         )
 
@@ -159,7 +161,7 @@ def from_file(cls, path: pathlib.Path) -> "ConfigReader":
 
     @staticmethod
     def _dump(
-        format: "FormatLiteral",
+        fmt: "FormatLiteral",
         content: "RawConfigData",
         indent: int = 2,
         **kwargs: t.Any,
@@ -172,22 +174,23 @@ def _dump(
         >>> ConfigReader._dump("json", { "session_name": "my session" })
         '{\n  "session_name": "my session"\n}'
         """
-        if format == "yaml":
+        if fmt == "yaml":
             return yaml.dump(
                 content,
                 indent=2,
                 default_flow_style=False,
                 Dumper=yaml.SafeDumper,
             )
-        elif format == "json":
+        elif fmt == "json":
             return json.dumps(
                 content,
                 indent=2,
             )
         else:
-            raise NotImplementedError(f"{format} not supported in config")
+            msg = f"{fmt} not supported in config"
+            raise NotImplementedError(msg)
 
-    def dump(self, format: "FormatLiteral", indent: int = 2, **kwargs: t.Any) -> str:
+    def dump(self, fmt: "FormatLiteral", indent: int = 2, **kwargs: t.Any) -> str:
         r"""Dump via ConfigReader instance.
 
         >>> cfg = ConfigReader({ "session_name": "my session" })
@@ -197,7 +200,7 @@ def dump(self, format: "FormatLiteral", indent: int = 2, **kwargs: t.Any) -> str
         '{\n  "session_name": "my session"\n}'
         """
         return self._dump(
-            format=format,
+            fmt=fmt,
             content=self.content,
             indent=indent,
             **kwargs,

src/tmuxp/cli/__init__.py

@@ -34,7 +34,14 @@
 
     CLIVerbosity: TypeAlias = t.Literal["DEBUG", "INFO", "WARNING", "ERROR", "CRITICAL"]
     CLISubparserName: TypeAlias = t.Literal[
-        "ls", "load", "freeze", "convert", "edit", "import", "shell", "debug-info"
+        "ls",
+        "load",
+        "freeze",
+        "convert",
+        "edit",
+        "import",
+        "shell",
+        "debug-info",
     ]
     CLIImportSubparserName: TypeAlias = t.Literal["teamocil", "tmuxinator"]
 
@@ -60,21 +67,25 @@ def create_parser() -> argparse.ArgumentParser:
     load_parser = subparsers.add_parser("load", help="load tmuxp workspaces")
     create_load_subparser(load_parser)
     shell_parser = subparsers.add_parser(
-        "shell", help="launch python shell for tmux server, session, window and pane"
+        "shell",
+        help="launch python shell for tmux server, session, window and pane",
     )
     create_shell_subparser(shell_parser)
     import_parser = subparsers.add_parser(
-        "import", help="import workspaces from teamocil and tmuxinator."
+        "import",
+        help="import workspaces from teamocil and tmuxinator.",
     )
     create_import_subparser(import_parser)
 
     convert_parser = subparsers.add_parser(
-        "convert", help="convert workspace files between yaml and json."
+        "convert",
+        help="convert workspace files between yaml and json.",
     )
     create_convert_subparser(convert_parser)
 
     debug_info_parser = subparsers.add_parser(
-        "debug-info", help="print out all diagnostic info"
+        "debug-info",
+        help="print out all diagnostic info",
     )
     create_debug_info_subparser(debug_info_parser)
 
@@ -85,7 +96,8 @@ def create_parser() -> argparse.ArgumentParser:
     create_edit_subparser(edit_parser)
 
     freeze_parser = subparsers.add_parser(
-        "freeze", help="freeze a live tmux session to a tmuxp workspace file"
+        "freeze",
+        help="freeze a live tmux session to a tmuxp workspace file",
     )
     create_freeze_subparser(freeze_parser)
 

src/tmuxp/cli/convert.py

@@ -46,7 +46,7 @@ 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])"
+            f"Unknown filetype: {ext} (valid: [.json, .yaml, .yml])",
         )
 
 
@@ -57,7 +57,8 @@ def command_convert(
 ) -> None:
     """Entrypoint for ``tmuxp convert`` convert a tmuxp config between JSON and YAML."""
     workspace_file = find_workspace_file(
-        workspace_file, workspace_dir=get_workspace_dir()
+        workspace_file,
+        workspace_dir=get_workspace_dir(),
     )
 
     if isinstance(workspace_file, str):
@@ -77,7 +78,7 @@ def command_convert(
     newfile = workspace_file.parent / (str(workspace_file.stem) + f".{to_filetype}")
 
     new_workspace = configparser.dump(
-        format=to_filetype,
+        fmt=to_filetype,
         indent=2,
         **{"default_flow_style": False} if to_filetype == "yaml" else {},
     )

src/tmuxp/cli/debug_info.py

@@ -45,7 +45,7 @@ def format_tmux_resp(std_resp: tmux_cmd) -> str:
                 Fore.RED,
                 "\n".join(prepend_tab(std_resp.stderr)),
                 Fore.RESET,
-            ]
+            ],
         )
 
     output = [
@@ -58,8 +58,8 @@ def format_tmux_resp(std_resp: tmux_cmd) -> str:
                     "arch: %s" % platform.machine(),
                     "uname: %s" % "; ".join(platform.uname()[:3]),
                     "version: %s" % platform.version(),
-                ]
-            )
+                ],
+            ),
         ),
         output_break(),
         "python version: %s" % " ".join(sys.version.split("\n")),