From 564b317fb53e9925b86ca5ef5d3bbcf99387602c Mon Sep 17 00:00:00 2001 From: Gregor Gärtner Date: Sat, 24 Sep 2022 11:29:58 +0100 Subject: Refs #33990 -- Renamed SimpleTestCase.assertFormsetError() to assertFormSetError(). Co-Authored-By: Michael Howitz --- docs/internals/deprecation.txt | 2 ++ docs/releases/1.6.txt | 2 +- docs/releases/4.0.1.txt | 3 +-- docs/releases/4.1.txt | 8 ++++---- docs/releases/4.2.txt | 3 +++ docs/topics/testing/tools.txt | 15 ++++++++++----- 6 files changed, 21 insertions(+), 12 deletions(-) (limited to 'docs') diff --git a/docs/internals/deprecation.txt b/docs/internals/deprecation.txt index a5b76c13ab..cbde99fb06 100644 --- a/docs/internals/deprecation.txt +++ b/docs/internals/deprecation.txt @@ -35,6 +35,8 @@ details on these changes. * The ``map_width`` and ``map_height`` attributes of ``BaseGeometryWidget`` will be removed. +* The ``SimpleTestCase.assertFormsetError()`` method will be removed. + .. _deprecation-removed-in-5.0: 5.0 diff --git a/docs/releases/1.6.txt b/docs/releases/1.6.txt index 4109565448..2d77c7dc85 100644 --- a/docs/releases/1.6.txt +++ b/docs/releases/1.6.txt @@ -321,7 +321,7 @@ Minor features * The :class:`~django.test.SimpleTestCase` class includes a new assertion helper for testing formset errors: - :meth:`~django.test.SimpleTestCase.assertFormsetError`. + ``django.test.SimpleTestCase.assertFormsetError()``. * The list of related fields added to a :class:`~django.db.models.query.QuerySet` by diff --git a/docs/releases/4.0.1.txt b/docs/releases/4.0.1.txt index d5e129a153..dba3f1783f 100644 --- a/docs/releases/4.0.1.txt +++ b/docs/releases/4.0.1.txt @@ -50,8 +50,7 @@ Bugfixes ======== * Fixed a regression in Django 4.0 that caused a crash of - :meth:`~django.test.SimpleTestCase.assertFormsetError` on a formset named - ``form`` (:ticket:`33346`). + ``assertFormsetError()`` on a formset named ``form`` (:ticket:`33346`). * Fixed a bug in Django 4.0 that caused a crash on booleans with the ``RedisCache`` backend (:ticket:`33361`). diff --git a/docs/releases/4.1.txt b/docs/releases/4.1.txt index 08fb7c2abc..55e19e09ea 100644 --- a/docs/releases/4.1.txt +++ b/docs/releases/4.1.txt @@ -407,8 +407,8 @@ Tests raises a ``RuntimeError``, the same as outside of tests. * :meth:`.SimpleTestCase.assertFormError` and - :meth:`~.SimpleTestCase.assertFormsetError` now support passing a - form/formset object directly. + :meth:`assertFormsetError() ` + now support passing a form/formset object directly. URLs ~~~~ @@ -671,8 +671,8 @@ Miscellaneous * The undocumented ability to pass ``errors=None`` to :meth:`.SimpleTestCase.assertFormError` and - :meth:`~.SimpleTestCase.assertFormsetError` is deprecated. Use ``errors=[]`` - instead. + :meth:`assertFormsetError() ` + is deprecated. Use ``errors=[]`` instead. * ``django.contrib.sessions.serializers.PickleSerializer`` is deprecated due to the risk of remote code execution. diff --git a/docs/releases/4.2.txt b/docs/releases/4.2.txt index 5774bfef7b..33035d7881 100644 --- a/docs/releases/4.2.txt +++ b/docs/releases/4.2.txt @@ -419,3 +419,6 @@ Miscellaneous * The ``map_height`` and ``map_width`` attributes of ``BaseGeometryWidget`` are deprecated, use CSS to size map widgets instead. + +* ``SimpleTestCase.assertFormsetError()`` is deprecated in favor of + ``assertFormSetError()``. diff --git a/docs/topics/testing/tools.txt b/docs/topics/testing/tools.txt index 1f235d920b..4e2003acde 100644 --- a/docs/topics/testing/tools.txt +++ b/docs/topics/testing/tools.txt @@ -1573,16 +1573,16 @@ your test suite. ``assertFormError()`` is deprecated and will be removed in Django 5.0. Use the form instance directly instead. -.. method:: SimpleTestCase.assertFormsetError(formset, form_index, field, errors, msg_prefix='') +.. method:: SimpleTestCase.assertFormSetError(formset, form_index, field, errors, msg_prefix='') Asserts that the ``formset`` raises the provided list of errors when rendered. - ``formset`` is a ``Formset`` instance. The formset must be bound but not - necessarily validated (``assertFormsetError()`` will automatically call the + ``formset`` is a ``FormSet`` instance. The formset must be bound but not + necessarily validated (``assertFormSetError()`` will automatically call the ``full_clean()`` on the formset). - ``form_index`` is the number of the form within the ``Formset`` (starting + ``form_index`` is the number of the form within the ``FormSet`` (starting from 0). Use ``form_index=None`` to check the formset's non-form errors, i.e. the errors you get when calling ``formset.non_form_errors()``. In that case you must also use ``field=None``. @@ -1593,9 +1593,14 @@ your test suite. .. deprecated:: 4.1 Support for passing a response object and a formset name to - ``assertFormsetError()`` is deprecated and will be removed in Django + ``assertFormSetError()`` is deprecated and will be removed in Django 5.0. Use the formset instance directly instead. + .. deprecated:: 4.2 + + The ``assertFormsetError()`` assertion method is deprecated. Use + ``assertFormSetError()`` instead. + .. method:: SimpleTestCase.assertContains(response, text, count=None, status_code=200, msg_prefix='', html=False) Asserts that a :class:`response ` produced the -- cgit v1.3