標準のコーディング規約:PEP 8

Pythonの標準のコーディング規約として、PEP8(ペップ・エイト)が定義されている。
日本語訳は、こちら 。
Pythonにおけるスタイルガイドで、変数や関数名の付け方、空白に関する内容や、インデントの仕方、コメントの書き方など様々な基本的なルールを定義したものである。
PEPは、Python Enhancement Proposalの略である。
PEP8は、本来は、標準ライブラリの Python のコードを書くためのコーディング規約である。
コーディング規約に従うことにより、コードの可読性の向上が図れ、他のPythonプログラムが理解しやすくなり、コードの変更作業が簡単になるというメリットがある。

また、ガイドラインに準拠しているかどうかチェックするツールがあり、Pythonでは、pep8 というコマンドを使うことにより、明らかな文法の誤りを検出するだけでなく、不要な import 文など無駄なコードも検出も可能である。

pep8に関しては、原文もしくは、日本語訳を参照するのがよいですが、下記の記事も理解の参考となると思います。
【Python】コードの記述方法(コーディング規約:PEP8)

 

以下、基本的なことで理解したことを記載する。
。コーディング規約とは、プログラミングをする時(コーディングをする時)、言プログラマたちが順守した方がよいコードの記述規則(ルール)である。
・PEP8は、必ず従わなければいけないものではない。プロジェクトとか組織で独自の規則があれば、それを優先する。
・一番重要なのは、特定のモジュールや関数の中で一貫性を保つことである。
・インデントにはタブではなく空白を使うこと、そしてインデントに4個の空白を使うこと。
・括弧を使いブロックを明示した場合は、文を複数行にわたって記載できる。
その方法は、
1)インデントを開始区切り文字に合わせる
2)開始区切り文字の直後に改行を行い、1つインデントを加える
・コードの1行の長さは79文字以下にする
・コードの可読性を上げるために空白行を入れる
・入演算子や比較演算子、ブール値(and、or、not)の前後には1つのスペースを入れる
・開始記号の直後や終了記号の直前にスペースは入れない
・カンマ・コロン・セミコロンの直前にはスペースは入れず直後にスペースを入れる
・スライスの場合は前後にスペースを入れない
・if not a is bではなく、if a is not bを使用する
・空値かどうかを確認する際に、シーケンス(リストや文字列など)の長さではなく、Falseであるかで確認する
・式がブール値のTrueまたはFalseかを確認するときに比較演算子(==)は使用しない
import文は、スクリプトの先頭に記入する
・import文の順番は次の流れで記載し、グループで分ける
1.標準ライブラリ
2.サードパーティー
3.自作したモジュール
それぞれのグループは1行の空行を入れる。またグループの中でも、アルファベット順に記載する
・1つのimport文には、一つのライブラリのみを記載する
・モジュールの絶対名でインポートする
・小文字、大文字、アンダーバーで構成した名前とする
・1文字目に数字は使えない
・アンダーバー(アンダースコア)以外の半角記号は使用できない
・予約語(andやbreakなど)は使えない
・クラスと例外の名前は、単語の先頭を大文字にして繋げる方式(CapitalizedWords)とする、_は使用しない
・Pythonのパッケージとモジュールにはすべて小文字の短い名前にする
・関数と変数の名前は、すべて小文字にする、またはすべて小文字にして単語をアンダーバーで繋げる

以上

 

コメントを残す

メールアドレスが公開されることはありません。 が付いている欄は必須項目です

このサイトはスパムを低減するために Akismet を使っています。コメントデータの処理方法の詳細はこちらをご覧ください

Python

前の記事

The Zen of Python