Unittest 单元测试框架4 - 类与函数(1)

前文：
Unittest 单元测试框架1 - 基本使用和命令行选项

Unittest 单元测试框架2 - 编写测试代码以及如何跳过测试用例
Unittest 单元测试框架3 - 使用子测试区分测试迭代

类与函数

测试用例

• class unittest.TestCase(methodName='runTest')
  TestCase类的实例表示uniitest Universe中的逻辑测试单元。该类旨在用作基类，具体测试由具体的子类实现。此类实现测试运行程序所需的接口，以使其能够驱动测试，以及测试代码可用于检查和报告各种故障的方法。

  每个TestCase实例将运行一个基本方法：名为methodName的方法，在大多数使用TestCase的情况下既不会更改methodName也不会重新实现默认的runTest()方法。

  在3.2版本更改中：无需提供methodName, 就可以成功实例化TestCase。这样可以更轻松地交互式解释器尝试使用TestCase。
  TestCase实例提供三组方法： 一组用于运行测试， 另一组由测试实现用于检查条件和报告故障，还有一些查询方法允许收集有关测试本身的信息。

  第一组(运行测试)的方法是：

  • setUp()
    
    调用该方法去准备test fixture。 这是调用测试方法之前立即调用的；除了Assertion或SkipTest之外。此方法引发的任何异常都将被视为错误而不是测试失败。默认实现不执行任何操作。

  • tearDown()
    
    调用测试方法并记录结果后立即调用的方法。即使测试方法引发异常，也会调用此方法，因此在子类中的实现可能需要特别注意检查内部状态。此方法引发的任何异常(Assertion或SkipTest除外)都将被视为附加错误，而不是测试失败(因此会增加报告的错误总数)。仅在setUp()成功的情况下才会调用此方法，而不管测试方法的结果如何。默认实现不执行任何操作。

  • setUpClass()
    
    3.2新版本功能

    在运行单个类中的测试之前调用的类方法。使用类作为唯一参数调用setUpClass并且必须将其修饰为classmethod():

    @classmethod
    def setUpClass(cls):
        ...
    

  • tearDownClass()
    
    3.2新版本功能

    在单个类中的测试运行之后调用的类方法。使用类作为唯一参数调用tearDownClass,并且必须将其修饰为classmethod():

    @classmethod
    def tearDownClass(cls):
        ...
    

  • run
    
    在3.3版本中更改:Previous version of run did not return the result. Neither did calling an instance

    运行测试，将结果收集到作为结果传递的TestResult对象中，如果result是忽略或者None。一个临时的result对象将会被创建(通过调用defaultTestResult()方法)并且使用. result对象返回到run()的调用者。

    只需调用TestCase实例，就可以达到相同的效果。

  • skipTest(reason)
    
    3.1新版本功能
    在测试方法或setUp()期间调用该函数将跳过当前测试。

  • subTest(msg=None, **params)
    
    3.4新版本功能
    返回一个上下文管理器，该上下文管理器将封闭的代码块作为子测试执行。msg和params是可选的任意值，在子测试失败时会显示这些值。使您可以清楚地识别它们。

    一个测试用例可以包含任意数量的子测试生命，并且它们可以任意嵌套。

  • debug()
    
    运行测试而不收集结果。这允许将测试测试引发的异常传播到调用方，并可以用于支持在调试器下运行测试。

  TestCase类提供了几种assert方法来检查和报告故障。下表列出了最常用的方法(有关更多的断言方法，请参考下表):

  Method	Checks that	New in
  assertEqual(a, b)	a == b
  assertNotEqual(a, b)	a != b
  assertTrue(x)	bool(x) is True
  assertFalse(x)	bool(x) is False
  assertIs(a, b)	a is b	3.1
  assertIsNot(a, b)	a is not b	3.1
  assertIsNone(x)	x is None	3.1
  assertIsNotNone(x)	x is not None	3.1
  assertIn(a, b)	a in b	3.1
  assertNotIn(a, b)	a not in b	3.1
  assertIsInstance(a, b)	isinstance(a, b)	3.2
  assertNotIsInstance(a, b)	not isinstance(a, b)	3.2

所有的断言方法都接受一个msg参数，如果指定该参数，该参数将用作失败时的错误消息。请注意，仅当将msg关键字参数用作上下文管理器时， 它们才能传递给assertRaises(), assertRaisesRegex(), assertWarns(), assertWarnsRegex()。

• assertEqual(first, second, msg=None)
  
  测试first和second是否相等。如果值比较不相等，则测试将失败。

  另外，如果first和second是完全相同的类型，并且是list, tuple，dict， set， frozenset或str或向addTypeEqualityFunc()注册的任何类型之一的子类型，则将调用特定类型的等式函数以生成更多有用的默认错误消息。

  在3.1版本更改 : Added the automatic calling of type-specific equality function.

  在3.2版本更改 : assertMultiLineEqual() added as the. default type equality function for comparing strings.

• assertNotEqual(first, second, msg=None)
  
  测试first和second不相等，如果对比值相等，则测试将会Fail。

• assertTrue(expr, msg=None)

