test0908
/
django
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Fixed #33301 -- Clarified the type of arguments required by custom assertions.

This commit is contained in:
Baptiste Mispelon 2021-11-20 14:17:34 +01:00 committed by Mariusz Felisiak
parent 75ee7057e9
commit 528691d1b6
1 changed files with 24 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
docs/topics/testing/tools.txt
View File

@ -1478,8 +1478,11 @@ your test suite.
Asserts that a field on a form raises the provided list of errors when Asserts that a field on a form raises the provided list of errors when
rendered on the form. rendered on the form.
``response`` must be a response instance returned by the
:class:`test client <django.test.Response>`.
``form`` is the name the ``Form`` instance was given in the template ``form`` is the name the ``Form`` instance was given in the template
context. context of the response.
``field`` is the name of the field on the form to check. If ``field`` ``field`` is the name of the field on the form to check. If ``field``
has a value of ``None``, non-field errors (errors you can access via has a value of ``None``, non-field errors (errors you can access via
@ -1494,8 +1497,11 @@ your test suite.
Asserts that the ``formset`` raises the provided list of errors when Asserts that the ``formset`` raises the provided list of errors when
rendered. rendered.
``response`` must be a response instance returned by the
:class:`test client <django.test.Response>`.
``formset`` is the name the ``Formset`` instance was given in the template ``formset`` is the name the ``Formset`` instance was given in the template
context. context of the response.
``form_index`` is the number of the form within the ``Formset``. If ``form_index`` is the number of the form within the ``Formset``. If
``form_index`` has a value of ``None``, non-form errors (errors you can ``form_index`` has a value of ``None``, non-form errors (errors you can
@ -1511,9 +1517,10 @@ your test suite.
.. method:: SimpleTestCase.assertContains(response, text, count=None, status_code=200, msg_prefix='', html=False) .. method:: SimpleTestCase.assertContains(response, text, count=None, status_code=200, msg_prefix='', html=False)
Asserts that a ``Response`` instance produced the given ``status_code`` and Asserts that a :class:`response <django.http.HttpResponse>` produced the
that ``text`` appears in the content of the response. If ``count`` is given :attr:`~django.http.HttpResponse.status_code` and that ``text``
provided, ``text`` must occur exactly ``count`` times in the response. appears in its :attr:`~django.http.HttpResponse.content`. If ``count``
is provided, ``text`` must occur exactly ``count`` times in the response.
Set ``html`` to ``True`` to handle ``text`` as HTML. The comparison with Set ``html`` to ``True`` to handle ``text`` as HTML. The comparison with
the response content will be based on HTML semantics instead of the response content will be based on HTML semantics instead of
@ -1523,8 +1530,9 @@ your test suite.
.. method:: SimpleTestCase.assertNotContains(response, text, status_code=200, msg_prefix='', html=False) .. method:: SimpleTestCase.assertNotContains(response, text, status_code=200, msg_prefix='', html=False)
Asserts that a ``Response`` instance produced the given ``status_code`` and Asserts that a :class:`response <django.http.HttpResponse>` produced the
that ``text`` does *not* appear in the content of the response. given :attr:`~django.http.HttpResponse.status_code` and that ``text`` does
*not* appear in its :attr:`~django.http.HttpResponse.content`.
Set ``html`` to ``True`` to handle ``text`` as HTML. The comparison with Set ``html`` to ``True`` to handle ``text`` as HTML. The comparison with
the response content will be based on HTML semantics instead of the response content will be based on HTML semantics instead of
@ -1537,9 +1545,12 @@ your test suite.
Asserts that the template with the given name was used in rendering the Asserts that the template with the given name was used in rendering the
response. response.
The name is a string such as ``'admin/index.html'``. ``response`` must be a response instance returned by the
:class:`test client <django.test.Response>`.
The count argument is an integer indicating the number of times the ``template_name`` should be a string such as ``'admin/index.html'``.
The ``count`` argument is an integer indicating the number of times the
template should be rendered. Default is ``None``, meaning that the template template should be rendered. Default is ``None``, meaning that the template
should be rendered one or more times. should be rendered one or more times.
@ -1567,9 +1578,10 @@ your test suite.
.. method:: SimpleTestCase.assertRedirects(response, expected_url, status_code=302, target_status_code=200, msg_prefix='', fetch_redirect_response=True) .. method:: SimpleTestCase.assertRedirects(response, expected_url, status_code=302, target_status_code=200, msg_prefix='', fetch_redirect_response=True)
Asserts that the response returned a ``status_code`` redirect status, Asserts that the :class:`response <django.http.HttpResponse>` returned a
redirected to ``expected_url`` (including any ``GET`` data), and that the :attr:`~django.http.HttpResponse.status_code` redirect status, redirected
final page was received with ``target_status_code``. to ``expected_url`` (including any ``GET`` data), and that the final page
was received with ``target_status_code``.
If your request used the ``follow`` argument, the ``expected_url`` and If your request used the ``follow`` argument, the ``expected_url`` and
``target_status_code`` will be the url and status code for the final ``target_status_code`` will be the url and status code for the final