Python单元测试框架：测试描述

Question

用python提供测试脚本描述的最佳实践是什么？在

显然，我可以将注释放在测试用例下面，但是我想知道是否有任何标准实践（我应该编写的任何方法）来提供测试用例的描述（关于测试用例应该做什么的详细信息）？在

你会这样写测试描述吗？公司名称：

Class TestFoo:
    def testfoo1():
    """
    test description:
    step1:
    step2: 
    """

如有任何参考/建议，将不胜感激。在

Answer 1

如果您使用的是python的unittest模块，那么测试方法docstring是放置这些信息的标准位置。unittest将使用该docstring格式化输出等

Answer 2

最好的方法是让类名具有足够的描述性，这样就不需要描述了。在

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

Answer 3

在unittest框架中，有 ^{}方法：

shortDescription()

Returns a description of the test, or None if no description has been provided. The default implementation of this method returns the first line of the test method’s docstring, if available.

所以，事实上，使用docstring方法是个不错的地方。不过，您可能必须在类声明中从TestCase继承，这样运行器才能这样工作。在

对于最佳实践：以一种简洁但有用的方式命名测试用例（类）和测试方法，这种方式足以让开发人员在某个特定测试失败时，对哪里出了问题有一个高度的了解。一个先决条件是，每个测试方法应该只测试一个东西，而不是断言一大堆不同的东西。在

对于合理的测试名称，通常不需要包含“关于测试用例应该做什么的详细信息”的docstring。如果现有的大型测试检查很多东西，那么您可能需要将它们拆分为一组较小的测试，每个测试只对一个单独的东西进行断言。在