1. 代码风格

python社区有一套成文的代码规范,就是有名的pep 8规范.而google也有一套成文的风格规范,他们都很不错,但更加推荐使用pep8标准,并且在一些细节上使用google的规范.当然了,python的代码风格并不是强制性的,只是使用这套规则会更加便于团队合作.是否使用还是看使用者个人

1.1. 代码编排

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

1.2. 文档编排

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

1.3. 空格的使用

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

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

1.4. 注释

总体原则，错误的注释不如没有注释。所以当一段代码发生变化时，第一件事就是要修改注释！

注释必须使用英文，最好是完整的句子，首字母大写，句后要有结束符，结束符后跟两个空格，开始下一句。如果是短语，可以省略结束符。

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

    # Description : Module config.  #   # Input : None  #  # Output : None 

2. 行注释，在一句代码后加注释。比如：x = x + 1 # Increment x 但是这种方式尽量少使用。

3. 避免无谓的注释。

1.5. 文档描述

1. 为所有的共有模块、函数、类、方法写docstrings；非共有的没有必要，但是可以写注释（在def的下一行）。

2. 如果docstring要换行，参考如下例子,详见PEP 257

    """Return a foobang   Optional plotz says to frobnicate the bizbaz first.   """ 

1.6. Shebang

大部分.py文件不必以#!作为文件的开始. 根据 PEP-394 , 程序的main文件应该以#!/usr/bin/python2或者 #!/usr/bin/python3开始.但其实更好的方式是使用#! /usr/bin/env/python2或者 #!/usr/bin/env python3

在计算机科学中, Shebang (也称为Hashbang)是一个由井号和叹号构成的字符串行(#!), 其出现在文本文件的第一行的前两个字符. 在文件中存在Shebang的情况下, 类Unix操作系统的程序载入器会分析Shebang后的内容, 将这些内容作为解释器指令, 并调用该指令, 并将载有Shebang的文件路径作为该解释器的参数. 例如, 以指令#!/bin/sh开头的文件在执行时会实际调用/bin/sh程序.

#!先用于帮助内核找到Python解释器, 但是在导入模块时, 将会被忽略. 因此只有被直接执行的文件中才有必要加入#!.

1.7. TODO注释

为临时代码使用TODO注释, 它是一种短期解决方案. 不算完美, 但够好了.

TODO注释应该在所有开头处包含TODO字符串, 紧跟着是用括号括起来的你的名字, email地址或其它标识符. 然后是一个可选的冒号. 接着必须有一行注释, 解释要做什么. 主要目的是为了有一个统一的TODO格式, 这样添加注释的人就可以搜索到(并可以按需提供更多细节). 写了TODO注释并不保证写的人会亲自解决问题. 当你写了一个TODO, 请注上你的名字.

# TODO([email protected]): Use a "*" here for string repetition. # TODO(Zeke) Change this to use relations. 

如果你的TODO是”将来做某事”的形式, 那么请确保你包含了一个指定的日期(“2009年11月解决”)或者一个特定的事件(“等到所有的客户都可以处理XML请求就移除这些代码”).

1.8. 命名规范

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

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

1.9. 编码建议

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()代替切片进行序列前缀或后缀的检查。比如：

    if foo.startswith('bar'): 

   优于

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

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

    if isinstance(obj, int): 

   优于

    if type(obj) is type(1): 

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

    if not seq:      pass  if seq:      pass 

   优于

    """Return a foobang   Optional plotz says to frobnicate the bizbaz first.   """ 0

9. 字符串不要以空格收尾。

10. 二进制数据判断使用if boolvalue的方式。

1.10. 导入格式

每个导入应该独占一行 Yes:

 """Return a foobang   Optional plotz says to frobnicate the bizbaz first.   """ 1

No:

 """Return a foobang   Optional plotz says to frobnicate the bizbaz first.   """ 2

导入总应该放在文件顶部, 位于模块注释和文档字符串之后, 模块全局变量和常量之前. 导入应该按照从最通用到最不通用的顺序分组:

1. 标准库导入
2. 第三方库导入
3. 应用程序指定导入

每种分组中, 应该根据每个模块的完整包路径按字典序排序, 忽略大小写.

 """Return a foobang   Optional plotz says to frobnicate the bizbaz first.   """ 3

1.11. Main

即使是一个打算被用作脚本的文件, 也应该是可导入的. 并且简单的导入不应该导致这个脚本的主功能(main functionality)被执行, 这是一种副作用. 主功能应该放在一个main()函数中. 在Python中, pydoc以及单元测试要求模块必须是可导入的. 你的代码应该在执行主程序前总是检查 if__name__ == '__main__' , 这样当模块被导入时主程序就不会被执行.

 """Return a foobang   Optional plotz says to frobnicate the bizbaz first.   """ 4

所有的顶级代码在模块导入时都会被执行. 要小心不要去调用函数, 创建对象, 或者执行那些不应该在使用pydoc时执行的操作.

1.12. 代码美化

要完全符合规范是很作孽繁琐的一件事,我们同样可以使用工具简化这个工作,这就是autopep8.

安装:

 """Return a foobang   Optional plotz says to frobnicate the bizbaz first.   """ 5

如果使用atom的话则可以安装Atom Beautify插件,它的python代码美化也是基于autopep8的.

如果使用的svcode的话可以安装官方插件python,然后插件会自动提醒安装需要的美化工具.