note.nkmk.me

Python PEP8スタイルガイドの命名規則

Date: 2016-12-07 / tags: Python
スポンサーリンク

PEP8とは

PEPはPython Enhanthment Proposal(Python拡張提案)の略で、Pythonの新機能などを説明するドキュメント。

PEP stands for Python Enhancement Proposal. A PEP is a design document providing information to the Python community, or describing a new feature for Python or its processes or environment.
PEP 1 -- PEP Purpose and Guidelines | Python.org

PEPはPython拡張提案(Python Enhancement Proposal)を表しています。PEPはPythonのコミュニティに対して情報を提供したり、Pythonの新機能やプロセス、環境などを説明するための設計書です。
Python Enhancement Proposal: 1

公式はこちら。

日本語訳されてるもののまとめもある。

PEP8はその8番目で、「Style Guide for Python Code」、Pythonのスタイルガイドについて書かれている。

重要だけど忘れがちな、命名規則について書いておく。

PEP8命名規則

  • 関数、変数、属性
    • lowercase_underscore
    • 小文字 + アンダースコア
  • プロテクテッド属性
    • _leading_underscore
    • 先頭にアンダースコア
  • プライベート属性
    • __double_underscore
    • 先頭にアンダースコア2つ
  • クラスと例外
    • CapitalizedWords (CamelCase)
    • 単語の頭文字を大文字、アンダースコアなし
  • モジュールレベルの定数
    • ALL_CAPS
    • 大文字 + アンダースコア
  • クラスのインスタンスメソッドの第1引数
    • self
  • クラスメソッドの第1引数
    • cls
スポンサーリンク
シェア
このエントリーをはてなブックマークに追加

関連カテゴリー

関連記事