python风格指南¶
前言¶
本文包含代码风格、Python特性使用、面对不同问题的最佳解决方案三大块内容
代码风格是指编写代码过程当中的排版布局的问题，主要是PEP8当中的一些内容，针对PEP8我自己加了一些认为自己需要注意的点进去
Python特性使用是指对于写Python的过程当中
代码风格¶
空行¶
- 模块顶级元素（类、函数）之间空两行
- 类中的方法之间空一行
- 其他认为有必要空行以分割逻辑块的地方空一行，不对对于逻辑快的区分优先使用函数解构的方法去做
导入¶
- 引用层次依次为标准库的引用>第三方库的引用>项目内引用，不同引用层次之间空一行以表示区隔
- 一般情况下不使用
from module import *的写法 - 仅在引用核心模块的时候使用
from module import something的写法，对于非核心模块，均使用import module - 可以在要引用的模块名过长的时候使用
import module as mod这样的写法
换行¶
- 可以通过首个元素就换行来解决对齐问题
Shebang¶
Shebang亦即 #! ，只有被直接执行的文件才有必要加入
行长度¶
除了导入模块的语句，每行代码不超过80个字符
长表达式¶
- 对于调用链使用如下的拆分方案
pagination = db.session.query(Vocabulary).\ filter_by(user_id=user_id, is_remember=False).\ paginate(page, per_page=20, error_out=False)
- 对于多参数使用如下的拆分方案
new_word = Vocabulary( user_id=request_content['user_id'], word=request_content['word'], word_explain=request_content['explain'] )
注释¶
- 函数或方法的docstring
- 类的docstring
- 块注释
- 行注释：不要使用行注释，全部用块注释代替，#后面要加空格
命名¶
- 对于不希望外部使用的模块变量或函数使用单下划线（使用
import * from的时候不会被包含） - 不要使用双下划线
- 对于模块名使用小写加下划线的方式
Main¶
所有的可执行代码都应该使用 if __name__=='__main__' 来包含可执行代码块，防止其被导入的时候产生副作用
引号¶
使用单引号而非双引号
功能使用¶
异常¶
- 异常的触发必须使用这种形式：
raise MyException("Error message")或者raise MyException - 模块和包定义自己的异常基类的时候应用从内建的Exception类继承（这个我暂时还用不上）
- 如非必要，永远不要使用
except或者except Exception这种来捕获所有的异常，前者比后者更加难以容忍，甚至会捕获KeyboardInterrupt - try块中的语句要尽量小，只包含你想要捕获异常的语句
- 使用finally子句来执行哪些无论try快中有没有异常都应该被执行的代码
- 异常的使用规范
我选择前者，更多使用异常处理而非条件判断
列表推导¶
- 使用列表推导以代替map()和filter()
- 不要滥用列表推导，列表推掉的使用前提是使代码显得清晰明确，如果有双重循环或者列表推导的长度过长，那么就不要去使用列表推导，而是应当直接使用循环
生成器¶
- 对于要存储量大的数据，鼓励使用生成器（迭代器）
- 生成器的意义在于其惰性产出值从而节省内存，如果一个生成器对象包含一个列表作为属性的话，那么就没有什么意义了
特性（properties)¶
- 使用
@property装饰器来进行创建 - 代替java当中那种烦人的get和set方法，维护接口的统一性
- 可拓展性强，刚开始可以不使用特性，想用特性的时候又不会破坏原有的接口
函数参数¶
- 尽量不要在参数列表中加复杂的对象（尽量只加基础对象）
- 对于比较复杂的数据的情况，可以使用嵌套的元组、字典
- 永远不要修改修改或保存传入的数据，对于可变对象而言，一定要复制一个副本，而非在元对象的基础上做改变
文件命名¶
1. python相关的文件统一使用下划线进行命名 2.