• assertFalse(expr, msg=None)
  
  测试 expr 的值是 true(或者flase)

  请注意这等效于bool(expr)为True, 而不是expr为True(后者使用assertIs(expr, True))。当有更多特定的方法可用时(例如 assertEqual(a, b) 而不是 assertTrue(a==b)), 也应避免使用此方法，因为在失败的情况下它们会提供更好的错误消息。

• assertIs(first, second, msg=None)

• assertIsNot(first, second, msg=None)
  3.1 新版本功能
  测试first 和 second 是(或者 不是)相同的对象。

• assertIsNone(expr, msg=None)

• assertIsNotNone(expr, msg=None)
  
  3.1 新版本功能
  测试expr 是(或者 不是) None。

• assertIn(member, container, msg=None)

• assertNotIn(member, container, msg=None)
  
  3.1 新版本功能
  测试member 在(或者 不在) container。

• assertIsInstance(obj, cls, msg=None)

• assertNotIsInstance(obj, cls, msg=None)
  3.2 新版本功能
  测试obj是(或者 不是)cls的实例(可以是一个类或一个类的元祖,由isinstance()支持。要检查确切的类型 请使用assertIs(type(obj), cls))。

  也可以使用以下方法检查异常，警告和日志消息的生成:

  Method	Checks that	New in
  assertRaises(exc, fun, *args, **kwds)	fun(*args, **kwds) raises exc
  assertRaisesRegex(exc, r, fun, *args, **kwds)	fun(*args, **kwds) raises exc and the message matches regex r	3.1
  assertWarns(warn, fun, *args, **kwds)	fun(*args, **kwds) raises warn	3.2
  assertWarnsRegex(warn, r, fun, *args, **kwds)	fun(*args, **kwds) raises warn and the message matches regex r	3.2
  assertLogs(logger, level)	The with block logs on logger with minimum leve	3.4

• assertRaises(exception, callable, *args, **kwds)

• assertRaises(exception, *, msg=None)
  测试当调用 callable时， 使用同样传递给assertRaises()的位置或关键字参数是否引发异常。如果抛出异常，则测试通过；如果抛出另一个异常，则测试失败；如果没有抛出异常，则测试失败，为了捕获任何一组异常，包含异常类的元组可以作为异常传递。

  如果只给出了exception和msg参数,则返回一个上下文管理器，一遍测试代码可以内嵌编写，而不是作为函数:

  with self.assertRaises(SomeException):
      do_something()
  

  当作为一个上下文管理器使用，assertRaises()接受附加的关键字参数msg。

  上下文管理器会将捕获的异常对象存储在其异常属性中。 如果要对引发的异常执行其他检查，这将很有用:

  with self.assertRaises(SomeException) as cm:
      do_something()
  
  the_exception = cm.exception
  self.assertEqual(the_exception.error_code, 3)
  

  在3.1版本更改: Added the ability to use assertRaises() as a context manager.

  在3.2版本更改: Added the exception attribute.

  在3.3版本更改: Added the msg keyword argument when used as a context manager.

• assertRaisesRegex(exception, regex, callable, *args, **kwds）

• assertRaisesRegex(exception, regex, *, msg=None)

  Like assertRaises() but also tests that regex matches on the string representation of the raised exception. regex may be a regular expression object or a string containing a regular expression suitable for use by re.search(). Examples:

  像assertRaises()一样，也测试正则表达式 是否与引发的异常的字符串表示形式匹配。 regex可以是正则表达式对象， 也可以是包含适合re.search()使用的正则表达式的字符串。例如：

  self.assertRaisesRegex(ValueError, "invelid literal for.*XYZ'$", int, 'XYZ')
  

  或者

  with self.assertRaisesRegex(ValueError, 'literal'):
      int('XYZ'))
  

  在3.1版本更改： Added under the name assertRaisesRegexp

  在3.2版本更改： Renamed to assertRaisesRegex()

  在3.3版本更改： Added the msg keyword argument when used as a context manager.

• assertWarns(warning, callable, *args, **kwds)

• assertWarns(warning, *, msg=None)
  
  测试当调用callable时，使用任何位置或关键字参数(也传递给assertWarns())是否会触发警告。如果触发了警告，则测试通过;如果没有触发警告，则测试失败。任何异常都是错误。要捕获警告组中的任何一个，可以将包含警告类的元组作为警告传递。

  如果只给出了警告和msg参数，则返回一个上下文管理器，以便测试代码可以内联编写，而不是作为函数:

  with self.assertWarns(SomeWarning):
      do_something()
  

  当作为一个上下文管理器使用，assertWarns() 接收附件的关键字参数msg。

  上下文管理器将在其warning属性中存储捕获的警告对象，并在filename和lineno属性中存储触发警告的源行。如果目的是对捕获的警告执行额外的检查，这可能会很有用:

  with self.assertWarns(SomeWarning) as cm:
      do_something()
  
  self.assertIn('myfile.py', cm.filename)
  self.assertEqual(320, cm.lineno)
  

  在调用该方法时，不管是否有适当的警告过滤器，该方法都可以工作。
  
  3.2新版本功能
  
  在3.3版本更改： Added the msg keyword argument when used as a context manager.

原文来自于https://docs.python.org/3.9/library/unittest.html#
如有侵权，请联系删除