说说Python编码规范

前言

        已有近两个月没有发表过文章了，前段时间外甥和女儿过来这边渡暑假，平常晚上和周末时间都陪着她们了，趁这个周末有空，再抽空再把这块拾起来。
         这么久没写了，再次拿起键盘，想想，发表些什么呢，想起上次公司的代码评审委员会下周其中一个议题是关于Python编码规范的整理，那就趁热打铁，整理一份关于Python编码规范的文章，也为那些写Python的人，提供一些编码注意的一些事项或者说是参考吧。

编码规范的作用

        规范故明思义，就是通过不断的总结，吸取好的点，从而形成的一份大家共同需要遵守的行为契约，
网上有很多版本的编码规范，基本上都是遵循 PEP8 的规范。那么什么是PEP8呢？
        PEP是 Python Enhancement Proposal 的缩写，简单来说，是python增强建议书的意思。它描述了Python编程风格的方方面面。在遵守这个文档的条件下，不同程序员编写的Python代码可以保持最大程度的相似风格。
这样就易于阅读，易于在程序员之间交流。

下面就说说Python编码时，应该遵守的编码规范有哪些。

编码需遵守的规范

编码

• 所有的 Python 脚本文件都应在文件头标上如下标识或其兼容格式的标识： # -- coding:utf-8 --

分号

• 不要在行尾加分号, 也不要用分号将两条命令放在同一行。

换行

• 常规下，每一行代码控制在 80 字符以内

• 以下情况除外：

• 长的导入模块语句

• 注释里的URL

• 使用 \ 或 () 控制换行，举例：

    def foo(first, second, third, fourth, fifth,
            sixth, and_some_other_very_long_param):
        user = User.objects.filter_by(first=first, second=second, third=third) \
            .skip(100).limit(100) \
            .all()
  
    text = ('Long strings can be made up ''of several shorter strings.')

   

  如果行长到连第一个括号内的参数都放不下，则每个元素都单独占一行：

• 折叠长行的首选方法是使用Python支持的圆括号、方括号(brackets)和花括号(braces)内的行延续。但是有时也可以适当使用反斜杠 \ 。

括号

• 宁缺毋滥的使用括号

• 除非是用于实现行连接, 否则不要在返回语句或条件语句中使用括号. 不过在元组两边使用括号是可以的.

    推荐: if foo:
             bar()while x:
             x = bar()if x and y:
             bar()if not x:
             bar()return foo         for (x, y) in dict.items(): ..
    不推荐:  if (x):
             bar()if not(x):
             bar()return (foo)

缩进

• 用4个空格来缩进代码

• 绝对不要用tab, 也不要tab和空格混用，否则容易出现 IndentationError

• 使用任何编辑器写 Python，请把一个 tab 展开为 4 个空格

空行

• 顶级定义之间空两行, 比如函数或者类定义. 方法定义, 类定义与第一个方法之间, 都应该空一行. 函数或方法中, 某些地方要是你觉得合适, 就空一行.

• function 和 class 顶上两个空行

• class 的 method 之间一个空行

• 函数内逻辑无关的段落之间空一行，不要过度使用空行

• 不要把多个语句写在一行，然后用 ; 隔开

• if/for/while 语句中，即使执行语句只有一句，也要另起一行

• 在类、函数的定义间加空行；

• 在import不同种类的模块间加空行；

• 在函数中的逻辑段落间加空行，即把相关的代码紧凑写在一起，作为一个逻辑段落，段落间以空行分隔；

空格

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

• 各种右括号前不要加空格。

• 函数的左括号前不要加空格。如Func(1)。

• 序列的左括号前不要加空格。如list[2]。

• 操作符左右各加一个空格，不要为了对齐增加空格。

• 函数默认参数使用的赋值符左右省略空格。

• 不要将多句语句写在同一行，尽管使用‘；’允许。

• if/for/while语句中，即使执行语句只有一句，也必须另起一行。

• 在二元算术、逻辑运算符前后加空格如：a = b + c

• 在 list, dict, tuple, set, 参数列表的 , 后面加一个空格

• 在 dict 的 : 后面加一个空格

• 在注释符号 # 后面加一个空格，但是 #!/usr/bin/python 的 # 后不能有空格

