Pythonの命名規則と具体例 | ファイル名や内部変数まで網羅

今回は、Pythonに関する命名規則についてご紹介します。

Python関連情報まとめ

Pythonの命名規則とは
Pythonの命名規則一覧
具体的な命名方法の例
命名の際によくある間違い
まとめ

Pythonの命名規則とは

Pythonの命名規則とは、ソースコード内のファイル名やクラス名、変数名などに共通のルールを設けることで、コードの可読性とメンテナンス性を高めるための指針です。

Pythonでは、公式スタイルガイド「PEP8」をはじめ、一般的に用いられる慣習が存在します。

ルールを統一し、誰が見ても分かりやすいコードに仕上げることが目的です。

Pythonの命名規則一覧

ここでは、Pythonにおける代表的な命名規則をまとめます。

ファイル名やパッケージ名、クラス名、関数名など、それぞれの項目で推奨されるスタイルが異なります。

いずれも一貫したスタイルを保つことが重要です。

ファイル名・モジュール名

すべて小文字で記述
単語同士をアンダースコア（_）でつなぐ

例：data_processor.py、utils.py、config_loader.py

パッケージ名

基本的に小文字
アンダースコアは必要に応じて使用
シンプルな名称が推奨される

例：mypackage、datautils、networking

クラス名

単語の先頭を大文字にする「CapWords（キャメルケース）」形式
不要なアンダースコアはつけない

例：UserProfile、DataAnalyzer、HttpRequestHandler

関数名・メソッド名

すべて小文字を使用
単語はアンダースコアで区切る（snake_case）

例：calculate_sum()、load_config()、process_input_data()

変数名

関数名と同様、snake_case を用いる
変数の用途が分かるよう、意味のある名称にする

例：user_count、total_price、error_message

定数

すべて大文字
単語間はアンダースコアで区切る

例：MAX_RETRIES、DEFAULT_TIMEOUT、API_ENDPOINT

特殊な命名規則

プライベート属性・メソッド：名前の先頭にアンダースコア（_）を付ける（例：_internal_method）
特殊メソッド（ダンダー）：両端にアンダースコア2つ（__）を付ける（例：__init__）
クラス変数：クラススコープで定義し、snake_case に従う
インスタンス変数：コンストラクタ内で self. を用いて定義し、snake_case を使用

具体的な命名方法の例

ここからは、実際にコード例を示しながら命名規則の活用方法を見てみます。

以下のサンプルコードでは、ファイル名をdata_processor.pyとし、クラス名や関数名に規則を適用しています。

class DataProcessor:
    # クラス変数
    default_format = "csv"

    def __init__(self, data_list):
        self.data_list = data_list

    def process_data(self):
        processed = []
        for item in self.data_list:
            processed_item = self._format_item(item)
            processed.append(processed_item)
        return processed

    def _format_item(self, item):
        return item.strip().lower()

def load_data_from_file(file_path):
    with open(file_path, "r") as f:
        return [line for line in f]

def main():
    file_path = "sample_data.txt"
    data = load_data_from_file(file_path)
    processor = DataProcessor(data)
    processed_data = processor.process_data()
    print(processed_data)

if __name__ == "__main__":
    main()

class DataProcessor:

# クラス変数

default_format = "csv"

def __init__(self, data_list):

self.data_list = data_list

def process_data(self):

processed = []

for item in self.data_list:

processed_item = self._format_item(item)

processed.append(processed_item)

return processed

def _format_item(self, item):

return item.strip().lower()

def load_data_from_file(file_path):

with open(file_path, "r") as f:

return [line for line in f]

def main():

file_path = "sample_data.txt"

data = load_data_from_file(file_path)

processor = DataProcessor(data)

processed_data = processor.process_data()

print(processed_data)

if __name__ == "__main__":

main()

このコードを「data_processor.py」というファイル名で保存し、実行すると、以下のような結果が得られます。

実行結果

[‘abc’, ‘def’, ‘ghi’]

命名の際によくある間違い

命名規則を守るつもりでも、ちょっとした思い違いで間違ったスタイルを使ってしまうケースがあります。

次のポイントに注意すると、より分かりやすいコードになります。

大文字・小文字の混在：ファイル名に大文字を入れてしまう
アンダースコア不足：snake_case で単語が判別しにくい
予約語の衝突：Pythonの組み込み関数と同じ名前を使わない
略語乱用：略語を多用すると可読性が低下

プロジェクト全体の規模が大きくなるほど、命名規則の徹底は非常に大切です。

まとめ

Pythonの命名規則を意識することで、可読性とメンテナンス性が向上します。

ファイル名からクラス名、変数名まで、スタイルガイドに従う一貫性がポイントです。

プロジェクト全体でルールを統一すると、コードベースの整理がより容易になります。