pre-commitでコミット前に整形とlintを自動化(black/isort/flake8)

# macOS/Linux の例
python3 -m venv .venv
source .venv/bin/activate

# Windows PowerShell の例
py -m venv .venv
.\.venv\Scripts\Activate.ps1

# 開発用ツールのインストール
pip install -U pre-commit black isort flake8

# 依存を記録して共有
pip freeze | grep -E "pre-commit|black|isort|flake8" > requirements-dev.txt

# .pre-commit-config.yaml
# pre-commitが実行する各ツール(フック)の一覧とバージョンを定義します。
# revは固定(ピン止め)するのが基本です。定期的に `pre-commit autoupdate` で更新しましょう。
minimum_pre_commit_version: "3.5.0"
default_language_version:
  python: python3

repos:
  # 便利な基本フック集(末尾改行/改行コード/余分な空白など)
  - repo: https://github.com/pre-commit/pre-commit-hooks
    rev: v4.6.0
    hooks:
      - id: trailing-whitespace
      - id: end-of-file-fixer
      - id: mixed-line-ending
        args: ["--fix=lf"]  # 改行コードをLFに揃える

  # black: コード整形
  - repo: https://github.com/psf/black
    rev: 24.8.0
    hooks:
      - id: black
        language_version: python3
        # line-lengthなどはpyproject.tomlに寄せると一元管理できます

  # isort: インポート順の自動整理
  - repo: https://github.com/pycqa/isort
    rev: 5.13.2
    hooks:
      - id: isort
        language_version: python3
        args: ["--profile=black"]  # blackと整形規則を統一

  # flake8: Lint
  - repo: https://github.com/PyCQA/flake8
    rev: 7.1.1
    hooks:
      - id: flake8
        language_version: python3
        # フィルタや長さ制限などは .flake8 へ

# pyproject.toml
# black と isort の規則をここに集約します。エディターやCIとも共有しやすいです。
[tool.black]
line-length = 88
target-version = ["py310", "py311"]

[tool.isort]
profile = "black"
src_paths = ["src", "tests"]

# .flake8
# flake8の推奨設定例。E203/W503はblackと相性の都合で無視するのが一般的です。
[flake8]
max-line-length = 88
extend-ignore = E203, W503
per-file-ignores =
    __init__.py:F401

# .pre-commit-config.yaml (black 部分のみ抜粋)
- repo: https://github.com/psf/black
  rev: 24.8.0
  hooks:
    - id: black
      language_version: python3

# .pre-commit-config.yaml (isort 部分のみ抜粋)
- repo: https://github.com/pycqa/isort
  rev: 5.13.2
  hooks:
    - id: isort
      language_version: python3
      args: ["--profile=black"]

# .pre-commit-config.yaml (flake8 部分のみ抜粋)
- repo: https://github.com/PyCQA/flake8
  rev: 7.1.1
  hooks:
    - id: flake8
      language_version: python3

pre-commit install

pre-commit run --all-files

# sample.py (わざと悪い例)
# - インポートの順や未使用インポート
# - スペース・セミコロンなどの整形問題
import os, sys  # sys は未使用
from typing import List, Dict  # 未使用

import json

def add(a:int,b:int)->int:
    return  a+b

colors=['red','green','blue',  'yellow']

def greet(name:str)->None:
    print(f"hello,{name}")

if __name__=="__main__":
    greet("world"); print(add(1,2))  # 1行に2文

git add sample.py
git commit -m "Add sample (intentionally bad)"

isort.............................................Reformatted
black.............................................Reformatted
flake8............................................Failed
- hook id: flake8
- exit code: 1

sample.py:1:12: F401 'sys' imported but unused
sample.py:2:1: F401 'typing.List' imported but unused
sample.py:2:1: F401 'typing.Dict' imported but unused

# sample.py (修正後の例)
import json
import os  # 使っている想定なら残す。未使用ならこれも削除。

def add(a: int, b: int) -> int:
    return a + b

colors = ["red", "green", "blue", "yellow"]

def greet(name: str) -> None:
    print(f"hello,{name}")

if __name__ == "__main__":
    greet("world")
    print(add(1, 2))

git add sample.py
git commit -m "Fix: remove unused imports and apply formatting"

# 例: data/ と migrations/ をflake8から除外
- repo: https://github.com/PyCQA/flake8
  rev: 7.1.1
  hooks:
    - id: flake8
      language_version: python3
      exclude: ^(data/|migrations/)

# 例: Pythonファイルのみにblackを適用
- repo: https://github.com/psf/black
  rev: 24.8.0
  hooks:
    - id: black
      files: \.pyi?$

# macOS/Linux: 改行はLFに統一
git config --global core.autocrlf input

# Windows: チェックアウト時にCRLF、コミット時にLFへ変換
git config --global core.autocrlf true

// .vscode/settings.json の例
{
  "[python]": {
    "editor.defaultFormatter": "ms-python.black-formatter",
    "editor.formatOnSave": true
  },
  // 保存時にインポート並べ替え(拡張がisortを呼びます)
  "editor.codeActionsOnSave": {
    "source.organizeImports": "explicit"
  }
}

# 全ファイル実行を並列化(-jで並列数を指定)
pre-commit run --all-files -j 4