python是一种简单精炼的脚本语言。对比其他语言而言,python可以使用相对较少的单词,写出一段合适的代码。但是我们在写python代码时,仍然需要我们能保持代码的可读性以及整洁性,下面这段变成语言的基本准则对你会有很多帮助。
这篇文章只是一篇指导性文章,能让你写出更有效的更pythonic的代码,如果你想了解更多,可以阅读 The Hitchhiker's Guide to Python 这本书,或者前往PEP8 Style Guide
通用的编程指南
一、缩进
对于缩进你可以使用tab键,或者space键,但是不要把两个混在一起用。python3里面,建议使用space,通常是以4个space为标准。下面以一个list为例子说明,以下两种形式都允许使用
上面这个例子告诉你,你既可以把闭括号写在行首,也可以用4个空格键进行缩进。
下面以两端代码,进行比较:
Bad example
Good example
二、一行一句话
Bad
Good
这个原则同样适用于包的引用
Bad practice
Good practice
请把import语句放在版权信息和文档注释下面。引入顺序最好是,标准库,第三方库,特殊的库引用,每一行引用上面最好也要有注释,增加代码可读性
三、每一行的字符长度
四、不要写含义不明的代码
python虽然可以使用一些技巧,但是代码不是写给你自己看的,为了他人的生命着想,不要写含义不明的代码,例如:
Bad
Good
五、命名规则
在命名模块、类、方法或函数、变量上,有很多变异的方式。包括含有或者不含有下划线的大小写字母等等,虽然方式不一,但是也可以从这些发展变异里面找到一丝统一。如下
你可以选择其中一种命名方式,并且在你的代码里面保持一种风格,不要太跳。根据PEP8,有如下规则你需要遵守:
标识符的名称必须与ASCII兼容
模块命名需要简短、且全为小写
类首字母大写
异常也是首字母大写,并且含有error
常量全为大写
当然,你可以使用工具帮你检查代码风格,例如工具pycodestyle