PEP8の書き方まとめ Pythonの命名/インデント/空白のルール

# NG
userName = "Alice"      # キャメルケースは避ける
GetUserName = lambda u: u.name  # 関数名は小文字で

# OK
user_name = "Alice"
def get_user_name(user):  # 動詞から始めると意図が伝わる
    return user.name

# NG
class user_profile:
    pass

# OK
class UserProfile:
    pass

# NG
pi = 3.14159

# OK
PI = 3.14159
MAX_CONNECTIONS = 20

# NG
DataLoader.py
MyLib/

# OK
dataloader.py
mylib/
string_utils.py

_internal_cache = {}  # モジュール内部だけで使いたい

def _normalize(text):  # 外に見せたくない関数
    return " ".join(text.split())

class Tokenizer:
    def __init__(self):
        self._buffer = []  # クラス内部向け

class Point:
    def __init__(self, x, y):  # 生成時に呼ばれる
        self.x = x
        self.y = y

    def __str__(self):         # str(point) で使われる
        return f"({self.x}, {self.y})"

    def __eq__(self, other):   # == 比較
        return (self.x, self.y) == (other.x, other.y)

# NG: 2スペースや不揃いは避ける
def add(x, y):
  return x + y

# OK: 4スペース
def add(x, y):
    return x + y

# NG: タブ混在の例 (見た目は同じでも崩れます)
def f():
<TAB>print("mixed")  # 実際のタブは目に見えません

# OK: スペースのみ
def f():
    print("spaces only")

# NG
a=1+2*3
value    =    x*y

# OK
a = 1 + 2 * 3
value = x * y

# 例外: 単項演算子は詰める
b = -5
mask = ~flags

# OK: 演算子の前で改行
total = (price
         + tax
         - discount)

# NG
if x == 1 :  # コロンの前に空白を置かない
    print("one")

items = [1 , 2 , 3]  # カンマの前に空白を置かない

# OK
if x == 1:
    print("one")

items = [1, 2, 3]

# NG
spam( ham[ 1 ], { eggs: 2 } )
# OK
spam(ham[1], {eggs: 2})

# NG
open(file = "data.txt", mode = "w")

# OK
open(file="data.txt", mode="w")

# NG
text = "Hello, world"
head = text[ 0 : 5 ]     # コロンの前後の空白は不要
step = text[0 : 10 : 2]  # 同様に不要

# OK
text = "Hello, world"
head = text[0:5]
step = text[0:10:2]

# 多次元インデックスではカンマの後に1スペース
matrix = arr[1:9, 3:, ::2]

# NG: バックスラッシュは脆い(コメントや空白で壊れやすい)
result = a + b + c + d + e + f + g + \
h + i

# OK: 括弧、ブラケット、ブレース内では暗黙の行継続が可能
result = (
    a + b + c + d
    + e + f + g
    + h + i
)

# 辞書や引数も同様
config = {
    "host": "localhost",
    "port": 5432,
    "user": "app",
}

# OK: ファイル直下のクラスや関数は2行で区切る

PI = 3.14159


def area(r):
    return PI * r * r


class Circle:
    pass

class Calculator:
    def add(self, x, y):
        return x + y

    def sub(self, x, y):  # メソッド間は1行空ける
        return x - y

# NG
def handle():
    import json  # 原則は先頭に
    return json.loads("[]")

# OK
import json

def handle():
    return json.loads("[]")

"""サンプルモジュール(PEP8準拠の構造例)。"""

import math

# NG
import os, sys  # 並列表記は避ける

# OK
import os
import sys

# 推奨: 絶対import
from collections import defaultdict
import myproject.utils.string_ops as string_ops

# 妥当なケース: 明示的相対import(パッケージ内部)
from . import util  # 現在のパッケージから
from ..core import models  # 1つ上のパッケージから

# NG
from math import *

# OK
from math import sqrt, pi

"""importの順序と空行の例。"""

# 1. 標準ライブラリ
import os
from pathlib import Path

# 2. サードパーティ
import requests

# 3. 自作(ローカル)モジュール
from myapp.config import settings
from myapp.core.services import service

# NG: 不要な別名は読みにくい
import numpy as n

# OK: 名前衝突や慣習的な短縮だけ
import numpy as np  # 慣習的に広く使われる
from urllib.parse import urlparse as parse_url  # 意図が伝わる

"""PEP8に沿ったモジュール構成のサンプル。"""

# 標準ライブラリ
from pathlib import Path
import sys

# サードパーティ
# (例示のみ。インストールされていない環境では使わない)
# import requests

# 自作
# from myapp.utils import read_text

PI = 3.14159  # 定数は全大文字

def area(r):  # スネークケースの関数名
    """円の面積を返す。"""
    return PI * (r ** 2)

class Circle:  # パスカルケースのクラス名
    def __init__(self, r):
        self._r = r  # 非公開属性は先頭にアンダースコア

    def area(self):
        return area(self._r)

def main():  # スクリプトのエントリポイント
    c = Circle(2)
    print(f"area = {c.area()}")  # キーワード引数の=は空白なし

if __name__ == "__main__":
    sys.exit(main())