Pythonのコーディング規約

投稿日：

機械学習のためにPythonを勉強し直しているときの覚書。

コーディング規約は公式サイトのPEP8を参照

初回は日本語訳ドキュメントで理解して、確認するときは公式英語版を参照する。


自分用まとめ

  • UTF-8（BOMなし）= UTF-8N
  • インデントはスペース４つ
  • 一行は79文字まで
  • 改行する場合は演算子の前で
  • トップレベルの関数間は2行空ける。クラス内のメソッド間は1行空ける。
  • 引用符に規定なし。単語はシングルクォーテーション、文章はダブルクォーテーションにすることにした。
    参考： coding style - Single quotes vs. double quotes in Python - Stack Overflow
  • 関数名と変数名は小文字のsnake_case
  • クラス名はPascalCase(UpperCamelCase)。メソッド名は関数と同じsnake_case。privateな場合は先頭にアンダースコアを付ける
    PHPとJavaScriptをやっているとメソッド名はcamelCaseにしたくなる…
    参考： Pythonのloggingライブラリは、なぜcamelCaseなのか？ - Qiita
  • 定数は全大文字のアンダースコア区切り


VS CodeにPythonプラグインをインストールすればPEPに準拠してくれる。
下記マイクロソフトのサイトはHello WorldからVS Code上でデバッグするやり方をチュートリアル形式で細かく解説してくれていて分かりやすい。


【関連記事】