traverseda
/
cpython
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

#14558: document the module, argv, and testLoader args of unittest.main.

This commit is contained in:
Ezio Melotti 2012-04-30 19:10:28 +03:00
parent 290416f364
commit 3d6d7a5e15
1 changed files with 15 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
Doc/library/unittest.rst
View File

@ -1926,9 +1926,10 @@ Loading and running tests
testLoader=unittest.defaultTestLoader, exit=True, verbosity=1, \ testLoader=unittest.defaultTestLoader, exit=True, verbosity=1, \
failfast=None, catchbreak=None, buffer=None, warnings=None) failfast=None, catchbreak=None, buffer=None, warnings=None)
A command-line program that runs a set of tests; this is primarily for making A command-line program that loads a set of tests from *module* and runs them;
test modules conveniently executable. The simplest use for this function is to this is primarily for making test modules conveniently executable.
include the following line at the end of a test script:: The simplest use for this function is to include the following line at the
end of a test script::
if __name__ == '__main__': if __name__ == '__main__':
unittest.main() unittest.main()
@ -1939,10 +1940,17 @@ Loading and running tests
if __name__ == '__main__': if __name__ == '__main__':
unittest.main(verbosity=2) unittest.main(verbosity=2)
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 of :data:`sys.argv` are used.
The *testRunner* argument can either be a test runner class or an already The *testRunner* argument can either be a test runner class or an already
created instance of it. By default ``main`` calls :func:`sys.exit` with created instance of it. By default ``main`` calls :func:`sys.exit` with
an exit code indicating success or failure of the tests run. an exit code indicating success or failure of the tests run.
The *testLoader* argument has to be a :class:`TestLoader` instance,
and defaults to :data:`defaultTestLoader`.
``main`` supports being used from the interactive interpreter by passing in the ``main`` supports being used from the interactive interpreter by passing in the
argument ``exit=False``. This displays the result on standard output without argument ``exit=False``. This displays the result on standard output without
calling :func:`sys.exit`:: calling :func:`sys.exit`::
@ -1950,7 +1958,7 @@ 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 The *failfast*, *catchbreak* and *buffer* parameters have the same
effect as the same-name `command-line options`_. effect as the same-name `command-line options`_.
The *warning* argument specifies the :ref:`warning filter <warning-filter>` The *warning* argument specifies the :ref:`warning filter <warning-filter>`
@ -1962,11 +1970,11 @@ Loading and running tests
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:: 3.1 .. versionchanged:: 3.1
The ``exit`` parameter was added. The *exit* parameter was added.
.. versionchanged:: 3.2 .. versionchanged:: 3.2
The ``verbosity``, ``failfast``, ``catchbreak``, ``buffer`` The *verbosity*, *failfast*, *catchbreak*, *buffer*
and ``warnings`` parameters were added. and *warnings* parameters were added.
load_tests Protocol load_tests Protocol