测试文档字符串是否存在

Question

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

什么才是正确的方法呢？我在考虑用递归导入做这个检查。

Answer 1

向@jonrsharpe呼喊，以获取pylint的提示。:)

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

 pylint --generate-rcfile > .pylintrc

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

 docstring-min-length=10

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

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

如果echo为0，则传递pylint，否则失败。希望它能帮上忙;)

Answer 2

不使用pylint等外部程序的简单方法是检查functions 文档属性是否为None。

def f():
    pass

print(f.__doc__ is None) # Prints None.