この記事では、Python言語における変数、定数、関数、クラス、メソッドなどの命名規則(PEP-8 )についてソースコード付きで解説します。
命名規則とは
命名規則とは、コードを書く時の変数名や関数名の付け方などのルールです。
ネーミング規則やネーミング規約、命名規約などとも呼ばれます。
命名規則に沿ってコードを書くことで、読みやすい、理解しやすいコードを書くことができます。
Pythonでは、PEP-8と呼ばれる標準のコーディング規約があります。
今回は、その中で変数・関数・クラス・メソッドなどの命名規則をまとめてみました。
主な命名規則（PEP-8）
主な命名規則（PEP-8）を整理すると次の通りです。
| 種類 | 例 |
|---|---|
| 関数名 | def my_function(): |
| 変数名 | my_var = 1 |
| 定数名 | MY_CONSTANT = 3.14 |
| クラス名 | class MyClass(): |
| メソッド名 | def my_method(self) |
| インスタンス変数名： | self.my_var = 1 |
| モジュール名 | my_module |
| パッケージ名 | my_package |
| 例外名 | class My_Class(Exception): |
命名規則のポイントを整理すると次のようになります。
| ポイント | ポイントの説明 | 記述例 |
|---|---|---|
| 関数名・変数名・メソッド名, モジュール名・パッケージ名 | 全て小文字。複数の単語を使う場合は、単語の区切りにアンダースコア(_)を使います。 | my_function |
| インスタンス変数名 | 先頭に「self.」を付けます。全て小文字。複数の単語を使う場合は、単語の区切りにアンダースコア(_)を使います。 | self.my_var |
| 定数名 | 全て大文字。複数の単語を使う場合は、単語の区切りにアンダースコア(_)を使います。 | MY_CONSTANT |
| クラス名・例外名 | 大文字始まり。複数の単語を使う場合は、2番目以降の単語も大文字始まり。 | MyClass |
補足・・・他の命名規則など
PEP-8以外にも、Google Python Style GuideによるPythonの命名規約などがあります。
基本的にはPython標準のPEP-8に沿って書くのが良いと思います。
【Python超入門】使い方とサンプル集
Pythonの使い方について、基礎文法から応用例まで入門者向けに解説します。
python.joho.info
2024.06.18
コメント
定数名は「全て大文字」だと、My_CONSTANTはMY_CONSTANTでは？
※匿名様
いつもコメントありがとうございます。
誤記を修正いたしました。
My_Class ではなく MyClass です
※匿名様
ご指摘ありがとうございます。
2個目の表にMy_CONSTANTが残ってますね。
※匿名様
コメントありがとうございます。
該当箇所を修正しました。