mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-09-26 18:29:57 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 10

Adding documentation for new unittest.main() parameters

Browse source
This commit is contained in:
Michael Foord 2010-04-04 23:28:44 +00:00
parent 76a23c17bc
commit ddb20df018
1 changed files with 7 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

10
Doc/library/unittest.rst
View file

@ -1665,8 +1665,8 @@ Loading and running tests
stream, descriptions, verbosity stream, descriptions, verbosity
.. function:: main([module[, defaultTest[, argv[, testRunner[, testLoader[, exit, [verbosity]]]]]]]) .. function:: main([module[, defaultTest[, argv[, testRunner[, testLoader[, exit[, verbosity[, failfast[, catchbreak[,buffer]]]]]]]]]])
,
A command-line program that runs a set of tests; this is primarily for making A command-line program that runs a set of tests; this is primarily for making
test modules conveniently executable. The simplest use for this function is to test modules conveniently executable. The simplest use for this function is to
include the following line at the end of a test script:: include the following line at the end of a test script::
@ -1691,11 +1691,15 @@ Loading and running tests
>>> from unittest import main >>> from unittest import main
>>> main(module='test_module', exit=False) >>> main(module='test_module', exit=False)
The ``failfast``, ``catchbreak`` and ``buffer`` parameters have the same
effect as the `failfast, catch and buffer command line options`_.
Calling ``main`` actually returns an instance of the ``TestProgram`` class. Calling ``main`` actually returns an instance of the ``TestProgram`` class.
This stores the result of the tests run as the ``result`` attribute. This stores the result of the tests run as the ``result`` attribute.
.. versionchanged:: 2.7 .. versionchanged:: 2.7
The ``exit`` and ``verbosity`` parameters were added. The ``exit``, ``verbosity``, ``failfast``, ``catchbreak`` and ``buffer``
parameters were added.
load_tests Protocol load_tests Protocol