基本方針として PEP 8 および Ruff の自動チェックに準拠する.本ガイドでは PEP 8 でカバーされないプロジェクト固有のルールのみ定義する.
ruff.toml で設定済み)ruff.toml で設定済み)"PEP 8 に準拠する.
| 対象 | 形式 | 例 |
|---|---|---|
| モジュール | snake_case | uniformity.py |
| 関数・変数 | snake_case | calc_cov |
| 定数 | UPPER_SNAKE_CASE | DEFAULT_ROI_SIZE |
| クラス | PascalCase | UniformityResult |
Ruff(isort 互換)で自動整列する.順序:
numpy.ndarray を使用するdef calc_cov(image: numpy.ndarray) -> float:
# CIE ΔE2000 を使用(CIEDE2000, CIE 142-2001) delta_e = colour.delta_E(lab1, lab2, method="CIE 2000")
def load_image(path: str) -> numpy.ndarray:
"""PNG 画像を読み込み RGB 配列として返す.
Args:
path: 画像ファイルのパス.
Returns:
RGB 画像の NumPy 配列(H x W x 3, uint8).
"""