学习 python 编写规范 pep8 的问题笔记，pythonpep8,决定开始Python

学习 python 编写规范 pep8 的问题笔记，pythonpep8,决定开始Python

决定开始Python之路了，利用业余时间，争取更深入学习Python。编程语言不是艺术，而是工作或者说是工具，所以整理并遵循一套编码规范是十分必要的。所以今天下午我根据PEP 8整理了一份，以后都照此编码了，还会持续更新。

PEP8 Python 编码规范

一 代码编排
1 缩进。4个空格的缩进（编辑器都可以完成此功能），不使用Tap，更不能混合使用Tap和空格。
2 每行最大长度79，换行可以使用反斜杠，最好使用圆括号。换行点要在操作符的后边敲回车。
3 类和top-level函数定义之间空两行；类中的方法定义之间空一行；函数内逻辑无关段落之间空一行；其他地方尽量不要再空行。

二 文档编排
1 模块内容的顺序：模块说明和docstring—import—globals&constants—其他定义。其中import部分，又按标准、三方和自己编写顺序依次排放，之间空一行。
2 不要在一句import中多个库，比如import os, sys不推荐。
3 如果采用from XX import XX引用库，可以省略‘module.’，都是可能出现命名冲突，这时就要采用import XX。

三 空格的使用
总体原则，避免不必要的空格。
1 各种右括号前不要加空格。
2 逗号、冒号、分号前不要加空格。
3 函数的左括号前不要加空格。如Func(1)。
4 序列的左括号前不要加空格。如list[2]。
5 操作符左右各加一个空格，不要为了对齐增加空格。
6 函数默认参数使用的赋值符左右省略空格。
7 不要将多句语句写在同一行，尽管使用‘；’允许。
8 if/for/while语句中，即使执行语句只有一句，也必须另起一行。

四 注释
总体原则，错误的注释不如没有注释。所以当一段代码发生变化时，第一件事就是要修改注释！
注释必须使用英文，最好是完整的句子，首字母大写，句后要有结束符，结束符后跟两个空格，开始下一句。如果是短语，可以省略结束符。
1 块注释，在一段代码前增加的注释。在‘#’后加一空格。段落之间以只有‘#’的行间隔。比如：
# Description : Module config.
#
# Input : None
#
# Output : None
2 行注释，在一句代码后加注释。比如：x = x + 1# Increment x
但是这种方式尽量少使用。
3 避免无谓的注释。

五 文档描述
1 为所有的共有模块、函数、类、方法写docstrings；非共有的没有必要，但是可以写注释（在def的下一行）。
2 如果docstring要换行，参考如下例子,详见PEP 257
"""Return a foobang

Optional plotz says to frobnicate the bizbaz first.

"""

六 命名规范
总体原则，新编代码必须按下面命名风格进行，现有库的编码尽量保持风格。
1 尽量单独使用小写字母‘l’，大写字母‘O’等容易混淆的字母。
2 模块命名尽量短小，使用全部小写的方式，可以使用下划线。
3 包命名尽量短小，使用全部小写的方式，不可以使用下划线。
4 类的命名使用CapWords的方式，模块内部使用的类采用_CapWords的方式。
5 异常命名使用CapWords+Error后缀的方式。
6 全局变量尽量只在模块内有效，类似C语言中的static。实现方法有两种，一是__all__机制;二是前缀一个下划线。
7 函数命名使用全部小写的方式，可以使用下划线。
8 常量命名使用全部大写的方式，可以使用下划线。
9 类的属性（方法和变量）命名使用全部小写的方式，可以使用下划线。
9 类的属性有3种作用域public、non-public和subclass API，可以理解成C++中的public、private、protected，non-public属性前，前缀一条下划线。
11 类的属性若与关键字名字冲突，后缀一下划线，尽量不要使用缩略等其他方式。
12 为避免与子类属性命名冲突，在类的一些属性前，前缀两条下划线。比如：类Foo中声明__a,访问时，只能通过Foo._Foo__a，避免歧义。如果子类也叫Foo，那就无能为力了。
13 类的方法第一个参数必须是self，而静态方法第一个参数必须是cls。

