執筆者：Handbook編集部
Pythonのコーディング規約PEP8とは
PEP8 とは
PEP8 とは、Python のコーディング規約です。複数人で開発するときに、それぞれどのような書き方をするかは人それぞれ好みがあります。
その中で、お互いにコードを書いて開発を進めると次のようなことが起こります。
- 自分と違う書き方のため、コードのレビューに時間がかかる
- コードの書き方がバラバラなため、修正が大変
チームで開発を効率よくするために、一定コードの書き方にルールを設け、このような問題を回避しようというのが、コーディング規約のモチベーションになります。
PEP8 とは、Python 公式のコーディング規約になります。以下が公式のドキュメントになります。
PEP8 の代表的なルール
「一貫性にこだわりすぎるのは、狭い心の現れである」
PEP8 のドキュメントの冒頭に書いてあるメッセージが「A Foolish Consistency is the Hobgoblin of Little Minds （一貫性にこだわりすぎるのは、狭い心の現れである）」です。
この話は、公式ドキュメントを詳しくみて欲しいのですが、スタイルガイドに合わせることは重要ですが、コードの中で一貫性を保つことはもっと重要と主張したうえで、ガイドラインを時には無視して書くことを許容しています。
ガイドラインに従って書くと読みにくくなったり、ガイドラインが出てくる前に書かれたものなどで、準拠させること以外にコードの変更をする必要がない場合には、無視してもよいと主張しています。
この手のコーディング規約は、宗教戦争になりがちな部分かと思いますが、一貫性にこだわりすぎず、本来コーディング規約を統一して得たかった便益を享受することが大事だとも言えます。
PEP8 のルール
詳しくは公式ドキュメントを見てもらいたいですが、以下代表的な部分を取り上げます。
-
インデント
- スペース 4 つ
-
タブ or スペース
- スペースが望ましい
-
1 行の長さ
- 79 文字以下
-
2 項演算子の前と後のどちらで改行するか
- 前で改行する
-
空行
- 関数やクラスは 2 行ずつ空ける
- クラス内部は 1 行ずつ空けてメソッドを定義する
-
import
-
import文は異なるライブラリから取得するときは、行を分ける
-
標準ライブラリ、サードパーティに関連するもの、ローカル特有なものでそれぞれグループ化しておくこと
-
ワイルドカードを使ったimportは避けるこ
と
-
命名規則
- CamelCase や snake_case は混合しないようにしましょう
- 良い例
- SomeClass : クラス定義
- some_function : 関数
- some_variable : 変数
- SOME_VARIABLE : グローバル変数や定数
- 悪い例
- Some_Class
- some_Function
- sample_CODE
PEP8 のライブラリの使い方
上記で取り上げた以外にも、多くのガイドがありますが、覚えられないと思います。そのようなときは、コードのフォーマットを整えてくれる PEP8 というライブラリがあります。
インストール
$ pip install pep8
ソースコードのチェック
以下のような形で利用することができます。
# コードスタイルをチェック
$ pep8 <file-path>
# ソースコードも表示
$ pep8 <file-path> --show-source
参考
Hakky ではエンジニアを募集中です！まずは話してみたいなどでも構いませんので、ぜひお気軽に採用ページからお問い合わせくださいませ。
