Pythonコーディングスタイルガイド：PEP 8の重要ポイント徹底解説

本記事では、Pythonプロジェクトで守るべき標準的なコーディングスタイルガイドについて解説します。統一されたスタイルガイドに従うことで、チームメンバー全員が同じペースで開発を進められるようになり、コード全体の一貫性とプロフェッショナルな品質が保たれます。

Pythonでは、多くの開発者がPEP 8と呼ばれる公式スタイルガイドを採用しています。PEP 8に従うことで、コードは美しく整然とし、可読性が大幅に向上します。本記事では、その中から特に実践で役立つルールを厳選して紹介します。

インデントにはタブ（または統一されたスペース）を使う

コードのインデントにはタブを使用しましょう。関数やメソッドごとにスペースの数がバラバラになると、コードの可読性が大きく損なわれます。多くのコードエディタでは、設定画面からタブに対応するスペースの数（一般的には4）を指定できます。

# 例
def sample(random):
    # ステートメント1
    # ステートメント2
    # ...
    return random

エンコーディングはUTF-8またはASCIIが基本

国際的な環境で開発する場合は、PythonのデフォルトであるUTF-8またはASCIIエンコーディングを使用するのがベストプラクティスです。これにより、異なる環境間での文字化けや互換性の問題を防ぐことができます。

タプルの末尾カンマ

タプルの要素の末尾にカンマを付けるのも良い習慣のひとつです。必須ではありませんが、後から要素を追加しやすくなるというメリットがあります。

# 例
tup = (1, 2, 3,)

docstring（ドキュメンテーション文字列）を活用する

関数やクラスにはdocstringを記述しましょう。docstringは三重引用符（"""）で囲んで表現します。以下に例を示します。

def sample():
    """これは関数です"""
    """
    このように
    複数行にわたる
    説明も可能です
    """

class Sample:
    """これはクラスです"""
    """
    このように
    複数行にわたる
    説明も可能です
    """

1行は79文字以内に収める

PEP 8では、1行あたり79文字以内に収めることが推奨されています。長い式は行継続文字（\）や括弧を使って複数行に分割しましょう。以下の例をご覧ください。

# 例
def evaluate(a, b, c, d):
    return (2 ** (a + b) / (c // d) ** d + a - d * b) \
        - (3 ** (a + b) / (c // d) ** d + a - d * b)

演算子の前後にはスペースを入れる

演算子の前後にスペースを入れるのは、最も基本的なベストプラクティスのひとつです。また、カンマの後にもスペースを入れることで、さらに読みやすいコードになります。

# 例
import random

result = random.randint(1, 3) + random.randint(1, 2)

変数・定数・クラス・関数の命名規則

変数、定数、クラス、関数の命名は、プログラム全体を通して同じ規則に統一しましょう。Pythonの開発者の多くは、関数や変数にはsnake_case（スネークケース）、クラス名にはPascalCase（パスカルケース）を使います。定数はすべて大文字にし、単語の区切りにはアンダースコアを使用します（例：PI_TWO）。

• snake_case → this_is_function
• PascalCase → ThisIsClass
• CONSTANT → THIS_IS_CONSTANT

モジュールは1行につき1つだけインポートする

構文的には正しくても、1行で複数のモジュールをインポートするのは避けましょう。1行につき1つのモジュールをインポートするのがPEP 8の推奨スタイルです。

# 悪い例
import math, random

# 良い例
import math
import random

コメントを常に最新の状態に保つ

コメントは常に最新の状態に保ちましょう。コードを修正した際には、対応するコメントも忘れずに更新します。これはコーディングにおいて非常に重要なポイントでありながら、意外と見落とされがちです。ぜひ日頃から意識しておきましょう。

単独で変数名として使うべきでない文字

大文字の「I」と小文字の「l」は、数字の「1」や他のローマ字と視覚的に紛らわしいため、単独で変数名として使用しないようにしましょう。誤読によるバグを防ぐためにも、これらの文字の単独使用は避けるのが賢明です。

識別子にはASCII文字のみを使用する

PEP 8では、変数名や関数名などの識別子にはASCII文字のみを使用することが推奨されています。日本語などの非ASCII文字を識別子に含めると、環境によっては正常に動作しなかったり、他の開発者がコードを扱いにくくなったりするため、避けるようにしましょう。