Ruff 완벽 가이드: Rust로 재작성된 Python 코드 검사, Flake8보다 100배 빠름

# 방법 1: pip 사용 (권장)
pip install ruff

# 방법 2: uv 사용 (더 빠름)
uv tool install ruff

# 방법 3: macOS Homebrew
brew install ruff

# 방법 4: 공식 설치 스크립트
curl -LsSf https://astral.sh/ruff/install.sh | sh

# 설치 확인
ruff --version
# 출력: ruff 0.9.x

import os
import sys
import json  # unused

def  hello_world():
    x=1+2
    print("hello world")
    return x

if __name__ == "__main__":
    hello_world()

ruff check hello.py

ruff check --fix hello.py

def hello_world():
    x = 1 + 2
    print("hello world")
    return x

if __name__ == "__main__":
    hello_world()

ruff format hello.py

[tool.ruff]
# 대상 Python 버전
target-version = "py312"
# 줄 길이 제한
line-length = 88
# 검사할 디렉토리
src = ["src", "tests"]
# 제외할 디렉토리
exclude = [
    ".git",
    ".venv",
    "__pycache__",
    "build",
    "dist",
]

[tool.ruff.lint]
# 활성화할 규칙 집합
select = [
    "E",      # pycodestyle 오류
    "W",      # pycodestyle 경고
    "F",      # pyflakes
    "I",      # isort (import 정렬)
    "UP",     # pyupgrade (버전 업그레이드 권장)
    "B",      # flake8-bugbear (일반적인 버그 패턴)
    "SIM",    # flake8-simplify (코드 단순화)
    "RUF",    # Ruff 자체 규칙
]
# 무시할 규칙
ignore = [
    "E501",   # 줄이 너무 김 (formatter에 맡김)
    "E402",   # import가 파일 상단에 없음 (일부 스크립트에서 필요)
]
# 허용할 최대 복잡도
mccabe.max-complexity = 10

[tool.ruff.lint.per-file-ignores]
# 테스트 파일에서 일부 규칙 무시
"tests/**/*.py" = ["S101", "PLR2004"]
# 마이그레이션 파일에서 모든 규칙 무시
"**/migrations/*.py" = ["ALL"]

[tool.ruff.format]
# 따옴표 스타일: 홑따옴표 또는 쌍따옴표
quote-style = "double"
# 들여쓰기 타입
indent-style = "space"
# 파일末尾 개행
skip-magic-trailing-comma = false

pip uninstall black isort flake8 autoflake pyupgrade -y

[tool.ruff]
line-length = 88          # Black 기본 줄 너비
target-version = "py312"

[tool.ruff.format]
quote-style = "double"    # Black 기본 쌍따옴표
indent-style = "space"

[tool.ruff.lint]
select = ["E", "W", "F", "I"]

# 1단계: 모든 Python 파일 포매팅
ruff format .

# 2단계: 검사 및 자동 수정
ruff check --fix .

# 3단계: 남은 문제 확인 (자동 수정 안 함)
ruff check .

repos:
  - repo: https://github.com/astral-sh/ruff-pre-commit
    rev: v0.9.0
    hooks:
      # 먼저 포매팅
      - id: ruff-format
      # 그다음 검사
      - id: ruff
        args: [--fix, --exit-non-zero-on-fix]

pip install pre-commit
pre-commit install

name: Ruff Check

on: [push, pull_request]

jobs:
  ruff:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      - name: Set up Python
        uses: actions/setup-python@v5
        with:
          python-version: "3.12"

      - name: Install Ruff
        run: pip install ruff

      - name: Run Ruff format check
        run: ruff format --check .

      - name: Run Ruff lint
        run: ruff check --output-format=github .

ruff:
  image: python:3.12-slim
  stage: test
  script:
    - pip install ruff
    - ruff format --check .
    - ruff check .
  allow_failure: true  # 초기에는 실패 허용 가능

# 변경된 파일만 검사 (CI 시나리오)
ruff check --diff .

# SARIF 형식 출력 (GitHub Code Scanning용)
ruff check --output-format=sarif . > results.sarif

# 특정 규칙만 검사
ruff check --select=F,E .

# Ruff 설정 및 캐시 상태 확인
ruff check --show-settings .

[tool.ruff.lint]
select = ["E", "F", "W"]

# 일부 규칙을 오류가 아닌 경고로 설정
[tool.ruff.lint.flake8-errmsg]
max-string-length = 20

[tool.ruff.lint.pydocstyle]
convention = "google"  # 또는 "numpy", "pep257"

// .vscode/settings.json
{
  "[python]": {
    "editor.defaultFormatter": "charliermarsh.ruff",
    "editor.codeActionsOnSave": {
      "source.fixAll.ruff": "explicit"
    }
  }
}

# 파일 변경 감지, 자동 재검사
ruff check --watch .

# JSON 형식 출력, jq로 처리 가능
ruff check --output-format=json . | jq '.'

# 또는 sarif 형식으로 GitHub Code Scanning과 연동
ruff check --output-format=sarif . > ruff-results.sarif