python:doctest我的github-markdown文件？

Question

我想从这个文件中运行doctests,我不清楚要完成它:

README.md:

# WELCOME!

This library is helpful and will help you in _many_ ways!

For example:

```
>>> import library
>>> library.helps()
True
```

(旁白:任何人都可以帮我把这个突出显示为降价吗？)

Answer 1

您可以运行doctest在你README使用命令行：

python -m doctest -v README.md

该-m参数告诉 Python 将以下模块作为脚本运行。当作为脚本运行时，doctest模块doctest.testmod在以下文件上运行该函数。最后，-v参数使doctest以详细模式运行；如果它被关闭，则doctest只有在至少一个测试失败时才会产生输出（如果一切都成功则不会产生任何输出）。

Answer 2

作为doctest的替代方案，我编写了mkcodes，这是一个从 Markdown 文件中提取代码块的脚本，以便可以在单独的文件中测试它们。

这是我使用 mkcodes 的实际测试脚本：

mkcodes --github --output tests/docs/test_{name}.py docs
py.test tests
pyflakes tests
pep8 tests