测试文档字符串是否存在

Question

我想为 Python 编写单元测试，检查每个包、模块、类和方法是否都有一个__doc__字符串。

正确的方法是什么？我正在考虑通过递归导入进行此检查。

Answer 1

向 @jonrsharpe 寻求有关 pylint 的提示。:)

使用以下命令设置默认 .pylintrc：

 pylint --generate-rcfile > .pylintrc

编辑将 docstring-min-length 变量更改为：

 docstring-min-length=10

然后执行这个脚本... echo 将打印 pylint 测试的退出代码：

 pylint --disable=all --enable=missing-docstring <package-name>
 echo $?

如果 echo 为 0 pylint 通过，否则失败。希望有帮助；）