用于测试参数解析而不用 os.popen() 污染文档字符串的 shell 脚本的 Python doctest

Question

有没有办法编写 python doctest 字符串来测试旨在从命令行（终端）启动的脚本，该脚本不会使用 os.popen 调用污染文档示例？

#!/usr/bin/env python
# filename: add
"""
Example:
>>> import os
>>> os.popen('add -n 1 2').read().strip()
'3'
"""

if __name__ == '__main__':
    from argparse import ArgumentParser
    p = ArgumentParser(description=__doc__.strip())
    p.add_argument('-n',type = int, nargs   = 2, default = 0,help  = 'Numbers to add.')
    p.add_argument('--test',action = 'store_true',help  = 'Test script.')
    a = p.parse_args()
    if a.test:
        import doctest
        doctest.testmod()
    if a.n and len(a.n)==2:
        print a.n[0]+a.n[1]

在不使用 popen 的情况下运行 doctest.testmod() 只会导致测试失败，因为脚本是在 python shell 而不是 bash（或 DOS）shell 中运行的。

LLNL 的高级 Python 课程建议将脚本放在与 .py 模块分开的文件中。但随后 doctest 字符串仅测试模块，没有 arg 解析。我的 os.popen() 方法污染了示例文档。有没有更好的办法？

Answer 1

刚刚找到了一些看起来像您想要的答案的东西： shell-doctest.

Answer 2

doctest 是用来运行 python 代码的，所以你必须在某个地方进行转换。如果您决定直接通过doctest 测试命令行界面，一种可能性是在将__doc__ 传递给argparse 之前对其进行正则表达式替换，以取出os.popen 包装器：

clean = re.sub(r"^>>> os\.popen\('(.*)'\).*", r"% \1", __doc__)
p = ArgumentParser(description=clean, ...)

（当然，有各种更好的方法可以做到这一点，具体取决于您认为“好的”）。

这将为最终用户清理它。如果您还希望它在源代码中看起来更干净，您可以采用另一种方式：将命令行示例放在 docstring 中，不要使用 doctest.testmodule()。通过doctest.script_from_examples 运行您的文档字符串并对其进行后处理以插入os 调用。 （然后你必须将它嵌入到某些东西中，这样你就可以用run_docstring_examples 对其进行测试。）doctest 不关心输入是否是有效的 python，所以你可以执行以下操作：

>>> print doctest.script_from_examples("""
Here is a commandline example I want converted:
>>> add -n 3 4
7
""")
# Here is a commandline example I want converted:
add -n 3 4
# Expected:
## 7

这仍然会在帮助中显示 python 提示 >>>。如果这让您感到困扰，您可能只需要在两个方向上处理字符串。

Answer 3

您也可以自己加载文档字符串并执行命令，如in this test。

import sys

module = sys.modules[__name__]
docstring = module.__doc__
# search in docstring for certain regex, and check that the following line(s) matches a pattern.