python

コーディングのコツ【python】

Pythonには公式で定めた PEP8 というコーディングスタイルがあり、これに準拠して書くと良いとされています。ここでは公式チュートリアル コーディングスタイル を参考にいくつか紹介します。

インデント

インデントにはスペース4つを利用し、タブは使わない。

ソースコードの一行が長くなりすぎないようにする。
→ PEP 8には1行を79文字以下にするようにと書いてあります。

関数やクラスの大きめのコードブロックの区切りに空行を使う。

 

出来る限りコメントは行に独立で書く。

docstringを使う。

命名法

演算子の前後とコンマの後には空白を入れ、括弧類の前後に空白を入れない (ex. a = f(1, 2) + g(3, 4) ) 。

クラスや関数に一貫性のある名前をつける。

  • クラス名にはキャメルケースを使う (単語の境界を大文字で区別する) => HogeHogeClass。
  • 関数名にはスネークケースを使う (単語の境界を _ で区別する) => fuga_fuga_function。

ソースコードの文字コードにはUTF-8 もしくは ASCII エンコーディングを利用する。

識別子に利用する文字列は半角英数とし、日本語のような非ASCII文字は利用しない。
これらのコーディングスタイルをチェックするようなプログラムなども開発されており

コーディングスタイルチェック

ソースコードのコーディングスタイルチェック
pycodestyle

ドキュメントのコーディングスタイルチェック
pydocstyle