geekdoc-python-zh/docs/py4b/python-style-guide.md

2.7 KiB
Raw Permalink Blame History

Python 风格规则

原文:https://www.pythonforbeginners.com/cheatsheet/python-style-guide

正如我在 Python 风格指南第 1 部分中所写的Google 已经整理了一份非常好的风格指南摘要。这份风格指南列出了 Python 程序的注意事项。

风格指南是关于一致性的。与本风格指南保持一致非常重要。项目内部的一致性更重要。一个模块或功能的一致性是最重要的。

PEP8 已经成为大多数项目的风格指南。它提倡一种可读性很强、赏心悦目的编码风格。PEP8 已经成为大多数项目的风格指南。它提倡一种可读性很强、赏心悦目的编码风格。这是 Python 社区中一个公认的约定,通常我们应该遵循这些约定。

页面可以在这里找到:http://Google-style guide . Google code . com/SVN/trunk/py guide . html

每个样式点都有一个摘要。

Python 风格规则

分号

不要用分号结束你的行,也不要用分号将两个命令放在同一行。

线长度

最大行长度为 80 个字符。

圆括号

少用括号。

刻痕

将代码块缩进 4 个空格。

空白行

顶层定义之间有两行空白,方法 定义之间有一行空白。

空白

遵循标点符号周围空格的标准印刷规则。

射浜线

大多数。py 文件不需要以#开头!线。

用#启动程序的主文件!/usr/bin/python。

评论

一定要为模块、函数、方法和行内注释使用正确的风格。

班级

如果一个类没有从其他基类继承,则显式从 object 继承。

这也适用于嵌套类。

用线串

对格式字符串使用%运算符,即使参数都是 字符串。

不过,用你最好的判断在+和%之间做出决定。

文件和套接字

使用完文件和套接字后,显式关闭它们。

待办事项注释

对于临时的、短期的解决方案或足够好但不完美的代码,使用 TODO 注释。

导入格式

导入应该在单独的行上。

声明

通常每行只有一条语句。

访问控制

如果一个访问函数很简单,你应该使用公共变量 而不是访问函数,以避免 Python 中函数调用的额外开销。

当添加更多功能时,您可以使用 property 来保持语法 的一致性。

命名

模块名,包名,类名,方法名,异常名, 函数名,全局常量名,全局变量名, 实例变量名,函数参数名,局部变量名。

主要的

即使是作为脚本使用的文件也应该是可导入的,一个简单的导入 不应该有执行脚本主要功能的副作用。

主要功能应该在 main()函数中。