summaryrefslogtreecommitdiff
path: root/docs/topics
diff options
context:
space:
mode:
authorSarah Boyce <42296566+sarahboyce@users.noreply.github.com>2024-12-12 16:17:09 +0100
committerSarah Boyce <42296566+sarahboyce@users.noreply.github.com>2025-01-15 22:28:37 +0100
commit810edfd7428e12bd640573112c6c1a024ac33da2 (patch)
treec6dd06c80384f51aa373dfff5e0285d753a8830f /docs/topics
parent9b5ad4056ccf9ff7ea548f72d28eb66c1b4f84cc (diff)
Removed versionadded/changed annotations for 5.1.
This also removes remaining versionadded/changed annotations for older versions.
Diffstat (limited to 'docs/topics')
-rw-r--r--docs/topics/auth/default.txt22
-rw-r--r--docs/topics/checks.txt4
-rw-r--r--docs/topics/http/sessions.txt87
-rw-r--r--docs/topics/testing/advanced.txt8
-rw-r--r--docs/topics/testing/tools.txt59
5 files changed, 0 insertions, 180 deletions
diff --git a/docs/topics/auth/default.txt b/docs/topics/auth/default.txt
index a22cebbf15..06d7c2fc26 100644
--- a/docs/topics/auth/default.txt
+++ b/docs/topics/auth/default.txt
@@ -601,10 +601,6 @@ The ``login_required`` decorator
:func:`django.contrib.admin.views.decorators.staff_member_required`
decorator a useful alternative to ``login_required()``.
-.. versionchanged:: 5.1
-
- Support for wrapping asynchronous view functions was added.
-
.. currentmodule:: django.contrib.auth.mixins
The ``LoginRequiredMixin`` mixin
@@ -647,8 +643,6 @@ inheritance list.
The ``login_not_required`` decorator
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.. versionadded:: 5.1
-
When :class:`~django.contrib.auth.middleware.LoginRequiredMiddleware` is
installed, all views require authentication by default. Some views, such as the
login view, may need to disable this behavior.
@@ -719,11 +713,6 @@ email in the desired domain and if not, redirects to the login page::
@user_passes_test(email_check, login_url="/login/")
def my_view(request): ...
- .. versionchanged:: 5.1
-
- Support for wrapping asynchronous view functions and using asynchronous
- test callables was added.
-
.. currentmodule:: django.contrib.auth.mixins
.. class:: UserPassesTestMixin
@@ -828,10 +817,6 @@ The ``permission_required`` decorator
``redirect_authenticated_user=True`` and the logged-in user doesn't have
all of the required permissions.
-.. versionchanged:: 5.1
-
- Support for wrapping asynchronous view functions was added.
-
.. currentmodule:: django.contrib.auth.mixins
The ``PermissionRequiredMixin`` mixin
@@ -1640,15 +1625,8 @@ provides several built-in forms located in :mod:`django.contrib.auth.forms`:
Takes the ``user`` as the first positional argument.
- .. versionchanged:: 5.1
-
- Option to disable (or reenable) password-based authentication was
- added.
-
.. class:: AdminUserCreationForm
- .. versionadded:: 5.1.1
-
A form used in the admin interface to create a new user. Inherits from
:class:`UserCreationForm`.
diff --git a/docs/topics/checks.txt b/docs/topics/checks.txt
index 94ba66f0db..b0e8c2987f 100644
--- a/docs/topics/checks.txt
+++ b/docs/topics/checks.txt
@@ -195,10 +195,6 @@ the only difference is that the check is a classmethod, not an instance method::
# ... your own checks ...
return errors
-.. versionchanged:: 5.1
-
- In older versions, template engines didn't implement a ``check()`` method.
-
Writing tests
-------------
diff --git a/docs/topics/http/sessions.txt b/docs/topics/http/sessions.txt
index e670292ca8..03559da3ed 100644
--- a/docs/topics/http/sessions.txt
+++ b/docs/topics/http/sessions.txt
@@ -81,10 +81,6 @@ writing to the cache fails, the exception is handled and logged via the
:ref:`sessions logger <django-contrib-sessions-logger>`, to avoid failing an
otherwise successful write operation.
-.. versionchanged:: 5.1
-
- Handling and logging of exceptions when writing to the cache was added.
-
Session reads use the cache, or the database if the data has been evicted from
the cache. To use this backend, set :setting:`SESSION_ENGINE` to
``"django.contrib.sessions.backends.cached_db"``, and follow the configuration
@@ -202,14 +198,8 @@ You can edit it multiple times.
Example: ``fav_color = request.session.get('fav_color', 'red')``
- .. versionchanged:: 5.1
-
- ``aget()`` function was added.
-
.. method:: aset(key, value)
- .. versionadded:: 5.1
-
Example: ``await request.session.aset('fav_color', 'red')``
.. method:: update(dict)
@@ -219,10 +209,6 @@ You can edit it multiple times.
Example: ``request.session.update({'fav_color': 'red'})``
- .. versionchanged:: 5.1
-
- ``aupdate()`` function was added.
-
.. method:: pop(key, default=__not_given)
.. method:: apop(key, default=__not_given)
@@ -230,55 +216,31 @@ You can edit it multiple times.
Example: ``fav_color = request.session.pop('fav_color', 'blue')``
- .. versionchanged:: 5.1
-
- ``apop()`` function was added.
-
.. method:: keys()
.. method:: akeys()
*Asynchronous version*: ``akeys()``
- .. versionchanged:: 5.1
-
- ``akeys()`` function was added.
-
.. method:: values()
.. method:: avalues()
*Asynchronous version*: ``avalues()``
- .. versionchanged:: 5.1
-
- ``avalues()`` function was added.
-
.. method:: has_key(key)
.. method:: ahas_key(key)
*Asynchronous version*: ``ahas_key()``
- .. versionchanged:: 5.1
-
- ``ahas_key()`` function was added.
-
.. method:: items()
.. method:: aitems()
*Asynchronous version*: ``aitems()``
- .. versionchanged:: 5.1
-
- ``aitems()`` function was added.
-
.. method:: setdefault()
.. method:: asetdefault()
*Asynchronous version*: ``asetdefault()``
- .. versionchanged:: 5.1
-
- ``asetdefault()`` function was added.
-
.. method:: clear()
It also has these methods:
@@ -293,10 +255,6 @@ You can edit it multiple times.
can't be accessed again from the user's browser (for example, the
:func:`django.contrib.auth.logout()` function calls it).
- .. versionchanged:: 5.1
-
- ``aflush()`` function was added.
-
.. method:: set_test_cookie()
.. method:: aset_test_cookie()
@@ -307,10 +265,6 @@ You can edit it multiple times.
until the user's next page request. See `Setting test cookies`_ below for
more information.
- .. versionchanged:: 5.1
-
- ``aset_test_cookie()`` function was added.
-
.. method:: test_cookie_worked()
.. method:: atest_cookie_worked()
@@ -322,10 +276,6 @@ You can edit it multiple times.
previous, separate page request.
See `Setting test cookies`_ below for more information.
- .. versionchanged:: 5.1
-
- ``atest_cookie_worked()`` function was added.
-
.. method:: delete_test_cookie()
.. method:: adelete_test_cookie()
@@ -333,10 +283,6 @@ You can edit it multiple times.
Deletes the test cookie. Use this to clean up after yourself.
- .. versionchanged:: 5.1
-
- ``adelete_test_cookie()`` function was added.
-
.. method:: get_session_cookie_age()
Returns the value of the setting :setting:`SESSION_COOKIE_AGE`. This can
@@ -368,10 +314,6 @@ You can edit it multiple times.
purposes. Session expiration is computed from the last time the
session was *modified*.
- .. versionchanged:: 5.1
-
- ``aset_expiry()`` function was added.
-
.. method:: get_expiry_age()
.. method:: aget_expiry_age()
@@ -404,10 +346,6 @@ You can edit it multiple times.
expires_at = modification + timedelta(seconds=settings.SESSION_COOKIE_AGE)
- .. versionchanged:: 5.1
-
- ``aget_expiry_age()`` function was added.
-
.. method:: get_expiry_date()
.. method:: aget_expiry_date()
@@ -420,10 +358,6 @@ You can edit it multiple times.
This function accepts the same keyword arguments as
:meth:`get_expiry_age`, and similar notes on usage apply.
- .. versionchanged:: 5.1
-
- ``aget_expiry_date()`` function was added.
-
.. method:: get_expire_at_browser_close()
.. method:: aget_expire_at_browser_close()
@@ -432,10 +366,6 @@ You can edit it multiple times.
Returns either ``True`` or ``False``, depending on whether the user's
session cookie will expire when the user's web browser is closed.
- .. versionchanged:: 5.1
-
- ``aget_expire_at_browser_close()`` function was added.
-
.. method:: clear_expired()
.. method:: aclear_expired()
@@ -444,10 +374,6 @@ You can edit it multiple times.
Removes expired sessions from the session store. This class method is
called by :djadmin:`clearsessions`.
- .. versionchanged:: 5.1
-
- ``aclear_expired()`` function was added.
-
.. method:: cycle_key()
.. method:: acycle_key()
@@ -457,10 +383,6 @@ You can edit it multiple times.
:func:`django.contrib.auth.login()` calls this method to mitigate against
session fixation.
- .. versionchanged:: 5.1
-
- ``acycle_key()`` function was added.
-
.. _session_serialization:
Session serialization
@@ -616,10 +538,6 @@ Here's a typical usage example::
request.session.set_test_cookie()
return render(request, "foo/login_form.html")
-.. versionchanged:: 5.1
-
- Support for setting test cookies in asynchronous view functions was added.
-
Using sessions out of views
===========================
@@ -868,11 +786,6 @@ You can extend the session engines, but doing so with database-backed session
engines generally requires some extra effort (see the next section for
details).
-.. versionchanged:: 5.1
-
- ``aexists()``, ``acreate()``, ``asave()``, ``adelete()``, ``aload()``, and
- ``aclear_expired()`` methods were added.
-
.. _extending-database-backed-session-engines:
Extending database-backed session engines
diff --git a/docs/topics/testing/advanced.txt b/docs/topics/testing/advanced.txt
index 6b03f0f82b..1b0c172ef9 100644
--- a/docs/topics/testing/advanced.txt
+++ b/docs/topics/testing/advanced.txt
@@ -32,10 +32,6 @@ restricted subset of the test client API:
attributes must be supplied by the test itself if required
for the view to function properly.
-.. versionchanged:: 5.1
-
- The ``query_params`` parameter was added.
-
Example
-------
@@ -89,10 +85,6 @@ difference being that it returns ``ASGIRequest`` instances rather than
Arbitrary keyword arguments in ``defaults`` are added directly into the ASGI
scope.
-.. versionchanged:: 5.1
-
- The ``query_params`` parameter was added.
-
Testing class-based views
=========================
diff --git a/docs/topics/testing/tools.txt b/docs/topics/testing/tools.txt
index dba2a9cce8..a03ad7da78 100644
--- a/docs/topics/testing/tools.txt
+++ b/docs/topics/testing/tools.txt
@@ -158,10 +158,6 @@ Use the ``django.test.Client`` class to make requests.
The ``json_encoder`` argument allows setting a custom JSON encoder for
the JSON serialization that's described in :meth:`post`.
- .. versionchanged:: 5.1
-
- The ``query_params`` argument was added.
-
Once you have a ``Client`` instance, you can call any of the following
methods:
@@ -241,10 +237,6 @@ Use the ``django.test.Client`` class to make requests.
If you set ``secure`` to ``True`` the client will emulate an HTTPS
request.
- .. versionchanged:: 5.1
-
- The ``query_params`` argument was added.
-
.. method:: Client.post(path, data=None, content_type=MULTIPART_CONTENT, follow=False, secure=False, *, headers=None, query_params=None, **extra)
Makes a POST request on the provided ``path`` and returns a
@@ -360,10 +352,6 @@ Use the ``django.test.Client`` class to make requests.
If you set ``secure`` to ``True`` the client will emulate an HTTPS
request.
- .. versionchanged:: 5.1
-
- The ``query_params`` argument was added.
-
.. method:: Client.head(path, data=None, follow=False, secure=False, *, headers=None, query_params=None, **extra)
Makes a HEAD request on the provided ``path`` and returns a
@@ -371,10 +359,6 @@ Use the ``django.test.Client`` class to make requests.
including the ``follow``, ``secure``, ``headers``, ``query_params``,
and ``extra`` parameters, except it does not return a message body.
- .. versionchanged:: 5.1
-
- The ``query_params`` argument was added.
-
.. method:: Client.options(path, data='', content_type='application/octet-stream', follow=False, secure=False, *, headers=None, query_params=None, **extra)
Makes an OPTIONS request on the provided ``path`` and returns a
@@ -386,10 +370,6 @@ Use the ``django.test.Client`` class to make requests.
The ``follow``, ``secure``, ``headers``, ``query_params``, and
``extra`` parameters act the same as for :meth:`Client.get`.
- .. versionchanged:: 5.1
-
- The ``query_params`` argument was added.
-
.. method:: Client.put(path, data='', content_type='application/octet-stream', follow=False, secure=False, *, headers=None, query_params=None, **extra)
Makes a PUT request on the provided ``path`` and returns a
@@ -401,10 +381,6 @@ Use the ``django.test.Client`` class to make requests.
The ``follow``, ``secure``, ``headers``, ``query_params``, and
``extra`` parameters act the same as for :meth:`Client.get`.
- .. versionchanged:: 5.1
-
- The ``query_params`` argument was added.
-
.. method:: Client.patch(path, data='', content_type='application/octet-stream', follow=False, secure=False, *, headers=None, query_params=None, **extra)
Makes a PATCH request on the provided ``path`` and returns a
@@ -413,10 +389,6 @@ Use the ``django.test.Client`` class to make requests.
The ``follow``, ``secure``, ``headers``, ``query_params``, and
``extra`` parameters act the same as for :meth:`Client.get`.
- .. versionchanged:: 5.1
-
- The ``query_params`` argument was added.
-
.. method:: Client.delete(path, data='', content_type='application/octet-stream', follow=False, secure=False, *, headers=None, query_params=None, **extra)
Makes a DELETE request on the provided ``path`` and returns a
@@ -428,10 +400,6 @@ Use the ``django.test.Client`` class to make requests.
The ``follow``, ``secure``, ``headers``, ``query_params``, and
``extra`` parameters act the same as for :meth:`Client.get`.
- .. versionchanged:: 5.1
-
- The ``query_params`` argument was added.
-
.. method:: Client.trace(path, follow=False, secure=False, *, headers=None, query_params=None, **extra)
Makes a TRACE request on the provided ``path`` and returns a
@@ -444,10 +412,6 @@ Use the ``django.test.Client`` class to make requests.
The ``follow``, ``secure``, ``headers``, ``query_params``, and
``extra`` parameters act the same as for :meth:`Client.get`.
- .. versionchanged:: 5.1
-
- The ``query_params`` argument was added.
-
.. method:: Client.login(**credentials)
.. method:: Client.alogin(**credentials)
@@ -1548,11 +1512,6 @@ LOCALE_PATHS, LANGUAGE_CODE Default translation and loaded translations
STATIC_ROOT, STATIC_URL, STORAGES Storages configuration
================================= ========================
-.. versionchanged:: 5.1
-
- Resetting the default renderer when the ``FORM_RENDERER`` setting is
- changed was added.
-
Isolating apps
--------------
@@ -1740,10 +1699,6 @@ your test suite.
attribute ordering is not significant. See
:meth:`~SimpleTestCase.assertHTMLEqual` for more details.
- .. versionchanged:: 5.1
-
- In older versions, error messages didn't contain the response content.
-
.. method:: SimpleTestCase.assertNotContains(response, text, status_code=200, msg_prefix='', html=False)
Asserts that a :class:`response <django.http.HttpResponse>` produced the
@@ -1756,10 +1711,6 @@ your test suite.
attribute ordering is not significant. See
:meth:`~SimpleTestCase.assertHTMLEqual` for more details.
- .. versionchanged:: 5.1
-
- In older versions, error messages didn't contain the response content.
-
.. method:: SimpleTestCase.assertTemplateUsed(response, template_name, msg_prefix='', count=None)
Asserts that the template with the given name was used in rendering the
@@ -1896,14 +1847,8 @@ your test suite.
Whitespace in most cases is ignored, and attribute ordering is not
significant. See :meth:`~SimpleTestCase.assertHTMLEqual` for more details.
- .. versionchanged:: 5.1
-
- In older versions, error messages didn't contain the ``haystack``.
-
.. method:: SimpleTestCase.assertNotInHTML(needle, haystack, msg_prefix="")
- .. versionadded:: 5.1
-
Asserts that the HTML fragment ``needle`` is *not* contained in the
``haystack``.
@@ -2058,10 +2003,6 @@ test client, with the following exceptions:
>>> c = AsyncClient()
>>> c.get("/customers/details/", {"name": "fred", "age": 7}, ACCEPT="application/json")
-.. versionchanged:: 5.1
-
- The ``query_params`` argument was added.
-
Using ``AsyncClient`` any method that makes a request must be awaited::
async def test_my_thing(self):