七 编码建议
1 编码中考虑到其他python实现的效率等问题，比如运算符‘+’在CPython（Python）中效率很高，都是Jython中却非常低，所以应该采用.join()的方式。
2 尽可能使用‘is’‘is not’取代‘==’，比如if x is not None 要优于if x。
3 使用基于类的异常，每个模块或包都有自己的异常类，此异常类继承自Exception。
4 异常中不要使用裸露的except，except后跟具体的exceptions。
5 异常中try的代码尽可能少。比如：
try:
value = collection[key]
except KeyError:
return key_not_found(key)
else:
return handle_value(value)
要优于
try:
# Too broad!
return handle_value(collection[key])
except KeyError:
# Will also catch KeyError raised by handle_value()
return key_not_found(key)
6 使用startswith() and endswith()代替切片进行序列前缀或后缀的检查。比如：
Yes: if foo.startswith(‘bar‘):优于
No: if foo[:3] == ‘bar‘:
7 使用isinstance()比较对象的类型。比如
Yes: if isinstance(obj, int): 优于
No: if type(obj) is type(1):
8 判断序列空或不空，有如下规则
Yes: if not seq:
if seq:
优于
No: if len(seq)
if not len(seq)
9 字符串不要以空格收尾。
10 二进制数据判断使用 if boolvalue的方式。

code	sample message
E1	Indentation
E101	indentation contains mixed spaces and tabs
E111	indentation is not a multiple of four
E112	expected an indented block
E113	unexpected indentation
E114	indentation is not a multiple of four (comment)
E115	expected an indented block (comment)
E116	unexpected indentation (comment)
E121 (*^)	continuation line under-indented for hanging indent
E122 (^)	continuation line missing indentation or outdented
E123 (*)	closing bracket does not match indentation of opening bracket’s line
E124 (^)	closing bracket does not match visual indentation
E125 (^)	continuation line with same indent as next logical line
E126 (*^)	continuation line over-indented for hanging indent
E127 (^)	continuation line over-indented for visual indent
E128 (^)	continuation line under-indented for visual indent
E129 (^)	visually indented line with same indent as next logical line
E131 (^)	continuation line unaligned for hanging indent
E133 (*)	closing bracket is missing indentation
E2	Whitespace
E201	whitespace after ‘(‘
E202	whitespace before ‘)’
E203	whitespace before ‘:’
E211	whitespace before ‘(‘
E221	multiple spaces before operator
E222	multiple spaces after operator
E223	tab before operator
E224	tab after operator
E225	missing whitespace around operator
E226 (*)	missing whitespace around arithmetic operator
E227	missing whitespace around bitwise or shift operator
E228	missing whitespace around modulo operator
E231	missing whitespace after ‘,’, ‘;’, or ‘:’
E241 (*)	multiple spaces after ‘,’
E242 (*)	tab after ‘,’
E251	unexpected spaces around keyword / parameter equals
E261	at least two spaces before inline comment
E262	inline comment should start with ‘# ‘
E265	block comment should start with ‘# ‘
E266	too many leading ‘#’ for block comment
E271	multiple spaces after keyword
E272	multiple spaces before keyword
E273	tab after keyword
E274	tab before keyword
E275	missing whitespace after keyword
E3	Blank line
E301	expected 1 blank line, found 0
E302	expected 2 blank lines, found 0
E303	too many blank lines (3)
E304	blank lines found after function decorator
E305	expected 2 blank lines after end of function or class
E4	Import
E401	multiple imports on one line
E402	module level import not at top of file
E5	Line length
E501 (^)	line too long (82 > 79 characters)
E502	the backslash is redundant between brackets
E7	Statement
E701	multiple statements on one line (colon)
E702	multiple statements on one line (semicolon)
E703	statement ends with a semicolon
E704 (*)	multiple statements on one line (def)
E711 (^)	comparison to None should be ‘if cond is None:’
E712 (^)	comparison to True should be ‘if cond is True:’ or ‘if cond:’
E713	test for membership should be ‘not in’
E714	test for object identity should be ‘is not’
E721 (^)	do not compare types, use ‘isinstance()’
E731	do not assign a lambda expression, use a def
E741	do not use variables named ‘l’, ‘O’, or ‘I’
E742	do not define classes named ‘l’, ‘O’, or ‘I’
E743	do not define functions named ‘l’, ‘O’, or ‘I’
E9	Runtime
E901	SyntaxError or IndentationError
E902	IOError
W1	Indentation warning
W191	indentation contains tabs
W2	Whitespace warning
W291	trailing whitespace
W292	no newline at end of file
W293	blank line contains whitespace
W3	Blank line warning
W391	blank line at end of file
W5	Line break warning
W503 (*)	line break occurred before a binary operator
W6	Deprecation warning
W601	.has_key() is deprecated, use ‘in’
W602	deprecated form of raising exception
W603	‘<>’ is deprecated, use ‘!=’
W604	backticks are deprecated, use ‘repr()’

学习 python 编写规范 pep8 的问题笔记