Pythonの命名規則(スネークケースとキャメルケース)

Python

はじめに

この記事では、Pythonの命名規則について説明します。

スネークケース (snake_case)

スネークケースは、Pythonで最も広く使用される命名規則です。単語をアンダースコア (_) で区切り、すべて小文字で記述します。

# スネークケースの例
user_name, calculate_total_price, my_module

スネークケースは主に変数名・関数名・モジュール名に使用します。(PEP8推奨)

スネークケースは単語の区切りが明確で、長い名前でも読みやすいためPythonプログラミングで広く一般的に用いられます。特にPEP8 (Pythonの公式スタイルガイド) が推奨しているため、標準ライブラリや多くのPythonプロジェクトでも使われています。

キャメルケース (CamelCase)

キャメルケースは、単語の区切りを大文字で表現します。

キャメルケースにはローワーキャメルケース(LCC)アッパーキャメルケース(UCC)の2種類があります。

ローワーキャメルケース (LCC)

LCCは、最初の単語のみ小文字で始め、他は大文字で始めます。

# LCCの例
userName, calculateTotalPrice, myModule

LCCはpythonではあまり用いられません。

最初の単語だけ小文字で始めるこのLCCは、JavaやJavaScriptなどの他の言語でよく使用されます。Pythonでも一部のプロジェクトでは使用されますが、一般的ではありません。

アッパーキャメルケース (UCC) / パスカルケース (PascalCase)

UCCは、すべての単語の最初の文字を大文字で記述します。これは「パスカルケース」とも呼ばれます。

# UCC(パスカルケース)の例
UserAccount, DataProcessor

UCC(パスカルケース)は主にクラス名に使用します。(PEP8推奨)

クラス名を定義する時にこのUCC (パスカルケース) をよく用いますが、呼び出されたインスタンスはスネークケースで命名することが多いです。( 例: user_account = UserAccount() )

一部のPythonプロジェクトでは定数名にUCCを使用することがありますが、後述のアッパースネークケースを使う方が一般的です。

アッパースネークケース (UPPER_SNAKE_CASE) / コンスタントケース (CONSTANT_CASE)

スネークケースの全てを大文字にしたバージョンです。

アッパースネークケースは主に定数に使用します。(PEP8推奨)

# アッパースネークケースの例
MAX_CONNECTIONS = 100
DEFAULT_TIMEOUT = 30
PI = 3.14159

グローバル定数や設定値、環境変数などによく用いられます。全部大文字で書かれているため目につきやすく、「値が変更されるべきでない」という定数の意図が明確になります。

まとめ

pythonの命名法についてまとめました。

大事なのは、コードの一貫性と可読性を保つことです。プロジェクト内で統一された命名規則を採用し、チーム内で合意形成をすることが重要です。コードリーディングを見据えて、可読性の高い変数名・関数名になるよう常に心がけましょう。

さらに学びたい方へ

Udemyの以下の動画が参考になりますので、ぜひこちらもご覧ください。

(Udemy動画は結構高いものもありますが、セールで80%OFFになったりもするので、セールのタイミングで一気に購入してしまうのがおすすめです)

コメント

タイトルとURLをコピーしました