Google实践中总结的Python规范，get了吗？

好的代码风格，给人舒服的感觉，今天介绍一下谷歌的Python风格规范

1 分号

不要在行尾加分号, 也不要用分号将两条命令放在同一行。

2 行长度

每行不超过80个字符；不要使用反斜杠连接行。Python会将圆括号、中括号和花括号的行隐式的连接起来，可以利用这个特点。如果需要，可以在表达式外围增加一堆额外的圆括号。

3 括号

宁缺毋滥得使用括号。除非是用于实现行连接，否则不要在返回语句或条件语句中使用括号。不过在元组两遍使用括号是可以的。

4 缩进

用四个空格来缩进代码。绝对不要用tab，也不要tab和空格混用。对于行连接的情况，应该垂直对其换行的元素，或者使用4空格的悬挂式缩进：

5 空行

顶级定义（比如函数或者类定义）之间空两行，方法定义之间空一行。

6 空格

按照标准的排版规范来使用标点两边的空格。

括号内不要有空格。

不要在逗号，分号，冒号前面加空格，但应该在它们后面加（除了在行尾）。

参数列表, 索引或切片的左括号前不应加空格。

在二元操作符两边都加上一个空格, 比如赋值(=), 比较(==, <, >, !=, <>, <=, >=, in, not in, is, is not), 布尔(and, or, not)。至于算术操作符两边的空格该如何使用, 需要你自己好好判断。不过两侧务必要保持一致。

当’=’用于指示关键字参数或默认参数值时, 不要在其两侧使用空格。

不要用空格来垂直对齐多行间的标记， 因为这会成为维护的负担(适用于:, #, =等):

7 Shebang

大部分.py文件不必以#!作为文件的开始. 根据 PEP-394, 程序的main文件应该以 #!/usr/bin/python2或者 #!/usr/bin/python3开始。在计算机科学中，Shebang（也称为 Hashbang ）是一个由井号和叹号构成的字符序列 #! ，其出现在文本文件的第一行的前两个字符。在文件中存在 Shebang 的情况下，类 Unix 操作系统的程序载入器会分析 Shebang 后的内容，将这些内容作为解释器指令，并调用该指令，并将载有 Shebang 的文件路径作为该解释器的参数。

8 注释

确保对模块, 函数, 方法和行内注释使用正确的风格。

文档字符串

Python有一种独一无二的的注释方式：使用文档字符串。文档字符串是包， 模块， 类或函数里的第一个语句。这些字符串可以通过对象的doc成员被自动提取，并且被pydoc所用。我们对文档字符串的惯例是使用三重双引号。一个文档字符串应该这样组织：首先是一行以句号、问号或惊叹号结尾的概述(或者该文档字符串单纯只有一行)、 接着是一个空行， 接着是文档字符串剩下的部分，它应该与文档字符串的第一行的第一个引号对齐。下面有更多文档字符串的格式化规范。

模块

每个文件应该包含一个许可样板。根据项目使用的许可(例如：Apache 2.0,，BSD，LGPL， GPL)， 选择合适的样板。

函数和方法

一个函数必须要有文档字符串， 除非它满足以下条件：

文档字符串应该包含函数做什么，以及输入和输出的详细描述。通常， 不应该描述”怎么做”，除非是一些复杂的算法。文档字符串应该提供足够的信息， 当别人编写代码调用该函数时，他不需要看一行代码，只要看文档字符串就可以了。对于复杂的代码， 在代码旁边加注释会比使用文档字符串更有意义。

类

类应该在其定义下有一个用于描述该类的文档字符串。如果你的类有公共属性(Attributes)，那么文档中应该有一个属性(Attributes)段。并且应该遵守和函数参数相同的格式。

块注释和行注释

最需要写注释的是代码中那些技巧性的部分。如果你在下次 代码审查的时候必须解释一下，那么你应该现在就给它写注释。对于复杂的操作， 应该在其操作开始前写上若干行注释。对于不是一目了然的代码，应在其行尾添加注释。

9 类

如果一个类不继承自其它类， 就显式的从object继承. 嵌套类也一样。继承自 object 是为了使属性(properties)正常工作， 并且这样可以保护你的代码， 使其不受 PEP-3000的一个特殊的潜在不兼容性影响。这样做也定义了一些特殊的方法， 这些方法实现了对象的默认语义， 包括 __new__, __init__, __delattr__, __getattribute__, __setattr__, __hash__, __repr__, and __str__ 。

原文链接:https://www.cnblogs.com/xxpythonxx/p/10883509.html
如有疑问请与原作者联系

标签：

版权申明：本站文章部分自网络，如有侵权，请联系：west999com@outlook.com
特别注意：本站所有转载文章言论不代表本站观点，本站所提供的摄影照片，插画，设计作品，如需使用，请与原作者联系，版权归原作者所有