Skip to content


Subversion checkout URL

You can clone with
Download ZIP
Browse files

[1.5.x] Fixed #20177 - Corrected docs for django.test.utils.setup_tes…


Thanks for the report.

Backport of bc02a96 from master
  • Loading branch information...
commit acd9dc3888aa8af881b917028062c3bdca6e610c 1 parent 1ef423b
@timgraham timgraham authored
Showing with 15 additions and 4 deletions.
  1. +7 −0 docs/intro/tutorial05.txt
  2. +8 −4 docs/topics/testing/advanced.txt
7 docs/intro/tutorial05.txt
@@ -327,6 +327,13 @@ in the shell::
>>> from django.test.utils import setup_test_environment
>>> setup_test_environment()
+:meth:`~django.test.utils.setup_test_environment` installs a template renderer
+which will allow us to examine some additional attributes on responses such as
+``response.context`` that otherwise wouldn't be available. Note that this
+method *does not* setup a test database, so the following will be run against
+the existing database and the output may differ slightly depending on what
+polls you already created.
Next we need to import the test client class (later in ```` we will use
the :class:`django.test.TestCase` class, which comes with its own client, so
this won't be required)::
12 docs/topics/testing/advanced.txt
@@ -163,10 +163,12 @@ environment first. Django provides a convenience method to do this::
>>> from django.test.utils import setup_test_environment
>>> setup_test_environment()
-This convenience method sets up the test database, and puts other
-Django features into modes that allow for repeatable testing.
+:func:`~django.test.utils.setup_test_environment` puts several Django features
+into modes that allow for repeatable testing, but does not create the test
+databases; :func:`django.test.simple.DjangoTestSuiteRunner.setup_databases`
+takes care of that.
-The call to :meth:`~django.test.utils.setup_test_environment` is made
+The call to :func:`~django.test.utils.setup_test_environment` is made
automatically as part of the setup of ``./ test``. You only
need to manually invoke this method if you're not using running your
tests via Django's test runner.
@@ -286,7 +288,9 @@ Methods
.. method:: DjangoTestSuiteRunner.setup_test_environment(**kwargs)
- Sets up the test environment ready for testing.
+ Sets up the test environment by calling
+ :func:`~django.test.utils.setup_test_environment` and setting
+ :setting:`DEBUG` to ``False``.
.. method:: DjangoTestSuiteRunner.build_suite(test_labels, extra_tests=None, **kwargs)

0 comments on commit acd9dc3

Please sign in to comment.
Something went wrong with that request. Please try again.