Python unittest框架：测试描述

Question

在python中提供测试脚本描述的最佳做法是什么？

显然我可以将评论放在测试用例下面，但是想知道是否有任何标准做法（我应该写的任何方法）来提供测试用例的描述（有关测试用例的详细信息）应该这样做？

您是如何进行测试说明的？：

ggplot2

任何建议/参考将不胜感激。

Answer 1

在unittest框架中，您拥有。{ shortDecription方法：

  

<强> shortDescription()

     

返回测试的描述，如果没有提供描述，则返回None。此方法的默认实现返回测试方法的docstring的第一行（如果可用）。

所以，事实上，使用docstring方法是个好地方。您可能必须在类声明中继承TestCase，以便跑步者能够像这样工作。

对于最佳实践：以简洁但有用的方式命名测试用例（类）和测试方法，这对于开发人员来说已经足够高级了解如果出现问题，特定测试是否会失败。对此的先决条件是每个测试方法应该只测试一件事，而不是在一大堆不同的东西上断言。

通过合理的测试名称，通常不需要具有“关于测试用例应该做什么的详细信息”的文档字符串。如果您现有大型测试可以检查很多东西，您可能希望将它们分成一堆较小的测试，每个测试都在一个且仅在一个单独的事物上断言。

Answer 2

测试方法docstring是放置该信息的标准位置如果您使用的是python＆＃39; unittest模块。 unittest将使用该文档字符串格式化输出等。

Answer 3

最好的方法是让类的名称具有足够的描述性，以便不需要描述。

除此之外，docstring是最好的方法。