可以使用 autodoc 从 docstring 执行代码吗？

Question

当使用 Sphinx 和 autodoc 来记录 Python 项目时，您可以使用 :Example: 在您的模块/类/函数文档字符串中包含一个代码示例，Sphinx 会为您提供语法高亮显示。像这样。

>>> rng = Range(0, 1000)
>>> rng
[0, 1000)
>>> len(rng)
1000
>>> rng.start = 500
>>> rng.start
500
>>> rng.end
1000
>>> 

我从 Python 解释器复制并粘贴了它。有没有办法让 Sphinx 或 autodoc 执行代码并自动捕获文档的输出？

我主要担心复制粘贴的代码/输出与当前的实际代码行为不同步。

Answer 1

标准库包括doctest，它可以识别、执行和验证来自文本文件或文档字符串的交互式示例。