Python 命名規則

Pythonでコードを書く時の、推奨されている命名規則に説明します。ここでは、Pythonにおいてもっとも主要なPEP8というコーディング規約の命名規則にしたがって記載しています。

PEP8 命名規則


 対象規則
変数名、引数小文字のみ。単語をアンダースコアで繋げる。user_name
定数大文字のみ。単語をアンダースコアで繋げる。FILE_NAME
クラスCapWords 方式。単語の頭だけ大文字で繋げる。UserBaseClass
例外CapWords 方式。単語の頭だけ大文字で繋げる。AttributeError
型変数CapWords 方式。単語の頭だけ大文字で繋げる。AnyStr
関数名小文字のみ。単語をアンダースコアで繋げる。update_name()
メソッド小文字のみ。単語をアンダースコアで繋げる。update_name()
モジュール小文字のみ。単語をアンダースコアで繋げる。os
パッケージ小文字のみ。アンダースコアは使わない。tqdm
非公開属性アンダースコアを先頭につける。_update_name()

from tqdm import tqdm_notebook # tqdmはパッケージ名
import os # osはモジュール名
import sql_update

FILE_PATH = 'home/test.csv' # FILE_PATHは定数

class WorkerBase: # WorkerBaseがクラス名
    def __init__(self, first_name, family_name): # first_nameが変数名
        self.user_name = first_name + family_name
        
    def _update_user_name(self): # _update_user_nameが非公開のメソッド
        sql_update(self.user_name)


for i in tqdm_notebook(range(10)):
  print(i) #print() は関数名

try:
    with open(FILE_PATH) as f:
        s = f.read()
except  FileNotFoundError: # FileNotFoundErrorはエラー
    print('ファイルがありません')

このエントリーをはてなブックマークに追加