萬九郎の硬い船

プログラミング学習記録など

Pythonの命名規約について知っておく

BeautifulSoupのドキュメントの中で、classがPython予約語であるためclass_という名前で代用する、というのが出てきたが、これはPythonのコーディング規約であるPEP8の中の

関数の引数名が予約語と衝突していた場合、アンダースコアを引数名の後ろに追加するのが一般的には望ましい

に準拠したものであるようだ。PEP8の「守るべき命名規約」から今の段階から気をつけられる項目を他にもいくつか抜き出しておく。

  • 単一の文字 ‘l’(小文字のエル)、’O’(大文字のオー)、’I’(大文字のアイ)を決して変数に使わないでください。
  • クラスの名前には通常CapWords方式を使うべきです。
  • 関数の名前は小文字のみにすべきです。また、読みやすくするために、必要に応じて単語をアンダースコアで区切るべきです。
  • インスタンスメソッドのはじめの引数の名前は常にselfを使ってください。
  • クラスメソッドのはじめの引数の名前は常にclsを使ってください。