Ruff script to automatically ignore lint

[yoann9344]

It is usually a good idea to select all rules then to ignore all errors, then little by little you can fix it. But while writing new features you'll have all these ignores deactivated by your IDE. So it is interesting to toggle the ruff.lint.ignore section. More than that it is interesting, to have sorted and described errors in your pyproject.toml. Basically the following tool put ruff check --statistics into ruff.lint.ignore.

requirements : tomlkit (to keep toml formatting)

"""Script to clean ruff errors by filling lint.ignore section."""
from __future__ import annotations

import re
import shlex
import shutil
import subprocess
import sys
from pathlib import Path
from typing import TYPE_CHECKING

from tomlkit import array
from tomlkit.toml_file import TOMLFile


if TYPE_CHECKING:
    from tomlkit.items import Array


RAW_IGNORE = """[
    # "<code>" # <count> [<fixable>] <details'
{stats}
]"""


def ruff_stats() -> str:
    """Retrieve ruff stats."""
    poetry = shutil.which("poetry")
    cmd = shlex.split(f"{poetry} run ruff check --statistics")
    ruff = subprocess.run(cmd, stdout=subprocess.PIPE, check=False)
    return ruff.stdout.decode()


def parse_stats() -> str:
    """Parse ruff stats in toml format."""
    # def parse_stats() -> Iterator[tuple[str, str]]:
    stats = ruff_stats()
    regex = re.compile(r"^([ 0-9]+)(\t+)([a-zA-Z0-9]+)(\s+)(.*)$", flags=re.MULTILINE)
    m = regex.findall(stats)
    return "\n".join([f"    '{code}',{space} # {count} {details}" for count, tab, code, space, details in m])


def write_ignore_stats():
    """Write tool.ruff.lint.ignore with ruff stats errors."""
    pyproject = TOMLFile("pyproject.toml")
    config = pyproject.read()
    ignore: Array = config["tool"]["ruff"]["lint"]["ignore"]  # type: ignore[index, assignment]
    ignore.clear()
    pyproject.write(config)
    raw_ignore = RAW_IGNORE.format(stats=parse_stats())
    config["tool"]["ruff"]["lint"]["ignore"] = array(raw_ignore)  # type: ignore[index]
    pyproject.write(config)


def write_ignore_dev():
    """Write tool.ruff.lint.ignore with your own config."""
    pyproject = TOMLFile("pyproject.toml")
    config = pyproject.read()
    path = Path("~/.local/share/ruffi.toml")

    if path.exists():
        dev = TOMLFile(path)
        dev_config = dev.read()
        dev_ignore: Array = dev_config["tool"]["ruff"]["lint"]["ignore"]  # type: ignore[index, assignment]
        config["tool"]["ruff"]["lint"]["ignore"] = dev_ignore  # type: ignore[index]
    else:
        ignore: Array = config["tool"]["ruff"]["lint"]["ignore"]  # type: ignore[index, assignment]
        ignore.clear()

    pyproject.write(config)


if __name__ == "__main__":
    if "--help" in sys.argv:
        print(  # noqa: T201 - By example put this T201 in your dev config ;)
            "ruffi : Automatically ignore all errors by modifying pyproject.toml. \n"
            "ruffi --dev : Push your own config into lint.ignore. Your config must be in ~/.local/share/ruffi.toml",
        )
    elif "--dev" in sys.argv:
        write_ignore_dev()
    else:
        write_ignore_stats()

By example, it will generate something like this :

[tool.ruff.lint]
ignore = [
    # "<code>" # <count> [<fixable>] <details'
    'Q000',   	 # 3708 [*] Single quotes found but double quotes preferred
    'ANN001', 	 # 1414 [ ] Missing type annotation for function argument `_`
]