PEP8仕様
変数
# 常量:大写加下划线
USER_CONSTANT = "a constant"
# 私有变量 : 小写和一个前导下划线
"""
Python 中不存在私有变量一说,若是遇到需要保护的变量,使用小写和一个前导下划线。但这只是
程序员之间的一个约定,用于警告说明这是一个私有变量,外部类不要去访问它。但实际上,外部类还
是可以访问到这个变量。
"""
_private_value = "my private value"
# 内置变量 : 小写,两个前导下划线和两个后置下划线
"""
两个前导下划线会导致变量在解释期间被更名。这是为了避免内置变量和其他变量产生冲突。用户
定义的变量要严格避免这种风格。以免导致混乱
"""
__class__ = "inner value"
関数とメソッド
一般的に、あなたは使用する必要があります下ケースとアンダースコアを。しかし、大文字と小文字を使用して一部の古いライブラリは、それは資産の各単語の最初の文字、残りを小文字に続いて、最初の単語を小文字です。しかし、今、小文字とアンダースコアは常識となっています
プライベートメソッド:下部ケースと大手はアンダー
こことプライベート変数は、本当にプライベートなアクセスではありません。また、(2アンダースコアに直面したとき、Pythonの名前マングリング特性が役割を果たします)一般的に2つの先頭のアンダースコア機能を使用しないことに留意すべきです。
特別な方法:下と2つの大手は2つの後は、アンダースコアアンダースコア
だけな演算子のオーバーロードなどの特別な機能に適用されるこのスタイルを。
関数パラメータ:下部ケースとアンダー、等号のデフォルトの両側のスペースなし
def my_function(para_one, para_two):
pass
class MyTest(object):
__instance = None # 私有类属性
def _private_method(self): # 私有方法
pass
def __new__(self): # 特殊方法
pass
カテゴリ
常にラクダという名前のクラスの形式を使用する最初の文字のすべての残りの部分は、言葉に小文字を大文字に、つまり、。クラス名は、簡潔、正確で行われた仕事からクラスを理解するのに十分なものでなければなりません。1つの一般的な方法は、例えば、タイプまたは特性を示す接尾辞を使用することです。
SQLEngine
、MimeTypes
ベース・クラスのために、あなたは基本抽象またはプレフィックスを使用することができBaseCookie
、AbstractGroup
モジュールやパッケージ
特別なモジュールに加えて、__init__
モジュール名外のすべての小文字には下線が引かれていません。
彼らは合意を達成した場合は、libには、通常のような、接尾辞として使用します:
import smtplib
import os
import sys
パラメータについて
- 静的型チェックを実装するためにアサーションを使用しないでください。アサーションは、パラメータをチェックするために使用するだけでなく、静的な型チェックすることができます。Pythonは動的言語、その設計に反しをチェック静的な型を入力されます。アサーションは、関数は無意味ではないの呼び出しを避けるために使用されるべきです。
- 乱用しないでください
*args
と**kwargs
。*args
そして、**kwargs
パラメータは、機能の堅牢性を損なうことがあります。彼らは署名をぼかし、およびコードは、多くの場合であってはならない場所に小さなパラメータパーサの構築を開始します。
他の
# 使用 has 或 is 前缀命名布尔元素
is_connect = True
has_member = False
# 用复数形式命名序列
members = ['user_1', 'user_2']
# 用显式名称命名字典
person_address = {'user_1': '10 road WD', 'user_2': '20 street huafu'}
# 避免通用名称
诸如 list, dict, sequence 或者 element 这样的名称应该避免
# 避免现有名称
诸如 os, sys 这种系统已经存在的名称应该避免
一部の図
数のランク:PEP 8は、79のように定義されます。自分の状況に応じて、このような全画面表示エディタの数を超えません。
機能:表示画面内符号のない30以上の行クラス、全体垂直カーソル機能を参照するために使用されなくてもよいです。
クラス:コードのない200の以上の行は、10以上の方法を持っていません。モジュールは、500行を超えてはなりません。
検証スクリプト
あなたはあなたのコードのスタイルはPEP8を満たして検証するために使用されるpep8スクリプトをインストールすることができます