pyhton自动化项目编码以及命名规范

对于任何一个编程项目来说，都需要一个编码的规范以及标准，这里整理了一些Google python的命名规范以及python语言PEP8的编码规范。

一、命名规范

命名示例：

module_name, 模块
package_name, 包
ClassName, 类
method_name, 方法
ExceptionName, 异常
function_name, 函数
GLOBAL_VAR_NAME, 全局变量
instance_var_name, 实例
function_parameter_name, 参数
local_var_name. 本变量

类

总是使用首字母大写单词串。如MyClass。内部类可以使用额外的前导下划线。

函数&方法

小写+下划线
注意：混合大小写仅被允许用于这种风格已经占据优势的时候，以便保持向后兼容。

函数和方法的参数如果一个函数的参数名称和保留的关键字冲突，通常使用一个后缀下划线。

全局变量对于from M import *导入语句，如果想阻止导入模块内的全局变量可以使用旧有的规范，在全局变量上加一个前导的下划线。注意:应避免使用全局变量。

变量

小写，由下划线连接各个单词。如color = WHITE，this_is_a_variable = 1
注意：
1.不论是类成员变量还是全局变量，均不使用 m 或 g 前缀。
2.私有类成员使用单一下划线前缀标识。
3.变量名不应带有类型信息，因为Python是动态类型语言。如 iValue、names_list、dict_obj 等都是不好的命名。

常量

常量名所有字母大写，由下划线连接各个单词如MAX_OVERFLOW，TOTAL。

异常

以“Error”作为后缀。

文件名

全小写,可使用下划线

包

应该是简短的、小写的名字。如果下划线可以改善可读性可以加入。如mypackage。

模块

与包的规范同。如mymodule。

缩写

命名应当尽量使用全拼写的单词，缩写的情况有如下两种：
1.常用的缩写，如XML、ID等，在命名时也应只大写首字母，如XmlParser。
2.命名中含有长单词，对某个单词进行缩写。这时应使用约定成俗的缩写方式。
例如：
function 缩写为 fn text 缩写为 txt object 缩写为 obj count 缩写为 cnt number 缩写为 num，等。

前导后缀下划线

一个前导下划线：表示非公有。
一个后缀下划线：避免关键字冲突。
两个前导下划线：当命名一个类属性引起名称冲突时使用。
两个前导和后缀下划线：“魔”（有特殊用图）对象或者属性，例如__init__或者__file__。绝对不要创造这样的名字，而只是使用它们。
注意：关于下划线的使用存在一些争议。

特定命名方式

主要是指 xxx 形式的系统保留字命名法。项目中也可以使用这种命名，它的意义在于这种形式的变量是只读的，这种形式的类成员函数尽量不要重载。
如:

 class Base(object):

 	def init(self, id, parent = None):

 		self.id = id

 		self.parent = parent 

 	def message(self, msgid):

 		pass

其中 id、parent 和 message 都采用了系统保留字命名法。

二、PEP8 Python编码规范

关于pep8 python的编码规范，一般在ide中书写python代码时，都会有类似下划线这样的格式不规范提示，写代码时也要经常注意尽量不要出现不规范的书写格式。

2.1 代码编排

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

2.2 文档编排

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

2.3空格的使用

总体原则，避免不必要的空格。

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

2.3 注释

总体原则，错误的注释不如没有注释。所以当一段代码发生变化时，第一件事就是要修改注释！
注释必须使用英文，最好是完整的句子，首字母大写，句后要有结束符，结束符后跟两个空格，开始下一句。如果是短语，可以省略结束符。

块注释，在一段代码前增加的注释。在‘#’后加一空格。段落之间以只有‘#’的行间隔。比如：

# Description : Module config.

#

# Input : None

#

# Output : None

行注释，在一句代码后加注释。比如：

x = x + 1 # Increment x

是这种方式尽量少使用。

避免无谓的注释。

2.5 文档描述

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

"""

Return a foobang

Optional plotz says to frobnicate the bizbaz first.

"""

2.6 命名规范

总体原则，新编代码必须按下面命名风格进行，现有库的编码尽量保持风格。

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

2.7编码建议

编码中考虑到其他python实现的效率等问题，比如运算符‘+’在CPython（Python）中效率很高，都是Jython中却非常低，所以应该采用.join()的方式。
尽可能使用‘is’‘is not’取代‘==’，比如if x is not None 要优于if x。
使用基于类的异常，每个模块或包都有自己的异常类，此异常类继承自Exception。
异常中不要使用裸露的except，except后跟具体的exceptions。
异常中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)

使用startswith() and endswith()代替切片进行序列前缀或后缀的检查。比如

if foo.startswith(‘bar’):

优于

if foo[:3] == ‘bar’:

使用isinstance()比较对象的类型。
比如

if isinstance(obj, int):

优于

if type(obj) is type(1):

判断序列空或不空，有如下规则

if not seq:

if seq:

优于

if len(seq)

if not len(seq)

字符串不要以空格收尾。
二进制数据判断使用 if boolvalue的方式。

转自：https://blog.csdn.net/CCGGAAG/article/details/90059723