diff options
| -rw-r--r-- | Doc/library/unittest.rst | 22 |
1 files changed, 15 insertions, 7 deletions
diff --git a/Doc/library/unittest.rst b/Doc/library/unittest.rst index a698e13..4d3216b 100644 --- a/Doc/library/unittest.rst +++ b/Doc/library/unittest.rst @@ -1926,9 +1926,10 @@ Loading and running tests testLoader=unittest.defaultTestLoader, exit=True, verbosity=1, \ failfast=None, catchbreak=None, buffer=None, warnings=None) - 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 - include the following line at the end of a test script:: + 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() @@ -1939,10 +1940,17 @@ Loading and running tests if __name__ == '__main__': 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 created instance of it. By default ``main`` calls :func:`sys.exit` with 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 argument ``exit=False``. This displays the result on standard output without calling :func:`sys.exit`:: @@ -1950,7 +1958,7 @@ Loading and running tests >>> from unittest import main >>> 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`_. 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. .. versionchanged:: 3.1 - The ``exit`` parameter was added. + The *exit* parameter was added. .. versionchanged:: 3.2 - The ``verbosity``, ``failfast``, ``catchbreak``, ``buffer`` - and ``warnings`` parameters were added. + The *verbosity*, *failfast*, *catchbreak*, *buffer* + and *warnings* parameters were added. load_tests Protocol |