mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-10-02 05:12:23 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 8

bpo-19950: Clarify unittest TestCase instance use. (GH-6875) (GH-6938)

Browse source 
(cherry picked from commit dff46758f2)

Co-authored-by: Gregory P. Smith <greg@krypto.org> Google
This commit is contained in:
Miss Islington (bot) 2018-05-18 17:55:45 -07:00 • committed by Gregory P. Smith
parent a3a554a536
commit 436972e295
1 changed files with 14 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

22
Doc/library/unittest.rst
View file

@ -361,8 +361,9 @@ testing code::
Note that in order to test something, we use one of the :meth:`assert\*` Note that in order to test something, we use one of the :meth:`assert\*`
methods provided by the :class:`TestCase` base class. If the test fails, an methods provided by the :class:`TestCase` base class. If the test fails, an
exception will be raised, and :mod:`unittest` will identify the test case as a exception will be raised with an explanatory message, and :mod:`unittest`
:dfn:`failure`. Any other exceptions will be treated as :dfn:`errors`. will identify the test case as a :dfn:`failure`. Any other exceptions will be
treated as :dfn:`errors`.
Tests can be numerous, and their set-up can be repetitive. Luckily, we Tests can be numerous, and their set-up can be repetitive. Luckily, we
can factor out set-up code by implementing a method called can factor out set-up code by implementing a method called
@ -408,13 +409,18 @@ after the test method has been run::
If :meth:`~TestCase.setUp` succeeded, :meth:`~TestCase.tearDown` will be If :meth:`~TestCase.setUp` succeeded, :meth:`~TestCase.tearDown` will be
run whether the test method succeeded or not. run whether the test method succeeded or not.
Such a working environment for the testing code is called a :dfn:`fixture`. Such a working environment for the testing code is called a
:dfn:`test fixture`. A new TestCase instance is created as a unique
test fixture used to execute each individual test method. Thus
`~TestCase.setUp`, `~TestCase.tearDown`, and `~TestCase.__init__`
will be called once per test.
Test case instances are grouped together according to the features they test. It is recommended that you use TestCase implementations to group tests together
:mod:`unittest` provides a mechanism for this: the :dfn:`test suite`, according to the features they test. :mod:`unittest` provides a mechanism for
represented by :mod:`unittest`'s :class:`TestSuite` class. In most cases, this: the :dfn:`test suite`, represented by :mod:`unittest`'s
calling :func:`unittest.main` will do the right thing and collect all the :class:`TestSuite` class. In most cases, calling :func:`unittest.main` will do
module's test cases for you, and then execute them. the right thing and collect all the module's test cases for you and execute
them.
However, should you want to customize the building of your test suite, However, should you want to customize the building of your test suite,
you can do it yourself:: you can do it yourself::