Python Docstring : raise vs. 引发

Question

我使用 PyCharm IDE 来协助制作符合 PEP0257 的文档字符串。它提供了两个属性，我不完全理解它们之间的区别/用途:

• :raise Exception: 此处异常说明
• :raises Exception: 这里有异常说明

我什么时候在我的文档字符串中使用 raise 作为与 raises 的对立面？具体来说，如果一个类需要一个未提供的参数并引发 TypeError，那么应该使用它来记录吗？

Answer 1

TL;DR

raises 用于描述可能引发的异常。 raise 被 Sphinx 识别运行 autodoc 时，与 raises 相同。

完整说明

PyCharm 有助于使用几种不同样式的文档字符串注释。

我经常使用的三个是:

1. NumPy Format
2. Google Format
3. Sphinx (不仅仅是一种格式)

在所有这些中，有一个用于 Raises 的特殊部分，您可以在旧版本的 PyCharm 代码测试中看到:

1. Simple NumPy
2. Simple Google

SphinxDocString 的实现我们可以see here有许多可以识别的关键字。然后这些标签链接到 RAISES_TAGS 列表，可以在 here 中找到该列表。 .

我希望这些信息有用。