Python PEP：函数定义后的空行？

Question

我找不到有关此详细信息的任何 PEP 参考。 函数定义后必须有一个空行？

我应该这样做吗：

def hello_function():
    return 'hello'

或者我应该这样做：

def hello_function():

    return 'hello'

当使用文档字符串时，同样的问题适用：

这个：

def hello_function():
    """
    Important function
    """
    return 'hello'

或这个

def hello_function():
    """
    Important function
    """

    return 'hello'

编辑

正如 FoxMaSk 所评论的，这就是 PEP 在空白行上所说的内容，但它没有对这个细节做任何说明。

空行

用两个空行分隔顶级函数和类定义。

类中的方法定义由单个空行分隔。

可以（谨慎地）使用额外的空行来分隔相关功能组。 一堆相关的单行代码之间可以省略空行（例如一组虚拟实现）。

在函数中谨慎使用空行来指示逻辑部分。

Python 接受 control-L（即 ^L）换页符作为空格； 许多工具将这些字符视为页面分隔符，因此您可以使用它们来分隔文件相关部分的页面。 请注意，某些编辑器和基于 Web 的代码查看器可能无法将 control-L 识别为换页符，而是会在其位置显示另一个字形。

Answer 1

阅读文档字符串约定。

它说即使该功能非常明显，您也必须编写一行文档字符串。 它说：

在文档字符串之前或之后都没有空行。

所以我会编写类似的代码

def hello_function():
    """Return 'hello' string."""
    return 'hello'

Answer 2

正如@moliware 所指出的， Docstring 约定在One-line Docstrings下声明：

在文档字符串之前或之后都没有空行。

但是，它还说（在Multi-line Docstrings 下）：

在记录一个类的所有文档字符串（单行或多行）之后插入一个空行——一般来说，类的方法之间用一个空行分隔，文档字符串需要从第一个方法偏移由一个空行。

我对所有这些的解释：空行不应该在任何文档字符串之前，并且只应该在类的文档字符串之后。

Answer 3

项目使用不同的文档字符串约定。

例如， pandas 文档字符串指南明确要求您将三重引号放入他们自己的一行中。

文档字符串必须用三个双引号定义。 在文档字符串之前或之后不应留下空行。 文本从左引号之后的下一行开始。 结束引号有自己的一行（意味着它们不在最后一句话的末尾）。

Answer 4

让 python 脚本同时遵守pydocstyle和pycodestyle是一个挑战。 但有很大帮助的一件事是，在您的文档字符串中，将第一行写为 79 个字符内的函数或类的摘要，包括.

然后在留下一个空行之后（因为使用你的 coditor 的新行快捷方式比手动按enter更好）你可以写任何你想要的东西，当时只关注pycodestyle这比pydocstyle稍微容易一些，主要原因是我们的由于我们使用的各种代码编辑器中的缩进设置、制表符设置、行设置，对行和缩进的理解与系统理解的完全不同。因此，通过这种方式，您将拥有pycodestyle中的TODO ，您可以理解它并且可以纠正而不是敲打您的在pydocstyle TODO s 上pydocstyle 。