25.3. unittest
— 单元测试框架¶
2.1 新版功能.
(如果你已经对测试的概念比较熟悉了,你可能想直接跳转到这一部分 断言方法。)
The Python unit testing framework, sometimes referred to as “PyUnit,” is a Python language version of JUnit, by Kent Beck and Erich Gamma. JUnit is, in turn, a Java version of Kent’s Smalltalk testing framework. Each is the de facto standard unit testing framework for its respective language.
unittest
supports test automation, sharing of setup and shutdown code for
tests, aggregation of tests into collections, and independence of the tests from
the reporting framework. The unittest
module provides classes that make
it easy to support these qualities for a set of tests.
To achieve this, unittest
supports some important concepts:
- 测试脚手架
test fixture 表示为了开展一项或多项测试所需要进行的准备工作,以及所有相关的清理操作。举个例子,这可能包含创建临时或代理的数据库、目录,再或者启动一个服务器进程。
- 测试用例
A test case is the smallest unit of testing. It checks for a specific response to a particular set of inputs.
unittest
provides a base class,TestCase
, which may be used to create new test cases.- 测试套件
test suite 是一系列的测试用例,或测试套件,或两者皆有。它用于归档需要一起执行的测试。
- 测试运行器(test runner)
test runner 是一个用于执行和输出测试结果的组件。这个运行器可能使用图形接口、文本接口,或返回一个特定的值表示运行测试的结果。
The test case and test fixture concepts are supported through the
TestCase
and FunctionTestCase
classes; the former should be
used when creating new tests, and the latter can be used when integrating
existing test code with a unittest
-driven framework. When building test
fixtures using TestCase
, the setUp()
and
tearDown()
methods can be overridden to provide initialization
and cleanup for the fixture. With FunctionTestCase
, existing functions
can be passed to the constructor for these purposes. When the test is run, the
fixture initialization is run first; if it succeeds, the cleanup method is run
after the test has been executed, regardless of the outcome of the test. Each
instance of the TestCase
will only be used to run a single test method,
so a new fixture is created for each test.
Test suites are implemented by the TestSuite
class. This class allows
individual tests and test suites to be aggregated; when the suite is executed,
all tests added directly to the suite and in “child” test suites are run.
A test runner is an object that provides a single method,
run()
, which accepts a TestCase
or TestSuite
object as a parameter, and returns a result object. The class
TestResult
is provided for use as the result object. unittest
provides the TextTestRunner
as an example test runner which reports
test results on the standard error stream by default. Alternate runners can be
implemented for other environments (such as graphical environments) without any
need to derive from a specific class.
参见
doctest
— 文档测试模块另一个风格完全不同的测试模块。
- unittest2: A backport of new unittest features for Python 2.4-2.6
Many new features were added to unittest in Python 2.7, including test discovery. unittest2 allows you to use these features with earlier versions of Python.
- Simple Smalltalk Testing: With Patterns
Kent Beck’s original paper on testing frameworks using the pattern shared by
unittest
.- Nose and pytest
Third-party unittest frameworks with a lighter-weight syntax for writing tests. For example,
assert func(10) == 42
.- The Python Testing Tools Taxonomy
An extensive list of Python testing tools including functional testing frameworks and mock object libraries.
- Testing in Python Mailing List
A special-interest-group for discussion of testing, and testing tools, in Python.
25.3.1. 基本实例¶
unittest
模块提供了一系列创建和运行测试的工具。这一段落演示了这些工具的一小部分,但也足以满足大部分用户的需求。
这是一段简短的代码,来测试三种字符串方法:
import unittest
class TestStringMethods(unittest.TestCase):
def test_upper(self):
self.assertEqual('foo'.upper(), 'FOO')
def test_isupper(self):
self.assertTrue('FOO'.isupper())
self.assertFalse('Foo'.isupper())
def test_split(self):
s = 'hello world'
self.assertEqual(s.split(), ['hello', 'world'])
# check that s.split fails when the separator is not a string
with self.assertRaises(TypeError):
s.split(2)
if __name__ == '__main__':
unittest.main()
继承 unittest.TestCase
就创建了一个测试样例。上述三个独立的测试是三个类的方法,这些方法的命名都以 test
开头。 这个命名约定告诉测试运行者类的哪些方法表示测试。
每个测试的关键是:调用 assertEqual()
来检查预期的输出; 调用 assertTrue()
或 assertFalse()
来验证一个条件;调用 assertRaises()
来验证抛出了一个特定的异常。使用这些方法而不是 assert
语句是为了让测试运行者能聚合所有的测试结果并产生结果报告。
通过 setUp()
和 tearDown()
方法,可以设置测试开始前与完成后需要执行的指令。 在 组织你的测试代码 中,对此有更为详细的描述。
最后的代码块中,演示了运行测试的一个简单的方法。 unittest.main()
提供了一个测试脚本的命令行接口。当在命令行运行该测试脚本,上文的脚本生成如以下格式的输出:
...
----------------------------------------------------------------------
Ran 3 tests in 0.000s
OK
Instead of unittest.main()
, there are other ways to run the tests with a
finer level of control, less terse output, and no requirement to be run from the
command line. For example, the last two lines may be replaced with:
suite = unittest.TestLoader().loadTestsFromTestCase(TestStringMethods)
unittest.TextTestRunner(verbosity=2).run(suite)
Running the revised script from the interpreter or another script produces the following output:
test_isupper (__main__.TestStringMethods) ... ok
test_split (__main__.TestStringMethods) ... ok
test_upper (__main__.TestStringMethods) ... ok
----------------------------------------------------------------------
Ran 3 tests in 0.001s
OK
以上例子演示了 unittest
中最常用的、足够满足许多日常测试需求的特性。文档的剩余部分详述该框架的完整特性。
25.3.2. 命令行界面¶
unittest 模块可以通过命令行运行模块、类和独立测试方法的测试:
python -m unittest test_module1 test_module2
python -m unittest test_module.TestClass
python -m unittest test_module.TestClass.test_method
你可以传入模块名、类或方法名或他们的任意组合。
在运行测试时,你可以通过添加 -v 参数获取更详细(更多的冗余)的信息。
python -m unittest -v test_module
用于获取命令行选项列表:
python -m unittest -h
在 2.7 版更改: 在早期版本中,只支持运行独立的测试方法,而不支持模块和类。
25.3.2.1. 命令行选项¶
unittest supports these command-line options:
-
-b
,
--buffer
¶
在测试运行时,标准输出流与标准错误流会被放入缓冲区。成功的测试的运行时输出会被丢弃;测试不通过时,测试运行中的输出会正常显示,错误会被加入到测试失败信息。
-
-c
,
--catch
¶
当测试正在运行时, Control-C 会等待当前测试完成,并在完成后报告已执行的测试的结果。当再次按下 Control-C 时,引发平常的
KeyboardInterrupt
异常。See Signal Handling for the functions that provide this functionality.
-
-f
,
--failfast
¶
当出现第一个错误或者失败时,停止运行测试。
2.7 新版功能: 添加命令行选项 -b
, -c
和 -f
。
命令行亦可用于探索性测试,以运行一个项目的所有测试或其子集。
25.3.3. 探索性测试¶
2.7 新版功能.
Unittest supports simple test discovery. In order to be compatible with test discovery, all of the test files must be modules or packages importable from the top-level directory of the project (this means that their filenames must be valid identifiers).
探索性测试在 TestLoader.discover()
中实现,但也可以通过命令行使用。它在命令行中的基本用法如下:
cd project_directory
python -m unittest discover
discover
有以下选项:
-
-v
,
--verbose
¶
更详细地输出结果。
-
-s
,
--start-directory
directory
¶ 开始进行搜索的目录(默认值为当前目录
.
)。
-
-p
,
--pattern
pattern
¶ 用于匹配测试文件的模式(默认为
test*.py
)。
-
-t
,
--top-level-directory
directory
¶ 指定项目的最上层目录(通常为开始时所在目录)。
-s
,-p
和 -t
选项可以按顺序作为位置参数传入。以下两条命令是等价的:
python -m unittest discover -s project_directory -p "*_test.py"
python -m unittest discover project_directory "*_test.py"
正如可以传入路径那样,传入一个包名作为起始目录也是可行的,如 myproject.subpackage.test
。你提供的包名会被导入,它在文件系统中的位置会被作为起始目录。
警告
探索性测试通过导入测试对测试进行加载。在找到所有你指定的开始目录下的所有测试文件后,它把路径转换为包名并进行导入。如 foo/bar/baz.py
会被导入为 foo.bar.baz
。
如果你有一个全局安装的包,并尝试对这个包的副本进行探索性测试,可能会从错误的地方开始导入。如果出现这种情况,测试会输出警告并退出。
如果你使用包名而不是路径作为开始目录,搜索时会假定它导入的是你想要的目录,所以你不会收到警告。
测试模块和包可以通过 load_tests protocol 自定义测试的加载和搜索。
25.3.4. 组织你的测试代码¶
The basic building blocks of unit testing are test cases — single
scenarios that must be set up and checked for correctness. In unittest
,
test cases are represented by instances of unittest
’s TestCase
class. To make your own test cases you must write subclasses of
TestCase
, or use FunctionTestCase
.
An instance of a TestCase
-derived class is an object that can
completely run a single test method, together with optional set-up and tidy-up
code.
一个 TestCase
实例的测试代码必须是完全自含的,因此它可以独立运行,或与其它任意组合任意数量的测试用例一起运行。
The simplest TestCase
subclass will simply override the
runTest()
method in order to perform specific testing code:
import unittest
class DefaultWidgetSizeTestCase(unittest.TestCase):
def runTest(self):
widget = Widget('The widget')
self.assertEqual(widget.size(), (50, 50), 'incorrect default size')
Note that in order to test something, we use one of the assert*()
methods provided by the TestCase
base class. If the test fails, an
exception will be raised, and unittest
will identify the test case as a
failure. Any other exceptions will be treated as errors. This
helps you identify where the problem is: failures are caused by incorrect
results - a 5 where you expected a 6. Errors are caused by incorrect
code - e.g., a TypeError
caused by an incorrect function call.
The way to run a test case will be described later. For now, note that to construct an instance of such a test case, we call its constructor without arguments:
testCase = DefaultWidgetSizeTestCase()
Now, such test cases can be numerous, and their set-up can be repetitive. In
the above case, constructing a Widget
in each of 100 Widget test case
subclasses would mean unsightly duplication.
Luckily, we can factor out such set-up code by implementing a method called
setUp()
, which the testing framework will automatically call for
us when we run the test:
import unittest
class SimpleWidgetTestCase(unittest.TestCase):
def setUp(self):
self.widget = Widget('The widget')
class DefaultWidgetSizeTestCase(SimpleWidgetTestCase):
def runTest(self):
self.assertEqual(self.widget.size(), (50,50),
'incorrect default size')
class WidgetResizeTestCase(SimpleWidgetTestCase):
def runTest(self):
self.widget.resize(100,150)
self.assertEqual(self.widget.size(), (100,150),
'wrong size after resize')
If the setUp()
method raises an exception while the test is
running, the framework will consider the test to have suffered an error, and the
runTest()
method will not be executed.
Similarly, we can provide a tearDown()
method that tidies up
after the runTest()
method has been run:
import unittest
class SimpleWidgetTestCase(unittest.TestCase):
def setUp(self):
self.widget = Widget('The widget')
def tearDown(self):
self.widget.dispose()
self.widget = None
If setUp()
succeeded, the tearDown()
method will
be run whether runTest()
succeeded or not.
Such a working environment for the testing code is called a fixture.
Often, many small test cases will use the same fixture. In this case, we would
end up subclassing SimpleWidgetTestCase
into many small one-method
classes such as DefaultWidgetSizeTestCase
. This is time-consuming and
discouraging, so in the same vein as JUnit, unittest
provides a simpler
mechanism:
import unittest
class WidgetTestCase(unittest.TestCase):
def setUp(self):
self.widget = Widget('The widget')
def tearDown(self):
self.widget.dispose()
self.widget = None
def test_default_size(self):
self.assertEqual(self.widget.size(), (50,50),
'incorrect default size')
def test_resize(self):
self.widget.resize(100,150)
self.assertEqual(self.widget.size(), (100,150),
'wrong size after resize')
Here we have not provided a runTest()
method, but have instead
provided two different test methods. Class instances will now each run one of
the test_*()
methods, with self.widget
created and destroyed
separately for each instance. When creating an instance we must specify the
test method it is to run. We do this by passing the method name in the
constructor:
defaultSizeTestCase = WidgetTestCase('test_default_size')
resizeTestCase = WidgetTestCase('test_resize')
Test case instances are grouped together according to the features they test.
unittest
provides a mechanism for this: the test suite,
represented by unittest
’s TestSuite
class:
widgetTestSuite = unittest.TestSuite()
widgetTestSuite.addTest(WidgetTestCase('test_default_size'))
widgetTestSuite.addTest(WidgetTestCase('test_resize'))
For the ease of running tests, as we will see later, it is a good idea to provide in each test module a callable object that returns a pre-built test suite:
def suite():
suite = unittest.TestSuite()
suite.addTest(WidgetTestCase('test_default_size'))
suite.addTest(WidgetTestCase('test_resize'))
return suite
or even:
def suite():
tests = ['test_default_size', 'test_resize']
return unittest.TestSuite(map(WidgetTestCase, tests))
Since it is a common pattern to create a TestCase
subclass with many
similarly named test functions, unittest
provides a TestLoader
class that can be used to automate the process of creating a test suite and
populating it with individual tests. For example,
suite = unittest.TestLoader().loadTestsFromTestCase(WidgetTestCase)
will create a test suite that will run WidgetTestCase.test_default_size()
and
WidgetTestCase.test_resize
. TestLoader
uses the 'test'
method
name prefix to identify test methods automatically.
Note that the order in which the various test cases will be run is determined by sorting the test function names with respect to the built-in ordering for strings.
Often it is desirable to group suites of test cases together, so as to run tests
for the whole system at once. This is easy, since TestSuite
instances
can be added to a TestSuite
just as TestCase
instances can be
added to a TestSuite
:
suite1 = module1.TheTestSuite()
suite2 = module2.TheTestSuite()
alltests = unittest.TestSuite([suite1, suite2])
You can place the definitions of test cases and test suites in the same modules
as the code they are to test (such as widget.py
), but there are several
advantages to placing the test code in a separate module, such as
test_widget.py
:
The test module can be run standalone from the command line.
The test code can more easily be separated from shipped code.
There is less temptation to change test code to fit the code it tests without a good reason.
Test code should be modified much less frequently than the code it tests.
Tested code can be refactored more easily.
Tests for modules written in C must be in separate modules anyway, so why not be consistent?
If the testing strategy changes, there is no need to change the source code.
25.3.5. 复用已有的测试代码¶
一些用户希望直接使用 unittest
运行已有的测试代码,而不需要把已有的每个测试函数转化为一个 TestCase
的子类。
因此, unittest
提供 FunctionTestCase
类。这个 TestCase
的子类可用于打包已有的测试函数,并支持设置前置与后置函数。
假定有一个测试函数:
def testSomething():
something = makeSomething()
assert something.name is not None
# ...
one can create an equivalent test case instance as follows:
testcase = unittest.FunctionTestCase(testSomething)
If there are additional set-up and tear-down methods that should be called as part of the test case’s operation, they can also be provided like so:
testcase = unittest.FunctionTestCase(testSomething,
setUp=makeSomethingDB,
tearDown=deleteSomethingDB)
To make migrating existing test suites easier, unittest
supports tests
raising AssertionError
to indicate test failure. However, it is
recommended that you use the explicit TestCase.fail*()
and
TestCase.assert*()
methods instead, as future versions of unittest
may treat AssertionError
differently.
注解
Even though FunctionTestCase
can be used to quickly convert an
existing test base over to a unittest
-based system, this approach is
not recommended. Taking the time to set up proper TestCase
subclasses will make future test refactorings infinitely easier.
In some cases, the existing tests may have been written using the doctest
module. If so, doctest
provides a DocTestSuite
class that can
automatically build unittest.TestSuite
instances from the existing
doctest
-based tests.
25.3.6. 跳过测试与预计的失败¶
2.7 新版功能.
Unittest supports skipping individual test methods and even whole classes of
tests. In addition, it supports marking a test as an “expected failure,” a test
that is broken and will fail, but shouldn’t be counted as a failure on a
TestResult
.
Skipping a test is simply a matter of using the skip()
decorator
or one of its conditional variants.
跳过测试的基本用法如下:
class MyTestCase(unittest.TestCase):
@unittest.skip("demonstrating skipping")
def test_nothing(self):
self.fail("shouldn't happen")
@unittest.skipIf(mylib.__version__ < (1, 3),
"not supported in this library version")
def test_format(self):
# Tests that work for only a certain version of the library.
pass
@unittest.skipUnless(sys.platform.startswith("win"), "requires Windows")
def test_windows_support(self):
# windows specific testing code
pass
在啰嗦模式下运行以上测试例子时,程序输出如下:
test_format (__main__.MyTestCase) ... skipped 'not supported in this library version'
test_nothing (__main__.MyTestCase) ... skipped 'demonstrating skipping'
test_windows_support (__main__.MyTestCase) ... skipped 'requires Windows'
----------------------------------------------------------------------
Ran 3 tests in 0.005s
OK (skipped=3)
跳过测试类的写法跟跳过测试方法的写法相似:
@unittest.skip("showing class skipping")
class MySkippedTestCase(unittest.TestCase):
def test_not_run(self):
pass
TestCase.setUp()
也可以跳过测试。可以用于所需资源不可用的情况下跳过接下来的测试。
使用 expectedFailure()
装饰器表明这个测试预计失败。:
class ExpectedFailureTestCase(unittest.TestCase):
@unittest.expectedFailure
def test_fail(self):
self.assertEqual(1, 0, "broken")
It’s easy to roll your own skipping decorators by making a decorator that calls
skip()
on the test when it wants it to be skipped. This decorator skips
the test unless the passed object has a certain attribute:
def skipUnlessHasattr(obj, attr):
if hasattr(obj, attr):
return lambda func: func
return unittest.skip("{!r} doesn't have {!r}".format(obj, attr))
The following decorators implement test skipping and expected failures:
-
unittest.
skip
(reason)¶ 跳过被此装饰器装饰的测试。 reason 为测试被跳过的原因。
-
unittest.
skipIf
(condition, reason)¶ 当 condition 为真时,跳过被装饰的测试。
-
unittest.
skipUnless
(condition, reason)¶ 跳过被装饰的测试,除非 condition 为真。
-
unittest.
expectedFailure
()¶ Mark the test as an expected failure. If the test fails when run, the test is not counted as a failure.
-
exception
unittest.
SkipTest
(reason)¶ 引发此异常以跳过一个测试。
通常来说,你可以使用
TestCase.skipTest()
或其中一个跳过测试的装饰器实现跳过测试的功能,而不是直接引发此异常。
Skipped tests will not have setUp()
or tearDown()
run around them.
Skipped classes will not have setUpClass()
or tearDownClass()
run.
25.3.7. 类与函数¶
本节深入介绍了 unittest
的 API。
25.3.7.1. 测试用例¶
-
class
unittest.
TestCase
(methodName='runTest')¶ Instances of the
TestCase
class represent the smallest testable units in theunittest
universe. This class is intended to be used as a base class, with specific tests being implemented by concrete subclasses. This class implements the interface needed by the test runner to allow it to drive the test, and methods that the test code can use to check for and report various kinds of failure.Each instance of
TestCase
will run a single test method: the method named methodName. If you remember, we had an earlier example that went something like this:def suite(): suite = unittest.TestSuite() suite.addTest(WidgetTestCase('test_default_size')) suite.addTest(WidgetTestCase('test_resize')) return suite
Here, we create two instances of
WidgetTestCase
, each of which runs a single test.methodName defaults to
runTest()
.TestCase
instances provide three groups of methods: one group used to run the test, another used by the test implementation to check conditions and report failures, and some inquiry methods allowing information about the test itself to be gathered.Methods in the first group (running the test) are:
-
setUp
()¶ Method called to prepare the test fixture. This is called immediately before calling the test method; other than
AssertionError
orSkipTest
, any exception raised by this method will be considered an error rather than a test failure. The default implementation does nothing.
-
tearDown
()¶ Method called immediately after the test method has been called and the result recorded. This is called even if the test method raised an exception, so the implementation in subclasses may need to be particularly careful about checking internal state. Any exception, other than
AssertionError
orSkipTest
, raised by this method will be considered an additional error rather than a test failure (thus increasing the total number of reported errors). This method will only be called if thesetUp()
succeeds, regardless of the outcome of the test method. The default implementation does nothing.
-
setUpClass
()¶ A class method called before tests in an individual class are run.
setUpClass
is called with the class as the only argument and must be decorated as aclassmethod()
:@classmethod def setUpClass(cls): ...
查看 Class and Module Fixtures 获取更详细的说明。
2.7 新版功能.
-
tearDownClass
()¶ A class method called after tests in an individual class have run.
tearDownClass
is called with the class as the only argument and must be decorated as aclassmethod()
:@classmethod def tearDownClass(cls): ...
查看 Class and Module Fixtures 获取更详细的说明。
2.7 新版功能.
-
run
(result=None)¶ Run the test, collecting the result into the test result object passed as result. If result is omitted or
None
, a temporary result object is created (by calling thedefaultTestResult()
method) and used. The result object is not returned torun()
’s caller.The same effect may be had by simply calling the
TestCase
instance.
-
skipTest
(reason)¶ Calling this during a test method or
setUp()
skips the current test. See 跳过测试与预计的失败 for more information.2.7 新版功能.
-
debug
()¶ Run the test without collecting the result. This allows exceptions raised by the test to be propagated to the caller, and can be used to support running tests under a debugger.
The
TestCase
class provides several assert methods to check for and report failures. The following table lists the most commonly used methods (see the tables below for more assert methods):Method
Checks that
New in
a == b
a != b
bool(x) is True
bool(x) is False
a is b
2.7
a is not b
2.7
x is None
2.7
x is not None
2.7
a in b
2.7
a not in b
2.7
isinstance(a, b)
2.7
not isinstance(a, b)
2.7
All the assert methods (except
assertRaises()
,assertRaisesRegexp()
) accept a msg argument that, if specified, is used as the error message on failure (see alsolongMessage
).-
assertEqual
(first, second, msg=None)¶ Test that first and second are equal. If the values do not compare equal, the test will fail.
In addition, if first and second are the exact same type and one of list, tuple, dict, set, frozenset or unicode or any type that a subclass registers with
addTypeEqualityFunc()
the type-specific equality function will be called in order to generate a more useful default error message (see also the list of type-specific methods).在 2.7 版更改: Added the automatic calling of type-specific equality function.
-
assertNotEqual
(first, second, msg=None)¶ Test that first and second are not equal. If the values do compare equal, the test will fail.
-
assertTrue
(expr, msg=None)¶ -
assertFalse
(expr, msg=None)¶ Test that expr is true (or false).
Note that this is equivalent to
bool(expr) is True
and not toexpr is True
(useassertIs(expr, True)
for the latter). This method should also be avoided when more specific methods are available (e.g.assertEqual(a, b)
instead ofassertTrue(a == b)
), because they provide a better error message in case of failure.
-
assertIs
(first, second, msg=None)¶ -
assertIsNot
(first, second, msg=None)¶ Test that first and second evaluate (or don’t evaluate) to the same object.
2.7 新版功能.
-
assertIsNone
(expr, msg=None)¶ -
assertIsNotNone
(expr, msg=None)¶ Test that expr is (or is not)
None
.2.7 新版功能.
-
assertIn
(first, second, msg=None)¶ -
assertNotIn
(first, second, msg=None)¶ Test that first is (or is not) in second.
2.7 新版功能.
-
assertIsInstance
(obj, cls, msg=None)¶ -
assertNotIsInstance
(obj, cls, msg=None)¶ Test that obj is (or is not) an instance of cls (which can be a class or a tuple of classes, as supported by
isinstance()
). To check for the exact type, useassertIs(type(obj), cls)
.2.7 新版功能.
It is also possible to check that exceptions and warnings are raised using the following methods:
Method
Checks that
New in
fun(*args, **kwds)
raises excfun(*args, **kwds)
raises exc and the message matches regex r2.7
-
assertRaises
(exception, callable, *args, **kwds)¶ -
assertRaises
(exception) Test that an exception is raised when callable is called with any positional or keyword arguments that are also passed to
assertRaises()
. The test passes if exception is raised, is an error if another exception is raised, or fails if no exception is raised. To catch any of a group of exceptions, a tuple containing the exception classes may be passed as exception.If only the exception argument is given, returns a context manager so that the code under test can be written inline rather than as a function:
with self.assertRaises(SomeException): do_something()
The context manager will store the caught exception object in its
exception
attribute. This can be useful if the intention is to perform additional checks on the exception raised:with self.assertRaises(SomeException) as cm: do_something() the_exception = cm.exception self.assertEqual(the_exception.error_code, 3)
在 2.7 版更改: Added the ability to use
assertRaises()
as a context manager.
-
assertRaisesRegexp
(exception, regexp, callable, *args, **kwds)¶ -
assertRaisesRegexp
(exception, regexp) Like
assertRaises()
but also tests that regexp matches on the string representation of the raised exception. regexp may be a regular expression object or a string containing a regular expression suitable for use byre.search()
. Examples:self.assertRaisesRegexp(ValueError, "invalid literal for.*XYZ'$", int, 'XYZ')
或者:
with self.assertRaisesRegexp(ValueError, 'literal'): int('XYZ')
2.7 新版功能.
There are also other methods used to perform more specific checks, such as:
Method
Checks that
New in
round(a-b, 7) == 0
round(a-b, 7) != 0
a > b
2.7
a >= b
2.7
a < b
2.7
a <= b
2.7
r.search(s)
2.7
not r.search(s)
2.7
sorted(a) == sorted(b) and works with unhashable objs
2.7
all the key/value pairs in a exist in b
2.7
-
assertAlmostEqual
(first, second, places=7, msg=None, delta=None)¶ -
assertNotAlmostEqual
(first, second, places=7, msg=None, delta=None)¶ Test that first and second are approximately (or not approximately) equal by computing the difference, rounding to the given number of decimal places (default 7), and comparing to zero. Note that these methods round the values to the given number of decimal places (i.e. like the
round()
function) and not significant digits.If delta is supplied instead of places then the difference between first and second must be less or equal to (or greater than) delta.
Supplying both delta and places raises a
TypeError
.在 2.7 版更改:
assertAlmostEqual()
automatically considers almost equal objects that compare equal.assertNotAlmostEqual()
automatically fails if the objects compare equal. Added the delta keyword argument.
-
assertGreater
(first, second, msg=None)¶ -
assertGreaterEqual
(first, second, msg=None)¶ -
assertLess
(first, second, msg=None)¶ -
assertLessEqual
(first, second, msg=None)¶ Test that first is respectively >, >=, < or <= than second depending on the method name. If not, the test will fail:
>>> self.assertGreaterEqual(3, 4) AssertionError: "3" unexpectedly not greater than or equal to "4"
2.7 新版功能.
-
assertRegexpMatches
(text, regexp, msg=None)¶ Test that a regexp search matches text. In case of failure, the error message will include the pattern and the text (or the pattern and the part of text that unexpectedly matched). regexp may be a regular expression object or a string containing a regular expression suitable for use by
re.search()
.2.7 新版功能.
-
assertNotRegexpMatches
(text, regexp, msg=None)¶ Verifies that a regexp search does not match text. Fails with an error message including the pattern and the part of text that matches. regexp may be a regular expression object or a string containing a regular expression suitable for use by
re.search()
.2.7 新版功能.
-
assertItemsEqual
(actual, expected, msg=None)¶ Test that sequence expected contains the same elements as actual, regardless of their order. When they don’t, an error message listing the differences between the sequences will be generated.
Duplicate elements are not ignored when comparing actual and expected. It verifies if each element has the same count in both sequences. It is the equivalent of
assertEqual(sorted(expected), sorted(actual))
but it works with sequences of unhashable objects as well.In Python 3, this method is named
assertCountEqual
.2.7 新版功能.
-
assertDictContainsSubset
(expected, actual, msg=None)¶ Tests whether the key/value pairs in dictionary actual are a superset of those in expected. If not, an error message listing the missing keys and mismatched values is generated.
2.7 新版功能.
3.2 版后已移除.
The
assertEqual()
method dispatches the equality check for objects of the same type to different type-specific methods. These methods are already implemented for most of the built-in types, but it’s also possible to register new methods usingaddTypeEqualityFunc()
:-
addTypeEqualityFunc
(typeobj, function)¶ Registers a type-specific method called by
assertEqual()
to check if two objects of exactly the same typeobj (not subclasses) compare equal. function must take two positional arguments and a third msg=None keyword argument just asassertEqual()
does. It must raiseself.failureException(msg)
when inequality between the first two parameters is detected – possibly providing useful information and explaining the inequalities in details in the error message.2.7 新版功能.
The list of type-specific methods automatically used by
assertEqual()
are summarized in the following table. Note that it’s usually not necessary to invoke these methods directly.Method
Used to compare
New in
strings
2.7
sequences
2.7
lists
2.7
tuples
2.7
sets or frozensets
2.7
dicts
2.7
-
assertMultiLineEqual
(first, second, msg=None)¶ Test that the multiline string first is equal to the string second. When not equal a diff of the two strings highlighting the differences will be included in the error message. This method is used by default when comparing Unicode strings with
assertEqual()
.2.7 新版功能.
-
assertSequenceEqual
(seq1, seq2, msg=None, seq_type=None)¶ Tests that two sequences are equal. If a seq_type is supplied, both seq1 and seq2 must be instances of seq_type or a failure will be raised. If the sequences are different an error message is constructed that shows the difference between the two.
This method is not called directly by
assertEqual()
, but it’s used to implementassertListEqual()
andassertTupleEqual()
.2.7 新版功能.
-
assertListEqual
(list1, list2, msg=None)¶ -
assertTupleEqual
(tuple1, tuple2, msg=None)¶ Tests that two lists or tuples are equal. If not, an error message is constructed that shows only the differences between the two. An error is also raised if either of the parameters are of the wrong type. These methods are used by default when comparing lists or tuples with
assertEqual()
.2.7 新版功能.
-
assertSetEqual
(set1, set2, msg=None)¶ Tests that two sets are equal. If not, an error message is constructed that lists the differences between the sets. This method is used by default when comparing sets or frozensets with
assertEqual()
.Fails if either of set1 or set2 does not have a
set.difference()
method.2.7 新版功能.
-
assertDictEqual
(expected, actual, msg=None)¶ Test that two dictionaries are equal. If not, an error message is constructed that shows the differences in the dictionaries. This method will be used by default to compare dictionaries in calls to
assertEqual()
.2.7 新版功能.
Finally the
TestCase
provides the following methods and attributes:-
fail
(msg=None)¶ Signals a test failure unconditionally, with msg or
None
for the error message.
-
failureException
¶ This class attribute gives the exception raised by the test method. If a test framework needs to use a specialized exception, possibly to carry additional information, it must subclass this exception in order to “play fair” with the framework. The initial value of this attribute is
AssertionError
.
-
longMessage
¶ If set to
True
then any explicit failure message you pass in to the assert methods will be appended to the end of the normal failure message. The normal messages contain useful information about the objects involved, for example the message from assertEqual shows you the repr of the two unequal objects. Setting this attribute toTrue
allows you to have a custom error message in addition to the normal one.This attribute defaults to
False
, meaning that a custom message passed to an assert method will silence the normal message.The class setting can be overridden in individual tests by assigning an instance attribute to
True
orFalse
before calling the assert methods.2.7 新版功能.
-
maxDiff
¶ This attribute controls the maximum length of diffs output by assert methods that report diffs on failure. It defaults to 80*8 characters. Assert methods affected by this attribute are
assertSequenceEqual()
(including all the sequence comparison methods that delegate to it),assertDictEqual()
andassertMultiLineEqual()
.Setting
maxDiff
toNone
means that there is no maximum length of diffs.2.7 新版功能.
Testing frameworks can use the following methods to collect information on the test:
-
countTestCases
()¶ Return the number of tests represented by this test object. For
TestCase
instances, this will always be1
.
-
defaultTestResult
()¶ Return an instance of the test result class that should be used for this test case class (if no other result instance is provided to the
run()
method).For
TestCase
instances, this will always be an instance ofTestResult
; subclasses ofTestCase
should override this as necessary.
-
id
()¶ Return a string identifying the specific test case. This is usually the full name of the test method, including the module and class name.
-
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, orNone
.
-
addCleanup
(function, *args, **kwargs)¶ Add a function to be called after
tearDown()
to cleanup resources used during the test. Functions will be called in reverse order to the order they are added (LIFO). They are called with any arguments and keyword arguments passed intoaddCleanup()
when they are added.If
setUp()
fails, meaning thattearDown()
is not called, then any cleanup functions added will still be called.2.7 新版功能.
-
doCleanups
()¶ This method is called unconditionally after
tearDown()
, or aftersetUp()
ifsetUp()
raises an exception.It is responsible for calling all the cleanup functions added by
addCleanup()
. If you need cleanup functions to be called prior totearDown()
then you can calldoCleanups()
yourself.doCleanups()
pops methods off the stack of cleanup functions one at a time, so it can be called at any time.2.7 新版功能.
-
-
class
unittest.
FunctionTestCase
(testFunc, setUp=None, tearDown=None, description=None)¶ This class implements the portion of the
TestCase
interface which allows the test runner to drive the test, but does not provide the methods which test code can use to check and report errors. This is used to create test cases using legacy test code, allowing it to be integrated into aunittest
-based test framework.
25.3.7.1.1. Deprecated aliases¶
For historical reasons, some of the TestCase
methods had one or more
aliases that are now deprecated. The following table lists the correct names
along with their deprecated aliases:
方法名
Deprecated alias(es)
failUnlessEqual, assertEquals
failIfEqual
failUnless, assert_
failIf
failUnlessRaises
failUnlessAlmostEqual
failIfAlmostEqual
2.7 版后已移除: the aliases listed in the second column
25.3.7.2. Grouping tests¶
-
class
unittest.
TestSuite
(tests=())¶ This class represents an aggregation of individual test cases and test suites. The class presents the interface needed by the test runner to allow it to be run as any other test case. Running a
TestSuite
instance is the same as iterating over the suite, running each test individually.If tests is given, it must be an iterable of individual test cases or other test suites that will be used to build the suite initially. Additional methods are provided to add test cases and suites to the collection later on.
TestSuite
objects behave much likeTestCase
objects, except they do not actually implement a test. Instead, they are used to aggregate tests into groups of tests that should be run together. Some additional methods are available to add tests toTestSuite
instances:-
addTests
(tests)¶ Add all the tests from an iterable of
TestCase
andTestSuite
instances to this test suite.This is equivalent to iterating over tests, calling
addTest()
for each element.
TestSuite
shares the following methods withTestCase
:-
run
(result)¶ Run the tests associated with this suite, collecting the result into the test result object passed as result. Note that unlike
TestCase.run()
,TestSuite.run()
requires the result object to be passed in.
-
debug
()¶ Run the tests associated with this suite without collecting the result. This allows exceptions raised by the test to be propagated to the caller and can be used to support running tests under a debugger.
-
countTestCases
()¶ Return the number of tests represented by this test object, including all individual tests and sub-suites.
-
__iter__
()¶ Tests grouped by a
TestSuite
are always accessed by iteration. Subclasses can lazily provide tests by overriding__iter__()
. Note that this method maybe called several times on a single suite (for example when counting tests or comparing for equality) so the tests returned must be the same for repeated iterations.在 2.7 版更改: In earlier versions the
TestSuite
accessed tests directly rather than through iteration, so overriding__iter__()
wasn’t sufficient for providing tests.
In the typical usage of a
TestSuite
object, therun()
method is invoked by aTestRunner
rather than by the end-user test harness.-
25.3.7.3. Loading and running tests¶
-
class
unittest.
TestLoader
¶ The
TestLoader
class is used to create test suites from classes and modules. Normally, there is no need to create an instance of this class; theunittest
module provides an instance that can be shared asunittest.defaultTestLoader
. Using a subclass or instance, however, allows customization of some configurable properties.TestLoader
objects have the following methods:-
loadTestsFromTestCase
(testCaseClass)¶ Return a suite of all test cases contained in the
TestCase
-derivedtestCaseClass
.
-
loadTestsFromModule
(module)¶ Return a suite of all test cases contained in the given module. This method searches module for classes derived from
TestCase
and creates an instance of the class for each test method defined for the class.注解
While using a hierarchy of
TestCase
-derived classes can be convenient in sharing fixtures and helper functions, defining test methods on base classes that are not intended to be instantiated directly does not play well with this method. Doing so, however, can be useful when the fixtures are different and defined in subclasses.If a module provides a
load_tests
function it will be called to load the tests. This allows modules to customize test loading. This is the load_tests protocol.在 2.7 版更改: Support for
load_tests
added.
-
loadTestsFromName
(name, module=None)¶ Return a suite of all test cases given a string specifier.
The specifier name is a “dotted name” that may resolve either to a module, a test case class, a test method within a test case class, a
TestSuite
instance, or a callable object which returns aTestCase
orTestSuite
instance. These checks are applied in the order listed here; that is, a method on a possible test case class will be picked up as “a test method within a test case class”, rather than “a callable object”.For example, if you have a module
SampleTests
containing aTestCase
-derived classSampleTestCase
with three test methods (test_one()
,test_two()
, andtest_three()
), the specifier'SampleTests.SampleTestCase'
would cause this method to return a suite which will run all three test methods. Using the specifier'SampleTests.SampleTestCase.test_two'
would cause it to return a test suite which will run only thetest_two()
test method. The specifier can refer to modules and packages which have not been imported; they will be imported as a side-effect.The method optionally resolves name relative to the given module.
-
loadTestsFromNames
(names, module=None)¶ Similar to
loadTestsFromName()
, but takes a sequence of names rather than a single name. The return value is a test suite which supports all the tests defined for each name.
-
getTestCaseNames
(testCaseClass)¶ Return a sorted sequence of method names found within testCaseClass; this should be a subclass of
TestCase
.
-
discover
(start_dir, pattern='test*.py', top_level_dir=None)¶ Find all the test modules by recursing into subdirectories from the specified start directory, and return a TestSuite object containing them. Only test files that match pattern will be loaded. (Using shell style pattern matching.) Only module names that are importable (i.e. are valid Python identifiers) will be loaded.
All test modules must be importable from the top level of the project. If the start directory is not the top level directory then the top level directory must be specified separately.
If importing a module fails, for example due to a syntax error, then this will be recorded as a single error and discovery will continue.
If a test package name (directory with
__init__.py
) matches the pattern then the package will be checked for aload_tests
function. If this exists then it will be called with loader, tests, pattern.If load_tests exists then discovery does not recurse into the package,
load_tests
is responsible for loading all tests in the package.The pattern is deliberately not stored as a loader attribute so that packages can continue discovery themselves. top_level_dir is stored so
load_tests
does not need to pass this argument in toloader.discover()
.start_dir can be a dotted module name as well as a directory.
2.7 新版功能.
The following attributes of a
TestLoader
can be configured either by subclassing or assignment on an instance:-
testMethodPrefix
¶ String giving the prefix of method names which will be interpreted as test methods. The default value is
'test'
.This affects
getTestCaseNames()
and all theloadTestsFrom*()
methods.
-
sortTestMethodsUsing
¶ Function to be used to compare method names when sorting them in
getTestCaseNames()
and all theloadTestsFrom*()
methods. The default value is the built-incmp()
function; the attribute can also be set toNone
to disable the sort.
-
-
class
unittest.
TestResult
¶ This class is used to compile information about which tests have succeeded and which have failed.
A
TestResult
object stores the results of a set of tests. TheTestCase
andTestSuite
classes ensure that results are properly recorded; test authors do not need to worry about recording the outcome of tests.Testing frameworks built on top of
unittest
may want access to theTestResult
object generated by running a set of tests for reporting purposes; aTestResult
instance is returned by theTestRunner.run()
method for this purpose.TestResult
instances have the following attributes that will be of interest when inspecting the results of running a set of tests:-
errors
¶ A list containing 2-tuples of
TestCase
instances and strings holding formatted tracebacks. Each tuple represents a test which raised an unexpected exception.在 2.2 版更改: Contains formatted tracebacks instead of
sys.exc_info()
results.
-
failures
¶ A list containing 2-tuples of
TestCase
instances and strings holding formatted tracebacks. Each tuple represents a test where a failure was explicitly signalled using theTestCase.assert*()
methods.在 2.2 版更改: Contains formatted tracebacks instead of
sys.exc_info()
results.
-
skipped
¶ A list containing 2-tuples of
TestCase
instances and strings holding the reason for skipping the test.2.7 新版功能.
-
expectedFailures
¶ A list containing 2-tuples of
TestCase
instances and strings holding formatted tracebacks. Each tuple represents an expected failure of the test case.
-
unexpectedSuccesses
¶ A list containing
TestCase
instances that were marked as expected failures, but succeeded.
-
testsRun
¶ The total number of tests run so far.
-
buffer
¶ If set to true,
sys.stdout
andsys.stderr
will be buffered in betweenstartTest()
andstopTest()
being called. Collected output will only be echoed onto the realsys.stdout
andsys.stderr
if the test fails or errors. Any output is also attached to the failure / error message.2.7 新版功能.
-
failfast
¶ If set to true
stop()
will be called on the first failure or error, halting the test run.2.7 新版功能.
-
wasSuccessful
()¶ Return
True
if all tests run so far have passed, otherwise returnsFalse
.
-
stop
()¶ This method can be called to signal that the set of tests being run should be aborted by setting the
shouldStop
attribute toTrue
.TestRunner
objects should respect this flag and return without running any additional tests.For example, this feature is used by the
TextTestRunner
class to stop the test framework when the user signals an interrupt from the keyboard. Interactive tools which provideTestRunner
implementations can use this in a similar manner.
The following methods of the
TestResult
class are used to maintain the internal data structures, and may be extended in subclasses to support additional reporting requirements. This is particularly useful in building tools which support interactive reporting while tests are being run.-
startTest
(test)¶ Called when the test case test is about to be run.
-
stopTest
(test)¶ Called after the test case test has been executed, regardless of the outcome.
-
startTestRun
()¶ Called once before any tests are executed.
2.7 新版功能.
-
stopTestRun
()¶ Called once after all tests are executed.
2.7 新版功能.
-
addError
(test, err)¶ Called when the test case test raises an unexpected exception. err is a tuple of the form returned by
sys.exc_info()
:(type, value, traceback)
.The default implementation appends a tuple
(test, formatted_err)
to the instance’serrors
attribute, where formatted_err is a formatted traceback derived from err.
-
addFailure
(test, err)¶ Called when the test case test signals a failure. err is a tuple of the form returned by
sys.exc_info()
:(type, value, traceback)
.The default implementation appends a tuple
(test, formatted_err)
to the instance’sfailures
attribute, where formatted_err is a formatted traceback derived from err.
-
addSuccess
(test)¶ Called when the test case test succeeds.
The default implementation does nothing.
-
addSkip
(test, reason)¶ Called when the test case test is skipped. reason is the reason the test gave for skipping.
The default implementation appends a tuple
(test, reason)
to the instance’sskipped
attribute.
-
addExpectedFailure
(test, err)¶ Called when the test case test fails, but was marked with the
expectedFailure()
decorator.The default implementation appends a tuple
(test, formatted_err)
to the instance’sexpectedFailures
attribute, where formatted_err is a formatted traceback derived from err.
-
addUnexpectedSuccess
(test)¶ Called when the test case test was marked with the
expectedFailure()
decorator, but succeeded.The default implementation appends the test to the instance’s
unexpectedSuccesses
attribute.
-
-
class
unittest.
TextTestResult
(stream, descriptions, verbosity)¶ A concrete implementation of
TestResult
used by theTextTestRunner
.2.7 新版功能: This class was previously named
_TextTestResult
. The old name still exists as an alias but is deprecated.
-
unittest.
defaultTestLoader
¶ Instance of the
TestLoader
class intended to be shared. If no customization of theTestLoader
is needed, this instance can be used instead of repeatedly creating new instances.
-
class
unittest.
TextTestRunner
(stream=sys.stderr, descriptions=True, verbosity=1, failfast=False, buffer=False, resultclass=None)¶ A basic test runner implementation which prints results on standard error. It has a few configurable parameters, but is essentially very simple. Graphical applications which run test suites should provide alternate implementations.
-
_makeResult
()¶ This method returns the instance of
TestResult
used byrun()
. It is not intended to be called directly, but can be overridden in subclasses to provide a customTestResult
._makeResult()
instantiates the class or callable passed in theTextTestRunner
constructor as theresultclass
argument. It defaults toTextTestResult
if noresultclass
is provided. The result class is instantiated with the following arguments:stream, descriptions, verbosity
-
-
unittest.
main
([module[, defaultTest[, argv[, testRunner[, testLoader[, exit[, verbosity[, failfast[, catchbreak[, buffer]]]]]]]]]])¶ A command-line program that loads a set of tests from module and runs them; this is primarily for making test modules conveniently executable. The simplest use for this function is to include the following line at the end of a test script:
if __name__ == '__main__': unittest.main()
You can run tests with more detailed information by passing in the verbosity argument:
if __name__ == '__main__': unittest.main(verbosity=2)
The defaultTest argument is the name of the test to run if no test names are specified via argv. If not specified or
None
and no test names are provided via argv, all tests found in module are run.The argv argument can be a list of options passed to the program, with the first element being the program name. If not specified or
None
, the values ofsys.argv
are used.The testRunner argument can either be a test runner class or an already created instance of it. By default
main
callssys.exit()
with an exit code indicating success or failure of the tests run.The testLoader argument has to be a
TestLoader
instance, and defaults todefaultTestLoader
.main
supports being used from the interactive interpreter by passing in the argumentexit=False
. This displays the result on standard output without callingsys.exit()
:>>> from unittest import main >>> main(module='test_module', exit=False)
The failfast, catchbreak and buffer parameters have the same effect as the same-name command-line options.
Calling
main
actually returns an instance of theTestProgram
class. This stores the result of the tests run as theresult
attribute.在 2.7 版更改: The exit, verbosity, failfast, catchbreak and buffer parameters were added.
25.3.7.3.1. load_tests Protocol¶
2.7 新版功能.
Modules or packages can customize how tests are loaded from them during normal
test runs or test discovery by implementing a function called load_tests
.
If a test module defines load_tests
it will be called by
TestLoader.loadTestsFromModule()
with the following arguments:
load_tests(loader, standard_tests, None)
It should return a TestSuite
.
loader is the instance of TestLoader
doing the loading.
standard_tests are the tests that would be loaded by default from the
module. It is common for test modules to only want to add or remove tests
from the standard set of tests.
The third argument is used when loading packages as part of test discovery.
A typical load_tests
function that loads tests from a specific set of
TestCase
classes may look like:
test_cases = (TestCase1, TestCase2, TestCase3)
def load_tests(loader, tests, pattern):
suite = TestSuite()
for test_class in test_cases:
tests = loader.loadTestsFromTestCase(test_class)
suite.addTests(tests)
return suite
If discovery is started, either from the command line or by calling
TestLoader.discover()
, with a pattern that matches a package
name then the package __init__.py
will be checked for load_tests
.
注解
The default pattern is 'test*.py'
. This matches all Python files
that start with 'test'
but won’t match any test directories.
A pattern like 'test*'
will match test packages as well as
modules.
If the package __init__.py
defines load_tests
then it will be
called and discovery not continued into the package. load_tests
is called with the following arguments:
load_tests(loader, standard_tests, pattern)
This should return a TestSuite
representing all the tests
from the package. (standard_tests
will only contain tests
collected from __init__.py
.)
Because the pattern is passed into load_tests
the package is free to
continue (and potentially modify) test discovery. A ‘do nothing’
load_tests
function for a test package would look like:
def load_tests(loader, standard_tests, pattern):
# top level directory cached on loader instance
this_dir = os.path.dirname(__file__)
package_tests = loader.discover(start_dir=this_dir, pattern=pattern)
standard_tests.addTests(package_tests)
return standard_tests
25.3.8. Class and Module Fixtures¶
Class and module level fixtures are implemented in TestSuite
. When
the test suite encounters a test from a new class then tearDownClass()
from the previous class (if there is one) is called, followed by
setUpClass()
from the new class.
Similarly if a test is from a different module from the previous test then
tearDownModule
from the previous module is run, followed by
setUpModule
from the new module.
After all the tests have run the final tearDownClass
and
tearDownModule
are run.
Note that shared fixtures do not play well with [potential] features like test parallelization and they break test isolation. They should be used with care.
The default ordering of tests created by the unittest test loaders is to group
all tests from the same modules and classes together. This will lead to
setUpClass
/ setUpModule
(etc) being called exactly once per class and
module. If you randomize the order, so that tests from different modules and
classes are adjacent to each other, then these shared fixture functions may be
called multiple times in a single test run.
Shared fixtures are not intended to work with suites with non-standard
ordering. A BaseTestSuite
still exists for frameworks that don’t want to
support shared fixtures.
If there are any exceptions raised during one of the shared fixture functions
the test is reported as an error. Because there is no corresponding test
instance an _ErrorHolder
object (that has the same interface as a
TestCase
) is created to represent the error. If you are just using
the standard unittest test runner then this detail doesn’t matter, but if you
are a framework author it may be relevant.
25.3.8.1. setUpClass and tearDownClass¶
These must be implemented as class methods:
import unittest
class Test(unittest.TestCase):
@classmethod
def setUpClass(cls):
cls._connection = createExpensiveConnectionObject()
@classmethod
def tearDownClass(cls):
cls._connection.destroy()
If you want the setUpClass
and tearDownClass
on base classes called
then you must call up to them yourself. The implementations in
TestCase
are empty.
If an exception is raised during a setUpClass
then the tests in the class
are not run and the tearDownClass
is not run. Skipped classes will not
have setUpClass
or tearDownClass
run. If the exception is a
SkipTest
exception then the class will be reported as having been skipped
instead of as an error.
25.3.8.2. setUpModule and tearDownModule¶
These should be implemented as functions:
def setUpModule():
createConnection()
def tearDownModule():
closeConnection()
If an exception is raised in a setUpModule
then none of the tests in the
module will be run and the tearDownModule
will not be run. If the exception is a
SkipTest
exception then the module will be reported as having been skipped
instead of as an error.
25.3.9. Signal Handling¶
The -c/--catch
command-line option to unittest,
along with the catchbreak
parameter to unittest.main()
, provide
more friendly handling of control-C during a test run. With catch break
behavior enabled control-C will allow the currently running test to complete,
and the test run will then end and report all the results so far. A second
control-c will raise a KeyboardInterrupt
in the usual way.
The control-c handling signal handler attempts to remain compatible with code or
tests that install their own signal.SIGINT
handler. If the unittest
handler is called but isn’t the installed signal.SIGINT
handler,
i.e. it has been replaced by the system under test and delegated to, then it
calls the default handler. This will normally be the expected behavior by code
that replaces an installed handler and delegates to it. For individual tests
that need unittest
control-c handling disabled the removeHandler()
decorator can be used.
There are a few utility functions for framework authors to enable control-c handling functionality within test frameworks.
-
unittest.
installHandler
()¶ Install the control-c handler. When a
signal.SIGINT
is received (usually in response to the user pressing control-c) all registered results havestop()
called.2.7 新版功能.
-
unittest.
registerResult
(result)¶ Register a
TestResult
object for control-c handling. Registering a result stores a weak reference to it, so it doesn’t prevent the result from being garbage collected.Registering a
TestResult
object has no side-effects if control-c handling is not enabled, so test frameworks can unconditionally register all results they create independently of whether or not handling is enabled.2.7 新版功能.
-
unittest.
removeResult
(result)¶ Remove a registered result. Once a result has been removed then
stop()
will no longer be called on that result object in response to a control-c.2.7 新版功能.
-
unittest.
removeHandler
(function=None)¶ When called without arguments this function removes the control-c handler if it has been installed. This function can also be used as a test decorator to temporarily remove the handler while the test is being executed:
@unittest.removeHandler def test_signal_handling(self): ...
2.7 新版功能.