diff options
| author | Carl Meyer <carl@oddbird.net> | 2013-05-27 14:41:39 -0600 |
|---|---|---|
| committer | Carl Meyer <carl@oddbird.net> | 2013-05-27 14:55:08 -0600 |
| commit | cd79f337233be3f2dfa22316314c9d4834093e31 (patch) | |
| tree | 6dc06e1069521cb84261cb56a7b32c7d42085a41 /docs | |
| parent | 0027f1390443f199087d0784920450d93a359614 (diff) | |
Fixed #20503 - Moved doctest utilities in with the rest of the deprecated test code.
The ``DocTestRunner`` and ``OutputChecker`` were formerly in
``django.test.testcases``, now they are in ``django.test.simple``. This avoids
triggering the ``django.test._doctest`` deprecation message with any import
from ``django.test``. Since these utility classes are undocumented internal
API, they can be moved without a separate deprecation process.
Also removed the deprecation warnings specific to these classes, as they are
now covered by the module-level warning in ``django.test.simple``.
Thanks Anssi for the report.
Refs #17365.
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/internals/deprecation.txt | 6 | ||||
| -rw-r--r-- | docs/releases/1.6.txt | 18 |
2 files changed, 8 insertions, 16 deletions
diff --git a/docs/internals/deprecation.txt b/docs/internals/deprecation.txt index c4bbc3b7a4..45f82b49e6 100644 --- a/docs/internals/deprecation.txt +++ b/docs/internals/deprecation.txt @@ -386,10 +386,8 @@ these changes. ``django.test.simple.DjangoTestSuiteRunner`` will be removed. Instead use ``django.test.runner.DiscoverRunner``. -* The module ``django.test._doctest`` and the classes - ``django.test.testcases.DocTestRunner`` and - ``django.test.testcases.OutputChecker`` will be removed. Instead use the - doctest module from the Python standard library. +* The module ``django.test._doctest`` will be removed. Instead use the doctest + module from the Python standard library. * The ``CACHE_MIDDLEWARE_ANONYMOUS_ONLY`` setting will be removed. diff --git a/docs/releases/1.6.txt b/docs/releases/1.6.txt index 4f4b615835..c01128c684 100644 --- a/docs/releases/1.6.txt +++ b/docs/releases/1.6.txt @@ -345,21 +345,15 @@ support some types of tests that were supported by the previous runner: your test suite, follow the `recommendations in the Python documentation`_. Django bundles a modified version of the :mod:`doctest` module from the Python -standard library (in ``django.test._doctest``) in order to allow passing in a -custom ``DocTestRunner`` when instantiating a ``DocTestSuite``, and includes -some additional doctest utilities (``django.test.testcases.DocTestRunner`` -turns on the ``ELLIPSIS`` option by default, and -``django.test.testcases.OutputChecker`` provides better matching of XML, JSON, -and numeric data types). - -These utilities are deprecated and will be removed in Django 1.8; doctest -suites should be updated to work with the standard library's doctest module (or -converted to unittest-compatible tests). +standard library (in ``django.test._doctest``) and includes some additional +doctest utilities. These utilities are deprecated and will be removed in Django +1.8; doctest suites should be updated to work with the standard library's +doctest module (or converted to unittest-compatible tests). If you wish to delay updates to your test suite, you can set your :setting:`TEST_RUNNER` setting to ``django.test.simple.DjangoTestSuiteRunner`` -to fully restore the old test behavior. ``DjangoTestSuiteRunner`` is -deprecated but will not be removed from Django until version 1.8. +to fully restore the old test behavior. ``DjangoTestSuiteRunner`` is deprecated +but will not be removed from Django until version 1.8. .. _recommendations in the Python documentation: http://docs.python.org/2/library/doctest.html#unittest-api |
