Commit ddb20df0 authored by Michael Foord's avatar Michael Foord

Adding documentation for new unittest.main() parameters

parent 76a23c17
...@@ -1665,8 +1665,8 @@ Loading and running tests ...@@ -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 ...@@ -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
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment