From be26f1ace4532196b579c903ca77e1cd947a3bd4 Mon Sep 17 00:00:00 2001 From: Russell Keith-Magee Date: Mon, 18 Jan 2010 23:49:20 +0000 Subject: [PATCH] Updated the docs around test runners to encourage the use of **kwargs in the test runner constructor. git-svn-id: http://code.djangoproject.com/svn/django/trunk@12259 bcc190cf-cafb-0310-a4f2-bffc1f526a37 --- docs/topics/testing.txt | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/docs/topics/testing.txt b/docs/topics/testing.txt index 82039581e0..18a1052483 100644 --- a/docs/topics/testing.txt +++ b/docs/topics/testing.txt @@ -1269,7 +1269,7 @@ testing behavior. This class defines the ``run_tests()`` entry point, plus a selection of other methods that are used to by ``run_tests()`` to set up, execute and tear down the test suite. -.. class:: DjangoTestSuiteRunner(verbosity=1, interactive=True, failfast=True) +.. class:: DjangoTestSuiteRunner(verbosity=1, interactive=True, failfast=True, **kwargs) ``verbosity`` determines the amount of notification and debug information that will be printed to the console; ``0`` is no output, ``1`` is normal @@ -1284,6 +1284,12 @@ set up, execute and tear down the test suite. If ``failfast`` is ``True``, the test suite will stop running after the first test failure is detected. + Django will, from time to time, extend the capabilities of + the test runner by adding new arguments. The ``**kwargs`` declaration + allows for this expansion. If you subclass ``DjangoTestSuiteRunner`` or + write your own test runner, ensure accept and handle the ``**kwargs`` + parameter. + .. method:: DjangoTestSuiteRunner.run_tests(test_labels, extra_tests=[]) Run the test suite.