🍬python for office
👉 本开源项目的交流群 👈
Python 风格指南 - 内容目录
Google Python开源项目风格十分流行,我把其中自己关注的内容摘抄如下。
如需查看原手册:传送门
Python语言规范
- Lint
- 使用pylint检查python代码
- 导入
- 使用
import x
来导入包和模块. - 使用
from x import y
, 其中x是包前缀, y是不带前缀的模块名. - 使用
from x import y as z
, 如果两个要导入的模块都叫做y或者y太长了. - 仅当缩写
z
是通用缩写时才可使用import y as z
.(比如np
代表numpy
.)
- 使用
- 包
- 所有的新代码都应该用完整包名来导入每个模块.
- 异常
- 永远不要使用
except:
语句来捕获所有异常, 也不要捕获Exception
或者StandardError
, 除非你打算重新触发该异常, 或者你已经在当前线程的最外层(记得还是要打印一条错误消息). 在异常这方面, Python非常宽容,except:
真的会捕获包括Python语法错误在内的任何错误. 使用except:
很容易隐藏真正的bug.
- 永远不要使用
- 全局变量
- 避免使用全局变量. 鼓励使用模块级的常量。
- 注意常量命名必须全部大写,用
_
分隔.具体参见 命名规则
- 函数与方法装饰器
- 线程
- 威力过大的特性
- 现代python: python3 和from future imports
- 代码类型注释
Python风格规范
- 分号
- 行长度
- 括号
- 缩进
- 序列元素尾部逗号
- 空行
- 空格
- Shebang
- 注释
- 标点符号,拼写和语法
- 类
- 字符串
- 文件和sockets
- TODO注释
- 导入格式
- 语句
- 访问控制
- 命名
- Main
- 函数长度
- 类型注释
临别赠言