Pythonプロジェクトに静的解析ツールのRust製Ruffを導入してflake8/black/isortを置き換えてみた

$ curl -LsSf https://astral.sh/ruff/install.sh | sh
$ ruff check --fix
$ ruff format

import os   # 不要なインポート
print(n)    # 定義されていない変数

$ flake8 sample_linter.py
sample_linter.py:1:1: F401 'os' imported but unused
sample_linter.py:2:7: F821 undefined name 'n'

$ ruff check sample_linter.py # 検出
sample_linter.py:1:8: F401 [*] `os` imported but unused
  |
1 | import os
  |        ^^ F401
2 | print(n)
  |
  = help: Remove unused import: `os`

sample_linter.py:2:7: F821 Undefined name `n`
  |
1 | import os
2 | print(n)
  |       ^ F821
  |

Found 2 errors.
[*] 1 fixable with the `--fix` option.

$ ruff check --fix sample_linter.py # `--fix` で修正
sample_linter.py:1:7: F821 Undefined name `n`
  |
1 | print(n)
  |       ^ F821
  |

Found 2 errors (1 fixed, 1 remaining).

$ cat sample_linter.py
print(n)

if n:print("ok")

if n:
    print("ok")

$ black sample_format.py
reformatted sample_format.py

All done! ✨ 🍰 ✨
1 file reformatted.

$ ruff format --check sample_format.py # コード整形の必要製の検出
Would reformat: sample_format.py
1 file would be reformatted

$ ruff format sample_format.py         # コード整形
1 file reformatted

import requests
import sys
import os

import os
import sys

import requests

$ isort sample_import.py
Fixing /Users/user/sample_import.py

$ ruff check --extend-select I --fix sample_import.py
Found 1 error (1 fixed, 0 remaining).

$ brew install pre-commit

repos:
  - repo: https://github.com/astral-sh/ruff-pre-commit
    rev: v0.5.6
    hooks:
      - id: ruff
        args: [--extend-select, I, --fix]
      - id: ruff-format

$ pre-commit install
pre-commit installed at .git/hooks/pre-commit

$ git commit -m test
[WARNING] Unstaged files detected.
[INFO] Stashing unstaged files to /Users/user/.cache/pre-commit/patch1723031830-70446.
ruff.....................................................................Failed
- hook id: ruff
- exit code: 1
- files were modified by this hook

a.py:1:7: F821 Undefined name `n`
  |
1 | print(n)
  |       ^ F821
  |

Found 2 errors (1 fixed, 1 remaining).

ruff-format..............................................................Passed
[INFO] Restored changes from /Users/user/.cache/pre-commit/patch1723031830-70446.

{
  "[python]": {
    "editor.formatOnSave": true,
    "editor.defaultFormatter": "charliermarsh.ruff",
    "editor.codeActionsOnSave": {
      "source.fixAll": "explicit",
      "source.organizeImports": "explicit"
    }
  }
}

name: Linter
on: [ push, pull_request ]
jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - name: Install Python
        uses: actions/setup-python@v5
        with:
          python-version: "3.11"
      - name: Install dependencies
        run: |
          python -m pip install --upgrade pip
          pip install ruff
      # Update output format to enable automatic inline annotations.
      - name: Run Ruff
        run: ruff check --output-format=github
      - name: Run Ruff
        run: ruff format --check

name: Linter
on: [ push, pull_request ]
jobs:
  ruff:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: chartboost/ruff-action@v1
        with:
          args: check --output-format=github
      - uses: chartboost/ruff-action@v1
        with:
          args: format --check

[tool.ruff]
target-version = "py310"

[tool.ruff.lint]
ignore = [
  "E501", # Line too long
]

select = [
  "E",   # pycodestyle
  "F",   # pyflakes
  "I",   # isort
]

[tool.ruff]
# The formatter wraps lines at a length of 88.
line-length = 88

[tool.ruff.lint.pycodestyle]
# E501 reports lines that exceed the length of 200.
max-line-length = 200

x = 1  # noqa

"""Lorem ipsum dolor sit amet.

Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor.
"""  # noqa: E501

$ ruff check a.py
a.py:1:7: F821 Undefined name `n`
  |
1 | print(n)
  |       ^ F821
  |

Found 1 error.

$ echo $?
1

$ ruff check --fix fix.py
Found 1 error (1 fixed, 0 remaining).
$ echo $?
0

$ ruff check --fix  --exit-non-zero-on-fix fix.py
Found 1 error (1 fixed, 0 remaining).
$ echo $?
1

$ ruff format b.py
1 file reformatted

$ echo $?
0

$ ruff format --check b.py
Would reformat: b.py
1 file would be reformatted

$ echo $?
1