测试docstring存在

时间:2015-06-03 13:10:12

标签: python unit-testing

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

这是正确的方法吗?我正在考虑使用递归导入进行此检查。

2 个答案:

答案 0 :(得分:2)

向@jonrsharpe大喊大叫提示。 :)

使用以下命令创建默认的.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则传递,否则失败。 希望它能够继续下去;)

答案 1 :(得分:1)

无需使用诸如pylint之类的外部程序,简单的方法就是检查功能 doc 属性是否为None。

def f():
    pass

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