Python编码规范小结

1.介绍

1.1 开发背景

为了提高组内自动化开发效率，避免重复开发，对组内各模块已开发的自动化lib 库、

case 中常用的操作、以及其他工具的调用接口进行汇总，管理出 dsqa 组内自动化 case 开发的基础库。

1.2 语言

基础库采用 python 开发。需要调用的相关二进制工具的地方，为降低开发成本，暂采用直接调该工具，封出 python 方法接口。

1.3 版本

Python 版本较多，为避免上下版本的兼容性问题，开发采用统一版本。

Python 2.6.2/2.7.x

1.4 规范文档

为了方便维护、他人阅读使用，整理出该编码规范文档。请大家开发时遵循本规范进行更开发。

本文档参考自Guido 的《Python 风格指南》一文. 并从《Barry's style guide》中添加了部分内容，以及我的个人建议。

2. 一致性的建议

整个项目的开发中，请尽量保持一致性，尤其是一个模块或者一个函数中的一致性更为重要。

因此存在这样的一个问题：由于不同模块的 lib 库开发人不同，编码规范也可能不同， 整合起来会显得不够“和谐”。还是希望各模块lib 库负责人做相应的修改，尽量“和谐”。

3. 代码的布局

3.1 缩进

众所周知，python 是通过缩进来进行代码布局的。使用vi 可以在~/.vimrc 中配置几个空格来代表一个tab，从而来布局 python 函数的缩进。

3.2 Tab 键还是空格

Python 里有一句叫“以用空格为荣，以用 tab 键为耻”。但全用空格时确实很麻烦。因此，这里不限定用tab 键还是空格。但记住：不可混用！

你可以选择全部使用 tab 键，这样也不会出错。

3.3 行的最大长度

类似于函数中的行注释、函数体等，如果某一行很长，则导致换行折叠观看，很影响美

观，而且还不利于阅读。因此，对顺序排放的的大块文本（文档字符串或注释），推荐长度限制在 72 个字节内。

推荐使用反斜杠续行。

3.4 空行

用两行分割顶层函数和类的定义。用一行分割类成员方法的定义。

在一个函数内使用空行时请注意谨慎使用于一个逻辑段。

3.5 编码

在 python 2.4 之后内核已经开始支持 Unicode 了。无论什么情况下，使用 UTF-8 才是王道！

#-*- coding:utf-8 -*-