PEP8的相关了解

什么是PEP8?

1、PEP8的介绍

PEP8是一个编程规范，内容是一些关于如何让你的程序更具可读性的建议。

2、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 尽量单独使用小写字母‘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

3、python(PEP8)代码常见警告

	PEP 8: module level import not at top of file
	解决：import不在文件的最上面，可能引用之前还有代码，把import引用放到文件的最上部就可以消除警告了。
	PEP 8: expected 2 blank lines，found 0
	解决：期望上面有2个空白行，发现0个，添加两个空白行就可以了。
	function name should be lowercase
	解决：函数名改成小写。
	PEP 8: indentation contains tabs
	解决：缩进中有tab空格，推荐用四个空格缩进。
	Indent expected
	解决：意思是没有缩进，解析器报错了，添加缩进就可以了。
	Unexpected indent
	解决：不期望的缩进，重新添加符合规范的缩进或者Alt+Enter快捷键会提示你转化成规范的缩进。
	PEP 8: missing whitespace around operator
	解决：意思是操作符（‘=’，‘<’等）前后丢失了空格，举个例子a=b会报警告，a = b正常。
	PEP 8: no newline at end of file
	解决：文件尾部没有新起一行，光标移到最后回车即可。
	PEP 8: blank line at end of file
	解决：文件最后多了一个空白行，只要有一个即可，删掉一个。
	Shadows name ‘xxx’ from outer scope
	解决：意思是‘xxx’在外部已经定义了，修改一下‘xxx’-> ‘uuu’或者其他符合要求的修改都可。
	PEP 8: block comment should start with ‘# ’
	解决：说的很清楚要以#加一个空格开始
	PEP 8: inline comment should start with ‘# ’
	解决：注释信息单独放一行
	PEP 8: multiple statements on one line (colon)
	解决：多行语句写到一行了，Python3.0好像不允许写到一行了，例如if x == 2: print(something)这样写就会有警告，必须要分两行。像下面这样
	if x == 2:
	print(something)
	Symplify chained comparision
	解决：警告的意思是可简化连锁比较，下面举个例子
	if a > 0 and a < 9 可修改为 if

4 Ubuntu 上出现PEP8的常见处理方式：

	快捷键：Ctrl+Alt+L  可以处理
	但是Ubuntu上刚开始用，快捷键没有修改的话，需要自己在Ubuntu上把原有的这个快捷键删除，b不然的话使用这个快捷键会优先使用系统的那个快捷键

5 如果想要深入了解的话，可以查看以下网址

----http://www.python.org/dev/peps/pep-0008