• 操作符两端加一个空格，如 +, -, *, /, |, &, =

• 接上一条，在参数列表里的 = 两端不需要空格

• 括号（(), {}, []）内的两端不需要空格

• 括号内不要有空格.

• 不要在逗号, 分号, 冒号前面加空格, 但应该在它们后面加(除了在行尾).

    推荐: if x == 4:print x, y
         x, y = y, x
    不推荐:  if x == 4 :print x , y
     x , y = y , x

 

• 在二元操作符两边都加上一个空格, 比如赋值(=), 比较(==, <, >, !=, <>, <=, >=, in, not in, is, is not), 布尔(and, or, not). 至于算术操作符两边的空格该如何使用, 需要你自己好好判断. 不过两侧务必要保持一致.

    推荐: x == 1
    不推荐:  x<1

 

• 当’=’用于指示关键字参数或默认参数值时, 不要在其两侧使用空格.

    推荐: def complex(real, imag=0.0): return magic(r=real, i=imag)
    不推荐:  def complex(real, imag = 0.0): return magic(r = real, i = imag)

   

• 不要用空格来垂直对齐多行间的标记, 因为这会成为维护的负担(适用于:, #, =等):

    推荐:
         foo = 1000  # 注释
         long_name = 2  # 注释不需要对齐

         dictionary = {"foo": 1,"long_name": 2,}
    不推荐:
         foo       = 1000  # 注释
         long_name = 2     # 注释不需要对齐

         dictionary = {"foo"      : 1,"long_name": 2,}

 

Shebang

• 大部分.py文件不必以#!作为文件的开始

• 程序的main文件应该以 #!/usr/bin/python2或者 #!/usr/bin/python3开始.

 

补充知识： 此处解释一下何为Shebang,Shebang就是
是一个由井号和叹号构成的字符串行(#!), 其出现在文本文件的第一行的前两个字符. 在文件中存在Shebang的情况下,
类Unix操作系统的程序载入器会分析Shebang后的内容, 将这些内容作为解释器指令, 并调用该指令,
并将载有Shebang的文件路径作为该解释器的参数. 例如, 以指令#!/bin/sh开头的文件在执行时会实际调用/bin/sh程序.)#!先用于帮助内核找到Python解释器, 但是在导入模块时, 将会被忽略. 因此只有被直接执行的文件中才有必要加入#!

注释

• 为了提高可读性, 块注释和行注释注释应该至少离开代码2个空格.

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

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

   

• 行注释，在一句代码后加注释。比如：x = x + 1            # Increment x

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

• 如果docstring要换行

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

   

• 文档字符串 docstring, 是 package, module, class, method, function 级别的注释，可以通过doc 成员访问到，注释内容在一对 “”” 符号之间

• function, method 的文档字符串应当描述其功能、输入参数、返回值，如果有复杂的算法和实现，也需要写清楚

• 优先使用英文写注释，英文不好全部写中文，否则更加看不懂

• 注释块：注释块通常应用于跟随其后的一些 (或者全部) 代码，并和这些代码有着相同的缩进 层次。注释块中每行以 ‘#’ 和一个空格开始 (除非它是注释内的缩进文本)。
  注释块内的段落以仅含单个 ‘#’ 的行分割

• 行内注释：一个行内注释是和语句在同一行的注释。行内注释应该至少用两个空格和语句分开。 它们应该以一个 ‘#’ 和单个空格开始。

异常

• 不要轻易使用 try/except

• except 后面需要指定捕捉的异常，裸露的 except 会捕捉所有异常，意味着会隐藏潜在的问题

• 可以有多个 except 语句，捕捉多种异常，分别做异常处理

• 使用 finally 子句来处理一些收尾操作

• try/except 里的内容不要太多，只在可能抛出异常的地方使用

• 从 Exception 而不是 BaseException 继承自定义的异常类

Class（类）

• 使用 super 调用父类的方法

• 支持多继承，即同时有多个父类，建议使用 Mixin

• 如果一个类不继承自其它类, 就显式的从object继承. 嵌套类也一样.

推荐: 
    class SampleClass(object):
        pass
    class OuterClass(object):
        pass
    class InnerClass(object):
        pass

    class ChildClass(ParentClass):
    """Explicitly inherits from another class already."""
        pass
    不推荐: 
    class SampleClass:
        pass
    class OuterClass:
        pass   
    class InnerClass:
        pass

 

这是继承自 object 是为了使属性(properties)正常工作, 并且这样可以保护你的代码, 使其不受Python 3000的一个特殊的潜在不兼容性影响. 这样做也定义了一些特殊的方法, 这些方法实现了对象的默认语义, 包括 new, init, delattr, getattribute, setattr, hash, repr, and str .

引号

• 在同一个文件中, 保持使用字符串引号的一致性. 使用单引号’或者双引号”之一用以引用字符串, 并在同一文件中沿用. 在字符串内可以使用另外一种引号,

• 为多行字符串使用三重双引号”””而非三重单引号’’’. 当且仅当项目中使用单引号’来引用字符串时, 才可能会使用三重’’’为非文档字符串的多行字符串来标识引用. 文档字符串必须使用三重双引号”””. 不过要注意, 通常用隐式行连接更清晰, 因为多行字符串与程序其他部分的缩进方式不一致.

文件和sockets

• 在文件和sockets结束时, 显式的关闭它.

• 推荐使用 “with”语句 以管理文件:

   with open("hello.txt") as hello_file:     
       for line in hello_file:         
           print line    

   

• 对于不支持使用”with”语句的类似文件的对象,使用 contextlib.closing():

    import contextlib  with contextlib.closing(urllib.urlopen("http://www.python.org/")) as front_page:      
      for line in front_page:         
           print line    

   

TODO注释

• TODO注释应该在所有开头处包含”TODO”字符串, 紧跟着是用括号括起来的你的名字, email地址或其它标识符. 然后是一个可选的冒号. 接着必须有一行注释, 解释要做什么

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

import导入格式

• • • • 每个导入应该独占一行

          推荐: import os       
        　　　　import sys
        

        　　from flask import Flask, render_template, jsonify

        不推荐: import os, sys 
        

         

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

• 标准库导入

• 第三方库导入

• 应用程序指定导入

• 所有 import 尽量放在文件开头，在 docstring 下面，其他变量定义的上面

• 不要使用 from foo imort *

• 为了避免可能出现的命名冲突，可以使用 as 或导入上一级命名空间

• 不要出现循环导入(cyclic import)

命名

命名参考形式：
module_name, package_name, ClassName, method_name, ExceptionName, function_name, GLOBAL_VAR_NAME, instance_var_name, function_parameter_name, local_var_name.

• 应该避免的名称

• 单字符名称, 除了计数器和迭代器.

• 包/模块名中的连字符(-)

• 双下划线开头并结尾的名称(Python保留, 例如init)

• 命名约定

• 所谓”内部(Internal)”表示仅模块内可用, 或者, 在类内是保护或私有的.

• 用单下划线(_)开头表示模块变量或函数是protected的(使用import * from时不会包含).

• 用双下划线(__)开头的实例变量或方法表示类内私有.

• 将相关的类和顶级函数放在同一个模块里. 不像Java, 没必要限制一个类一个模块.

• 对类名使用大写字母开头的单词(如CapWords, 即Pascal风格), 但是模块名应该用小写加下划线的方式(如lower_with_under.py). 尽管已经有很多现存的模块使用类似于CapWords.py这样的命名, 但现在已经不鼓励这样做, 因为如果模块名碰巧和类名一致, 这会让人困扰.

• 尽量单独使用小写字母‘l’，大写字母‘O’等容易混淆的字母。

• 模块命名尽量短小，使用全部小写的方式，可以使用下划线。

• 包命名尽量短小，使用全部小写的方式。

• 类的命名使用CapWords的方式，模块内部使用的类采用_CapWords的方式。

• 异常命名使用CapWords+Error后缀的方式。

• 全局变量尽量只在模块内有效，类似C语言中的static。实现方法有两种，一是all机制;二是前缀一个下划线。

• 函数命名使用全部小写的方式，可以使用下划线。

• 常量命名使用全部大写的方式，可以使用下划线。

• 类的属性（方法和变量）命名使用全部小写的方式，可以使用下划线。

• 类的属性有3种作用域public、non-public和subclass API，可以理解成C++中的public、private、protected，non-public属性前，前缀一条下划线。

• 类的属性若与关键字名字冲突，后缀一下划线，尽量不要使用缩略等其他方式。

• 为避免与子类属性命名冲突，在类的一些属性前，前缀两条下划线。比如：类Foo中声明a,访问时，只能通过Foo._Fooa，避免歧义。如果子类也叫Foo，那就无能为力了。

• 类的方法第一个参数必须是self，而静态方法第一个参数必须是cls。

• 使用有意义的，英文单词或词组，绝对不要使用汉语拼音

• package/module 名中不要出现 -

Main方法

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

字符串

• 使用字符串的 join 方法拼接字符串

• 使用字符串类型的方法，而不是 string 模块的方法

• 使用 startswith 和 endswith 方法比较前缀和后缀

• 使用 format 方法格式化字符串

比较

• 空的 list, str, tuple, set, dict 和 0, 0.0, None 都是 False

• 使用 if some_list 而不是 if len(some_list) 判断某个 list 是否为空，其他类型同理

• 使用 is 和 is not 与单例（如 None）进行比较，而不是用 == 和 !=

• 使用 if a is not None 而不是 if not a is None

• 用 isinstance 而不是 type 判断类型

• 不要用 == 和 != 与 True 和 False 比较（除非有特殊情况，如在 sqlalchemy 中可能用到）

• 使用 in 操作：

• 用 key in dict 而不是 dict.has_key()

    不推荐 if d.has_key(k):
    do_something()
  
    推荐 if key in d:
    do_something()

   

• 用 set 加速 “存在性” 检查，list 的查找是线性的，复杂度 O(n)，set 底层是 hash table, 复杂度 O(1)，但用 set 需要比 list 更多内存空间

代码编排

• 缩进。4个空格的缩进（编辑器都可以完成此功能），不使用Tap，更不能混合使用Tap和空格。

• 每行最大长度79，换行可以使用反斜杠，最好使用圆括号。换行点要在操作符的后边敲回车。

• 类和top-level函数定义之间空两行；类中的方法定义之间空一行；函数内逻辑无关段落之间空一行；其他地方尽量不要再空行。

文档编排

• 模块内容的顺序：模块说明和docstring—import—globals&constants—其他定义。其中import部分，又按标准、三方和自己编写顺序依次排放，之间空一行。

• 不要在一句import中多个库，比如import os, sys不推荐。

• 如果采用from XX import XX引用库，可以省略‘module.’，都是可能出现命名冲突，这时就要采用import XX

编码建议

• 编码中考虑到其他python实现的效率等问题，比如运算符‘+’在CPython（Python）中效率很高，都是Jython中却非常低，所以应该采用.join()的方式。

• 尽可能使用‘is’‘is not’取代‘==’，比如if x is not None 要优于if x。

• 使用基于类的异常，每个模块或包都有自己的异常类，此异常类继承自Exception。

• 异常中不要使用裸露的except，except后跟具体的exceptions。

• 异常中try的代码尽可能少。

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

  推荐:  if foo.startswith('bar'):
  不推荐:  if foo[:3] == 'bar':

   

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

  推荐:  if isinstance(obj, int): 优于
  不推荐:  if type(obj) is type(1):

   

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

  Yes:  if not seq:if seq:
  优于
  No:  if len(seq)if not len(seq)

   

• 字符串不要以空格收尾。

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

• 使用列表表达式（list comprehension），字典表达式(dict comprehension, Python 2.7+) 和生成器(generator)

• dict 的 get 方法可以指定默认值，但有些时候应该用 [] 操作，使得可以抛出 KeyError

• 使用 for item in list 迭代 list, for index, item in enumerate(list) 迭代 list 并获取下标

• 使用内建函数 sorted 和 list.sort 进行排序

• 适量使用 map, reduce, filter 和 lambda，使用内建的 all, any 处理多个条件的判断

• 使用装饰器(decorator)

• 使用 with 语句处理上下文

• 使用 logging 记录日志，配置好格式和级别

• 阅读优秀的开源代码，如 Flask 框架, Requests

• 不要重复造轮子，查看标准库、PyPi、Github、Google 等使用现有的优秀的解决

 

 

好了，时间也不早了，今天就到此为止吧，如果觉得本文对你有点用的话，就邀请身边的人关注起吧~

公众号为:mikezhou_talk