Python常用PEP8编码规范和建议经验分享

EXAMPLE:
# Have to define the param `args(List)`,
# otherwise will be capture the CLI option when execute `python manage.py server`.
# oslo_config: (args if args is not None else sys.argv[1:])
CONF(args=[], default_config_files=[CONFIG_FILE])

单行注释(应避免无谓的注释)

EXAMPLE:
x = x + 1 # Compensate for border

文档字符串

EXAMPLE:
# 多行文档, 首行首字母大写，结尾的 """ 应该单独成行
"""Return a foobang
Optional plotz says to frobnicate the bizbaz first.
"""

# 单行的文档， 结尾的 """ 在同一行。
"""Return a foobang"""

命名规则

包和模块名:
包和模块名应该简短，全部用小写字母, 多字母之间可以使用单下划线连接。

类名:
遵循驼峰命名

class MyClass(object):
pass

全局变量名:
全局变量名应尽量只在模块内部使用, 对可能使用语句 from moduleName import variableName 而被导入的模块，应采用 __all__ 机制来防止全局变量被别的模块导入, 或者在全局变量名开头加一个前置下划线.

EXAMPLE:
name = 'name'

函数名
函数名应该为全部小写的凹驼峰规则。

EXAMPLE:
vcenter_connection = ''

常量名
常量全部使用大写字母的凹驼峰规则来表示, 通常在模块顶格定义

EXAMPLE:
MAX_OVERFLOW = ''
TOTAL = 1

方法名和实例变量
非公开方法和实例变量开头使用前置下划线
有时候可能会为了避免与子类命名冲突，采用两个前置下划线
需要注意的是: 若 class Foo 的属性名为 __a， 该属性是不能以 Foo.__a 的方式访问的(执著的用户还是可以通过Foo._Foo__a 来访问), 所以通常双前置下划线仅被用来避免与基类的属性发生命名冲突。

编程建议

None 的比较用 is 或 is not，而不要用 ==

用 is not 代替 not … is, 前者的可读性更好

EXAMPLE:
# Yes
if foo is not None

# No
if not foo is None

使用函数定义关键字 def 代替 lambda 赋值给标识符, 这样更适合于回调和字符串表示
# Yes
def f(x):
return 2*x

# No
f = lambda x: 2*x

异常类应该继承自Exception，而不是 BaseException

Python 2 中用raise ValueError('message') 代替 raise ValueError, 'message'

(考虑兼容python3和续行的方便性)

捕获异常时尽量指明具体异常, 尽量不用 except Exception, 应该捕获 出了什么问题，而不是 问题发生

EXAMPLE:
# Yes (捕获具体异常)
try:
import platform_specific_module
except ImportError:
platform_specific_module = None

# No (不要全局捕获)
try:
import platform_specific_module
except:
platform_specific_module = None

try/except 子句中的代码要尽可能的少, 以免屏蔽掉其他的错误

EXAMPLE:
# Yes
try:
value = collection[key]
except KeyError:
return key_not_found(key)
else:
return handle_value(value)

# No
try:
return handle_value(collection[key])
except KeyError:
# 可能会捕捉到 handle_value()中的 KeyError, 而不是 collection 的
return key_not_found(key)

函数或者方法在没有返回值时要明确返回 None
# Yes
def foo():
return None

# No
def foo():
return

使用字符串方法而不是 string 模块
python 2.0 以后字符串方法总是更快，而且与 Unicode 字符串使用了相同的 API

使用使用 .startswith() 和 .endswith() 代替字符串切片来检查前缀和后缀
startswith() 和 endswith 更简洁，利于减少错误

EXAMPLE:
# Yes
if foo.startswith('bar'):

# No
if foo[:3] == 'bar':

使用 isinstance() 代替对象类型的比较

EXAMPLE:
# Yes
if isinstance(obj, int):

# No
if type(obj) is type(1):

空序列类型对象的 bool 为 False:
# Yes
if not seq:
pass
if seq:
pass

# No
if len(seq):
pass
if not len(seq):
pass

不要用 == 进行 bool 比较
# Yes
if greeting:
pass

# No
if greeting == True
pass
if greeting is True: # Worse
pass