Python Code Quality

Python コード品質ツールの簡易リファレンス: ruff (linting & formatting)、ty (type checking)。

このスキルを使う場面

このスキルを使う場合	代わりに専門的なスキルを使う場合
新規プロジェクトで完全な品質スタック (lint + format + type-check) をセットアップする	ruff の lint ルール選択のみを調整する — ruff-linting を使う
ruff と ty を pre-commit と CI に統合する	ruff フォーマッター設定のみを構成する — ruff-formatting を使う
ツール選択前に ruff/ty/basedpyright を高レベルで比較する	strict basedpyright/ty type-checker ルールを構成する — basedpyright-type-checking または ty-type-checking を使う

このスキルが適用される場面

• Python コードの linting
• コード フォーマッティング
• Type checking
• Pre-commit フック
• CI/CD 品質ゲート
• コード スタイル強制

Quick Reference

Ruff (Linter & Formatter)

# Lint code
uv run ruff check .

# Auto-fix issues
uv run ruff check --fix .

# Format code
uv run ruff format .

# Check and format
uv run ruff check --fix . && uv run ruff format .

# Show specific rule
uv run ruff check --select E501  # Line too long

# Ignore specific rule
uv run ruff check --ignore E501

ty (Type Checking)

# Type check project
uv run ty check

# Type check specific file
uv run ty check src/module.py

# Check with explicit Python version
uv run ty check --python 3.11

# Verbose output
uv run ty check --verbose

pyproject.toml 設定

[tool.ruff]
line-length = 88
target-version = "py311"

[tool.ruff.lint]
select = [
    "E",   # pycodestyle errors
    "W",   # pycodestyle warnings
    "F",   # pyflakes
    "I",   # isort
    "N",   # pep8-naming
    "UP",  # pyupgrade
    "B",   # flake8-bugbear
]
ignore = [
    "E501",  # line too long (handled by formatter)
]

[tool.ruff.lint.isort]
known-first-party = ["myproject"]

[tool.ty]
python-version = "3.11"
exclude = [
    "**/__pycache__",
    "**/.venv",
    "tests",
]

[tool.ty.rules]
possibly-unbound = "warn"

Type Hints

# Modern type hints (Python 3.10+)
def process_data(
    items: list[str],                    # Not List[str]
    config: dict[str, int],              # Not Dict[str, int]
    optional: str | None = None,         # Not Optional[str]
) -> tuple[bool, str]:                   # Not Tuple[bool, str]
    return True, "success"

# Type aliases
from typing import TypeAlias

UserId: TypeAlias = int
UserDict: TypeAlias = dict[str, str | int]

def get_user(user_id: UserId) -> UserDict:
    return {"id": user_id, "name": "Alice"}

Pre-commit 設定

# .pre-commit-config.yaml
repos:
  - repo: https://github.com/astral-sh/ruff-pre-commit
    rev: v0.1.9
    hooks:
      - id: ruff
        args: [--fix]
      - id: ruff-format

  - repo: https://github.com/astral-sh/ty
    rev: v0.0.10
    hooks:
      - id: ty

Ruff の一般的なルール

• E501: 行が長すぎる
• F401: 未使用のインポート
• F841: 未使用の変数
• I001: インポートがソートされていない
• N806: 変数は小文字にすべき
• B008: 引数デフォルト値での関数呼び出し

関連項目

• python-testing - コード品質のテスト
• uv-project-management - プロジェクトへの品質ツール追加
• python-development - コア Python パターン

参考資料

• Ruff: https://docs.astral.sh/ruff/
• ty: https://docs.astral.sh/ty/
• 詳細ガイド: REFERENCE.md を参照