在autodoc docstring中执行代码

Question

当使用Sphinx和autodoc来记录Python项目时，您可以使用:Example:在模块/类/函数docstring中包含代码示例，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，它可以识别，执行和验证来自文本文件或文档字符串的交互式示例。