Add files using upload-large-folder tool

testbed/django__django/docs/releases/1.6.3.txt

@@ -0,0 +1,183 @@
+==========================
+Django 1.6.3 release notes
+==========================
+
+*April 21, 2014*
+
+Django 1.6.3 fixes several bugs in 1.6.2, including three security issues,
+and makes one backwards-incompatible change:
+
+Unexpected code execution using ``reverse()``
+=============================================
+
+Django's URL handling is based on a mapping of regex patterns
+(representing the URLs) to callable views, and Django's own processing
+consists of matching a requested URL against those patterns to
+determine the appropriate view to invoke.
+
+Django also provides a convenience function -- ``reverse()`` -- which performs
+this process in the opposite direction. The ``reverse()`` function takes
+information about a view and returns a URL which would invoke that view. Use
+of ``reverse()`` is encouraged for application developers, as the output of
+``reverse()`` is always based on the current URL patterns, meaning developers
+do not need to change other code when making changes to URLs.
+
+One argument signature for ``reverse()`` is to pass a dotted Python
+path to the desired view. In this situation, Django will import the
+module indicated by that dotted path as part of generating the
+resulting URL. If such a module has import-time side effects, those
+side effects will occur.
+
+Thus it is possible for an attacker to cause unexpected code
+execution, given the following conditions:
+
+1. One or more views are present which construct a URL based on user
+   input (commonly, a "next" parameter in a querystring indicating
+   where to redirect upon successful completion of an action).
+
+2. One or more modules are known to an attacker to exist on the
+   server's Python import path, which perform code execution with side
+   effects on importing.
+
+To remedy this, ``reverse()`` will now only accept and import dotted
+paths based on the view-containing modules listed in the project's :doc:`URL
+pattern configuration </topics/http/urls>`, so as to ensure that only modules
+the developer intended to be imported in this fashion can or will be imported.
+
+Caching of anonymous pages could reveal CSRF token
+==================================================
+
+Django includes both a :doc:`caching framework </topics/cache>` and a system
+for :doc:`preventing cross-site request forgery (CSRF) attacks
+</ref/csrf/>`. The CSRF-protection system is based on a random nonce
+sent to the client in a cookie which must be sent by the client on future
+requests and, in forms, a hidden value which must be submitted back with the
+form.
+
+The caching framework includes an option to cache responses to
+anonymous (i.e., unauthenticated) clients.
+
+When the first anonymous request to a given page is by a client which
+did not have a CSRF cookie, the cache framework will also cache the
+CSRF cookie and serve the same nonce to other anonymous clients who
+do not have a CSRF cookie. This can allow an attacker to obtain a
+valid CSRF cookie value and perform attacks which bypass the check for
+the cookie.
+
+To remedy this, the caching framework will no longer cache such
+responses. The heuristic for this will be:
+
+1. If the incoming request did not submit any cookies, and
+
+2. If the response did send one or more cookies, and
+
+3. If the ``Vary: Cookie`` header is set on the response, then the
+   response will not be cached.
+
+MySQL typecasting
+=================
+
+The MySQL database is known to "typecast" on certain queries; for
+example, when querying a table which contains string values, but using
+a query which filters based on an integer value, MySQL will first
+silently coerce the strings to integers and return a result based on that.
+
+If a query is performed without first converting values to the
+appropriate type, this can produce unexpected results, similar to what
+would occur if the query itself had been manipulated.
+
+Django's model field classes are aware of their own types and most
+such classes perform explicit conversion of query arguments to the
+correct database-level type before querying. However, three model
+field classes did not correctly convert their arguments:
+
+* :class:`~django.db.models.FilePathField`
+* :class:`~django.db.models.GenericIPAddressField`
+* ``IPAddressField``
+
+These three fields have been updated to convert their arguments to the
+correct types before querying.
+
+Additionally, developers of custom model fields are now warned via
+documentation to ensure their custom field classes will perform
+appropriate type conversions, and users of the :meth:`raw()
+<django.db.models.query.QuerySet.raw>` and :meth:`extra()
+<django.db.models.query.QuerySet.extra>` query methods -- which allow the
+developer to supply raw SQL or SQL fragments -- will be advised to ensure they
+perform appropriate manual type conversions prior to executing queries.
+
+``select_for_update()`` requires a transaction
+==============================================
+
+Historically, queries that use
+:meth:`~django.db.models.query.QuerySet.select_for_update()` could be
+executed in autocommit mode, outside of a transaction. Before Django
+1.6, Django's automatic transactions mode allowed this to be used to
+lock records until the next write operation. Django 1.6 introduced
+database-level autocommit; since then, execution in such a context
+voids the effect of ``select_for_update()``. It is, therefore, assumed
+now to be an error and raises an exception.
+
+This change was made because such errors can be caused by including an
+app which expects global transactions (e.g. :setting:`ATOMIC_REQUESTS
+<DATABASE-ATOMIC_REQUESTS>` set to ``True``), or Django's old autocommit
+behavior, in a project which runs without them; and further, such
+errors may manifest as data-corruption bugs.
+
+This change may cause test failures if you use ``select_for_update()``
+in a test class which is a subclass of
+:class:`~django.test.TransactionTestCase` rather than
+:class:`~django.test.TestCase`.
+
+Other bugfixes and changes
+==========================
+
+* Content retrieved from the GeoIP library is now properly decoded from its
+  default ``iso-8859-1`` encoding
+  (:ticket:`21996`).
+
+* Fixed ``AttributeError`` when using
+  :meth:`~django.db.models.query.QuerySet.bulk_create` with ``ForeignObject``
+  (:ticket:`21566`).
+
+* Fixed crash of ``QuerySet``\s that use ``F() + timedelta()`` when their query
+  was compiled more once
+  (:ticket:`21643`).
+
+* Prevented custom ``widget`` class attribute of
+  :class:`~django.forms.IntegerField` subclasses from being overwritten by the
+  code in their ``__init__`` method
+  (:ticket:`22245`).
+
+* Improved :func:`~django.utils.html.strip_tags` accuracy (but it still cannot
+  guarantee an HTML-safe result, as stated in the documentation).
+
+* Fixed a regression in the :mod:`django.contrib.gis` SQL compiler for
+  non-concrete fields (:ticket:`22250`).
+
+* Fixed :attr:`ModelAdmin.preserve_filters
+  <django.contrib.admin.ModelAdmin.preserve_filters>` when running a site with
+  a URL prefix (:ticket:`21795`).
+
+* Fixed a crash in the ``find_command`` management utility when the ``PATH``
+  environment variable wasn't set
+  (:ticket:`22256`).
+
+* Fixed :djadmin:`changepassword` on Windows
+  (:ticket:`22364`).
+
+* Avoided shadowing deadlock exceptions on MySQL
+  (:ticket:`22291`).
+
+* Wrapped database exceptions in ``_set_autocommit``
+  (:ticket:`22321`).
+
+* Fixed atomicity when closing a database connection or when the database server
+  disconnects (:ticket:`21239` and :ticket:`21202`)
+
+* Fixed regression in ``prefetch_related`` that caused the related objects
+  query to include an unnecessary join
+  (:ticket:`21760`).
+
+Additionally, Django's vendored version of six, ``django.utils.six`` has been
+upgraded to the latest release (1.6.1).

testbed/django__django/docs/releases/1.8.1.txt

@@ -0,0 +1,97 @@
+==========================
+Django 1.8.1 release notes
+==========================
+
+*May 1, 2015*
+
+Django 1.8.1 fixes several bugs in 1.8 and includes some optimizations in the
+migrations framework.
+
+Bugfixes
+========
+
+* Added support for serializing :class:`~datetime.timedelta` objects in
+  migrations (:ticket:`24566`).
+
+* Restored proper parsing of the :djadmin:`testserver` command's positional
+  arguments (fixture names) (:ticket:`24571`).
+
+* Prevented ``TypeError`` in translation functions ``check_for_language()`` and
+  ``get_language_bidi()`` when translations are deactivated (:ticket:`24569`).
+
+* Fixed :djadmin:`squashmigrations` command when using
+  :class:`~django.db.migrations.operations.SeparateDatabaseAndState`
+  (:ticket:`24278`).
+
+* Stripped microseconds from ``datetime`` values when using an older version of
+  the MySQLdb DB API driver as it does not support fractional seconds
+  (:ticket:`24584`).
+
+* Fixed a migration crash when altering
+  :class:`~django.db.models.ManyToManyField`\s (:ticket:`24513`).
+
+* Fixed a crash with ``QuerySet.update()`` on foreign keys to one-to-one fields
+  (:ticket:`24578`).
+
+* Fixed a regression in the model detail view of
+  :mod:`~django.contrib.admindocs` when a model has a reverse foreign key
+  relation (:ticket:`24624`).
+
+* Prevented arbitrary file inclusions in :mod:`~django.contrib.admindocs`
+  (:ticket:`24625`).
+
+* Fixed a crash with ``QuerySet.update()`` on foreign keys to instances with
+  ``uuid`` primary keys (:ticket:`24611`).
+
+* Fixed database introspection with SQLite 3.8.9 (released April 8, 2015)
+  (:ticket:`24637`).
+
+* Updated ``urlpatterns`` examples generated by :djadmin:`startproject` to
+  remove usage of referencing views by dotted path in
+  ``django.conf.urls.url()`` which is deprecated in Django 1.8
+  (:ticket:`24635`).
+
+* Fixed queries where an expression was referenced in ``order_by()``, but wasn't
+  part of the select clause. An example query is
+  ``qs.annotate(foo=F('field')).values('pk').order_by('foo'))`` (:ticket:`24615`).
+
+* Fixed a database table name quoting regression (:ticket:`24605`).
+
+* Prevented the loss of ``null``/``not null`` column properties during field
+  alteration of MySQL databases (:ticket:`24595`).
+
+* Fixed JavaScript path of ``contrib.admin``’s related field widget when using
+  alternate static file storages (:ticket:`24655`).
+
+* Fixed a migration crash when adding new relations to models
+  (:ticket:`24573`).
+
+* Fixed a migration crash when applying migrations with model managers on
+  Python 3 that were generated on Python 2 (:ticket:`24701`).
+
+* Restored the ability to use iterators as queryset filter arguments
+  (:ticket:`24719`).
+
+* Fixed a migration crash when renaming the target model of a many-to-many
+  relation (:ticket:`24725`).
+
+* Removed flushing of the test database with :option:`test --keepdb`, which
+  prevented apps with data migrations from using the option (:ticket:`24729`).
+
+* Fixed ``makemessages`` crash in some locales (:ticket:`23271`).
+
+* Fixed help text positioning of ``contrib.admin`` fields that use the
+  ``ModelAdmin.filter_horizontal`` and ``filter_vertical`` options
+  (:ticket:`24676`).
+
+* Fixed ``AttributeError: function 'GDALAllRegister' not found`` error when
+  initializing ``contrib.gis`` on Windows.
+
+Optimizations
+=============
+
+* Changed ``ModelState`` to deepcopy fields instead of deconstructing and
+  reconstructing (:ticket:`24591`). This speeds up the rendering of model
+  states and reduces memory usage when running :djadmin:`manage.py migrate
+  <migrate>` (although other changes in this release may negate any performance
+  benefits).

testbed/django__django/docs/releases/1.9.2.txt

@@ -0,0 +1,105 @@
+==========================
+Django 1.9.2 release notes
+==========================
+
+*February 1, 2016*
+
+Django 1.9.2 fixes a security regression in 1.9 and several bugs in 1.9.1. It
+also makes a small backwards incompatible change that hopefully doesn't affect
+any users.
+
+Security issue: User with "change" but not "add" permission can create objects for ``ModelAdmin``’s with ``save_as=True``
+=========================================================================================================================
+
+If a ``ModelAdmin`` uses ``save_as=True`` (not the default), the admin
+provides an option when editing objects to "Save as new". A regression in
+Django 1.9 prevented that form submission from raising a "Permission Denied"
+error for users without the "add" permission.
+
+Backwards incompatible change: ``.py-tpl`` files rewritten in project/app templates
+===================================================================================
+
+The addition of some Django template language syntax to the default app
+template in Django 1.9 means those files now have some invalid Python syntax.
+This causes difficulties for packaging systems that unconditionally
+byte-compile ``*.py`` files.
+
+To remedy this, a ``.py-tpl`` suffix is now used for the project and app
+template files included in Django. The ``.py-tpl`` suffix is replaced with
+``.py`` by the ``startproject`` and ``startapp`` commands. For example, a
+template with the filename ``manage.py-tpl`` will be created as ``manage.py``.
+
+Please file a ticket if you have a custom project template containing
+``.py-tpl`` files and find this behavior problematic.
+
+Bugfixes
+========
+
+* Fixed a regression in ``ConditionalGetMiddleware`` causing ``If-None-Match``
+  checks to always return HTTP 200 (:ticket:`26024`).
+
+* Fixed a regression that caused the "user-tools" items to display on the
+  admin's logout page (:ticket:`26035`).
+
+* Fixed a crash in the translations system when the current language has no
+  translations (:ticket:`26046`).
+
+* Fixed a regression that caused the incorrect day to be selected when opening
+  the admin calendar widget for timezones from GMT+0100 to GMT+1200
+  (:ticket:`24980`).
+
+* Fixed a regression in the admin's edit related model popup that caused an
+  escaped value to be displayed in the select dropdown of the parent window
+  (:ticket:`25997`).
+
+* Fixed a regression in 1.8.8 causing incorrect index handling in migrations on
+  PostgreSQL when adding ``db_index=True`` or ``unique=True`` to a
+  ``CharField`` or ``TextField`` that already had the other specified, or when
+  removing one of them from a field that had both, or when adding
+  ``unique=True`` to a field already listed in ``unique_together``
+  (:ticket:`26034`).
+
+* Fixed a regression where defining a relation on an abstract model's field
+  using a string model name without an app_label no longer resolved that
+  reference to the abstract model's app if using that model in another
+  application (:ticket:`25858`).
+
+* Fixed a crash when destroying an existing test database on MySQL or
+  PostgreSQL (:ticket:`26096`).
+
+* Fixed CSRF cookie check on POST requests when ``USE_X_FORWARDED_PORT=True``
+  (:ticket:`26094`).
+
+* Fixed a ``QuerySet.order_by()`` crash when ordering by a relational field of
+  a ``ManyToManyField`` ``through`` model (:ticket:`26092`).
+
+* Fixed a regression that caused an exception when making database queries on
+  SQLite with more than 2000 parameters when :setting:`DEBUG` is ``True`` on
+  distributions that increase the ``SQLITE_MAX_VARIABLE_NUMBER`` compile-time
+  limit to over 2000, such as Debian (:ticket:`26063`).
+
+* Fixed a crash when using a reverse ``OneToOneField`` in
+  ``ModelAdmin.readonly_fields`` (:ticket:`26060`).
+
+* Fixed a crash when calling the ``migrate`` command in a test case with the
+  ``available_apps`` attribute pointing to an application with migrations
+  disabled using the ``MIGRATION_MODULES`` setting (:ticket:`26135`).
+
+* Restored the ability for testing and debugging tools to determine the
+  template from which a node came from, even during template inheritance or
+  inclusion. Prior to Django 1.9, debugging tools could access the template
+  origin from the node via ``Node.token.source[0]``. This was an undocumented,
+  private API. The origin is now available directly on each node using the
+  ``Node.origin`` attribute (:ticket:`25848`).
+
+* Fixed a regression in Django 1.8.5 that broke copying a ``SimpleLazyObject``
+  with ``copy.copy()`` (:ticket:`26122`).
+
+* Always included ``geometry_field`` in the GeoJSON serializer output regardless
+  of the ``fields`` parameter (:ticket:`26138`).
+
+* Fixed the ``contrib.gis`` map widgets when using
+  ``USE_THOUSAND_SEPARATOR=True`` (:ticket:`20415`).
+
+* Made invalid forms display the initial of values of their disabled fields
+  (:ticket:`26129`).

testbed/django__django/docs/releases/1.9.4.txt

@@ -0,0 +1,8 @@
+==========================
+Django 1.9.4 release notes
+==========================
+
+*March 5, 2016*
+
+Django 1.9.4 fixes a regression on Python 2 in the 1.9.3 security release
+where ``utils.http.is_safe_url()`` crashes on bytestring URLs (:ticket:`26308`).

testbed/django__django/docs/releases/2.0.1.txt

@@ -0,0 +1,45 @@
+==========================
+Django 2.0.1 release notes
+==========================
+
+*January 1, 2018*
+
+Django 2.0.1 fixes several bugs in 2.0.
+
+Bugfixes
+========
+
+* Fixed a regression in Django 1.11 that added newlines between ``MultiWidget``'s
+  subwidgets (:ticket:`28890`).
+
+* Fixed incorrect class-based model index name generation for models with
+  quoted ``db_table`` (:ticket:`28876`).
+
+* Fixed incorrect foreign key constraint name for models with quoted
+  ``db_table`` (:ticket:`28876`).
+
+* Fixed a regression in caching of a ``GenericForeignKey`` when the referenced
+  model instance uses more than one level of multi-table inheritance
+  (:ticket:`28856`).
+
+* Reallowed filtering a queryset with ``GeometryField=None`` (:ticket:`28896`).
+
+* Corrected admin check to allow a ``OneToOneField`` in
+  ``ModelAdmin.autocomplete_fields`` (:ticket:`28898`).
+
+* Fixed a regression on SQLite where ``DecimalField`` returned a result with
+  trailing zeros in the fractional part truncated (:ticket:`28915`).
+
+* Fixed crash in the ``testserver`` command startup (:ticket:`28941`).
+
+* Fixed crash when coercing a translatable URL pattern to ``str``
+  (:ticket:`28947`).
+
+* Fixed crash on SQLite when renaming a field in a model referenced by a
+  ``ManyToManyField`` (:ticket:`28884`).
+
+* Fixed a crash when chaining ``values()`` or ``values_list()`` after
+  ``QuerySet.select_for_update(of=(...))`` (:ticket:`28944`).
+
+* Fixed admin changelist crash when using a query expression in the page's
+  ordering (:ticket:`28958`).

testbed/django__django/docs/releases/2.0.5.txt

@@ -0,0 +1,25 @@
+==========================
+Django 2.0.5 release notes
+==========================
+
+*May 1, 2018*
+
+Django 2.0.5 fixes several bugs in 2.0.4.
+
+Bugfixes
+========
+
+* Corrected the import paths that ``inspectdb`` generates for
+  ``django.contrib.postgres`` fields (:ticket:`29307`).
+
+* Fixed a regression in Django 1.11.8 where altering a field with a unique
+  constraint may drop and rebuild more foreign keys than necessary
+  (:ticket:`29193`).
+
+* Fixed crashes in ``django.contrib.admindocs`` when a view is a callable
+  object, such as ``django.contrib.syndication.views.Feed`` (:ticket:`29296`).
+
+* Fixed a regression in Django 2.0.4 where ``QuerySet.values()`` or
+  ``values_list()`` after combining an annotated and unannotated queryset with
+  ``union()``, ``difference()``, or ``intersection()`` crashed due to mismatching
+  columns (:ticket:`29286`).

testbed/django__django/docs/releases/2.1.12.txt

@@ -0,0 +1,15 @@
+===========================
+Django 2.1.12 release notes
+===========================
+
+*September 2, 2019*
+
+Django 2.1.12 fixes a regression in 2.1.11.
+
+Bugfixes
+========
+
+* Fixed crash of ``KeyTransform()`` for
+  ``django.contrib.postgres.fields.JSONField`` and
+  :class:`~django.contrib.postgres.fields.HStoreField` when using on
+  expressions with params (:ticket:`30672`).

testbed/django__django/docs/releases/2.1.14.txt

@@ -0,0 +1,15 @@
+===========================
+Django 2.1.14 release notes
+===========================
+
+*November 4, 2019*
+
+Django 2.1.14 fixes a regression in 2.1.13.
+
+Bugfixes
+========
+
+* Fixed a crash when using a ``contains``, ``contained_by``, ``has_key``,
+  ``has_keys``, or ``has_any_keys`` lookup on
+  ``django.contrib.postgres.fields.JSONField``, if the right or left hand
+  side of an expression is a key transform (:ticket:`30826`).

testbed/django__django/docs/releases/2.1.15.txt

@@ -0,0 +1,53 @@
+===========================
+Django 2.1.15 release notes
+===========================
+
+*December 2, 2019*
+
+Django 2.1.15 fixes a security issue and a data loss bug in 2.1.14.
+
+CVE-2019-19118: Privilege escalation in the Django admin.
+=========================================================
+
+Since Django 2.1, a Django model admin displaying a parent model with related
+model inlines, where the user has view-only permissions to a parent model but
+edit permissions to the inline model, would display a read-only view of the
+parent model but editable forms for the inline.
+
+Submitting these forms would not allow direct edits to the parent model, but
+would trigger the parent model's ``save()`` method, and cause pre and post-save
+signal handlers to be invoked. This is a privilege escalation as a user who
+lacks permission to edit a model should not be able to trigger its save-related
+signals.
+
+To resolve this issue, the permission handling code of the Django admin
+interface has been changed. Now, if a user has only the "view" permission for a
+parent model, the entire displayed form will not be editable, even if the user
+has permission to edit models included in inlines.
+
+This is a backwards-incompatible change, and the Django security team is aware
+that some users of Django were depending on the ability to allow editing of
+inlines in the admin form of an otherwise view-only parent model.
+
+Given the complexity of the Django admin, and in-particular the permissions
+related checks, it is the view of the Django security team that this change was
+necessary: that it is not currently feasible to maintain the existing behavior
+while escaping the potential privilege escalation in a way that would avoid a
+recurrence of similar issues in the future, and that would be compatible with
+Django's *safe by default* philosophy.
+
+For the time being, developers whose applications are affected by this change
+should replace the use of inlines in read-only parents with custom forms and
+views that explicitly implement the desired functionality. In the longer term,
+adding a documented, supported, and properly-tested mechanism for
+partially-editable multi-model forms to the admin interface may occur in Django
+itself.
+
+Bugfixes
+========
+
+* Fixed a data loss possibility in the
+  :meth:`~django.db.models.query.QuerySet.select_for_update()`. When using
+  ``'self'`` in the ``of`` argument with :ref:`multi-table inheritance
+  <multi-table-inheritance>`, a parent model was locked instead of the
+  queryset's model (:ticket:`30953`).

testbed/django__django/docs/releases/2.1.2.txt

@@ -0,0 +1,40 @@
+==========================
+Django 2.1.2 release notes
+==========================
+
+*October 1, 2018*
+
+Django 2.1.2 fixes a security issue and several bugs in 2.1.1. Also, the latest
+string translations from Transifex are incorporated.
+
+CVE-2018-16984: Password hash disclosure to "view only" admin users
+===================================================================
+
+If an admin user has the change permission to the user model, only part of the
+password hash is displayed in the change form. Admin users with the view (but
+not change) permission to the user model were displayed the entire hash. While
+it's typically infeasible to reverse a strong password hash, if your site uses
+weaker password hashing algorithms such as MD5 or SHA1, it could be a problem.
+
+Bugfixes
+========
+
+* Fixed a regression where nonexistent joins in ``F()`` no longer raised
+  ``FieldError`` (:ticket:`29727`).
+
+* Fixed a regression where files starting with a tilde or underscore weren't
+  ignored by the migrations loader (:ticket:`29749`).
+
+* Made migrations detect changes to ``Meta.default_related_name``
+  (:ticket:`29755`).
+
+* Added compatibility for ``cx_Oracle`` 7 (:ticket:`29759`).
+
+* Fixed a regression in Django 2.0 where unique index names weren't quoted
+  (:ticket:`29778`).
+
+* Fixed a regression where sliced queries with multiple columns with the same
+  name crashed on Oracle 12.1 (:ticket:`29630`).
+
+* Fixed a crash when a user with the view (but not change) permission made a
+  POST request to an admin user change form (:ticket:`29809`).

testbed/django__django/docs/releases/2.1.4.txt

@@ -0,0 +1,28 @@
+==========================
+Django 2.1.4 release notes
+==========================
+
+*December 3, 2018*
+
+Django 2.1.4 fixes several bugs in 2.1.3.
+
+Bugfixes
+========
+
+* Corrected the default password list that ``CommonPasswordValidator`` uses by
+  lowercasing all passwords to match the format expected by the validator
+  (:ticket:`29952`).
+
+* Prevented repetitive calls to ``geos_version_tuple()`` in the ``WKBWriter``
+  class in an attempt to fix a random crash involving ``LooseVersion``
+  (:ticket:`29959`).
+
+* Fixed keep-alive support in ``runserver`` after it was disabled to fix
+  another issue in Django 2.0 (:ticket:`29849`).
+
+* Fixed admin view-only change form crash when using
+  ``ModelAdmin.prepopulated_fields`` (:ticket:`29929`).
+
+* Fixed "Please correct the errors below" error message when editing an object
+  in the admin if the user only has the "view" permission on inlines
+  (:ticket:`29930`).

testbed/django__django/docs/releases/2.1.7.txt

@@ -0,0 +1,12 @@
+==========================
+Django 2.1.7 release notes
+==========================
+
+*February 11, 2019*
+
+Django 2.1.7 fixes a packaging error in 2.1.6.
+
+Bugfixes
+========
+
+* Corrected packaging error from 2.1.6 (:ticket:`30175`).

testbed/django__django/docs/releases/2.1.8.txt

@@ -0,0 +1,14 @@
+==========================
+Django 2.1.8 release notes
+==========================
+
+*April 1, 2019*
+
+Django 2.1.8 fixes a bug in 2.1.7.
+
+Bugfixes
+========
+
+* Prevented admin inlines for a ``ManyToManyField``\'s implicit through model
+  from being editable if the user only has the view permission
+  (:ticket:`30289`).

testbed/django__django/docs/releases/2.1.9.txt

@@ -0,0 +1,32 @@
+============================
+Django 2.1.9 release notes
+============================
+
+*June 3, 2019*
+
+Django 2.1.9 fixes security issues in 2.1.8.
+
+CVE-2019-12308: AdminURLFieldWidget XSS
+---------------------------------------
+
+The clickable "Current URL" link generated by ``AdminURLFieldWidget`` displayed
+the provided value without validating it as a safe URL. Thus, an unvalidated
+value stored in the database, or a value provided as a URL query parameter
+payload, could result in an clickable JavaScript link.
+
+``AdminURLFieldWidget`` now validates the provided value using
+:class:`~django.core.validators.URLValidator` before displaying the clickable
+link. You may customize the validator by passing a ``validator_class`` kwarg to
+``AdminURLFieldWidget.__init__()``, e.g. when using
+:attr:`~django.contrib.admin.ModelAdmin.formfield_overrides`.
+
+Patched bundled jQuery for CVE-2019-11358: Prototype pollution
+--------------------------------------------------------------
+
+jQuery before 3.4.0, mishandles ``jQuery.extend(true, {}, ...)`` because of
+``Object.prototype`` pollution. If an unsanitized source object contained an
+enumerable ``__proto__`` property, it could extend the native
+``Object.prototype``.
+
+The bundled version of jQuery used by the Django admin has been patched to
+allow for the ``select2`` library's use of ``jQuery.extend()``.

testbed/django__django/docs/releases/2.1.txt

@@ -0,0 +1,483 @@
+========================
+Django 2.1 release notes
+========================
+
+*August 1, 2018*
+
+Welcome to Django 2.1!
+
+These release notes cover the :ref:`new features <whats-new-2.1>`, as well as
+some :ref:`backwards incompatible changes <backwards-incompatible-2.1>` you'll
+want to be aware of when upgrading from Django 2.0 or earlier. We've
+:ref:`dropped some features<removed-features-2.1>` that have reached the end of
+their deprecation cycle, and we've :ref:`begun the deprecation process for some
+features <deprecated-features-2.1>`.
+
+See the :doc:`/howto/upgrade-version` guide if you're updating an existing
+project.
+
+Python compatibility
+====================
+
+Django 2.1 supports Python 3.5, 3.6, and 3.7. Django 2.0 is the last version to
+support Python 3.4.  We **highly recommend** and only officially support the
+latest release of each series.
+
+.. _whats-new-2.1:
+
+What's new in Django 2.1
+========================
+
+Model "view" permission
+-----------------------
+
+A "view" permission is added to the model :attr:`Meta.default_permissions
+<django.db.models.Options.default_permissions>`. The new permissions will be
+created automatically when running :djadmin:`migrate`.
+
+This allows giving users read-only access to models in the admin.
+:meth:`.ModelAdmin.has_view_permission` is new. The implementation is backwards
+compatible in that there isn't a need to assign the "view" permission to allow
+users who have the "change" permission to edit objects.
+
+There are a couple of :ref:`backwards incompatible considerations
+<view_permission_backwards_incompatible>`.
+
+Minor features
+--------------
+
+:mod:`django.contrib.admin`
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+* :attr:`.ModelAdmin.search_fields` now accepts any lookup such as
+  ``field__exact``.
+
+* jQuery is upgraded from version 2.2.3 to 3.3.1.
+
+* The new :meth:`.ModelAdmin.delete_queryset` method allows customizing the
+  deletion process of the "delete selected objects" action.
+
+* You can now :ref:`override the default admin site
+  <overriding-default-admin-site>`.
+
+* The new :attr:`.ModelAdmin.sortable_by` attribute and
+  :meth:`.ModelAdmin.get_sortable_by` method allow limiting the columns that
+  can be sorted in the change list page.
+
+* The ``admin_order_field`` attribute for elements in
+  :attr:`.ModelAdmin.list_display` may now be a query expression.
+
+* The new :meth:`.ModelAdmin.get_deleted_objects()` method allows customizing
+  the deletion process of the delete view and the "delete selected" action.
+
+* The ``actions.html``, ``change_list_results.html``, ``date_hierarchy.html``,
+  ``pagination.html``, ``prepopulated_fields_js.html``, ``search_form.html``,
+  and ``submit_line.html`` templates can now be :ref:`overridden per app or
+  per model <admin-templates-overridden-per-app-or-model>` (besides overridden
+  globally).
+
+* The admin change list and change form object tools can now be :ref:`overridden
+  per app, per model, or globally <admin-templates-overridden-per-app-or-model>`
+  with ``change_list_object_tools.html`` and
+  ``change_form_object_tools.html`` templates.
+
+* :meth:`.InlineModelAdmin.has_add_permission` is now passed the parent object
+  as the second positional argument, ``obj``.
+
+* Admin actions may now :ref:`specify permissions <admin-action-permissions>`
+  to limit their availability to certain users.
+
+:mod:`django.contrib.auth`
+~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+* :djadmin:`createsuperuser` now gives a prompt to allow bypassing the
+  :setting:`AUTH_PASSWORD_VALIDATORS` checks.
+
+:mod:`django.contrib.gis`
+~~~~~~~~~~~~~~~~~~~~~~~~~
+
+* The new :meth:`.GEOSGeometry.buffer_with_style` method is a version of
+  :meth:`~.GEOSGeometry.buffer` that allows customizing the style of the
+  buffer.
+
+* :class:`~django.contrib.gis.forms.widgets.OpenLayersWidget` is now based on
+  OpenLayers 4.6.5 (previously 3.20.1).
+
+:mod:`django.contrib.sessions`
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+* Added the :setting:`SESSION_COOKIE_SAMESITE` setting to set the ``SameSite``
+  cookie flag on session cookies.
+
+Cache
+~~~~~
+
+* The :ref:`local-memory cache backend <local-memory-caching>` now uses a
+  least-recently-used (LRU) culling strategy rather than a pseudo-random one.
+
+* The new :meth:`~django.core.cache.cache.touch` method of the :ref:`low-level
+  cache API <low-level-cache-api>` updates the timeout of cache keys.
+
+CSRF
+~~~~
+
+* Added the :setting:`CSRF_COOKIE_SAMESITE` setting to set the ``SameSite``
+  cookie flag on CSRF cookies.
+
+Forms
+~~~~~
+
+* The widget for ``ImageField`` now renders with the HTML attribute
+  ``accept="image/*"``.
+
+Internationalization
+~~~~~~~~~~~~~~~~~~~~
+
+* Added the :meth:`~django.utils.translation.get_supported_language_variant`
+  function.
+
+* Untranslated strings for territorial language variants now use the
+  translations of the generic language. For example, untranslated ``pt_BR``
+  strings use ``pt`` translations.
+
+Management Commands
+~~~~~~~~~~~~~~~~~~~
+
+* The new :option:`inspectdb --include-views` option allows creating models
+  for database views.
+
+* The :class:`~django.core.management.BaseCommand` class now uses a custom help
+  formatter so that the standard options like ``--verbosity`` or ``--settings``
+  appear last in the help output, giving a more prominent position to subclassed
+  command's options.
+
+Migrations
+~~~~~~~~~~
+
+* Added support for serialization of ``functools.partialmethod`` objects.
+
+* To support frozen environments, migrations may be loaded from ``.pyc`` files.
+
+Models
+~~~~~~
+
+* Models can now use ``__init_subclass__()`` from :pep:`487`.
+
+* A ``BinaryField`` may now be set to ``editable=True`` if you wish to include
+  it in model forms.
+
+* A number of new text database functions are added:
+  :class:`~django.db.models.functions.Chr`,
+  :class:`~django.db.models.functions.Left`,
+  :class:`~django.db.models.functions.LPad`,
+  :class:`~django.db.models.functions.LTrim`,
+  :class:`~django.db.models.functions.Ord`,
+  :class:`~django.db.models.functions.Repeat`,
+  :class:`~django.db.models.functions.Replace`,
+  :class:`~django.db.models.functions.Right`,
+  :class:`~django.db.models.functions.RPad`,
+  :class:`~django.db.models.functions.RTrim`, and
+  :class:`~django.db.models.functions.Trim`.
+
+* The new :class:`~django.db.models.functions.TruncWeek` function truncates
+  :class:`~django.db.models.DateField` and
+  :class:`~django.db.models.DateTimeField` to the Monday of a week.
+
+* Query expressions can now be negated using a minus sign.
+
+* :meth:`.QuerySet.order_by` and :meth:`distinct(*fields) <.QuerySet.distinct>`
+  now support using field transforms.
+
+* :class:`~django.db.models.BooleanField` can now be ``null=True``. This is
+  encouraged instead of ``NullBooleanField``, which will likely be deprecated
+  in the future.
+
+* The new :meth:`.QuerySet.explain` method displays the database's execution
+  plan of a queryset's query.
+
+*  :meth:`.QuerySet.raw` now supports :meth:`~.QuerySet.prefetch_related`.
+
+Requests and Responses
+~~~~~~~~~~~~~~~~~~~~~~
+
+* Added :meth:`.HttpRequest.get_full_path_info`.
+
+* Added the ``samesite`` argument to :meth:`.HttpResponse.set_cookie` to allow
+  setting the ``SameSite`` cookie flag.
+
+* The new ``as_attachment`` argument for :class:`~django.http.FileResponse`
+  sets the ``Content-Disposition`` header to make the browser ask if the user
+  wants to download the file. ``FileResponse`` also tries to set the
+  ``Content-Type`` and ``Content-Length`` headers where appropriate.
+
+Templates
+~~~~~~~~~
+
+* The new :tfilter:`json_script` filter safely outputs a Python object as JSON,
+  wrapped in a ``<script>`` tag, ready for use with JavaScript.
+
+Tests
+~~~~~
+
+* Added test :class:`~django.test.Client` support for 307 and 308 redirects.
+
+* The test :class:`~django.test.Client` now serializes a request data
+  dictionary as JSON if ``content_type='application/json'``. You can customize
+  the JSON encoder with test client's ``json_encoder`` parameter.
+
+* The new :meth:`.SimpleTestCase.assertWarnsMessage` method is a simpler
+  version of :meth:`~unittest.TestCase.assertWarnsRegex`.
+
+.. _backwards-incompatible-2.1:
+
+Backwards incompatible changes in 2.1
+=====================================
+
+Database backend API
+--------------------
+
+This section describes changes that may be needed in third-party database
+backends.
+
+* To adhere to :pep:`249`, exceptions where a database doesn't support a
+  feature are changed from :exc:`NotImplementedError` to
+  :exc:`django.db.NotSupportedError`.
+
+* Renamed the ``allow_sliced_subqueries`` database feature flag to
+  ``allow_sliced_subqueries_with_in``.
+
+* ``DatabaseOperations.distinct_sql()`` now requires an additional ``params``
+  argument and returns a tuple of SQL and parameters instead of an SQL string.
+
+* ``DatabaseFeatures.introspected_boolean_field_type`` is changed from a method
+  to a property.
+
+:mod:`django.contrib.gis`
+-------------------------
+
+* Support for SpatiaLite 4.0 is removed.
+
+Dropped support for MySQL 5.5
+-----------------------------
+
+The end of upstream support for MySQL 5.5 is December 2018. Django 2.1 supports
+MySQL 5.6 and higher.
+
+Dropped support for PostgreSQL 9.3
+----------------------------------
+
+The end of upstream support for PostgreSQL 9.3 is September 2018. Django 2.1
+supports PostgreSQL 9.4 and higher.
+
+Removed ``BCryptPasswordHasher`` from the default ``PASSWORD_HASHERS`` setting
+------------------------------------------------------------------------------
+
+If you used bcrypt with Django 1.4 or 1.5 (before ``BCryptSHA256PasswordHasher``
+was added in Django 1.6), you might have some passwords that use the
+``BCryptPasswordHasher`` hasher.
+
+You can check if that's the case like this::
+
+    from django.contrib.auth import get_user_model
+
+    User = get_user_model()
+    User.objects.filter(password__startswith="bcrypt$$")
+
+If you want to continue to allow those passwords to be used, you'll
+have to define the :setting:`PASSWORD_HASHERS` setting (if you don't already)
+and include ``'django.contrib.auth.hashers.BCryptPasswordHasher'``.
+
+Moved ``wrap_label`` widget template context variable
+-----------------------------------------------------
+
+To fix the lack of ``<label>`` when using ``RadioSelect`` and
+``CheckboxSelectMultiple`` with ``MultiWidget``, the ``wrap_label`` context
+variable now appears as an attribute of each option. For example, in a custom
+``input_option.html`` template, change ``{% if wrap_label %}`` to
+``{% if widget.wrap_label %}``.
+
+``SameSite`` cookies
+--------------------
+
+The cookies used for ``django.contrib.sessions``, ``django.contrib.messages``,
+and Django's CSRF protection now set the ``SameSite`` flag to ``Lax`` by
+default. Browsers that respect this flag won't send these cookies on
+cross-origin requests. If you rely on the old behavior, set the
+:setting:`SESSION_COOKIE_SAMESITE` and/or :setting:`CSRF_COOKIE_SAMESITE`
+setting to ``None``.
+
+.. _view_permission_backwards_incompatible:
+
+Considerations for the new model "view" permission
+--------------------------------------------------
+
+Custom admin forms need to take the view-only case into account
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+With the new "view" permission, existing custom admin forms may raise errors
+when a user doesn't have the change permission because the form might access
+nonexistent fields. Fix this by overriding :meth:`.ModelAdmin.get_form` and
+checking if the user has the "change" permissions and returning the default
+form if not::
+
+    class MyAdmin(admin.ModelAdmin):
+        def get_form(self, request, obj=None, **kwargs):
+            if not self.has_change_permission(request, obj):
+                return super().get_form(request, obj, **kwargs)
+            return CustomForm
+
+New default view permission could allow unwanted access to admin views
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+If you have a custom permission with a codename of the form
+``view_<modelname>``, the new view permission handling in the admin will allow
+view access to the changelist and detail pages for those models. If this is
+unwanted, you must change your custom permission codename.
+
+Miscellaneous
+-------------
+
+* The minimum supported version of ``mysqlclient`` is increased from 1.3.3 to
+  1.3.7.
+
+* Support for SQLite < 3.7.15 is removed.
+
+* The date format of ``Set-Cookie``'s ``Expires`` directive is changed to
+  follow :rfc:`7231#section-7.1.1.1` instead of Netscape's cookie standard.
+  Hyphens present in dates like ``Tue, 25-Dec-2018 22:26:13 GMT`` are removed.
+  This change should be merely cosmetic except perhaps for antiquated browsers
+  that don't parse the new format.
+
+* ``allowed_hosts`` is now a required argument of private API
+  ``django.utils.http.is_safe_url()``.
+
+* The ``multiple`` attribute rendered by the
+  :class:`~django.forms.SelectMultiple` widget now uses HTML5 boolean syntax
+  rather than XHTML's ``multiple="multiple"``.
+
+* HTML rendered by form widgets no longer includes a closing slash on void
+  elements, e.g. ``<br>``. This is incompatible within XHTML, although some
+  widgets already used aspects of HTML5 such as boolean attributes.
+
+* The value of :class:`~django.forms.SelectDateWidget`'s empty options is
+  changed from 0 to an empty string, which mainly may require some adjustments
+  in tests that compare HTML.
+
+* :meth:`.User.has_usable_password` and the
+  :func:`~django.contrib.auth.hashers.is_password_usable` function no longer
+  return ``False`` if the password is ``None`` or an empty string, or if the
+  password uses a hasher that's not in the :setting:`PASSWORD_HASHERS` setting.
+  This undocumented behavior was a regression in Django 1.6 and prevented users
+  with such passwords from requesting a password reset. Audit your code to
+  confirm that your usage of these APIs don't rely on the old behavior.
+
+* Since migrations are now loaded from ``.pyc`` files, you might need to delete
+  them if you're working in a mixed Python 2 and Python 3 environment.
+
+* Using ``None`` as a ``django.contrib.postgres.fields.JSONField`` lookup
+  value now matches objects that have the specified key and a null value rather
+  than objects that don't have the key.
+
+* The admin CSS class ``field-box`` is renamed to ``fieldBox`` to prevent
+  conflicts with the class given to model fields named "box".
+
+* Since the admin's ``actions.html``, ``change_list_results.html``,
+  ``date_hierarchy.html``, ``pagination.html``, ``prepopulated_fields_js.html``,
+  ``search_form.html``, and ``submit_line.html`` templates can now be
+  overridden per app or per model, you may need to rename existing templates
+  with those names that were written for a different purpose.
+
+* ``QuerySet.raw()`` now caches its results like regular querysets. Use
+  ``iterator()`` if you don't want caching.
+
+* The database router :meth:`allow_relation` method is called in more cases.
+  Improperly written routers may need to be updated accordingly.
+
+* Translations are no longer deactivated before running management commands.
+  If your custom command requires translations to be deactivated (for example,
+  to insert untranslated content into the database), use the new
+  :ref:`@no_translations decorator <management-commands-and-locales>`.
+
+* Management commands no longer allow the abbreviated forms of the
+  ``--settings`` and ``--pythonpath`` arguments.
+
+* The private ``django.db.models.sql.constants.QUERY_TERMS`` constant is
+  removed. The :meth:`~.RegisterLookupMixin.get_lookup`
+  and :meth:`~.RegisterLookupMixin.get_lookups` methods
+  of the :ref:`Lookup Registration API <lookup-registration-api>` may be
+  suitable alternatives. Compared to the ``QUERY_TERMS`` constant, they allow
+  your code to also account for any custom lookups that have been registered.
+
+* Compatibility with ``py-bcrypt`` is removed as it's unmaintained. Use
+  :pypi:`bcrypt` instead.
+
+.. _deprecated-features-2.1:
+
+Features deprecated in 2.1
+==========================
+
+Miscellaneous
+-------------
+
+* The ``ForceRHR`` GIS function is deprecated in favor of the new
+  :class:`~django.contrib.gis.db.models.functions.ForcePolygonCW` function.
+
+* ``django.utils.http.cookie_date()`` is deprecated in favor of
+  :func:`~django.utils.http.http_date`, which follows the format of the latest
+  RFC.
+
+* ``{% load staticfiles %}`` and ``{% load admin_static %}`` are deprecated
+  in favor of ``{% load static %}``, which works the same.
+
+* ``django.contrib.staticfiles.templatetags.static()`` is deprecated in favor
+  of ``django.templatetags.static.static()``.
+
+* Support for :meth:`.InlineModelAdmin.has_add_permission` methods that don't
+  accept ``obj`` as the second positional argument will be removed in Django
+  3.0.
+
+.. _removed-features-2.1:
+
+Features removed in 2.1
+=======================
+
+These features have reached the end of their deprecation cycle and are removed
+in Django 2.1. See :ref:`deprecated-features-1.11` for details, including how
+to remove usage of these features.
+
+* ``contrib.auth.views.login()``, ``logout()``, ``password_change()``,
+  ``password_change_done()``, ``password_reset()``, ``password_reset_done()``,
+  ``password_reset_confirm()``, and ``password_reset_complete()`` are removed.
+
+* The ``extra_context`` parameter of ``contrib.auth.views.logout_then_login()``
+  is removed.
+
+* ``django.test.runner.setup_databases()`` is removed.
+
+* ``django.utils.translation.string_concat()`` is removed.
+
+* ``django.core.cache.backends.memcached.PyLibMCCache`` no longer supports
+  passing ``pylibmc`` behavior settings as top-level attributes of ``OPTIONS``.
+
+* The ``host`` parameter of ``django.utils.http.is_safe_url()`` is removed.
+
+* Silencing of exceptions raised while rendering the ``{% include %}`` template
+  tag is removed.
+
+* ``DatabaseIntrospection.get_indexes()`` is removed.
+
+* The ``authenticate()`` method of authentication backends requires ``request``
+  as the first positional argument.
+
+* The ``django.db.models.permalink()`` decorator is removed.
+
+* The ``USE_ETAGS`` setting is removed. ``CommonMiddleware`` and
+  ``django.utils.cache.patch_response_headers()`` no longer set ETags.
+
+* The ``Model._meta.has_auto_field`` attribute is removed.
+
+* ``url()``'s support for inline flags in regular expression groups (``(?i)``,
+  ``(?L)``, ``(?m)``, ``(?s)``, and ``(?u)``) is removed.
+
+* Support for ``Widget.render()`` methods without the ``renderer`` argument
+  is removed.

testbed/django__django/docs/releases/2.2.10.txt

@@ -0,0 +1,13 @@
+===========================
+Django 2.2.10 release notes
+===========================
+
+*February 3, 2020*
+
+Django 2.2.10 fixes a security issue in 2.2.9.
+
+CVE-2020-7471: Potential SQL injection via ``StringAgg(delimiter)``
+===================================================================
+
+:class:`~django.contrib.postgres.aggregates.StringAgg` aggregation function was
+subject to SQL injection, using a suitably crafted ``delimiter``.

testbed/django__django/docs/releases/2.2.13.txt

@@ -0,0 +1,33 @@
+===========================
+Django 2.2.13 release notes
+===========================
+
+*June 3, 2020*
+
+Django 2.2.13 fixes two security issues and a regression in 2.2.12.
+
+CVE-2020-13254: Potential data leakage via malformed memcached keys
+===================================================================
+
+In cases where a memcached backend does not perform key validation, passing
+malformed cache keys could result in a key collision, and potential data
+leakage. In order to avoid this vulnerability, key validation is added to the
+memcached cache backends.
+
+CVE-2020-13596: Possible XSS via admin ``ForeignKeyRawIdWidget``
+================================================================
+
+Query parameters for the admin ``ForeignKeyRawIdWidget`` were not properly URL
+encoded, posing an XSS attack vector. ``ForeignKeyRawIdWidget`` now
+ensures query parameters are correctly URL encoded.
+
+Bugfixes
+========
+
+* Fixed a regression in Django 2.2.12 that affected translation loading for
+  apps providing translations for territorial language variants as well as a
+  generic language, where the project has different plural equations for the
+  language (:ticket:`31570`).
+
+* Tracking a jQuery security release, upgraded the version of jQuery used by
+  the admin from 3.3.1 to 3.5.1.

testbed/django__django/docs/releases/2.2.15.txt

@@ -0,0 +1,16 @@
+===========================
+Django 2.2.15 release notes
+===========================
+
+*August 3, 2020*
+
+Django 2.2.15 fixes two bugs in 2.2.14.
+
+Bugfixes
+========
+
+* Allowed setting the ``SameSite`` cookie flag in
+  :meth:`.HttpResponse.delete_cookie` (:ticket:`31790`).
+
+* Fixed crash when sending emails to addresses with display names longer than
+  75 chars on Python 3.6.11+, 3.7.8+, and 3.8.4+ (:ticket:`31784`).

testbed/django__django/docs/releases/2.2.16.txt

@@ -0,0 +1,36 @@
+===========================
+Django 2.2.16 release notes
+===========================
+
+*September 1, 2020*
+
+Django 2.2.16 fixes two security issues and two data loss bugs in 2.2.15.
+
+CVE-2020-24583: Incorrect permissions on intermediate-level directories on Python 3.7+
+======================================================================================
+
+On Python 3.7+, :setting:`FILE_UPLOAD_DIRECTORY_PERMISSIONS` mode was not
+applied to intermediate-level directories created in the process of uploading
+files and to intermediate-level collected static directories when using the
+:djadmin:`collectstatic` management command.
+
+You should review and manually fix permissions on existing intermediate-level
+directories.
+
+CVE-2020-24584: Permission escalation in intermediate-level directories of the file system cache on Python 3.7+
+===============================================================================================================
+
+On Python 3.7+, the intermediate-level directories of the file system cache had
+the system's standard umask rather than ``0o077`` (no group or others
+permissions).
+
+Bugfixes
+========
+
+* Fixed a data loss possibility in the
+  :meth:`~django.db.models.query.QuerySet.select_for_update()`. When using
+  related fields pointing to a proxy model in the ``of`` argument, the
+  corresponding model was not locked (:ticket:`31866`).
+
+* Fixed a data loss possibility, following a regression in Django 2.0, when
+  copying model instances with a cached fields value (:ticket:`31863`).

testbed/django__django/docs/releases/2.2.17.txt

@@ -0,0 +1,7 @@
+===========================
+Django 2.2.17 release notes
+===========================
+
+*November 2, 2020*
+
+Django 2.2.17 adds compatibility with Python 3.9.

testbed/django__django/docs/releases/2.2.18.txt

@@ -0,0 +1,15 @@
+===========================
+Django 2.2.18 release notes
+===========================
+
+*February 1, 2021*
+
+Django 2.2.18 fixes a security issue with severity "low" in 2.2.17.
+
+CVE-2021-3281: Potential directory-traversal via ``archive.extract()``
+======================================================================
+
+The ``django.utils.archive.extract()`` function, used by
+:option:`startapp --template` and :option:`startproject --template`, allowed
+directory-traversal via an archive with absolute paths or relative paths with
+dot segments.

testbed/django__django/docs/releases/2.2.19.txt

@@ -0,0 +1,16 @@
+===========================
+Django 2.2.19 release notes
+===========================
+
+*February 19, 2021*
+
+Django 2.2.19 fixes a security issue in 2.2.18.
+
+CVE-2021-23336: Web cache poisoning via ``django.utils.http.limited_parse_qsl()``
+=================================================================================
+
+Django contains a copy of :func:`urllib.parse.parse_qsl` which was added to
+backport some security fixes. A further security fix has been issued recently
+such that ``parse_qsl()`` no longer allows using ``;`` as a query parameter
+separator by default. Django now includes this fix. See :bpo:`42967` for
+further details.

testbed/django__django/docs/releases/2.2.20.txt

@@ -0,0 +1,15 @@
+===========================
+Django 2.2.20 release notes
+===========================
+
+*April 6, 2021*
+
+Django 2.2.20 fixes a security issue with severity "low" in 2.2.19.
+
+CVE-2021-28658: Potential directory-traversal via uploaded files
+================================================================
+
+``MultiPartParser`` allowed directory-traversal via uploaded files with
+suitably crafted file names.
+
+Built-in upload handlers were not affected by this vulnerability.

testbed/django__django/docs/releases/2.2.23.txt

@@ -0,0 +1,15 @@
+===========================
+Django 2.2.23 release notes
+===========================
+
+*May 13, 2021*
+
+Django 2.2.23 fixes a regression in 2.2.21.
+
+Bugfixes
+========
+
+* Fixed a regression in Django 2.2.21 where saving ``FileField`` would raise a
+  ``SuspiciousFileOperation`` even when a custom
+  :attr:`~django.db.models.FileField.upload_to` returns a valid file path
+  (:ticket:`32718`).

testbed/django__django/docs/releases/2.2.3.txt

@@ -0,0 +1,38 @@
+==========================
+Django 2.2.3 release notes
+==========================
+
+*July 1, 2019*
+
+Django 2.2.3 fixes a security issue and several bugs in 2.2.2. Also, the latest
+string translations from Transifex are incorporated.
+
+CVE-2019-12781: Incorrect HTTP detection with reverse-proxy connecting via HTTPS
+--------------------------------------------------------------------------------
+
+When deployed behind a reverse-proxy connecting to Django via HTTPS,
+:attr:`django.http.HttpRequest.scheme` would incorrectly detect client
+requests made via HTTP as using HTTPS. This entails incorrect results for
+:meth:`~django.http.HttpRequest.is_secure`, and
+:meth:`~django.http.HttpRequest.build_absolute_uri`, and that HTTP
+requests would not be redirected to HTTPS in accordance with
+:setting:`SECURE_SSL_REDIRECT`.
+
+``HttpRequest.scheme`` now respects :setting:`SECURE_PROXY_SSL_HEADER`, if it is
+configured, and the appropriate header is set on the request, for both HTTP and
+HTTPS requests.
+
+If you deploy Django behind a reverse-proxy that forwards HTTP requests, and
+that connects to Django via HTTPS, be sure to verify that your application
+correctly handles code paths relying on ``scheme``, ``is_secure()``,
+``build_absolute_uri()``, and ``SECURE_SSL_REDIRECT``.
+
+Bugfixes
+========
+
+* Fixed a regression in Django 2.2 where :class:`~django.db.models.Avg`,
+  :class:`~django.db.models.StdDev`, and :class:`~django.db.models.Variance`
+  crash with ``filter`` argument (:ticket:`30542`).
+
+* Fixed a regression in Django 2.2.2 where auto-reloader crashes with
+  ``AttributeError``, e.g. when using ``ipdb`` (:ticket:`30588`).

testbed/django__django/docs/releases/2.2.5.txt

@@ -0,0 +1,24 @@
+==========================
+Django 2.2.5 release notes
+==========================
+
+*September 2, 2019*
+
+Django 2.2.5 fixes several bugs in 2.2.4.
+
+Bugfixes
+========
+
+* Relaxed the system check added in Django 2.2 for models to reallow use of the
+  same ``db_table`` by multiple models when database routers are installed
+  (:ticket:`30673`).
+
+* Fixed crash of ``KeyTransform()`` for
+  ``django.contrib.postgres.fields.JSONField`` and
+  :class:`~django.contrib.postgres.fields.HStoreField` when using on
+  expressions with params (:ticket:`30672`).
+
+* Fixed a regression in Django 2.2 where
+  :attr:`ModelAdmin.list_filter <django.contrib.admin.ModelAdmin.list_filter>`
+  choices to foreign objects don't respect a model's ``Meta.ordering``
+  (:ticket:`30449`).

testbed/django__django/docs/releases/2.2.7.txt

@@ -0,0 +1,26 @@
+==========================
+Django 2.2.7 release notes
+==========================
+
+*November 4, 2019*
+
+Django 2.2.7 fixes several bugs in 2.2.6.
+
+Bugfixes
+========
+
+* Fixed a crash when using a ``contains``, ``contained_by``, ``has_key``,
+  ``has_keys``, or ``has_any_keys`` lookup on
+  ``django.contrib.postgres.fields.JSONField``, if the right or left hand
+  side of an expression is a key transform (:ticket:`30826`).
+
+* Prevented :option:`migrate --plan` from showing that ``RunPython`` operations
+  are irreversible when ``reverse_code`` callables don't have docstrings or
+  when showing a forward migration plan (:ticket:`30870`).
+
+* Fixed migrations crash on PostgreSQL when adding an
+  :class:`~django.db.models.Index` with fields ordering and
+  :attr:`~.Index.opclasses` (:ticket:`30903`).
+
+* Restored the ability to override
+  :meth:`~django.db.models.Model.get_FOO_display` (:ticket:`30931`).

testbed/django__django/docs/releases/3.0.10.txt

@@ -0,0 +1,36 @@
+===========================
+Django 3.0.10 release notes
+===========================
+
+*September 1, 2020*
+
+Django 3.0.10 fixes two security issues and two data loss bugs in 3.0.9.
+
+CVE-2020-24583: Incorrect permissions on intermediate-level directories on Python 3.7+
+======================================================================================
+
+On Python 3.7+, :setting:`FILE_UPLOAD_DIRECTORY_PERMISSIONS` mode was not
+applied to intermediate-level directories created in the process of uploading
+files and to intermediate-level collected static directories when using the
+:djadmin:`collectstatic` management command.
+
+You should review and manually fix permissions on existing intermediate-level
+directories.
+
+CVE-2020-24584: Permission escalation in intermediate-level directories of the file system cache on Python 3.7+
+===============================================================================================================
+
+On Python 3.7+, the intermediate-level directories of the file system cache had
+the system's standard umask rather than ``0o077`` (no group or others
+permissions).
+
+Bugfixes
+========
+
+* Fixed a data loss possibility in the
+  :meth:`~django.db.models.query.QuerySet.select_for_update()`. When using
+  related fields pointing to a proxy model in the ``of`` argument, the
+  corresponding model was not locked (:ticket:`31866`).
+
+* Fixed a data loss possibility, following a regression in Django 2.0, when
+  copying model instances with a cached fields value (:ticket:`31863`).

testbed/django__django/docs/releases/3.0.6.txt

@@ -0,0 +1,14 @@
+==========================
+Django 3.0.6 release notes
+==========================
+
+*May 4, 2020*
+
+Django 3.0.6 fixes a bug in 3.0.5.
+
+Bugfixes
+========
+
+* Fixed a regression in Django 3.0 that caused a crash when filtering a
+  ``Subquery()`` annotation of a queryset containing a single related field
+  against a ``SimpleLazyObject`` (:ticket:`31420`).

testbed/django__django/docs/releases/3.1.1.txt

@@ -0,0 +1,88 @@
+==========================
+Django 3.1.1 release notes
+==========================
+
+*September 1, 2020*
+
+Django 3.1.1 fixes two security issues and several bugs in 3.1.
+
+CVE-2020-24583: Incorrect permissions on intermediate-level directories on Python 3.7+
+======================================================================================
+
+On Python 3.7+, :setting:`FILE_UPLOAD_DIRECTORY_PERMISSIONS` mode was not
+applied to intermediate-level directories created in the process of uploading
+files and to intermediate-level collected static directories when using the
+:djadmin:`collectstatic` management command.
+
+You should review and manually fix permissions on existing intermediate-level
+directories.
+
+CVE-2020-24584: Permission escalation in intermediate-level directories of the file system cache on Python 3.7+
+===============================================================================================================
+
+On Python 3.7+, the intermediate-level directories of the file system cache had
+the system's standard umask rather than ``0o077`` (no group or others
+permissions).
+
+Bugfixes
+========
+
+* Fixed wrapping of translated action labels in the admin's navigation sidebar
+  for East Asian languages (:ticket:`31853`).
+
+* Fixed wrapping of long model names in the admin's navigation sidebar
+  (:ticket:`31854`).
+
+* Fixed encoding session data while upgrading multiple instances of the same
+  project to Django 3.1 (:ticket:`31864`).
+
+* Adjusted admin's navigation sidebar template to reduce debug logging when
+  rendering (:ticket:`31865`).
+
+* Fixed a data loss possibility in the
+  :meth:`~django.db.models.query.QuerySet.select_for_update()`. When using
+  related fields pointing to a proxy model in the ``of`` argument, the
+  corresponding model was not locked (:ticket:`31866`).
+
+* Fixed a data loss possibility, following a regression in Django 2.0, when
+  copying model instances with a cached fields value (:ticket:`31863`).
+
+* Fixed a regression in Django 3.1 that caused a crash when decoding an invalid
+  session data (:ticket:`31895`).
+
+* Reverted a deprecation in Django 3.1 that caused a crash when passing
+  deprecated keyword arguments to a queryset in
+  ``TemplateView.get_context_data()`` (:ticket:`31877`).
+
+* Enforced thread sensitivity of the :class:`MiddlewareMixin.process_request()
+  <django.utils.deprecation.MiddlewareMixin>` and ``process_response()`` hooks
+  when in an async context (:ticket:`31905`).
+
+* Fixed ``__in`` lookup on key transforms for
+  :class:`~django.db.models.JSONField` with MariaDB, MySQL, Oracle, and SQLite
+  (:ticket:`31936`).
+
+* Fixed a regression in Django 3.1 that caused permission errors in
+  ``CommonPasswordValidator`` and ``settings.py`` generated by the
+  :djadmin:`startproject` command, when user didn't have permissions to all
+  intermediate directories in a Django installation path (:ticket:`31912`).
+
+* Fixed detecting an async ``get_response`` callable in various builtin
+  middlewares (:ticket:`31928`).
+
+* Fixed a ``QuerySet.order_by()`` crash on PostgreSQL when ordering and
+  grouping by :class:`~django.db.models.JSONField` with a custom
+  :attr:`~django.db.models.JSONField.decoder` (:ticket:`31956`). As a
+  consequence, fetching a ``JSONField`` with raw SQL now returns a string
+  instead of preloaded data. You will need to explicitly call ``json.loads()``
+  in such cases.
+
+* Fixed a ``QuerySet.delete()`` crash on MySQL, following a performance
+  regression in Django 3.1 on MariaDB 10.3.2+, when filtering against an
+  aggregate function (:ticket:`31965`).
+
+* Fixed a ``django.contrib.admin.EmptyFieldListFilter`` crash when using on
+  reverse relations (:ticket:`31952`).
+
+* Prevented content overflowing in the admin changelist view when the
+  navigation sidebar is enabled (:ticket:`31901`).

testbed/django__django/docs/releases/3.1.3.txt

@@ -0,0 +1,62 @@
+==========================
+Django 3.1.3 release notes
+==========================
+
+*November 2, 2020*
+
+Django 3.1.3 fixes several bugs in 3.1.2 and adds compatibility with Python
+3.9.
+
+Bugfixes
+========
+
+* Fixed a regression in Django 3.1.2 that caused the incorrect height of the
+  admin changelist search bar (:ticket:`32072`).
+
+* Fixed a regression in Django 3.1.2 that caused the incorrect width of the
+  admin changelist search bar on a filtered page (:ticket:`32091`).
+
+* Fixed displaying Unicode characters in
+  :class:`forms.JSONField <django.forms.JSONField>` and read-only
+  :class:`models.JSONField <django.db.models.JSONField>` values in the admin
+  (:ticket:`32080`).
+
+* Fixed a regression in Django 3.1 that caused a crash of
+  :class:`~django.contrib.postgres.aggregates.ArrayAgg` and
+  :class:`~django.contrib.postgres.aggregates.StringAgg` with ``ordering``
+  on key transforms for :class:`~django.db.models.JSONField` (:ticket:`32096`).
+
+* Fixed a regression in Django 3.1 that caused a crash of ``__in`` lookup when
+  using key transforms for :class:`~django.db.models.JSONField` in the lookup
+  value (:ticket:`32096`).
+
+* Fixed a regression in Django 3.1 that caused a crash of
+  :class:`~django.db.models.ExpressionWrapper` with key transforms for
+  :class:`~django.db.models.JSONField` (:ticket:`32096`).
+
+* Fixed a regression in Django 3.1 that caused a migrations crash on PostgreSQL
+  when adding an
+  :class:`~django.contrib.postgres.constraints.ExclusionConstraint` with key
+  transforms for :class:`~django.db.models.JSONField` in ``expressions``
+  (:ticket:`32096`).
+
+* Fixed a regression in Django 3.1 where
+  :exc:`ProtectedError.protected_objects <django.db.models.ProtectedError>` and
+  :exc:`RestrictedError.restricted_objects <django.db.models.RestrictedError>`
+  attributes returned iterators instead of :py:class:`set` of objects
+  (:ticket:`32107`).
+
+* Fixed a regression in Django 3.1.2 that caused incorrect form input layout on
+  small screens in the admin change form view (:ticket:`32069`).
+
+* Fixed a regression in Django 3.1 that invalidated pre-Django 3.1 password
+  reset tokens (:ticket:`32130`).
+
+* Added support for ``asgiref`` 3.3 (:ticket:`32128`).
+
+* Fixed a regression in Django 3.1 that caused incorrect textarea layout on
+  medium-sized screens in the admin change form view with the sidebar open
+  (:ticket:`32127`).
+
+* Fixed a regression in Django 3.0.7 that didn't use ``Subquery()`` aliases in
+  the ``GROUP BY`` clause (:ticket:`32152`).

testbed/django__django/docs/releases/3.1.6.txt

@@ -0,0 +1,21 @@
+==========================
+Django 3.1.6 release notes
+==========================
+
+*February 1, 2021*
+
+Django 3.1.6 fixes a security issue with severity "low" and a bug in 3.1.5.
+
+CVE-2021-3281: Potential directory-traversal via ``archive.extract()``
+======================================================================
+
+The ``django.utils.archive.extract()`` function, used by
+:option:`startapp --template` and :option:`startproject --template`, allowed
+directory-traversal via an archive with absolute paths or relative paths with
+dot segments.
+
+Bugfixes
+========
+
+* Fixed an admin layout issue in Django 3.1 where changelist filter controls 
+  would become squashed (:ticket:`32391`).

testbed/django__django/docs/releases/3.1.txt

@@ -0,0 +1,866 @@
+========================
+Django 3.1 release notes
+========================
+
+*August 4, 2020*
+
+Welcome to Django 3.1!
+
+These release notes cover the :ref:`new features <whats-new-3.1>`, as well as
+some :ref:`backwards incompatible changes <backwards-incompatible-3.1>` you'll
+want to be aware of when upgrading from Django 3.0 or earlier. We've
+:ref:`dropped some features<removed-features-3.1>` that have reached the end of
+their deprecation cycle, and we've :ref:`begun the deprecation process for
+some features <deprecated-features-3.1>`.
+
+See the :doc:`/howto/upgrade-version` guide if you're updating an existing
+project.
+
+Python compatibility
+====================
+
+Django 3.1 supports Python 3.6, 3.7, 3.8, and 3.9 (as of 3.1.3). We **highly
+recommend** and only officially support the latest release of each series.
+
+.. _whats-new-3.1:
+
+What's new in Django 3.1
+========================
+
+Asynchronous views and middleware support
+-----------------------------------------
+
+Django now supports a fully asynchronous request path, including:
+
+* :ref:`Asynchronous views <async-views>`
+* :ref:`Asynchronous middleware <async-middleware>`
+* :ref:`Asynchronous tests and test client <async-tests>`
+
+To get started with async views, you need to declare a view using
+``async def``::
+
+    async def my_view(request):
+        await asyncio.sleep(0.5)
+        return HttpResponse("Hello, async world!")
+
+All asynchronous features are supported whether you are running under WSGI or
+ASGI mode. However, there will be performance penalties using async code in
+WSGI mode. You can read more about the specifics in :doc:`/topics/async`
+documentation.
+
+You are free to mix async and sync views, middleware, and tests as much as you
+want. Django will ensure that you always end up with the right execution
+context. We expect most projects will keep the majority of their views
+synchronous, and only have a select few running in async mode - but it is
+entirely your choice.
+
+Django's ORM, cache layer, and other pieces of code that do long-running
+network calls do not yet support async access. We expect to add support for
+them in upcoming releases. Async views are ideal, however, if you are doing a
+lot of API or HTTP calls inside your view, you can now natively do all those
+HTTP calls in parallel to considerably speed up your view's execution.
+
+Asynchronous support should be entirely backwards-compatible and we have tried
+to ensure that it has no speed regressions for your existing, synchronous code.
+It should have no noticeable effect on any existing Django projects.
+
+JSONField for all supported database backends
+---------------------------------------------
+
+Django now includes :class:`.models.JSONField` and
+:class:`forms.JSONField <django.forms.JSONField>` that can be used on all
+supported database backends. Both fields support the use of custom JSON
+encoders and decoders. The model field supports the introspection,
+:ref:`lookups, and transforms <querying-jsonfield>` that were previously
+PostgreSQL-only::
+
+    from django.db import models
+
+
+    class ContactInfo(models.Model):
+        data = models.JSONField()
+
+
+    ContactInfo.objects.create(
+        data={
+            "name": "John",
+            "cities": ["London", "Cambridge"],
+            "pets": {"dogs": ["Rufus", "Meg"]},
+        }
+    )
+    ContactInfo.objects.filter(
+        data__name="John",
+        data__pets__has_key="dogs",
+        data__cities__contains="London",
+    ).delete()
+
+If your project uses ``django.contrib.postgres.fields.JSONField``, plus the
+related form field and transforms, you should adjust to use the new fields,
+and generate and apply a database migration. For now, the old fields and
+transforms are left as a reference to the new ones and are :ref:`deprecated as
+of this release <deprecated-jsonfield>`.
+
+.. _default-hashing-algorithm-usage:
+
+``DEFAULT_HASHING_ALGORITHM`` settings
+--------------------------------------
+
+The new ``DEFAULT_HASHING_ALGORITHM`` transitional setting allows specifying
+the default hashing algorithm to use for encoding cookies, password reset
+tokens in the admin site, user sessions, and signatures created by
+:class:`django.core.signing.Signer` and :meth:`django.core.signing.dumps`.
+
+Support for SHA-256 was added in Django 3.1. If you are upgrading multiple
+instances of the same project to Django 3.1, you should set
+``DEFAULT_HASHING_ALGORITHM`` to ``'sha1'`` during the transition, in order to
+allow compatibility with the older versions of Django. Note that this requires
+Django 3.1.1+. Once the transition to 3.1 is complete you can stop overriding
+``DEFAULT_HASHING_ALGORITHM``.
+
+This setting is deprecated as of this release, because support for tokens,
+cookies, sessions, and signatures that use SHA-1 algorithm will be removed in
+Django 4.0.
+
+Minor features
+--------------
+
+:mod:`django.contrib.admin`
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+* The new ``django.contrib.admin.EmptyFieldListFilter`` for
+  :attr:`.ModelAdmin.list_filter` allows filtering on empty values (empty
+  strings and nulls) in the admin changelist view.
+
+* Filters in the right sidebar of the admin changelist view now contain a link
+  to clear all filters.
+
+* The admin now has a sidebar on larger screens for easier navigation. It is
+  enabled by default but can be disabled by using a custom ``AdminSite`` and
+  setting :attr:`.AdminSite.enable_nav_sidebar` to ``False``.
+
+  Rendering the sidebar requires access to the current request in order to set
+  CSS and ARIA role affordances. This requires using
+  ``'django.template.context_processors.request'`` in the
+  ``'context_processors'`` option of :setting:`OPTIONS <TEMPLATES-OPTIONS>`.
+
+* Initially empty ``extra`` inlines can now be removed, in the same way as
+  dynamically created ones.
+
+* ``XRegExp`` is upgraded from version 2.0.0 to 3.2.0.
+
+* jQuery is upgraded from version 3.4.1 to 3.5.1.
+
+* Select2 library is upgraded from version 4.0.7 to 4.0.13.
+
+:mod:`django.contrib.auth`
+~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+* The default iteration count for the PBKDF2 password hasher is increased from
+  180,000 to 216,000.
+
+* The new :setting:`PASSWORD_RESET_TIMEOUT` setting allows defining the number
+  of seconds a password reset link is valid for. This is encouraged instead of
+  the deprecated ``PASSWORD_RESET_TIMEOUT_DAYS`` setting, which will be removed
+  in Django 4.0.
+
+* The password reset mechanism now uses the SHA-256 hashing algorithm. Support
+  for tokens that use the old hashing algorithm remains until Django 4.0.
+
+* :meth:`.AbstractBaseUser.get_session_auth_hash` now uses the SHA-256 hashing
+  algorithm. Support for user sessions that use the old hashing algorithm
+  remains until Django 4.0.
+
+:mod:`django.contrib.contenttypes`
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+* The new :option:`remove_stale_contenttypes --include-stale-apps` option
+  allows removing stale content types from previously installed apps that have
+  been removed from :setting:`INSTALLED_APPS`.
+
+:mod:`django.contrib.gis`
+~~~~~~~~~~~~~~~~~~~~~~~~~
+
+* :lookup:`relate` lookup is now supported on MariaDB.
+
+* Added the :attr:`.LinearRing.is_counterclockwise` property.
+
+* :class:`~django.contrib.gis.db.models.functions.AsGeoJSON` is now supported
+  on Oracle.
+
+* Added the :class:`~django.contrib.gis.db.models.functions.AsWKB` and
+  :class:`~django.contrib.gis.db.models.functions.AsWKT` functions.
+
+* Added support for PostGIS 3 and GDAL 3.
+
+:mod:`django.contrib.humanize`
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+* :tfilter:`intword` template filter now supports negative integers.
+
+:mod:`django.contrib.postgres`
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+* The new :class:`~django.contrib.postgres.indexes.BloomIndex` class allows
+  creating ``bloom`` indexes in the database. The new
+  :class:`~django.contrib.postgres.operations.BloomExtension` migration
+  operation installs the ``bloom`` extension to add support for this index.
+
+* :meth:`~django.db.models.Model.get_FOO_display` now supports
+  :class:`~django.contrib.postgres.fields.ArrayField` and
+  :class:`~django.contrib.postgres.fields.RangeField`.
+
+* The new :lookup:`rangefield.lower_inc`, :lookup:`rangefield.lower_inf`,
+  :lookup:`rangefield.upper_inc`, and :lookup:`rangefield.upper_inf` lookups
+  allow querying :class:`~django.contrib.postgres.fields.RangeField` by a bound
+  type.
+
+* :lookup:`rangefield.contained_by` now supports
+  :class:`~django.db.models.SmallAutoField`,
+  :class:`~django.db.models.AutoField`,
+  :class:`~django.db.models.BigAutoField`,
+  :class:`~django.db.models.SmallIntegerField`, and
+  :class:`~django.db.models.DecimalField`.
+
+* :class:`~django.contrib.postgres.search.SearchQuery` now supports
+  ``'websearch'`` search type on PostgreSQL 11+.
+
+* :class:`SearchQuery.value <django.contrib.postgres.search.SearchQuery>` now
+  supports query expressions.
+
+* The new :class:`~django.contrib.postgres.search.SearchHeadline` class allows
+  highlighting search results.
+
+* :lookup:`search` lookup now supports query expressions.
+
+* The new ``cover_density`` parameter of
+  :class:`~django.contrib.postgres.search.SearchRank` allows ranking by cover
+  density.
+
+* The new ``normalization`` parameter of
+  :class:`~django.contrib.postgres.search.SearchRank` allows rank
+  normalization.
+
+* The new :attr:`.ExclusionConstraint.deferrable` attribute allows creating
+  deferrable exclusion constraints.
+
+:mod:`django.contrib.sessions`
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+* The :setting:`SESSION_COOKIE_SAMESITE` setting now allows ``'None'`` (string)
+  value to explicitly state that the cookie is sent with all same-site and
+  cross-site requests.
+
+:mod:`django.contrib.staticfiles`
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+* The :setting:`STATICFILES_DIRS` setting now supports :class:`pathlib.Path`.
+
+Cache
+~~~~~
+
+* The :func:`~django.views.decorators.cache.cache_control` decorator and
+  :func:`~django.utils.cache.patch_cache_control` method now support multiple
+  field names in the ``no-cache`` directive for the ``Cache-Control`` header,
+  according to :rfc:`7234#section-5.2.2.2`.
+
+* :meth:`~django.core.cache.cache.delete` now returns ``True`` if the key was
+  successfully deleted, ``False`` otherwise.
+
+CSRF
+~~~~
+
+* The :setting:`CSRF_COOKIE_SAMESITE` setting now allows ``'None'`` (string)
+  value to explicitly state that the cookie is sent with all same-site and
+  cross-site requests.
+
+Email
+~~~~~
+
+* The :setting:`EMAIL_FILE_PATH` setting, used by the :ref:`file email backend
+  <topic-email-file-backend>`, now supports :class:`pathlib.Path`.
+
+Error Reporting
+~~~~~~~~~~~~~~~
+
+* :class:`django.views.debug.SafeExceptionReporterFilter` now filters sensitive
+  values from ``request.META`` in exception reports.
+
+* The new :attr:`.SafeExceptionReporterFilter.cleansed_substitute` and
+  :attr:`.SafeExceptionReporterFilter.hidden_settings` attributes allow
+  customization of sensitive settings and ``request.META`` filtering in
+  exception reports.
+
+* The technical 404 debug view now respects
+  :setting:`DEFAULT_EXCEPTION_REPORTER_FILTER` when applying settings
+  filtering.
+
+* The new :setting:`DEFAULT_EXCEPTION_REPORTER` allows providing a
+  :class:`django.views.debug.ExceptionReporter` subclass to customize exception
+  report generation. See :ref:`custom-error-reports` for details.
+
+File Storage
+~~~~~~~~~~~~
+
+* ``FileSystemStorage.save()`` method now supports :class:`pathlib.Path`.
+
+* :class:`~django.db.models.FileField` and
+  :class:`~django.db.models.ImageField` now accept a callable for ``storage``.
+  This allows you to modify the used storage at runtime, selecting different
+  storages for different environments, for example.
+
+Forms
+~~~~~
+
+* :class:`~django.forms.ModelChoiceIterator`, used by
+  :class:`~django.forms.ModelChoiceField` and
+  :class:`~django.forms.ModelMultipleChoiceField`, now uses
+  :class:`~django.forms.ModelChoiceIteratorValue` that can be used by widgets
+  to access model instances. See :ref:`iterating-relationship-choices` for
+  details.
+
+* :class:`django.forms.DateTimeField` now accepts dates in a subset of ISO 8601
+  datetime formats, including optional timezone, e.g. ``2019-10-10T06:47``,
+  ``2019-10-10T06:47:23+04:00``, or ``2019-10-10T06:47:23Z``. The timezone will
+  always be retained if provided, with timezone-aware datetimes being returned
+  even when :setting:`USE_TZ` is ``False``.
+
+  Additionally, ``DateTimeField`` now uses ``DATE_INPUT_FORMATS`` in addition
+  to ``DATETIME_INPUT_FORMATS`` when converting a field input to a ``datetime``
+  value.
+
+* :attr:`.MultiWidget.widgets` now accepts a dictionary which allows
+  customizing subwidget ``name`` attributes.
+
+* The new :attr:`.BoundField.widget_type` property can be used to dynamically
+  adjust form rendering based upon the widget type.
+
+Internationalization
+~~~~~~~~~~~~~~~~~~~~
+
+* The :setting:`LANGUAGE_COOKIE_SAMESITE` setting now allows ``'None'``
+  (string) value to explicitly state that the cookie is sent with all same-site
+  and cross-site requests.
+
+* Added support and translations for the Algerian Arabic, Igbo, Kyrgyz, Tajik,
+  and Turkmen languages.
+
+Management Commands
+~~~~~~~~~~~~~~~~~~~
+
+* The new :option:`check --database` option allows specifying database aliases
+  for running the ``database`` system checks. Previously these checks were
+  enabled for all configured :setting:`DATABASES` by passing the ``database``
+  tag to the command.
+
+* The new :option:`migrate --check` option makes the command exit with a
+  non-zero status when unapplied migrations are detected.
+
+* The new ``returncode`` argument for
+  :attr:`~django.core.management.CommandError` allows customizing the exit
+  status for management commands.
+
+* The new :option:`dbshell -- ARGUMENTS <dbshell -->` option allows passing
+  extra arguments to the command-line client for the database.
+
+* The :djadmin:`flush` and :djadmin:`sqlflush` commands now include SQL to
+  reset sequences on SQLite.
+
+Models
+~~~~~~
+
+* The new :class:`~django.db.models.functions.ExtractIsoWeekDay` function
+  extracts ISO-8601 week days from :class:`~django.db.models.DateField` and
+  :class:`~django.db.models.DateTimeField`, and the new :lookup:`iso_week_day`
+  lookup allows querying by an ISO-8601 day of week.
+
+* :meth:`.QuerySet.explain` now supports:
+
+  * ``TREE`` format on MySQL 8.0.16+,
+  * ``analyze`` option on MySQL 8.0.18+ and MariaDB.
+
+* Added :class:`~django.db.models.PositiveBigIntegerField` which acts much like
+  a :class:`~django.db.models.PositiveIntegerField` except that it only allows
+  values under a certain (database-dependent) limit. Values from ``0`` to
+  ``9223372036854775807`` are safe in all databases supported by Django.
+
+* The new :class:`~django.db.models.RESTRICT` option for
+  :attr:`~django.db.models.ForeignKey.on_delete` argument of ``ForeignKey`` and
+  ``OneToOneField`` emulates the behavior of the SQL constraint ``ON DELETE
+  RESTRICT``.
+
+* :attr:`.CheckConstraint.check` now supports boolean expressions.
+
+* The :meth:`.RelatedManager.add`, :meth:`~.RelatedManager.create`, and
+  :meth:`~.RelatedManager.set` methods now accept callables as values in the
+  ``through_defaults`` argument.
+
+* The new ``is_dst``  parameter of the :meth:`.QuerySet.datetimes` determines
+  the treatment of nonexistent and ambiguous datetimes.
+
+* The new :class:`~django.db.models.F` expression ``bitxor()`` method allows
+  :ref:`bitwise XOR operation <using-f-expressions-in-filters>`.
+
+* :meth:`.QuerySet.bulk_create` now sets the primary key on objects when using
+  MariaDB 10.5+.
+
+* The ``DatabaseOperations.sql_flush()`` method now generates more efficient
+  SQL on MySQL by using ``DELETE`` instead of ``TRUNCATE`` statements for
+  tables which don't require resetting sequences.
+
+* SQLite functions are now marked as :py:meth:`deterministic
+  <sqlite3.Connection.create_function>` on Python 3.8+. This allows using them
+  in check constraints and partial indexes.
+
+* The new :attr:`.UniqueConstraint.deferrable` attribute allows creating
+  deferrable unique constraints.
+
+Pagination
+~~~~~~~~~~
+
+* :class:`~django.core.paginator.Paginator` can now be iterated over to yield
+  its pages.
+
+Requests and Responses
+~~~~~~~~~~~~~~~~~~~~~~
+
+* If :setting:`ALLOWED_HOSTS` is empty and ``DEBUG=True``, subdomains of
+  localhost are now allowed in the ``Host`` header, e.g. ``static.localhost``.
+
+* :meth:`.HttpResponse.set_cookie` and :meth:`.HttpResponse.set_signed_cookie`
+  now allow using ``samesite='None'`` (string) to explicitly state that the
+  cookie is sent with all same-site and cross-site requests.
+
+* The new :meth:`.HttpRequest.accepts` method returns whether the request
+  accepts the given MIME type according to the ``Accept`` HTTP header.
+
+.. _whats-new-security-3.1:
+
+Security
+~~~~~~~~
+
+* The :setting:`SECURE_REFERRER_POLICY` setting now defaults to
+  ``'same-origin'``. With this configured,
+  :class:`~django.middleware.security.SecurityMiddleware` sets the
+  :ref:`referrer-policy` header to ``same-origin`` on all responses that do not
+  already have it. This prevents the ``Referer`` header being sent to other
+  origins. If you need the previous behavior, explicitly set
+  :setting:`SECURE_REFERRER_POLICY` to ``None``.
+
+* The default algorithm of :class:`django.core.signing.Signer`,
+  :meth:`django.core.signing.loads`, and :meth:`django.core.signing.dumps` is
+  changed to the SHA-256. Support for signatures made with the old SHA-1
+  algorithm remains until Django 4.0.
+
+  Also, the new ``algorithm`` parameter of the
+  :class:`~django.core.signing.Signer` allows customizing the hashing
+  algorithm.
+
+Templates
+~~~~~~~~~
+
+* The renamed :ttag:`translate` and :ttag:`blocktranslate` template tags are
+  introduced for internationalization in template code. The older :ttag:`trans`
+  and :ttag:`blocktrans` template tags aliases continue to work, and will be
+  retained for the foreseeable future.
+
+* The :ttag:`include` template tag now accepts iterables of template names.
+
+Tests
+~~~~~
+
+* :class:`~django.test.SimpleTestCase` now implements the ``debug()`` method to
+  allow running a test without collecting the result and catching exceptions.
+  This can be used to support running tests under a debugger.
+
+* The new :setting:`MIGRATE <TEST_MIGRATE>` test database setting allows
+  disabling of migrations during a test database creation.
+
+* Django test runner now supports a :option:`test --buffer` option to discard
+  output for passing tests.
+
+* :class:`~django.test.runner.DiscoverRunner` now skips running the system
+  checks on databases not :ref:`referenced by tests<testing-multi-db>`.
+
+* :class:`~django.test.TransactionTestCase` teardown is now faster on MySQL
+  due to :djadmin:`flush` command improvements. As a side effect the latter
+  doesn't automatically reset sequences on teardown anymore. Enable
+  :attr:`.TransactionTestCase.reset_sequences` if your tests require this
+  feature.
+
+URLs
+~~~~
+
+* :ref:`Path converters <registering-custom-path-converters>` can now raise
+  ``ValueError`` in ``to_url()`` to indicate no match when reversing URLs.
+
+Utilities
+~~~~~~~~~
+
+* :func:`~django.utils.encoding.filepath_to_uri` now supports
+  :class:`pathlib.Path`.
+
+* :func:`~django.utils.dateparse.parse_duration` now supports comma separators
+  for decimal fractions in the ISO 8601 format.
+
+* :func:`~django.utils.dateparse.parse_datetime`,
+  :func:`~django.utils.dateparse.parse_duration`, and
+  :func:`~django.utils.dateparse.parse_time` now support comma separators for
+  milliseconds.
+
+Miscellaneous
+~~~~~~~~~~~~~
+
+* The SQLite backend now supports :class:`pathlib.Path` for the ``NAME``
+  setting.
+
+* The ``settings.py`` generated by the :djadmin:`startproject` command now uses
+  :class:`pathlib.Path` instead of :mod:`os.path` for building filesystem
+  paths.
+
+* The :setting:`TIME_ZONE <DATABASE-TIME_ZONE>` setting is now allowed on
+  databases that support time zones.
+
+.. _backwards-incompatible-3.1:
+
+Backwards incompatible changes in 3.1
+=====================================
+
+Database backend API
+--------------------
+
+This section describes changes that may be needed in third-party database
+backends.
+
+* ``DatabaseOperations.fetch_returned_insert_columns()`` now requires an
+  additional ``returning_params`` argument.
+
+* ``connection.timezone`` property is now ``'UTC'`` by default, or the
+  :setting:`TIME_ZONE <DATABASE-TIME_ZONE>` when :setting:`USE_TZ` is ``True``
+  on databases that support time zones. Previously, it was ``None`` on
+  databases that support time zones.
+
+* ``connection._nodb_connection`` property is changed to the
+  ``connection._nodb_cursor()`` method and now returns a context manager that
+  yields a cursor and automatically closes the cursor and connection upon
+  exiting the ``with`` statement.
+
+* ``DatabaseClient.runshell()`` now requires an additional ``parameters``
+  argument as a list of extra arguments to pass on to the command-line client.
+
+* The ``sequences`` positional argument of ``DatabaseOperations.sql_flush()``
+  is replaced by the boolean keyword-only argument ``reset_sequences``. If
+  ``True``, the sequences of the truncated tables will be reset.
+
+* The ``allow_cascade`` argument of ``DatabaseOperations.sql_flush()`` is now a
+  keyword-only argument.
+
+* The ``using`` positional argument of
+  ``DatabaseOperations.execute_sql_flush()`` is removed. The method now uses
+  the database of the called instance.
+
+* Third-party database backends must implement support for ``JSONField`` or set
+  ``DatabaseFeatures.supports_json_field`` to ``False``. If storing primitives
+  is not supported, set ``DatabaseFeatures.supports_primitives_in_json_field``
+  to ``False``. If there is a true datatype for JSON, set
+  ``DatabaseFeatures.has_native_json_field`` to ``True``. If
+  :lookup:`jsonfield.contains` and :lookup:`jsonfield.contained_by` are not
+  supported, set ``DatabaseFeatures.supports_json_field_contains`` to
+  ``False``.
+
+* Third party database backends must implement introspection for ``JSONField``
+  or set ``can_introspect_json_field`` to ``False``.
+
+Dropped support for MariaDB 10.1
+--------------------------------
+
+Upstream support for MariaDB 10.1 ends in October 2020. Django 3.1 supports
+MariaDB 10.2 and higher.
+
+``contrib.admin`` browser support
+---------------------------------
+
+The admin no longer supports the legacy Internet Explorer browser. See
+:ref:`the admin FAQ <admin-browser-support>` for details on supported browsers.
+
+:attr:`AbstractUser.first_name <django.contrib.auth.models.User.first_name>` ``max_length`` increased to 150
+------------------------------------------------------------------------------------------------------------
+
+A migration for :attr:`django.contrib.auth.models.User.first_name` is included.
+If you have a custom user model inheriting from ``AbstractUser``, you'll need
+to generate and apply a database migration for your user model.
+
+If you want to preserve the 30 character limit for first names, use a custom
+form::
+
+    from django import forms
+    from django.contrib.auth.forms import UserChangeForm
+
+
+    class MyUserChangeForm(UserChangeForm):
+        first_name = forms.CharField(max_length=30, required=False)
+
+If you wish to keep this restriction in the admin when editing users, set
+``UserAdmin.form`` to use this form::
+
+    from django.contrib.auth.admin import UserAdmin
+    from django.contrib.auth.models import User
+
+
+    class MyUserAdmin(UserAdmin):
+        form = MyUserChangeForm
+
+
+    admin.site.unregister(User)
+    admin.site.register(User, MyUserAdmin)
+
+Miscellaneous
+-------------
+
+* The cache keys used by :ttag:`cache` and generated by
+  :func:`~django.core.cache.utils.make_template_fragment_key` are different
+  from the keys generated by older versions of Django. After upgrading to
+  Django 3.1, the first request to any previously cached template fragment will
+  be a cache miss.
+
+* The logic behind the decision to return a redirection fallback or a 204 HTTP
+  response from the :func:`~django.views.i18n.set_language` view is now based
+  on the ``Accept`` HTTP header instead of the ``X-Requested-With`` HTTP header
+  presence.
+
+* The compatibility imports of ``django.core.exceptions.EmptyResultSet`` in
+  ``django.db.models.query``, ``django.db.models.sql``, and
+  ``django.db.models.sql.datastructures`` are removed.
+
+* The compatibility import of ``django.core.exceptions.FieldDoesNotExist`` in
+  ``django.db.models.fields`` is removed.
+
+* The compatibility imports of ``django.forms.utils.pretty_name()`` and
+  ``django.forms.boundfield.BoundField`` in ``django.forms.forms`` are removed.
+
+* The compatibility imports of ``Context``, ``ContextPopException``, and
+  ``RequestContext`` in ``django.template.base`` are removed.
+
+* The compatibility import of
+  ``django.contrib.admin.helpers.ACTION_CHECKBOX_NAME`` in
+  ``django.contrib.admin`` is removed.
+
+* The :setting:`STATIC_URL` and :setting:`MEDIA_URL` settings set to relative
+  paths are now prefixed by the server-provided value of ``SCRIPT_NAME`` (or
+  ``/`` if not set). This change should not affect settings set to valid URLs
+  or absolute paths.
+
+* :class:`~django.middleware.http.ConditionalGetMiddleware` no longer adds the
+  ``ETag`` header to responses with an empty
+  :attr:`~django.http.HttpResponse.content`.
+
+* ``django.utils.decorators.classproperty()`` decorator is made public and
+  moved to :class:`django.utils.functional.classproperty()`.
+
+* :tfilter:`floatformat` template filter now outputs (positive) ``0`` for
+  negative numbers which round to zero.
+
+* :attr:`Meta.ordering <django.db.models.Options.ordering>` and
+  :attr:`Meta.unique_together <django.db.models.Options.unique_together>`
+  options on models in ``django.contrib`` modules that were formerly tuples are
+  now lists.
+
+* The admin calendar widget now handles two-digit years according to the Open
+  Group Specification, i.e. values between 69 and 99 are mapped to the previous
+  century, and values between 0 and 68 are mapped to the current century.
+
+* Date-only formats are removed from the default list for
+  :setting:`DATETIME_INPUT_FORMATS`.
+
+* The :class:`~django.forms.FileInput` widget no longer renders with the
+  ``required`` HTML attribute when initial data exists.
+
+* The undocumented ``django.views.debug.ExceptionReporterFilter`` class is
+  removed. As per the :ref:`custom-error-reports` documentation, classes to be
+  used with :setting:`DEFAULT_EXCEPTION_REPORTER_FILTER` need to inherit from
+  :class:`django.views.debug.SafeExceptionReporterFilter`.
+
+* The cache timeout set by :func:`~django.views.decorators.cache.cache_page`
+  decorator now takes precedence over the ``max-age`` directive from the
+  ``Cache-Control`` header.
+
+* Providing a non-local remote field in the :attr:`.ForeignKey.to_field`
+  argument now raises :class:`~django.core.exceptions.FieldError`.
+
+* :setting:`SECURE_REFERRER_POLICY` now defaults to ``'same-origin'``. See the
+  *What's New* :ref:`Security section <whats-new-security-3.1>` above for more
+  details.
+
+* :djadmin:`check` management command now runs the ``database`` system checks
+  only for database aliases specified using :option:`check --database` option.
+
+* :djadmin:`migrate` management command now runs the ``database`` system checks
+  only for a database to migrate.
+
+* The admin CSS classes ``row1`` and ``row2`` are removed in favor of
+  ``:nth-child(odd)`` and ``:nth-child(even)`` pseudo-classes.
+
+* The :func:`~django.contrib.auth.hashers.make_password` function now requires
+  its argument to be a string or bytes. Other types should be explicitly cast
+  to one of these.
+
+* The undocumented ``version`` parameter to the
+  :class:`~django.contrib.gis.db.models.functions.AsKML` function is removed.
+
+* :ref:`JSON and YAML serializers <serialization-formats>`, used by
+  :djadmin:`dumpdata`, now dump all data with Unicode by default. If you need
+  the previous behavior, pass ``ensure_ascii=True`` to JSON serializer, or
+  ``allow_unicode=False`` to YAML serializer.
+
+* The auto-reloader no longer monitors changes in built-in Django translation
+  files.
+
+* The minimum supported version of ``mysqlclient`` is increased from 1.3.13 to
+  1.4.0.
+
+* The undocumented ``django.contrib.postgres.forms.InvalidJSONInput`` and
+  ``django.contrib.postgres.forms.JSONString`` are moved to
+  ``django.forms.fields``.
+
+* The undocumented ``django.contrib.postgres.fields.jsonb.JsonAdapter`` class
+  is removed.
+
+* The :ttag:`{% localize off %} <localize>` tag and :tfilter:`unlocalize`
+  filter no longer respect :setting:`DECIMAL_SEPARATOR` setting.
+
+* The minimum supported version of ``asgiref`` is increased from 3.2 to
+  3.2.10.
+
+* The :doc:`Media </topics/forms/media>` class now renders ``<script>`` tags
+  without the ``type`` attribute to follow `WHATWG recommendations
+  <https://html.spec.whatwg.org/multipage/scripting.html#the-script-element>`_.
+
+* :class:`~django.forms.ModelChoiceIterator`, used by
+  :class:`~django.forms.ModelChoiceField` and
+  :class:`~django.forms.ModelMultipleChoiceField`, now yields 2-tuple choices
+  containing :class:`~django.forms.ModelChoiceIteratorValue` instances as the
+  first ``value`` element in each choice. In most cases this proxies
+  transparently, but if you need the ``field`` value itself, use the
+  :attr:`.ModelChoiceIteratorValue.value` attribute instead.
+
+.. _deprecated-features-3.1:
+
+Features deprecated in 3.1
+==========================
+
+.. _deprecated-jsonfield:
+
+PostgreSQL ``JSONField``
+------------------------
+
+``django.contrib.postgres.fields.JSONField`` and
+``django.contrib.postgres.forms.JSONField`` are deprecated in favor of
+:class:`.models.JSONField` and
+:class:`forms.JSONField <django.forms.JSONField>`.
+
+The undocumented ``django.contrib.postgres.fields.jsonb.KeyTransform`` and
+``django.contrib.postgres.fields.jsonb.KeyTextTransform`` are also deprecated
+in favor of the transforms in ``django.db.models.fields.json``.
+
+The new ``JSONField``\s, ``KeyTransform``, and ``KeyTextTransform`` can be used
+on all supported database backends.
+
+Miscellaneous
+-------------
+
+* ``PASSWORD_RESET_TIMEOUT_DAYS`` setting is deprecated in favor of
+  :setting:`PASSWORD_RESET_TIMEOUT`.
+
+* The undocumented usage of the :lookup:`isnull` lookup with non-boolean values
+  as the right-hand side is deprecated, use ``True`` or ``False`` instead.
+
+* The barely documented ``django.db.models.query_utils.InvalidQuery`` exception
+  class is deprecated in favor of
+  :class:`~django.core.exceptions.FieldDoesNotExist` and
+  :class:`~django.core.exceptions.FieldError`.
+
+* The ``django-admin.py`` entry point is deprecated in favor of
+  ``django-admin``.
+
+* The ``HttpRequest.is_ajax()`` method is deprecated as it relied on a
+  jQuery-specific way of signifying AJAX calls, while current usage tends to
+  use the JavaScript `Fetch API
+  <https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API>`_. Depending on
+  your use case, you can either write your own AJAX detection method, or use
+  the new :meth:`.HttpRequest.accepts` method if your code depends on the
+  client ``Accept`` HTTP header.
+
+  If you are writing your own AJAX detection method, ``request.is_ajax()`` can
+  be reproduced exactly as
+  ``request.headers.get('x-requested-with') == 'XMLHttpRequest'``.
+
+* Passing ``None`` as the first argument to
+  ``django.utils.deprecation.MiddlewareMixin.__init__()`` is deprecated.
+
+* The encoding format of cookies values used by
+  :class:`~django.contrib.messages.storage.cookie.CookieStorage` is different
+  from the format generated by older versions of Django. Support for the old
+  format remains until Django 4.0.
+
+* The encoding format of sessions is different from the format generated by
+  older versions of Django. Support for the old format remains until Django
+  4.0.
+
+* The purely documentational ``providing_args`` argument for
+  :class:`~django.dispatch.Signal` is deprecated. If you rely on this
+  argument as documentation, you can move the text to a code comment or
+  docstring.
+
+* Calling ``django.utils.crypto.get_random_string()`` without a ``length``
+  argument is deprecated.
+
+* The ``list`` message for :class:`~django.forms.ModelMultipleChoiceField` is
+  deprecated in favor of ``invalid_list``.
+
+* Passing raw column aliases to :meth:`.QuerySet.order_by` is deprecated. The
+  same result can be achieved by passing aliases in a
+  :class:`~django.db.models.expressions.RawSQL` instead beforehand.
+
+* The ``NullBooleanField`` model field is deprecated in favor of
+  ``BooleanField(null=True, blank=True)``.
+
+* ``django.conf.urls.url()`` alias of :func:`django.urls.re_path` is
+  deprecated.
+
+* The ``{% ifequal %}`` and ``{% ifnotequal %}`` template tags are deprecated
+  in favor of :ttag:`{% if %}<if>`. ``{% if %}`` covers all use cases, but if
+  you need to continue using these tags, they can be extracted from Django to a
+  module and included as a built-in tag in the :class:`'builtins'
+  <django.template.backends.django.DjangoTemplates>` option in
+  :setting:`OPTIONS <TEMPLATES-OPTIONS>`.
+
+* ``DEFAULT_HASHING_ALGORITHM`` transitional setting is deprecated.
+
+.. _removed-features-3.1:
+
+Features removed in 3.1
+=======================
+
+These features have reached the end of their deprecation cycle and are removed
+in Django 3.1.
+
+See :ref:`deprecated-features-2.2` for details on these changes, including how
+to remove usage of these features.
+
+* ``django.utils.timezone.FixedOffset`` is removed.
+
+* ``django.core.paginator.QuerySetPaginator`` is removed.
+
+* A model's ``Meta.ordering`` doesn't affect ``GROUP BY`` queries.
+
+* ``django.contrib.postgres.fields.FloatRangeField`` and
+  ``django.contrib.postgres.forms.FloatRangeField`` are removed.
+
+* The ``FILE_CHARSET`` setting is removed.
+
+* ``django.contrib.staticfiles.storage.CachedStaticFilesStorage`` is removed.
+
+* The ``RemoteUserBackend.configure_user()`` method requires ``request`` as the
+  first positional argument.
+
+* Support for ``SimpleTestCase.allow_database_queries`` and
+  ``TransactionTestCase.multi_db`` is removed.

testbed/django__django/docs/releases/3.2.txt

@@ -0,0 +1,791 @@
+========================
+Django 3.2 release notes
+========================
+
+*April 6, 2021*
+
+Welcome to Django 3.2!
+
+These release notes cover the :ref:`new features <whats-new-3.2>`, as well as
+some :ref:`backwards incompatible changes <backwards-incompatible-3.2>` you'll
+want to be aware of when upgrading from Django 3.1 or earlier. We've
+:ref:`begun the deprecation process for some features
+<deprecated-features-3.2>`.
+
+See the :doc:`/howto/upgrade-version` guide if you're updating an existing
+project.
+
+Django 3.2 is designated as a :term:`long-term support release
+<Long-term support release>`. It will receive security updates for at least
+three years after its release. Support for the previous LTS, Django 2.2, will
+end in April 2022.
+
+Python compatibility
+====================
+
+Django 3.2 supports Python 3.6, 3.7, 3.8, 3.9, and 3.10 (as of 3.2.9). We
+**highly recommend** and only officially support the latest release of each
+series.
+
+.. _whats-new-3.2:
+
+What's new in Django 3.2
+========================
+
+Automatic :class:`~django.apps.AppConfig` discovery
+---------------------------------------------------
+
+Most pluggable applications define an :class:`~django.apps.AppConfig` subclass
+in an ``apps.py`` submodule. Many define a ``default_app_config`` variable
+pointing to this class in their ``__init__.py``.
+
+When the ``apps.py`` submodule exists and defines a single
+:class:`~django.apps.AppConfig` subclass, Django now uses that configuration
+automatically, so you can remove ``default_app_config``.
+
+``default_app_config`` made it possible to declare only the application's path
+in :setting:`INSTALLED_APPS` (e.g. ``'django.contrib.admin'``) rather than the
+app config's path (e.g. ``'django.contrib.admin.apps.AdminConfig'``). It was
+introduced for backwards-compatibility with the former style, with the intent
+to switch the ecosystem to the latter, but the switch didn't happen.
+
+With automatic ``AppConfig`` discovery, ``default_app_config`` is no longer
+needed. As a consequence, it's deprecated.
+
+See :ref:`configuring-applications-ref` for full details.
+
+Customizing type of auto-created primary keys
+---------------------------------------------
+
+When defining a model, if no field in a model is defined with
+:attr:`primary_key=True <django.db.models.Field.primary_key>` an implicit
+primary key is added. The type of this implicit primary key can now be
+controlled via the :setting:`DEFAULT_AUTO_FIELD` setting and
+:attr:`AppConfig.default_auto_field <django.apps.AppConfig.default_auto_field>`
+attribute. No more needing to override primary keys in all models.
+
+Maintaining the historical behavior, the default value for
+:setting:`DEFAULT_AUTO_FIELD` is :class:`~django.db.models.AutoField`. Starting
+with 3.2 new projects are generated with :setting:`DEFAULT_AUTO_FIELD` set to
+:class:`~django.db.models.BigAutoField`. Also, new apps are generated with
+:attr:`AppConfig.default_auto_field <django.apps.AppConfig.default_auto_field>`
+set to :class:`~django.db.models.BigAutoField`. In a future Django release the
+default value of :setting:`DEFAULT_AUTO_FIELD` will be changed to
+:class:`~django.db.models.BigAutoField`.
+
+To avoid unwanted migrations in the future, either explicitly set
+:setting:`DEFAULT_AUTO_FIELD` to :class:`~django.db.models.AutoField`::
+
+    DEFAULT_AUTO_FIELD = "django.db.models.AutoField"
+
+or configure it on a per-app basis::
+
+    from django.apps import AppConfig
+
+
+    class MyAppConfig(AppConfig):
+        default_auto_field = "django.db.models.AutoField"
+        name = "my_app"
+
+or on a per-model basis::
+
+    from django.db import models
+
+
+    class MyModel(models.Model):
+        id = models.AutoField(primary_key=True)
+
+In anticipation of the changing default, a system check will provide a warning
+if you do not have an explicit setting for :setting:`DEFAULT_AUTO_FIELD`.
+
+When changing the value of :setting:`DEFAULT_AUTO_FIELD`, migrations for the
+primary key of existing auto-created through tables cannot be generated
+currently. See the :setting:`DEFAULT_AUTO_FIELD` docs for details on migrating
+such tables.
+
+.. _new_functional_indexes:
+
+Functional indexes
+------------------
+
+The new :attr:`*expressions <django.db.models.Index.expressions>` positional
+argument of :class:`Index() <django.db.models.Index>` enables creating
+functional indexes on expressions and database functions. For example::
+
+    from django.db import models
+    from django.db.models import F, Index, Value
+    from django.db.models.functions import Lower, Upper
+
+
+    class MyModel(models.Model):
+        first_name = models.CharField(max_length=255)
+        last_name = models.CharField(max_length=255)
+        height = models.IntegerField()
+        weight = models.IntegerField()
+
+        class Meta:
+            indexes = [
+                Index(
+                    Lower("first_name"),
+                    Upper("last_name").desc(),
+                    name="first_last_name_idx",
+                ),
+                Index(
+                    F("height") / (F("weight") + Value(5)),
+                    name="calc_idx",
+                ),
+            ]
+
+Functional indexes are added to models using the
+:attr:`Meta.indexes <django.db.models.Options.indexes>` option.
+
+``pymemcache`` support
+----------------------
+
+The new ``django.core.cache.backends.memcached.PyMemcacheCache`` cache backend
+allows using the :pypi:`pymemcache` library for memcached. ``pymemcache`` 3.4.0
+or higher is required. For more details, see the :doc:`documentation on caching
+in Django </topics/cache>`.
+
+New decorators for the admin site
+---------------------------------
+
+The new :func:`~django.contrib.admin.display` decorator allows for easily
+adding options to custom display functions that can be used with
+:attr:`~django.contrib.admin.ModelAdmin.list_display` or
+:attr:`~django.contrib.admin.ModelAdmin.readonly_fields`.
+
+Likewise, the new :func:`~django.contrib.admin.action` decorator allows for
+easily adding options to action functions that can be used with
+:attr:`~django.contrib.admin.ModelAdmin.actions`.
+
+Using the ``@display`` decorator has the advantage that it is now
+possible to use the ``@property`` decorator when needing to specify attributes
+on the custom method. Prior to this it was necessary to use the ``property()``
+function instead after assigning the required attributes to the method.
+
+Using decorators has the advantage that these options are more discoverable as
+they can be suggested by completion utilities in code editors. They are merely
+a convenience and still set the same attributes on the functions under the
+hood.
+
+Minor features
+--------------
+
+:mod:`django.contrib.admin`
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+* :attr:`.ModelAdmin.search_fields` now allows searching against quoted phrases
+  with spaces.
+
+* Read-only related fields are now rendered as navigable links if target models
+  are registered in the admin.
+
+* The admin now supports theming, and includes a dark theme that is enabled
+  according to browser settings. See :ref:`admin-theming` for more details.
+
+* :attr:`.ModelAdmin.autocomplete_fields` now respects
+  :attr:`ForeignKey.to_field <django.db.models.ForeignKey.to_field>` and
+  :attr:`ForeignKey.limit_choices_to
+  <django.db.models.ForeignKey.limit_choices_to>` when searching a related
+  model.
+
+* The admin now installs a final catch-all view that redirects unauthenticated
+  users to the login page, regardless of whether the URL is otherwise valid.
+  This protects against a potential model enumeration privacy issue.
+
+  Although not recommended, you may set the new
+  :attr:`.AdminSite.final_catch_all_view` to ``False`` to disable the
+  catch-all view.
+
+:mod:`django.contrib.auth`
+~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+* The default iteration count for the PBKDF2 password hasher is increased from
+  216,000 to 260,000.
+
+* The default variant for the Argon2 password hasher is changed to Argon2id.
+  ``memory_cost`` and ``parallelism`` are increased to 102,400 and 8
+  respectively to match the ``argon2-cffi`` defaults.
+
+  Increasing the ``memory_cost`` pushes the required memory from 512 KB to 100
+  MB. This is still rather conservative but can lead to problems in memory
+  constrained environments. If this is the case, the existing hasher can be
+  subclassed to override the defaults.
+
+* The default salt entropy for the Argon2, MD5, PBKDF2, SHA-1 password hashers
+  is increased from 71 to 128 bits.
+
+:mod:`django.contrib.contenttypes`
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+* The new ``absolute_max`` argument for
+  :func:`~django.contrib.contenttypes.forms.generic_inlineformset_factory`
+  allows customizing the maximum number of forms that can be instantiated when
+  supplying ``POST`` data. See :ref:`formsets-absolute-max` for more details.
+
+* The new ``can_delete_extra`` argument for
+  :func:`~django.contrib.contenttypes.forms.generic_inlineformset_factory`
+  allows removal of the option to delete extra forms. See
+  :attr:`~.BaseFormSet.can_delete_extra` for more information.
+
+:mod:`django.contrib.gis`
+~~~~~~~~~~~~~~~~~~~~~~~~~
+
+* The :meth:`.GDALRaster.transform` method now supports
+  :class:`~django.contrib.gis.gdal.SpatialReference`.
+
+* The :class:`~django.contrib.gis.gdal.DataSource` class now supports
+  :class:`pathlib.Path`.
+
+* The :class:`~django.contrib.gis.utils.LayerMapping` class now supports
+  :class:`pathlib.Path`.
+
+:mod:`django.contrib.postgres`
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+* The new :attr:`.ExclusionConstraint.include` attribute allows creating
+  covering exclusion constraints on PostgreSQL 12+.
+
+* The new ``ExclusionConstraint.opclasses`` attribute allows setting PostgreSQL
+  operator classes.
+
+* The new :attr:`.JSONBAgg.ordering` attribute determines the ordering of the
+  aggregated elements.
+
+* The new :attr:`.JSONBAgg.distinct` attribute determines if aggregated values
+  will be distinct.
+
+* The :class:`~django.contrib.postgres.operations.CreateExtension` operation
+  now checks that the extension already exists in the database and skips the
+  migration if so.
+
+* The new :class:`~django.contrib.postgres.operations.CreateCollation` and
+  :class:`~django.contrib.postgres.operations.RemoveCollation` operations
+  allow creating and dropping collations on PostgreSQL. See
+  :ref:`manage-postgresql-collations` for more details.
+
+* Lookups for :class:`~django.contrib.postgres.fields.ArrayField` now allow
+  (non-nested) arrays containing expressions as right-hand sides.
+
+* The new :class:`OpClass() <django.contrib.postgres.indexes.OpClass>`
+  expression allows creating functional indexes on expressions with a custom
+  operator class. See :ref:`new_functional_indexes` for more details.
+
+:mod:`django.contrib.sitemaps`
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+* The new :class:`~django.contrib.sitemaps.Sitemap` attributes
+  :attr:`~django.contrib.sitemaps.Sitemap.alternates`,
+  :attr:`~django.contrib.sitemaps.Sitemap.languages` and
+  :attr:`~django.contrib.sitemaps.Sitemap.x_default` allow
+  generating sitemap *alternates* to localized versions of your pages.
+
+:mod:`django.contrib.syndication`
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+* The new ``item_comments`` hook allows specifying a comments URL per feed
+  item.
+
+Database backends
+~~~~~~~~~~~~~~~~~
+
+* Third-party database backends can now skip or mark as expected failures
+  tests in Django's test suite using the new
+  ``DatabaseFeatures.django_test_skips`` and
+  ``django_test_expected_failures`` attributes.
+
+Decorators
+~~~~~~~~~~
+
+* The new :func:`~django.views.decorators.common.no_append_slash` decorator
+  allows individual views to be excluded from :setting:`APPEND_SLASH` URL
+  normalization.
+
+Error Reporting
+~~~~~~~~~~~~~~~
+
+* Custom :class:`~django.views.debug.ExceptionReporter` subclasses can now
+  define the :attr:`~django.views.debug.ExceptionReporter.html_template_path`
+  and :attr:`~django.views.debug.ExceptionReporter.text_template_path`
+  properties to override the templates used to render exception reports.
+
+File Uploads
+~~~~~~~~~~~~
+
+* The new :meth:`FileUploadHandler.upload_interrupted()
+  <django.core.files.uploadhandler.FileUploadHandler.upload_interrupted>`
+  callback allows handling interrupted uploads.
+
+Forms
+~~~~~
+
+* The new ``absolute_max`` argument for :func:`.formset_factory`,
+  :func:`.inlineformset_factory`, and :func:`.modelformset_factory` allows
+  customizing the maximum number of forms that can be instantiated when
+  supplying ``POST`` data. See :ref:`formsets-absolute-max` for more details.
+
+* The new ``can_delete_extra`` argument for :func:`.formset_factory`,
+  :func:`.inlineformset_factory`, and :func:`.modelformset_factory` allows
+  removal of the option to delete extra forms. See
+  :attr:`~.BaseFormSet.can_delete_extra` for more information.
+
+* :class:`~django.forms.formsets.BaseFormSet` now reports a user facing error,
+  rather than raising an exception, when the management form is missing or has
+  been tampered with. To customize this error message, pass the
+  ``error_messages`` argument with the key ``'missing_management_form'`` when
+  instantiating the formset.
+
+Generic Views
+~~~~~~~~~~~~~
+
+* The ``week_format`` attributes of
+  :class:`~django.views.generic.dates.WeekMixin` and
+  :class:`~django.views.generic.dates.WeekArchiveView` now support the
+  ``'%V'`` ISO 8601 week format.
+
+Management Commands
+~~~~~~~~~~~~~~~~~~~
+
+* :djadmin:`loaddata` now supports fixtures stored in XZ archives (``.xz``) and
+  LZMA archives (``.lzma``).
+
+* :djadmin:`dumpdata` now can compress data in the ``bz2``, ``gz``, ``lzma``,
+  or ``xz`` formats.
+
+* :djadmin:`makemigrations` can now be called without an active database
+  connection. In that case, check for a consistent migration history is
+  skipped.
+
+* :attr:`.BaseCommand.requires_system_checks` now supports specifying a list of
+  tags. System checks registered in the chosen tags will be checked for errors
+  prior to executing the command. In previous versions, either all or none
+  of the system checks were performed.
+
+* Support for colored terminal output on Windows is updated. Various modern
+  terminal environments are automatically detected, and the options for
+  enabling support in other cases are improved. See :ref:`syntax-coloring` for
+  more details.
+
+Migrations
+~~~~~~~~~~
+
+* The new ``Operation.migration_name_fragment`` property allows providing a
+  filename fragment that will be used to name a migration containing only that
+  operation.
+
+* Migrations now support serialization of pure and concrete path objects from
+  :mod:`pathlib`, and :class:`os.PathLike` instances.
+
+Models
+~~~~~~
+
+* The new ``no_key`` parameter for :meth:`.QuerySet.select_for_update()`,
+  supported on PostgreSQL, allows acquiring weaker locks that don't block the
+  creation of rows that reference locked rows through a foreign key.
+
+* :class:`When() <django.db.models.expressions.When>` expression now allows
+  using the ``condition`` argument with ``lookups``.
+
+* The new :attr:`.Index.include` and :attr:`.UniqueConstraint.include`
+  attributes allow creating covering indexes and covering unique constraints on
+  PostgreSQL 11+.
+
+* The new :attr:`.UniqueConstraint.opclasses` attribute allows setting
+  PostgreSQL operator classes.
+
+* The :meth:`.QuerySet.update` method now respects the ``order_by()`` clause on
+  MySQL and MariaDB.
+
+* :class:`FilteredRelation() <django.db.models.FilteredRelation>` now supports
+  nested relations.
+
+* The ``of`` argument of :meth:`.QuerySet.select_for_update()` is now allowed
+  on MySQL 8.0.1+.
+
+* :class:`Value() <django.db.models.Value>` expression now
+  automatically resolves its ``output_field`` to the appropriate
+  :class:`Field <django.db.models.Field>` subclass based on the type of
+  its provided ``value`` for :py:class:`bool`, :py:class:`bytes`,
+  :py:class:`float`, :py:class:`int`, :py:class:`str`,
+  :py:class:`datetime.date`, :py:class:`datetime.datetime`,
+  :py:class:`datetime.time`, :py:class:`datetime.timedelta`,
+  :py:class:`decimal.Decimal`, and :py:class:`uuid.UUID` instances. As a
+  consequence, resolving an ``output_field`` for database functions and
+  combined expressions may now crash with mixed types when using ``Value()``.
+  You will need to explicitly set the ``output_field`` in such cases.
+
+* The new :meth:`.QuerySet.alias` method allows creating reusable aliases for
+  expressions that don't need to be selected but are used for filtering,
+  ordering, or as a part of complex expressions.
+
+* The new :class:`~django.db.models.functions.Collate` function allows
+  filtering and ordering by specified database collations.
+
+* The ``field_name`` argument of :meth:`.QuerySet.in_bulk()` now accepts
+  distinct fields if there's only one field specified in
+  :meth:`.QuerySet.distinct`.
+
+* The new ``tzinfo`` parameter of the
+  :class:`~django.db.models.functions.TruncDate` and
+  :class:`~django.db.models.functions.TruncTime` database functions allows
+  truncating datetimes in a specific timezone.
+
+* The new ``db_collation`` argument for
+  :attr:`CharField <django.db.models.CharField.db_collation>` and
+  :attr:`TextField <django.db.models.TextField.db_collation>` allows setting a
+  database collation for the field.
+
+* Added the :class:`~django.db.models.functions.Random` database function.
+
+* :ref:`aggregation-functions`, :class:`F() <django.db.models.F>`,
+  :class:`OuterRef() <django.db.models.OuterRef>`, and other expressions now
+  allow using transforms. See :ref:`using-transforms-in-expressions` for
+  details.
+
+* The new ``durable`` argument for :func:`~django.db.transaction.atomic`
+  guarantees that changes made in the atomic block will be committed if the
+  block exits without errors. A nested atomic block marked as durable will
+  raise a ``RuntimeError``.
+
+* Added the :class:`~django.db.models.functions.JSONObject` database function.
+
+Pagination
+~~~~~~~~~~
+
+* The new :meth:`django.core.paginator.Paginator.get_elided_page_range` method
+  allows generating a page range with some of the values elided. If there are a
+  large number of pages, this can be helpful for generating a reasonable number
+  of page links in a template.
+
+Requests and Responses
+~~~~~~~~~~~~~~~~~~~~~~
+
+* Response headers are now stored in :attr:`.HttpResponse.headers`. This can be
+  used instead of the original dict-like interface of ``HttpResponse`` objects.
+  Both interfaces will continue to be supported. See
+  :ref:`setting-header-fields` for details.
+
+* The new ``headers`` parameter of :class:`~django.http.HttpResponse`,
+  :class:`~django.template.response.SimpleTemplateResponse`, and
+  :class:`~django.template.response.TemplateResponse` allows setting response
+  :attr:`~django.http.HttpResponse.headers` on instantiation.
+
+Security
+~~~~~~~~
+
+* The :setting:`SECRET_KEY` setting is now checked for a valid value upon first
+  access, rather than when settings are first loaded. This enables running
+  management commands that do not rely on the ``SECRET_KEY`` without needing to
+  provide a value. As a consequence of this, calling
+  :func:`~django.conf.settings.configure` without providing a valid
+  ``SECRET_KEY``, and then going on to access ``settings.SECRET_KEY`` will now
+  raise an :exc:`~django.core.exceptions.ImproperlyConfigured` exception.
+
+* The new ``Signer.sign_object()`` and ``Signer.unsign_object()`` methods allow
+  signing complex data structures. See :ref:`signing-complex-data` for more
+  details.
+
+  Also, :func:`signing.dumps() <django.core.signing.dumps>` and
+  :func:`~django.core.signing.loads` become shortcuts for
+  :meth:`.TimestampSigner.sign_object` and
+  :meth:`~.TimestampSigner.unsign_object`.
+
+Serialization
+~~~~~~~~~~~~~
+
+* The new :ref:`JSONL <serialization-formats-jsonl>` serializer allows using
+  the JSON Lines format with :djadmin:`dumpdata` and :djadmin:`loaddata`. This
+  can be useful for populating large databases because data is loaded line by
+  line into memory, rather than being loaded all at once.
+
+Signals
+~~~~~~~
+
+* :meth:`Signal.send_robust() <django.dispatch.Signal.send_robust>` now logs
+  exceptions.
+
+Templates
+~~~~~~~~~
+
+* :tfilter:`floatformat` template filter now allows using the ``g`` suffix to
+  force grouping by the :setting:`THOUSAND_SEPARATOR` for the active locale.
+
+* Templates cached with :ref:`Cached template loaders<template-loaders>` are
+  now correctly reloaded in development.
+
+Tests
+~~~~~
+
+* Objects assigned to class attributes in :meth:`.TestCase.setUpTestData` are
+  now isolated for each test method. Such objects are now required to support
+  creating deep copies with :py:func:`copy.deepcopy`. Assigning objects which
+  don't support ``deepcopy()`` is deprecated and will be removed in Django 4.1.
+
+* :class:`~django.test.runner.DiscoverRunner` now enables
+  :py:mod:`faulthandler` by default. This can be disabled by using the
+  :option:`test --no-faulthandler` option.
+
+* :class:`~django.test.runner.DiscoverRunner` and the
+  :djadmin:`test` management command can now track timings, including database
+  setup and total run time. This can be enabled by using the :option:`test
+  --timing` option.
+
+* :class:`~django.test.Client` now preserves the request query string when
+  following 307 and 308 redirects.
+
+* The new :meth:`.TestCase.captureOnCommitCallbacks` method captures callback
+  functions passed to :func:`transaction.on_commit()
+  <django.db.transaction.on_commit>` in a list. This allows you to test such
+  callbacks without using the slower :class:`.TransactionTestCase`.
+
+* :meth:`TransactionTestCase.assertQuerysetEqual()
+  <django.test.TransactionTestCase.assertQuerySetEqual>` now supports direct
+  comparison against another queryset rather than being restricted to
+  comparison against a list of string representations of objects when using the
+  default value for the ``transform`` argument.
+
+Utilities
+~~~~~~~~~
+
+* The new ``depth`` parameter of ``django.utils.timesince.timesince()`` and
+  ``django.utils.timesince.timeuntil()`` functions allows specifying the number
+  of adjacent time units to return.
+
+Validators
+~~~~~~~~~~
+
+* Built-in validators now include the provided value in the ``params`` argument
+  of a raised :exc:`~django.core.exceptions.ValidationError`. This allows
+  custom error messages to use the ``%(value)s`` placeholder.
+
+* The :class:`.ValidationError` equality operator now ignores ``messages`` and
+  ``params`` ordering.
+
+.. _backwards-incompatible-3.2:
+
+Backwards incompatible changes in 3.2
+=====================================
+
+Database backend API
+--------------------
+
+This section describes changes that may be needed in third-party database
+backends.
+
+* The new ``DatabaseFeatures.introspected_field_types`` property replaces these
+  features:
+
+  * ``can_introspect_autofield``
+  * ``can_introspect_big_integer_field``
+  * ``can_introspect_binary_field``
+  * ``can_introspect_decimal_field``
+  * ``can_introspect_duration_field``
+  * ``can_introspect_ip_address_field``
+  * ``can_introspect_positive_integer_field``
+  * ``can_introspect_small_integer_field``
+  * ``can_introspect_time_field``
+  * ``introspected_big_auto_field_type``
+  * ``introspected_small_auto_field_type``
+  * ``introspected_boolean_field_type``
+
+* To enable support for covering indexes (:attr:`.Index.include`) and covering
+  unique constraints (:attr:`.UniqueConstraint.include`), set
+  ``DatabaseFeatures.supports_covering_indexes`` to ``True``.
+
+* Third-party database backends must implement support for column database
+  collations on ``CharField``\s and ``TextField``\s or set
+  ``DatabaseFeatures.supports_collation_on_charfield`` and
+  ``DatabaseFeatures.supports_collation_on_textfield`` to ``False``. If
+  non-deterministic collations are not supported, set
+  ``supports_non_deterministic_collations`` to ``False``.
+
+* ``DatabaseOperations.random_function_sql()`` is removed in favor of the new
+  :class:`~django.db.models.functions.Random` database function.
+
+* ``DatabaseOperations.date_trunc_sql()`` and
+  ``DatabaseOperations.time_trunc_sql()`` now take the optional ``tzname``
+  argument in order to truncate in a specific timezone.
+
+* ``DatabaseClient.runshell()`` now gets arguments and an optional dictionary
+  with environment variables to the underlying command-line client from
+  ``DatabaseClient.settings_to_cmd_args_env()`` method. Third-party database
+  backends must implement ``DatabaseClient.settings_to_cmd_args_env()`` or
+  override ``DatabaseClient.runshell()``.
+
+* Third-party database backends must implement support for functional indexes
+  (:attr:`.Index.expressions`) or set
+  ``DatabaseFeatures.supports_expression_indexes`` to ``False``. If ``COLLATE``
+  is not a part of the ``CREATE INDEX`` statement, set
+  ``DatabaseFeatures.collate_as_index_expression`` to ``True``.
+
+:mod:`django.contrib.admin`
+---------------------------
+
+* Pagination links in the admin are now 1-indexed instead of 0-indexed, i.e.
+  the query string for the first page is ``?p=1`` instead of ``?p=0``.
+
+* The new admin catch-all view will break URL patterns routed after the admin
+  URLs and matching the admin URL prefix. You can either adjust your URL
+  ordering or, if necessary, set :attr:`AdminSite.final_catch_all_view
+  <django.contrib.admin.AdminSite.final_catch_all_view>` to ``False``,
+  disabling the catch-all view. See :ref:`whats-new-3.2` for more details.
+
+* Minified JavaScript files are no longer included with the admin. If you
+  require these files to be minified, consider using a third party app or
+  external build tool. The minified vendored JavaScript files packaged with the
+  admin (e.g. :ref:`jquery.min.js <contrib-admin-jquery>`) are still included.
+
+* :attr:`.ModelAdmin.prepopulated_fields` no longer strips English stop words,
+  such as ``'a'`` or ``'an'``.
+
+:mod:`django.contrib.gis`
+-------------------------
+
+* Support for PostGIS 2.2 is removed.
+
+* The Oracle backend now clones polygons (and geometry collections containing
+  polygons) before reorienting them and saving them to the database. They are
+  no longer mutated in place. You might notice this if you use the polygons
+  after a model is saved.
+
+Dropped support for PostgreSQL 9.5
+----------------------------------
+
+Upstream support for PostgreSQL 9.5 ends in February 2021. Django 3.2 supports
+PostgreSQL 9.6 and higher.
+
+Dropped support for MySQL 5.6
+-----------------------------
+
+The end of upstream support for MySQL 5.6 is April 2021. Django 3.2 supports
+MySQL 5.7 and higher.
+
+Miscellaneous
+-------------
+
+* Django now supports non-``pytz`` time zones, such as Python 3.9+'s
+  :mod:`zoneinfo` module and its backport.
+
+* The undocumented ``SpatiaLiteOperations.proj4_version()`` method is renamed
+  to ``proj_version()``.
+
+* :func:`~django.utils.text.slugify` now removes leading and trailing dashes
+  and underscores.
+
+* The :tfilter:`intcomma` and :tfilter:`intword` template filters no longer
+  depend on the ``USE_L10N`` setting.
+
+* Support for ``argon2-cffi`` < 19.1.0 is removed.
+
+* The cache keys no longer includes the language when internationalization is
+  disabled (``USE_I18N = False``) and localization is enabled
+  (``USE_L10N = True``). After upgrading to Django 3.2 in such configurations,
+  the first request to any previously cached value will be a cache miss.
+
+* ``ForeignKey.validate()`` now uses
+  :attr:`~django.db.models.Model._base_manager` rather than
+  :attr:`~django.db.models.Model._default_manager` to check that related
+  instances exist.
+
+* When an application defines an :class:`~django.apps.AppConfig` subclass in
+  an ``apps.py`` submodule, Django now uses this configuration automatically,
+  even if it isn't enabled with ``default_app_config``. Set ``default = False``
+  in the :class:`~django.apps.AppConfig` subclass if you need to prevent this
+  behavior. See :ref:`whats-new-3.2` for more details.
+
+* Instantiating an abstract model now raises ``TypeError``.
+
+* Keyword arguments to :func:`~django.test.utils.setup_databases` are now
+  keyword-only.
+
+* The undocumented ``django.utils.http.limited_parse_qsl()`` function is
+  removed. Please use :func:`urllib.parse.parse_qsl` instead.
+
+* ``django.test.utils.TestContextDecorator`` now uses
+  :py:meth:`~unittest.TestCase.addCleanup` so that cleanups registered in the
+  :py:meth:`~unittest.TestCase.setUp` method are called before
+  ``TestContextDecorator.disable()``.
+
+* ``SessionMiddleware`` now raises a
+  :exc:`~django.contrib.sessions.exceptions.SessionInterrupted` exception
+  instead of :exc:`~django.core.exceptions.SuspiciousOperation` when a session
+  is destroyed in a concurrent request.
+
+* The :class:`django.db.models.Field` equality operator now correctly
+  distinguishes inherited field instances across models. Additionally, the
+  ordering of such fields is now defined.
+
+* The undocumented ``django.core.files.locks.lock()`` function now returns
+  ``False`` if the file cannot be locked, instead of raising
+  :exc:`BlockingIOError`.
+
+* The password reset mechanism now invalidates tokens when the user email is
+  changed.
+
+* :djadmin:`makemessages` command no longer processes invalid locales specified
+  using :option:`makemessages --locale` option, when they contain hyphens
+  (``'-'``).
+
+* The ``django.contrib.auth.forms.ReadOnlyPasswordHashField`` form field is now
+  :attr:`~django.forms.Field.disabled` by default. Therefore
+  ``UserChangeForm.clean_password()`` is no longer required to return the
+  initial value.
+
+* The ``cache.get_many()``, ``get_or_set()``, ``has_key()``, ``incr()``,
+  ``decr()``, ``incr_version()``, and ``decr_version()`` cache operations now
+  correctly handle ``None`` stored in the cache, in the same way as any other
+  value, instead of behaving as though the key didn't exist.
+
+  Due to a ``python-memcached`` limitation, the previous behavior is kept for
+  the deprecated ``MemcachedCache`` backend.
+
+* The minimum supported version of SQLite is increased from 3.8.3 to 3.9.0.
+
+* :class:`~django.contrib.messages.storage.cookie.CookieStorage` now stores
+  messages in the :rfc:`6265` compliant format. Support for cookies that use
+  the old format remains until Django 4.1.
+
+* The minimum supported version of ``asgiref`` is increased from 3.2.10 to
+  3.3.2.
+
+.. _deprecated-features-3.2:
+
+Features deprecated in 3.2
+==========================
+
+Miscellaneous
+-------------
+
+* Assigning objects which don't support creating deep copies with
+  :py:func:`copy.deepcopy` to class attributes in
+  :meth:`.TestCase.setUpTestData` is deprecated.
+
+* Using a boolean value in :attr:`.BaseCommand.requires_system_checks` is
+  deprecated. Use ``'__all__'`` instead of ``True``, and ``[]`` (an empty list)
+  instead of ``False``.
+
+* The ``whitelist`` argument and ``domain_whitelist`` attribute of
+  :class:`~django.core.validators.EmailValidator` are deprecated. Use
+  ``allowlist`` instead of ``whitelist``, and ``domain_allowlist`` instead of
+  ``domain_whitelist``. You may need to rename ``whitelist`` in existing
+  migrations.
+
+* The ``default_app_config`` application configuration variable is deprecated,
+  due to the now automatic ``AppConfig`` discovery. See :ref:`whats-new-3.2`
+  for more details.
+
+* Automatically calling ``repr()`` on a queryset in
+  ``TransactionTestCase.assertQuerysetEqual()``, when compared to string
+  values, is deprecated. If you need the previous behavior, explicitly set
+  ``transform`` to ``repr``.
+
+* The ``django.core.cache.backends.memcached.MemcachedCache`` backend is
+  deprecated as ``python-memcached`` has some problems and seems to be
+  unmaintained. Use ``django.core.cache.backends.memcached.PyMemcacheCache``
+  or ``django.core.cache.backends.memcached.PyLibMCCache`` instead.
+
+* The format of messages used by
+  ``django.contrib.messages.storage.cookie.CookieStorage`` is different from
+  the format generated by older versions of Django. Support for the old format
+  remains until Django 4.1.

testbed/django__django/docs/releases/4.0.txt

@@ -0,0 +1,773 @@
+========================
+Django 4.0 release notes
+========================
+
+*December 7, 2021*
+
+Welcome to Django 4.0!
+
+These release notes cover the :ref:`new features <whats-new-4.0>`, as well as
+some :ref:`backwards incompatible changes <backwards-incompatible-4.0>` you'll
+want to be aware of when upgrading from Django 3.2 or earlier. We've
+:ref:`begun the deprecation process for some features
+<deprecated-features-4.0>`.
+
+See the :doc:`/howto/upgrade-version` guide if you're updating an existing
+project.
+
+Python compatibility
+====================
+
+Django 4.0 supports Python 3.8, 3.9, and 3.10. We **highly recommend** and only
+officially support the latest release of each series.
+
+The Django 3.2.x series is the last to support Python 3.6 and 3.7.
+
+.. _whats-new-4.0:
+
+What's new in Django 4.0
+========================
+
+``zoneinfo`` default timezone implementation
+--------------------------------------------
+
+The Python standard library's :mod:`zoneinfo` is now the default timezone
+implementation in Django.
+
+This is the next step in the migration from using ``pytz`` to using
+:mod:`zoneinfo`. Django 3.2 allowed the use of non-``pytz`` time zones. Django
+4.0 makes ``zoneinfo`` the default implementation. Support for ``pytz`` is now
+deprecated and will be removed in Django 5.0.
+
+:mod:`zoneinfo` is part of the Python standard library from Python 3.9. The
+``backports.zoneinfo`` package is automatically installed alongside Django if
+you are using Python 3.8.
+
+The move to ``zoneinfo`` should be largely transparent. Selection of the
+current timezone, conversion of datetime instances to the current timezone in
+forms and templates, as well as operations on aware datetimes in UTC are
+unaffected.
+
+However, if you are working with non-UTC time zones, and using the ``pytz``
+``normalize()`` and ``localize()`` APIs, possibly with the :setting:`TIME_ZONE
+<DATABASE-TIME_ZONE>` setting, you will need to audit your code, since ``pytz``
+and ``zoneinfo`` are not entirely equivalent.
+
+To give time for such an audit, the transitional ``USE_DEPRECATED_PYTZ``
+setting allows continued use of ``pytz`` during the 4.x release cycle. This
+setting will be removed in Django 5.0.
+
+In addition, a `pytz_deprecation_shim`_ package, created by the ``zoneinfo``
+author, can be used to assist with the migration from ``pytz``. This package
+provides shims to help you safely remove ``pytz``, and has a detailed
+`migration guide`_ showing how to move to the new ``zoneinfo`` APIs.
+
+Using `pytz_deprecation_shim`_ and the ``USE_DEPRECATED_PYTZ``
+transitional setting is recommended if you need a gradual update path.
+
+.. _pytz_deprecation_shim: https://pytz-deprecation-shim.readthedocs.io/en/latest/index.html
+.. _migration guide: https://pytz-deprecation-shim.readthedocs.io/en/latest/migration.html
+
+Functional unique constraints
+-----------------------------
+
+The new :attr:`*expressions <django.db.models.UniqueConstraint.expressions>`
+positional argument of
+:class:`UniqueConstraint() <django.db.models.UniqueConstraint>` enables
+creating functional unique constraints on expressions and database functions.
+For example::
+
+    from django.db import models
+    from django.db.models import UniqueConstraint
+    from django.db.models.functions import Lower
+
+
+    class MyModel(models.Model):
+        first_name = models.CharField(max_length=255)
+        last_name = models.CharField(max_length=255)
+
+        class Meta:
+            constraints = [
+                UniqueConstraint(
+                    Lower("first_name"),
+                    Lower("last_name").desc(),
+                    name="first_last_name_unique",
+                ),
+            ]
+
+Functional unique constraints are added to models using the
+:attr:`Meta.constraints <django.db.models.Options.constraints>` option.
+
+``scrypt`` password hasher
+--------------------------
+
+The new :ref:`scrypt password hasher <scrypt-usage>` is more secure and
+recommended over PBKDF2. However, it's not the default as it requires OpenSSL
+1.1+ and more memory.
+
+Redis cache backend
+-------------------
+
+The new ``django.core.cache.backends.redis.RedisCache`` cache backend provides
+built-in support for caching with Redis. :pypi:`redis-py <redis>` 3.0.0 or
+higher is required. For more details, see the :ref:`documentation on caching
+with Redis in Django <redis>`.
+
+Template based form rendering
+-----------------------------
+
+:class:`Forms <django.forms.Form>`, :doc:`Formsets </topics/forms/formsets>`,
+and :class:`~django.forms.ErrorList` are now rendered using the template engine
+to enhance customization. See the new :meth:`~django.forms.Form.render`,
+:meth:`~django.forms.Form.get_context`, and
+:attr:`~django.forms.Form.template_name` for ``Form`` and
+:ref:`formset rendering <formset-rendering>` for ``Formset``.
+
+Minor features
+--------------
+
+:mod:`django.contrib.admin`
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+* The ``admin/base.html`` template now has a new block ``header`` which
+  contains the admin site header.
+
+* The new :meth:`.ModelAdmin.get_formset_kwargs` method allows customizing the
+  keyword arguments passed to the constructor of a formset.
+
+* The navigation sidebar now has a quick filter toolbar.
+
+* The new context variable ``model`` which contains the model class for each
+  model is added to the :meth:`.AdminSite.each_context` method.
+
+* The new :attr:`.ModelAdmin.search_help_text` attribute allows specifying a
+  descriptive text for the search box.
+
+* The :attr:`.InlineModelAdmin.verbose_name_plural` attribute now fallbacks to
+  the :attr:`.InlineModelAdmin.verbose_name` + ``'s'``.
+
+* jQuery is upgraded from version 3.5.1 to 3.6.0.
+
+:mod:`django.contrib.admindocs`
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+* The admindocs now allows esoteric setups where :setting:`ROOT_URLCONF` is not
+  a string.
+
+* The model section of the ``admindocs`` now shows cached properties.
+
+:mod:`django.contrib.auth`
+~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+* The default iteration count for the PBKDF2 password hasher is increased from
+  260,000 to 320,000.
+
+* The new
+  :attr:`LoginView.next_page <django.contrib.auth.views.LoginView.next_page>`
+  attribute and
+  :meth:`~django.contrib.auth.views.LoginView.get_default_redirect_url` method
+  allow customizing the redirect after login.
+
+:mod:`django.contrib.gis`
+~~~~~~~~~~~~~~~~~~~~~~~~~
+
+* Added support for SpatiaLite 5.
+
+* :class:`~django.contrib.gis.gdal.GDALRaster` now allows creating rasters in
+  any GDAL virtual filesystem.
+
+* The new :class:`~django.contrib.gis.admin.GISModelAdmin` class allows
+  customizing the widget used for ``GeometryField``. This is encouraged instead
+  of deprecated ``GeoModelAdmin`` and ``OSMGeoAdmin``.
+
+:mod:`django.contrib.postgres`
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+* The PostgreSQL backend now supports connecting by a service name. See
+  :ref:`postgresql-connection-settings` for more details.
+
+* The new :class:`~django.contrib.postgres.operations.AddConstraintNotValid`
+  operation allows creating check constraints on PostgreSQL without verifying
+  that all existing rows satisfy the new constraint.
+
+* The new :class:`~django.contrib.postgres.operations.ValidateConstraint`
+  operation allows validating check constraints which were created using
+  :class:`~django.contrib.postgres.operations.AddConstraintNotValid` on
+  PostgreSQL.
+
+* The new
+  :class:`ArraySubquery() <django.contrib.postgres.expressions.ArraySubquery>`
+  expression allows using subqueries to construct lists of values on
+  PostgreSQL.
+
+* The new :lookup:`trigram_word_similar` lookup, and the
+  :class:`TrigramWordDistance()
+  <django.contrib.postgres.search.TrigramWordDistance>` and
+  :class:`TrigramWordSimilarity()
+  <django.contrib.postgres.search.TrigramWordSimilarity>` expressions allow
+  using trigram word similarity.
+
+:mod:`django.contrib.staticfiles`
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+* :class:`~django.contrib.staticfiles.storage.ManifestStaticFilesStorage` now
+  replaces paths to JavaScript source map references with their hashed
+  counterparts.
+
+* The new ``manifest_storage`` argument of
+  :class:`~django.contrib.staticfiles.storage.ManifestFilesMixin` and
+  :class:`~django.contrib.staticfiles.storage.ManifestStaticFilesStorage`
+  allows customizing the manifest file storage.
+
+Cache
+~~~~~
+
+* The new async API for ``django.core.cache.backends.base.BaseCache`` begins
+  the process of making cache backends async-compatible. The new async methods
+  all have ``a`` prefixed names, e.g. ``aadd()``, ``aget()``, ``aset()``,
+  ``aget_or_set()``, or ``adelete_many()``.
+
+  Going forward, the ``a`` prefix will be used for async variants of methods
+  generally.
+
+CSRF
+~~~~
+
+* CSRF protection now consults the ``Origin`` header, if present. To facilitate
+  this, :ref:`some changes <csrf-trusted-origins-changes-4.0>` to the
+  :setting:`CSRF_TRUSTED_ORIGINS` setting are required.
+
+Forms
+~~~~~
+
+* :class:`~django.forms.ModelChoiceField` now includes the provided value in
+  the ``params`` argument of a raised
+  :exc:`~django.core.exceptions.ValidationError` for the ``invalid_choice``
+  error message. This allows custom error messages to use the ``%(value)s``
+  placeholder.
+
+* :class:`~django.forms.formsets.BaseFormSet` now renders non-form errors with
+  an additional class of ``nonform`` to help distinguish them from
+  form-specific errors.
+
+* :class:`~django.forms.formsets.BaseFormSet` now allows customizing the widget
+  used when deleting forms via
+  :attr:`~django.forms.formsets.BaseFormSet.can_delete` by setting the
+  :attr:`~django.forms.formsets.BaseFormSet.deletion_widget` attribute or
+  overriding :meth:`~django.forms.formsets.BaseFormSet.get_deletion_widget`
+  method.
+
+Internationalization
+~~~~~~~~~~~~~~~~~~~~
+
+* Added support and translations for the Malay language.
+
+Generic Views
+~~~~~~~~~~~~~
+
+* :class:`~django.views.generic.edit.DeleteView` now uses
+  :class:`~django.views.generic.edit.FormMixin`, allowing you to provide a
+  :class:`~django.forms.Form` subclass, with a checkbox for example, to confirm
+  deletion. In addition, this allows ``DeleteView`` to function with
+  :class:`django.contrib.messages.views.SuccessMessageMixin`.
+
+  In accordance with ``FormMixin``, object deletion for POST requests is
+  handled in ``form_valid()``. Custom delete logic in ``delete()`` handlers
+  should be moved to ``form_valid()``, or a shared helper method, as needed.
+
+Logging
+~~~~~~~
+
+* The alias of the database used in an SQL call is now passed as extra context
+  along with each message to the :ref:`django-db-logger` logger.
+
+Management Commands
+~~~~~~~~~~~~~~~~~~~
+
+* The :djadmin:`runserver` management command now supports the
+  :option:`--skip-checks` option.
+
+* On PostgreSQL, :djadmin:`dbshell` now supports specifying a password file.
+
+* The :djadmin:`shell` command now respects :py:data:`sys.__interactivehook__`
+  at startup. This allows loading shell history between interactive sessions.
+  As a consequence, ``readline`` is no longer loaded if running in *isolated*
+  mode.
+
+* The new :attr:`BaseCommand.suppressed_base_arguments
+  <django.core.management.BaseCommand.suppressed_base_arguments>` attribute
+  allows suppressing unsupported default command options in the help output.
+
+* The new :option:`startapp --exclude` and :option:`startproject --exclude`
+  options allow excluding directories from the template.
+
+Models
+~~~~~~
+
+* New :meth:`QuerySet.contains(obj) <.QuerySet.contains>` method returns
+  whether the queryset contains the given object. This tries to perform the
+  query in the simplest and fastest way possible.
+
+* The new ``precision`` argument of the
+  :class:`Round() <django.db.models.functions.Round>` database function allows
+  specifying the number of decimal places after rounding.
+
+* :meth:`.QuerySet.bulk_create` now sets the primary key on objects when using
+  SQLite 3.35+.
+
+* :class:`~django.db.models.DurationField` now supports multiplying and
+  dividing by scalar values on SQLite.
+
+* :meth:`.QuerySet.bulk_update` now returns the number of objects updated.
+
+* The new :attr:`.Expression.empty_result_set_value` attribute allows
+  specifying a value to return when the function is used over an empty result
+  set.
+
+* The ``skip_locked`` argument of :meth:`.QuerySet.select_for_update()` is now
+  allowed on MariaDB 10.6+.
+
+* :class:`~django.db.models.Lookup` expressions may now be used in ``QuerySet``
+  annotations, aggregations, and directly in filters.
+
+* The new :ref:`default <aggregate-default>` argument for built-in aggregates
+  allows specifying a value to be returned when the queryset (or grouping)
+  contains no entries, rather than ``None``.
+
+Requests and Responses
+~~~~~~~~~~~~~~~~~~~~~~
+
+* The :class:`~django.middleware.security.SecurityMiddleware` now adds the
+  :ref:`Cross-Origin Opener Policy <cross-origin-opener-policy>` header with a
+  value of ``'same-origin'`` to prevent cross-origin popups from sharing the
+  same browsing context. You can prevent this header from being added by
+  setting the :setting:`SECURE_CROSS_ORIGIN_OPENER_POLICY` setting to ``None``.
+
+Signals
+~~~~~~~
+
+* The new ``stdout`` argument for :func:`~django.db.models.signals.pre_migrate`
+  and :func:`~django.db.models.signals.post_migrate` signals allows redirecting
+  output to a stream-like object. It should be preferred over
+  :py:data:`sys.stdout` and :py:func:`print` when emitting verbose output in
+  order to allow proper capture when testing.
+
+Templates
+~~~~~~~~~
+
+* :tfilter:`floatformat` template filter now allows using the ``u`` suffix to
+  force disabling localization.
+
+Tests
+~~~~~
+
+* The new ``serialized_aliases`` argument of
+  :func:`django.test.utils.setup_databases` determines which
+  :setting:`DATABASES` aliases test databases should have their state
+  serialized to allow usage of the
+  :ref:`serialized_rollback <test-case-serialized-rollback>` feature.
+
+* Django test runner now supports a :option:`--buffer <test --buffer>` option
+  with parallel tests.
+
+* The new ``logger`` argument to :class:`~django.test.runner.DiscoverRunner`
+  allows a Python :py:ref:`logger <logger>` to be used for logging.
+
+* The new :meth:`.DiscoverRunner.log` method provides a way to log messages
+  that uses the ``DiscoverRunner.logger``, or prints to the console if not set.
+
+* Django test runner now supports a :option:`--shuffle <test --shuffle>` option
+  to execute tests in a random order.
+
+* The :option:`test --parallel` option now supports the value ``auto`` to run
+  one test process for each processor core.
+
+* :meth:`.TestCase.captureOnCommitCallbacks` now captures new callbacks added
+  while executing :func:`.transaction.on_commit` callbacks.
+
+.. _backwards-incompatible-4.0:
+
+Backwards incompatible changes in 4.0
+=====================================
+
+Database backend API
+--------------------
+
+This section describes changes that may be needed in third-party database
+backends.
+
+* ``DatabaseOperations.year_lookup_bounds_for_date_field()`` and
+  ``year_lookup_bounds_for_datetime_field()`` methods now take the optional
+  ``iso_year`` argument in order to support bounds for ISO-8601 week-numbering
+  years.
+
+* The second argument of ``DatabaseSchemaEditor._unique_sql()`` and
+  ``_create_unique_sql()`` methods is now ``fields`` instead of ``columns``.
+
+:mod:`django.contrib.gis`
+-------------------------
+
+* Support for PostGIS 2.3 is removed.
+
+* Support for GDAL 2.0 and GEOS 3.5 is removed.
+
+Dropped support for PostgreSQL 9.6
+----------------------------------
+
+Upstream support for PostgreSQL 9.6 ends in November 2021. Django 4.0 supports
+PostgreSQL 10 and higher.
+
+Also, the minimum supported version of ``psycopg2`` is increased from 2.5.4 to
+2.8.4, as ``psycopg2`` 2.8.4 is the first release to support Python 3.8.
+
+Dropped support for Oracle 12.2 and 18c
+---------------------------------------
+
+Upstream support for Oracle 12.2 ends in March 2022 and for Oracle 18c it ends
+in June 2021. Django 3.2 will be supported until April 2024. Django 4.0
+officially supports Oracle 19c.
+
+.. _csrf-trusted-origins-changes-4.0:
+
+``CSRF_TRUSTED_ORIGINS`` changes
+--------------------------------
+
+Format change
+~~~~~~~~~~~~~
+
+Values in the :setting:`CSRF_TRUSTED_ORIGINS` setting must include the scheme
+(e.g. ``'http://'`` or ``'https://'``) instead of only the hostname.
+
+Also, values that started with a dot, must now also include an asterisk before
+the dot. For example, change ``'.example.com'`` to ``'https://*.example.com'``.
+
+A system check detects any required changes.
+
+Configuring it may now be required
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+As CSRF protection now consults the ``Origin`` header, you may need to set
+:setting:`CSRF_TRUSTED_ORIGINS`, particularly if you allow requests from
+subdomains by setting :setting:`CSRF_COOKIE_DOMAIN` (or
+:setting:`SESSION_COOKIE_DOMAIN` if :setting:`CSRF_USE_SESSIONS` is enabled) to
+a value starting with a dot.
+
+``SecurityMiddleware`` no longer sets the ``X-XSS-Protection`` header
+---------------------------------------------------------------------
+
+The :class:`~django.middleware.security.SecurityMiddleware` no longer sets the
+``X-XSS-Protection`` header if the ``SECURE_BROWSER_XSS_FILTER`` setting is
+``True``. The setting is removed.
+
+Most modern browsers don't honor the ``X-XSS-Protection`` HTTP header. You can
+use Content-Security-Policy_ without allowing ``'unsafe-inline'`` scripts
+instead.
+
+If you want to support legacy browsers and set the header, use this line in a
+custom middleware::
+
+    response.headers.setdefault("X-XSS-Protection", "1; mode=block")
+
+.. _Content-Security-Policy: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy
+
+Migrations autodetector changes
+-------------------------------
+
+The migrations autodetector now uses model states instead of model classes.
+Also, migration operations for ``ForeignKey`` and ``ManyToManyField`` fields no
+longer specify attributes which were not passed to the fields during
+initialization.
+
+As a side-effect, running ``makemigrations`` might generate no-op
+``AlterField`` operations for ``ManyToManyField`` and ``ForeignKey`` fields in
+some cases.
+
+``DeleteView`` changes
+----------------------
+
+:class:`~django.views.generic.edit.DeleteView` now uses
+:class:`~django.views.generic.edit.FormMixin` to handle POST requests. As a
+consequence, any custom deletion logic in ``delete()`` handlers should be
+moved to ``form_valid()``, or a shared helper method, if required.
+
+Table and column naming scheme changes on Oracle
+------------------------------------------------
+
+Django 4.0 inadvertently changed the table and column naming scheme on Oracle.
+This causes errors for models and fields with names longer than 30 characters.
+Unfortunately, renaming some Oracle tables and columns is required. Use the
+upgrade script in :ticket:`33789 <33789#comment:15>` to generate ``RENAME``
+statements to change naming scheme.
+
+Miscellaneous
+-------------
+
+* Support for ``cx_Oracle`` < 7.0 is removed.
+
+* To allow serving a Django site on a subpath without changing the value of
+  :setting:`STATIC_URL`, the leading slash is removed from that setting (now
+  ``'static/'``) in the default :djadmin:`startproject` template.
+
+* The :class:`~django.contrib.admin.AdminSite` method for the admin ``index``
+  view is no longer decorated with ``never_cache`` when accessed directly,
+  rather than via the recommended ``AdminSite.urls`` property, or
+  ``AdminSite.get_urls()`` method.
+
+* Unsupported operations on a sliced queryset now raise ``TypeError`` instead
+  of ``AssertionError``.
+
+* The undocumented ``django.test.runner.reorder_suite()`` function is renamed
+  to ``reorder_tests()``. It now accepts an iterable of tests rather than a
+  test suite, and returns an iterator of tests.
+
+* Calling ``FileSystemStorage.delete()`` with an empty ``name`` now raises
+  ``ValueError`` instead of ``AssertionError``.
+
+* Calling ``EmailMultiAlternatives.attach_alternative()`` or
+  ``EmailMessage.attach()`` with an invalid ``content`` or ``mimetype``
+  arguments now raise ``ValueError`` instead of ``AssertionError``.
+
+* :meth:`~django.test.SimpleTestCase.assertHTMLEqual` no longer considers a
+  non-boolean attribute without a value equal to an attribute with the same
+  name and value.
+
+* Tests that fail to load, for example due to syntax errors, now always match
+  when using :option:`test --tag`.
+
+* The undocumented ``django.contrib.admin.utils.lookup_needs_distinct()``
+  function is renamed to ``lookup_spawns_duplicates()``.
+
+* The undocumented ``HttpRequest.get_raw_uri()`` method is removed. The
+  :meth:`.HttpRequest.build_absolute_uri` method may be a suitable alternative.
+
+* The ``object`` argument of undocumented ``ModelAdmin.log_addition()``,
+  ``log_change()``, and ``log_deletion()`` methods is renamed to ``obj``.
+
+* :class:`~django.utils.feedgenerator.RssFeed`,
+  :class:`~django.utils.feedgenerator.Atom1Feed`, and their subclasses now emit
+  elements with no content as self-closing tags.
+
+* ``NodeList.render()`` no longer casts the output of ``render()`` method for
+  individual nodes to a string. ``Node.render()`` should always return a string
+  as documented.
+
+* The ``where_class`` property of ``django.db.models.sql.query.Query`` and the
+  ``where_class`` argument to the private ``get_extra_restriction()`` method of
+  ``ForeignObject`` and ``ForeignObjectRel`` are removed. If needed, initialize
+  ``django.db.models.sql.where.WhereNode`` instead.
+
+* The ``filter_clause`` argument of the undocumented ``Query.add_filter()``
+  method is replaced by two positional arguments ``filter_lhs`` and
+  ``filter_rhs``.
+
+* :class:`~django.middleware.csrf.CsrfViewMiddleware` now uses
+  ``request.META['CSRF_COOKIE_NEEDS_UPDATE']`` in place of
+  ``request.META['CSRF_COOKIE_USED']``, ``request.csrf_cookie_needs_reset``,
+  and ``response.csrf_cookie_set`` to track whether the CSRF cookie should be
+  sent. This is an undocumented, private API.
+
+* The undocumented ``TRANSLATOR_COMMENT_MARK`` constant is moved from
+  ``django.template.base`` to ``django.utils.translation.template``.
+
+* The ``real_apps`` argument of the undocumented
+  ``django.db.migrations.state.ProjectState.__init__()`` method must now be a
+  set if provided.
+
+* :class:`~django.forms.RadioSelect` and
+  :class:`~django.forms.CheckboxSelectMultiple` widgets are now rendered in
+  ``<div>`` tags so they are announced more concisely by screen readers. If you
+  need the previous behavior, :ref:`override the widget template
+  <overriding-built-in-widget-templates>` with the appropriate template from
+  Django 3.2.
+
+* The :tfilter:`floatformat` template filter no longer depends on the
+  ``USE_L10N`` setting and always returns localized output. Use the ``u``
+  suffix to disable localization.
+
+* The default value of the ``USE_L10N`` setting is changed to ``True``. See the
+  :ref:`Localization section <use_l10n_deprecation>` above for more details.
+
+* As part of the :ref:`move to zoneinfo <whats-new-4.0>`,
+  ``django.utils.timezone.utc`` is changed to alias
+  :attr:`datetime.timezone.utc`.
+
+* The minimum supported version of ``asgiref`` is increased from 3.3.2 to
+  3.4.1.
+
+.. _deprecated-features-4.0:
+
+Features deprecated in 4.0
+==========================
+
+Use of ``pytz`` time zones
+--------------------------
+
+As part of the :ref:`move to zoneinfo <whats-new-4.0>`, use of ``pytz`` time
+zones is deprecated.
+
+Accordingly, the ``is_dst`` arguments to the following are also deprecated:
+
+* :meth:`django.db.models.query.QuerySet.datetimes`
+* :func:`django.db.models.functions.Trunc`
+* :func:`django.db.models.functions.TruncSecond`
+* :func:`django.db.models.functions.TruncMinute`
+* :func:`django.db.models.functions.TruncHour`
+* :func:`django.db.models.functions.TruncDay`
+* :func:`django.db.models.functions.TruncWeek`
+* :func:`django.db.models.functions.TruncMonth`
+* :func:`django.db.models.functions.TruncQuarter`
+* :func:`django.db.models.functions.TruncYear`
+* :func:`django.utils.timezone.make_aware`
+
+Support for use of ``pytz`` will be removed in Django 5.0.
+
+Time zone support
+-----------------
+
+In order to follow good practice, the default value of the :setting:`USE_TZ`
+setting will change from ``False`` to ``True``, and time zone support will be
+enabled by default, in Django 5.0.
+
+Note that the default :file:`settings.py` file created by
+:djadmin:`django-admin startproject <startproject>` includes
+:setting:`USE_TZ = True <USE_TZ>` since Django 1.4.
+
+You can set ``USE_TZ`` to ``False`` in your project settings before then to
+opt-out.
+
+.. _use_l10n_deprecation:
+
+Localization
+------------
+
+In order to follow good practice, the default value of the ``USE_L10N`` setting
+is changed from ``False`` to ``True``.
+
+Moreover ``USE_L10N`` is deprecated as of this release. Starting with Django
+5.0, by default, any date or number displayed by Django will be localized.
+
+The :ttag:`{% localize %} <localize>` tag and the :tfilter:`localize`/
+:tfilter:`unlocalize` filters will still be honored by Django.
+
+Miscellaneous
+-------------
+
+* ``SERIALIZE`` test setting is deprecated as it can be inferred from the
+  :attr:`~django.test.TestCase.databases` with the
+  :ref:`serialized_rollback <test-case-serialized-rollback>` option enabled.
+
+* The undocumented ``django.utils.baseconv`` module is deprecated.
+
+* The undocumented ``django.utils.datetime_safe`` module is deprecated.
+
+* The default sitemap protocol for sitemaps built outside the context of a
+  request will change from ``'http'`` to ``'https'`` in Django 5.0.
+
+* The ``extra_tests`` argument for :meth:`.DiscoverRunner.build_suite` and
+  :meth:`.DiscoverRunner.run_tests` is deprecated.
+
+* The :class:`~django.contrib.postgres.aggregates.ArrayAgg`,
+  :class:`~django.contrib.postgres.aggregates.JSONBAgg`, and
+  :class:`~django.contrib.postgres.aggregates.StringAgg` aggregates will return
+  ``None`` when there are no rows instead of ``[]``, ``[]``, and ``''``
+  respectively in Django 5.0. If you need the previous behavior, explicitly set
+  ``default`` to ``Value([])``, ``Value('[]')``, or ``Value('')``.
+
+* The ``django.contrib.gis.admin.GeoModelAdmin`` and ``OSMGeoAdmin`` classes
+  are deprecated. Use :class:`~django.contrib.admin.ModelAdmin` and
+  :class:`~django.contrib.gis.admin.GISModelAdmin` instead.
+
+* Since form rendering now uses the template engine, the undocumented
+  ``BaseForm._html_output()`` helper method is deprecated.
+
+* The ability to return a ``str`` from ``ErrorList`` and ``ErrorDict`` is
+  deprecated. It is expected these methods return a ``SafeString``.
+
+Features removed in 4.0
+=======================
+
+These features have reached the end of their deprecation cycle and are removed
+in Django 4.0.
+
+See :ref:`deprecated-features-3.0` for details on these changes, including how
+to remove usage of these features.
+
+* ``django.utils.http.urlquote()``, ``urlquote_plus()``, ``urlunquote()``, and
+  ``urlunquote_plus()`` are removed.
+
+* ``django.utils.encoding.force_text()`` and ``smart_text()`` are removed.
+
+* ``django.utils.translation.ugettext()``, ``ugettext_lazy()``,
+  ``ugettext_noop()``, ``ungettext()``, and ``ungettext_lazy()`` are removed.
+
+* ``django.views.i18n.set_language()`` doesn't set the user language in
+  ``request.session`` (key ``_language``).
+
+* ``alias=None`` is required in the signature of
+  ``django.db.models.Expression.get_group_by_cols()`` subclasses.
+
+* ``django.utils.text.unescape_entities()`` is removed.
+
+* ``django.utils.http.is_safe_url()`` is removed.
+
+See :ref:`deprecated-features-3.1` for details on these changes, including how
+to remove usage of these features.
+
+* The ``PASSWORD_RESET_TIMEOUT_DAYS`` setting is removed.
+
+* The :lookup:`isnull` lookup no longer allows using non-boolean values as the
+  right-hand side.
+
+* The ``django.db.models.query_utils.InvalidQuery`` exception class is removed.
+
+* The ``django-admin.py`` entry point is removed.
+
+* The ``HttpRequest.is_ajax()`` method is removed.
+
+* Support for the pre-Django 3.1 encoding format of cookies values used by
+  ``django.contrib.messages.storage.cookie.CookieStorage`` is removed.
+
+* Support for the pre-Django 3.1 password reset tokens in the admin site (that
+  use the SHA-1 hashing algorithm) is removed.
+
+* Support for the pre-Django 3.1 encoding format of sessions is removed.
+
+* Support for the pre-Django 3.1 ``django.core.signing.Signer`` signatures
+  (encoded with the SHA-1 algorithm) is removed.
+
+* Support for the pre-Django 3.1 ``django.core.signing.dumps()`` signatures
+  (encoded with the SHA-1 algorithm) in ``django.core.signing.loads()`` is
+  removed.
+
+* Support for the pre-Django 3.1 user sessions (that use the SHA-1 algorithm)
+  is removed.
+
+* The ``get_response`` argument for
+  ``django.utils.deprecation.MiddlewareMixin.__init__()`` is required and
+  doesn't accept ``None``.
+
+* The ``providing_args`` argument for ``django.dispatch.Signal`` is removed.
+
+* The ``length`` argument for ``django.utils.crypto.get_random_string()`` is
+  required.
+
+* The ``list`` message for ``ModelMultipleChoiceField`` is removed.
+
+* Support for passing raw column aliases to ``QuerySet.order_by()`` is removed.
+
+* The ``NullBooleanField`` model field is removed, except for support in
+  historical migrations.
+
+* ``django.conf.urls.url()`` is removed.
+
+* The ``django.contrib.postgres.fields.JSONField`` model field is removed,
+  except for support in historical migrations.
+
+* ``django.contrib.postgres.fields.jsonb.KeyTransform`` and
+  ``django.contrib.postgres.fields.jsonb.KeyTextTransform`` are removed.
+
+* ``django.contrib.postgres.forms.JSONField`` is removed.
+
+* The ``{% ifequal %}`` and ``{% ifnotequal %}`` template tags are removed.
+
+* The ``DEFAULT_HASHING_ALGORITHM`` transitional setting is removed.

testbed/django__django/docs/releases/4.1.txt

@@ -0,0 +1,753 @@
+========================
+Django 4.1 release notes
+========================
+
+*August 3, 2022*
+
+Welcome to Django 4.1!
+
+These release notes cover the :ref:`new features <whats-new-4.1>`, as well as
+some :ref:`backwards incompatible changes <backwards-incompatible-4.1>` you'll
+want to be aware of when upgrading from Django 4.0 or earlier. We've
+:ref:`begun the deprecation process for some features
+<deprecated-features-4.1>`.
+
+See the :doc:`/howto/upgrade-version` guide if you're updating an existing
+project.
+
+Python compatibility
+====================
+
+Django 4.1 supports Python 3.8, 3.9, 3.10, and 3.11 (as of 4.1.3). We
+**highly recommend** and only officially support the latest release of each
+series.
+
+.. _whats-new-4.1:
+
+What's new in Django 4.1
+========================
+
+Asynchronous handlers for class-based views
+-------------------------------------------
+
+View subclasses may now define async HTTP method handlers::
+
+    import asyncio
+    from django.http import HttpResponse
+    from django.views import View
+
+
+    class AsyncView(View):
+        async def get(self, request, *args, **kwargs):
+            # Perform view logic using await.
+            await asyncio.sleep(1)
+            return HttpResponse("Hello async world!")
+
+See :ref:`async-class-based-views` for more details.
+
+Asynchronous ORM interface
+--------------------------
+
+``QuerySet`` now provides an asynchronous interface for all data access
+operations. These are named as-per the existing synchronous operations but with
+an ``a`` prefix, for example ``acreate()``, ``aget()``, and so on.
+
+The new interface allows you to write asynchronous code without needing to wrap
+ORM operations in ``sync_to_async()``::
+
+    async for author in Author.objects.filter(name__startswith="A"):
+        book = await author.books.afirst()
+
+Note that, at this stage, the underlying database operations remain
+synchronous, with contributions ongoing to push asynchronous support down into
+the SQL compiler, and integrate asynchronous database drivers. The new
+asynchronous queryset interface currently encapsulates the necessary
+``sync_to_async()`` operations for you, and will allow your code to take
+advantage of developments in the ORM's asynchronous support as it evolves.
+
+See :ref:`async-queries` for details and limitations.
+
+Validation of Constraints
+-------------------------
+
+:class:`Check <django.db.models.CheckConstraint>`,
+:class:`unique <django.db.models.UniqueConstraint>`, and :class:`exclusion
+<django.contrib.postgres.constraints.ExclusionConstraint>` constraints defined
+in the :attr:`Meta.constraints <django.db.models.Options.constraints>` option
+are now checked during :ref:`model validation <validating-objects>`.
+
+Form rendering accessibility
+----------------------------
+
+In order to aid users with screen readers, and other assistive technology, new
+``<div>`` based form templates are available from this release. These provide
+more accessible navigation than the older templates, and are able to correctly
+group related controls, such as radio-lists, into fieldsets.
+
+The new templates are recommended, and will become the default form rendering
+style when outputting a form, like ``{{ form }}`` in a template, from Django
+5.0.
+
+In order to ease adopting the new output style, the default form and formset
+templates are now configurable at the project level via the
+:setting:`FORM_RENDERER` setting.
+
+See :ref:`the Forms section (below)<forms-4.1>` for full details.
+
+.. _csrf-cookie-masked-usage:
+
+``CSRF_COOKIE_MASKED`` setting
+------------------------------
+
+The new ``CSRF_COOKIE_MASKED`` transitional setting allows specifying whether
+to mask the CSRF cookie.
+
+:class:`~django.middleware.csrf.CsrfViewMiddleware` no longer masks the CSRF
+cookie like it does the CSRF token in the DOM. If you are upgrading multiple
+instances of the same project to Django 4.1, you should set
+``CSRF_COOKIE_MASKED`` to ``True`` during the transition, in order to allow
+compatibility with the older versions of Django. Once the transition to 4.1 is
+complete you can stop overriding ``CSRF_COOKIE_MASKED``.
+
+This setting is deprecated as of this release and will be removed in Django
+5.0.
+
+Minor features
+--------------
+
+:mod:`django.contrib.admin`
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+* The admin :ref:`dark mode CSS variables <admin-theming>` are now applied in a
+  separate stylesheet and template block.
+
+* :ref:`modeladmin-list-filters` providing custom ``FieldListFilter``
+  subclasses can now control the query string value separator when filtering
+  for multiple values using the ``__in`` lookup.
+
+* The admin :meth:`history view <django.contrib.admin.ModelAdmin.history_view>`
+  is now paginated.
+
+* Related widget wrappers now have a link to object's change form.
+
+* The :meth:`.AdminSite.get_app_list` method now allows changing the order of
+  apps and models on the admin index page.
+
+:mod:`django.contrib.auth`
+~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+* The default iteration count for the PBKDF2 password hasher is increased from
+  320,000 to 390,000.
+
+* The :meth:`.RemoteUserBackend.configure_user` method now allows synchronizing
+  user attributes with attributes in a remote system such as an LDAP directory.
+
+:mod:`django.contrib.gis`
+~~~~~~~~~~~~~~~~~~~~~~~~~
+
+* The new :meth:`.GEOSGeometry.make_valid()` method allows converting invalid
+  geometries to valid ones.
+
+* The new ``clone`` argument for :meth:`.GEOSGeometry.normalize` allows
+  creating a normalized clone of the geometry.
+
+:mod:`django.contrib.postgres`
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+* The new :class:`BitXor() <django.contrib.postgres.aggregates.BitXor>`
+  aggregate function returns an ``int`` of the bitwise ``XOR`` of all non-null
+  input values.
+
+* :class:`~django.contrib.postgres.indexes.SpGistIndex` now supports covering
+  indexes on PostgreSQL 14+.
+
+* :class:`~django.contrib.postgres.constraints.ExclusionConstraint` now
+  supports covering exclusion constraints using SP-GiST indexes on PostgreSQL
+  14+.
+
+* The new ``default_bounds`` attribute of :attr:`DateTimeRangeField
+  <django.contrib.postgres.fields.DateTimeRangeField.default_bounds>` and
+  :attr:`DecimalRangeField
+  <django.contrib.postgres.fields.DecimalRangeField.default_bounds>` allows
+  specifying bounds for list and tuple inputs.
+
+* :class:`~django.contrib.postgres.constraints.ExclusionConstraint` now allows
+  specifying operator classes with the
+  :class:`OpClass() <django.contrib.postgres.indexes.OpClass>` expression.
+
+:mod:`django.contrib.sitemaps`
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+* The default sitemap index template ``<sitemapindex>`` now includes the
+  ``<lastmod>`` timestamp where available, through the new
+  :meth:`~django.contrib.sitemaps.Sitemap.get_latest_lastmod` method. Custom
+  sitemap index templates should be updated for the adjusted :ref:`context
+  variables <sitemap-index-context-variables>`.
+
+:mod:`django.contrib.staticfiles`
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+* :class:`~django.contrib.staticfiles.storage.ManifestStaticFilesStorage` now
+  replaces paths to CSS source map references with their hashed counterparts.
+
+Database backends
+~~~~~~~~~~~~~~~~~
+
+* Third-party database backends can now specify the minimum required version of
+  the database using the ``DatabaseFeatures.minimum_database_version``
+  attribute which is a tuple (e.g. ``(10, 0)`` means "10.0"). If a minimum
+  version is specified, backends must also implement
+  ``DatabaseWrapper.get_database_version()``, which returns a tuple of the
+  current database version. The backend's
+  ``DatabaseWrapper.init_connection_state()`` method must call ``super()`` in
+  order for the check to run.
+
+.. _forms-4.1:
+
+Forms
+~~~~~
+
+* The default template used to render forms when cast to a string, e.g. in
+  templates as ``{{ form }}``, is now configurable at the project-level by
+  setting :attr:`~django.forms.renderers.BaseRenderer.form_template_name` on
+  the class provided for :setting:`FORM_RENDERER`.
+
+  :attr:`.Form.template_name` is now a property deferring to the renderer, but
+  may be overridden with a string value to specify the template name per-form
+  class.
+
+  Similarly, the default template used to render formsets can be specified via
+  the matching
+  :attr:`~django.forms.renderers.BaseRenderer.formset_template_name` renderer
+  attribute.
+
+* The new ``div.html`` form template, referencing
+  :attr:`.Form.template_name_div` attribute, and matching :meth:`.Form.as_div`
+  method, render forms using HTML ``<div>`` elements.
+
+  This new output style is recommended over the existing
+  :meth:`~.Form.as_table`, :meth:`~.Form.as_p` and :meth:`~.Form.as_ul` styles,
+  as the template implements ``<fieldset>`` and ``<legend>`` to group related
+  inputs and is easier for screen reader users to navigate.
+
+  The div-based output will become the default rendering style from Django 5.0.
+
+* In order to smooth adoption of the new ``<div>`` output style, two
+  transitional form renderer classes are available:
+  ``django.forms.renderers.DjangoDivFormRenderer`` and
+  ``django.forms.renderers.Jinja2DivFormRenderer``, for the Django and Jinja2
+  template backends respectively.
+
+  You can apply one of these via the :setting:`FORM_RENDERER` setting. For
+  example::
+
+    FORM_RENDERER = "django.forms.renderers.DjangoDivFormRenderer"
+
+  Once the ``<div>`` output style is the default, from Django 5.0, these
+  transitional renderers will be deprecated, for removal in Django 6.0. The
+  ``FORM_RENDERER`` declaration can be removed at that time.
+
+* If the new ``<div>`` output style is not appropriate for your project, you should
+  define a renderer subclass specifying
+  :attr:`~django.forms.renderers.BaseRenderer.form_template_name` and
+  :attr:`~django.forms.renderers.BaseRenderer.formset_template_name` for your
+  required style, and set :setting:`FORM_RENDERER` accordingly.
+
+  For example, for the ``<p>`` output style used by :meth:`~.Form.as_p`, you
+  would define a form renderer setting ``form_template_name`` to
+  ``"django/forms/p.html"`` and ``formset_template_name`` to
+  ``"django/forms/formsets/p.html"``.
+
+* The new :meth:`~django.forms.BoundField.legend_tag` allows rendering field
+  labels in ``<legend>`` tags via the new ``tag`` argument of
+  :meth:`~django.forms.BoundField.label_tag`.
+
+* The new ``edit_only`` argument for :func:`.modelformset_factory` and
+  :func:`.inlineformset_factory` allows preventing new objects creation.
+
+* The ``js`` and ``css`` class attributes of :doc:`Media </topics/forms/media>`
+  now allow using hashable objects, not only path strings, as long as those
+  objects implement the ``__html__()`` method (typically when decorated with
+  the :func:`~django.utils.html.html_safe` decorator).
+
+* The new :attr:`.BoundField.use_fieldset` and :attr:`.Widget.use_fieldset`
+  attributes help to identify widgets where its inputs should be grouped in a
+  ``<fieldset>`` with a ``<legend>``.
+
+* The :ref:`formsets-error-messages` argument for
+  :class:`~django.forms.formsets.BaseFormSet` now allows customizing
+  error messages for invalid number of forms by passing ``'too_few_forms'``
+  and ``'too_many_forms'`` keys.
+
+* :class:`~django.forms.IntegerField`, :class:`~django.forms.FloatField`, and
+  :class:`~django.forms.DecimalField` now optionally accept a ``step_size``
+  argument. This is used to set the ``step`` HTML attribute, and is validated
+  on form submission.
+
+Internationalization
+~~~~~~~~~~~~~~~~~~~~
+
+* The :func:`~django.conf.urls.i18n.i18n_patterns` function now supports
+  languages with both scripts and regions.
+
+Management Commands
+~~~~~~~~~~~~~~~~~~~
+
+* :option:`makemigrations --no-input` now logs default answers and reasons why
+  migrations cannot be created.
+
+* The new :option:`makemigrations --scriptable` option diverts log output and
+  input prompts to ``stderr``, writing only paths of generated migration files
+  to ``stdout``.
+
+* The new :option:`migrate --prune` option allows deleting nonexistent
+  migrations from the ``django_migrations`` table.
+
+* Python files created by :djadmin:`startproject`, :djadmin:`startapp`,
+  :djadmin:`optimizemigration`, :djadmin:`makemigrations`, and
+  :djadmin:`squashmigrations` are now formatted using the ``black`` command if
+  it is present on your ``PATH``.
+
+* The new :djadmin:`optimizemigration` command allows optimizing operations for
+  a migration.
+
+Migrations
+~~~~~~~~~~
+
+* The new :class:`~django.db.migrations.operations.RenameIndex` operation
+  allows renaming indexes defined in the
+  :attr:`Meta.indexes <django.db.models.Options.indexes>` or
+  :attr:`~django.db.models.Options.index_together` options.
+
+* The migrations autodetector now generates
+  :class:`~django.db.migrations.operations.RenameIndex` operations instead of
+  ``RemoveIndex`` and ``AddIndex``, when renaming indexes defined in the
+  :attr:`Meta.indexes <django.db.models.Options.indexes>`.
+
+* The migrations autodetector now generates
+  :class:`~django.db.migrations.operations.RenameIndex` operations instead of
+  ``AlterIndexTogether`` and ``AddIndex``, when moving indexes defined in the
+  :attr:`Meta.index_together <django.db.models.Options.index_together>` to the
+  :attr:`Meta.indexes <django.db.models.Options.indexes>`.
+
+Models
+~~~~~~
+
+* The ``order_by`` argument of the
+  :class:`~django.db.models.expressions.Window` expression now accepts string
+  references to fields and transforms.
+
+* The new :setting:`CONN_HEALTH_CHECKS` setting allows enabling health checks
+  for :ref:`persistent database connections <persistent-database-connections>`
+  in order to reduce the number of failed requests, e.g. after database server
+  restart.
+
+* :meth:`.QuerySet.bulk_create` now supports updating fields when a row
+  insertion fails uniqueness constraints. This is supported on MariaDB, MySQL,
+  PostgreSQL, and SQLite 3.24+.
+
+* :meth:`.QuerySet.iterator` now supports prefetching related objects as long
+  as the ``chunk_size`` argument is provided. In older versions, no prefetching
+  was done.
+
+* :class:`~django.db.models.Q` objects and querysets can now be combined using
+  ``^`` as the exclusive or (``XOR``) operator. ``XOR`` is natively supported
+  on MariaDB and MySQL. For databases that do not support ``XOR``, the query
+  will be converted to an equivalent using ``AND``, ``OR``, and ``NOT``.
+
+* The new :ref:`Field.non_db_attrs <custom-field-non_db_attrs>` attribute
+  allows customizing attributes of fields that don't affect a column
+  definition.
+
+* On PostgreSQL, ``AutoField``, ``BigAutoField``, and ``SmallAutoField`` are
+  now created as identity columns rather than serial columns with sequences.
+
+Requests and Responses
+~~~~~~~~~~~~~~~~~~~~~~
+
+* :meth:`.HttpResponse.set_cookie` now supports :class:`~datetime.timedelta`
+  objects for the ``max_age`` argument.
+
+Security
+~~~~~~~~
+
+* The new :setting:`SECRET_KEY_FALLBACKS` setting allows providing a list of
+  values for secret key rotation.
+
+* The :setting:`SECURE_PROXY_SSL_HEADER` setting now supports a comma-separated
+  list of protocols in the header value.
+
+Signals
+~~~~~~~
+
+* The :data:`~django.db.models.signals.pre_delete` and
+  :data:`~django.db.models.signals.post_delete` signals now dispatch the
+  ``origin`` of the deletion.
+
+.. _templates-4.1:
+
+Templates
+~~~~~~~~~
+
+* The HTML ``<script>`` element ``id`` attribute is no longer required when
+  wrapping the :tfilter:`json_script` template filter.
+
+* The :class:`cached template loader <django.template.loaders.cached.Loader>`
+  is now enabled in development, when :setting:`DEBUG` is ``True``, and
+  :setting:`OPTIONS['loaders'] <TEMPLATES-OPTIONS>` isn't specified. You may
+  specify ``OPTIONS['loaders']`` to override this, if necessary.
+
+Tests
+~~~~~
+
+* The :class:`.DiscoverRunner` now supports running tests in parallel on
+  macOS, Windows, and any other systems where the default
+  :mod:`multiprocessing` start method is ``spawn``.
+
+* A nested atomic block marked as durable in :class:`django.test.TestCase` now
+  raises a ``RuntimeError``, the same as outside of tests.
+
+* :meth:`.SimpleTestCase.assertFormError` and
+  :meth:`assertFormsetError() <django.test.SimpleTestCase.assertFormSetError>`
+  now support passing a form/formset object directly.
+
+URLs
+~~~~
+
+* The new :attr:`.ResolverMatch.captured_kwargs` attribute stores the captured
+  keyword arguments, as parsed from the URL.
+
+* The new :attr:`.ResolverMatch.extra_kwargs` attribute stores the additional
+  keyword arguments passed to the view function.
+
+Utilities
+~~~~~~~~~
+
+* ``SimpleLazyObject`` now supports addition operations.
+
+* :func:`~django.utils.safestring.mark_safe` now preserves lazy objects.
+
+Validators
+~~~~~~~~~~
+
+* The new :class:`~django.core.validators.StepValueValidator` checks if a value
+  is an integral multiple of a given step size. This new validator is used for
+  the new ``step_size`` argument added to form fields representing numeric
+  values.
+
+.. _backwards-incompatible-4.1:
+
+Backwards incompatible changes in 4.1
+=====================================
+
+Database backend API
+--------------------
+
+This section describes changes that may be needed in third-party database
+backends.
+
+* ``BaseDatabaseFeatures.has_case_insensitive_like`` is changed from ``True``
+  to ``False`` to reflect the behavior of most databases.
+
+* ``DatabaseIntrospection.get_key_columns()`` is removed. Use
+  ``DatabaseIntrospection.get_relations()`` instead.
+
+* ``DatabaseOperations.ignore_conflicts_suffix_sql()`` method is replaced by
+  ``DatabaseOperations.on_conflict_suffix_sql()`` that accepts the ``fields``,
+  ``on_conflict``, ``update_fields``, and ``unique_fields`` arguments.
+
+* The ``ignore_conflicts`` argument of the
+  ``DatabaseOperations.insert_statement()`` method is replaced by
+  ``on_conflict`` that accepts ``django.db.models.constants.OnConflict``.
+
+* ``DatabaseOperations._convert_field_to_tz()`` is replaced by
+  ``DatabaseOperations._convert_sql_to_tz()`` that accepts the ``sql``,
+  ``params``, and ``tzname`` arguments.
+
+* Several date and time methods on ``DatabaseOperations`` now take ``sql`` and
+  ``params`` arguments instead of ``field_name`` and return 2-tuple containing
+  some SQL and the parameters to be interpolated into that SQL. The changed
+  methods have these new signatures:
+
+  * ``DatabaseOperations.date_extract_sql(lookup_type, sql, params)``
+  * ``DatabaseOperations.datetime_extract_sql(lookup_type, sql, params, tzname)``
+  * ``DatabaseOperations.time_extract_sql(lookup_type, sql, params)``
+  * ``DatabaseOperations.date_trunc_sql(lookup_type, sql, params, tzname=None)``
+  * ``DatabaseOperations.datetime_trunc_sql(self, lookup_type, sql, params, tzname)``
+  * ``DatabaseOperations.time_trunc_sql(lookup_type, sql, params, tzname=None)``
+  * ``DatabaseOperations.datetime_cast_date_sql(sql, params, tzname)``
+  * ``DatabaseOperations.datetime_cast_time_sql(sql, params, tzname)``
+
+:mod:`django.contrib.gis`
+-------------------------
+
+* Support for GDAL 2.1 is removed.
+
+* Support for PostGIS 2.4 is removed.
+
+Dropped support for PostgreSQL 10
+---------------------------------
+
+Upstream support for PostgreSQL 10 ends in November 2022. Django 4.1 supports
+PostgreSQL 11 and higher.
+
+Dropped support for MariaDB 10.2
+--------------------------------
+
+Upstream support for MariaDB 10.2 ends in May 2022. Django 4.1 supports MariaDB
+10.3 and higher.
+
+Admin changelist searches spanning multi-valued relationships changes
+---------------------------------------------------------------------
+
+Admin changelist searches using multiple search terms are now applied in a
+single call to ``filter()``, rather than in sequential ``filter()`` calls.
+
+For multi-valued relationships, this means that rows from the related model
+must match all terms rather than any term. For example, if ``search_fields``
+is set to ``['child__name', 'child__age']``, and a user searches for
+``'Jamal 17'``, parent rows will be returned only if there is a relationship to
+some 17-year-old child named Jamal, rather than also returning parents who
+merely have a younger or older child named Jamal in addition to some other
+17-year-old.
+
+See the :ref:`spanning-multi-valued-relationships` topic for more discussion of
+this difference. In Django 4.0 and earlier,
+:meth:`~django.contrib.admin.ModelAdmin.get_search_results` followed the
+second example query, but this undocumented behavior led to queries with
+excessive joins.
+
+Reverse foreign key changes for unsaved model instances
+-------------------------------------------------------
+
+In order to unify the behavior with many-to-many relations for unsaved model
+instances, a reverse foreign key now raises ``ValueError`` when calling
+:class:`related managers <django.db.models.fields.related.RelatedManager>` for
+unsaved objects.
+
+Miscellaneous
+-------------
+
+* Related managers for :class:`~django.db.models.ForeignKey`,
+  :class:`~django.db.models.ManyToManyField`, and
+  :class:`~django.contrib.contenttypes.fields.GenericRelation` are now cached
+  on the :class:`~django.db.models.Model` instance to which they belong. *This
+  change was reverted in Django 4.1.2.*
+
+* The Django test runner now returns a non-zero error code for unexpected
+  successes from tests marked with :py:func:`unittest.expectedFailure`.
+
+* :class:`~django.middleware.csrf.CsrfViewMiddleware` no longer masks the CSRF
+  cookie like it does the CSRF token in the DOM.
+
+* :class:`~django.middleware.csrf.CsrfViewMiddleware` now uses
+  ``request.META['CSRF_COOKIE']`` for storing the unmasked CSRF secret rather
+  than a masked version. This is an undocumented, private API.
+
+* The :attr:`.ModelAdmin.actions` and
+  :attr:`~django.contrib.admin.ModelAdmin.inlines` attributes now default to an
+  empty tuple rather than an empty list to discourage unintended mutation.
+
+* The ``type="text/css"`` attribute is no longer included in ``<link>`` tags
+  for CSS :doc:`form media </topics/forms/media>`.
+
+* ``formset:added`` and ``formset:removed`` JavaScript events are now pure
+  JavaScript events and don't depend on jQuery. See
+  :ref:`admin-javascript-inline-form-events` for more details on the change.
+
+* The ``exc_info`` argument of the undocumented
+  ``django.utils.log.log_response()`` function is replaced by ``exception``.
+
+* The ``size`` argument of the undocumented
+  ``django.views.static.was_modified_since()`` function is removed.
+
+* The admin log out UI now uses ``POST`` requests.
+
+* The undocumented ``InlineAdminFormSet.non_form_errors`` property is replaced
+  by the ``non_form_errors()`` method. This is consistent with ``BaseFormSet``.
+
+* As per :ref:`above<templates-4.1>`, the cached template loader is now
+  enabled in development. You may specify ``OPTIONS['loaders']`` to override
+  this, if necessary.
+
+* The undocumented ``django.contrib.auth.views.SuccessURLAllowedHostsMixin``
+  mixin is replaced by ``RedirectURLMixin``.
+
+* :class:`~django.db.models.BaseConstraint` subclasses must implement
+  :meth:`~django.db.models.BaseConstraint.validate` method to allow those
+  constraints to be used for validation.
+
+* The undocumented ``URLResolver._is_callback()``,
+  ``URLResolver._callback_strs``, and ``URLPattern.lookup_str()`` are
+  moved to ``django.contrib.admindocs.utils``.
+
+* The :meth:`.Model.full_clean` method now converts an ``exclude`` value to a
+  ``set``. It’s also preferable to pass an ``exclude`` value as a ``set`` to
+  the :meth:`.Model.clean_fields`, :meth:`.Model.full_clean`,
+  :meth:`.Model.validate_unique`, and :meth:`.Model.validate_constraints`
+  methods.
+
+* The minimum supported version of ``asgiref`` is increased from 3.4.1 to
+  3.5.2.
+
+* Combined expressions no longer use the error-prone behavior of guessing
+  ``output_field`` when argument types match. As a consequence, resolving an
+  ``output_field`` for database functions and combined expressions may now
+  crash with mixed types. You will need to explicitly set the ``output_field``
+  in such cases.
+
+* The :djadmin:`makemessages` command no longer changes ``.po`` files when up
+  to date. In older versions, ``POT-Creation-Date`` was always updated.
+
+.. _deprecated-features-4.1:
+
+Features deprecated in 4.1
+==========================
+
+Log out via GET
+---------------
+
+Logging out via ``GET`` requests to the :py:class:`built-in logout view
+<django.contrib.auth.views.LogoutView>` is deprecated. Use ``POST`` requests
+instead.
+
+If you want to retain the user experience of an HTML link, you can use a form
+that is styled to appear as a link:
+
+.. code-block:: html
+
+  <form id="logout-form" method="post" action="{% url 'admin:logout' %}">
+    {% csrf_token %}
+    <button type="submit">{% translate "Log out" %}</button>
+  </form>
+
+.. code-block:: css
+
+  #logout-form {
+    display: inline;
+  }
+  #logout-form button {
+    background: none;
+    border: none;
+    cursor: pointer;
+    padding: 0;
+    text-decoration: underline;
+  }
+
+Miscellaneous
+-------------
+
+* The context for sitemap index templates of a flat list of URLs is deprecated.
+  Custom sitemap index templates should be updated for the adjusted
+  :ref:`context variables <sitemap-index-context-variables>`, expecting a list
+  of objects with ``location`` and optional ``lastmod`` attributes.
+
+* ``CSRF_COOKIE_MASKED`` transitional setting is deprecated.
+
+* The ``name`` argument of :func:`django.utils.functional.cached_property` is
+  deprecated as it's unnecessary as of Python 3.6.
+
+* The ``opclasses`` argument of
+  ``django.contrib.postgres.constraints.ExclusionConstraint`` is deprecated in
+  favor of using :class:`OpClass() <django.contrib.postgres.indexes.OpClass>`
+  in :attr:`.ExclusionConstraint.expressions`. To use it, you need to add
+  ``'django.contrib.postgres'`` in your :setting:`INSTALLED_APPS`.
+
+  After making this change, :djadmin:`makemigrations` will generate a new
+  migration with two operations: ``RemoveConstraint`` and ``AddConstraint``.
+  Since this change has no effect on the database schema,
+  the :class:`~django.db.migrations.operations.SeparateDatabaseAndState`
+  operation can be used to only update the migration state without running any
+  SQL. Move the generated operations into the ``state_operations`` argument of
+  :class:`~django.db.migrations.operations.SeparateDatabaseAndState`. For
+  example::
+
+    class Migration(migrations.Migration):
+        ...
+
+        operations = [
+            migrations.SeparateDatabaseAndState(
+                database_operations=[],
+                state_operations=[
+                    migrations.RemoveConstraint(...),
+                    migrations.AddConstraint(...),
+                ],
+            ),
+        ]
+
+* The undocumented ability to pass ``errors=None`` to
+  :meth:`.SimpleTestCase.assertFormError` and
+  :meth:`assertFormsetError() <django.test.SimpleTestCase.assertFormSetError>`
+  is deprecated. Use ``errors=[]`` instead.
+
+* ``django.contrib.sessions.serializers.PickleSerializer`` is deprecated due to
+  the risk of remote code execution.
+
+* The usage of ``QuerySet.iterator()`` on a queryset that prefetches related
+  objects without providing the ``chunk_size`` argument is deprecated. In older
+  versions, no prefetching was done. Providing a value for ``chunk_size``
+  signifies that the additional query per chunk needed to prefetch is desired.
+
+* Passing unsaved model instances to related filters is deprecated. In Django
+  5.0, the exception will be raised.
+
+* ``created=True`` is added to the signature of
+  :meth:`.RemoteUserBackend.configure_user`. Support  for ``RemoteUserBackend``
+  subclasses that do not accept this argument is deprecated.
+
+* The ``django.utils.timezone.utc`` alias to :attr:`datetime.timezone.utc` is
+  deprecated. Use :attr:`datetime.timezone.utc` directly.
+
+* Passing a response object and a form/formset name to
+  ``SimpleTestCase.assertFormError()`` and ``assertFormsetError()`` is
+  deprecated. Use::
+
+    assertFormError(response.context["form_name"], ...)
+    assertFormsetError(response.context["formset_name"], ...)
+
+  or pass the form/formset object directly instead.
+
+* The undocumented ``django.contrib.gis.admin.OpenLayersWidget`` is deprecated.
+
+* ``django.contrib.auth.hashers.CryptPasswordHasher`` is deprecated.
+
+* The ability to pass ``nulls_first=False`` or ``nulls_last=False`` to
+  ``Expression.asc()`` and ``Expression.desc()`` methods, and the ``OrderBy``
+  expression is deprecated. Use ``None`` instead.
+
+* The ``"django/forms/default.html"`` and
+  ``"django/forms/formsets/default.html"`` templates which are a proxy to the
+  table-based templates are deprecated. Use the specific template instead.
+
+* The undocumented ``LogoutView.get_next_page()`` method is renamed to
+  ``get_success_url()``.
+
+Features removed in 4.1
+=======================
+
+These features have reached the end of their deprecation cycle and are removed
+in Django 4.1.
+
+See :ref:`deprecated-features-3.2` for details on these changes, including how
+to remove usage of these features.
+
+* Support for assigning objects which don't support creating deep copies with
+  ``copy.deepcopy()`` to class attributes in ``TestCase.setUpTestData()`` is
+  removed.
+
+* Support for using a boolean value in
+  :attr:`.BaseCommand.requires_system_checks` is removed.
+
+* The ``whitelist`` argument and ``domain_whitelist`` attribute of
+  ``django.core.validators.EmailValidator`` are removed.
+
+* The ``default_app_config`` application configuration variable is removed.
+
+* ``TransactionTestCase.assertQuerysetEqual()`` no longer calls ``repr()`` on a
+  queryset when compared to string values.
+
+* The ``django.core.cache.backends.memcached.MemcachedCache`` backend is
+  removed.
+
+* Support for the pre-Django 3.2 format of messages used by
+  ``django.contrib.messages.storage.cookie.CookieStorage`` is removed.

testbed/django__django/docs/releases/4.2.4.txt

@@ -0,0 +1,12 @@
+==========================
+Django 4.2.4 release notes
+==========================
+
+*Expected August 1, 2023*
+
+Django 4.2.4 fixes several bugs in 4.2.3.
+
+Bugfixes
+========
+
+* ...

testbed/django__django/docs/releases/4.2.txt

@@ -0,0 +1,610 @@
+========================
+Django 4.2 release notes
+========================
+
+*April 3, 2023*
+
+Welcome to Django 4.2!
+
+These release notes cover the :ref:`new features <whats-new-4.2>`, as well as
+some :ref:`backwards incompatible changes <backwards-incompatible-4.2>` you'll
+want to be aware of when upgrading from Django 4.1 or earlier. We've
+:ref:`begun the deprecation process for some features
+<deprecated-features-4.2>`.
+
+See the :doc:`/howto/upgrade-version` guide if you're updating an existing
+project.
+
+Django 4.2 is designated as a :term:`long-term support release
+<Long-term support release>`. It will receive security updates for at least
+three years after its release. Support for the previous LTS, Django 3.2, will
+end in April 2024.
+
+Python compatibility
+====================
+
+Django 4.2 supports Python 3.8, 3.9, 3.10, and 3.11. We **highly recommend**
+and only officially support the latest release of each series.
+
+.. _whats-new-4.2:
+
+What's new in Django 4.2
+========================
+
+Psycopg 3 support
+-----------------
+
+Django now supports `psycopg`_ version 3.1.8 or higher. To update your code,
+install the :pypi:`psycopg library <psycopg>`, you don't need to change the
+:setting:`ENGINE <DATABASE-ENGINE>` as ``django.db.backends.postgresql``
+supports both libraries.
+
+Support for ``psycopg2`` is likely to be deprecated and removed at some point
+in the future.
+
+Be aware that ``psycopg`` 3 introduces some breaking changes over ``psycopg2``.
+As a consequence, you may need to make some changes to account for
+`differences from psycopg2`_.
+
+.. _psycopg: https://www.psycopg.org/psycopg3/
+.. _differences from psycopg2: https://www.psycopg.org/psycopg3/docs/basic/from_pg2.html
+
+Comments on columns and tables
+------------------------------
+
+The new :attr:`Field.db_comment <django.db.models.Field.db_comment>` and
+:attr:`Meta.db_table_comment <django.db.models.Options.db_table_comment>`
+options allow creating comments on columns and tables, respectively. For
+example::
+
+    from django.db import models
+
+
+    class Question(models.Model):
+        text = models.TextField(db_comment="Poll question")
+        pub_date = models.DateTimeField(
+            db_comment="Date and time when the question was published",
+        )
+
+        class Meta:
+            db_table_comment = "Poll questions"
+
+
+    class Answer(models.Model):
+        question = models.ForeignKey(
+            Question,
+            on_delete=models.CASCADE,
+            db_comment="Reference to a question",
+        )
+        answer = models.TextField(db_comment="Question answer")
+
+        class Meta:
+            db_table_comment = "Question answers"
+
+Also, the new :class:`~django.db.migrations.operations.AlterModelTableComment`
+operation allows changing table comments defined in the
+:attr:`Meta.db_table_comment <django.db.models.Options.db_table_comment>`.
+
+Mitigation for the BREACH attack
+--------------------------------
+
+:class:`~django.middleware.gzip.GZipMiddleware` now includes a mitigation for
+the BREACH attack. It will add up to 100 random bytes to gzip responses to make
+BREACH attacks harder. Read more about the mitigation technique in the `Heal
+The Breach (HTB) paper`_.
+
+.. _Heal The Breach (HTB) paper: https://ieeexplore.ieee.org/document/9754554
+
+In-memory file storage
+----------------------
+
+The new :class:`django.core.files.storage.InMemoryStorage` class provides a
+non-persistent storage useful for speeding up tests by avoiding disk access.
+
+Custom file storages
+--------------------
+
+The new :setting:`STORAGES` setting allows configuring multiple custom file
+storage backends. It also controls storage engines for managing
+:doc:`files </topics/files>` (the ``"default"`` key) and :doc:`static files
+</ref/contrib/staticfiles>` (the ``"staticfiles"`` key).
+
+The old ``DEFAULT_FILE_STORAGE`` and ``STATICFILES_STORAGE`` settings are
+deprecated as of this release.
+
+Minor features
+--------------
+
+:mod:`django.contrib.admin`
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+* The light or dark color theme of the admin can now be toggled in the UI, as
+  well as being set to follow the system setting.
+
+* The admin's font stack now prefers system UI fonts and no longer requires
+  downloading fonts. Additionally, CSS variables are available to more easily
+  override the default font families.
+
+* The :source:`admin/delete_confirmation.html
+  <django/contrib/admin/templates/admin/delete_confirmation.html>` template now
+  has some additional blocks and scripting hooks to ease customization.
+
+* The chosen options of
+  :attr:`~django.contrib.admin.ModelAdmin.filter_horizontal` and
+  :attr:`~django.contrib.admin.ModelAdmin.filter_vertical` widgets are now
+  filterable.
+
+* The ``admin/base.html`` template now has a new block ``nav-breadcrumbs``
+  which contains the navigation landmark and the ``breadcrumbs`` block.
+
+* :attr:`.ModelAdmin.list_editable` now uses atomic transactions when making
+  edits.
+
+* jQuery is upgraded from version 3.6.0 to 3.6.4.
+
+:mod:`django.contrib.auth`
+~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+* The default iteration count for the PBKDF2 password hasher is increased from
+  390,000 to 600,000.
+
+* :class:`~django.contrib.auth.forms.UserCreationForm` now saves many-to-many
+  form fields for a custom user model.
+
+* The new :class:`~django.contrib.auth.forms.BaseUserCreationForm` is now the
+  recommended base class for customizing the user creation form.
+
+:mod:`django.contrib.gis`
+~~~~~~~~~~~~~~~~~~~~~~~~~
+
+* The :doc:`GeoJSON serializer </ref/contrib/gis/serializers>` now outputs the
+  ``id`` key for serialized features, which defaults to the primary key of
+  objects.
+
+* The :class:`~django.contrib.gis.gdal.GDALRaster` class now supports
+  :class:`pathlib.Path`.
+
+* The :class:`~django.contrib.gis.geoip2.GeoIP2` class now supports  ``.mmdb``
+  files downloaded from DB-IP.
+
+* The OpenLayers template widget no longer includes inline CSS (which also
+  removes the former ``map_css`` block) to better comply with a strict Content
+  Security Policy.
+
+* :class:`~django.contrib.gis.forms.widgets.OpenLayersWidget` is now based on
+  OpenLayers 7.2.2 (previously 4.6.5).
+
+* The new :lookup:`isempty` lookup and
+  :class:`IsEmpty() <django.contrib.gis.db.models.functions.IsEmpty>`
+  expression allow filtering empty geometries on PostGIS.
+
+* The new :class:`FromWKB() <django.contrib.gis.db.models.functions.FromWKB>`
+  and :class:`FromWKT() <django.contrib.gis.db.models.functions.FromWKT>`
+  functions allow creating geometries from Well-known binary (WKB) and
+  Well-known text (WKT) representations.
+
+:mod:`django.contrib.postgres`
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+* The new :lookup:`trigram_strict_word_similar` lookup, and the
+  :class:`TrigramStrictWordSimilarity()
+  <django.contrib.postgres.search.TrigramStrictWordSimilarity>` and
+  :class:`TrigramStrictWordDistance()
+  <django.contrib.postgres.search.TrigramStrictWordDistance>` expressions allow
+  using trigram strict word similarity.
+
+* The :lookup:`arrayfield.overlap` lookup now supports ``QuerySet.values()``
+  and ``values_list()`` as a right-hand side.
+
+:mod:`django.contrib.sitemaps`
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+* The new :meth:`.Sitemap.get_languages_for_item` method allows customizing the
+  list of languages for which the item is displayed.
+
+:mod:`django.contrib.staticfiles`
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+* :class:`~django.contrib.staticfiles.storage.ManifestStaticFilesStorage` now
+  has experimental support for replacing paths to JavaScript modules in
+  ``import`` and ``export`` statements with their hashed counterparts. If you
+  want to try it, subclass ``ManifestStaticFilesStorage`` and set the
+  ``support_js_module_import_aggregation`` attribute to ``True``.
+
+* The new :attr:`.ManifestStaticFilesStorage.manifest_hash` attribute provides
+  a hash over all files in the manifest and changes whenever one of the files
+  changes.
+
+Database backends
+~~~~~~~~~~~~~~~~~
+
+* The new ``"assume_role"`` option is now supported in :setting:`OPTIONS` on
+  PostgreSQL to allow specifying the :ref:`session role <database-role>`.
+
+* The new ``"server_side_binding"`` option is now supported in
+  :setting:`OPTIONS` on PostgreSQL with ``psycopg`` 3.1.8+ to allow using
+  :ref:`server-side binding cursors <database-server-side-parameters-binding>`.
+
+Error Reporting
+~~~~~~~~~~~~~~~
+
+* The debug page now shows :pep:`exception notes <678>` and
+  :pep:`fine-grained error locations <657>` on Python 3.11+.
+
+* Session cookies are now treated as credentials and therefore hidden and
+  replaced with stars (``**********``) in error reports.
+
+Forms
+~~~~~
+
+* :class:`~django.forms.ModelForm` now accepts the new ``Meta`` option
+  ``formfield_callback`` to customize form fields.
+
+* :func:`~django.forms.models.modelform_factory` now respects the
+  ``formfield_callback`` attribute of the ``form``’s ``Meta``.
+
+Internationalization
+~~~~~~~~~~~~~~~~~~~~
+
+* Added support and translations for the Central Kurdish (Sorani) language.
+
+Logging
+~~~~~~~
+
+* The :ref:`django-db-logger` logger now logs transaction management queries
+  (``BEGIN``, ``COMMIT``, and ``ROLLBACK``) at the ``DEBUG`` level.
+
+Management Commands
+~~~~~~~~~~~~~~~~~~~
+
+* :djadmin:`makemessages` command now supports locales with private sub-tags
+  such as ``nl_NL-x-informal``.
+
+* The new :option:`makemigrations --update` option merges model changes into
+  the latest migration and optimizes the resulting operations.
+
+Migrations
+~~~~~~~~~~
+
+* Migrations now support serialization of ``enum.Flag`` objects.
+
+Models
+~~~~~~
+
+* ``QuerySet`` now extensively supports filtering against
+  :ref:`window-functions` with the exception of disjunctive filter lookups
+  against window functions when performing aggregation.
+
+* :meth:`~.QuerySet.prefetch_related` now supports
+  :class:`~django.db.models.Prefetch` objects with sliced querysets.
+
+* :ref:`Registering lookups <lookup-registration-api>` on
+  :class:`~django.db.models.Field` instances is now supported.
+
+* The new ``robust`` argument for :func:`~django.db.transaction.on_commit`
+  allows performing actions that can fail after a database transaction is
+  successfully committed.
+
+* The new :class:`KT() <django.db.models.fields.json.KT>` expression represents
+  the text value of a key, index, or path transform of
+  :class:`~django.db.models.JSONField`.
+
+* :class:`~django.db.models.functions.Now` now supports microsecond precision
+  on MySQL and millisecond precision on SQLite.
+
+* :class:`F() <django.db.models.F>` expressions that output ``BooleanField``
+  can now be negated using ``~F()`` (inversion operator).
+
+* ``Model`` now provides asynchronous versions of some methods that use the
+  database, using an ``a`` prefix: :meth:`~.Model.adelete`,
+  :meth:`~.Model.arefresh_from_db`, and :meth:`~.Model.asave`.
+
+* Related managers now provide asynchronous versions of methods that change a
+  set of related objects, using an ``a`` prefix: :meth:`~.RelatedManager.aadd`,
+  :meth:`~.RelatedManager.aclear`, :meth:`~.RelatedManager.aremove`, and
+  :meth:`~.RelatedManager.aset`.
+
+* :attr:`CharField.max_length <django.db.models.CharField.max_length>` is no
+  longer required to be set on PostgreSQL, which supports unlimited ``VARCHAR``
+  columns.
+
+Requests and Responses
+~~~~~~~~~~~~~~~~~~~~~~
+
+* :class:`~django.http.StreamingHttpResponse` now supports async iterators
+  when Django is served via ASGI.
+
+Tests
+~~~~~
+
+* The :option:`test --debug-sql` option now formats SQL queries with
+  ``sqlparse``.
+
+* The :class:`~django.test.RequestFactory`,
+  :class:`~django.test.AsyncRequestFactory`, :class:`~django.test.Client`, and
+  :class:`~django.test.AsyncClient` classes now support the ``headers``
+  parameter, which accepts a dictionary of header names and values. This allows
+  a more natural syntax for declaring headers.
+
+  .. code-block:: python
+
+     # Before:
+     self.client.get("/home/", HTTP_ACCEPT_LANGUAGE="fr")
+     await self.async_client.get("/home/", ACCEPT_LANGUAGE="fr")
+
+     # After:
+     self.client.get("/home/", headers={"accept-language": "fr"})
+     await self.async_client.get("/home/", headers={"accept-language": "fr"})
+
+Utilities
+~~~~~~~~~
+
+* The new ``encoder`` parameter for :meth:`django.utils.html.json_script`
+  function allows customizing a JSON encoder class.
+
+* The private internal vendored copy of ``urllib.parse.urlsplit()`` now strips
+  ``'\r'``, ``'\n'``, and ``'\t'`` (see :cve:`2022-0391` and :bpo:`43882`).
+  This is to protect projects that may be incorrectly using the internal
+  ``url_has_allowed_host_and_scheme()`` function, instead of using one of the
+  documented functions for handling URL redirects. The Django functions were
+  not affected.
+
+* The new :func:`django.utils.http.content_disposition_header` function returns
+  a ``Content-Disposition`` HTTP header value as specified by :rfc:`6266`.
+
+Validators
+~~~~~~~~~~
+
+* The list of common passwords used by ``CommonPasswordValidator`` is updated
+  to the most recent version.
+
+.. _backwards-incompatible-4.2:
+
+Backwards incompatible changes in 4.2
+=====================================
+
+Database backend API
+--------------------
+
+This section describes changes that may be needed in third-party database
+backends.
+
+* ``DatabaseFeatures.allows_group_by_pk`` is removed as it only remained to
+  accommodate a MySQL extension that has been supplanted by proper functional
+  dependency detection in MySQL 5.7.15. Note that
+  ``DatabaseFeatures.allows_group_by_selected_pks`` is still supported and
+  should be enabled if your backend supports functional dependency detection in
+  ``GROUP BY`` clauses as specified by the ``SQL:1999`` standard.
+
+* :djadmin:`inspectdb` now uses ``display_size`` from
+  ``DatabaseIntrospection.get_table_description()`` rather than
+  ``internal_size`` for ``CharField``.
+
+Dropped support for MariaDB 10.3
+--------------------------------
+
+Upstream support for MariaDB 10.3 ends in May 2023. Django 4.2 supports MariaDB
+10.4 and higher.
+
+Dropped support for MySQL 5.7
+-----------------------------
+
+Upstream support for MySQL 5.7 ends in October 2023. Django 4.2 supports MySQL
+8 and higher.
+
+Dropped support for PostgreSQL 11
+---------------------------------
+
+Upstream support for PostgreSQL 11 ends in November 2023. Django 4.2 supports
+PostgreSQL 12 and higher.
+
+Setting ``update_fields`` in ``Model.save()`` may now be required
+-----------------------------------------------------------------
+
+In order to avoid updating unnecessary columns,
+:meth:`.QuerySet.update_or_create` now passes ``update_fields`` to the
+:meth:`Model.save() <django.db.models.Model.save>` calls. As a consequence, any
+fields modified in the custom ``save()`` methods should be added to the
+``update_fields`` keyword argument before calling ``super()``. See
+:ref:`overriding-model-methods` for more details.
+
+Miscellaneous
+-------------
+
+* The undocumented ``django.http.multipartparser.parse_header()`` function is
+  removed. Use ``django.utils.http.parse_header_parameters()`` instead.
+
+* :ttag:`{% blocktranslate asvar … %}<blocktranslate>` result is now marked as
+  safe for (HTML) output purposes.
+
+* The ``autofocus`` HTML attribute in the admin search box is removed as it can
+  be confusing for screen readers.
+
+* The :option:`makemigrations --check` option no longer creates missing
+  migration files.
+
+* The ``alias`` argument for :meth:`.Expression.get_group_by_cols` is removed.
+
+* The minimum supported version of ``sqlparse`` is increased from 0.2.2 to
+  0.3.1.
+
+* The undocumented ``negated`` parameter of the
+  :class:`~django.db.models.Exists` expression is removed.
+
+* The ``is_summary`` argument of the undocumented ``Query.add_annotation()``
+  method is removed.
+
+* The minimum supported version of SQLite is increased from 3.9.0 to 3.21.0.
+
+* The minimum supported version of ``asgiref`` is increased from 3.5.2 to
+  3.6.0.
+
+* :class:`~django.contrib.auth.forms.UserCreationForm` now rejects usernames
+  that differ only in case. If you need the previous behavior, use
+  :class:`~django.contrib.auth.forms.BaseUserCreationForm` instead.
+
+* The minimum supported version of ``mysqlclient`` is increased from 1.4.0 to
+  1.4.3.
+
+* The minimum supported version of ``argon2-cffi`` is increased  from 19.1.0 to
+  19.2.0.
+
+* The minimum supported version of ``Pillow`` is increased from 6.2.0 to 6.2.1.
+
+* The minimum supported version of ``jinja2`` is increased from 2.9.2 to
+  2.11.0.
+
+* The minimum supported version of :pypi:`redis-py <redis>` is increased from
+  3.0.0 to 3.4.0.
+
+* Manually instantiated ``WSGIRequest`` objects must be provided a file-like
+  object for ``wsgi.input``. Previously, Django was more lax than the expected
+  behavior as specified by the WSGI specification.
+
+* Support for ``PROJ`` < 5 is removed.
+
+* :class:`~django.core.mail.backends.smtp.EmailBackend` now verifies a
+  :py:attr:`hostname <ssl.SSLContext.check_hostname>` and
+  :py:attr:`certificates <ssl.SSLContext.verify_mode>`. If you need the
+  previous behavior that is less restrictive and not recommended, subclass
+  ``EmailBackend`` and override the ``ssl_context`` property.
+
+.. _deprecated-features-4.2:
+
+Features deprecated in 4.2
+==========================
+
+``index_together`` option is deprecated in favor of ``indexes``
+---------------------------------------------------------------
+
+The :attr:`Meta.index_together <django.db.models.Options.index_together>`
+option is deprecated in favor of the :attr:`~django.db.models.Options.indexes`
+option.
+
+Migrating existing ``index_together`` should be handled as a migration. For
+example::
+
+    class Author(models.Model):
+        rank = models.IntegerField()
+        name = models.CharField(max_length=30)
+
+        class Meta:
+            index_together = [["rank", "name"]]
+
+Should become::
+
+    class Author(models.Model):
+        rank = models.IntegerField()
+        name = models.CharField(max_length=30)
+
+        class Meta:
+            indexes = [models.Index(fields=["rank", "name"])]
+
+Running the :djadmin:`makemigrations` command will generate a migration
+containing a :class:`~django.db.migrations.operations.RenameIndex` operation
+which will rename the existing index. Next, consider squashing migrations to
+remove ``index_together`` from historical migrations.
+
+The ``AlterIndexTogether`` migration operation is now officially supported only
+for pre-Django 4.2 migration files. For backward compatibility reasons, it's
+still part of the public API, and there's no plan to deprecate or remove it,
+but it should not be used for new migrations. Use
+:class:`~django.db.migrations.operations.AddIndex` and
+:class:`~django.db.migrations.operations.RemoveIndex` operations instead.
+
+Passing encoded JSON string literals to ``JSONField`` is deprecated
+-------------------------------------------------------------------
+
+``JSONField`` and its associated lookups and aggregates used to allow passing
+JSON encoded string literals which caused ambiguity on whether string literals
+were already encoded from database backend's perspective.
+
+During the deprecation period string literals will be attempted to be JSON
+decoded and a warning will be emitted on success that points at passing
+non-encoded forms instead.
+
+Code that use to pass JSON encoded string literals::
+
+    Document.objects.bulk_create(
+        Document(data=Value("null")),
+        Document(data=Value("[]")),
+        Document(data=Value('"foo-bar"')),
+    )
+    Document.objects.annotate(
+        JSONBAgg("field", default=Value("[]")),
+    )
+
+Should become::
+
+    Document.objects.bulk_create(
+        Document(data=Value(None, JSONField())),
+        Document(data=[]),
+        Document(data="foo-bar"),
+    )
+    Document.objects.annotate(
+        JSONBAgg("field", default=[]),
+    )
+
+From Django 5.1+ string literals will be implicitly interpreted as JSON string
+literals.
+
+Miscellaneous
+-------------
+
+* The ``BaseUserManager.make_random_password()`` method is deprecated. See
+  `recipes and best practices
+  <https://docs.python.org/3/library/secrets.html#recipes-and-best-practices>`_
+  for using Python's :py:mod:`secrets` module to generate passwords.
+
+* The ``length_is`` template filter is deprecated in favor of :tfilter:`length`
+  and the ``==`` operator within an :ttag:`{% if %}<if>` tag. For example
+
+  .. code-block:: html+django
+
+    {% if value|length == 4 %}…{% endif %}
+    {% if value|length == 4 %}True{% else %}False{% endif %}
+
+  instead of:
+
+  .. code-block:: html+django
+
+    {% if value|length_is:4 %}…{% endif %}
+    {{ value|length_is:4 }}
+
+* ``django.contrib.auth.hashers.SHA1PasswordHasher``,
+  ``django.contrib.auth.hashers.UnsaltedSHA1PasswordHasher``, and
+  ``django.contrib.auth.hashers.UnsaltedMD5PasswordHasher`` are deprecated.
+
+* ``django.contrib.postgres.fields.CICharField`` is deprecated in favor of
+  ``CharField(db_collation="…")`` with a case-insensitive non-deterministic
+  collation.
+
+* ``django.contrib.postgres.fields.CIEmailField`` is deprecated in favor of
+  ``EmailField(db_collation="…")`` with a case-insensitive non-deterministic
+  collation.
+
+* ``django.contrib.postgres.fields.CITextField`` is deprecated in favor of
+  ``TextField(db_collation="…")`` with a case-insensitive non-deterministic
+  collation.
+
+* ``django.contrib.postgres.fields.CIText`` mixin is deprecated.
+
+* 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()``.
+
+* ``TransactionTestCase.assertQuerysetEqual()`` is deprecated in favor of
+  ``assertQuerySetEqual()``.
+
+* Passing positional arguments to ``Signer`` and ``TimestampSigner`` is
+  deprecated in favor of keyword-only arguments.
+
+* The ``DEFAULT_FILE_STORAGE`` setting is deprecated in favor of
+  ``STORAGES["default"]``.
+
+* The ``STATICFILES_STORAGE`` setting is deprecated in favor of
+  ``STORAGES["staticfiles"]``.
+
+* The ``django.core.files.storage.get_storage_class()`` function is deprecated.

testbed/django__django/docs/releases/5.0.txt

@@ -0,0 +1,646 @@
+============================================
+Django 5.0 release notes - UNDER DEVELOPMENT
+============================================
+
+*Expected December 2023*
+
+Welcome to Django 5.0!
+
+These release notes cover the :ref:`new features <whats-new-5.0>`, as well as
+some :ref:`backwards incompatible changes <backwards-incompatible-5.0>` you'll
+want to be aware of when upgrading from Django 4.2 or earlier. We've
+:ref:`begun the deprecation process for some features
+<deprecated-features-5.0>`.
+
+See the :doc:`/howto/upgrade-version` guide if you're updating an existing
+project.
+
+Python compatibility
+====================
+
+Django 5.0 supports Python 3.10, 3.11, and 3.12. We **highly recommend** and
+only officially support the latest release of each series.
+
+The Django 4.2.x series is the last to support Python 3.8 and 3.9.
+
+Third-party library support for older version of Django
+=======================================================
+
+Following the release of Django 5.0, we suggest that third-party app authors
+drop support for all versions of Django prior to 4.2. At that time, you should
+be able to run your package's tests using ``python -Wd`` so that deprecation
+warnings appear. After making the deprecation warning fixes, your app should be
+compatible with Django 5.0.
+
+.. _whats-new-5.0:
+
+What's new in Django 5.0
+========================
+
+Facet filters in the admin
+--------------------------
+
+Facet counts are now shown for applied filters in the admin changelist when
+toggled on via the UI. This behavior can be changed via the new
+:attr:`.ModelAdmin.show_facets` attribute. For more information see
+:ref:`facet-filters`.
+
+Simplified templates for form field rendering
+---------------------------------------------
+
+Django 5.0 introduces the concept of a field group, and field group templates.
+This simplifies rendering of the related elements of a Django form field such
+as its label, widget, help text, and errors.
+
+For example, the template below:
+
+.. code-block:: html+django
+
+    <form>
+    ...
+    <div>
+      {{ form.name.label_tag }}
+      {% if form.name.help_text %}
+        <div class="helptext" id="{{ form.name.id_for_label }}_helptext">
+          {{ form.name.help_text|safe }}
+        </div>
+      {% endif %}
+      {{ form.name.errors }}
+      {{ form.name }}
+      <div class="row">
+        <div class="col">
+          {{ form.email.label_tag }}
+          {% if form.email.help_text %}
+            <div class="helptext" id="{{ form.email.id_for_label }}_helptext">
+              {{ form.email.help_text|safe }}
+            </div>
+          {% endif %}
+          {{ form.email.errors }}
+          {{ form.email }}
+        </div>
+        <div class="col">
+          {{ form.password.label_tag }}
+          {% if form.password.help_text %}
+            <div class="helptext" id="{{ form.password.id_for_label }}_helptext">
+              {{ form.password.help_text|safe }}
+            </div>
+          {% endif %}
+          {{ form.password.errors }}
+          {{ form.password }}
+        </div>
+      </div>
+    </div>
+    ...
+    </form>
+
+Can now be simplified to:
+
+.. code-block:: html+django
+
+    <form>
+    ...
+    <div>
+      {{ form.name.as_field_group }}
+      <div class="row">
+        <div class="col">{{ form.email.as_field_group }}</div>
+        <div class="col">{{ form.password.as_field_group }}</div>
+      </div>
+    </div>
+    ...
+    </form>
+
+:meth:`~django.forms.BoundField.as_field_group` renders fields with the
+``"django/forms/field.html"`` template by default and can be customized on a
+per-project, per-field, or per-request basis. See
+:ref:`reusable-field-group-templates`.
+
+Database-computed default values
+--------------------------------
+
+The new :attr:`Field.db_default <django.db.models.Field.db_default>` parameter
+sets a database-computed default value. For example::
+
+    from django.db import models
+    from django.db.models.functions import Now, Pi
+
+
+    class MyModel(models.Model):
+        age = models.IntegerField(db_default=18)
+        created = models.DateTimeField(db_default=Now())
+        circumference = models.FloatField(db_default=2 * Pi())
+
+Minor features
+--------------
+
+:mod:`django.contrib.admin`
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+* The new :meth:`.AdminSite.get_log_entries` method allows customizing the
+  queryset for the site's listed log entries.
+
+* The ``django.contrib.admin.AllValuesFieldListFilter``,
+  ``ChoicesFieldListFilter``, ``RelatedFieldListFilter``, and
+  ``RelatedOnlyFieldListFilter`` admin filters now handle multi-valued query
+  parameters.
+
+* ``XRegExp`` is upgraded from version 3.2.0 to 5.1.1.
+
+* The new :meth:`.AdminSite.get_model_admin` method returns an admin class for
+  the given model class.
+
+:mod:`django.contrib.admindocs`
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+* ...
+
+:mod:`django.contrib.auth`
+~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+* The default iteration count for the PBKDF2 password hasher is increased from
+  600,000 to 720,000.
+
+* The new asynchronous functions are now provided, using an
+  ``a`` prefix: :func:`django.contrib.auth.aauthenticate`,
+  :func:`~.django.contrib.auth.aget_user`,
+  :func:`~.django.contrib.auth.alogin`, :func:`~.django.contrib.auth.alogout`,
+  and :func:`~.django.contrib.auth.aupdate_session_auth_hash`.
+
+* ``AuthenticationMiddleware`` now adds an :meth:`.HttpRequest.auser`
+  asynchronous method that returns the currently logged-in user.
+
+* The new :func:`django.contrib.auth.hashers.acheck_password` asynchronous
+  function and :meth:`.AbstractBaseUser.acheck_password` method allow
+  asynchronous checking of user passwords.
+
+:mod:`django.contrib.contenttypes`
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+* ...
+
+:mod:`django.contrib.gis`
+~~~~~~~~~~~~~~~~~~~~~~~~~
+
+* The new
+  :class:`ClosestPoint() <django.contrib.gis.db.models.functions.ClosestPoint>`
+  function returns a 2-dimensional point on the geometry that is closest to
+  another geometry.
+
+* :ref:`GIS aggregates <gis-aggregation-functions>` now support the ``filter``
+  argument.
+
+* Added support for GDAL 3.7.
+
+:mod:`django.contrib.messages`
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+* ...
+
+:mod:`django.contrib.postgres`
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+* The new :attr:`~.ExclusionConstraint.violation_error_code` attribute of
+  :class:`~django.contrib.postgres.constraints.ExclusionConstraint` allows
+  customizing the ``code`` of ``ValidationError`` raised during
+  :ref:`model validation <validating-objects>`.
+
+:mod:`django.contrib.redirects`
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+* ...
+
+:mod:`django.contrib.sessions`
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+* ...
+
+:mod:`django.contrib.sitemaps`
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+* ...
+
+:mod:`django.contrib.sites`
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+* ...
+
+:mod:`django.contrib.staticfiles`
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+* ...
+
+:mod:`django.contrib.syndication`
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+* ...
+
+Asynchronous views
+~~~~~~~~~~~~~~~~~~
+
+* Under ASGI, ``http.disconnect`` events are now handled. This allows views to
+  perform any necessary cleanup if a client disconnects before the response is
+  generated. See :ref:`async-handling-disconnect` for more details.
+
+Cache
+~~~~~
+
+* ...
+
+CSRF
+~~~~
+
+* ...
+
+Decorators
+~~~~~~~~~~
+
+* The following decorators now support wrapping asynchronous view functions:
+
+  * :func:`~django.views.decorators.cache.cache_control`
+  * :func:`~django.views.decorators.cache.never_cache`
+  * :func:`~django.views.decorators.common.no_append_slash`
+  * :func:`~django.views.decorators.csrf.csrf_exempt`
+  * :func:`~django.views.decorators.debug.sensitive_variables`
+  * :func:`~django.views.decorators.debug.sensitive_post_parameters`
+  * :func:`~django.views.decorators.http.condition`
+  * :func:`~django.views.decorators.http.etag`
+  * :func:`~django.views.decorators.http.last_modified`
+  * :func:`~django.views.decorators.http.require_http_methods`
+  * :func:`~django.views.decorators.http.require_GET`
+  * :func:`~django.views.decorators.http.require_POST`
+  * :func:`~django.views.decorators.http.require_safe`
+  * :func:`~django.views.decorators.vary.vary_on_cookie`
+  * :func:`~django.views.decorators.vary.vary_on_headers`
+  * ``xframe_options_deny()``
+  * ``xframe_options_sameorigin()``
+  * ``xframe_options_exempt()``
+
+Email
+~~~~~
+
+* ...
+
+Error Reporting
+~~~~~~~~~~~~~~~
+
+* :func:`~django.views.decorators.debug.sensitive_variables` and
+  :func:`~django.views.decorators.debug.sensitive_post_parameters` can now be
+  used with asynchronous functions.
+
+File Storage
+~~~~~~~~~~~~
+
+* ...
+
+File Uploads
+~~~~~~~~~~~~
+
+* ...
+
+Forms
+~~~~~
+
+* :attr:`.ChoiceField.choices` now accepts
+  :ref:`Choices classes <field-choices-enum-types>` directly instead of
+  requiring expansion with the ``choices`` attribute.
+
+* The new ``assume_scheme`` argument for :class:`~django.forms.URLField` allows
+  specifying a default URL scheme.
+
+* In order to improve accessibility and enable screen readers to associate form
+  fields with their help text, the form field now includes the
+  ``aria-describedby`` HTML attribute.
+
+Generic Views
+~~~~~~~~~~~~~
+
+* ...
+
+Internationalization
+~~~~~~~~~~~~~~~~~~~~
+
+* ...
+
+Logging
+~~~~~~~
+
+* ...
+
+Management Commands
+~~~~~~~~~~~~~~~~~~~
+
+* ...
+
+Migrations
+~~~~~~~~~~
+
+* ...
+
+Models
+~~~~~~
+
+* The new ``create_defaults`` argument of :meth:`.QuerySet.update_or_create`
+  and :meth:`.QuerySet.aupdate_or_create` methods allows specifying a different
+  field values for the create operation.
+
+* The new ``violation_error_code`` attribute of
+  :class:`~django.db.models.BaseConstraint`,
+  :class:`~django.db.models.CheckConstraint`, and
+  :class:`~django.db.models.UniqueConstraint` allows customizing the ``code``
+  of ``ValidationError`` raised during
+  :ref:`model validation <validating-objects>`.
+
+* :attr:`.Field.choices` now accepts
+  :ref:`Choices classes <field-choices-enum-types>` directly instead of
+  requiring expansion with the ``choices`` attribute.
+
+* The :ref:`force_insert <ref-models-force-insert>` argument of
+  :meth:`.Model.save` now allows specifying a tuple of parent classes that must
+  be forced to be inserted.
+
+* :meth:`.QuerySet.bulk_create` and :meth:`.QuerySet.abulk_create` methods now
+  set the primary key on each model instance when the ``update_conflicts``
+  parameter is enabled (if the database supports it).
+
+Pagination
+~~~~~~~~~~
+
+* The new :attr:`django.core.paginator.Paginator.error_messages` argument
+  allows customizing the error messages raised by :meth:`.Paginator.page`.
+
+Requests and Responses
+~~~~~~~~~~~~~~~~~~~~~~
+
+* ...
+
+Security
+~~~~~~~~
+
+* ...
+
+Serialization
+~~~~~~~~~~~~~
+
+* ...
+
+Signals
+~~~~~~~
+
+* The new :meth:`.Signal.asend` and :meth:`.Signal.asend_robust` methods allow
+  asynchronous signal dispatch. Signal receivers may be synchronous or
+  asynchronous, and will be automatically adapted to the correct calling style.
+
+Templates
+~~~~~~~~~
+
+* The new :tfilter:`escapeseq` template filter applies :tfilter:`escape` to
+  each element of a sequence.
+
+Tests
+~~~~~
+
+* :class:`~django.test.Client` and :class:`~django.test.AsyncClient` now
+  provide asynchronous methods, using an ``a`` prefix:
+  :meth:`~django.test.Client.asession`, :meth:`~django.test.Client.alogin`,
+  :meth:`~django.test.Client.aforce_login`, and
+  :meth:`~django.test.Client.alogout`.
+
+URLs
+~~~~
+
+* ...
+
+Utilities
+~~~~~~~~~
+
+* ...
+
+Validators
+~~~~~~~~~~
+
+* The new ``offset`` argument of
+  :class:`~django.core.validators.StepValueValidator` allows specifying an
+  offset for valid values.
+
+.. _backwards-incompatible-5.0:
+
+Backwards incompatible changes in 5.0
+=====================================
+
+Database backend API
+--------------------
+
+This section describes changes that may be needed in third-party database
+backends.
+
+* ``DatabaseFeatures.supports_expression_defaults`` should be set to ``False``
+  if the database doesn't support using database functions as defaults.
+
+* ``DatabaseFeatures.supports_default_keyword_in_insert`` should be set to
+  ``False`` if the database doesn't support the ``DEFAULT`` keyword in
+  ``INSERT`` queries.
+
+* ``DatabaseFeatures.supports_default_keyword_in_bulk insert`` should be set to
+  ``False`` if the database doesn't support the ``DEFAULT`` keyword in bulk
+  ``INSERT`` queries.
+
+:mod:`django.contrib.gis`
+-------------------------
+
+* Support for GDAL 2.2 and 2.3 is removed.
+
+* Support for GEOS 3.6 and 3.7 is removed.
+
+:mod:`django.contrib.sitemaps`
+------------------------------
+
+* The ``django.contrib.sitemaps.ping_google()`` function and the
+  ``ping_google`` management command are removed as the Google
+  Sitemaps ping endpoint is deprecated and will be removed in January 2024.
+
+* The ``django.contrib.sitemaps.SitemapNotFound`` exception class is removed.
+
+Using ``create_defaults__exact`` may now be required with ``QuerySet.update_or_create()``
+-----------------------------------------------------------------------------------------
+
+:meth:`.QuerySet.update_or_create` now supports the parameter
+``create_defaults``. As a consequence, any models that have a field named
+``create_defaults`` that are used with an ``update_or_create()`` should specify
+the field in the lookup with ``create_defaults__exact``.
+
+Miscellaneous
+-------------
+
+* The ``instance`` argument of the undocumented
+  ``BaseModelFormSet.save_existing()`` method is renamed to ``obj``.
+
+* The undocumented ``django.contrib.admin.helpers.checkbox`` is removed.
+
+* Integer fields are now validated as 64-bit integers on SQLite to match the
+  behavior of ``sqlite3``.
+
+* The undocumented ``Query.annotation_select_mask`` attribute is changed from a
+  set of strings to an ordered list of strings.
+
+* ``ImageField.update_dimension_fields()`` is no longer called on the
+  ``post_init`` signal if ``width_field`` and ``height_field`` are not set.
+
+* :class:`~django.db.models.functions.Now` database function now uses
+  ``LOCALTIMESTAMP`` instead of ``CURRENT_TIMESTAMP`` on Oracle.
+
+* :attr:`.AdminSite.site_header` is now rendered in a ``<div>`` tag instead of
+  ``<h1>``. Screen reader users rely on heading elements for navigation within
+  a page. Having two ``<h1>`` elements was confusing and the site header wasn't
+  helpful as it is repeated on all pages.
+
+* On databases without native support for the SQL ``XOR`` operator, ``^`` as
+  the exclusive or (``XOR``) operator now returns rows that are matched by an
+  odd number of operands rather than exactly one operand. This is consistent
+  with the behavior of MySQL, MariaDB, and Python.
+
+* The minimum supported version of ``asgiref`` is increased from 3.6.0 to
+  3.7.0.
+
+* The minimum supported version of ``selenium`` is increased from 3.8.0 to
+  4.8.0.
+
+* The ``AlreadyRegistered`` and ``NotRegistered`` exceptions are moved from
+  ``django.contrib.admin.sites`` to ``django.contrib.admin.exceptions``.
+
+.. _deprecated-features-5.0:
+
+Features deprecated in 5.0
+==========================
+
+Miscellaneous
+-------------
+
+* The ``DjangoDivFormRenderer`` and ``Jinja2DivFormRenderer`` transitional form
+  renderers are deprecated.
+
+* Passing positional arguments  ``name`` and ``violation_error_message`` to
+  :class:`~django.db.models.BaseConstraint` is deprecated in favor of
+  keyword-only arguments.
+
+* ``request`` is added to the signature of :meth:`.ModelAdmin.lookup_allowed`.
+  Support for ``ModelAdmin`` subclasses that do not accept this argument is
+  deprecated.
+
+* The ``get_joining_columns()`` method of ``ForeignObject`` and
+  ``ForeignObjectRel`` is deprecated. Starting with Django 6.0,
+  ``django.db.models.sql.datastructures.Join`` will no longer fallback to
+  ``get_joining_columns()``. Subclasses should implement
+  ``get_joining_fields()`` instead.
+
+* The ``ForeignObject.get_reverse_joining_columns()`` method is deprecated.
+
+* The default scheme for ``forms.URLField`` will change from ``"http"`` to
+  ``"https"`` in Django 6.0.
+
+* Support for calling ``format_html()`` without passing args or kwargs will be
+  removed.
+
+Features removed in 5.0
+=======================
+
+These features have reached the end of their deprecation cycle and are removed
+in Django 5.0.
+
+See :ref:`deprecated-features-4.0` for details on these changes, including how
+to remove usage of these features.
+
+* The ``SERIALIZE`` test setting is removed.
+
+* The undocumented ``django.utils.baseconv`` module is removed.
+
+* The undocumented ``django.utils.datetime_safe`` module is removed.
+
+* The default value of the ``USE_TZ`` setting is changed from ``False`` to
+  ``True``.
+
+* The default sitemap protocol for sitemaps built outside the context of a
+  request is changed from ``'http'`` to ``'https'``.
+
+* The ``extra_tests`` argument for ``DiscoverRunner.build_suite()`` and
+  ``DiscoverRunner.run_tests()`` is removed.
+
+* The ``django.contrib.postgres.aggregates.ArrayAgg``, ``JSONBAgg``, and
+  ``StringAgg`` aggregates no longer return ``[]``, ``[]``, and ``''``,
+  respectively, when there are no rows.
+
+* The ``USE_L10N`` setting is removed.
+
+* The ``USE_DEPRECATED_PYTZ`` transitional setting is removed.
+
+* Support for ``pytz`` timezones is removed.
+
+* The ``is_dst`` argument is removed from:
+
+  * ``QuerySet.datetimes()``
+  * ``django.utils.timezone.make_aware()``
+  * ``django.db.models.functions.Trunc()``
+  * ``django.db.models.functions.TruncSecond()``
+  * ``django.db.models.functions.TruncMinute()``
+  * ``django.db.models.functions.TruncHour()``
+  * ``django.db.models.functions.TruncDay()``
+  * ``django.db.models.functions.TruncWeek()``
+  * ``django.db.models.functions.TruncMonth()``
+  * ``django.db.models.functions.TruncQuarter()``
+  * ``django.db.models.functions.TruncYear()``
+
+* The ``django.contrib.gis.admin.GeoModelAdmin`` and ``OSMGeoAdmin`` classes
+  are removed.
+
+* The undocumented ``BaseForm._html_output()`` method is removed.
+
+* The ability to return a ``str``, rather than a ``SafeString``, when rendering
+  an ``ErrorDict`` and ``ErrorList`` is removed.
+
+See :ref:`deprecated-features-4.1` for details on these changes, including how
+to remove usage of these features.
+
+* The ``SitemapIndexItem.__str__()`` method is removed.
+
+* The ``CSRF_COOKIE_MASKED`` transitional setting is removed.
+
+* The ``name`` argument of ``django.utils.functional.cached_property()`` is
+  removed.
+
+* The ``opclasses`` argument of
+  ``django.contrib.postgres.constraints.ExclusionConstraint`` is removed.
+
+* The undocumented ability to pass ``errors=None`` to
+  ``SimpleTestCase.assertFormError()`` and ``assertFormsetError()`` is removed.
+
+* ``django.contrib.sessions.serializers.PickleSerializer`` is removed.
+
+* The usage of ``QuerySet.iterator()`` on a queryset that prefetches related
+  objects without providing the ``chunk_size`` argument is no longer allowed.
+
+* Passing unsaved model instances to related filters is no longer allowed.
+
+* ``created=True`` is required in the signature of
+  ``RemoteUserBackend.configure_user()`` subclasses.
+
+* Support for logging out via ``GET`` requests in the
+  ``django.contrib.auth.views.LogoutView`` and
+  ``django.contrib.auth.views.logout_then_login()`` is removed.
+
+* The ``django.utils.timezone.utc`` alias to ``datetime.timezone.utc`` is
+  removed.
+
+* Passing a response object and a form/formset name to
+  ``SimpleTestCase.assertFormError()`` and ``assertFormSetError()`` is no
+  longer allowed.
+
+* The ``django.contrib.gis.admin.OpenLayersWidget`` is removed.
+
++ The ``django.contrib.auth.hashers.CryptPasswordHasher`` is removed.
+
+* The ``"django/forms/default.html"`` and
+  ``"django/forms/formsets/default.html"`` templates are removed.
+
+* The default form and formset rendering style is changed to the div-based.
+
+* Passing ``nulls_first=False`` or ``nulls_last=False`` to ``Expression.asc()``
+  and ``Expression.desc()`` methods, and the ``OrderBy`` expression is no
+  longer allowed.

testbed/django__django/docs/releases/index.txt

@@ -0,0 +1,471 @@
+=============
+Release notes
+=============
+
+Release notes for the official Django releases. Each release note will tell you
+what's new in each version, and will also describe any backwards-incompatible
+changes made in that version.
+
+For those :doc:`upgrading to a new version of Django</howto/upgrade-version>`,
+you will need to check all the backwards-incompatible changes and
+:doc:`deprecated features</internals/deprecation>` for each 'final' release
+from the one after your current Django version, up to and including the new
+version.
+
+Final releases
+==============
+
+Below are release notes through Django |version| and its patch releases. Newer
+versions of the documentation contain the release notes for any later releases.
+
+.. _development_release_notes:
+
+5.0 release
+-----------
+.. toctree::
+   :maxdepth: 1
+
+   5.0
+
+4.2 release
+-----------
+
+.. toctree::
+   :maxdepth: 1
+
+   4.2.4
+   4.2.3
+   4.2.2
+   4.2.1
+   4.2
+
+4.1 release
+-----------
+.. toctree::
+   :maxdepth: 1
+
+   4.1.10
+   4.1.9
+   4.1.8
+   4.1.7
+   4.1.6
+   4.1.5
+   4.1.4
+   4.1.3
+   4.1.2
+   4.1.1
+   4.1
+
+4.0 release
+-----------
+.. toctree::
+   :maxdepth: 1
+
+   4.0.10
+   4.0.9
+   4.0.8
+   4.0.7
+   4.0.6
+   4.0.5
+   4.0.4
+   4.0.3
+   4.0.2
+   4.0.1
+   4.0
+
+3.2 release
+-----------
+.. toctree::
+   :maxdepth: 1
+
+   3.2.20
+   3.2.19
+   3.2.18
+   3.2.17
+   3.2.16
+   3.2.15
+   3.2.14
+   3.2.13
+   3.2.12
+   3.2.11
+   3.2.10
+   3.2.9
+   3.2.8
+   3.2.7
+   3.2.6
+   3.2.5
+   3.2.4
+   3.2.3
+   3.2.2
+   3.2.1
+   3.2
+
+3.1 release
+-----------
+.. toctree::
+   :maxdepth: 1
+
+   3.1.14
+   3.1.13
+   3.1.12
+   3.1.11
+   3.1.10
+   3.1.9
+   3.1.8
+   3.1.7
+   3.1.6
+   3.1.5
+   3.1.4
+   3.1.3
+   3.1.2
+   3.1.1
+   3.1
+
+3.0 release
+-----------
+.. toctree::
+   :maxdepth: 1
+
+   3.0.14
+   3.0.13
+   3.0.12
+   3.0.11
+   3.0.10
+   3.0.9
+   3.0.8
+   3.0.7
+   3.0.6
+   3.0.5
+   3.0.4
+   3.0.3
+   3.0.2
+   3.0.1
+   3.0
+
+2.2 release
+-----------
+.. toctree::
+   :maxdepth: 1
+
+   2.2.28
+   2.2.27
+   2.2.26
+   2.2.25
+   2.2.24
+   2.2.23
+   2.2.22
+   2.2.21
+   2.2.20
+   2.2.19
+   2.2.18
+   2.2.17
+   2.2.16
+   2.2.15
+   2.2.14
+   2.2.13
+   2.2.12
+   2.2.11
+   2.2.10
+   2.2.9
+   2.2.8
+   2.2.7
+   2.2.6
+   2.2.5
+   2.2.4
+   2.2.3
+   2.2.2
+   2.2.1
+   2.2
+
+2.1 release
+-----------
+.. toctree::
+   :maxdepth: 1
+
+   2.1.15
+   2.1.14
+   2.1.13
+   2.1.12
+   2.1.11
+   2.1.10
+   2.1.9
+   2.1.8
+   2.1.7
+   2.1.6
+   2.1.5
+   2.1.4
+   2.1.3
+   2.1.2
+   2.1.1
+   2.1
+
+2.0 release
+-----------
+.. toctree::
+   :maxdepth: 1
+
+   2.0.13
+   2.0.12
+   2.0.11
+   2.0.10
+   2.0.9
+   2.0.8
+   2.0.7
+   2.0.6
+   2.0.5
+   2.0.4
+   2.0.3
+   2.0.2
+   2.0.1
+   2.0
+
+1.11 release
+------------
+.. toctree::
+   :maxdepth: 1
+
+   1.11.29
+   1.11.28
+   1.11.27
+   1.11.26
+   1.11.25
+   1.11.24
+   1.11.23
+   1.11.22
+   1.11.21
+   1.11.20
+   1.11.19
+   1.11.18
+   1.11.17
+   1.11.16
+   1.11.15
+   1.11.14
+   1.11.13
+   1.11.12
+   1.11.11
+   1.11.10
+   1.11.9
+   1.11.8
+   1.11.7
+   1.11.6
+   1.11.5
+   1.11.4
+   1.11.3
+   1.11.2
+   1.11.1
+   1.11
+
+1.10 release
+------------
+.. toctree::
+   :maxdepth: 1
+
+   1.10.8
+   1.10.7
+   1.10.6
+   1.10.5
+   1.10.4
+   1.10.3
+   1.10.2
+   1.10.1
+   1.10
+
+1.9 release
+-----------
+.. toctree::
+   :maxdepth: 1
+
+   1.9.13
+   1.9.12
+   1.9.11
+   1.9.10
+   1.9.9
+   1.9.8
+   1.9.7
+   1.9.6
+   1.9.5
+   1.9.4
+   1.9.3
+   1.9.2
+   1.9.1
+   1.9
+
+1.8 release
+-----------
+.. toctree::
+   :maxdepth: 1
+
+   1.8.19
+   1.8.18
+   1.8.17
+   1.8.16
+   1.8.15
+   1.8.14
+   1.8.13
+   1.8.12
+   1.8.11
+   1.8.10
+   1.8.9
+   1.8.8
+   1.8.7
+   1.8.6
+   1.8.5
+   1.8.4
+   1.8.3
+   1.8.2
+   1.8.1
+   1.8
+
+1.7 release
+-----------
+.. toctree::
+   :maxdepth: 1
+
+   1.7.11
+   1.7.10
+   1.7.9
+   1.7.8
+   1.7.7
+   1.7.6
+   1.7.5
+   1.7.4
+   1.7.3
+   1.7.2
+   1.7.1
+   1.7
+
+1.6 release
+-----------
+.. toctree::
+   :maxdepth: 1
+
+   1.6.11
+   1.6.10
+   1.6.9
+   1.6.8
+   1.6.7
+   1.6.6
+   1.6.5
+   1.6.4
+   1.6.3
+   1.6.2
+   1.6.1
+   1.6
+
+1.5 release
+-----------
+.. toctree::
+   :maxdepth: 1
+
+   1.5.12
+   1.5.11
+   1.5.10
+   1.5.9
+   1.5.8
+   1.5.7
+   1.5.6
+   1.5.5
+   1.5.4
+   1.5.3
+   1.5.2
+   1.5.1
+   1.5
+
+1.4 release
+-----------
+.. toctree::
+   :maxdepth: 1
+
+   1.4.22
+   1.4.21
+   1.4.20
+   1.4.19
+   1.4.18
+   1.4.17
+   1.4.16
+   1.4.15
+   1.4.14
+   1.4.13
+   1.4.12
+   1.4.11
+   1.4.10
+   1.4.9
+   1.4.8
+   1.4.7
+   1.4.6
+   1.4.5
+   1.4.4
+   1.4.3
+   1.4.2
+   1.4.1
+   1.4
+
+1.3 release
+-----------
+.. toctree::
+   :maxdepth: 1
+
+   1.3.7
+   1.3.6
+   1.3.5
+   1.3.4
+   1.3.3
+   1.3.2
+   1.3.1
+   1.3
+
+1.2 release
+-----------
+.. toctree::
+   :maxdepth: 1
+
+   1.2.7
+   1.2.6
+   1.2.5
+   1.2.4
+   1.2.3
+   1.2.2
+   1.2.1
+   1.2
+
+1.1 release
+-----------
+.. toctree::
+   :maxdepth: 1
+
+   1.1.4
+   1.1.3
+   1.1.2
+   1.1
+
+1.0 release
+-----------
+.. toctree::
+   :maxdepth: 1
+
+   1.0.2
+   1.0.1
+   1.0
+
+Pre-1.0 releases
+----------------
+.. toctree::
+   :maxdepth: 1
+
+   0.96
+   0.95
+
+Security releases
+=================
+
+Whenever a security issue is disclosed via :doc:`Django's security
+policies </internals/security>`, appropriate release notes are now
+added to all affected release series.
+
+Additionally, :doc:`an archive of disclosed security issues
+</releases/security>` is maintained.
+
+.. toctree::
+   :hidden:
+
+   security

testbed/django__django/docs/releases/security.txt

@@ -0,0 +1,1422 @@
+==========================
+Archive of security issues
+==========================
+
+Django's development team is strongly committed to responsible
+reporting and disclosure of security-related issues, as outlined in
+:doc:`Django's security policies </internals/security>`.
+
+As part of that commitment, we maintain the following historical list
+of issues which have been fixed and disclosed. For each issue, the
+list below includes the date, a brief description, the `CVE identifier
+<https://en.wikipedia.org/wiki/Common_Vulnerabilities_and_Exposures>`_
+if applicable, a list of affected versions, a link to the full
+disclosure and links to the appropriate patch(es).
+
+Some important caveats apply to this information:
+
+* Lists of affected versions include only those versions of Django
+  which had stable, security-supported releases at the time of
+  disclosure. This means older versions (whose security support had
+  expired) and versions which were in pre-release (alpha/beta/RC)
+  states at the time of disclosure may have been affected, but are not
+  listed.
+
+* The Django project has on occasion issued security advisories,
+  pointing out potential security problems which can arise from
+  improper configuration or from other issues outside of Django
+  itself. Some of these advisories have received CVEs; when that is
+  the case, they are listed here, but as they have no accompanying
+  patches or releases, only the description, disclosure and CVE will
+  be listed.
+
+Issues under Django's security process
+======================================
+
+All security issues have been handled under versions of Django's security
+process. These are listed below.
+
+July 3, 2023 - :cve:`2023-36053`
+--------------------------------
+
+Potential regular expression denial of service vulnerability in
+``EmailValidator``/``URLValidator``. `Full description
+<https://www.djangoproject.com/weblog/2023/jul/03/security-releases/>`__
+
+* Django 4.2 :commit:`(patch) <b7c5feb35a31799de6e582ad6a5a91a9de74e0f9>`
+* Django 4.1 :commit:`(patch) <beb3f3d55940d9aa7198bf9d424ab74e873aec3d>`
+* Django 3.2 :commit:`(patch) <454f2fb93437f98917283336201b4048293f7582>`
+
+May 3, 2023 - :cve:`2023-31047`
+-------------------------------
+
+Potential bypass of validation when uploading multiple files using one form
+field. `Full description
+<https://www.djangoproject.com/weblog/2023/may/03/security-releases/>`__
+
+* Django 4.2 :commit:`(patch) <21b1b1fc03e5f9e9f8c977ee6e35618dd3b353dd>`
+* Django 4.1 :commit:`(patch) <e7c3a2ccc3a562328600be05068ed9149e12ce64>`
+* Django 3.2 :commit:`(patch) <eed53d0011622e70b936e203005f0e6f4ac48965>`
+
+February 14, 2023 - :cve:`2023-24580`
+-------------------------------------
+
+Potential denial-of-service vulnerability in file uploads. `Full description
+<https://www.djangoproject.com/weblog/2023/feb/14/security-releases/>`__
+
+* Django 4.1 :commit:`(patch) <628b33a854a9c68ec8a0c51f382f304a0044ec92>`
+* Django 4.0 :commit:`(patch) <83f1ea83e4553e211c1c5a0dfc197b66d4e50432>`
+* Django 3.2 :commit:`(patch) <a665ed5179f5bbd3db95ce67286d0192eff041d8>`
+
+February 1, 2023 - :cve:`2023-23969`
+------------------------------------
+
+Potential denial-of-service via ``Accept-Language`` headers. `Full description
+<https://www.djangoproject.com/weblog/2023/feb/01/security-releases/>`__
+
+* Django 4.1 :commit:`(patch) <9d7bd5a56b1ce0576e8e07a8001373576d277942>`
+* Django 4.0 :commit:`(patch) <4452642f193533e288a52c02efb5bbc766a68f95>`
+* Django 3.2 :commit:`(patch) <c7e0151fdf33e1b11d488b6f67b94fdf3a30614a>`
+
+October 4, 2022 - :cve:`2022-41323`
+-----------------------------------
+
+Potential denial-of-service vulnerability in internationalized URLs. `Full
+description
+<https://www.djangoproject.com/weblog/2022/oct/04/security-releases/>`__
+
+* Django 4.1 :commit:`(patch) <9d656ea51d9ea7105c0c0785783ac29d426a7d25>`
+* Django 4.0 :commit:`(patch) <23f0093125ac2e553da6c1b2f9988eb6a3dd2ea1>`
+* Django 3.2 :commit:`(patch) <5b6b257fa7ec37ff27965358800c67e2dd11c924>`
+
+August 3, 2022 - :cve:`2022-36359`
+----------------------------------
+
+Potential reflected file download vulnerability in FileResponse. `Full
+description
+<https://www.djangoproject.com/weblog/2022/aug/03/security-releases/>`__
+
+* Django 4.0 :commit:`(patch) <b7d9529cbe0af4adabb6ea5d01ed8dcce3668fb3>`
+* Django 3.2 :commit:`(patch) <b3e4494d759202a3b6bf247fd34455bf13be5b80>`
+
+July 4, 2022 - :cve:`2022-34265`
+--------------------------------
+
+Potential SQL injection via ``Trunc(kind)`` and ``Extract(lookup_name)``
+arguments. `Full description
+<https://www.djangoproject.com/weblog/2022/jul/04/security-releases/>`__
+
+* Django 4.0 :commit:`(patch) <0dc9c016fadb71a067e5a42be30164e3f96c0492>`
+* Django 3.2 :commit:`(patch) <a9010fe5555e6086a9d9ae50069579400ef0685e>`
+
+April 11, 2022 - :cve:`2022-28346`
+----------------------------------
+
+Potential SQL injection in ``QuerySet.annotate()``, ``aggregate()``, and
+``extra()``. `Full description
+<https://www.djangoproject.com/weblog/2022/apr/11/security-releases/>`__
+
+* Django 4.0 :commit:`(patch) <800828887a0509ad1162d6d407e94d8de7eafc60>`
+* Django 3.2 :commit:`(patch) <2044dac5c6968441be6f534c4139bcf48c5c7e48>`
+* Django 2.2 :commit:`(patch) <2c09e68ec911919360d5f8502cefc312f9e03c5d>`
+
+April 11, 2022 - :cve:`2022-28347`
+----------------------------------
+
+Potential SQL injection via ``QuerySet.explain(**options)`` on PostgreSQL.
+`Full description
+<https://www.djangoproject.com/weblog/2022/apr/11/security-releases/>`__
+
+* Django 4.0 :commit:`(patch) <00b0fc50e1738c7174c495464a5ef069408a4402>`
+* Django 3.2 :commit:`(patch) <9e19accb6e0a00ba77d5a95a91675bf18877c72d>`
+* Django 2.2 :commit:`(patch) <29a6c98b4c13af82064f993f0acc6e8fafa4d3f5>`
+
+February 1, 2022 - :cve:`2022-22818`
+------------------------------------
+
+Possible XSS via ``{% debug %}`` template tag. `Full description
+<https://www.djangoproject.com/weblog/2022/feb/01/security-releases/>`__
+
+Versions affected
+~~~~~~~~~~~~~~~~~
+
+* Django 4.0 :commit:`(patch) <01422046065d2b51f8f613409cad2c81b39487e5>`
+* Django 3.2 :commit:`(patch) <1a1e8278c46418bde24c86a65443b0674bae65e2>`
+* Django 2.2 :commit:`(patch) <c27a7eb9f40b64990398978152e62b6ff839c2e6>`
+
+February 1, 2022 - :cve:`2022-23833`
+------------------------------------
+
+Denial-of-service possibility in file uploads. `Full description
+<https://www.djangoproject.com/weblog/2022/feb/01/security-releases/>`__
+
+Versions affected
+~~~~~~~~~~~~~~~~~
+
+* Django 4.0 :commit:`(patch) <f9c7d48fdd6f198a6494a9202f90242f176e4fc9>`
+* Django 3.2 :commit:`(patch) <d16133568ef9c9b42cb7a08bdf9ff3feec2e5468>`
+* Django 2.2 :commit:`(patch) <c477b761804984c932704554ad35f78a2e230c6a>`
+
+January 4, 2022 - :cve:`2021-45452`
+------------------------------------
+
+Potential directory-traversal via ``Storage.save()``. `Full description
+<https://www.djangoproject.com/weblog/2022/jan/04/security-releases/>`__
+
+Versions affected
+~~~~~~~~~~~~~~~~~
+
+* Django 4.0 :commit:`(patch) <e1592e0f26302e79856cc7f2218ae848ae19b0f6>`
+* Django 3.2 :commit:`(patch) <8d2f7cff76200cbd2337b2cf1707e383eb1fb54b>`
+* Django 2.2 :commit:`(patch) <4cb35b384ceef52123fc66411a73c36a706825e1>`
+
+January 4, 2022 - :cve:`2021-45116`
+------------------------------------
+
+Potential information disclosure in ``dictsort`` template filter. `Full
+description
+<https://www.djangoproject.com/weblog/2022/jan/04/security-releases/>`__
+
+Versions affected
+~~~~~~~~~~~~~~~~~
+
+* Django 4.0 :commit:`(patch) <2a8ec7f546d6d5806e221ec948c5146b55bd7489>`
+* Django 3.2 :commit:`(patch) <c7fe895bca06daf12cc1670b56eaf72a1ef27a16>`
+* Django 2.2 :commit:`(patch) <c9f648ccfac5ab90fb2829a66da4f77e68c7f93a>`
+
+January 4, 2022 - :cve:`2021-45115`
+------------------------------------
+
+Denial-of-service possibility in ``UserAttributeSimilarityValidator``. `Full
+description
+<https://www.djangoproject.com/weblog/2022/jan/04/security-releases/>`__
+
+Versions affected
+~~~~~~~~~~~~~~~~~
+
+* Django 4.0 :commit:`(patch) <df79ef03ac867c93caaa6be56bc69e66abfeef8f>`
+* Django 3.2 :commit:`(patch) <a8b32fe13bcaed1c0b772fdc53de84abc224fb20>`
+* Django 2.2 :commit:`(patch) <2135637fdd5ce994de110affef9e67dffdf77277>`
+
+December 7, 2021 - :cve:`2021-44420`
+------------------------------------
+
+Potential bypass of an upstream access control based on URL paths. `Full
+description
+<https://www.djangoproject.com/weblog/2021/dec/07/security-releases/>`__
+
+Versions affected
+~~~~~~~~~~~~~~~~~
+
+* Django 3.2 :commit:`(patch) <333c65603032c377e682cdbd7388657a5463a05a>`
+* Django 3.1 :commit:`(patch) <22bd17488159601bf0741b70ae7932bffea8eced>`
+* Django 2.2 :commit:`(patch) <7cf7d74e8a754446eeb85cacf2fef1247e0cb6d7>`
+
+July 1, 2021 - :cve:`2021-35042`
+--------------------------------
+
+Potential SQL injection via unsanitized ``QuerySet.order_by()`` input. `Full
+description
+<https://www.djangoproject.com/weblog/2021/jul/01/security-releases/>`__
+
+Versions affected
+~~~~~~~~~~~~~~~~~
+
+* Django 3.2 :commit:`(patch) <a34a5f724c5d5adb2109374ba3989ebb7b11f81f>`
+* Django 3.1 :commit:`(patch) <0bd57a879a0d54920bb9038a732645fb917040e9>`
+
+June 2, 2021 - :cve:`2021-33203`
+--------------------------------
+
+Potential directory traversal via ``admindocs``. `Full description
+<https://www.djangoproject.com/weblog/2021/jun/02/security-releases/>`__
+
+Versions affected
+~~~~~~~~~~~~~~~~~
+
+* Django 3.2 :commit:`(patch) <dfaba12cda060b8b292ae1d271b44bf810b1c5b9>`
+* Django 3.1 :commit:`(patch) <20c67a0693c4ede2b09af02574823485e82e4c8f>`
+* Django 2.2 :commit:`(patch) <053cc9534d174dc89daba36724ed2dcb36755b90>`
+
+June 2, 2021 - :cve:`2021-33571`
+--------------------------------
+
+Possible indeterminate SSRF, RFI, and LFI attacks since validators accepted
+leading zeros in IPv4 addresses. `Full description
+<https://www.djangoproject.com/weblog/2021/jun/02/security-releases/>`__
+
+Versions affected
+~~~~~~~~~~~~~~~~~
+
+* Django 3.2 :commit:`(patch) <9f75e2e562fa0c0482f3dde6fc7399a9070b4a3d>`
+* Django 3.1 :commit:`(patch) <203d4ab9ebcd72fc4d6eb7398e66ed9e474e118e>`
+* Django 2.2 :commit:`(patch) <f27c38ab5d90f68c9dd60cabef248a570c0be8fc>`
+
+May 6, 2021 - :cve:`2021-32052`
+-------------------------------
+
+Header injection possibility since ``URLValidator`` accepted newlines in input
+on Python 3.9.5+. `Full description
+<https://www.djangoproject.com/weblog/2021/may/06/security-releases/>`__
+
+Versions affected
+~~~~~~~~~~~~~~~~~
+
+* Django 3.2 :commit:`(patch) <2d2c1d0c97832860fbd6597977e2aae17dd7e5b2>`
+* Django 3.1 :commit:`(patch) <afb23f5929944a407e4990edef1c7806a94c9879>`
+* Django 2.2 :commit:`(patch) <d9594c4ea57b6309d93879805302cec9ae9f23ff>`
+
+May 4, 2021 - :cve:`2021-31542`
+-------------------------------
+
+Potential directory-traversal via uploaded files. `Full description
+<https://www.djangoproject.com/weblog/2021/may/04/security-releases/>`__
+
+Versions affected
+~~~~~~~~~~~~~~~~~
+
+* Django 3.2 :commit:`(patch) <c98f446c188596d4ba6de71d1b77b4a6c5c2a007>`
+* Django 3.1 :commit:`(patch) <25d84d64122c15050a0ee739e859f22ddab5ac48>`
+* Django 2.2 :commit:`(patch) <04ac1624bdc2fa737188401757cf95ced122d26d>`
+
+April 6, 2021 - :cve:`2021-28658`
+---------------------------------
+
+Potential directory-traversal via uploaded files. `Full description
+<https://www.djangoproject.com/weblog/2021/apr/06/security-releases/>`__
+
+Versions affected
+~~~~~~~~~~~~~~~~~
+
+* Django 3.2 :commit:`(patch) <2820fd1be5dfccbf1216c3845fad8580502473e1>`
+* Django 3.1 :commit:`(patch) <cca0d98118cccf9ae0c6dcf2d6c57fc50469fbf0>`
+* Django 3.0 :commit:`(patch) <e7fba62248f604c76da4f23dcf1db4a57b0808ea>`
+* Django 2.2 :commit:`(patch) <4036d62bda0e9e9f6172943794b744a454ca49c2>`
+
+February 19, 2021 - :cve:`2021-23336`
+-------------------------------------
+
+Web cache poisoning via ``django.utils.http.limited_parse_qsl()``. `Full
+description
+<https://www.djangoproject.com/weblog/2021/feb/19/security-releases/>`__
+
+Versions affected
+~~~~~~~~~~~~~~~~~
+
+* Django 3.2 :commit:`(patch) <be8237c7cce24b06aabde0b97afce98ddabbe3b6>`
+* Django 3.1 :commit:`(patch) <8f6d431b08cbb418d9144b976e7b972546607851>`
+* Django 3.0 :commit:`(patch) <326a926beef869d3341bc9ef737887f0449b6b71>`
+* Django 2.2 :commit:`(patch) <fd6b6afd5959b638c62dbf4839ccff97e7f7dfda>`
+
+February 1, 2021 - :cve:`2021-3281`
+-----------------------------------
+
+Potential directory-traversal via ``archive.extract()``. `Full description
+<https://www.djangoproject.com/weblog/2021/feb/01/security-releases/>`__
+
+Versions affected
+~~~~~~~~~~~~~~~~~
+
+* Django 3.1 :commit:`(patch) <02e6592835b4559909aa3aaaf67988fef435f624>`
+* Django 3.0 :commit:`(patch) <52e409ed17287e9aabda847b6afe58be2fa9f86a>`
+* Django 2.2 :commit:`(patch) <21e7622dec1f8612c85c2fc37fe8efbfd3311e37>`
+
+September 1, 2020 - :cve:`2020-24584`
+-------------------------------------
+
+Permission escalation in intermediate-level directories of the file system
+cache on Python 3.7+. `Full description
+<https://www.djangoproject.com/weblog/2020/sep/01/security-releases/>`__
+
+Versions affected
+~~~~~~~~~~~~~~~~~
+
+* Django 3.1 :commit:`(patch) <2b099caa5923afa8cfb5f1e8c0d56b6e0e81915b>`
+* Django 3.0 :commit:`(patch) <cdb367c92a0ba72ddc0cbd13ff42b0e6df709554>`
+* Django 2.2 :commit:`(patch) <a3aebfdc8153dc230686b6d2454ccd32ed4c9e6f>`
+
+September 1, 2020 - :cve:`2020-24583`
+-------------------------------------
+
+Incorrect permissions on intermediate-level directories on Python 3.7+. `Full
+description
+<https://www.djangoproject.com/weblog/2020/sep/01/security-releases/>`__
+
+Versions affected
+~~~~~~~~~~~~~~~~~
+
+* Django 3.1 :commit:`(patch) <934430d22aa5d90c2ba33495ff69a6a1d997d584>`
+* Django 3.0 :commit:`(patch) <08892bffd275c79ee1f8f67639eb170aaaf1181e>`
+* Django 2.2 :commit:`(patch) <375657a71c889c588f723469bd868bd1d40c369f>`
+
+June 3, 2020 - :cve:`2020-13596`
+--------------------------------
+
+Possible XSS via admin ``ForeignKeyRawIdWidget``. `Full description
+<https://www.djangoproject.com/weblog/2020/jun/03/security-releases/>`__
+
+Versions affected
+~~~~~~~~~~~~~~~~~
+
+* Django 3.0 :commit:`(patch) <1f2dd37f6fcefdd10ed44cb233b2e62b520afb38>`
+* Django 2.2 :commit:`(patch) <6d61860b22875f358fac83d903dc629897934815>`
+
+June 3, 2020 - :cve:`2020-13254`
+--------------------------------
+
+Potential data leakage via malformed memcached keys. `Full description
+<https://www.djangoproject.com/weblog/2020/jun/03/security-releases/>`__
+
+Versions affected
+~~~~~~~~~~~~~~~~~
+
+* Django 3.0 :commit:`(patch) <84b2da5552e100ae3294f564f6c862fef8d0e693>`
+* Django 2.2 :commit:`(patch) <07e59caa02831c4569bbebb9eb773bdd9cb4b206>`
+
+March 4, 2020 - :cve:`2020-9402`
+--------------------------------
+
+Potential SQL injection via ``tolerance`` parameter in GIS functions and
+aggregates on Oracle. `Full description
+<https://www.djangoproject.com/weblog/2020/mar/04/security-releases/>`__
+
+Versions affected
+~~~~~~~~~~~~~~~~~
+
+* Django 3.0 :commit:`(patch) <26a5cf834526e291db00385dd33d319b8271fc4c>`
+* Django 2.2 :commit:`(patch) <fe886a3b58a93cfbe8864b485f93cb6d426cd1f2>`
+* Django 1.11 :commit:`(patch) <02d97f3c9a88adc890047996e5606180bd1c6166>`
+
+February 3, 2020 - :cve:`2020-7471`
+-----------------------------------
+
+Potential SQL injection via ``StringAgg(delimiter)``. `Full description
+<https://www.djangoproject.com/weblog/2020/feb/03/security-releases/>`__
+
+Versions affected
+~~~~~~~~~~~~~~~~~
+
+* Django 3.0 :commit:`(patch) <505826b469b16ab36693360da9e11fd13213421b>`
+* Django 2.2 :commit:`(patch) <c67a368c16e4680b324b4f385398d638db4d8147>`
+* Django 1.11 :commit:`(patch) <001b0634cd309e372edb6d7d95d083d02b8e37bd>`
+
+December 18, 2019 - :cve:`2019-19844`
+-------------------------------------
+
+Potential account hijack via password reset form. `Full description
+<https://www.djangoproject.com/weblog/2019/dec/18/security-releases/>`__
+
+Versions affected
+~~~~~~~~~~~~~~~~~
+
+* Django 3.0 :commit:`(patch) <302a4ff1e8b1c798aab97673909c7a3dfda42c26>`
+* Django 2.2 :commit:`(patch) <4d334bea06cac63dc1272abcec545b85136cca0e>`
+* Django 1.11 :commit:`(patch) <f4cff43bf921fcea6a29b726eb66767f67753fa2>`
+
+December 2, 2019 - :cve:`2019-19118`
+------------------------------------
+
+Privilege escalation in the Django admin. `Full description
+<https://www.djangoproject.com/weblog/2019/dec/02/security-releases/>`__
+
+Versions affected
+~~~~~~~~~~~~~~~~~
+
+* Django 3.0 :commit:`(patch) <092cd66cf3c3e175acce698d6ca2012068d878fa>`
+* Django 2.2 :commit:`(patch) <36f580a17f0b3cb087deadf3b65eea024f479c21>`
+* Django 2.1 :commit:`(patch) <103ebe2b5ff1b2614b85a52c239f471904d26244>`
+
+August 1, 2019 - :cve:`2019-14235`
+----------------------------------
+
+Potential memory exhaustion in ``django.utils.encoding.uri_to_iri()``. `Full
+description
+<https://www.djangoproject.com/weblog/2019/aug/01/security-releases/>`__
+
+Versions affected
+~~~~~~~~~~~~~~~~~
+
+* Django 2.2 :commit:`(patch) <cf694e6852b0da7799f8b53f1fb2f7d20cf17534>`
+* Django 2.1 :commit:`(patch) <5d50a2e5fa36ad23ab532fc54cf4073de84b3306>`
+* Django 1.11 :commit:`(patch) <869b34e9b3be3a4cfcb3a145f218ffd3f5e3fd79>`
+
+August 1, 2019 - :cve:`2019-14234`
+----------------------------------
+
+SQL injection possibility in key and index lookups for
+``JSONField``/``HStoreField``. `Full description
+<https://www.djangoproject.com/weblog/2019/aug/01/security-releases/>`__
+
+Versions affected
+~~~~~~~~~~~~~~~~~
+
+* Django 2.2 :commit:`(patch) <4f5b58f5cd3c57fee9972ab074f8dc6895d8f387>`
+* Django 2.1 :commit:`(patch) <f74b3ae3628c26e1b4f8db3d13a91d52a833a975>`
+* Django 1.11 :commit:`(patch) <ed682a24fca774818542757651bfba576c3fc3ef>`
+
+August 1, 2019 - :cve:`2019-14233`
+----------------------------------
+
+Denial-of-service possibility in ``strip_tags()``. `Full description
+<https://www.djangoproject.com/weblog/2019/aug/01/security-releases/>`__
+
+Versions affected
+~~~~~~~~~~~~~~~~~
+
+* Django 2.2 :commit:`(patch) <e34f3c0e9ee5fc9022428fe91640638bafd4cda7>`
+* Django 2.1 :commit:`(patch) <5ff8e791148bd451180124d76a55cb2b2b9556eb>`
+* Django 1.11 :commit:`(patch) <52479acce792ad80bb0f915f20b835f919993c72>`
+
+
+August 1, 2019 - :cve:`2019-14232`
+----------------------------------
+
+Denial-of-service possibility in ``django.utils.text.Truncator``. `Full
+description <https://www.djangoproject.com/weblog/2019/aug/01/security-releases/>`__
+
+Versions affected
+~~~~~~~~~~~~~~~~~
+
+* Django 2.2 :commit:`(patch) <c3289717c6f21a8cf23daff1c78c0c014b94041f>`
+* Django 2.1 :commit:`(patch) <c23723a1551340cc7d3126f04fcfd178fa224193>`
+* Django 1.11 :commit:`(patch) <42a66e969023c00536256469f0e8b8a099ef109d>`
+
+July 1, 2019 - :cve:`2019-12781`
+--------------------------------
+
+Incorrect HTTP detection with reverse-proxy connecting via HTTPS. `Full
+description <https://www.djangoproject.com/weblog/2019/jul/01/security-releases/>`__
+
+Versions affected
+~~~~~~~~~~~~~~~~~
+
+* Django 2.2 :commit:`(patch) <77706a3e4766da5d5fb75c4db22a0a59a28e6cd6>`
+* Django 2.1 :commit:`(patch) <1e40f427bb8d0fb37cc9f830096a97c36c97af6f>`
+* Django 1.11 :commit:`(patch) <32124fc41e75074141b05f10fc55a4f01ff7f050>`
+
+June 3, 2019 - :cve:`2019-12308`
+--------------------------------
+
+XSS via "Current URL" link generated by ``AdminURLFieldWidget``. `Full
+description <https://www.djangoproject.com/weblog/2019/jun/03/security-releases/>`__
+
+Versions affected
+~~~~~~~~~~~~~~~~~
+
+* Django 2.2 :commit:`(patch) <afddabf8428ddc89a332f7a78d0d21eaf2b5a673>`
+* Django 2.1 :commit:`(patch) <09186a13d975de6d049f8b3e05484f66b01ece62>`
+* Django 1.11 :commit:`(patch) <c238701859a52d584f349cce15d56c8e8137c52b>`
+
+June 3, 2019 - :cve:`2019-11358`
+--------------------------------
+
+Prototype pollution in bundled jQuery. `Full description
+<https://www.djangoproject.com/weblog/2019/jun/03/security-releases/>`__
+
+Versions affected
+~~~~~~~~~~~~~~~~~
+
+* Django 2.2 :commit:`(patch) <baaf187a4e354bf3976c51e2c83a0d2f8ee6e6ad>`
+* Django 2.1 :commit:`(patch) <95649bc08547a878cebfa1d019edec8cb1b80829>`
+
+February 11, 2019 - :cve:`2019-6975`
+------------------------------------
+
+Memory exhaustion in ``django.utils.numberformat.format()``. `Full description
+<https://www.djangoproject.com/weblog/2019/feb/11/security-releases/>`__
+
+Versions affected
+~~~~~~~~~~~~~~~~~
+
+* Django 2.1 :commit:`(patch) <40cd19055773705301c3428ed5e08a036d2091f3>`
+* Django 2.0 :commit:`(patch <1f42f82566c9d2d73aff1c42790d6b1b243f7676>` and
+  :commit:`correction) <392e040647403fc8007708d52ce01d915b014849>`
+* Django 1.11 :commit:`(patch) <0bbb560183fabf0533289700845dafa94951f227>`
+
+January 4, 2019 - :cve:`2019-3498`
+----------------------------------
+
+Content spoofing possibility in the default 404 page. `Full description
+<https://www.djangoproject.com/weblog/2019/jan/04/security-releases/>`__
+
+Versions affected
+~~~~~~~~~~~~~~~~~
+
+* Django 2.1 :commit:`(patch) <64d2396e83aedba3fcc84ca40f23fbd22f0b9b5b>`
+* Django 2.0 :commit:`(patch) <9f4ed7c94c62e21644ef5115e393ac426b886f2e>`
+* Django 1.11 :commit:`(patch) <1cd00fcf52d089ef0fe03beabd05d59df8ea052a>`
+
+October 1, 2018 - :cve:`2018-16984`
+-----------------------------------
+
+Password hash disclosure to "view only" admin users. `Full description
+<https://www.djangoproject.com/weblog/2018/oct/01/security-release/>`__
+
+Versions affected
+~~~~~~~~~~~~~~~~~
+
+* Django 2.1 :commit:`(patch) <c4bd5b597e0aa2432e4c867b86650f18af117851>`
+
+August 1, 2018 - :cve:`2018-14574`
+----------------------------------
+
+Open redirect possibility in ``CommonMiddleware``. `Full description
+<https://www.djangoproject.com/weblog/2018/aug/01/security-releases/>`__
+
+Versions affected
+~~~~~~~~~~~~~~~~~
+
+* Django 2.1 :commit:`(patch) <c4e5ff7fdb5fce447675e90291fd33fddd052b3c>`
+* Django 2.0 :commit:`(patch) <6fffc3c6d420e44f4029d5643f38d00a39b08525>`
+* Django 1.11 :commit:`(patch) <d6eaee092709aad477a9894598496c6deec532ff>`
+
+March 6, 2018 - :cve:`2018-7537`
+--------------------------------
+
+Denial-of-service possibility in ``truncatechars_html`` and
+``truncatewords_html`` template filters. `Full description
+<https://www.djangoproject.com/weblog/2018/mar/06/security-releases/>`__
+
+Versions affected
+~~~~~~~~~~~~~~~~~
+
+* Django 2.0 :commit:`(patch) <94c5da1d17a6b0d378866c66b605102c19f7988c>`
+* Django 1.11 :commit:`(patch) <a91436360b79a6ff995c3e5018bcc666dfaf1539>`
+* Django 1.8  :commit:`(patch) <d17974a287a6ea2e361daff88fcc004cbd6835fa>`
+
+March 6, 2018 - :cve:`2018-7536`
+--------------------------------
+
+Denial-of-service possibility in ``urlize`` and ``urlizetrunc`` template
+filters. `Full description
+<https://www.djangoproject.com/weblog/2018/mar/06/security-releases/>`__
+
+Versions affected
+~~~~~~~~~~~~~~~~~
+
+* Django 2.0 :commit:`(patch) <e157315da3ae7005fa0683ffc9751dbeca7306c8>`
+* Django 1.11 :commit:`(patch) <abf89d729f210c692a50e0ad3f75fb6bec6fae16>`
+* Django 1.8  :commit:`(patch) <1ca63a66ef3163149ad822701273e8a1844192c2>`
+
+February 1, 2018 - :cve:`2018-6188`
+-----------------------------------
+
+Information leakage in ``AuthenticationForm``. `Full description
+<https://www.djangoproject.com/weblog/2018/feb/01/security-releases/>`__
+
+Versions affected
+~~~~~~~~~~~~~~~~~
+
+* Django 2.0 :commit:`(patch) <c37bb28677295f6edda61d8ac461014ef0d3aeb2>`
+* Django 1.11 :commit:`(patch) <57b95fedad5e0b83fc9c81466b7d1751c6427aae>`
+
+September 5, 2017 - :cve:`2017-12794`
+-------------------------------------
+
+Possible XSS in traceback section of technical 500 debug page. `Full
+description <https://www.djangoproject.com/weblog/2017/sep/05/security-releases/>`__
+
+Versions affected
+~~~~~~~~~~~~~~~~~
+
+* Django 1.11 :commit:`(patch) <e35a0c56086924f331e9422daa266e907a4784cc>`
+* Django 1.10 :commit:`(patch) <58e08e80e362db79eb0fd775dc81faad90dca47a>`
+
+April 4, 2017 - :cve:`2017-7234`
+--------------------------------
+
+Open redirect vulnerability in ``django.views.static.serve()``. `Full
+description <https://www.djangoproject.com/weblog/2017/apr/04/security-releases/>`__
+
+Versions affected
+~~~~~~~~~~~~~~~~~
+
+* Django 1.10 :commit:`(patch) <2a9f6ef71b8e23fd267ee2be1be26dde8ab67037>`
+* Django 1.9 :commit:`(patch) <5f1ffb07afc1e59729ce2b283124116d6c0659e4>`
+* Django 1.8 :commit:`(patch) <4a6b945dffe8d10e7cec107d93e6efaebfbded29>`
+
+April 4, 2017 - :cve:`2017-7233`
+--------------------------------
+
+Open redirect and possible XSS attack via user-supplied numeric redirect URLs.
+`Full description <https://www.djangoproject.com/weblog/2017/apr/04/security-releases/>`__
+
+Versions affected
+~~~~~~~~~~~~~~~~~
+
+* Django 1.10 :commit:`(patch) <f824655bc2c50b19d2f202d7640785caabc82787>`
+* Django 1.9 :commit:`(patch) <254326cb3682389f55f886804d2c43f7b9f23e4f>`
+* Django 1.8 :commit:`(patch) <8339277518c7d8ec280070a780915304654e3b66>`
+
+November 1, 2016 - :cve:`2016-9014`
+-----------------------------------
+
+DNS rebinding vulnerability when ``DEBUG=True``. `Full description
+<https://www.djangoproject.com/weblog/2016/nov/01/security-releases/>`__
+
+Versions affected
+~~~~~~~~~~~~~~~~~
+
+* Django 1.10 :commit:`(patch) <884e113838e5a72b4b0ec9e5e87aa480f6aa4472>`
+* Django 1.9 :commit:`(patch) <45acd6d836895a4c36575f48b3fb36a3dae98d19>`
+* Django 1.8 :commit:`(patch) <c401ae9a7dfb1a94a8a61927ed541d6f93089587>`
+
+November 1, 2016 - :cve:`2016-9013`
+-----------------------------------
+
+User with hardcoded password created when running tests on Oracle. `Full
+description <https://www.djangoproject.com/weblog/2016/nov/01/security-releases/>`__
+
+Versions affected
+~~~~~~~~~~~~~~~~~
+
+* Django 1.10 :commit:`(patch) <34e10720d81b8d407aa14d763b6a7fe8f13b4f2e>`
+* Django 1.9 :commit:`(patch) <4844d86c7728c1a5a3bbce4ad336a8d32304072b>`
+* Django 1.8 :commit:`(patch) <70f99952965a430daf69eeb9947079aae535d2d0>`
+
+September 26, 2016 - :cve:`2016-7401`
+-------------------------------------
+
+CSRF protection bypass on a site with Google Analytics. `Full description
+<https://www.djangoproject.com/weblog/2016/sep/26/security-releases/>`__
+
+Versions affected
+~~~~~~~~~~~~~~~~~
+
+* Django 1.9 :commit:`(patch) <d1bc980db1c0fffd6d60677e62f70beadb9fe64a>`
+* Django 1.8 :commit:`(patch) <6118ab7d0676f0d622278e5be215f14fb5410b6a>`
+
+July 18, 2016 - :cve:`2016-6186`
+--------------------------------
+
+XSS in admin's add/change related popup. `Full description
+<https://www.djangoproject.com/weblog/2016/jul/18/security-releases/>`__
+
+Versions affected
+~~~~~~~~~~~~~~~~~
+
+* Django 1.9 :commit:`(patch) <d03bf6fe4e9bf5b07de62c1a271c4b41a7d3d158>`
+* Django 1.8 :commit:`(patch) <f68e5a99164867ab0e071a936470958ed867479d>`
+
+March 1, 2016 - :cve:`2016-2513`
+--------------------------------
+
+User enumeration through timing difference on password hasher work factor
+upgrade. `Full description
+<https://www.djangoproject.com/weblog/2016/mar/01/security-releases/>`__
+
+Versions affected
+~~~~~~~~~~~~~~~~~
+
+* Django 1.9 :commit:`(patch) <af7d09b0c5c6ab68e629fd9baf736f9dd203b18e>`
+* Django 1.8 :commit:`(patch) <f4e6e02f7713a6924d16540be279909ff4091eb6>`
+
+March 1, 2016 - :cve:`2016-2512`
+--------------------------------
+
+Malicious redirect and possible XSS attack via user-supplied redirect URLs
+containing basic auth. `Full description
+<https://www.djangoproject.com/weblog/2016/mar/01/security-releases/>`__
+
+Versions affected
+~~~~~~~~~~~~~~~~~
+
+* Django 1.9 :commit:`(patch) <fc6d147a63f89795dbcdecb0559256470fff4380>`
+* Django 1.8 :commit:`(patch) <382ab137312961ad62feb8109d70a5a581fe8350>`
+
+February 1, 2016 - :cve:`2016-2048`
+-----------------------------------
+
+User with "change" but not "add" permission can create objects for
+``ModelAdmin``’s with ``save_as=True``. `Full description
+<https://www.djangoproject.com/weblog/2016/feb/01/releases-192-and-189/>`__
+
+Versions affected
+~~~~~~~~~~~~~~~~~
+
+* Django 1.9 :commit:`(patch) <adbca5e4db42542575734b8e5d26961c8ada7265>`
+
+November 24, 2015 - :cve:`2015-8213`
+------------------------------------
+
+Settings leak possibility in ``date`` template filter. `Full description
+<https://www.djangoproject.com/weblog/2015/nov/24/security-releases-issued/>`__
+
+Versions affected
+~~~~~~~~~~~~~~~~~
+
+* Django 1.8 :commit:`(patch) <9f83fc2f66f5a0bac7c291aec55df66050bb6991>`
+* Django 1.7 :commit:`(patch) <8a01c6b53169ee079cb21ac5919fdafcc8c5e172>`
+
+August 18, 2015 - :cve:`2015-5963` / :cve:`2015-5964`
+-----------------------------------------------------
+
+Denial-of-service possibility in ``logout()`` view by filling session store.
+`Full description <https://www.djangoproject.com/weblog/2015/aug/18/security-releases/>`__
+
+Versions affected
+~~~~~~~~~~~~~~~~~
+
+* Django 1.8 :commit:`(patch) <2eb86b01d7b59be06076f6179a454d0fd0afaff6>`
+* Django 1.7 :commit:`(patch) <2f5485346ee6f84b4e52068c04e043092daf55f7>`
+* Django 1.4 :commit:`(patch) <575f59f9bc7c59a5e41a081d1f5f55fc859c5012>`
+
+July 8, 2015 - :cve:`2015-5145`
+-------------------------------
+
+Denial-of-service possibility in URL validation. `Full description
+<https://www.djangoproject.com/weblog/2015/jul/08/security-releases/>`__
+
+Versions affected
+~~~~~~~~~~~~~~~~~
+
+* Django 1.8 :commit:`(patch) <8f9a4d3a2bc42f14bb437defd30c7315adbff22c>`
+
+July 8, 2015 - :cve:`2015-5144`
+-------------------------------
+
+Header injection possibility since validators accept newlines in input. `Full
+description <https://www.djangoproject.com/weblog/2015/jul/08/security-releases/>`__
+
+Versions affected
+~~~~~~~~~~~~~~~~~
+
+* Django 1.8 :commit:`(patch) <574dd5e0b0fbb877ae5827b1603d298edc9bb2a0>`
+* Django 1.7 :commit:`(patch) <ae49b4d994656bc037513dcd064cb9ce5bb85649>`
+* Django 1.4 :commit:`(patch) <1ba1cdce7d58e6740fe51955d945b56ae51d072a>`
+
+July 8, 2015 - :cve:`2015-5143`
+-------------------------------
+
+Denial-of-service possibility by filling session store. `Full
+description <https://www.djangoproject.com/weblog/2015/jul/08/security-releases/>`__
+
+Versions affected
+~~~~~~~~~~~~~~~~~
+
+* Django 1.8 :commit:`(patch) <66d12d1ababa8f062857ee5eb43276493720bf16>`
+* Django 1.7 :commit:`(patch) <1828f4341ec53a8684112d24031b767eba557663>`
+* Django 1.4 :commit:`(patch) <2e47f3e401c29bc2ba5ab794d483cb0820855fb9>`
+
+May 20, 2015 - :cve:`2015-3982`
+-------------------------------
+
+Fixed session flushing in the cached_db backend. `Full description
+<https://www.djangoproject.com/weblog/2015/may/20/security-release/>`__
+
+Versions affected
+~~~~~~~~~~~~~~~~~
+
+* Django 1.8 :commit:`(patch) <31cb25adecba930bdeee4556709f5a1c42d88fd6>`
+
+March 18, 2015 - :cve:`2015-2317`
+---------------------------------
+
+Mitigated possible XSS attack via user-supplied redirect URLs. `Full
+description <https://www.djangoproject.com/weblog/2015/mar/18/security-releases/>`__
+
+Versions affected
+~~~~~~~~~~~~~~~~~
+
+* Django 1.4 :commit:`(patch) <2342693b31f740a422abf7267c53b4e7bc487c1b>`
+* Django 1.6 :commit:`(patch) <5510f070711540aaa8d3707776cd77494e688ef9>`
+* Django 1.7 :commit:`(patch) <2a4113dbd532ce952308992633d802dc169a75f1>`
+* Django 1.8 :commit:`(patch) <770427c2896a078925abfca2317486b284d22f04>`
+
+March 18, 2015 - :cve:`2015-2316`
+---------------------------------
+
+Denial-of-service possibility with ``strip_tags()``. `Full description
+<https://www.djangoproject.com/weblog/2015/mar/18/security-releases/>`__
+
+Versions affected
+~~~~~~~~~~~~~~~~~
+
+* Django 1.6 :commit:`(patch) <b6b3cb9899214a23ebb0f4ebf0e0b300b0ee524f>`
+* Django 1.7 :commit:`(patch) <e63363f8e075fa8d66326ad6a1cc3391cc95cd97>`
+* Django 1.8 :commit:`(patch) <5447709a571cd5d95971f1d5d21d4a7edcf85bbd>`
+
+March 9, 2015 - :cve:`2015-2241`
+--------------------------------
+
+XSS attack via properties in ``ModelAdmin.readonly_fields``. `Full description
+<https://www.djangoproject.com/weblog/2015/mar/09/security-releases/>`__
+
+Versions affected
+~~~~~~~~~~~~~~~~~
+
+* Django 1.7 :commit:`(patch) <d16e4e1d6f95e6f46bff53cc4fd0ab398b8e5059>`
+* Django 1.8 :commit:`(patch) <2654e1b93923bac55f12b4e66c5e39b16695ace5>`
+
+January 13, 2015 - :cve:`2015-0222`
+-----------------------------------
+
+Database denial-of-service with ``ModelMultipleChoiceField``. `Full description
+<https://www.djangoproject.com/weblog/2015/jan/13/security/>`__
+
+Versions affected
+~~~~~~~~~~~~~~~~~
+
+* Django 1.6 :commit:`(patch) <d7a06ee7e571b6dad07c0f5b519b1db02e2a476c>`
+* Django 1.7 :commit:`(patch) <bcfb47780ce7caecb409a9e9c1c314266e41d392>`
+
+January 13, 2015 - :cve:`2015-0221`
+-----------------------------------
+
+Denial-of-service attack against ``django.views.static.serve()``. `Full
+description <https://www.djangoproject.com/weblog/2015/jan/13/security/>`__
+
+Versions affected
+~~~~~~~~~~~~~~~~~
+
+* Django 1.4 :commit:`(patch) <d020da6646c5142bc092247d218a3d1ce3e993f7>`
+* Django 1.6 :commit:`(patch) <553779c4055e8742cc832ed525b9ee34b174934f>`
+* Django 1.7 :commit:`(patch) <818e59a3f0fbadf6c447754d202d88df025f8f2a>`
+
+January 13, 2015 - :cve:`2015-0220`
+-----------------------------------
+
+Mitigated possible XSS attack via user-supplied redirect URLs. `Full
+description <https://www.djangoproject.com/weblog/2015/jan/13/security/>`__
+
+Versions affected
+~~~~~~~~~~~~~~~~~
+
+* Django 1.4 :commit:`(patch) <4c241f1b710da6419d9dca160e80b23b82db7758>`
+* Django 1.6 :commit:`(patch) <72e0b033662faa11bb7f516f18a132728aa0ae28>`
+* Django 1.7 :commit:`(patch) <de67dedc771ad2edec15c1d00c083a1a084e1e89>`
+
+January 13, 2015 - :cve:`2015-0219`
+-----------------------------------
+
+WSGI header spoofing via underscore/dash conflation. `Full description
+<https://www.djangoproject.com/weblog/2015/jan/13/security/>`__
+
+Versions affected
+~~~~~~~~~~~~~~~~~
+
+* Django 1.4 :commit:`(patch) <4f6fffc1dc429f1ad428ecf8e6620739e8837450>`
+* Django 1.6 :commit:`(patch) <d7597b31d5c03106eeba4be14a33b32a5e25f4ee>`
+* Django 1.7 :commit:`(patch) <41b4bc73ee0da7b2e09f4af47fc1fd21144c710f>`
+
+August 20, 2014 - :cve:`2014-0483`
+----------------------------------
+
+Data leakage via querystring manipulation in admin.
+`Full description <https://www.djangoproject.com/weblog/2014/aug/20/security/>`__
+
+Versions affected
+~~~~~~~~~~~~~~~~~
+
+* Django 1.4 :commit:`(patch) <027bd348642007617518379f8b02546abacaa6e0>`
+* Django 1.5 :commit:`(patch) <2a446c896e7c814661fb9c4f212b071b2a7fa446>`
+* Django 1.6 :commit:`(patch) <f7c494f2506250b8cb5923714360a3642ed63e0f>`
+* Django 1.7 :commit:`(patch) <2b31342cdf14fc20e07c43d258f1e7334ad664a6>`
+
+August 20, 2014 - :cve:`2014-0482`
+----------------------------------
+
+``RemoteUserMiddleware`` session hijacking. `Full description
+<https://www.djangoproject.com/weblog/2014/aug/20/security/>`__
+
+Versions affected
+~~~~~~~~~~~~~~~~~
+
+* Django 1.4 :commit:`(patch) <c9e3b9949cd55f090591fbdc4a114fcb8368b6d9>`
+* Django 1.5 :commit:`(patch) <dd68f319b365f6cb38c5a6c106faf4f6142d7d88>`
+* Django 1.6 :commit:`(patch) <0268b855f9eab3377f2821164ef3e66037789e09>`
+* Django 1.7 :commit:`(patch) <1a45d059c70385fcd6f4a3955f3b4e4cc96d0150>`
+
+August 20, 2014 - :cve:`2014-0481`
+----------------------------------
+
+File upload denial of service. `Full description
+<https://www.djangoproject.com/weblog/2014/aug/20/security/>`__
+
+Versions affected
+~~~~~~~~~~~~~~~~~
+
+* Django 1.4 :commit:`(patch) <30042d475bf084c6723c6217a21598d9247a9c41>`
+* Django 1.5 :commit:`(patch) <26cd48e166ac4d84317c8ee6d63ac52a87e8da99>`
+* Django 1.6 :commit:`(patch) <dd0c3f4ee1a30c1a1e6055061c6ba6e58c6b54d1>`
+* Django 1.7 :commit:`(patch) <3123f8452cf49071be9110e277eea60ba0032216>`
+
+August 20, 2014 - :cve:`2014-0480`
+----------------------------------
+
+``reverse()`` can generate URLs pointing to other hosts. `Full description
+<https://www.djangoproject.com/weblog/2014/aug/20/security/>`__
+
+Versions affected
+~~~~~~~~~~~~~~~~~
+
+* Django 1.4 :commit:`(patch) <c2fe73133b62a1d9e8f7a6b43966570b14618d7e>`
+* Django 1.5 :commit:`(patch) <45ac9d4fb087d21902469fc22643f5201d41a0cd>`
+* Django 1.6 :commit:`(patch) <da051da8df5e69944745072611351d4cfc6435d5>`
+* Django 1.7 :commit:`(patch) <bf650a2ee78c6d1f4544a875dcc777cf27fe93e9>`
+
+May 18, 2014 - :cve:`2014-3730`
+-------------------------------
+
+Malformed URLs from user input incorrectly validated. `Full description
+<https://www.djangoproject.com/weblog/2014/may/14/security-releases-issued/>`__
+
+Versions affected
+~~~~~~~~~~~~~~~~~
+
+* Django 1.4 :commit:`(patch) <7feb54bbae3f637ab3c4dd4831d4385964f574df>`
+* Django 1.5 :commit:`(patch) <ad32c218850ad40972dcef57beb460f8c979dd6d>`
+* Django 1.6 :commit:`(patch) <601107524523bca02376a0ddc1a06c6fdb8f22f3>`
+* Django 1.7 :commit:`(patch) <e7b0cace455c2da24492660636bfd48c45a19cdf>`
+
+May 18, 2014 - :cve:`2014-1418`
+-------------------------------
+
+Caches may be allowed to store and serve private data. `Full description
+<https://www.djangoproject.com/weblog/2014/may/14/security-releases-issued/>`__
+
+Versions affected
+~~~~~~~~~~~~~~~~~
+
+* Django 1.4 :commit:`(patch) <28e23306aa53bbbb8fb87db85f99d970b051026c>`
+* Django 1.5 :commit:`(patch) <4001ec8698f577b973c5a540801d8a0bbea1205b>`
+* Django 1.6 :commit:`(patch) <1abcf3a808b35abae5d425ed4d44cb6e886dc769>`
+* Django 1.7 :commit:`(patch) <7fef18ba9e5a8b47bc24b5bb259c8bf3d3879f2a>`
+
+April 21, 2014 - :cve:`2014-0474`
+---------------------------------
+
+MySQL typecasting causes unexpected query results. `Full description
+<https://www.djangoproject.com/weblog/2014/apr/21/security/>`__
+
+Versions affected
+~~~~~~~~~~~~~~~~~
+
+* Django 1.4 :commit:`(patch) <aa80f498de6d687e613860933ac58433ab71ea4b>`
+* Django 1.5 :commit:`(patch) <985434fb1d6bf2335bf96c6ebf91c3674f1f399f>`
+* Django 1.6 :commit:`(patch) <5f0829a27e85d89ad8c433f5c6a7a7d17c9e9292>`
+* Django 1.7 :commit:`(patch) <34526c2f56b863c2103655a0893ac801667e86ea>`
+
+April 21, 2014 - :cve:`2014-0473`
+---------------------------------
+
+Caching of anonymous pages could reveal CSRF token. `Full description
+<https://www.djangoproject.com/weblog/2014/apr/21/security/>`__
+
+Versions affected
+~~~~~~~~~~~~~~~~~
+
+* Django 1.4 :commit:`(patch) <1170f285ddd6a94a65f911a27788ba49ca08c0b0>`
+* Django 1.5 :commit:`(patch) <6872f42757d7ef6a97e0b6ec5db4d2615d8a2bd8>`
+* Django 1.6 :commit:`(patch) <d63e20942f3024f24cb8cd85a49461ba8a9b6736>`
+* Django 1.7 :commit:`(patch) <380545bf85cbf17fc698d136815b7691f8d023ca>`
+
+April 21, 2014 - :cve:`2014-0472`
+---------------------------------
+
+Unexpected code execution using ``reverse()``. `Full description
+<https://www.djangoproject.com/weblog/2014/apr/21/security/>`__
+
+Versions affected
+~~~~~~~~~~~~~~~~~
+
+* Django 1.4 :commit:`(patch) <c1a8c420fe4b27fb2caf5e46d23b5712fc0ac535>`
+* Django 1.5 :commit:`(patch) <2a5bcb69f42b84464b24b5c835dca6467b6aa7f1>`
+* Django 1.6 :commit:`(patch) <4352a50871e239ebcdf64eee6f0b88e714015c1b>`
+* Django 1.7 :commit:`(patch) <546740544d7f69254a67b06a3fc7fa0c43512958>`
+
+September 14, 2013 - :cve:`2013-1443`
+-------------------------------------
+
+Denial-of-service via large passwords. `Full description
+<https://www.djangoproject.com/weblog/2013/sep/15/security/>`__
+
+Versions affected
+~~~~~~~~~~~~~~~~~
+
+* Django 1.4 :commit:`(patch <3f3d887a6844ec2db743fee64c9e53e04d39a368>` and :commit:`Python compatibility fix) <6903d1690a92aa040adfb0c8eb37cf62e4206714>`
+* Django 1.5 :commit:`(patch) <22b74fa09d7ccbc8c52270d648a0da7f3f0fa2bc>`
+
+September 10, 2013 - :cve:`2013-4315`
+-------------------------------------
+
+Directory-traversal via ``ssi`` template tag. `Full description
+<https://www.djangoproject.com/weblog/2013/sep/10/security-releases-issued/>`__
+
+Versions affected
+~~~~~~~~~~~~~~~~~
+
+* Django 1.4 :commit:`(patch) <87d2750b39f6f2d54b7047225521a44dcd37e896>`
+* Django 1.5 :commit:`(patch) <988b61c550d798f9a66d17ee0511fb7a9a7f33ca>`
+
+August 13, 2013 - :cve:`2013-6044`
+----------------------------------
+
+Possible XSS via unvalidated URL redirect schemes. `Full description
+<https://www.djangoproject.com/weblog/2013/aug/13/security-releases-issued/>`__
+
+Versions affected
+~~~~~~~~~~~~~~~~~
+
+* Django 1.4 :commit:`(patch) <ec67af0bd609c412b76eaa4cc89968a2a8e5ad6a>`
+* Django 1.5 :commit:`(patch) <1a274ccd6bc1afbdac80344c9b6e5810c1162b5f>`
+
+August 13, 2013 - :cve:`2013-4249`
+----------------------------------
+
+XSS via admin trusting ``URLField`` values. `Full description
+<https://www.djangoproject.com/weblog/2013/aug/13/security-releases-issued/>`__
+
+Versions affected
+~~~~~~~~~~~~~~~~~
+
+* Django 1.5 :commit:`(patch) <90363e388c61874add3f3557ee654a996ec75d78>`
+
+February 19, 2013 - :cve:`2013-0306`
+------------------------------------
+
+Denial-of-service via formset ``max_num`` bypass. `Full description
+<https://www.djangoproject.com/weblog/2013/feb/19/security/>`__
+
+Versions affected
+~~~~~~~~~~~~~~~~~
+
+* Django 1.3 :commit:`(patch) <d7094bbce8cb838f3b40f504f198c098ff1cf727>`
+* Django 1.4 :commit:`(patch) <0cc350a896f70ace18280410eb616a9197d862b0>`
+
+February 19, 2013 - :cve:`2013-0305`
+------------------------------------
+
+Information leakage via admin history log. `Full description
+<https://www.djangoproject.com/weblog/2013/feb/19/security/>`__
+
+Versions affected
+~~~~~~~~~~~~~~~~~
+
+* Django 1.3 :commit:`(patch) <d3a45e10c8ac8268899999129daa27652ec0da35>`
+* Django 1.4 :commit:`(patch) <0e7861aec73702f7933ce2a93056f7983939f0d6>`
+
+February 19, 2013 - :cve:`2013-1664` / :cve:`2013-1665`
+-------------------------------------------------------
+
+Entity-based attacks against Python XML libraries. `Full description
+<https://www.djangoproject.com/weblog/2013/feb/19/security/>`__
+
+Versions affected
+~~~~~~~~~~~~~~~~~
+
+* Django 1.3 :commit:`(patch) <d19a27066b2247102e65412aa66917aff0091112>`
+* Django 1.4 :commit:`(patch) <1c60d07ba23e0350351c278ad28d0bd5aa410b40>`
+
+February 19, 2013 - No CVE
+--------------------------
+
+Additional hardening of ``Host`` header handling. `Full description
+<https://www.djangoproject.com/weblog/2013/feb/19/security/>`__
+
+Versions affected
+~~~~~~~~~~~~~~~~~
+
+* Django 1.3 :commit:`(patch) <27cd872e6e36a81d0bb6f5b8765a1705fecfc253>`
+* Django 1.4 :commit:`(patch) <9936fdb11d0bbf0bd242f259bfb97bbf849d16f8>`
+
+December 10, 2012 - No CVE 2
+----------------------------
+
+Additional hardening of redirect validation. `Full description
+<https://www.djangoproject.com/weblog/2012/dec/10/security/>`__
+
+Versions affected
+~~~~~~~~~~~~~~~~~
+
+* Django 1.3: :commit:`(patch) <1515eb46daa0897ba5ad5f0a2db8969255f1b343>`
+* Django 1.4: :commit:`(patch) <b2ae0a63aeec741f1e51bac9a95a27fd635f9652>`
+
+December 10, 2012 - No CVE 1
+----------------------------
+
+Additional hardening of ``Host`` header handling. `Full description
+<https://www.djangoproject.com/weblog/2012/dec/10/security/>`__
+
+Versions affected
+~~~~~~~~~~~~~~~~~
+
+* Django 1.3 :commit:`(patch) <2da4ace0bc1bc1d79bf43b368cb857f6f0cd6b1b>`
+* Django 1.4 :commit:`(patch) <319627c184e71ae267d6b7f000e293168c7b6e09>`
+
+October 17, 2012 - :cve:`2012-4520`
+-----------------------------------
+
+``Host`` header poisoning. `Full description
+<https://www.djangoproject.com/weblog/2012/oct/17/security/>`__
+
+Versions affected
+~~~~~~~~~~~~~~~~~
+
+* Django 1.3 :commit:`(patch) <b45c377f8f488955e0c7069cad3f3dd21910b071>`
+* Django 1.4 :commit:`(patch) <92d3430f12171f16f566c9050c40feefb830a4a3>`
+
+July 30, 2012 - :cve:`2012-3444`
+--------------------------------
+
+Denial-of-service via large image files. `Full description
+<https://www.djangoproject.com/weblog/2012/jul/30/security-releases-issued/>`__
+
+Versions affected
+~~~~~~~~~~~~~~~~~
+
+* Django 1.3 :commit:`(patch) <9ca0ff6268eeff92d0d0ac2c315d4b6a8e229155>`
+* Django 1.4 :commit:`(patch) <da33d67181b53fe6cc737ac1220153814a1509f6>`
+
+July 30, 2012 - :cve:`2012-3443`
+--------------------------------
+
+Denial-of-service via compressed image files. `Full description
+<https://www.djangoproject.com/weblog/2012/jul/30/security-releases-issued/>`__
+
+Versions affected
+~~~~~~~~~~~~~~~~~
+
+* Django 1.3: :commit:`(patch) <b2eb4787a0fff9c9993b78be5c698e85108f3446>`
+* Django 1.4: :commit:`(patch) <c14f325c4eef628bc7bfd8873c3a72aeb0219141>`
+
+July 30, 2012 - :cve:`2012-3442`
+--------------------------------
+
+XSS via failure to validate redirect scheme. `Full description
+<https://www.djangoproject.com/weblog/2012/jul/30/security-releases-issued/>`__
+
+Versions affected
+~~~~~~~~~~~~~~~~~
+
+* Django 1.3: :commit:`(patch) <4dea4883e6c50d75f215a6b9bcbd95273f57c72d>`
+* Django 1.4: :commit:`(patch) <e34685034b60be1112160e76091e5aee60149fa1>`
+
+September 9, 2011 - :cve:`2011-4140`
+------------------------------------
+
+Potential CSRF via ``Host`` header. `Full description
+<https://www.djangoproject.com/weblog/2011/sep/09/security-releases-issued/>`__
+
+Versions affected
+~~~~~~~~~~~~~~~~~
+
+This notification was an advisory only, so no patches were issued.
+
+* Django 1.2
+* Django 1.3
+
+September 9, 2011 - :cve:`2011-4139`
+------------------------------------
+
+``Host`` header cache poisoning. `Full description
+<https://www.djangoproject.com/weblog/2011/sep/09/security-releases-issued/>`__
+
+Versions affected
+~~~~~~~~~~~~~~~~~
+
+* Django 1.2 :commit:`(patch) <c613af4d6485586c79d692b70a9acac429f3ca9d>`
+* Django 1.3 :commit:`(patch) <2f7fadc38efa58ac0a8f93f936b82332a199f396>`
+
+September 9, 2011 - :cve:`2011-4138`
+------------------------------------
+
+Information leakage/arbitrary request issuance via ``URLField.verify_exists``.
+`Full description
+<https://www.djangoproject.com/weblog/2011/sep/09/security-releases-issued/>`__
+
+Versions affected
+~~~~~~~~~~~~~~~~~
+
+* Django 1.2: :commit:`(patch) <7268f8af86186518821d775c530d5558fd726930>`
+* Django 1.3: :commit:`(patch) <1a76dbefdfc60e2d5954c0ba614c3d054ba9c3f0>`
+
+September 9, 2011 - :cve:`2011-4137`
+------------------------------------
+
+Denial-of-service via ``URLField.verify_exists``. `Full description
+<https://www.djangoproject.com/weblog/2011/sep/09/security-releases-issued/>`__
+
+Versions affected
+~~~~~~~~~~~~~~~~~
+
+* Django 1.2 :commit:`(patch) <7268f8af86186518821d775c530d5558fd726930>`
+* Django 1.3 :commit:`(patch) <1a76dbefdfc60e2d5954c0ba614c3d054ba9c3f0>`
+
+September 9, 2011 - :cve:`2011-4136`
+------------------------------------
+
+Session manipulation when using memory-cache-backed session. `Full description
+<https://www.djangoproject.com/weblog/2011/sep/09/security-releases-issued/>`__
+
+Versions affected
+~~~~~~~~~~~~~~~~~
+
+* Django 1.2 :commit:`(patch) <ac7c3a110f906e4dfed3a17451bf7fd9fcb81296>`
+* Django 1.3 :commit:`(patch) <fbe2eead2fa9d808658ca582241bcacb02618840>`
+
+February 8, 2011 - :cve:`2011-0698`
+-----------------------------------
+
+Directory-traversal on Windows via incorrect path-separator handling. `Full
+description <https://www.djangoproject.com/weblog/2011/feb/08/security/>`__
+
+Versions affected
+~~~~~~~~~~~~~~~~~
+
+* Django 1.1 :commit:`(patch) <570a32a047ea56265646217264b0d3dab1a14dbd>`
+* Django 1.2 :commit:`(patch) <194566480b15cf4e294d3f03ff587019b74044b2>`
+
+February 8, 2011 - :cve:`2011-0697`
+-----------------------------------
+
+XSS via unsanitized names of uploaded files. `Full description
+<https://www.djangoproject.com/weblog/2011/feb/08/security/>`__
+
+Versions affected
+~~~~~~~~~~~~~~~~~
+
+* Django 1.1 :commit:`(patch) <1966786d2dde73e17f39cf340eb33fcb5d73904e>`
+* Django 1.2 :commit:`(patch) <1f814a9547842dcfabdae09573055984af9d3fab>`
+
+February 8, 2011 - :cve:`2011-0696`
+-----------------------------------
+
+CSRF via forged HTTP headers. `Full description
+<https://www.djangoproject.com/weblog/2011/feb/08/security/>`__
+
+Versions affected
+~~~~~~~~~~~~~~~~~
+
+* Django 1.1 :commit:`(patch) <408c5c873ce1437c7eee9544ff279ecbad7e150a>`
+* Django 1.2 :commit:`(patch) <818e70344e7193f6ebc73c82ed574e6ce3c91afc>`
+
+December 22, 2010 - :cve:`2010-4535`
+------------------------------------
+
+Denial-of-service in password-reset mechanism. `Full description
+<https://www.djangoproject.com/weblog/2010/dec/22/security/>`__
+
+Versions affected
+~~~~~~~~~~~~~~~~~
+
+* Django 1.1 :commit:`(patch) <7f8dd9cbac074389af8d8fd235bf2cb657227b9a>`
+* Django 1.2 :commit:`(patch) <d5d8942a160685c403d381a279e72e09de5489a9>`
+
+December 22, 2010 - :cve:`2010-4534`
+------------------------------------
+
+Information leakage in administrative interface. `Full description
+<https://www.djangoproject.com/weblog/2010/dec/22/security/>`__
+
+Versions affected
+~~~~~~~~~~~~~~~~~
+
+* Django 1.1 :commit:`(patch) <17084839fd7e267da5729f2a27753322b9d415a0>`
+* Django 1.2 :commit:`(patch) <85207a245bf09fdebe486b4c7bbcb65300f2a693>`
+
+September 8, 2010 - :cve:`2010-3082`
+------------------------------------
+
+XSS via trusting unsafe cookie value. `Full description
+<https://www.djangoproject.com/weblog/2010/sep/08/security-release/>`__
+
+Versions affected
+~~~~~~~~~~~~~~~~~
+
+* Django 1.2 :commit:`(patch) <7f84657b6b2243cc787bdb9f296710c8d13ad0bd>`
+
+October 9, 2009 - :cve:`2009-3965`
+----------------------------------
+
+Denial-of-service via pathological regular expression performance. `Full
+description <https://www.djangoproject.com/weblog/2009/oct/09/security/>`__
+
+Versions affected
+~~~~~~~~~~~~~~~~~
+
+* Django 1.0 :commit:`(patch) <594a28a9044120bed58671dde8a805c9e0f6c79a>`
+* Django 1.1 :commit:`(patch) <e3e992e18b368fcd56aabafc1b5bf80a6e11b495>`
+
+July 28, 2009 - :cve:`2009-2659`
+--------------------------------
+
+Directory-traversal in development server media handler. `Full description
+<https://www.djangoproject.com/weblog/2009/jul/28/security/>`__
+
+Versions affected
+~~~~~~~~~~~~~~~~~
+
+* Django 0.96 :commit:`(patch) <da85d76fd6ca846f3b0ff414e042ddb5e62e2e69>`
+* Django 1.0 :commit:`(patch) <df7f917b7f51ba969faa49d000ffc79572c5dcb4>`
+
+September 2, 2008 - :cve:`2008-3909`
+------------------------------------
+
+CSRF via preservation of POST data during admin login. `Full description
+<https://www.djangoproject.com/weblog/2008/sep/02/security/>`__
+
+Versions affected
+~~~~~~~~~~~~~~~~~
+
+* Django 0.91 :commit:`(patch) <44debfeaa4473bd28872c735dd3d9afde6886752>`
+* Django 0.95 :commit:`(patch) <aee48854a164382c655acb9f18b3c06c3d238e81>`
+* Django 0.96 :commit:`(patch) <7e0972bded362bc4b851c109df2c8a6548481a8e>`
+
+May 14, 2008 - :cve:`2008-2302`
+-------------------------------
+
+XSS via admin login redirect. `Full description
+<https://www.djangoproject.com/weblog/2008/may/14/security/>`__
+
+Versions affected
+~~~~~~~~~~~~~~~~~
+
+* Django 0.91 :commit:`(patch) <6e657e2c404a96e744748209e896d8a69c15fdf2>`
+* Django 0.95 :commit:`(patch) <50ce7fb57d79e8940ccf6e2781f2f01df029b5c5>`
+* Django 0.96 :commit:`(patch) <7791e5c050cebf86d868c5dab7092185b125fdc9>`
+
+October 26, 2007 - :cve:`2007-5712`
+-----------------------------------
+
+Denial-of-service via arbitrarily-large ``Accept-Language`` header. `Full
+description <https://www.djangoproject.com/weblog/2007/oct/26/security-fix/>`__
+
+Versions affected
+~~~~~~~~~~~~~~~~~
+
+* Django 0.91 :commit:`(patch) <8bc36e726c9e8c75c681d3ad232df8e882aaac81>`
+* Django 0.95 :commit:`(patch) <412ed22502e11c50dbfee854627594f0e7e2c234>`
+* Django 0.96 :commit:`(patch) <7dd2dd08a79e388732ce00e2b5514f15bd6d0f6f>`
+
+Issues prior to Django's security process
+=========================================
+
+Some security issues were handled before Django had a formalized
+security process in use. For these, new releases may not have been
+issued at the time and CVEs may not have been assigned.
+
+January 21, 2007 - :cve:`2007-0405`
+-----------------------------------
+
+Apparent "caching" of authenticated user. `Full description
+<https://www.djangoproject.com/weblog/2007/jan/21/0951/>`__
+
+Versions affected
+~~~~~~~~~~~~~~~~~
+
+* Django 0.95 :commit:`(patch) <e89f0a65581f82a5740bfe989136cea75d09cd67>`
+
+August 16, 2006 - :cve:`2007-0404`
+----------------------------------
+
+Filename validation issue in translation framework. `Full description
+<https://www.djangoproject.com/weblog/2006/aug/16/compilemessages/>`__
+
+Versions affected
+~~~~~~~~~~~~~~~~~
+
+* Django 0.90 :commit:`(patch) <6eefa521be3c658dc0b38f8d62d52e9801e198ab>`
+* Django 0.91 :commit:`(patch) <d31e39173c29537e6a1613278c93634c18a3206e>`
+* Django 0.95 :commit:`(patch) <a132d411c6986418ee6c0edc331080aa792fee6e>`
+  (released January 21 2007)

testbed/django__django/docs/topics/auth/customizing.txt

@@ -0,0 +1,1213 @@
+====================================
+Customizing authentication in Django
+====================================
+
+The authentication that comes with Django is good enough for most common cases,
+but you may have needs not met by the out-of-the-box defaults. Customizing
+authentication in your projects requires understanding what points of the
+provided system are extensible or replaceable. This document provides details
+about how the auth system can be customized.
+
+:ref:`Authentication backends <authentication-backends>` provide an extensible
+system for when a username and password stored with the user model need to be
+authenticated against a different service than Django's default.
+
+You can give your models :ref:`custom permissions <custom-permissions>` that
+can be checked through Django's authorization system.
+
+You can :ref:`extend <extending-user>` the default ``User`` model, or
+:ref:`substitute <auth-custom-user>` a completely customized model.
+
+.. _authentication-backends:
+
+Other authentication sources
+============================
+
+There may be times you have the need to hook into another authentication source
+-- that is, another source of usernames and passwords or authentication
+methods.
+
+For example, your company may already have an LDAP setup that stores a username
+and password for every employee. It'd be a hassle for both the network
+administrator and the users themselves if users had separate accounts in LDAP
+and the Django-based applications.
+
+So, to handle situations like this, the Django authentication system lets you
+plug in other authentication sources. You can override Django's default
+database-based scheme, or you can use the default system in tandem with other
+systems.
+
+See the :ref:`authentication backend reference
+<authentication-backends-reference>` for information on the authentication
+backends included with Django.
+
+Specifying authentication backends
+----------------------------------
+
+Behind the scenes, Django maintains a list of "authentication backends" that it
+checks for authentication. When somebody calls
+:func:`django.contrib.auth.authenticate()` -- as described in :ref:`How to log
+a user in <how-to-log-a-user-in>` -- Django tries authenticating across
+all of its authentication backends. If the first authentication method fails,
+Django tries the second one, and so on, until all backends have been attempted.
+
+The list of authentication backends to use is specified in the
+:setting:`AUTHENTICATION_BACKENDS` setting. This should be a list of Python
+path names that point to Python classes that know how to authenticate. These
+classes can be anywhere on your Python path.
+
+By default, :setting:`AUTHENTICATION_BACKENDS` is set to::
+
+    ["django.contrib.auth.backends.ModelBackend"]
+
+That's the basic authentication backend that checks the Django users database
+and queries the built-in permissions. It does not provide protection against
+brute force attacks via any rate limiting mechanism. You may either implement
+your own rate limiting mechanism in a custom auth backend, or use the
+mechanisms provided by most web servers.
+
+The order of :setting:`AUTHENTICATION_BACKENDS` matters, so if the same
+username and password is valid in multiple backends, Django will stop
+processing at the first positive match.
+
+If a backend raises a :class:`~django.core.exceptions.PermissionDenied`
+exception, authentication will immediately fail. Django won't check the
+backends that follow.
+
+.. note::
+
+    Once a user has authenticated, Django stores which backend was used to
+    authenticate the user in the user's session, and reuses the same backend
+    for the duration of that session whenever access to the currently
+    authenticated user is needed. This effectively means that authentication
+    sources are cached on a per-session basis, so if you change
+    :setting:`AUTHENTICATION_BACKENDS`, you'll need to clear out session data if
+    you need to force users to re-authenticate using different methods. A
+    simple way to do that is to execute ``Session.objects.all().delete()``.
+
+Writing an authentication backend
+---------------------------------
+
+An authentication backend is a class that implements two required methods:
+``get_user(user_id)`` and ``authenticate(request, **credentials)``, as well as
+a set of optional permission related :ref:`authorization methods
+<authorization_methods>`.
+
+The ``get_user`` method takes a ``user_id`` -- which could be a username,
+database ID or whatever, but has to be the primary key of your user object --
+and returns a user object or ``None``.
+
+The ``authenticate`` method takes a ``request`` argument and credentials as
+keyword arguments. Most of the time, it'll look like this::
+
+    from django.contrib.auth.backends import BaseBackend
+
+
+    class MyBackend(BaseBackend):
+        def authenticate(self, request, username=None, password=None):
+            # Check the username/password and return a user.
+            ...
+
+But it could also authenticate a token, like so::
+
+    from django.contrib.auth.backends import BaseBackend
+
+
+    class MyBackend(BaseBackend):
+        def authenticate(self, request, token=None):
+            # Check the token and return a user.
+            ...
+
+Either way, ``authenticate()`` should check the credentials it gets and return
+a user object that matches those credentials if the credentials are valid. If
+they're not valid, it should return ``None``.
+
+``request`` is an :class:`~django.http.HttpRequest` and may be ``None`` if it
+wasn't provided to :func:`~django.contrib.auth.authenticate` (which passes it
+on to the backend).
+
+The Django admin is tightly coupled to the Django :ref:`User object
+<user-objects>`. The best way to deal with this is to create a Django ``User``
+object for each user that exists for your backend (e.g., in your LDAP
+directory, your external SQL database, etc.) You can either write a script to
+do this in advance, or your ``authenticate`` method can do it the first time a
+user logs in.
+
+Here's an example backend that authenticates against a username and password
+variable defined in your ``settings.py`` file and creates a Django ``User``
+object the first time a user authenticates::
+
+    from django.conf import settings
+    from django.contrib.auth.backends import BaseBackend
+    from django.contrib.auth.hashers import check_password
+    from django.contrib.auth.models import User
+
+
+    class SettingsBackend(BaseBackend):
+        """
+        Authenticate against the settings ADMIN_LOGIN and ADMIN_PASSWORD.
+
+        Use the login name and a hash of the password. For example:
+
+        ADMIN_LOGIN = 'admin'
+        ADMIN_PASSWORD = 'pbkdf2_sha256$30000$Vo0VlMnkR4Bk$qEvtdyZRWTcOsCnI/oQ7fVOu1XAURIZYoOZ3iq8Dr4M='
+        """
+
+        def authenticate(self, request, username=None, password=None):
+            login_valid = settings.ADMIN_LOGIN == username
+            pwd_valid = check_password(password, settings.ADMIN_PASSWORD)
+            if login_valid and pwd_valid:
+                try:
+                    user = User.objects.get(username=username)
+                except User.DoesNotExist:
+                    # Create a new user. There's no need to set a password
+                    # because only the password from settings.py is checked.
+                    user = User(username=username)
+                    user.is_staff = True
+                    user.is_superuser = True
+                    user.save()
+                return user
+            return None
+
+        def get_user(self, user_id):
+            try:
+                return User.objects.get(pk=user_id)
+            except User.DoesNotExist:
+                return None
+
+.. _authorization_methods:
+
+Handling authorization in custom backends
+-----------------------------------------
+
+Custom auth backends can provide their own permissions.
+
+The user model and its manager will delegate permission lookup functions
+(:meth:`~django.contrib.auth.models.User.get_user_permissions()`,
+:meth:`~django.contrib.auth.models.User.get_group_permissions()`,
+:meth:`~django.contrib.auth.models.User.get_all_permissions()`,
+:meth:`~django.contrib.auth.models.User.has_perm()`,
+:meth:`~django.contrib.auth.models.User.has_module_perms()`, and
+:meth:`~django.contrib.auth.models.UserManager.with_perm()`) to any
+authentication backend that implements these functions.
+
+The permissions given to the user will be the superset of all permissions
+returned by all backends. That is, Django grants a permission to a user that
+any one backend grants.
+
+If a backend raises a :class:`~django.core.exceptions.PermissionDenied`
+exception in :meth:`~django.contrib.auth.models.User.has_perm()` or
+:meth:`~django.contrib.auth.models.User.has_module_perms()`, the authorization
+will immediately fail and Django won't check the backends that follow.
+
+A backend could implement permissions for the magic admin like this::
+
+    from django.contrib.auth.backends import BaseBackend
+
+
+    class MagicAdminBackend(BaseBackend):
+        def has_perm(self, user_obj, perm, obj=None):
+            return user_obj.username == settings.ADMIN_LOGIN
+
+This gives full permissions to the user granted access in the above example.
+Notice that in addition to the same arguments given to the associated
+:class:`django.contrib.auth.models.User` functions, the backend auth functions
+all take the user object, which may be an anonymous user, as an argument.
+
+A full authorization implementation can be found in the ``ModelBackend`` class
+in :source:`django/contrib/auth/backends.py`, which is the default backend and
+queries the ``auth_permission`` table most of the time.
+
+.. _anonymous_auth:
+
+Authorization for anonymous users
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+An anonymous user is one that is not authenticated i.e. they have provided no
+valid authentication details. However, that does not necessarily mean they are
+not authorized to do anything. At the most basic level, most websites
+authorize anonymous users to browse most of the site, and many allow anonymous
+posting of comments etc.
+
+Django's permission framework does not have a place to store permissions for
+anonymous users. However, the user object passed to an authentication backend
+may be an :class:`django.contrib.auth.models.AnonymousUser` object, allowing
+the backend to specify custom authorization behavior for anonymous users. This
+is especially useful for the authors of reusable apps, who can delegate all
+questions of authorization to the auth backend, rather than needing settings,
+for example, to control anonymous access.
+
+.. _inactive_auth:
+
+Authorization for inactive users
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+An inactive user is one that has its
+:attr:`~django.contrib.auth.models.User.is_active` field set to ``False``. The
+:class:`~django.contrib.auth.backends.ModelBackend` and
+:class:`~django.contrib.auth.backends.RemoteUserBackend` authentication
+backends prohibits these users from authenticating. If a custom user model
+doesn't have an :attr:`~django.contrib.auth.models.CustomUser.is_active` field,
+all users will be allowed to authenticate.
+
+You can use :class:`~django.contrib.auth.backends.AllowAllUsersModelBackend`
+or :class:`~django.contrib.auth.backends.AllowAllUsersRemoteUserBackend` if you
+want to allow inactive users to authenticate.
+
+The support for anonymous users in the permission system allows for a scenario
+where anonymous users have permissions to do something while inactive
+authenticated users do not.
+
+Do not forget to test for the ``is_active`` attribute of the user in your own
+backend permission methods.
+
+Handling object permissions
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Django's permission framework has a foundation for object permissions, though
+there is no implementation for it in the core. That means that checking for
+object permissions will always return ``False`` or an empty list (depending on
+the check performed). An authentication backend will receive the keyword
+parameters ``obj`` and ``user_obj`` for each object related authorization
+method and can return the object level permission as appropriate.
+
+.. _custom-permissions:
+
+Custom permissions
+==================
+
+To create custom permissions for a given model object, use the ``permissions``
+:ref:`model Meta attribute <meta-options>`.
+
+This example ``Task`` model creates two custom permissions, i.e., actions users
+can or cannot do with ``Task`` instances, specific to your application::
+
+    class Task(models.Model):
+        ...
+
+        class Meta:
+            permissions = [
+                ("change_task_status", "Can change the status of tasks"),
+                ("close_task", "Can remove a task by setting its status as closed"),
+            ]
+
+The only thing this does is create those extra permissions when you run
+:djadmin:`manage.py migrate <migrate>` (the function that creates permissions
+is connected to the :data:`~django.db.models.signals.post_migrate` signal).
+Your code is in charge of checking the value of these permissions when a user
+is trying to access the functionality provided by the application (changing the
+status of tasks or closing tasks.) Continuing the above example, the following
+checks if a user may close tasks::
+
+    user.has_perm("app.close_task")
+
+.. _extending-user:
+
+Extending the existing ``User`` model
+=====================================
+
+There are two ways to extend the default
+:class:`~django.contrib.auth.models.User` model without substituting your own
+model. If the changes you need are purely behavioral, and don't require any
+change to what is stored in the database, you can create a :ref:`proxy model
+<proxy-models>` based on :class:`~django.contrib.auth.models.User`. This
+allows for any of the features offered by proxy models including default
+ordering, custom managers, or custom model methods.
+
+If you wish to store information related to ``User``, you can use a
+:class:`~django.db.models.OneToOneField` to a model containing the fields for
+additional information. This one-to-one model is often called a profile model,
+as it might store non-auth related information about a site user. For example
+you might create an Employee model::
+
+    from django.contrib.auth.models import User
+
+
+    class Employee(models.Model):
+        user = models.OneToOneField(User, on_delete=models.CASCADE)
+        department = models.CharField(max_length=100)
+
+Assuming an existing Employee Fred Smith who has both a User and Employee
+model, you can access the related information using Django's standard related
+model conventions:
+
+.. code-block:: pycon
+
+    >>> u = User.objects.get(username="fsmith")
+    >>> freds_department = u.employee.department
+
+To add a profile model's fields to the user page in the admin, define an
+:class:`~django.contrib.admin.InlineModelAdmin` (for this example, we'll use a
+:class:`~django.contrib.admin.StackedInline`) in your app's ``admin.py`` and
+add it to a ``UserAdmin`` class which is registered with the
+:class:`~django.contrib.auth.models.User` class::
+
+    from django.contrib import admin
+    from django.contrib.auth.admin import UserAdmin as BaseUserAdmin
+    from django.contrib.auth.models import User
+
+    from my_user_profile_app.models import Employee
+
+
+    # Define an inline admin descriptor for Employee model
+    # which acts a bit like a singleton
+    class EmployeeInline(admin.StackedInline):
+        model = Employee
+        can_delete = False
+        verbose_name_plural = "employee"
+
+
+    # Define a new User admin
+    class UserAdmin(BaseUserAdmin):
+        inlines = [EmployeeInline]
+
+
+    # Re-register UserAdmin
+    admin.site.unregister(User)
+    admin.site.register(User, UserAdmin)
+
+These profile models are not special in any way - they are just Django models
+that happen to have a one-to-one link with a user model. As such, they aren't
+auto created when a user is created, but
+a :attr:`django.db.models.signals.post_save` could be used to create or update
+related models as appropriate.
+
+Using related models results in additional queries or joins to retrieve the
+related data. Depending on your needs, a custom user model that includes the
+related fields may be your better option, however, existing relations to the
+default user model within your project's apps may justify the extra database
+load.
+
+.. _auth-custom-user:
+
+Substituting a custom ``User`` model
+====================================
+
+Some kinds of projects may have authentication requirements for which Django's
+built-in :class:`~django.contrib.auth.models.User` model is not always
+appropriate. For instance, on some sites it makes more sense to use an email
+address as your identification token instead of a username.
+
+Django allows you to override the default user model by providing a value for
+the :setting:`AUTH_USER_MODEL` setting that references a custom model::
+
+     AUTH_USER_MODEL = "myapp.MyUser"
+
+This dotted pair describes the :attr:`~django.apps.AppConfig.label` of the
+Django app (which must be in your :setting:`INSTALLED_APPS`), and the name of
+the Django model that you wish to use as your user model.
+
+Using a custom user model when starting a project
+-------------------------------------------------
+
+If you're starting a new project, it's highly recommended to set up a custom
+user model, even if the default :class:`~django.contrib.auth.models.User` model
+is sufficient for you. This model behaves identically to the default user
+model, but you'll be able to customize it in the future if the need arises::
+
+    from django.contrib.auth.models import AbstractUser
+
+
+    class User(AbstractUser):
+        pass
+
+Don't forget to point :setting:`AUTH_USER_MODEL` to it. Do this before creating
+any migrations or running ``manage.py migrate`` for the first time.
+
+Also, register the model in the app's ``admin.py``::
+
+    from django.contrib import admin
+    from django.contrib.auth.admin import UserAdmin
+    from .models import User
+
+    admin.site.register(User, UserAdmin)
+
+Changing to a custom user model mid-project
+-------------------------------------------
+
+Changing :setting:`AUTH_USER_MODEL` after you've created database tables is
+significantly more difficult since it affects foreign keys and many-to-many
+relationships, for example.
+
+This change can't be done automatically and requires manually fixing your
+schema, moving your data from the old user table, and possibly manually
+reapplying some migrations. See :ticket:`25313` for an outline of the steps.
+
+Due to limitations of Django's dynamic dependency feature for swappable
+models, the model referenced by :setting:`AUTH_USER_MODEL` must be created in
+the first migration of its app (usually called ``0001_initial``); otherwise,
+you'll have dependency issues.
+
+In addition, you may run into a ``CircularDependencyError`` when running your
+migrations as Django won't be able to automatically break the dependency loop
+due to the dynamic dependency. If you see this error, you should break the loop
+by moving the models depended on by your user model into a second migration.
+(You can try making two normal models that have a ``ForeignKey`` to each other
+and seeing how ``makemigrations`` resolves that circular dependency if you want
+to see how it's usually done.)
+
+Reusable apps and ``AUTH_USER_MODEL``
+-------------------------------------
+
+Reusable apps shouldn't implement a custom user model. A project may use many
+apps, and two reusable apps that implemented a custom user model couldn't be
+used together. If you need to store per user information in your app, use
+a :class:`~django.db.models.ForeignKey` or
+:class:`~django.db.models.OneToOneField` to ``settings.AUTH_USER_MODEL``
+as described below.
+
+Referencing the ``User`` model
+------------------------------
+
+.. currentmodule:: django.contrib.auth
+
+If you reference :class:`~django.contrib.auth.models.User` directly (for
+example, by referring to it in a foreign key), your code will not work in
+projects where the :setting:`AUTH_USER_MODEL` setting has been changed to a
+different user model.
+
+.. function:: get_user_model()
+
+    Instead of referring to :class:`~django.contrib.auth.models.User` directly,
+    you should reference the user model using
+    ``django.contrib.auth.get_user_model()``. This method will return the
+    currently active user model -- the custom user model if one is specified, or
+    :class:`~django.contrib.auth.models.User` otherwise.
+
+    When you define a foreign key or many-to-many relations to the user model,
+    you should specify the custom model using the :setting:`AUTH_USER_MODEL`
+    setting. For example::
+
+        from django.conf import settings
+        from django.db import models
+
+
+        class Article(models.Model):
+            author = models.ForeignKey(
+                settings.AUTH_USER_MODEL,
+                on_delete=models.CASCADE,
+            )
+
+    When connecting to signals sent by the user model, you should specify
+    the custom model using the :setting:`AUTH_USER_MODEL` setting. For example::
+
+        from django.conf import settings
+        from django.db.models.signals import post_save
+
+
+        def post_save_receiver(sender, instance, created, **kwargs):
+            pass
+
+
+        post_save.connect(post_save_receiver, sender=settings.AUTH_USER_MODEL)
+
+    Generally speaking, it's easiest to refer to the user model with the
+    :setting:`AUTH_USER_MODEL` setting in code that's executed at import time,
+    however, it's also possible to call ``get_user_model()`` while Django
+    is importing models, so you could use
+    ``models.ForeignKey(get_user_model(), ...)``.
+
+    If your app is tested with multiple user models, using
+    ``@override_settings(AUTH_USER_MODEL=...)`` for example, and you cache the
+    result of ``get_user_model()`` in a module-level variable, you may need to
+    listen to the  :data:`~django.test.signals.setting_changed` signal to clear
+    the cache. For example::
+
+        from django.apps import apps
+        from django.contrib.auth import get_user_model
+        from django.core.signals import setting_changed
+        from django.dispatch import receiver
+
+
+        @receiver(setting_changed)
+        def user_model_swapped(*, setting, **kwargs):
+            if setting == "AUTH_USER_MODEL":
+                apps.clear_cache()
+                from myapp import some_module
+
+                some_module.UserModel = get_user_model()
+
+.. _specifying-custom-user-model:
+
+Specifying a custom user model
+------------------------------
+
+When you start your project with a custom user model, stop to consider if this
+is the right choice for your project.
+
+Keeping all user related information in one model removes the need for
+additional or more complex database queries to retrieve related models. On the
+other hand, it may be more suitable to store app-specific user information in a
+model that has a relation with your custom user model. That allows each app to
+specify its own user data requirements without potentially conflicting or
+breaking assumptions by other apps. It also means that you would keep your user
+model as simple as possible, focused on authentication, and following the
+minimum requirements Django expects custom user models to meet.
+
+If you use the default authentication backend, then your model must have a
+single unique field that can be used for identification purposes. This can
+be a username, an email address, or any other unique attribute. A non-unique
+username field is allowed if you use a custom authentication backend that
+can support it.
+
+The easiest way to construct a compliant custom user model is to inherit from
+:class:`~django.contrib.auth.models.AbstractBaseUser`.
+:class:`~django.contrib.auth.models.AbstractBaseUser` provides the core
+implementation of a user model, including hashed passwords and tokenized
+password resets. You must then provide some key implementation details:
+
+.. currentmodule:: django.contrib.auth
+
+.. class:: models.CustomUser
+
+    .. attribute:: USERNAME_FIELD
+
+        A string describing the name of the field on the user model that is
+        used as the unique identifier. This will usually be a username of some
+        kind, but it can also be an email address, or any other unique
+        identifier. The field *must* be unique (e.g. have ``unique=True`` set
+        in its definition), unless you use a custom authentication backend that
+        can support non-unique usernames.
+
+        In the following example, the field ``identifier`` is used
+        as the identifying field::
+
+            class MyUser(AbstractBaseUser):
+                identifier = models.CharField(max_length=40, unique=True)
+                ...
+                USERNAME_FIELD = "identifier"
+
+    .. attribute:: EMAIL_FIELD
+
+        A string describing the name of the email field on the ``User`` model.
+        This value is returned by
+        :meth:`~models.AbstractBaseUser.get_email_field_name`.
+
+    .. attribute:: REQUIRED_FIELDS
+
+        A list of the field names that will be prompted for when creating a
+        user via the :djadmin:`createsuperuser` management command. The user
+        will be prompted to supply a value for each of these fields. It must
+        include any field for which :attr:`~django.db.models.Field.blank` is
+        ``False`` or undefined and may include additional fields you want
+        prompted for when a user is created interactively.
+        ``REQUIRED_FIELDS`` has no effect in other parts of Django, like
+        creating a user in the admin.
+
+        For example, here is the partial definition for a user model that
+        defines two required fields - a date of birth and height::
+
+            class MyUser(AbstractBaseUser):
+                ...
+                date_of_birth = models.DateField()
+                height = models.FloatField()
+                ...
+                REQUIRED_FIELDS = ["date_of_birth", "height"]
+
+        .. note::
+
+            ``REQUIRED_FIELDS`` must contain all required fields on your user
+            model, but should *not* contain the ``USERNAME_FIELD`` or
+            ``password`` as these fields will always be prompted for.
+
+    .. attribute:: is_active
+
+        A boolean attribute that indicates whether the user is considered
+        "active".  This attribute is provided as an attribute on
+        ``AbstractBaseUser`` defaulting to ``True``. How you choose to
+        implement it will depend on the details of your chosen auth backends.
+        See the documentation of the :attr:`is_active attribute on the built-in
+        user model <django.contrib.auth.models.User.is_active>` for details.
+
+    .. method:: get_full_name()
+
+        Optional. A longer formal identifier for the user such as their full
+        name. If implemented, this appears alongside the username in an
+        object's history in :mod:`django.contrib.admin`.
+
+    .. method:: get_short_name()
+
+        Optional. A short, informal identifier for the user such as their
+        first name. If implemented, this replaces the username in the greeting
+        to the user in the header of :mod:`django.contrib.admin`.
+
+    .. admonition:: Importing ``AbstractBaseUser``
+
+        ``AbstractBaseUser`` and ``BaseUserManager`` are importable from
+        ``django.contrib.auth.base_user`` so that they can be imported without
+        including ``django.contrib.auth`` in :setting:`INSTALLED_APPS`.
+
+The following attributes and methods are available on any subclass of
+:class:`~django.contrib.auth.models.AbstractBaseUser`:
+
+.. class:: models.AbstractBaseUser
+
+    .. method:: get_username()
+
+        Returns the value of the field nominated by ``USERNAME_FIELD``.
+
+    .. method:: clean()
+
+        Normalizes the username by calling :meth:`normalize_username`. If you
+        override this method, be sure to call ``super()`` to retain the
+        normalization.
+
+    .. classmethod:: get_email_field_name()
+
+       Returns the name of the email field specified by the
+       :attr:`~models.CustomUser.EMAIL_FIELD` attribute. Defaults to
+       ``'email'`` if ``EMAIL_FIELD`` isn't specified.
+
+    .. classmethod:: normalize_username(username)
+
+        Applies NFKC Unicode normalization to usernames so that visually
+        identical characters with different Unicode code points are considered
+        identical.
+
+    .. attribute:: models.AbstractBaseUser.is_authenticated
+
+        Read-only attribute which is always ``True`` (as opposed to
+        ``AnonymousUser.is_authenticated`` which is always ``False``).
+        This is a way to tell if the user has been authenticated. This does not
+        imply any permissions and doesn't check if the user is active or has
+        a valid session. Even though normally you will check this attribute on
+        ``request.user`` to find out whether it has been populated by the
+        :class:`~django.contrib.auth.middleware.AuthenticationMiddleware`
+        (representing the currently logged-in user), you should know this
+        attribute is ``True`` for any :class:`~models.User` instance.
+
+    .. attribute:: models.AbstractBaseUser.is_anonymous
+
+        Read-only attribute which is always ``False``. This is a way of
+        differentiating :class:`~models.User` and :class:`~models.AnonymousUser`
+        objects. Generally, you should prefer using
+        :attr:`~models.User.is_authenticated` to this attribute.
+
+    .. method:: models.AbstractBaseUser.set_password(raw_password)
+
+        Sets the user's password to the given raw string, taking care of the
+        password hashing. Doesn't save the
+        :class:`~django.contrib.auth.models.AbstractBaseUser` object.
+
+        When the raw_password is ``None``, the password will be set to an
+        unusable password, as if
+        :meth:`~django.contrib.auth.models.AbstractBaseUser.set_unusable_password()`
+        were used.
+
+    .. method:: models.AbstractBaseUser.check_password(raw_password)
+    .. method:: models.AbstractBaseUser.acheck_password(raw_password)
+
+        *Asynchronous version*: ``acheck_password()``
+
+        Returns ``True`` if the given raw string is the correct password for
+        the user. (This takes care of the password hashing in making the
+        comparison.)
+
+        .. versionchanged:: 5.0
+
+            ``acheck_password()`` method was added.
+
+    .. method:: models.AbstractBaseUser.set_unusable_password()
+
+        Marks the user as having no password set.  This isn't the same as
+        having a blank string for a password.
+        :meth:`~django.contrib.auth.models.AbstractBaseUser.check_password()` for this user
+        will never return ``True``. Doesn't save the
+        :class:`~django.contrib.auth.models.AbstractBaseUser` object.
+
+        You may need this if authentication for your application takes place
+        against an existing external source such as an LDAP directory.
+
+    .. method:: models.AbstractBaseUser.has_usable_password()
+
+        Returns ``False`` if
+        :meth:`~django.contrib.auth.models.AbstractBaseUser.set_unusable_password()` has
+        been called for this user.
+
+    .. method:: models.AbstractBaseUser.get_session_auth_hash()
+
+        Returns an HMAC of the password field. Used for
+        :ref:`session-invalidation-on-password-change`.
+
+    .. method:: models.AbstractBaseUser.get_session_auth_fallback_hash()
+
+        .. versionadded:: 4.1.8
+
+        Yields the HMAC of the password field using
+        :setting:`SECRET_KEY_FALLBACKS`. Used by ``get_user()``.
+
+:class:`~models.AbstractUser` subclasses :class:`~models.AbstractBaseUser`:
+
+.. class:: models.AbstractUser
+
+    .. method:: clean()
+
+        Normalizes the email by calling
+        :meth:`.BaseUserManager.normalize_email`. If you override this method,
+        be sure to call ``super()`` to retain the normalization.
+
+Writing a manager for a custom user model
+-----------------------------------------
+
+You should also define a custom manager for your user model. If your user model
+defines ``username``, ``email``, ``is_staff``, ``is_active``, ``is_superuser``,
+``last_login``, and ``date_joined`` fields the same as Django's default user,
+you can install Django's :class:`~django.contrib.auth.models.UserManager`;
+however, if your user model defines different fields, you'll need to define a
+custom manager that extends :class:`~django.contrib.auth.models.BaseUserManager`
+providing two additional methods:
+
+.. class:: models.CustomUserManager
+
+    .. method:: models.CustomUserManager.create_user(username_field, password=None, **other_fields)
+
+        The prototype of ``create_user()`` should accept the username field,
+        plus all required fields as arguments. For example, if your user model
+        uses ``email`` as the username field, and has ``date_of_birth`` as a
+        required field, then ``create_user`` should be defined as::
+
+            def create_user(self, email, date_of_birth, password=None):
+                # create user here
+                ...
+
+    .. method:: models.CustomUserManager.create_superuser(username_field, password=None, **other_fields)
+
+        The prototype of ``create_superuser()`` should accept the username
+        field, plus all required fields as arguments. For example, if your user
+        model uses ``email`` as the username field, and has ``date_of_birth``
+        as a required field, then ``create_superuser`` should be defined as::
+
+            def create_superuser(self, email, date_of_birth, password=None):
+                # create superuser here
+                ...
+
+For a :class:`~.ForeignKey` in :attr:`.USERNAME_FIELD` or
+:attr:`.REQUIRED_FIELDS`, these methods receive the value of the
+:attr:`~.ForeignKey.to_field` (the :attr:`~django.db.models.Field.primary_key`
+by default) of an existing instance.
+
+:class:`~django.contrib.auth.models.BaseUserManager` provides the following
+utility methods:
+
+.. class:: models.BaseUserManager
+
+    .. classmethod:: models.BaseUserManager.normalize_email(email)
+
+        Normalizes email addresses by lowercasing the domain portion of the
+        email address.
+
+    .. method:: models.BaseUserManager.get_by_natural_key(username)
+
+        Retrieves a user instance using the contents of the field
+        nominated by ``USERNAME_FIELD``.
+
+    .. method:: models.BaseUserManager.make_random_password(length=10, allowed_chars='abcdefghjkmnpqrstuvwxyzABCDEFGHJKLMNPQRSTUVWXYZ23456789')
+
+        .. deprecated:: 4.2
+
+        Returns a random password with the given length and given string of
+        allowed characters. Note that the default value of ``allowed_chars``
+        doesn't contain letters that can cause user confusion, including:
+
+        * ``i``, ``l``, ``I``, and ``1`` (lowercase letter i, lowercase
+          letter L, uppercase letter i, and the number one)
+        * ``o``, ``O``, and ``0`` (lowercase letter o, uppercase letter o,
+          and zero)
+
+Extending Django's default ``User``
+-----------------------------------
+
+If you're entirely happy with Django's :class:`~django.contrib.auth.models.User`
+model, but you want to add some additional profile information, you could
+subclass :class:`django.contrib.auth.models.AbstractUser` and add your custom
+profile fields, although we'd recommend a separate model as described in
+:ref:`specifying-custom-user-model`. ``AbstractUser`` provides the full
+implementation of the default :class:`~django.contrib.auth.models.User` as an
+:ref:`abstract model <abstract-base-classes>`.
+
+.. _custom-users-and-the-built-in-auth-forms:
+
+Custom users and the built-in auth forms
+----------------------------------------
+
+Django's built-in :ref:`forms <built-in-auth-forms>` and :ref:`views
+<built-in-auth-views>` make certain assumptions about the user model that they
+are working with.
+
+The following forms are compatible with any subclass of
+:class:`~django.contrib.auth.models.AbstractBaseUser`:
+
+* :class:`~django.contrib.auth.forms.AuthenticationForm`: Uses the username
+  field specified by :attr:`~models.CustomUser.USERNAME_FIELD`.
+* :class:`~django.contrib.auth.forms.SetPasswordForm`
+* :class:`~django.contrib.auth.forms.PasswordChangeForm`
+* :class:`~django.contrib.auth.forms.AdminPasswordChangeForm`
+
+The following forms make assumptions about the user model and can be used as-is
+if those assumptions are met:
+
+* :class:`~django.contrib.auth.forms.PasswordResetForm`: Assumes that the user
+  model has a field that stores the user's email address with the name returned
+  by :meth:`~models.AbstractBaseUser.get_email_field_name` (``email`` by
+  default) that can be used to identify the user and a boolean field named
+  ``is_active`` to prevent password resets for inactive users.
+
+Finally, the following forms are tied to
+:class:`~django.contrib.auth.models.User` and need to be rewritten or extended
+to work with a custom user model:
+
+* :class:`~django.contrib.auth.forms.UserCreationForm`
+* :class:`~django.contrib.auth.forms.UserChangeForm`
+
+If your custom user model is a subclass of ``AbstractUser``, then you can
+extend these forms in this manner::
+
+    from django.contrib.auth.forms import UserCreationForm
+    from myapp.models import CustomUser
+
+
+    class CustomUserCreationForm(UserCreationForm):
+        class Meta(UserCreationForm.Meta):
+            model = CustomUser
+            fields = UserCreationForm.Meta.fields + ("custom_field",)
+
+.. versionchanged:: 4.2
+
+    In older versions, :class:`~django.contrib.auth.forms.UserCreationForm`
+    didn't save many-to-many form fields for a custom user model.
+
+Custom users and :mod:`django.contrib.admin`
+--------------------------------------------
+
+If you want your custom user model to also work with the admin, your user model
+must define some additional attributes and methods. These methods allow the
+admin to control access of the user to admin content:
+
+.. class:: models.CustomUser
+    :noindex:
+
+.. attribute:: is_staff
+
+    Returns ``True`` if the user is allowed to have access to the admin site.
+
+.. attribute:: is_active
+
+    Returns ``True`` if the user account is currently active.
+
+.. method:: has_perm(perm, obj=None):
+
+    Returns ``True`` if the user has the named permission. If ``obj`` is
+    provided, the permission needs to be checked against a specific object
+    instance.
+
+.. method:: has_module_perms(app_label):
+
+    Returns ``True`` if the user has permission to access models in
+    the given app.
+
+You will also need to register your custom user model with the admin. If
+your custom user model extends ``django.contrib.auth.models.AbstractUser``,
+you can use Django's existing ``django.contrib.auth.admin.UserAdmin``
+class. However, if your user model extends
+:class:`~django.contrib.auth.models.AbstractBaseUser`, you'll need to define
+a custom ``ModelAdmin`` class. It may be possible to subclass the default
+``django.contrib.auth.admin.UserAdmin``; however, you'll need to
+override any of the definitions that refer to fields on
+``django.contrib.auth.models.AbstractUser`` that aren't on your
+custom user class.
+
+.. note::
+
+    If you are using a custom ``ModelAdmin`` which is a subclass of
+    ``django.contrib.auth.admin.UserAdmin``, then you need to add your custom
+    fields to ``fieldsets`` (for fields to be used in editing users) and to
+    ``add_fieldsets`` (for fields to be used when creating a user). For
+    example::
+
+        from django.contrib.auth.admin import UserAdmin
+
+
+        class CustomUserAdmin(UserAdmin):
+            ...
+            fieldsets = UserAdmin.fieldsets + ((None, {"fields": ["custom_field"]}),)
+            add_fieldsets = UserAdmin.add_fieldsets + ((None, {"fields": ["custom_field"]}),)
+
+    See :ref:`a full example <custom-users-admin-full-example>` for more
+    details.
+
+Custom users and permissions
+----------------------------
+
+To make it easy to include Django's permission framework into your own user
+class, Django provides :class:`~django.contrib.auth.models.PermissionsMixin`.
+This is an abstract model you can include in the class hierarchy for your user
+model, giving you all the methods and database fields necessary to support
+Django's permission model.
+
+:class:`~django.contrib.auth.models.PermissionsMixin` provides the following
+methods and attributes:
+
+.. class:: models.PermissionsMixin
+
+    .. attribute:: models.PermissionsMixin.is_superuser
+
+        Boolean. Designates that this user has all permissions without
+        explicitly assigning them.
+
+    .. method:: models.PermissionsMixin.get_user_permissions(obj=None)
+
+        Returns a set of permission strings that the user has directly.
+
+        If ``obj`` is passed in, only returns the user permissions for this
+        specific object.
+
+    .. method:: models.PermissionsMixin.get_group_permissions(obj=None)
+
+        Returns a set of permission strings that the user has, through their
+        groups.
+
+        If ``obj`` is passed in, only returns the group permissions for
+        this specific object.
+
+    .. method:: models.PermissionsMixin.get_all_permissions(obj=None)
+
+        Returns a set of permission strings that the user has, both through
+        group and user permissions.
+
+        If ``obj`` is passed in, only returns the permissions for this
+        specific object.
+
+    .. method:: models.PermissionsMixin.has_perm(perm, obj=None)
+
+        Returns ``True`` if the user has the specified permission, where
+        ``perm`` is in the format ``"<app label>.<permission codename>"`` (see
+        :ref:`permissions <topic-authorization>`). If :attr:`.User.is_active`
+        and :attr:`~.User.is_superuser` are both ``True``, this method always
+        returns ``True``.
+
+        If ``obj`` is passed in, this method won't check for a permission for
+        the model, but for this specific object.
+
+    .. method:: models.PermissionsMixin.has_perms(perm_list, obj=None)
+
+        Returns ``True`` if the user has each of the specified permissions,
+        where each perm is in the format
+        ``"<app label>.<permission codename>"``. If :attr:`.User.is_active` and
+        :attr:`~.User.is_superuser` are both ``True``, this method always
+        returns ``True``.
+
+        If ``obj`` is passed in, this method won't check for permissions for
+        the model, but for the specific object.
+
+    .. method:: models.PermissionsMixin.has_module_perms(package_name)
+
+        Returns ``True`` if the user has any permissions in the given package
+        (the Django app label). If :attr:`.User.is_active` and
+        :attr:`~.User.is_superuser` are both ``True``, this method always
+        returns ``True``.
+
+.. admonition:: ``PermissionsMixin`` and ``ModelBackend``
+
+    If you don't include the
+    :class:`~django.contrib.auth.models.PermissionsMixin`, you must ensure you
+    don't invoke the permissions methods on ``ModelBackend``. ``ModelBackend``
+    assumes that certain fields are available on your user model. If your user
+    model doesn't provide  those fields, you'll receive database errors when
+    you check permissions.
+
+Custom users and proxy models
+-----------------------------
+
+One limitation of custom user models is that installing a custom user model
+will break any proxy model extending :class:`~django.contrib.auth.models.User`.
+Proxy models must be based on a concrete base class; by defining a custom user
+model, you remove the ability of Django to reliably identify the base class.
+
+If your project uses proxy models, you must either modify the proxy to extend
+the user model that's in use in your project, or merge your proxy's behavior
+into your :class:`~django.contrib.auth.models.User` subclass.
+
+.. _custom-users-admin-full-example:
+
+A full example
+--------------
+
+Here is an example of an admin-compliant custom user app. This user model uses
+an email address as the username, and has a required date of birth; it
+provides no permission checking beyond an ``admin`` flag on the user account.
+This model would be compatible with all the built-in auth forms and views,
+except for the user creation forms. This example illustrates how most of the
+components work together, but is not intended to be copied directly into
+projects for production use.
+
+This code would all live in a ``models.py`` file for a custom
+authentication app::
+
+    from django.db import models
+    from django.contrib.auth.models import BaseUserManager, AbstractBaseUser
+
+
+    class MyUserManager(BaseUserManager):
+        def create_user(self, email, date_of_birth, password=None):
+            """
+            Creates and saves a User with the given email, date of
+            birth and password.
+            """
+            if not email:
+                raise ValueError("Users must have an email address")
+
+            user = self.model(
+                email=self.normalize_email(email),
+                date_of_birth=date_of_birth,
+            )
+
+            user.set_password(password)
+            user.save(using=self._db)
+            return user
+
+        def create_superuser(self, email, date_of_birth, password=None):
+            """
+            Creates and saves a superuser with the given email, date of
+            birth and password.
+            """
+            user = self.create_user(
+                email,
+                password=password,
+                date_of_birth=date_of_birth,
+            )
+            user.is_admin = True
+            user.save(using=self._db)
+            return user
+
+
+    class MyUser(AbstractBaseUser):
+        email = models.EmailField(
+            verbose_name="email address",
+            max_length=255,
+            unique=True,
+        )
+        date_of_birth = models.DateField()
+        is_active = models.BooleanField(default=True)
+        is_admin = models.BooleanField(default=False)
+
+        objects = MyUserManager()
+
+        USERNAME_FIELD = "email"
+        REQUIRED_FIELDS = ["date_of_birth"]
+
+        def __str__(self):
+            return self.email
+
+        def has_perm(self, perm, obj=None):
+            "Does the user have a specific permission?"
+            # Simplest possible answer: Yes, always
+            return True
+
+        def has_module_perms(self, app_label):
+            "Does the user have permissions to view the app `app_label`?"
+            # Simplest possible answer: Yes, always
+            return True
+
+        @property
+        def is_staff(self):
+            "Is the user a member of staff?"
+            # Simplest possible answer: All admins are staff
+            return self.is_admin
+
+Then, to register this custom user model with Django's admin, the following
+code would be required in the app's ``admin.py`` file::
+
+    from django import forms
+    from django.contrib import admin
+    from django.contrib.auth.models import Group
+    from django.contrib.auth.admin import UserAdmin as BaseUserAdmin
+    from django.contrib.auth.forms import ReadOnlyPasswordHashField
+    from django.core.exceptions import ValidationError
+
+    from customauth.models import MyUser
+
+
+    class UserCreationForm(forms.ModelForm):
+        """A form for creating new users. Includes all the required
+        fields, plus a repeated password."""
+
+        password1 = forms.CharField(label="Password", widget=forms.PasswordInput)
+        password2 = forms.CharField(
+            label="Password confirmation", widget=forms.PasswordInput
+        )
+
+        class Meta:
+            model = MyUser
+            fields = ["email", "date_of_birth"]
+
+        def clean_password2(self):
+            # Check that the two password entries match
+            password1 = self.cleaned_data.get("password1")
+            password2 = self.cleaned_data.get("password2")
+            if password1 and password2 and password1 != password2:
+                raise ValidationError("Passwords don't match")
+            return password2
+
+        def save(self, commit=True):
+            # Save the provided password in hashed format
+            user = super().save(commit=False)
+            user.set_password(self.cleaned_data["password1"])
+            if commit:
+                user.save()
+            return user
+
+
+    class UserChangeForm(forms.ModelForm):
+        """A form for updating users. Includes all the fields on
+        the user, but replaces the password field with admin's
+        disabled password hash display field.
+        """
+
+        password = ReadOnlyPasswordHashField()
+
+        class Meta:
+            model = MyUser
+            fields = ["email", "password", "date_of_birth", "is_active", "is_admin"]
+
+
+    class UserAdmin(BaseUserAdmin):
+        # The forms to add and change user instances
+        form = UserChangeForm
+        add_form = UserCreationForm
+
+        # The fields to be used in displaying the User model.
+        # These override the definitions on the base UserAdmin
+        # that reference specific fields on auth.User.
+        list_display = ["email", "date_of_birth", "is_admin"]
+        list_filter = ["is_admin"]
+        fieldsets = [
+            (None, {"fields": ["email", "password"]}),
+            ("Personal info", {"fields": ["date_of_birth"]}),
+            ("Permissions", {"fields": ["is_admin"]}),
+        ]
+        # add_fieldsets is not a standard ModelAdmin attribute. UserAdmin
+        # overrides get_fieldsets to use this attribute when creating a user.
+        add_fieldsets = [
+            (
+                None,
+                {
+                    "classes": ["wide"],
+                    "fields": ["email", "date_of_birth", "password1", "password2"],
+                },
+            ),
+        ]
+        search_fields = ["email"]
+        ordering = ["email"]
+        filter_horizontal = []
+
+
+    # Now register the new UserAdmin...
+    admin.site.register(MyUser, UserAdmin)
+    # ... and, since we're not using Django's built-in permissions,
+    # unregister the Group model from admin.
+    admin.site.unregister(Group)
+
+Finally, specify the custom model as the default user model for your project
+using the :setting:`AUTH_USER_MODEL` setting in your ``settings.py``::
+
+    AUTH_USER_MODEL = "customauth.MyUser"

testbed/django__django/docs/topics/auth/default.txt

@@ -0,0 +1,1884 @@
+======================================
+Using the Django authentication system
+======================================
+
+.. currentmodule:: django.contrib.auth
+
+This document explains the usage of Django's authentication system in its
+default configuration. This configuration has evolved to serve the most common
+project needs, handling a reasonably wide range of tasks, and has a careful
+implementation of passwords and permissions. For projects where authentication
+needs differ from the default, Django supports extensive :doc:`extension and
+customization </topics/auth/customizing>` of authentication.
+
+Django authentication provides both authentication and authorization together
+and is generally referred to as the authentication system, as these features
+are somewhat coupled.
+
+.. _user-objects:
+
+``User`` objects
+================
+
+:class:`~django.contrib.auth.models.User` objects are the core of the
+authentication system. They typically represent the people interacting with
+your site and are used to enable things like restricting access, registering
+user profiles, associating content with creators etc. Only one class of user
+exists in Django's authentication framework, i.e., :attr:`'superusers'
+<django.contrib.auth.models.User.is_superuser>` or admin :attr:`'staff'
+<django.contrib.auth.models.User.is_staff>` users are just user objects with
+special attributes set, not different classes of user objects.
+
+The primary attributes of the default user are:
+
+* :attr:`~django.contrib.auth.models.User.username`
+* :attr:`~django.contrib.auth.models.User.password`
+* :attr:`~django.contrib.auth.models.User.email`
+* :attr:`~django.contrib.auth.models.User.first_name`
+* :attr:`~django.contrib.auth.models.User.last_name`
+
+See the :class:`full API documentation <django.contrib.auth.models.User>` for
+full reference, the documentation that follows is more task oriented.
+
+.. _topics-auth-creating-users:
+
+Creating users
+--------------
+
+The most direct way to create users is to use the included
+:meth:`~django.contrib.auth.models.UserManager.create_user` helper function:
+
+.. code-block:: pycon
+
+    >>> from django.contrib.auth.models import User
+    >>> user = User.objects.create_user("john", "lennon@thebeatles.com", "johnpassword")
+
+    # At this point, user is a User object that has already been saved
+    # to the database. You can continue to change its attributes
+    # if you want to change other fields.
+    >>> user.last_name = "Lennon"
+    >>> user.save()
+
+If you have the Django admin installed, you can also :ref:`create users
+interactively <auth-admin>`.
+
+.. _topics-auth-creating-superusers:
+
+Creating superusers
+-------------------
+
+Create superusers using the :djadmin:`createsuperuser` command:
+
+.. console::
+
+    $ python manage.py createsuperuser --username=joe --email=joe@example.com
+
+You will be prompted for a password. After you enter one, the user will be
+created immediately. If you leave off the :option:`--username <createsuperuser
+--username>` or :option:`--email <createsuperuser --email>` options, it will
+prompt you for those values.
+
+Changing passwords
+------------------
+
+Django does not store raw (clear text) passwords on the user model, but only
+a hash (see :doc:`documentation of how passwords are managed
+</topics/auth/passwords>` for full details). Because of this, do not attempt to
+manipulate the password attribute of the user directly. This is why a helper
+function is used when creating a user.
+
+To change a user's password, you have several options:
+
+:djadmin:`manage.py changepassword *username* <changepassword>` offers a method
+of changing a user's password from the command line. It prompts you to
+change the password of a given user which you must enter twice. If
+they both match, the new password will be changed immediately. If you
+do not supply a user, the command will attempt to change the password
+whose username matches the current system user.
+
+You can also change a password programmatically, using
+:meth:`~django.contrib.auth.models.User.set_password()`:
+
+.. code-block:: pycon
+
+    >>> from django.contrib.auth.models import User
+    >>> u = User.objects.get(username="john")
+    >>> u.set_password("new password")
+    >>> u.save()
+
+If you have the Django admin installed, you can also change user's passwords
+on the :ref:`authentication system's admin pages <auth-admin>`.
+
+Django also provides :ref:`views <built-in-auth-views>` and :ref:`forms
+<built-in-auth-forms>` that may be used to allow users to change their own
+passwords.
+
+Changing a user's password will log out all their sessions. See
+:ref:`session-invalidation-on-password-change` for details.
+
+Authenticating users
+--------------------
+
+.. function:: authenticate(request=None, **credentials)
+.. function:: aauthenticate(request=None, **credentials)
+
+    *Asynchronous version*: ``aauthenticate()``
+
+    Use :func:`~django.contrib.auth.authenticate()` to verify a set of
+    credentials. It takes credentials as keyword arguments, ``username`` and
+    ``password`` for the default case, checks them against each
+    :ref:`authentication backend <authentication-backends>`, and returns a
+    :class:`~django.contrib.auth.models.User` object if the credentials are
+    valid for a backend. If the credentials aren't valid for any backend or if
+    a backend raises :class:`~django.core.exceptions.PermissionDenied`, it
+    returns ``None``. For example::
+
+        from django.contrib.auth import authenticate
+
+        user = authenticate(username="john", password="secret")
+        if user is not None:
+            # A backend authenticated the credentials
+            ...
+        else:
+            # No backend authenticated the credentials
+            ...
+
+    ``request`` is an optional :class:`~django.http.HttpRequest` which is
+    passed on the ``authenticate()`` method of the authentication backends.
+
+    .. note::
+
+        This is a low level way to authenticate a set of credentials; for
+        example, it's used by the
+        :class:`~django.contrib.auth.middleware.RemoteUserMiddleware`. Unless
+        you are writing your own authentication system, you probably won't use
+        this. Rather if you're looking for a way to login a user, use the
+        :class:`~django.contrib.auth.views.LoginView`.
+
+    .. versionchanged:: 5.0
+
+        ``aauthenticate()`` function was added.
+
+.. _topic-authorization:
+
+Permissions and Authorization
+=============================
+
+Django comes with a built-in permissions system. It provides a way to assign
+permissions to specific users and groups of users.
+
+It's used by the Django admin site, but you're welcome to use it in your own
+code.
+
+The Django admin site uses permissions as follows:
+
+* Access to view objects is limited to users with the "view" or "change"
+  permission for that type of object.
+* Access to view the "add" form and add an object is limited to users with
+  the "add" permission for that type of object.
+* Access to view the change list, view the "change" form and change an
+  object is limited to users with the "change" permission for that type of
+  object.
+* Access to delete an object is limited to users with the "delete"
+  permission for that type of object.
+
+Permissions can be set not only per type of object, but also per specific
+object instance. By using the
+:meth:`~django.contrib.admin.ModelAdmin.has_view_permission`,
+:meth:`~django.contrib.admin.ModelAdmin.has_add_permission`,
+:meth:`~django.contrib.admin.ModelAdmin.has_change_permission` and
+:meth:`~django.contrib.admin.ModelAdmin.has_delete_permission` methods provided
+by the :class:`~django.contrib.admin.ModelAdmin` class, it is possible to
+customize permissions for different object instances of the same type.
+
+:class:`~django.contrib.auth.models.User` objects have two many-to-many
+fields: ``groups`` and ``user_permissions``.
+:class:`~django.contrib.auth.models.User` objects can access their related
+objects in the same way as any other :doc:`Django model
+</topics/db/models>`::
+
+    myuser.groups.set([group_list])
+    myuser.groups.add(group, group, ...)
+    myuser.groups.remove(group, group, ...)
+    myuser.groups.clear()
+    myuser.user_permissions.set([permission_list])
+    myuser.user_permissions.add(permission, permission, ...)
+    myuser.user_permissions.remove(permission, permission, ...)
+    myuser.user_permissions.clear()
+
+Default permissions
+-------------------
+
+When ``django.contrib.auth`` is listed in your :setting:`INSTALLED_APPS`
+setting, it will ensure that four default permissions -- add, change, delete,
+and view -- are created for each Django model defined in one of your installed
+applications.
+
+These permissions will be created when you run :djadmin:`manage.py migrate
+<migrate>`; the first time you run ``migrate`` after adding
+``django.contrib.auth`` to :setting:`INSTALLED_APPS`, the default permissions
+will be created for all previously-installed models, as well as for any new
+models being installed at that time. Afterward, it will create default
+permissions for new models each time you run :djadmin:`manage.py migrate
+<migrate>` (the function that creates permissions is connected to the
+:data:`~django.db.models.signals.post_migrate` signal).
+
+Assuming you have an application with an
+:attr:`~django.db.models.Options.app_label` ``foo`` and a model named ``Bar``,
+to test for basic permissions you should use:
+
+* add: ``user.has_perm('foo.add_bar')``
+* change: ``user.has_perm('foo.change_bar')``
+* delete: ``user.has_perm('foo.delete_bar')``
+* view: ``user.has_perm('foo.view_bar')``
+
+The :class:`~django.contrib.auth.models.Permission` model is rarely accessed
+directly.
+
+Groups
+------
+
+:class:`django.contrib.auth.models.Group` models are a generic way of
+categorizing users so you can apply permissions, or some other label, to those
+users. A user can belong to any number of groups.
+
+A user in a group automatically has the permissions granted to that group. For
+example, if the group ``Site editors`` has the permission
+``can_edit_home_page``, any user in that group will have that permission.
+
+Beyond permissions, groups are a convenient way to categorize users to give
+them some label, or extended functionality. For example, you could create a
+group ``'Special users'``, and you could write code that could, say, give them
+access to a members-only portion of your site, or send them members-only email
+messages.
+
+Programmatically creating permissions
+-------------------------------------
+
+While :ref:`custom permissions <custom-permissions>` can be defined within
+a model's ``Meta`` class, you can also create permissions directly. For
+example, you can create the ``can_publish`` permission for a ``BlogPost`` model
+in ``myapp``::
+
+    from myapp.models import BlogPost
+    from django.contrib.auth.models import Permission
+    from django.contrib.contenttypes.models import ContentType
+
+    content_type = ContentType.objects.get_for_model(BlogPost)
+    permission = Permission.objects.create(
+        codename="can_publish",
+        name="Can Publish Posts",
+        content_type=content_type,
+    )
+
+The permission can then be assigned to a
+:class:`~django.contrib.auth.models.User` via its ``user_permissions``
+attribute or to a :class:`~django.contrib.auth.models.Group` via its
+``permissions`` attribute.
+
+.. admonition:: Proxy models need their own content type
+
+    If you want to create :ref:`permissions for a proxy model
+    <proxy-models-permissions-topic>`, pass ``for_concrete_model=False`` to
+    :meth:`.ContentTypeManager.get_for_model` to get the appropriate
+    ``ContentType``::
+
+        content_type = ContentType.objects.get_for_model(
+            BlogPostProxy, for_concrete_model=False
+        )
+
+Permission caching
+------------------
+
+The :class:`~django.contrib.auth.backends.ModelBackend` caches permissions on
+the user object after the first time they need to be fetched for a permissions
+check. This is typically fine for the request-response cycle since permissions
+aren't typically checked immediately after they are added (in the admin, for
+example). If you are adding permissions and checking them immediately
+afterward, in a test or view for example, the easiest solution is to re-fetch
+the user from the database. For example::
+
+    from django.contrib.auth.models import Permission, User
+    from django.contrib.contenttypes.models import ContentType
+    from django.shortcuts import get_object_or_404
+
+    from myapp.models import BlogPost
+
+
+    def user_gains_perms(request, user_id):
+        user = get_object_or_404(User, pk=user_id)
+        # any permission check will cache the current set of permissions
+        user.has_perm("myapp.change_blogpost")
+
+        content_type = ContentType.objects.get_for_model(BlogPost)
+        permission = Permission.objects.get(
+            codename="change_blogpost",
+            content_type=content_type,
+        )
+        user.user_permissions.add(permission)
+
+        # Checking the cached permission set
+        user.has_perm("myapp.change_blogpost")  # False
+
+        # Request new instance of User
+        # Be aware that user.refresh_from_db() won't clear the cache.
+        user = get_object_or_404(User, pk=user_id)
+
+        # Permission cache is repopulated from the database
+        user.has_perm("myapp.change_blogpost")  # True
+
+        ...
+
+.. _proxy-models-permissions-topic:
+
+Proxy models
+------------
+
+Proxy models work exactly the same way as concrete models. Permissions are
+created using the own content type of the proxy model. Proxy models don't
+inherit the permissions of the concrete model they subclass::
+
+    class Person(models.Model):
+        class Meta:
+            permissions = [("can_eat_pizzas", "Can eat pizzas")]
+
+
+    class Student(Person):
+        class Meta:
+            proxy = True
+            permissions = [("can_deliver_pizzas", "Can deliver pizzas")]
+
+.. code-block:: pycon
+
+    >>> # Fetch the content type for the proxy model.
+    >>> content_type = ContentType.objects.get_for_model(Student, for_concrete_model=False)
+    >>> student_permissions = Permission.objects.filter(content_type=content_type)
+    >>> [p.codename for p in student_permissions]
+    ['add_student', 'change_student', 'delete_student', 'view_student',
+    'can_deliver_pizzas']
+    >>> for permission in student_permissions:
+    ...     user.user_permissions.add(permission)
+    ...
+    >>> user.has_perm("app.add_person")
+    False
+    >>> user.has_perm("app.can_eat_pizzas")
+    False
+    >>> user.has_perms(("app.add_student", "app.can_deliver_pizzas"))
+    True
+
+.. _auth-web-requests:
+
+Authentication in web requests
+==============================
+
+Django uses :doc:`sessions </topics/http/sessions>` and middleware to hook the
+authentication system into :class:`request objects <django.http.HttpRequest>`.
+
+These provide a :attr:`request.user <django.http.HttpRequest.user>`  attribute
+and a :meth:`request.auser <django.http.HttpRequest.auser>` async method
+on every request which represents the current user. If the current user has not
+logged in, this attribute will be set to an instance
+of :class:`~django.contrib.auth.models.AnonymousUser`, otherwise it will be an
+instance of :class:`~django.contrib.auth.models.User`.
+
+You can tell them apart with
+:attr:`~django.contrib.auth.models.User.is_authenticated`, like so::
+
+    if request.user.is_authenticated:
+        # Do something for authenticated users.
+        ...
+    else:
+        # Do something for anonymous users.
+        ...
+
+Or in an asynchronous view::
+
+    user = await request.auser()
+    if user.is_authenticated:
+        # Do something for authenticated users.
+        ...
+    else:
+        # Do something for anonymous users.
+        ...
+
+.. versionchanged:: 5.0
+
+    The :meth:`.HttpRequest.auser` method was added.
+
+.. _how-to-log-a-user-in:
+
+How to log a user in
+--------------------
+
+If you have an authenticated user you want to attach to the current session
+- this is done with a :func:`~django.contrib.auth.login` function.
+
+.. function:: login(request, user, backend=None)
+.. function:: alogin(request, user, backend=None)
+
+    *Asynchronous version*: ``alogin()``
+
+    To log a user in, from a view, use :func:`~django.contrib.auth.login()`. It
+    takes an :class:`~django.http.HttpRequest` object and a
+    :class:`~django.contrib.auth.models.User` object.
+    :func:`~django.contrib.auth.login()` saves the user's ID in the session,
+    using Django's session framework.
+
+    Note that any data set during the anonymous session is retained in the
+    session after a user logs in.
+
+    This example shows how you might use both
+    :func:`~django.contrib.auth.authenticate()` and
+    :func:`~django.contrib.auth.login()`::
+
+        from django.contrib.auth import authenticate, login
+
+
+        def my_view(request):
+            username = request.POST["username"]
+            password = request.POST["password"]
+            user = authenticate(request, username=username, password=password)
+            if user is not None:
+                login(request, user)
+                # Redirect to a success page.
+                ...
+            else:
+                # Return an 'invalid login' error message.
+                ...
+
+    .. versionchanged:: 5.0
+
+        ``alogin()`` function was added.
+
+Selecting the authentication backend
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+When a user logs in, the user's ID and the backend that was used for
+authentication are saved in the user's session. This allows the same
+:ref:`authentication backend <authentication-backends>` to fetch the user's
+details on a future request. The authentication backend to save in the session
+is selected as follows:
+
+#. Use the value of the optional ``backend`` argument, if provided.
+#. Use the value of the ``user.backend`` attribute, if present. This allows
+   pairing :func:`~django.contrib.auth.authenticate()` and
+   :func:`~django.contrib.auth.login()`:
+   :func:`~django.contrib.auth.authenticate()`
+   sets the ``user.backend`` attribute on the user object it returns.
+#. Use the ``backend`` in :setting:`AUTHENTICATION_BACKENDS`, if there is only
+   one.
+#. Otherwise, raise an exception.
+
+In cases 1 and 2, the value of the ``backend`` argument or the ``user.backend``
+attribute should be a dotted import path string (like that found in
+:setting:`AUTHENTICATION_BACKENDS`), not the actual backend class.
+
+How to log a user out
+---------------------
+
+.. function:: logout(request)
+.. function:: alogout(request)
+
+    *Asynchronous version*: ``alogout()``
+
+    To log out a user who has been logged in via
+    :func:`django.contrib.auth.login()`, use
+    :func:`django.contrib.auth.logout()` within your view. It takes an
+    :class:`~django.http.HttpRequest` object and has no return value.
+    Example::
+
+        from django.contrib.auth import logout
+
+
+        def logout_view(request):
+            logout(request)
+            # Redirect to a success page.
+
+    Note that :func:`~django.contrib.auth.logout()` doesn't throw any errors if
+    the user wasn't logged in.
+
+    When you call :func:`~django.contrib.auth.logout()`, the session data for
+    the current request is completely cleaned out. All existing data is
+    removed. This is to prevent another person from using the same web browser
+    to log in and have access to the previous user's session data. If you want
+    to put anything into the session that will be available to the user
+    immediately after logging out, do that *after* calling
+    :func:`django.contrib.auth.logout()`.
+
+    .. versionchanged:: 5.0
+
+        ``alogout()`` function was added.
+
+Limiting access to logged-in users
+----------------------------------
+
+The raw way
+~~~~~~~~~~~
+
+The raw way to limit access to pages is to check
+:attr:`request.user.is_authenticated
+<django.contrib.auth.models.User.is_authenticated>` and either redirect to a
+login page::
+
+    from django.conf import settings
+    from django.shortcuts import redirect
+
+
+    def my_view(request):
+        if not request.user.is_authenticated:
+            return redirect(f"{settings.LOGIN_URL}?next={request.path}")
+        # ...
+
+...or display an error message::
+
+    from django.shortcuts import render
+
+
+    def my_view(request):
+        if not request.user.is_authenticated:
+            return render(request, "myapp/login_error.html")
+        # ...
+
+.. currentmodule:: django.contrib.auth.decorators
+
+The ``login_required`` decorator
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. function:: login_required(redirect_field_name='next', login_url=None)
+
+    As a shortcut, you can use the convenient
+    :func:`~django.contrib.auth.decorators.login_required` decorator::
+
+        from django.contrib.auth.decorators import login_required
+
+
+        @login_required
+        def my_view(request):
+            ...
+
+    :func:`~django.contrib.auth.decorators.login_required` does the following:
+
+    * If the user isn't logged in, redirect to
+      :setting:`settings.LOGIN_URL <LOGIN_URL>`, passing the current absolute
+      path in the query string. Example: ``/accounts/login/?next=/polls/3/``.
+
+    * If the user is logged in, execute the view normally. The view code is
+      free to assume the user is logged in.
+
+    By default, the path that the user should be redirected to upon
+    successful authentication is stored in a query string parameter called
+    ``"next"``. If you would prefer to use a different name for this parameter,
+    :func:`~django.contrib.auth.decorators.login_required` takes an
+    optional ``redirect_field_name`` parameter::
+
+        from django.contrib.auth.decorators import login_required
+
+
+        @login_required(redirect_field_name="my_redirect_field")
+        def my_view(request):
+            ...
+
+    Note that if you provide a value to ``redirect_field_name``, you will most
+    likely need to customize your login template as well, since the template
+    context variable which stores the redirect path will use the value of
+    ``redirect_field_name`` as its key rather than ``"next"`` (the default).
+
+    :func:`~django.contrib.auth.decorators.login_required` also takes an
+    optional ``login_url`` parameter. Example::
+
+        from django.contrib.auth.decorators import login_required
+
+
+        @login_required(login_url="/accounts/login/")
+        def my_view(request):
+            ...
+
+    Note that if you don't specify the ``login_url`` parameter, you'll need to
+    ensure that the :setting:`settings.LOGIN_URL <LOGIN_URL>` and your login
+    view are properly associated. For example, using the defaults, add the
+    following lines to your URLconf::
+
+        from django.contrib.auth import views as auth_views
+
+        path("accounts/login/", auth_views.LoginView.as_view()),
+
+    The :setting:`settings.LOGIN_URL <LOGIN_URL>` also accepts view function
+    names and :ref:`named URL patterns <naming-url-patterns>`. This allows you
+    to freely remap your login view within your URLconf without having to
+    update the setting.
+
+.. note::
+
+    The ``login_required`` decorator does NOT check the ``is_active`` flag on a
+    user, but the default :setting:`AUTHENTICATION_BACKENDS` reject inactive
+    users.
+
+.. seealso::
+
+    If you are writing custom views for Django's admin (or need the same
+    authorization check that the built-in views use), you may find the
+    :func:`django.contrib.admin.views.decorators.staff_member_required`
+    decorator a useful alternative to ``login_required()``.
+
+.. currentmodule:: django.contrib.auth.mixins
+
+The ``LoginRequiredMixin`` mixin
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+When using :doc:`class-based views </topics/class-based-views/index>`, you can
+achieve the same behavior as with ``login_required`` by using the
+``LoginRequiredMixin``. This mixin should be at the leftmost position in the
+inheritance list.
+
+.. class:: LoginRequiredMixin
+
+    If a view is using this mixin, all requests by non-authenticated users will
+    be redirected to the login page or shown an HTTP 403 Forbidden error,
+    depending on the
+    :attr:`~django.contrib.auth.mixins.AccessMixin.raise_exception` parameter.
+
+    You can set any of the parameters of
+    :class:`~django.contrib.auth.mixins.AccessMixin` to customize the handling
+    of unauthorized users::
+
+
+        from django.contrib.auth.mixins import LoginRequiredMixin
+
+
+        class MyView(LoginRequiredMixin, View):
+            login_url = "/login/"
+            redirect_field_name = "redirect_to"
+
+.. note::
+
+    Just as the ``login_required`` decorator, this mixin does NOT check the
+    ``is_active`` flag on a user, but the default
+    :setting:`AUTHENTICATION_BACKENDS` reject inactive users.
+
+.. currentmodule:: django.contrib.auth.decorators
+
+Limiting access to logged-in users that pass a test
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+To limit access based on certain permissions or some other test, you'd do
+essentially the same thing as described in the previous section.
+
+You can run your test on :attr:`request.user <django.http.HttpRequest.user>` in
+the view directly. For example, this view checks to make sure the user has an
+email in the desired domain and if not, redirects to the login page::
+
+    from django.shortcuts import redirect
+
+
+    def my_view(request):
+        if not request.user.email.endswith("@example.com"):
+            return redirect("/login/?next=%s" % request.path)
+        # ...
+
+.. function:: user_passes_test(test_func, login_url=None, redirect_field_name='next')
+
+    As a shortcut, you can use the convenient ``user_passes_test`` decorator
+    which performs a redirect when the callable returns ``False``::
+
+        from django.contrib.auth.decorators import user_passes_test
+
+
+        def email_check(user):
+            return user.email.endswith("@example.com")
+
+
+        @user_passes_test(email_check)
+        def my_view(request):
+            ...
+
+    :func:`~django.contrib.auth.decorators.user_passes_test` takes a required
+    argument: a callable that takes a
+    :class:`~django.contrib.auth.models.User` object and returns ``True`` if
+    the user is allowed to view the page. Note that
+    :func:`~django.contrib.auth.decorators.user_passes_test` does not
+    automatically check that the :class:`~django.contrib.auth.models.User` is
+    not anonymous.
+
+    :func:`~django.contrib.auth.decorators.user_passes_test` takes two
+    optional arguments:
+
+    ``login_url``
+       Lets you specify the URL that users who don't pass the test will be
+       redirected to. It may be a login page and defaults to
+       :setting:`settings.LOGIN_URL <LOGIN_URL>` if you don't specify one.
+
+    ``redirect_field_name``
+       Same as for :func:`~django.contrib.auth.decorators.login_required`.
+       Setting it to ``None`` removes it from the URL, which you may want to do
+       if you are redirecting users that don't pass the test to a non-login
+       page where there's no "next page".
+
+    For example::
+
+        @user_passes_test(email_check, login_url="/login/")
+        def my_view(request):
+            ...
+
+.. currentmodule:: django.contrib.auth.mixins
+
+.. class:: UserPassesTestMixin
+
+    When using :doc:`class-based views </topics/class-based-views/index>`, you
+    can use the ``UserPassesTestMixin`` to do this.
+
+    .. method:: test_func()
+
+        You have to override the ``test_func()`` method of the class to
+        provide the test that is performed. Furthermore, you can set any of the
+        parameters of :class:`~django.contrib.auth.mixins.AccessMixin` to
+        customize the handling of unauthorized users::
+
+            from django.contrib.auth.mixins import UserPassesTestMixin
+
+
+            class MyView(UserPassesTestMixin, View):
+                def test_func(self):
+                    return self.request.user.email.endswith("@example.com")
+
+    .. method:: get_test_func()
+
+        You can also override the ``get_test_func()`` method to have the mixin
+        use a differently named function for its checks (instead of
+        :meth:`test_func`).
+
+    .. admonition:: Stacking ``UserPassesTestMixin``
+
+        Due to the way ``UserPassesTestMixin`` is implemented, you cannot stack
+        them in your inheritance list. The following does NOT work::
+
+            class TestMixin1(UserPassesTestMixin):
+                def test_func(self):
+                    return self.request.user.email.endswith("@example.com")
+
+
+            class TestMixin2(UserPassesTestMixin):
+                def test_func(self):
+                    return self.request.user.username.startswith("django")
+
+
+            class MyView(TestMixin1, TestMixin2, View):
+                ...
+
+        If ``TestMixin1`` would call ``super()`` and take that result into
+        account, ``TestMixin1`` wouldn't work standalone anymore.
+
+.. currentmodule:: django.contrib.auth.decorators
+
+The ``permission_required`` decorator
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. function:: permission_required(perm, login_url=None, raise_exception=False)
+
+    It's a relatively common task to check whether a user has a particular
+    permission. For that reason, Django provides a shortcut for that case: the
+    :func:`~django.contrib.auth.decorators.permission_required()` decorator.::
+
+        from django.contrib.auth.decorators import permission_required
+
+
+        @permission_required("polls.add_choice")
+        def my_view(request):
+            ...
+
+    Just like the :meth:`~django.contrib.auth.models.User.has_perm` method,
+    permission names take the form ``"<app label>.<permission codename>"``
+    (i.e. ``polls.add_choice`` for a permission on a model in the ``polls``
+    application).
+
+    The decorator may also take an iterable of permissions, in which case the
+    user must have all of the permissions in order to access the view.
+
+    Note that :func:`~django.contrib.auth.decorators.permission_required()`
+    also takes an optional ``login_url`` parameter::
+
+        from django.contrib.auth.decorators import permission_required
+
+
+        @permission_required("polls.add_choice", login_url="/loginpage/")
+        def my_view(request):
+            ...
+
+    As in the :func:`~django.contrib.auth.decorators.login_required` decorator,
+    ``login_url`` defaults to :setting:`settings.LOGIN_URL <LOGIN_URL>`.
+
+    If the ``raise_exception`` parameter is given, the decorator will raise
+    :exc:`~django.core.exceptions.PermissionDenied`, prompting :ref:`the 403
+    (HTTP Forbidden) view<http_forbidden_view>` instead of redirecting to the
+    login page.
+
+    If you want to use ``raise_exception`` but also give your users a chance to
+    login first, you can add the
+    :func:`~django.contrib.auth.decorators.login_required` decorator::
+
+        from django.contrib.auth.decorators import login_required, permission_required
+
+
+        @login_required
+        @permission_required("polls.add_choice", raise_exception=True)
+        def my_view(request):
+            ...
+
+    This also avoids a redirect loop when :class:`.LoginView`'s
+    ``redirect_authenticated_user=True`` and the logged-in user doesn't have
+    all of the required permissions.
+
+.. currentmodule:: django.contrib.auth.mixins
+
+The ``PermissionRequiredMixin`` mixin
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+To apply permission checks to :doc:`class-based views
+</ref/class-based-views/index>`, you can use the ``PermissionRequiredMixin``:
+
+.. class:: PermissionRequiredMixin
+
+    This mixin, just like the ``permission_required``
+    decorator, checks whether the user accessing a view has all given
+    permissions. You should specify the permission (or an iterable of
+    permissions) using the ``permission_required`` parameter::
+
+        from django.contrib.auth.mixins import PermissionRequiredMixin
+
+
+        class MyView(PermissionRequiredMixin, View):
+            permission_required = "polls.add_choice"
+            # Or multiple of permissions:
+            permission_required = ["polls.view_choice", "polls.change_choice"]
+
+    You can set any of the parameters of
+    :class:`~django.contrib.auth.mixins.AccessMixin` to customize the handling
+    of unauthorized users.
+
+    You may also override these methods:
+
+    .. method:: get_permission_required()
+
+        Returns an iterable of permission names used by the mixin. Defaults to
+        the ``permission_required`` attribute, converted to a tuple if
+        necessary.
+
+    .. method:: has_permission()
+
+        Returns a boolean denoting whether the current user has permission to
+        execute the decorated view. By default, this returns the result of
+        calling :meth:`~django.contrib.auth.models.User.has_perms()` with the
+        list of permissions returned by :meth:`get_permission_required()`.
+
+Redirecting unauthorized requests in class-based views
+------------------------------------------------------
+
+To ease the handling of access restrictions in :doc:`class-based views
+</ref/class-based-views/index>`, the ``AccessMixin`` can be used to configure
+the behavior of a view when access is denied. Authenticated users are denied
+access with an HTTP 403 Forbidden response. Anonymous users are redirected to
+the login page or shown an HTTP 403 Forbidden response, depending on the
+:attr:`~django.contrib.auth.mixins.AccessMixin.raise_exception` attribute.
+
+.. class:: AccessMixin
+
+    .. attribute:: login_url
+
+        Default return value for :meth:`get_login_url`.  Defaults to ``None``
+        in which case :meth:`get_login_url` falls back to
+        :setting:`settings.LOGIN_URL <LOGIN_URL>`.
+
+    .. attribute:: permission_denied_message
+
+        Default return value for :meth:`get_permission_denied_message`.
+        Defaults to an empty string.
+
+    .. attribute:: redirect_field_name
+
+        Default return value for :meth:`get_redirect_field_name`. Defaults to
+        ``"next"``.
+
+    .. attribute:: raise_exception
+
+        If this attribute is set to ``True``, a
+        :class:`~django.core.exceptions.PermissionDenied` exception is raised
+        when the conditions are not met.  When ``False`` (the default),
+        anonymous users are redirected to the login page.
+
+    .. method:: get_login_url()
+
+         Returns the URL that users who don't pass the test will be redirected
+         to. Returns :attr:`login_url` if set, or :setting:`settings.LOGIN_URL
+         <LOGIN_URL>` otherwise.
+
+    .. method:: get_permission_denied_message()
+
+        When :attr:`raise_exception` is ``True``, this method can be used to
+        control the error message passed to the error handler for display to
+        the user. Returns the :attr:`permission_denied_message` attribute by
+        default.
+
+    .. method:: get_redirect_field_name()
+
+        Returns the name of the query parameter that will contain the URL the
+        user should be redirected to after a successful login. If you set this
+        to ``None``, a query parameter won't be added. Returns the
+        :attr:`redirect_field_name` attribute by default.
+
+    .. method:: handle_no_permission()
+
+        Depending on the value of ``raise_exception``, the method either raises
+        a :exc:`~django.core.exceptions.PermissionDenied` exception or
+        redirects the user to the ``login_url``, optionally including the
+        ``redirect_field_name`` if it is set.
+
+.. currentmodule:: django.contrib.auth
+
+.. _session-invalidation-on-password-change:
+
+Session invalidation on password change
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+If your :setting:`AUTH_USER_MODEL` inherits from
+:class:`~django.contrib.auth.models.AbstractBaseUser` or implements its own
+:meth:`~django.contrib.auth.models.AbstractBaseUser.get_session_auth_hash()`
+method, authenticated sessions will include the hash returned by this function.
+In the :class:`~django.contrib.auth.models.AbstractBaseUser` case, this is an
+HMAC of the password field. Django verifies that the hash in the session for
+each request matches the one that's computed during the request. This allows a
+user to log out all of their sessions by changing their password.
+
+The default password change views included with Django,
+:class:`~django.contrib.auth.views.PasswordChangeView` and the
+``user_change_password`` view in the :mod:`django.contrib.auth` admin, update
+the session with the new password hash so that a user changing their own
+password won't log themselves out. If you have a custom password change view
+and wish to have similar behavior, use the :func:`update_session_auth_hash`
+function.
+
+.. function:: update_session_auth_hash(request, user)
+.. function:: aupdate_session_auth_hash(request, user)
+
+    *Asynchronous version*: ``aupdate_session_auth_hash()``
+
+    This function takes the current request and the updated user object from
+    which the new session hash will be derived and updates the session hash
+    appropriately. It also rotates the session key so that a stolen session
+    cookie will be invalidated.
+
+    Example usage::
+
+        from django.contrib.auth import update_session_auth_hash
+
+
+        def password_change(request):
+            if request.method == "POST":
+                form = PasswordChangeForm(user=request.user, data=request.POST)
+                if form.is_valid():
+                    form.save()
+                    update_session_auth_hash(request, form.user)
+            else:
+                ...
+
+    .. versionchanged:: 5.0
+
+        ``aupdate_session_auth_hash()`` function was added.
+
+.. note::
+
+    Since
+    :meth:`~django.contrib.auth.models.AbstractBaseUser.get_session_auth_hash()`
+    is based on :setting:`SECRET_KEY`, secret key values must be
+    rotated to avoid invalidating existing sessions when updating your site to
+    use a new secret. See :setting:`SECRET_KEY_FALLBACKS` for details.
+
+.. _built-in-auth-views:
+
+Authentication Views
+--------------------
+
+.. module:: django.contrib.auth.views
+
+Django provides several views that you can use for handling login, logout, and
+password management. These make use of the :ref:`stock auth forms
+<built-in-auth-forms>` but you can pass in your own forms as well.
+
+Django provides no default template for the authentication views. You should
+create your own templates for the views you want to use. The template context
+is documented in each view, see :ref:`all-authentication-views`.
+
+.. _using-the-views:
+
+Using the views
+~~~~~~~~~~~~~~~
+
+There are different methods to implement these views in your project. The
+easiest way is to include the provided URLconf in ``django.contrib.auth.urls``
+in your own URLconf, for example::
+
+    urlpatterns = [
+        path("accounts/", include("django.contrib.auth.urls")),
+    ]
+
+This will include the following URL patterns:
+
+.. code-block:: text
+
+    accounts/login/ [name='login']
+    accounts/logout/ [name='logout']
+    accounts/password_change/ [name='password_change']
+    accounts/password_change/done/ [name='password_change_done']
+    accounts/password_reset/ [name='password_reset']
+    accounts/password_reset/done/ [name='password_reset_done']
+    accounts/reset/<uidb64>/<token>/ [name='password_reset_confirm']
+    accounts/reset/done/ [name='password_reset_complete']
+
+The views provide a URL name for easier reference. See :doc:`the URL
+documentation </topics/http/urls>` for details on using named URL patterns.
+
+If you want more control over your URLs, you can reference a specific view in
+your URLconf::
+
+    from django.contrib.auth import views as auth_views
+
+    urlpatterns = [
+        path("change-password/", auth_views.PasswordChangeView.as_view()),
+    ]
+
+The views have optional arguments you can use to alter the behavior of the
+view. For example, if you want to change the template name a view uses, you can
+provide the ``template_name`` argument. A way to do this is to provide keyword
+arguments in the URLconf, these will be passed on to the view. For example::
+
+    urlpatterns = [
+        path(
+            "change-password/",
+            auth_views.PasswordChangeView.as_view(template_name="change-password.html"),
+        ),
+    ]
+
+All views are :doc:`class-based </topics/class-based-views/index>`, which allows
+you to easily customize them by subclassing.
+
+.. _all-authentication-views:
+
+All authentication views
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+This is a list with all the views ``django.contrib.auth`` provides. For
+implementation details see :ref:`using-the-views`.
+
+.. class:: LoginView
+
+    **URL name:** ``login``
+
+    See :doc:`the URL documentation </topics/http/urls>` for details on using
+    named URL patterns.
+
+    **Methods and Attributes**
+
+    .. attribute:: template_name
+
+        The name of a template to display for the view used to log the user in.
+        Defaults to :file:`registration/login.html`.
+
+    .. attribute:: next_page
+
+        The URL to redirect to after login. Defaults to
+        :setting:`LOGIN_REDIRECT_URL`.
+
+    .. attribute:: redirect_field_name
+
+        The name of a ``GET`` field containing the URL to redirect to after
+        login. Defaults to ``next``. Overrides the
+        :meth:`get_default_redirect_url` URL if the given ``GET`` parameter is
+        passed.
+
+    .. attribute:: authentication_form
+
+        A callable (typically a form class) to use for authentication. Defaults
+        to :class:`~django.contrib.auth.forms.AuthenticationForm`.
+
+    .. attribute:: extra_context
+
+        A dictionary of context data that will be added to the default context
+        data passed to the template.
+
+    .. attribute:: redirect_authenticated_user
+
+        A boolean that controls whether or not authenticated users accessing
+        the login page will be redirected as if they had just successfully
+        logged in. Defaults to ``False``.
+
+        .. warning::
+
+            If you enable ``redirect_authenticated_user``, other websites will
+            be able to determine if their visitors are authenticated on your
+            site by requesting redirect URLs to image files on your website. To
+            avoid this "`social media fingerprinting
+            <https://robinlinus.github.io/socialmedia-leak/>`_" information
+            leakage, host all images and your favicon on a separate domain.
+
+            Enabling ``redirect_authenticated_user`` can also result in a
+            redirect loop when using the :func:`.permission_required` decorator
+            unless the ``raise_exception`` parameter is used.
+
+    .. attribute:: success_url_allowed_hosts
+
+        A :class:`set` of hosts, in addition to :meth:`request.get_host()
+        <django.http.HttpRequest.get_host>`, that are safe for redirecting
+        after login. Defaults to an empty :class:`set`.
+
+    .. method:: get_default_redirect_url()
+
+        Returns the URL to redirect to after login. The default implementation
+        resolves and returns :attr:`next_page` if set, or
+        :setting:`LOGIN_REDIRECT_URL` otherwise.
+
+    Here's what ``LoginView`` does:
+
+    * If called via ``GET``, it displays a login form that POSTs to the
+      same URL. More on this in a bit.
+
+    * If called via ``POST`` with user submitted credentials, it tries to log
+      the user in. If login is successful, the view redirects to the URL
+      specified in ``next``. If ``next`` isn't provided, it redirects to
+      :setting:`settings.LOGIN_REDIRECT_URL <LOGIN_REDIRECT_URL>` (which
+      defaults to ``/accounts/profile/``). If login isn't successful, it
+      redisplays the login form.
+
+    It's your responsibility to provide the html for the login template
+    , called ``registration/login.html`` by default. This template gets passed
+    four template context variables:
+
+    * ``form``: A :class:`~django.forms.Form` object representing the
+      :class:`~django.contrib.auth.forms.AuthenticationForm`.
+
+    * ``next``: The URL to redirect to after successful login. This may
+      contain a query string, too.
+
+    * ``site``: The current :class:`~django.contrib.sites.models.Site`,
+      according to the :setting:`SITE_ID` setting. If you don't have the
+      site framework installed, this will be set to an instance of
+      :class:`~django.contrib.sites.requests.RequestSite`, which derives the
+      site name and domain from the current
+      :class:`~django.http.HttpRequest`.
+
+    * ``site_name``: An alias for ``site.name``. If you don't have the site
+      framework installed, this will be set to the value of
+      :attr:`request.META['SERVER_NAME'] <django.http.HttpRequest.META>`.
+      For more on sites, see :doc:`/ref/contrib/sites`.
+
+    If you'd prefer not to call the template :file:`registration/login.html`,
+    you can pass the ``template_name`` parameter via the extra arguments to
+    the ``as_view`` method in your URLconf. For example, this URLconf line would
+    use :file:`myapp/login.html` instead::
+
+        path("accounts/login/", auth_views.LoginView.as_view(template_name="myapp/login.html")),
+
+    You can also specify the name of the ``GET`` field which contains the URL
+    to redirect to after login using ``redirect_field_name``. By default, the
+    field is called ``next``.
+
+    Here's a sample :file:`registration/login.html` template you can use as a
+    starting point. It assumes you have a :file:`base.html` template that
+    defines a ``content`` block:
+
+    .. code-block:: html+django
+
+        {% extends "base.html" %}
+
+        {% block content %}
+
+        {% if form.errors %}
+        <p>Your username and password didn't match. Please try again.</p>
+        {% endif %}
+
+        {% if next %}
+            {% if user.is_authenticated %}
+            <p>Your account doesn't have access to this page. To proceed,
+            please login with an account that has access.</p>
+            {% else %}
+            <p>Please login to see this page.</p>
+            {% endif %}
+        {% endif %}
+
+        <form method="post" action="{% url 'login' %}">
+        {% csrf_token %}
+        <table>
+        <tr>
+            <td>{{ form.username.label_tag }}</td>
+            <td>{{ form.username }}</td>
+        </tr>
+        <tr>
+            <td>{{ form.password.label_tag }}</td>
+            <td>{{ form.password }}</td>
+        </tr>
+        </table>
+
+        <input type="submit" value="login">
+        <input type="hidden" name="next" value="{{ next }}">
+        </form>
+
+        {# Assumes you set up the password_reset view in your URLconf #}
+        <p><a href="{% url 'password_reset' %}">Lost password?</a></p>
+
+        {% endblock %}
+
+    If you have customized authentication (see :doc:`Customizing Authentication
+    </topics/auth/customizing>`) you can use a custom authentication form by
+    setting the ``authentication_form`` attribute. This form must accept a
+    ``request`` keyword argument in its ``__init__()`` method and provide a
+    ``get_user()`` method which returns the authenticated user object (this
+    method is only ever called after successful form validation).
+
+.. class:: LogoutView
+
+    Logs a user out on ``POST`` requests.
+
+    **URL name:** ``logout``
+
+    **Attributes:**
+
+    .. attribute:: next_page
+
+        The URL to redirect to after logout. Defaults to
+        :setting:`LOGOUT_REDIRECT_URL`.
+
+    .. attribute:: template_name
+
+        The full name of a template to display after logging the user out.
+        Defaults to :file:`registration/logged_out.html`.
+
+    .. attribute:: redirect_field_name
+
+        The name of a ``GET`` field containing the URL to redirect to after log
+        out. Defaults to ``'next'``. Overrides the
+        :attr:`next_page` URL if the given ``GET`` parameter is
+        passed.
+
+    .. attribute:: extra_context
+
+        A dictionary of context data that will be added to the default context
+        data passed to the template.
+
+    .. attribute:: success_url_allowed_hosts
+
+        A :class:`set` of hosts, in addition to :meth:`request.get_host()
+        <django.http.HttpRequest.get_host>`, that are safe for redirecting
+        after logout. Defaults to an empty :class:`set`.
+
+    **Template context:**
+
+    * ``title``: The string "Logged out", localized.
+
+    * ``site``: The current :class:`~django.contrib.sites.models.Site`,
+      according to the :setting:`SITE_ID` setting. If you don't have the
+      site framework installed, this will be set to an instance of
+      :class:`~django.contrib.sites.requests.RequestSite`, which derives the
+      site name and domain from the current
+      :class:`~django.http.HttpRequest`.
+
+    * ``site_name``: An alias for ``site.name``. If you don't have the site
+      framework installed, this will be set to the value of
+      :attr:`request.META['SERVER_NAME'] <django.http.HttpRequest.META>`.
+      For more on sites, see :doc:`/ref/contrib/sites`.
+
+.. function:: logout_then_login(request, login_url=None)
+
+    Logs a user out on ``POST`` requests, then redirects to the login page.
+
+    **URL name:** No default URL provided
+
+    **Optional arguments:**
+
+    * ``login_url``: The URL of the login page to redirect to.
+      Defaults to :setting:`settings.LOGIN_URL <LOGIN_URL>` if not supplied.
+
+    .. deprecated:: 4.1
+
+        Support for logging out on ``GET`` requests is deprecated and will be
+        removed in Django 5.0.
+
+.. class:: PasswordChangeView
+
+    **URL name:** ``password_change``
+
+    Allows a user to change their password.
+
+    **Attributes:**
+
+    .. attribute:: template_name
+
+        The full name of a template to use for displaying the password change
+        form. Defaults to :file:`registration/password_change_form.html` if not
+        supplied.
+
+    .. attribute:: success_url
+
+        The URL to redirect to after a successful password change. Defaults to
+        ``'password_change_done'``.
+
+    .. attribute:: form_class
+
+        A custom "change password" form which must accept a ``user`` keyword
+        argument. The form is responsible for actually changing the user's
+        password. Defaults to
+        :class:`~django.contrib.auth.forms.PasswordChangeForm`.
+
+    .. attribute:: extra_context
+
+        A dictionary of context data that will be added to the default context
+        data passed to the template.
+
+    **Template context:**
+
+    * ``form``: The password change form (see ``form_class`` above).
+
+.. class:: PasswordChangeDoneView
+
+    **URL name:** ``password_change_done``
+
+    The page shown after a user has changed their password.
+
+    **Attributes:**
+
+    .. attribute:: template_name
+
+        The full name of a template to use. Defaults to
+        :file:`registration/password_change_done.html` if not supplied.
+
+    .. attribute:: extra_context
+
+        A dictionary of context data that will be added to the default context
+        data passed to the template.
+
+.. class:: PasswordResetView
+
+    **URL name:** ``password_reset``
+
+    Allows a user to reset their password by generating a one-time use link
+    that can be used to reset the password, and sending that link to the
+    user's registered email address.
+
+    This view will send an email if the following conditions are met:
+
+    * The email address provided exists in the system.
+    * The requested user is active (``User.is_active`` is ``True``).
+    * The requested user has a usable password. Users flagged with an unusable
+      password (see
+      :meth:`~django.contrib.auth.models.User.set_unusable_password`) aren't
+      allowed to request a password reset to prevent misuse when using an
+      external authentication source like LDAP.
+
+    If any of these conditions are *not* met, no email will be sent, but the
+    user won't receive any error message either. This prevents information
+    leaking to potential attackers. If you want to provide an error message in
+    this case, you can subclass
+    :class:`~django.contrib.auth.forms.PasswordResetForm` and use the
+    ``form_class`` attribute.
+
+    .. note::
+
+        Be aware that sending an email costs extra time, hence you may be
+        vulnerable to an email address enumeration timing attack due to a
+        difference between the duration of a reset request for an existing
+        email address and the duration of a reset request for a nonexistent
+        email address. To reduce the overhead, you can use a 3rd party package
+        that allows to send emails asynchronously, e.g. :pypi:`django-mailer`.
+
+    **Attributes:**
+
+    .. attribute:: template_name
+
+        The full name of a template to use for displaying the password reset
+        form. Defaults to :file:`registration/password_reset_form.html` if not
+        supplied.
+
+    .. attribute:: form_class
+
+        Form that will be used to get the email of the user to reset the
+        password for. Defaults to
+        :class:`~django.contrib.auth.forms.PasswordResetForm`.
+
+    .. attribute:: email_template_name
+
+        The full name of a template to use for generating the email with the
+        reset password link. Defaults to
+        :file:`registration/password_reset_email.html` if not supplied.
+
+    .. attribute:: subject_template_name
+
+        The full name of a template to use for the subject of the email with
+        the reset password link. Defaults to
+        :file:`registration/password_reset_subject.txt` if not supplied.
+
+    .. attribute:: token_generator
+
+        Instance of the class to check the one time link. This will default to
+        ``default_token_generator``, it's an instance of
+        ``django.contrib.auth.tokens.PasswordResetTokenGenerator``.
+
+    .. attribute:: success_url
+
+        The URL to redirect to after a successful password reset request.
+        Defaults to ``'password_reset_done'``.
+
+    .. attribute:: from_email
+
+        A valid email address. By default Django uses the
+        :setting:`DEFAULT_FROM_EMAIL`.
+
+    .. attribute:: extra_context
+
+        A dictionary of context data that will be added to the default context
+        data passed to the template.
+
+    .. attribute:: html_email_template_name
+
+        The full name of a template to use for generating a
+        :mimetype:`text/html` multipart email with the password reset link. By
+        default, HTML email is not sent.
+
+    .. attribute:: extra_email_context
+
+        A dictionary of context data that will be available in the email
+        template. It can be used to override default template context values
+        listed below e.g. ``domain``.
+
+    **Template context:**
+
+    * ``form``: The form (see ``form_class`` above) for resetting the user's
+      password.
+
+    **Email template context:**
+
+    * ``email``: An alias for ``user.email``
+
+    * ``user``: The current :class:`~django.contrib.auth.models.User`,
+      according to the ``email`` form field. Only active users are able to
+      reset their passwords (``User.is_active is True``).
+
+    * ``site_name``: An alias for ``site.name``. If you don't have the site
+      framework installed, this will be set to the value of
+      :attr:`request.META['SERVER_NAME'] <django.http.HttpRequest.META>`.
+      For more on sites, see :doc:`/ref/contrib/sites`.
+
+    * ``domain``: An alias for ``site.domain``. If you don't have the site
+      framework installed, this will be set to the value of
+      ``request.get_host()``.
+
+    * ``protocol``: http or https
+
+    * ``uid``: The user's primary key encoded in base 64.
+
+    * ``token``: Token to check that the reset link is valid.
+
+    Sample ``registration/password_reset_email.html`` (email body template):
+
+    .. code-block:: html+django
+
+        Someone asked for password reset for email {{ email }}. Follow the link below:
+        {{ protocol}}://{{ domain }}{% url 'password_reset_confirm' uidb64=uid token=token %}
+
+    The same template context is used for subject template. Subject must be
+    single line plain text string.
+
+.. class:: PasswordResetDoneView
+
+    **URL name:** ``password_reset_done``
+
+    The page shown after a user has been emailed a link to reset their
+    password. This view is called by default if the :class:`PasswordResetView`
+    doesn't have an explicit ``success_url`` URL set.
+
+    .. note::
+
+        If the email address provided does not exist in the system, the user is
+        inactive, or has an unusable password, the user will still be
+        redirected to this view but no email will be sent.
+
+    **Attributes:**
+
+    .. attribute:: template_name
+
+        The full name of a template to use. Defaults to
+        :file:`registration/password_reset_done.html` if not supplied.
+
+    .. attribute:: extra_context
+
+        A dictionary of context data that will be added to the default context
+        data passed to the template.
+
+.. class:: PasswordResetConfirmView
+
+    **URL name:** ``password_reset_confirm``
+
+    Presents a form for entering a new password.
+
+    **Keyword arguments from the URL:**
+
+    * ``uidb64``: The user's id encoded in base 64.
+
+    * ``token``: Token to check that the password is valid.
+
+    **Attributes:**
+
+    .. attribute:: template_name
+
+        The full name of a template to display the confirm password view.
+        Default value is :file:`registration/password_reset_confirm.html`.
+
+    .. attribute:: token_generator
+
+        Instance of the class to check the password. This will default to
+        ``default_token_generator``, it's an instance of
+        ``django.contrib.auth.tokens.PasswordResetTokenGenerator``.
+
+    .. attribute:: post_reset_login
+
+        A boolean indicating if the user should be automatically authenticated
+        after a successful password reset. Defaults to ``False``.
+
+    .. attribute:: post_reset_login_backend
+
+        A dotted path to the authentication backend to use when authenticating
+        a user if ``post_reset_login`` is ``True``. Required only if you have
+        multiple :setting:`AUTHENTICATION_BACKENDS` configured. Defaults to
+        ``None``.
+
+    .. attribute:: form_class
+
+        Form that will be used to set the password. Defaults to
+        :class:`~django.contrib.auth.forms.SetPasswordForm`.
+
+    .. attribute:: success_url
+
+        URL to redirect after the password reset done. Defaults to
+        ``'password_reset_complete'``.
+
+    .. attribute:: extra_context
+
+        A dictionary of context data that will be added to the default context
+        data passed to the template.
+
+    .. attribute:: reset_url_token
+
+        Token parameter displayed as a component of password reset URLs.
+        Defaults to ``'set-password'``.
+
+    **Template context:**
+
+    * ``form``: The form (see ``form_class`` above) for setting the new user's
+      password.
+
+    * ``validlink``: Boolean, True if the link (combination of ``uidb64`` and
+      ``token``) is valid or unused yet.
+
+.. class:: PasswordResetCompleteView
+
+    **URL name:** ``password_reset_complete``
+
+    Presents a view which informs the user that the password has been
+    successfully changed.
+
+    **Attributes:**
+
+    .. attribute:: template_name
+
+        The full name of a template to display the view. Defaults to
+        :file:`registration/password_reset_complete.html`.
+
+    .. attribute:: extra_context
+
+        A dictionary of context data that will be added to the default context
+        data passed to the template.
+
+Helper functions
+----------------
+
+.. currentmodule:: django.contrib.auth.views
+
+.. function:: redirect_to_login(next, login_url=None, redirect_field_name='next')
+
+    Redirects to the login page, and then back to another URL after a
+    successful login.
+
+    **Required arguments:**
+
+    * ``next``: The URL to redirect to after a successful login.
+
+    **Optional arguments:**
+
+    * ``login_url``: The URL of the login page to redirect to.
+      Defaults to :setting:`settings.LOGIN_URL <LOGIN_URL>` if not supplied.
+
+    * ``redirect_field_name``: The name of a ``GET`` field containing the
+      URL to redirect to after log out. Overrides ``next`` if the given
+      ``GET`` parameter is passed.
+
+.. _built-in-auth-forms:
+
+Built-in forms
+--------------
+
+.. module:: django.contrib.auth.forms
+
+If you don't want to use the built-in views, but want the convenience of not
+having to write forms for this functionality, the authentication system
+provides several built-in forms located in :mod:`django.contrib.auth.forms`:
+
+.. note::
+    The built-in authentication forms make certain assumptions about the user
+    model that they are working with. If you're using a :ref:`custom user model
+    <auth-custom-user>`, it may be necessary to define your own forms for the
+    authentication system. For more information, refer to the documentation
+    about :ref:`using the built-in authentication forms with custom user models
+    <custom-users-and-the-built-in-auth-forms>`.
+
+.. class:: AdminPasswordChangeForm
+
+    A form used in the admin interface to change a user's password.
+
+    Takes the ``user`` as the first positional argument.
+
+.. class:: AuthenticationForm
+
+    A form for logging a user in.
+
+    Takes ``request`` as its first positional argument, which is stored on the
+    form instance for use by sub-classes.
+
+    .. method:: confirm_login_allowed(user)
+
+        By default, ``AuthenticationForm`` rejects users whose ``is_active``
+        flag is set to ``False``. You may override this behavior with a custom
+        policy to determine which users can log in. Do this with a custom form
+        that subclasses ``AuthenticationForm`` and overrides the
+        ``confirm_login_allowed()`` method. This method should raise a
+        :exc:`~django.core.exceptions.ValidationError` if the given user may
+        not log in.
+
+        For example, to allow all users to log in regardless of "active"
+        status::
+
+            from django.contrib.auth.forms import AuthenticationForm
+
+
+            class AuthenticationFormWithInactiveUsersOkay(AuthenticationForm):
+                def confirm_login_allowed(self, user):
+                    pass
+
+        (In this case, you'll also need to use an authentication backend that
+        allows inactive users, such as
+        :class:`~django.contrib.auth.backends.AllowAllUsersModelBackend`.)
+
+        Or to allow only some active users to log in::
+
+            class PickyAuthenticationForm(AuthenticationForm):
+                def confirm_login_allowed(self, user):
+                    if not user.is_active:
+                        raise ValidationError(
+                            _("This account is inactive."),
+                            code="inactive",
+                        )
+                    if user.username.startswith("b"):
+                        raise ValidationError(
+                            _("Sorry, accounts starting with 'b' aren't welcome here."),
+                            code="no_b_users",
+                        )
+
+.. class:: PasswordChangeForm
+
+    A form for allowing a user to change their password.
+
+.. class:: PasswordResetForm
+
+    A form for generating and emailing a one-time use link to reset a
+    user's password.
+
+    .. method:: send_mail(subject_template_name, email_template_name, context, from_email, to_email, html_email_template_name=None)
+
+        Uses the arguments to send an ``EmailMultiAlternatives``.
+        Can be overridden to customize how the email is sent to the user.
+
+        :param subject_template_name: the template for the subject.
+        :param email_template_name: the template for the email body.
+        :param context: context passed to the ``subject_template``,
+            ``email_template``, and ``html_email_template`` (if it is not
+            ``None``).
+        :param from_email: the sender's email.
+        :param to_email: the email of the requester.
+        :param html_email_template_name: the template for the HTML body;
+            defaults to ``None``, in which case a plain text email is sent.
+
+        By default, ``save()`` populates the ``context`` with the
+        same variables that
+        :class:`~django.contrib.auth.views.PasswordResetView` passes to its
+        email context.
+
+.. class:: SetPasswordForm
+
+    A form that lets a user change their password without entering the old
+    password.
+
+.. class:: UserChangeForm
+
+    A form used in the admin interface to change a user's information and
+    permissions.
+
+.. class:: BaseUserCreationForm
+
+    .. versionadded:: 4.2
+
+    A :class:`~django.forms.ModelForm` for creating a new user. This is the
+    recommended base class if you need to customize the user creation form.
+
+    It has three fields: ``username`` (from the user model), ``password1``,
+    and ``password2``. It verifies that ``password1`` and ``password2`` match,
+    validates the password using
+    :func:`~django.contrib.auth.password_validation.validate_password`, and
+    sets the user's password using
+    :meth:`~django.contrib.auth.models.User.set_password()`.
+
+.. class:: UserCreationForm
+
+    Inherits from :class:`BaseUserCreationForm`. To help prevent confusion with
+    similar usernames, the form doesn't allow usernames that differ only in
+    case.
+
+    .. versionchanged:: 4.2
+
+        In older versions, :class:`UserCreationForm` didn't save many-to-many
+        form fields for a custom user model.
+
+        In older versions, usernames that differ only in case are allowed.
+
+.. currentmodule:: django.contrib.auth
+
+Authentication data in templates
+--------------------------------
+
+The currently logged-in user and their permissions are made available in the
+:doc:`template context </ref/templates/api>` when you use
+:class:`~django.template.RequestContext`.
+
+.. admonition:: Technicality
+
+    Technically, these variables are only made available in the template
+    context if you use :class:`~django.template.RequestContext` and the
+    ``'django.contrib.auth.context_processors.auth'`` context processor is
+    enabled. It is in the default generated settings file. For more, see the
+    :ref:`RequestContext docs <subclassing-context-requestcontext>`.
+
+Users
+~~~~~
+
+When rendering a template :class:`~django.template.RequestContext`, the
+currently logged-in user, either a  :class:`~django.contrib.auth.models.User`
+instance or an :class:`~django.contrib.auth.models.AnonymousUser` instance, is
+stored in the template variable ``{{ user }}``:
+
+.. code-block:: html+django
+
+    {% if user.is_authenticated %}
+        <p>Welcome, {{ user.username }}. Thanks for logging in.</p>
+    {% else %}
+        <p>Welcome, new user. Please log in.</p>
+    {% endif %}
+
+This template context variable is not available if a ``RequestContext`` is not
+being used.
+
+Permissions
+~~~~~~~~~~~
+
+The currently logged-in user's permissions are stored in the template variable
+``{{ perms }}``. This is an instance of
+``django.contrib.auth.context_processors.PermWrapper``, which is a
+template-friendly proxy of permissions.
+
+Evaluating a single-attribute lookup of ``{{ perms }}`` as a boolean is a proxy
+to :meth:`User.has_module_perms()
+<django.contrib.auth.models.User.has_module_perms>`. For example, to check if
+the logged-in user has any permissions in the ``foo`` app:
+
+.. code-block:: html+django
+
+    {% if perms.foo %}
+
+Evaluating a two-level-attribute lookup as a boolean is a proxy to
+:meth:`User.has_perm() <django.contrib.auth.models.User.has_perm>`. For example,
+to check if the logged-in user has the permission ``foo.add_vote``:
+
+.. code-block:: html+django
+
+    {% if perms.foo.add_vote %}
+
+Here's a more complete example of checking permissions in a template:
+
+.. code-block:: html+django
+
+    {% if perms.foo %}
+        <p>You have permission to do something in the foo app.</p>
+        {% if perms.foo.add_vote %}
+            <p>You can vote!</p>
+        {% endif %}
+        {% if perms.foo.add_driving %}
+            <p>You can drive!</p>
+        {% endif %}
+    {% else %}
+        <p>You don't have permission to do anything in the foo app.</p>
+    {% endif %}
+
+It is possible to also look permissions up by ``{% if in %}`` statements.
+For example:
+
+.. code-block:: html+django
+
+    {% if 'foo' in perms %}
+        {% if 'foo.add_vote' in perms %}
+            <p>In lookup works, too.</p>
+        {% endif %}
+    {% endif %}
+
+.. _auth-admin:
+
+Managing users in the admin
+===========================
+
+When you have both ``django.contrib.admin`` and ``django.contrib.auth``
+installed, the admin provides a convenient way to view and manage users,
+groups, and permissions. Users can be created and deleted like any Django
+model. Groups can be created, and permissions can be assigned to users or
+groups. A log of user edits to models made within the admin is also stored and
+displayed.
+
+Creating users
+--------------
+
+You should see a link to "Users" in the "Auth"
+section of the main admin index page. The "Add user" admin page is different
+than standard admin pages in that it requires you to choose a username and
+password before allowing you to edit the rest of the user's fields.
+
+Also note: if you want a user account to be able to create users using the
+Django admin site, you'll need to give them permission to add users *and*
+change users (i.e., the "Add user" and "Change user" permissions). If an
+account has permission to add users but not to change them, that account won't
+be able to add users. Why? Because if you have permission to add users, you
+have the power to create superusers, which can then, in turn, change other
+users. So Django requires add *and* change permissions as a slight security
+measure.
+
+Be thoughtful about how you allow users to manage permissions. If you give a
+non-superuser the ability to edit users, this is ultimately the same as giving
+them superuser status because they will be able to elevate permissions of
+users including themselves!
+
+Changing passwords
+------------------
+
+User passwords are not displayed in the admin (nor stored in the database), but
+the :doc:`password storage details </topics/auth/passwords>` are displayed.
+Included in the display of this information is a link to
+a password change form that allows admins to change user passwords.

testbed/django__django/docs/topics/auth/index.txt

@@ -0,0 +1,89 @@
+=============================
+User authentication in Django
+=============================
+
+.. toctree::
+   :hidden:
+
+   default
+   passwords
+   customizing
+
+.. module:: django.contrib.auth
+   :synopsis: Django's authentication framework.
+
+Django comes with a user authentication system. It handles user accounts,
+groups, permissions and cookie-based user sessions. This section of the
+documentation explains how the default implementation works out of the box, as
+well as how to :doc:`extend and customize </topics/auth/customizing>` it to
+suit your project's needs.
+
+Overview
+========
+
+The Django authentication system handles both authentication and authorization.
+Briefly, authentication verifies a user is who they claim to be, and
+authorization determines what an authenticated user is allowed to do. Here the
+term authentication is used to refer to both tasks.
+
+The auth system consists of:
+
+* Users
+* Permissions: Binary (yes/no) flags designating whether a user may perform
+  a certain task.
+* Groups: A generic way of applying labels and permissions to more than one
+  user.
+* A configurable password hashing system
+* Forms and view tools for logging in users, or restricting content
+* A pluggable backend system
+
+The authentication system in Django aims to be very generic and doesn't provide
+some features commonly found in web authentication systems. Solutions for some
+of these common problems have been implemented in third-party packages:
+
+* Password strength checking
+* Throttling of login attempts
+* Authentication against third-parties (OAuth, for example)
+* Object-level permissions
+
+Installation
+============
+
+Authentication support is bundled as a Django contrib module in
+``django.contrib.auth``. By default, the required configuration is already
+included in the :file:`settings.py` generated by :djadmin:`django-admin
+startproject <startproject>`, these consist of two items listed in your
+:setting:`INSTALLED_APPS` setting:
+
+1. ``'django.contrib.auth'`` contains the core of the authentication framework,
+   and its default models.
+2. ``'django.contrib.contenttypes'`` is the Django :doc:`content type system
+   </ref/contrib/contenttypes>`, which allows permissions to be associated with
+   models you create.
+
+and these items in your :setting:`MIDDLEWARE` setting:
+
+#. :class:`~django.contrib.sessions.middleware.SessionMiddleware` manages
+   :doc:`sessions </topics/http/sessions>` across requests.
+#. :class:`~django.contrib.auth.middleware.AuthenticationMiddleware` associates
+   users with requests using sessions.
+
+With these settings in place, running the command ``manage.py migrate`` creates
+the necessary database tables for auth related models and permissions for any
+models defined in your installed apps.
+
+Usage
+=====
+
+:doc:`Using Django's default implementation <default>`
+
+* :ref:`Working with User objects <user-objects>`
+* :ref:`Permissions and authorization <topic-authorization>`
+* :ref:`Authentication in web requests <auth-web-requests>`
+* :ref:`Managing users in the admin <auth-admin>`
+
+:doc:`API reference for the default implementation </ref/contrib/auth>`
+
+:doc:`Customizing Users and authentication <customizing>`
+
+:doc:`Password management in Django <passwords>`

testbed/django__django/docs/topics/auth/passwords.txt

@@ -0,0 +1,755 @@
+=============================
+Password management in Django
+=============================
+
+Password management is something that should generally not be reinvented
+unnecessarily, and Django endeavors to provide a secure and flexible set of
+tools for managing user passwords. This document describes how Django stores
+passwords, how the storage hashing can be configured, and some utilities to
+work with hashed passwords.
+
+.. seealso::
+
+    Even though users may use strong passwords, attackers might be able to
+    eavesdrop on their connections. Use :ref:`HTTPS
+    <security-recommendation-ssl>` to avoid sending passwords (or any other
+    sensitive data) over plain HTTP connections because they will be vulnerable
+    to password sniffing.
+
+.. _auth_password_storage:
+
+How Django stores passwords
+===========================
+
+Django provides a flexible password storage system and uses PBKDF2 by default.
+
+The :attr:`~django.contrib.auth.models.User.password` attribute of a
+:class:`~django.contrib.auth.models.User` object is a string in this format:
+
+.. code-block:: text
+
+    <algorithm>$<iterations>$<salt>$<hash>
+
+Those are the components used for storing a User's password, separated by the
+dollar-sign character and consist of: the hashing algorithm, the number of
+algorithm iterations (work factor), the random salt, and the resulting password
+hash.  The algorithm is one of a number of one-way hashing or password storage
+algorithms Django can use; see below. Iterations describe the number of times
+the algorithm is run over the hash. Salt is the random seed used and the hash
+is the result of the one-way function.
+
+By default, Django uses the PBKDF2_ algorithm with a SHA256 hash, a
+password stretching mechanism recommended by NIST_. This should be
+sufficient for most users: it's quite secure, requiring massive
+amounts of computing time to break.
+
+However, depending on your requirements, you may choose a different
+algorithm, or even use a custom algorithm to match your specific
+security situation. Again, most users shouldn't need to do this -- if
+you're not sure, you probably don't.  If you do, please read on:
+
+Django chooses the algorithm to use by consulting the
+:setting:`PASSWORD_HASHERS` setting. This is a list of hashing algorithm
+classes that this Django installation supports.
+
+For storing passwords, Django will use the first hasher in
+:setting:`PASSWORD_HASHERS`. To store new passwords with a different algorithm,
+put your preferred algorithm first in :setting:`PASSWORD_HASHERS`.
+
+For verifying passwords, Django will find the hasher in the list that matches
+the algorithm name in the stored password. If a stored password names an
+algorithm not found in :setting:`PASSWORD_HASHERS`, trying to verify it will
+raise ``ValueError``.
+
+The default for :setting:`PASSWORD_HASHERS` is::
+
+    PASSWORD_HASHERS = [
+        "django.contrib.auth.hashers.PBKDF2PasswordHasher",
+        "django.contrib.auth.hashers.PBKDF2SHA1PasswordHasher",
+        "django.contrib.auth.hashers.Argon2PasswordHasher",
+        "django.contrib.auth.hashers.BCryptSHA256PasswordHasher",
+        "django.contrib.auth.hashers.ScryptPasswordHasher",
+    ]
+
+This means that Django will use PBKDF2_ to store all passwords but will support
+checking passwords stored with PBKDF2SHA1, argon2_, and bcrypt_.
+
+The next few sections describe a couple of common ways advanced users may want
+to modify this setting.
+
+.. _argon2_usage:
+
+Using Argon2 with Django
+------------------------
+
+Argon2_ is the winner of the 2015 `Password Hashing Competition`_, a community
+organized open competition to select a next generation hashing algorithm. It's
+designed not to be easier to compute on custom hardware than it is to compute
+on an ordinary CPU. The default variant for the Argon2 password hasher is
+Argon2id.
+
+Argon2_ is not the default for Django because it requires a third-party
+library. The Password Hashing Competition panel, however, recommends immediate
+use of Argon2 rather than the other algorithms supported by Django.
+
+To use Argon2id as your default storage algorithm, do the following:
+
+#. Install the :pypi:`argon2-cffi` package. This can be done by running
+   ``python -m pip install django[argon2]``, which is equivalent to
+   ``python -m pip install argon2-cffi`` (along with any version requirement
+   from Django's ``setup.cfg``).
+
+#. Modify :setting:`PASSWORD_HASHERS` to list ``Argon2PasswordHasher`` first.
+   That is, in your settings file, you'd put::
+
+        PASSWORD_HASHERS = [
+            "django.contrib.auth.hashers.Argon2PasswordHasher",
+            "django.contrib.auth.hashers.PBKDF2PasswordHasher",
+            "django.contrib.auth.hashers.PBKDF2SHA1PasswordHasher",
+            "django.contrib.auth.hashers.BCryptSHA256PasswordHasher",
+            "django.contrib.auth.hashers.ScryptPasswordHasher",
+        ]
+
+   Keep and/or add any entries in this list if you need Django to :ref:`upgrade
+   passwords <password-upgrades>`.
+
+.. _bcrypt_usage:
+
+Using ``bcrypt`` with Django
+----------------------------
+
+Bcrypt_ is a popular password storage algorithm that's specifically designed
+for long-term password storage. It's not the default used by Django since it
+requires the use of third-party libraries, but since many people may want to
+use it Django supports bcrypt with minimal effort.
+
+To use Bcrypt as your default storage algorithm, do the following:
+
+#. Install the :pypi:`bcrypt` package. This can be done by running
+   ``python -m pip install django[bcrypt]``, which is equivalent to
+   ``python -m pip install bcrypt`` (along with any version requirement from
+   Django's ``setup.cfg``).
+
+#. Modify :setting:`PASSWORD_HASHERS` to list ``BCryptSHA256PasswordHasher``
+   first. That is, in your settings file, you'd put::
+
+        PASSWORD_HASHERS = [
+            "django.contrib.auth.hashers.BCryptSHA256PasswordHasher",
+            "django.contrib.auth.hashers.PBKDF2PasswordHasher",
+            "django.contrib.auth.hashers.PBKDF2SHA1PasswordHasher",
+            "django.contrib.auth.hashers.Argon2PasswordHasher",
+            "django.contrib.auth.hashers.ScryptPasswordHasher",
+        ]
+
+   Keep and/or add any entries in this list if you need Django to :ref:`upgrade
+   passwords <password-upgrades>`.
+
+That's it -- now your Django install will use Bcrypt as the default storage
+algorithm.
+
+.. _scrypt-usage:
+
+Using ``scrypt`` with Django
+----------------------------
+
+scrypt_ is similar to PBKDF2 and bcrypt in utilizing a set number of iterations
+to slow down brute-force attacks. However, because PBKDF2 and bcrypt do not
+require a lot of memory, attackers with sufficient resources can launch
+large-scale parallel attacks in order to speed up the attacking process.
+scrypt_ is specifically designed to use more memory compared to other
+password-based key derivation functions in order to limit the amount of
+parallelism an attacker can use, see :rfc:`7914` for more details.
+
+To use scrypt_ as your default storage algorithm, do the following:
+
+#. Modify :setting:`PASSWORD_HASHERS` to list ``ScryptPasswordHasher`` first.
+   That is, in your settings file::
+
+        PASSWORD_HASHERS = [
+            "django.contrib.auth.hashers.ScryptPasswordHasher",
+            "django.contrib.auth.hashers.PBKDF2PasswordHasher",
+            "django.contrib.auth.hashers.PBKDF2SHA1PasswordHasher",
+            "django.contrib.auth.hashers.Argon2PasswordHasher",
+            "django.contrib.auth.hashers.BCryptSHA256PasswordHasher",
+        ]
+
+   Keep and/or add any entries in this list if you need Django to :ref:`upgrade
+   passwords <password-upgrades>`.
+
+.. note::
+
+    ``scrypt`` requires OpenSSL 1.1+.
+
+Increasing the salt entropy
+---------------------------
+
+Most password hashes include a salt along with their password hash in order to
+protect against rainbow table attacks. The salt itself is a random value which
+increases the size and thus the cost of the rainbow table and is currently set
+at 128 bits with the ``salt_entropy`` value in the ``BasePasswordHasher``. As
+computing and storage costs decrease this value should be raised. When
+implementing your own password hasher you are free to override this value in
+order to use a desired entropy level for your password hashes. ``salt_entropy``
+is measured in bits.
+
+.. admonition:: Implementation detail
+
+    Due to the method in which salt values are stored the ``salt_entropy``
+    value is effectively a minimum value. For instance a value of 128 would
+    provide a salt which would actually contain 131 bits of entropy.
+
+.. _increasing-password-algorithm-work-factor:
+
+Increasing the work factor
+--------------------------
+
+PBKDF2 and bcrypt
+~~~~~~~~~~~~~~~~~
+
+The PBKDF2 and bcrypt algorithms use a number of iterations or rounds of
+hashing. This deliberately slows down attackers, making attacks against hashed
+passwords harder. However, as computing power increases, the number of
+iterations needs to be increased. We've chosen a reasonable default (and will
+increase it with each release of Django), but you may wish to tune it up or
+down, depending on your security needs and available processing power. To do so,
+you'll subclass the appropriate algorithm and override the ``iterations``
+parameter (use the ``rounds`` parameter when subclassing a bcrypt hasher). For
+example, to increase the number of iterations used by the default PBKDF2
+algorithm:
+
+#. Create a subclass of ``django.contrib.auth.hashers.PBKDF2PasswordHasher``
+   ::
+
+        from django.contrib.auth.hashers import PBKDF2PasswordHasher
+
+
+        class MyPBKDF2PasswordHasher(PBKDF2PasswordHasher):
+            """
+            A subclass of PBKDF2PasswordHasher that uses 100 times more iterations.
+            """
+
+            iterations = PBKDF2PasswordHasher.iterations * 100
+
+   Save this somewhere in your project. For example, you might put this in
+   a file like ``myproject/hashers.py``.
+
+#. Add your new hasher as the first entry in :setting:`PASSWORD_HASHERS`::
+
+        PASSWORD_HASHERS = [
+            "myproject.hashers.MyPBKDF2PasswordHasher",
+            "django.contrib.auth.hashers.PBKDF2PasswordHasher",
+            "django.contrib.auth.hashers.PBKDF2SHA1PasswordHasher",
+            "django.contrib.auth.hashers.Argon2PasswordHasher",
+            "django.contrib.auth.hashers.BCryptSHA256PasswordHasher",
+            "django.contrib.auth.hashers.ScryptPasswordHasher",
+        ]
+
+That's it -- now your Django install will use more iterations when it
+stores passwords using PBKDF2.
+
+.. note::
+
+    bcrypt ``rounds`` is a logarithmic work factor, e.g. 12 rounds means
+    ``2 ** 12`` iterations.
+
+Argon2
+~~~~~~
+
+Argon2 has the following attributes that can be customized:
+
+#. ``time_cost`` controls the number of iterations within the hash.
+#. ``memory_cost`` controls the size of memory that must be used during the
+   computation of the hash.
+#. ``parallelism`` controls how many CPUs the computation of the hash can be
+   parallelized on.
+
+The default values of these attributes are probably fine for you. If you
+determine that the password hash is too fast or too slow, you can tweak it as
+follows:
+
+#. Choose ``parallelism`` to be the number of threads you can
+   spare computing the hash.
+#. Choose ``memory_cost`` to be the KiB of memory you can spare.
+#. Adjust ``time_cost`` and measure the time hashing a password takes.
+   Pick a ``time_cost`` that takes an acceptable time for you.
+   If ``time_cost`` set to 1 is unacceptably slow, lower ``memory_cost``.
+
+.. admonition:: ``memory_cost`` interpretation
+
+    The argon2 command-line utility and some other libraries interpret the
+    ``memory_cost`` parameter differently from the value that Django uses. The
+    conversion is given by ``memory_cost == 2 ** memory_cost_commandline``.
+
+``scrypt``
+~~~~~~~~~~
+
+scrypt_ has the following attributes that can be customized:
+
+#. ``work_factor`` controls the number of iterations within the hash.
+#. ``block_size``
+#. ``parallelism`` controls how many threads will run in parallel.
+#. ``maxmem`` limits the maximum size of memory that can be used during the
+   computation of the hash. Defaults to ``0``, which means the default
+   limitation from the OpenSSL library.
+
+We've chosen reasonable defaults, but you may wish to tune it up or down,
+depending on your security needs and available processing power.
+
+.. admonition:: Estimating memory usage
+
+    The minimum memory requirement of scrypt_ is::
+
+        work_factor * 2 * block_size * 64
+
+    so you may need to tweak ``maxmem`` when changing the ``work_factor`` or
+    ``block_size`` values.
+
+.. _password-upgrades:
+
+Password upgrading
+------------------
+
+When users log in, if their passwords are stored with anything other than
+the preferred algorithm, Django will automatically upgrade the algorithm
+to the preferred one. This means that old installs of Django will get
+automatically more secure as users log in, and it also means that you
+can switch to new (and better) storage algorithms as they get invented.
+
+However, Django can only upgrade passwords that use algorithms mentioned in
+:setting:`PASSWORD_HASHERS`, so as you upgrade to new systems you should make
+sure never to *remove* entries from this list. If you do, users using
+unmentioned algorithms won't be able to upgrade. Hashed passwords will be
+updated when increasing (or decreasing) the number of PBKDF2 iterations, bcrypt
+rounds, or argon2 attributes.
+
+Be aware that if all the passwords in your database aren't encoded in the
+default hasher's algorithm, you may be vulnerable to a user enumeration timing
+attack due to a difference between the duration of a login request for a user
+with a password encoded in a non-default algorithm and the duration of a login
+request for a nonexistent user (which runs the default hasher). You may be able
+to mitigate this by :ref:`upgrading older password hashes
+<wrapping-password-hashers>`.
+
+.. _wrapping-password-hashers:
+
+Password upgrading without requiring a login
+--------------------------------------------
+
+If you have an existing database with an older, weak hash such as MD5, you
+might want to upgrade those hashes yourself instead of waiting for the upgrade
+to happen when a user logs in (which may never happen if a user doesn't return
+to your site). In this case, you can use a "wrapped" password hasher.
+
+For this example, we'll migrate a collection of MD5 hashes to use
+PBKDF2(MD5(password)) and add the corresponding password hasher for checking
+if a user entered the correct password on login. We assume we're using the
+built-in ``User`` model and that our project has an ``accounts`` app. You can
+modify the pattern to work with any algorithm or with a custom user model.
+
+First, we'll add the custom hasher:
+
+.. code-block:: python
+    :caption: ``accounts/hashers.py``
+
+    from django.contrib.auth.hashers import (
+        PBKDF2PasswordHasher,
+        MD5PasswordHasher,
+    )
+
+
+    class PBKDF2WrappedMD5PasswordHasher(PBKDF2PasswordHasher):
+        algorithm = "pbkdf2_wrapped_md5"
+
+        def encode_md5_hash(self, md5_hash, salt, iterations=None):
+            return super().encode(md5_hash, salt, iterations)
+
+        def encode(self, password, salt, iterations=None):
+            _, _, md5_hash = MD5PasswordHasher().encode(password, salt).split("$", 2)
+            return self.encode_md5_hash(md5_hash, salt, iterations)
+
+The data migration might look something like:
+
+.. code-block:: python
+    :caption: ``accounts/migrations/0002_migrate_md5_passwords.py``
+
+    from django.db import migrations
+
+    from ..hashers import PBKDF2WrappedMD5PasswordHasher
+
+
+    def forwards_func(apps, schema_editor):
+        User = apps.get_model("auth", "User")
+        users = User.objects.filter(password__startswith="md5$")
+        hasher = PBKDF2WrappedMD5PasswordHasher()
+        for user in users:
+            algorithm, salt, md5_hash = user.password.split("$", 2)
+            user.password = hasher.encode_md5_hash(md5_hash, salt)
+            user.save(update_fields=["password"])
+
+
+    class Migration(migrations.Migration):
+        dependencies = [
+            ("accounts", "0001_initial"),
+            # replace this with the latest migration in contrib.auth
+            ("auth", "####_migration_name"),
+        ]
+
+        operations = [
+            migrations.RunPython(forwards_func),
+        ]
+
+Be aware that this migration will take on the order of several minutes for
+several thousand users, depending on the speed of your hardware.
+
+Finally, we'll add a :setting:`PASSWORD_HASHERS` setting:
+
+.. code-block:: python
+    :caption: ``mysite/settings.py``
+
+    PASSWORD_HASHERS = [
+        "django.contrib.auth.hashers.PBKDF2PasswordHasher",
+        "accounts.hashers.PBKDF2WrappedMD5PasswordHasher",
+    ]
+
+Include any other hashers that your site uses in this list.
+
+.. _pbkdf2: https://en.wikipedia.org/wiki/PBKDF2
+.. _nist: https://nvlpubs.nist.gov/nistpubs/Legacy/SP/nistspecialpublication800-132.pdf
+.. _bcrypt: https://en.wikipedia.org/wiki/Bcrypt
+.. _argon2: https://en.wikipedia.org/wiki/Argon2
+.. _scrypt: https://en.wikipedia.org/wiki/Scrypt
+.. _`Password Hashing Competition`: https://www.password-hashing.net/
+
+.. _auth-included-hashers:
+
+Included hashers
+----------------
+
+The full list of hashers included in Django is::
+
+    [
+        "django.contrib.auth.hashers.PBKDF2PasswordHasher",
+        "django.contrib.auth.hashers.PBKDF2SHA1PasswordHasher",
+        "django.contrib.auth.hashers.Argon2PasswordHasher",
+        "django.contrib.auth.hashers.BCryptSHA256PasswordHasher",
+        "django.contrib.auth.hashers.BCryptPasswordHasher",
+        "django.contrib.auth.hashers.ScryptPasswordHasher",
+        "django.contrib.auth.hashers.MD5PasswordHasher",
+    ]
+
+The corresponding algorithm names are:
+
+* ``pbkdf2_sha256``
+* ``pbkdf2_sha1``
+* ``argon2``
+* ``bcrypt_sha256``
+* ``bcrypt``
+* ``scrypt``
+* ``md5``
+
+.. _write-your-own-password-hasher:
+
+Writing your own hasher
+-----------------------
+
+If you write your own password hasher that contains a work factor such as a
+number of iterations, you should implement a
+``harden_runtime(self, password, encoded)`` method to bridge the runtime gap
+between the work factor supplied in the ``encoded`` password and the default
+work factor of the hasher. This prevents a user enumeration timing attack due
+to  difference between a login request for a user with a password encoded in an
+older number of iterations and a nonexistent user (which runs the default
+hasher's default number of iterations).
+
+Taking PBKDF2 as example, if ``encoded`` contains 20,000 iterations and the
+hasher's default ``iterations`` is 30,000, the method should run ``password``
+through another 10,000 iterations of PBKDF2.
+
+If your hasher doesn't have a work factor, implement the method as a no-op
+(``pass``).
+
+Manually managing a user's password
+===================================
+
+.. module:: django.contrib.auth.hashers
+
+The :mod:`django.contrib.auth.hashers` module provides a set of functions
+to create and validate hashed passwords. You can use them independently
+from the ``User`` model.
+
+.. function:: check_password(password, encoded, setter=None, preferred="default")
+.. function:: acheck_password(password, encoded, asetter=None, preferred="default")
+
+    *Asynchronous version*: ``acheck_password()``
+
+    If you'd like to manually authenticate a user by comparing a plain-text
+    password to the hashed password in the database, use the convenience
+    function :func:`check_password`. It takes two mandatory arguments: the
+    plain-text password to check, and the full value of a user's ``password``
+    field in the database to check against. It returns ``True`` if they match,
+    ``False`` otherwise. Optionally, you can pass a callable ``setter`` that
+    takes the password and will be called when you need to regenerate it. You
+    can also pass ``preferred`` to change a hashing algorithm if you don't want
+    to use the default (first entry of ``PASSWORD_HASHERS`` setting). See
+    :ref:`auth-included-hashers` for the algorithm name of each hasher.
+
+    .. versionchanged:: 5.0
+
+        ``acheck_password()`` method was added.
+
+.. function:: make_password(password, salt=None, hasher='default')
+
+    Creates a hashed password in the format used by this application. It takes
+    one mandatory argument: the password in plain-text (string or bytes).
+    Optionally, you can provide a salt and a hashing algorithm to use, if you
+    don't want to use the defaults (first entry of ``PASSWORD_HASHERS``
+    setting). See :ref:`auth-included-hashers` for the algorithm name of each
+    hasher. If the password argument is ``None``, an unusable password is
+    returned (one that will never be accepted by :func:`check_password`).
+
+.. function:: is_password_usable(encoded_password)
+
+    Returns ``False`` if the password is a result of
+    :meth:`.User.set_unusable_password`.
+
+.. _password-validation:
+
+Password validation
+===================
+
+.. module:: django.contrib.auth.password_validation
+
+Users often choose poor passwords. To help mitigate this problem, Django
+offers pluggable password validation. You can configure multiple password
+validators at the same time. A few validators are included in Django, but you
+can write your own as well.
+
+Each password validator must provide a help text to explain the requirements to
+the user, validate a given password and return an error message if it does not
+meet the requirements, and optionally receive passwords that have been set.
+Validators can also have optional settings to fine tune their behavior.
+
+Validation is controlled by the :setting:`AUTH_PASSWORD_VALIDATORS` setting.
+The default for the setting is an empty list, which means no validators are
+applied. In new projects created with the default :djadmin:`startproject`
+template, a set of validators is enabled by default.
+
+By default, validators are used in the forms to reset or change passwords and
+in the :djadmin:`createsuperuser` and :djadmin:`changepassword` management
+commands. Validators aren't applied at the model level, for example in
+``User.objects.create_user()`` and ``create_superuser()``, because we assume
+that developers, not users, interact with Django at that level and also because
+model validation doesn't automatically run as part of creating models.
+
+.. note::
+
+    Password validation can prevent the use of many types of weak passwords.
+    However, the fact that a password passes all the validators doesn't
+    guarantee that it is a strong password. There are many factors that can
+    weaken a password that are not detectable by even the most advanced
+    password validators.
+
+Enabling password validation
+----------------------------
+
+Password validation is configured in the
+:setting:`AUTH_PASSWORD_VALIDATORS` setting::
+
+    AUTH_PASSWORD_VALIDATORS = [
+        {
+            "NAME": "django.contrib.auth.password_validation.UserAttributeSimilarityValidator",
+        },
+        {
+            "NAME": "django.contrib.auth.password_validation.MinimumLengthValidator",
+            "OPTIONS": {
+                "min_length": 9,
+            },
+        },
+        {
+            "NAME": "django.contrib.auth.password_validation.CommonPasswordValidator",
+        },
+        {
+            "NAME": "django.contrib.auth.password_validation.NumericPasswordValidator",
+        },
+    ]
+
+This example enables all four included validators:
+
+* ``UserAttributeSimilarityValidator``, which checks the similarity between
+  the password and a set of attributes of the user.
+* ``MinimumLengthValidator``, which checks whether the password meets a minimum
+  length. This validator is configured with a custom option: it now requires
+  the minimum length to be nine characters, instead of the default eight.
+* ``CommonPasswordValidator``, which checks whether the password occurs in a
+  list of common passwords. By default, it compares to an included list of
+  20,000 common passwords.
+* ``NumericPasswordValidator``, which checks whether the password isn't
+  entirely numeric.
+
+For ``UserAttributeSimilarityValidator`` and ``CommonPasswordValidator``,
+we're using the default settings in this example. ``NumericPasswordValidator``
+has no settings.
+
+The help texts and any errors from password validators are always returned in
+the order they are listed in :setting:`AUTH_PASSWORD_VALIDATORS`.
+
+Included validators
+-------------------
+
+Django includes four validators:
+
+.. class:: MinimumLengthValidator(min_length=8)
+
+    Validates that the password is of a minimum length.
+    The minimum length can be customized with the ``min_length`` parameter.
+
+.. class:: UserAttributeSimilarityValidator(user_attributes=DEFAULT_USER_ATTRIBUTES, max_similarity=0.7)
+
+    Validates that the password is sufficiently different from certain
+    attributes of the user.
+
+    The ``user_attributes`` parameter should be an iterable of names of user
+    attributes to compare to. If this argument is not provided, the default
+    is used: ``'username', 'first_name', 'last_name', 'email'``.
+    Attributes that don't exist are ignored.
+
+    The maximum allowed similarity of passwords can be set on a scale of 0.1
+    to 1.0 with the ``max_similarity`` parameter. This is compared to the
+    result of :meth:`difflib.SequenceMatcher.quick_ratio`. A value of 0.1
+    rejects passwords unless they are substantially different from the
+    ``user_attributes``, whereas a value of 1.0 rejects only passwords that are
+    identical to an attribute's value.
+
+    .. versionchanged:: 2.2.26
+
+        The ``max_similarity`` parameter was limited to a minimum value of 0.1.
+
+.. class:: CommonPasswordValidator(password_list_path=DEFAULT_PASSWORD_LIST_PATH)
+
+    Validates that the password is not a common password. This converts the
+    password to lowercase (to do a case-insensitive comparison) and checks it
+    against a list of 20,000 common password created by `Royce Williams
+    <https://gist.github.com/roycewilliams/226886fd01572964e1431ac8afc999ce>`_.
+
+    The ``password_list_path`` can be set to the path of a custom file of
+    common passwords. This file should contain one lowercase password per line
+    and may be plain text or gzipped.
+
+    .. versionchanged:: 4.2
+
+        The list of 20,000 common passwords was updated to the most recent
+        version.
+
+.. class:: NumericPasswordValidator()
+
+    Validate that the password is not entirely numeric.
+
+Integrating validation
+----------------------
+
+There are a few functions in ``django.contrib.auth.password_validation`` that
+you can call from your own forms or other code to integrate password
+validation. This can be useful if you use custom forms for password setting,
+or if you have API calls that allow passwords to be set, for example.
+
+.. function:: validate_password(password, user=None, password_validators=None)
+
+    Validates a password. If all validators find the password valid, returns
+    ``None``. If one or more validators reject the password, raises a
+    :exc:`~django.core.exceptions.ValidationError` with all the error messages
+    from the validators.
+
+    The ``user`` object is optional: if it's not provided, some validators may
+    not be able to perform any validation and will accept any password.
+
+.. function:: password_changed(password, user=None, password_validators=None)
+
+    Informs all validators that the password has been changed. This can be used
+    by validators such as one that prevents password reuse. This should be
+    called once the password has been successfully changed.
+
+    For subclasses of :class:`~django.contrib.auth.models.AbstractBaseUser`,
+    the password field will be marked as "dirty" when calling
+    :meth:`~django.contrib.auth.models.AbstractBaseUser.set_password` which
+    triggers a call to ``password_changed()`` after the user is saved.
+
+.. function:: password_validators_help_texts(password_validators=None)
+
+    Returns a list of the help texts of all validators. These explain the
+    password requirements to the user.
+
+.. function:: password_validators_help_text_html(password_validators=None)
+
+    Returns an HTML string with all help texts in an ``<ul>``. This is
+    helpful when adding password validation to forms, as you can pass the
+    output directly to the ``help_text`` parameter of a form field.
+
+.. function:: get_password_validators(validator_config)
+
+    Returns a set of validator objects based on the ``validator_config``
+    parameter. By default, all functions use the validators defined in
+    :setting:`AUTH_PASSWORD_VALIDATORS`, but by calling this function with an
+    alternate set of validators and then passing the result into the
+    ``password_validators`` parameter of the other functions, your custom set
+    of validators will be used instead. This is useful when you have a typical
+    set of validators to use for most scenarios, but also have a special
+    situation that requires a custom set. If you always use the same set
+    of validators, there is no need to use this function, as the configuration
+    from :setting:`AUTH_PASSWORD_VALIDATORS` is used by default.
+
+    The structure of ``validator_config`` is identical to the
+    structure of :setting:`AUTH_PASSWORD_VALIDATORS`. The return value of
+    this function can be passed into the ``password_validators`` parameter
+    of the functions listed above.
+
+Note that where the password is passed to one of these functions, this should
+always be the clear text password - not a hashed password.
+
+Writing your own validator
+--------------------------
+
+If Django's built-in validators are not sufficient, you can write your own
+password validators. Validators have a fairly small interface. They must
+implement two methods:
+
+* ``validate(self, password, user=None)``: validate a password. Return
+  ``None`` if the password is valid, or raise a
+  :exc:`~django.core.exceptions.ValidationError` with an error message if the
+  password is not valid. You must be able to deal with ``user`` being
+  ``None`` - if that means your validator can't run, return ``None`` for no
+  error.
+* ``get_help_text()``: provide a help text to explain the requirements to
+  the user.
+
+Any items in the ``OPTIONS`` in :setting:`AUTH_PASSWORD_VALIDATORS` for your
+validator will be passed to the constructor. All constructor arguments should
+have a default value.
+
+Here's a basic example of a validator, with one optional setting::
+
+    from django.core.exceptions import ValidationError
+    from django.utils.translation import gettext as _
+
+
+    class MinimumLengthValidator:
+        def __init__(self, min_length=8):
+            self.min_length = min_length
+
+        def validate(self, password, user=None):
+            if len(password) < self.min_length:
+                raise ValidationError(
+                    _("This password must contain at least %(min_length)d characters."),
+                    code="password_too_short",
+                    params={"min_length": self.min_length},
+                )
+
+        def get_help_text(self):
+            return _(
+                "Your password must contain at least %(min_length)d characters."
+                % {"min_length": self.min_length}
+            )
+
+You can also implement ``password_changed(password, user=None``), which will
+be called after a successful password change. That can be used to prevent
+password reuse, for example. However, if you decide to store a user's previous
+passwords, you should never do so in clear text.

testbed/django__django/docs/topics/cache.txt

@@ -0,0 +1,1514 @@
+========================
+Django's cache framework
+========================
+
+A fundamental trade-off in dynamic websites is, well, they're dynamic. Each
+time a user requests a page, the web server makes all sorts of calculations --
+from database queries to template rendering to business logic -- to create the
+page that your site's visitor sees. This is a lot more expensive, from a
+processing-overhead perspective, than your standard
+read-a-file-off-the-filesystem server arrangement.
+
+For most web applications, this overhead isn't a big deal. Most web
+applications aren't ``washingtonpost.com`` or ``slashdot.org``; they're small-
+to medium-sized sites with so-so traffic. But for medium- to high-traffic
+sites, it's essential to cut as much overhead as possible.
+
+That's where caching comes in.
+
+To cache something is to save the result of an expensive calculation so that
+you don't have to perform the calculation next time. Here's some pseudocode
+explaining how this would work for a dynamically generated web page:
+
+.. code-block:: text
+
+    given a URL, try finding that page in the cache
+    if the page is in the cache:
+        return the cached page
+    else:
+        generate the page
+        save the generated page in the cache (for next time)
+        return the generated page
+
+Django comes with a robust cache system that lets you save dynamic pages so
+they don't have to be calculated for each request. For convenience, Django
+offers different levels of cache granularity: You can cache the output of
+specific views, you can cache only the pieces that are difficult to produce,
+or you can cache your entire site.
+
+Django also works well with "downstream" caches, such as `Squid
+<http://www.squid-cache.org/>`_ and browser-based caches. These are the types
+of caches that you don't directly control but to which you can provide hints
+(via HTTP headers) about which parts of your site should be cached, and how.
+
+.. seealso::
+    The :ref:`Cache Framework design philosophy <cache-design-philosophy>`
+    explains a few of the design decisions of the framework.
+
+.. _setting-up-the-cache:
+
+Setting up the cache
+====================
+
+The cache system requires a small amount of setup. Namely, you have to tell it
+where your cached data should live -- whether in a database, on the filesystem
+or directly in memory. This is an important decision that affects your cache's
+performance; yes, some cache types are faster than others.
+
+Your cache preference goes in the :setting:`CACHES` setting in your
+settings file. Here's an explanation of all available values for
+:setting:`CACHES`.
+
+.. _memcached:
+
+Memcached
+---------
+
+Memcached__ is an entirely memory-based cache server, originally developed
+to handle high loads at LiveJournal.com and subsequently open-sourced by
+Danga Interactive. It is used by sites such as Facebook and Wikipedia to
+reduce database access and dramatically increase site performance.
+
+__ https://memcached.org/
+
+Memcached runs as a daemon and is allotted a specified amount of RAM. All it
+does is provide a fast interface for adding, retrieving and deleting data in
+the cache. All data is stored directly in memory, so there's no overhead of
+database or filesystem usage.
+
+After installing Memcached itself, you'll need to install a Memcached
+binding. There are several Python Memcached bindings available; the
+two supported by Django are :pypi:`pylibmc` and :pypi:`pymemcache`.
+
+To use Memcached with Django:
+
+* Set :setting:`BACKEND <CACHES-BACKEND>` to
+  ``django.core.cache.backends.memcached.PyMemcacheCache`` or
+  ``django.core.cache.backends.memcached.PyLibMCCache`` (depending on your
+  chosen memcached binding)
+
+* Set :setting:`LOCATION <CACHES-LOCATION>` to ``ip:port`` values,
+  where ``ip`` is the IP address of the Memcached daemon and ``port`` is the
+  port on which Memcached is running, or to a ``unix:path`` value, where
+  ``path`` is the path to a Memcached Unix socket file.
+
+In this example, Memcached is running on localhost (127.0.0.1) port 11211, using
+the ``pymemcache`` binding::
+
+    CACHES = {
+        "default": {
+            "BACKEND": "django.core.cache.backends.memcached.PyMemcacheCache",
+            "LOCATION": "127.0.0.1:11211",
+        }
+    }
+
+In this example, Memcached is available through a local Unix socket file
+:file:`/tmp/memcached.sock` using the ``pymemcache`` binding::
+
+    CACHES = {
+        "default": {
+            "BACKEND": "django.core.cache.backends.memcached.PyMemcacheCache",
+            "LOCATION": "unix:/tmp/memcached.sock",
+        }
+    }
+
+One excellent feature of Memcached is its ability to share a cache over
+multiple servers. This means you can run Memcached daemons on multiple
+machines, and the program will treat the group of machines as a *single*
+cache, without the need to duplicate cache values on each machine. To take
+advantage of this feature, include all server addresses in
+:setting:`LOCATION <CACHES-LOCATION>`, either as a semicolon or comma
+delimited string, or as a list.
+
+In this example, the cache is shared over Memcached instances running on IP
+address 172.19.26.240 and 172.19.26.242, both on port 11211::
+
+    CACHES = {
+        "default": {
+            "BACKEND": "django.core.cache.backends.memcached.PyMemcacheCache",
+            "LOCATION": [
+                "172.19.26.240:11211",
+                "172.19.26.242:11211",
+            ],
+        }
+    }
+
+In the following example, the cache is shared over Memcached instances running
+on the IP addresses 172.19.26.240 (port 11211), 172.19.26.242 (port 11212), and
+172.19.26.244 (port 11213)::
+
+    CACHES = {
+        "default": {
+            "BACKEND": "django.core.cache.backends.memcached.PyMemcacheCache",
+            "LOCATION": [
+                "172.19.26.240:11211",
+                "172.19.26.242:11212",
+                "172.19.26.244:11213",
+            ],
+        }
+    }
+
+By default, the ``PyMemcacheCache`` backend sets the following options (you can
+override them in your :setting:`OPTIONS <CACHES-OPTIONS>`)::
+
+    "OPTIONS": {
+        "allow_unicode_keys": True,
+        "default_noreply": False,
+        "serde": pymemcache.serde.pickle_serde,
+    }
+
+A final point about Memcached is that memory-based caching has a
+disadvantage: because the cached data is stored in memory, the data will be
+lost if your server crashes. Clearly, memory isn't intended for permanent data
+storage, so don't rely on memory-based caching as your only data storage.
+Without a doubt, *none* of the Django caching backends should be used for
+permanent storage -- they're all intended to be solutions for caching, not
+storage -- but we point this out here because memory-based caching is
+particularly temporary.
+
+.. _redis:
+
+Redis
+-----
+
+Redis__ is an in-memory database that can be used for caching. To begin you'll
+need a Redis server running either locally or on a remote machine.
+
+__ https://redis.io/
+
+After setting up the Redis server, you'll need to install Python bindings for
+Redis. :pypi:`redis-py <redis>` is the binding supported natively by Django.
+Installing the :pypi:`hiredis-py <hiredis>` package is also recommended.
+
+To use Redis as your cache backend with Django:
+
+* Set :setting:`BACKEND <CACHES-BACKEND>` to
+  ``django.core.cache.backends.redis.RedisCache``.
+
+* Set :setting:`LOCATION <CACHES-LOCATION>` to the URL pointing to your Redis
+  instance, using the appropriate scheme. See the ``redis-py`` docs for
+  `details on the available schemes
+  <https://redis-py.readthedocs.io/en/stable/connections.html#redis.connection.ConnectionPool.from_url>`_.
+
+For example, if Redis is running on localhost (127.0.0.1) port 6379::
+
+    CACHES = {
+        "default": {
+            "BACKEND": "django.core.cache.backends.redis.RedisCache",
+            "LOCATION": "redis://127.0.0.1:6379",
+        }
+    }
+
+Often Redis servers are protected with authentication. In order to supply a
+username and password, add them in the ``LOCATION`` along with the URL::
+
+    CACHES = {
+        "default": {
+            "BACKEND": "django.core.cache.backends.redis.RedisCache",
+            "LOCATION": "redis://username:password@127.0.0.1:6379",
+        }
+    }
+
+If you have multiple Redis servers set up in the replication mode, you can
+specify the servers either as a semicolon or comma delimited string, or as a
+list. While using multiple servers, write operations are performed on the first
+server (leader). Read operations are performed on the other servers (replicas)
+chosen at random::
+
+    CACHES = {
+        "default": {
+            "BACKEND": "django.core.cache.backends.redis.RedisCache",
+            "LOCATION": [
+                "redis://127.0.0.1:6379",  # leader
+                "redis://127.0.0.1:6378",  # read-replica 1
+                "redis://127.0.0.1:6377",  # read-replica 2
+            ],
+        }
+    }
+
+.. _database-caching:
+
+Database caching
+----------------
+
+Django can store its cached data in your database. This works best if you've
+got a fast, well-indexed database server.
+
+To use a database table as your cache backend:
+
+* Set :setting:`BACKEND <CACHES-BACKEND>` to
+  ``django.core.cache.backends.db.DatabaseCache``
+
+* Set :setting:`LOCATION <CACHES-LOCATION>` to ``tablename``, the name of the
+  database table. This name can be whatever you want, as long as it's a valid
+  table name that's not already being used in your database.
+
+In this example, the cache table's name is ``my_cache_table``::
+
+    CACHES = {
+        "default": {
+            "BACKEND": "django.core.cache.backends.db.DatabaseCache",
+            "LOCATION": "my_cache_table",
+        }
+    }
+
+Unlike other cache backends, the database cache does not support automatic
+culling of expired entries at the database level. Instead, expired cache
+entries are culled each time ``add()``, ``set()``, or ``touch()`` is called.
+
+Creating the cache table
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+Before using the database cache, you must create the cache table with this
+command:
+
+.. code-block:: shell
+
+    python manage.py createcachetable
+
+This creates a table in your database that is in the proper format that
+Django's database-cache system expects. The name of the table is taken from
+:setting:`LOCATION <CACHES-LOCATION>`.
+
+If you are using multiple database caches, :djadmin:`createcachetable` creates
+one table for each cache.
+
+If you are using multiple databases, :djadmin:`createcachetable` observes the
+``allow_migrate()`` method of your database routers (see below).
+
+Like :djadmin:`migrate`, :djadmin:`createcachetable` won't touch an existing
+table. It will only create missing tables.
+
+To print the SQL that would be run, rather than run it, use the
+:option:`createcachetable --dry-run` option.
+
+Multiple databases
+~~~~~~~~~~~~~~~~~~
+
+If you use database caching with multiple databases, you'll also need
+to set up routing instructions for your database cache table. For the
+purposes of routing, the database cache table appears as a model named
+``CacheEntry``, in an application named ``django_cache``. This model
+won't appear in the models cache, but the model details can be used
+for routing purposes.
+
+For example, the following router would direct all cache read
+operations to ``cache_replica``, and all write operations to
+``cache_primary``. The cache table will only be synchronized onto
+``cache_primary``::
+
+    class CacheRouter:
+        """A router to control all database cache operations"""
+
+        def db_for_read(self, model, **hints):
+            "All cache read operations go to the replica"
+            if model._meta.app_label == "django_cache":
+                return "cache_replica"
+            return None
+
+        def db_for_write(self, model, **hints):
+            "All cache write operations go to primary"
+            if model._meta.app_label == "django_cache":
+                return "cache_primary"
+            return None
+
+        def allow_migrate(self, db, app_label, model_name=None, **hints):
+            "Only install the cache model on primary"
+            if app_label == "django_cache":
+                return db == "cache_primary"
+            return None
+
+If you don't specify routing directions for the database cache model,
+the cache backend will use the ``default`` database.
+
+And if you don't use the database cache backend, you don't need to worry about
+providing routing instructions for the database cache model.
+
+Filesystem caching
+------------------
+
+The file-based backend serializes and stores each cache value as a separate
+file. To use this backend set :setting:`BACKEND <CACHES-BACKEND>` to
+``"django.core.cache.backends.filebased.FileBasedCache"`` and
+:setting:`LOCATION <CACHES-LOCATION>` to a suitable directory. For example,
+to store cached data in ``/var/tmp/django_cache``, use this setting::
+
+    CACHES = {
+        "default": {
+            "BACKEND": "django.core.cache.backends.filebased.FileBasedCache",
+            "LOCATION": "/var/tmp/django_cache",
+        }
+    }
+
+If you're on Windows, put the drive letter at the beginning of the path,
+like this::
+
+    CACHES = {
+        "default": {
+            "BACKEND": "django.core.cache.backends.filebased.FileBasedCache",
+            "LOCATION": "c:/foo/bar",
+        }
+    }
+
+The directory path should be absolute -- that is, it should start at the root
+of your filesystem. It doesn't matter whether you put a slash at the end of the
+setting.
+
+Make sure the directory pointed-to by this setting either exists and is
+readable and writable, or that it can be created by the system user under which
+your web server runs. Continuing the above example, if your server runs as the
+user ``apache``, make sure the directory ``/var/tmp/django_cache`` exists and
+is readable and writable by the user ``apache``, or that it can be created by
+the user ``apache``.
+
+.. warning::
+
+    When the cache :setting:`LOCATION <CACHES-LOCATION>` is contained within
+    :setting:`MEDIA_ROOT`, :setting:`STATIC_ROOT`, or
+    :setting:`STATICFILES_FINDERS`, sensitive data may be exposed.
+
+    An attacker who gains access to the cache file can not only falsify HTML
+    content, which your site will trust, but also remotely execute arbitrary
+    code, as the data is serialized using :mod:`pickle`.
+
+.. warning::
+
+    Filesystem caching may become slow when storing a large number of files. If
+    you run into this problem, consider using a different caching mechanism.
+    You can also subclass
+    :source:`FileBasedCache <django/core/cache/backends/filebased.py>` and
+    improve the culling strategy.
+
+.. _local-memory-caching:
+
+Local-memory caching
+--------------------
+
+This is the default cache if another is not specified in your settings file. If
+you want the speed advantages of in-memory caching but don't have the capability
+of running Memcached, consider the local-memory cache backend. This cache is
+per-process (see below) and thread-safe. To use it, set :setting:`BACKEND
+<CACHES-BACKEND>` to ``"django.core.cache.backends.locmem.LocMemCache"``. For
+example::
+
+    CACHES = {
+        "default": {
+            "BACKEND": "django.core.cache.backends.locmem.LocMemCache",
+            "LOCATION": "unique-snowflake",
+        }
+    }
+
+The cache :setting:`LOCATION <CACHES-LOCATION>` is used to identify individual
+memory stores. If you only have one ``locmem`` cache, you can omit the
+:setting:`LOCATION <CACHES-LOCATION>`; however, if you have more than one local
+memory cache, you will need to assign a name to at least one of them in
+order to keep them separate.
+
+The cache uses a least-recently-used (LRU) culling strategy.
+
+Note that each process will have its own private cache instance, which means no
+cross-process caching is possible. This also means the local memory cache isn't
+particularly memory-efficient, so it's probably not a good choice for
+production environments. It's nice for development.
+
+Dummy caching (for development)
+-------------------------------
+
+Finally, Django comes with a "dummy" cache that doesn't actually cache -- it
+just implements the cache interface without doing anything.
+
+This is useful if you have a production site that uses heavy-duty caching in
+various places but a development/test environment where you don't want to cache
+and don't want to have to change your code to special-case the latter. To
+activate dummy caching, set :setting:`BACKEND <CACHES-BACKEND>` like so::
+
+    CACHES = {
+        "default": {
+            "BACKEND": "django.core.cache.backends.dummy.DummyCache",
+        }
+    }
+
+Using a custom cache backend
+----------------------------
+
+While Django includes support for a number of cache backends out-of-the-box,
+sometimes you might want to use a customized cache backend. To use an external
+cache backend with Django, use the Python import path as the
+:setting:`BACKEND <CACHES-BACKEND>` of the :setting:`CACHES` setting, like so::
+
+    CACHES = {
+        "default": {
+            "BACKEND": "path.to.backend",
+        }
+    }
+
+If you're building your own backend, you can use the standard cache backends
+as reference implementations. You'll find the code in the
+:source:`django/core/cache/backends/` directory of the Django source.
+
+Note: Without a really compelling reason, such as a host that doesn't support
+them, you should stick to the cache backends included with Django. They've
+been well-tested and are well-documented.
+
+.. _cache_arguments:
+
+Cache arguments
+---------------
+
+Each cache backend can be given additional arguments to control caching
+behavior. These arguments are provided as additional keys in the
+:setting:`CACHES` setting. Valid arguments are as follows:
+
+* :setting:`TIMEOUT <CACHES-TIMEOUT>`: The default timeout, in
+  seconds, to use for the cache. This argument defaults to ``300`` seconds (5 minutes).
+  You can set ``TIMEOUT`` to ``None`` so that, by default, cache keys never
+  expire. A value of ``0`` causes keys to immediately expire (effectively
+  "don't cache").
+
+* :setting:`OPTIONS <CACHES-OPTIONS>`: Any options that should be
+  passed to the cache backend. The list of valid options will vary
+  with each backend, and cache backends backed by a third-party library
+  will pass their options directly to the underlying cache library.
+
+  Cache backends that implement their own culling strategy (i.e.,
+  the ``locmem``, ``filesystem`` and ``database`` backends) will
+  honor the following options:
+
+  * ``MAX_ENTRIES``: The maximum number of entries allowed in
+    the cache before old values are deleted. This argument
+    defaults to ``300``.
+
+  * ``CULL_FREQUENCY``: The fraction of entries that are culled
+    when ``MAX_ENTRIES`` is reached. The actual ratio is
+    ``1 / CULL_FREQUENCY``, so set ``CULL_FREQUENCY`` to ``2`` to
+    cull half the entries when ``MAX_ENTRIES`` is reached. This argument
+    should be an integer and defaults to ``3``.
+
+    A value of ``0`` for ``CULL_FREQUENCY`` means that the
+    entire cache will be dumped when ``MAX_ENTRIES`` is reached.
+    On some backends (``database`` in particular) this makes culling *much*
+    faster at the expense of more cache misses.
+
+  The Memcached and Redis backends pass the contents of :setting:`OPTIONS
+  <CACHES-OPTIONS>` as keyword arguments to the client constructors, allowing
+  for more advanced control of client behavior. For example usage, see below.
+
+* :setting:`KEY_PREFIX <CACHES-KEY_PREFIX>`: A string that will be
+  automatically included (prepended by default) to all cache keys
+  used by the Django server.
+
+  See the :ref:`cache documentation <cache_key_prefixing>` for
+  more information.
+
+* :setting:`VERSION <CACHES-VERSION>`: The default version number
+  for cache keys generated by the Django server.
+
+  See the :ref:`cache documentation <cache_versioning>` for more
+  information.
+
+* :setting:`KEY_FUNCTION <CACHES-KEY_FUNCTION>`
+  A string containing a dotted path to a function that defines how
+  to compose a prefix, version and key into a final cache key.
+
+  See the :ref:`cache documentation <cache_key_transformation>`
+  for more information.
+
+In this example, a filesystem backend is being configured with a timeout
+of 60 seconds, and a maximum capacity of 1000 items::
+
+    CACHES = {
+        "default": {
+            "BACKEND": "django.core.cache.backends.filebased.FileBasedCache",
+            "LOCATION": "/var/tmp/django_cache",
+            "TIMEOUT": 60,
+            "OPTIONS": {"MAX_ENTRIES": 1000},
+        }
+    }
+
+Here's an example configuration for a ``pylibmc`` based backend that enables
+the binary protocol, SASL authentication, and the ``ketama`` behavior mode::
+
+    CACHES = {
+        "default": {
+            "BACKEND": "django.core.cache.backends.memcached.PyLibMCCache",
+            "LOCATION": "127.0.0.1:11211",
+            "OPTIONS": {
+                "binary": True,
+                "username": "user",
+                "password": "pass",
+                "behaviors": {
+                    "ketama": True,
+                },
+            },
+        }
+    }
+
+Here's an example configuration for a ``pymemcache`` based backend that enables
+client pooling (which may improve performance by keeping clients connected),
+treats memcache/network errors as cache misses, and sets the ``TCP_NODELAY``
+flag on the connection's socket::
+
+    CACHES = {
+        "default": {
+            "BACKEND": "django.core.cache.backends.memcached.PyMemcacheCache",
+            "LOCATION": "127.0.0.1:11211",
+            "OPTIONS": {
+                "no_delay": True,
+                "ignore_exc": True,
+                "max_pool_size": 4,
+                "use_pooling": True,
+            },
+        }
+    }
+
+Here's an example configuration for a ``redis`` based backend that selects
+database ``10`` (by default Redis ships with 16 logical databases), specifies a
+`parser class`_ (``redis.connection.HiredisParser`` will be used by default if
+the ``hiredis-py`` package is installed), and sets a custom `connection pool
+class`_ (``redis.ConnectionPool`` is used by default)::
+
+    CACHES = {
+        "default": {
+            "BACKEND": "django.core.cache.backends.redis.RedisCache",
+            "LOCATION": "redis://127.0.0.1:6379",
+            "OPTIONS": {
+                "db": "10",
+                "parser_class": "redis.connection.PythonParser",
+                "pool_class": "redis.BlockingConnectionPool",
+            },
+        }
+    }
+
+.. _`parser class`: https://github.com/redis/redis-py#parsers
+.. _`connection pool class`: https://github.com/redis/redis-py#connection-pools
+
+.. _the-per-site-cache:
+
+The per-site cache
+==================
+
+Once the cache is set up, the simplest way to use caching is to cache your
+entire site. You'll need to add
+``'django.middleware.cache.UpdateCacheMiddleware'`` and
+``'django.middleware.cache.FetchFromCacheMiddleware'`` to your
+:setting:`MIDDLEWARE` setting, as in this example::
+
+    MIDDLEWARE = [
+        "django.middleware.cache.UpdateCacheMiddleware",
+        "django.middleware.common.CommonMiddleware",
+        "django.middleware.cache.FetchFromCacheMiddleware",
+    ]
+
+.. note::
+
+    No, that's not a typo: the "update" middleware must be first in the list,
+    and the "fetch" middleware must be last. The details are a bit obscure, but
+    see `Order of MIDDLEWARE`_ below if you'd like the full story.
+
+Then, add the following required settings to your Django settings file:
+
+* :setting:`CACHE_MIDDLEWARE_ALIAS` -- The cache alias to use for storage.
+* :setting:`CACHE_MIDDLEWARE_SECONDS` -- The number of seconds each page should
+  be cached.
+* :setting:`CACHE_MIDDLEWARE_KEY_PREFIX` -- If the cache is shared across
+  multiple sites using the same Django installation, set this to the name of
+  the site, or some other string that is unique to this Django instance, to
+  prevent key collisions. Use an empty string if you don't care.
+
+``FetchFromCacheMiddleware`` caches GET and HEAD responses with status 200,
+where the request and response headers allow. Responses to requests for the same
+URL with different query parameters are considered to be unique pages and are
+cached separately. This middleware expects that a HEAD request is answered with
+the same response headers as the corresponding GET request; in which case it can
+return a cached GET response for HEAD request.
+
+Additionally, ``UpdateCacheMiddleware`` automatically sets a few headers in
+each :class:`~django.http.HttpResponse` which affect :ref:`downstream caches
+<downstream-caches>`:
+
+* Sets the ``Expires`` header to the current date/time plus the defined
+  :setting:`CACHE_MIDDLEWARE_SECONDS`.
+
+* Sets the ``Cache-Control`` header to give a max age for the page --
+  again, from the :setting:`CACHE_MIDDLEWARE_SECONDS` setting.
+
+See :doc:`/topics/http/middleware` for more on middleware.
+
+If a view sets its own cache expiry time (i.e. it has a ``max-age`` section in
+its ``Cache-Control`` header) then the page will be cached until the expiry
+time, rather than :setting:`CACHE_MIDDLEWARE_SECONDS`. Using the decorators in
+``django.views.decorators.cache`` you can easily set a view's expiry time
+(using the :func:`~django.views.decorators.cache.cache_control` decorator) or
+disable caching for a view (using the
+:func:`~django.views.decorators.cache.never_cache` decorator). See the
+`using other headers`__ section for more on these decorators.
+
+.. _i18n-cache-key:
+
+If :setting:`USE_I18N` is set to ``True`` then the generated cache key will
+include the name of the active :term:`language<language code>` -- see also
+:ref:`how-django-discovers-language-preference`). This allows you to easily
+cache multilingual sites without having to create the cache key yourself.
+
+Cache keys also include the :ref:`current time zone
+<default-current-time-zone>` when :setting:`USE_TZ` is set to ``True``.
+
+__ `Controlling cache: Using other headers`_
+
+The per-view cache
+==================
+
+.. function:: django.views.decorators.cache.cache_page(timeout, *, cache=None, key_prefix=None)
+
+A more granular way to use the caching framework is by caching the output of
+individual views. ``django.views.decorators.cache`` defines a ``cache_page``
+decorator that will automatically cache the view's response for you::
+
+    from django.views.decorators.cache import cache_page
+
+
+    @cache_page(60 * 15)
+    def my_view(request):
+        ...
+
+``cache_page`` takes a single argument: the cache timeout, in seconds. In the
+above example, the result of the ``my_view()`` view will be cached for 15
+minutes. (Note that we've written it as ``60 * 15`` for the purpose of
+readability. ``60 * 15`` will be evaluated to ``900`` -- that is, 15 minutes
+multiplied by 60 seconds per minute.)
+
+The cache timeout set by ``cache_page`` takes precedence over the ``max-age``
+directive from the ``Cache-Control`` header.
+
+The per-view cache, like the per-site cache, is keyed off of the URL. If
+multiple URLs point at the same view, each URL will be cached separately.
+Continuing the ``my_view`` example, if your URLconf looks like this::
+
+    urlpatterns = [
+        path("foo/<int:code>/", my_view),
+    ]
+
+then requests to ``/foo/1/`` and ``/foo/23/`` will be cached separately, as
+you may expect. But once a particular URL (e.g., ``/foo/23/``) has been
+requested, subsequent requests to that URL will use the cache.
+
+``cache_page`` can also take an optional keyword argument, ``cache``,
+which directs the decorator to use a specific cache (from your
+:setting:`CACHES` setting) when caching view results. By default, the
+``default`` cache will be used, but you can specify any cache you
+want::
+
+    @cache_page(60 * 15, cache="special_cache")
+    def my_view(request):
+        ...
+
+You can also override the cache prefix on a per-view basis. ``cache_page``
+takes an optional keyword argument, ``key_prefix``,
+which works in the same way as the :setting:`CACHE_MIDDLEWARE_KEY_PREFIX`
+setting for the middleware.  It can be used like this::
+
+    @cache_page(60 * 15, key_prefix="site1")
+    def my_view(request):
+        ...
+
+The ``key_prefix`` and ``cache`` arguments may be specified together. The
+``key_prefix`` argument and the :setting:`KEY_PREFIX <CACHES-KEY_PREFIX>`
+specified under :setting:`CACHES` will be concatenated.
+
+Additionally, ``cache_page`` automatically sets ``Cache-Control`` and
+``Expires`` headers in the response which affect :ref:`downstream caches
+<downstream-caches>`.
+
+Specifying per-view cache in the URLconf
+----------------------------------------
+
+The examples in the previous section have hard-coded the fact that the view is
+cached, because ``cache_page`` alters the ``my_view`` function in place. This
+approach couples your view to the cache system, which is not ideal for several
+reasons. For instance, you might want to reuse the view functions on another,
+cache-less site, or you might want to distribute the views to people who might
+want to use them without being cached. The solution to these problems is to
+specify the per-view cache in the URLconf rather than next to the view functions
+themselves.
+
+You can do so by wrapping the view function with ``cache_page`` when you refer
+to it in the URLconf. Here's the old URLconf from earlier::
+
+    urlpatterns = [
+        path("foo/<int:code>/", my_view),
+    ]
+
+Here's the same thing, with ``my_view`` wrapped in ``cache_page``::
+
+    from django.views.decorators.cache import cache_page
+
+    urlpatterns = [
+        path("foo/<int:code>/", cache_page(60 * 15)(my_view)),
+    ]
+
+.. templatetag:: cache
+
+Template fragment caching
+=========================
+
+If you're after even more control, you can also cache template fragments using
+the ``cache`` template tag. To give your template access to this tag, put
+``{% load cache %}`` near the top of your template.
+
+The ``{% cache %}`` template tag caches the contents of the block for a given
+amount of time. It takes at least two arguments: the cache timeout, in seconds,
+and the name to give the cache fragment. The fragment is cached forever if
+timeout is ``None``. The name will be taken as is, do not use a variable. For
+example:
+
+.. code-block:: html+django
+
+    {% load cache %}
+    {% cache 500 sidebar %}
+        .. sidebar ..
+    {% endcache %}
+
+Sometimes you might want to cache multiple copies of a fragment depending on
+some dynamic data that appears inside the fragment. For example, you might want a
+separate cached copy of the sidebar used in the previous example for every user
+of your site. Do this by passing one or more additional arguments, which may be
+variables with or without filters, to the ``{% cache %}`` template tag to
+uniquely identify the cache fragment:
+
+.. code-block:: html+django
+
+    {% load cache %}
+    {% cache 500 sidebar request.user.username %}
+        .. sidebar for logged in user ..
+    {% endcache %}
+
+If :setting:`USE_I18N` is set to ``True`` the per-site middleware cache will
+:ref:`respect the active language<i18n-cache-key>`. For the ``cache`` template
+tag you could use one of the
+:ref:`translation-specific variables<template-translation-vars>` available in
+templates to achieve the same result:
+
+.. code-block:: html+django
+
+    {% load i18n %}
+    {% load cache %}
+
+    {% get_current_language as LANGUAGE_CODE %}
+
+    {% cache 600 welcome LANGUAGE_CODE %}
+        {% translate "Welcome to example.com" %}
+    {% endcache %}
+
+The cache timeout can be a template variable, as long as the template variable
+resolves to an integer value. For example, if the template variable
+``my_timeout`` is set to the value ``600``, then the following two examples are
+equivalent:
+
+.. code-block:: html+django
+
+    {% cache 600 sidebar %} ... {% endcache %}
+    {% cache my_timeout sidebar %} ... {% endcache %}
+
+This feature is useful in avoiding repetition in templates. You can set the
+timeout in a variable, in one place, and reuse that value.
+
+By default, the cache tag will try to use the cache called "template_fragments".
+If no such cache exists, it will fall back to using the default cache. You may
+select an alternate cache backend to use with the ``using`` keyword argument,
+which must be the last argument to the tag.
+
+.. code-block:: html+django
+
+    {% cache 300 local-thing ...  using="localcache" %}
+
+It is considered an error to specify a cache name that is not configured.
+
+.. function:: django.core.cache.utils.make_template_fragment_key(fragment_name, vary_on=None)
+
+If you want to obtain the cache key used for a cached fragment, you can use
+``make_template_fragment_key``. ``fragment_name`` is the same as second argument
+to the ``cache`` template tag; ``vary_on`` is a list of all additional arguments
+passed to the tag. This function can be useful for invalidating or overwriting
+a cached item, for example:
+
+.. code-block:: pycon
+
+    >>> from django.core.cache import cache
+    >>> from django.core.cache.utils import make_template_fragment_key
+    # cache key for {% cache 500 sidebar username %}
+    >>> key = make_template_fragment_key("sidebar", [username])
+    >>> cache.delete(key)  # invalidates cached template fragment
+    True
+
+.. _low-level-cache-api:
+
+The low-level cache API
+=======================
+
+Sometimes, caching an entire rendered page doesn't gain you very much and is,
+in fact, inconvenient overkill.
+
+Perhaps, for instance, your site includes a view whose results depend on
+several expensive queries, the results of which change at different intervals.
+In this case, it would not be ideal to use the full-page caching that the
+per-site or per-view cache strategies offer, because you wouldn't want to
+cache the entire result (since some of the data changes often), but you'd still
+want to cache the results that rarely change.
+
+For cases like this, Django exposes a low-level cache API. You can use this API
+to store objects in the cache with any level of granularity you like.  You can
+cache any Python object that can be pickled safely: strings, dictionaries,
+lists of model objects, and so forth. (Most common Python objects can be
+pickled; refer to the Python documentation for more information about
+pickling.)
+
+Accessing the cache
+-------------------
+
+.. data:: django.core.cache.caches
+
+    You can access the caches configured in the :setting:`CACHES` setting
+    through a dict-like object: ``django.core.cache.caches``. Repeated
+    requests for the same alias in the same thread will return the same
+    object.
+
+        >>> from django.core.cache import caches
+        >>> cache1 = caches['myalias']
+        >>> cache2 = caches['myalias']
+        >>> cache1 is cache2
+        True
+
+    If the named key does not exist, ``InvalidCacheBackendError`` will be
+    raised.
+
+    To provide thread-safety, a different instance of the cache backend will
+    be returned for each thread.
+
+.. data:: django.core.cache.cache
+
+    As a shortcut, the default cache is available as
+    ``django.core.cache.cache``:
+
+    .. code-block:: pycon
+
+        >>> from django.core.cache import cache
+
+    This object is equivalent to ``caches['default']``.
+
+.. _cache-basic-interface:
+
+Basic usage
+-----------
+
+.. currentmodule:: django.core.cache
+
+The basic interface is:
+
+.. method:: cache.set(key, value, timeout=DEFAULT_TIMEOUT, version=None)
+
+    >>> cache.set('my_key', 'hello, world!', 30)
+
+.. method:: cache.get(key, default=None, version=None)
+
+    >>> cache.get('my_key')
+    'hello, world!'
+
+``key`` should be a ``str``, and ``value`` can be any picklable Python object.
+
+The ``timeout`` argument is optional and defaults to the ``timeout`` argument
+of the appropriate backend in the :setting:`CACHES` setting (explained above).
+It's the number of seconds the value should be stored in the cache. Passing in
+``None`` for ``timeout`` will cache the value forever. A ``timeout`` of ``0``
+won't cache the value.
+
+If the object doesn't exist in the cache, ``cache.get()`` returns ``None``:
+
+.. code-block:: pycon
+
+    >>> # Wait 30 seconds for 'my_key' to expire...
+    >>> cache.get("my_key")
+    None
+
+If you need to determine whether the object exists in the cache and you have
+stored a literal value ``None``, use a sentinel object as the default:
+
+.. code-block:: pycon
+
+    >>> sentinel = object()
+    >>> cache.get("my_key", sentinel) is sentinel
+    False
+    >>> # Wait 30 seconds for 'my_key' to expire...
+    >>> cache.get("my_key", sentinel) is sentinel
+    True
+
+``cache.get()`` can take a ``default`` argument. This specifies which value to
+return if the object doesn't exist in the cache:
+
+.. code-block:: pycon
+
+    >>> cache.get("my_key", "has expired")
+    'has expired'
+
+.. method:: cache.add(key, value, timeout=DEFAULT_TIMEOUT, version=None)
+
+To add a key only if it doesn't already exist, use the ``add()`` method.
+It takes the same parameters as ``set()``, but it will not attempt to
+update the cache if the key specified is already present:
+
+.. code-block:: pycon
+
+    >>> cache.set("add_key", "Initial value")
+    >>> cache.add("add_key", "New value")
+    >>> cache.get("add_key")
+    'Initial value'
+
+If you need to know whether ``add()`` stored a value in the cache, you can
+check the return value. It will return ``True`` if the value was stored,
+``False`` otherwise.
+
+.. method:: cache.get_or_set(key, default, timeout=DEFAULT_TIMEOUT, version=None)
+
+If you want to get a key's value or set a value if the key isn't in the cache,
+there is the ``get_or_set()`` method. It takes the same parameters as ``get()``
+but the default is set as the new cache value for that key, rather than
+returned:
+
+.. code-block:: pycon
+
+    >>> cache.get("my_new_key")  # returns None
+    >>> cache.get_or_set("my_new_key", "my new value", 100)
+    'my new value'
+
+You can also pass any callable as a *default* value:
+
+.. code-block:: pycon
+
+    >>> import datetime
+    >>> cache.get_or_set("some-timestamp-key", datetime.datetime.now)
+    datetime.datetime(2014, 12, 11, 0, 15, 49, 457920)
+
+.. method:: cache.get_many(keys, version=None)
+
+There's also a ``get_many()`` interface that only hits the cache once.
+``get_many()`` returns a dictionary with all the keys you asked for that
+actually exist in the cache (and haven't expired):
+
+.. code-block:: pycon
+
+    >>> cache.set("a", 1)
+    >>> cache.set("b", 2)
+    >>> cache.set("c", 3)
+    >>> cache.get_many(["a", "b", "c"])
+    {'a': 1, 'b': 2, 'c': 3}
+
+.. method:: cache.set_many(dict, timeout)
+
+To set multiple values more efficiently, use ``set_many()`` to pass a dictionary
+of key-value pairs:
+
+.. code-block:: pycon
+
+    >>> cache.set_many({"a": 1, "b": 2, "c": 3})
+    >>> cache.get_many(["a", "b", "c"])
+    {'a': 1, 'b': 2, 'c': 3}
+
+Like ``cache.set()``, ``set_many()`` takes an optional ``timeout`` parameter.
+
+On supported backends (memcached), ``set_many()`` returns a list of keys that
+failed to be inserted.
+
+.. method:: cache.delete(key, version=None)
+
+You can delete keys explicitly with ``delete()`` to clear the cache for a
+particular object:
+
+.. code-block:: pycon
+
+    >>> cache.delete("a")
+    True
+
+``delete()`` returns ``True`` if the key was successfully deleted, ``False``
+otherwise.
+
+.. method:: cache.delete_many(keys, version=None)
+
+If you want to clear a bunch of keys at once, ``delete_many()`` can take a list
+of keys to be cleared:
+
+.. code-block:: pycon
+
+    >>> cache.delete_many(["a", "b", "c"])
+
+.. method:: cache.clear()
+
+Finally, if you want to delete all the keys in the cache, use
+``cache.clear()``.  Be careful with this; ``clear()`` will remove *everything*
+from the cache, not just the keys set by your application. :
+
+.. code-block:: pycon
+
+    >>> cache.clear()
+
+.. method:: cache.touch(key, timeout=DEFAULT_TIMEOUT, version=None)
+
+``cache.touch()`` sets a new expiration for a key. For example, to update a key
+to expire 10 seconds from now:
+
+.. code-block:: pycon
+
+    >>> cache.touch("a", 10)
+    True
+
+Like other methods, the ``timeout`` argument is optional and defaults to the
+``TIMEOUT`` option of the appropriate backend in the :setting:`CACHES` setting.
+
+``touch()`` returns ``True`` if the key was successfully touched, ``False``
+otherwise.
+
+.. method:: cache.incr(key, delta=1, version=None)
+.. method:: cache.decr(key, delta=1, version=None)
+
+You can also increment or decrement a key that already exists using the
+``incr()`` or ``decr()`` methods, respectively. By default, the existing cache
+value will be incremented or decremented by 1. Other increment/decrement values
+can be specified by providing an argument to the increment/decrement call. A
+ValueError will be raised if you attempt to increment or decrement a
+nonexistent cache key:
+
+.. code-block:: pycon
+
+    >>> cache.set("num", 1)
+    >>> cache.incr("num")
+    2
+    >>> cache.incr("num", 10)
+    12
+    >>> cache.decr("num")
+    11
+    >>> cache.decr("num", 5)
+    6
+
+.. note::
+
+    ``incr()``/``decr()`` methods are not guaranteed to be atomic. On those
+    backends that support atomic increment/decrement (most notably, the
+    memcached backend), increment and decrement operations will be atomic.
+    However, if the backend doesn't natively provide an increment/decrement
+    operation, it will be implemented using a two-step retrieve/update.
+
+.. method:: cache.close()
+
+You can close the connection to your cache with ``close()`` if implemented by
+the cache backend.
+
+    >>> cache.close()
+
+.. note::
+
+    For caches that don't implement ``close`` methods it is a no-op.
+
+.. note::
+
+    The async variants of base methods are prefixed with ``a``, e.g.
+    ``cache.aadd()`` or ``cache.adelete_many()``. See `Asynchronous support`_
+    for more details.
+
+.. _cache_key_prefixing:
+
+Cache key prefixing
+-------------------
+
+If you are sharing a cache instance between servers, or between your
+production and development environments, it's possible for data cached
+by one server to be used by another server. If the format of cached
+data is different between servers, this can lead to some very hard to
+diagnose problems.
+
+To prevent this, Django provides the ability to prefix all cache keys
+used by a server. When a particular cache key is saved or retrieved,
+Django will automatically prefix the cache key with the value of the
+:setting:`KEY_PREFIX <CACHES-KEY_PREFIX>` cache setting.
+
+By ensuring each Django instance has a different
+:setting:`KEY_PREFIX <CACHES-KEY_PREFIX>`, you can ensure that there will be no
+collisions in cache values.
+
+.. _cache_versioning:
+
+Cache versioning
+----------------
+
+When you change running code that uses cached values, you may need to
+purge any existing cached values. The easiest way to do this is to
+flush the entire cache, but this can lead to the loss of cache values
+that are still valid and useful.
+
+Django provides a better way to target individual cache values.
+Django's cache framework has a system-wide version identifier,
+specified using the :setting:`VERSION <CACHES-VERSION>` cache setting.
+The value of this setting is automatically combined with the cache
+prefix and the user-provided cache key to obtain the final cache key.
+
+By default, any key request will automatically include the site
+default cache key version. However, the primitive cache functions all
+include a ``version`` argument, so you can specify a particular cache
+key version to set or get. For example:
+
+.. code-block:: pycon
+
+    >>> # Set version 2 of a cache key
+    >>> cache.set("my_key", "hello world!", version=2)
+    >>> # Get the default version (assuming version=1)
+    >>> cache.get("my_key")
+    None
+    >>> # Get version 2 of the same key
+    >>> cache.get("my_key", version=2)
+    'hello world!'
+
+The version of a specific key can be incremented and decremented using
+the ``incr_version()`` and ``decr_version()`` methods. This
+enables specific keys to be bumped to a new version, leaving other
+keys unaffected. Continuing our previous example:
+
+.. code-block:: pycon
+
+    >>> # Increment the version of 'my_key'
+    >>> cache.incr_version("my_key")
+    >>> # The default version still isn't available
+    >>> cache.get("my_key")
+    None
+    # Version 2 isn't available, either
+    >>> cache.get("my_key", version=2)
+    None
+    >>> # But version 3 *is* available
+    >>> cache.get("my_key", version=3)
+    'hello world!'
+
+.. _cache_key_transformation:
+
+Cache key transformation
+------------------------
+
+As described in the previous two sections, the cache key provided by a
+user is not used verbatim -- it is combined with the cache prefix and
+key version to provide a final cache key. By default, the three parts
+are joined using colons to produce a final string::
+
+    def make_key(key, key_prefix, version):
+        return "%s:%s:%s" % (key_prefix, version, key)
+
+If you want to combine the parts in different ways, or apply other
+processing to the final key (e.g., taking a hash digest of the key
+parts), you can provide a custom key function.
+
+The :setting:`KEY_FUNCTION <CACHES-KEY_FUNCTION>` cache setting
+specifies a dotted-path to a function matching the prototype of
+``make_key()`` above. If provided, this custom key function will
+be used instead of the default key combining function.
+
+Cache key warnings
+------------------
+
+Memcached, the most commonly-used production cache backend, does not allow
+cache keys longer than 250 characters or containing whitespace or control
+characters, and using such keys will cause an exception. To encourage
+cache-portable code and minimize unpleasant surprises, the other built-in cache
+backends issue a warning (``django.core.cache.backends.base.CacheKeyWarning``)
+if a key is used that would cause an error on memcached.
+
+If you are using a production backend that can accept a wider range of keys (a
+custom backend, or one of the non-memcached built-in backends), and want to use
+this wider range without warnings, you can silence ``CacheKeyWarning`` with
+this code in the ``management`` module of one of your
+:setting:`INSTALLED_APPS`::
+
+     import warnings
+
+     from django.core.cache import CacheKeyWarning
+
+     warnings.simplefilter("ignore", CacheKeyWarning)
+
+If you want to instead provide custom key validation logic for one of the
+built-in backends, you can subclass it, override just the ``validate_key``
+method, and follow the instructions for `using a custom cache backend`_. For
+instance, to do this for the ``locmem`` backend, put this code in a module::
+
+    from django.core.cache.backends.locmem import LocMemCache
+
+
+    class CustomLocMemCache(LocMemCache):
+        def validate_key(self, key):
+            """Custom validation, raising exceptions or warnings as needed."""
+            ...
+
+...and use the dotted Python path to this class in the
+:setting:`BACKEND <CACHES-BACKEND>` portion of your :setting:`CACHES` setting.
+
+.. _asynchronous_support:
+
+Asynchronous support
+====================
+
+Django has developing support for asynchronous cache backends, but does not
+yet support asynchronous caching. It will be coming in a future release.
+
+``django.core.cache.backends.base.BaseCache`` has async variants of :ref:`all
+base methods <cache-basic-interface>`. By convention, the asynchronous versions
+of all methods are prefixed with ``a``. By default, the arguments for both
+variants are the same:
+
+.. code-block:: pycon
+
+    >>> await cache.aset("num", 1)
+    >>> await cache.ahas_key("num")
+    True
+
+.. _downstream-caches:
+
+Downstream caches
+=================
+
+So far, this document has focused on caching your *own* data. But another type
+of caching is relevant to web development, too: caching performed by
+"downstream" caches. These are systems that cache pages for users even before
+the request reaches your website.
+
+Here are a few examples of downstream caches:
+
+* When using HTTP, your :abbr:`ISP (Internet Service Provider)` may cache
+  certain pages, so if you requested a page from ``http://example.com/``, your
+  ISP would send you the page without having to access example.com directly.
+  The maintainers of example.com have no knowledge of this caching; the ISP
+  sits between example.com and your web browser, handling all of the caching
+  transparently. Such caching is not possible under HTTPS as it would
+  constitute a man-in-the-middle attack.
+
+* Your Django website may sit behind a *proxy cache*, such as Squid Web
+  Proxy Cache (http://www.squid-cache.org/), that caches pages for
+  performance. In this case, each request first would be handled by the
+  proxy, and it would be passed to your application only if needed.
+
+* Your web browser caches pages, too. If a web page sends out the
+  appropriate headers, your browser will use the local cached copy for
+  subsequent requests to that page, without even contacting the web page
+  again to see whether it has changed.
+
+Downstream caching is a nice efficiency boost, but there's a danger to it:
+Many web pages' contents differ based on authentication and a host of other
+variables, and cache systems that blindly save pages based purely on URLs could
+expose incorrect or sensitive data to subsequent visitors to those pages.
+
+For example, if you operate a web email system, then the contents of the
+"inbox" page depend on which user is logged in. If an ISP blindly cached your
+site, then the first user who logged in through that ISP would have their
+user-specific inbox page cached for subsequent visitors to the site.  That's
+not cool.
+
+Fortunately, HTTP provides a solution to this problem. A number of HTTP headers
+exist to instruct downstream caches to differ their cache contents depending on
+designated variables, and to tell caching mechanisms not to cache particular
+pages. We'll look at some of these headers in the sections that follow.
+
+.. _using-vary-headers:
+
+Using ``Vary`` headers
+======================
+
+The ``Vary`` header defines which request headers a cache
+mechanism should take into account when building its cache key. For example, if
+the contents of a web page depend on a user's language preference, the page is
+said to "vary on language."
+
+By default, Django's cache system creates its cache keys using the requested
+fully-qualified URL -- e.g.,
+``"https://www.example.com/stories/2005/?order_by=author"``. This means every
+request to that URL will use the same cached version, regardless of user-agent
+differences such as cookies or language preferences. However, if this page
+produces different content based on some difference in request headers -- such
+as a cookie, or a language, or a user-agent -- you'll need to use the ``Vary``
+header to tell caching mechanisms that the page output depends on those things.
+
+To do this in Django, use the convenient
+:func:`django.views.decorators.vary.vary_on_headers` view decorator, like so::
+
+    from django.views.decorators.vary import vary_on_headers
+
+
+    @vary_on_headers("User-Agent")
+    def my_view(request):
+        ...
+
+In this case, a caching mechanism (such as Django's own cache middleware) will
+cache a separate version of the page for each unique user-agent.
+
+The advantage to using the ``vary_on_headers`` decorator rather than manually
+setting the ``Vary`` header (using something like ``response.headers['Vary'] =
+'user-agent'``) is that the decorator *adds* to the ``Vary`` header (which may
+already exist), rather than setting it from scratch and potentially overriding
+anything that was already in there.
+
+You can pass multiple headers to ``vary_on_headers()``::
+
+    @vary_on_headers("User-Agent", "Cookie")
+    def my_view(request):
+        ...
+
+This tells downstream caches to vary on *both*, which means each combination of
+user-agent and cookie will get its own cache value. For example, a request with
+the user-agent ``Mozilla`` and the cookie value ``foo=bar`` will be considered
+different from a request with the user-agent ``Mozilla`` and the cookie value
+``foo=ham``.
+
+Because varying on cookie is so common, there's a
+:func:`django.views.decorators.vary.vary_on_cookie` decorator. These two views
+are equivalent::
+
+    @vary_on_cookie
+    def my_view(request):
+        ...
+
+
+    @vary_on_headers("Cookie")
+    def my_view(request):
+        ...
+
+The headers you pass to ``vary_on_headers`` are not case sensitive;
+``"User-Agent"`` is the same thing as ``"user-agent"``.
+
+You can also use a helper function, :func:`django.utils.cache.patch_vary_headers`,
+directly. This function sets, or adds to, the ``Vary header``. For example::
+
+    from django.shortcuts import render
+    from django.utils.cache import patch_vary_headers
+
+
+    def my_view(request):
+        ...
+        response = render(request, "template_name", context)
+        patch_vary_headers(response, ["Cookie"])
+        return response
+
+``patch_vary_headers`` takes an :class:`~django.http.HttpResponse` instance as
+its first argument and a list/tuple of case-insensitive header names as its
+second argument.
+
+For more on Vary headers, see the :rfc:`official Vary spec
+<9110#section-12.5.5>`.
+
+Controlling cache: Using other headers
+======================================
+
+Other problems with caching are the privacy of data and the question of where
+data should be stored in a cascade of caches.
+
+A user usually faces two kinds of caches: their own browser cache (a private
+cache) and their provider's cache (a public cache). A public cache is used by
+multiple users and controlled by someone else. This poses problems with
+sensitive data--you don't want, say, your bank account number stored in a
+public cache. So web applications need a way to tell caches which data is
+private and which is public.
+
+The solution is to indicate a page's cache should be "private." To do this in
+Django, use the :func:`~django.views.decorators.cache.cache_control` view
+decorator. Example::
+
+    from django.views.decorators.cache import cache_control
+
+
+    @cache_control(private=True)
+    def my_view(request):
+        ...
+
+This decorator takes care of sending out the appropriate HTTP header behind the
+scenes.
+
+Note that the cache control settings "private" and "public" are mutually
+exclusive. The decorator ensures that the "public" directive is removed if
+"private" should be set (and vice versa). An example use of the two directives
+would be a blog site that offers both private and public entries. Public
+entries may be cached on any shared cache. The following code uses
+:func:`~django.utils.cache.patch_cache_control`, the manual way to modify the
+cache control header (it is internally called by the
+:func:`~django.views.decorators.cache.cache_control` decorator)::
+
+    from django.views.decorators.cache import patch_cache_control
+    from django.views.decorators.vary import vary_on_cookie
+
+
+    @vary_on_cookie
+    def list_blog_entries_view(request):
+        if request.user.is_anonymous:
+            response = render_only_public_entries()
+            patch_cache_control(response, public=True)
+        else:
+            response = render_private_and_public_entries(request.user)
+            patch_cache_control(response, private=True)
+
+        return response
+
+You can control downstream caches in other ways as well (see :rfc:`9111` for
+details on HTTP caching). For example, even if you don't use Django's
+server-side cache framework, you can still tell clients to cache a view for a
+certain amount of time with the :rfc:`max-age <9111#section-5.2.2.1>`
+directive::
+
+    from django.views.decorators.cache import cache_control
+
+
+    @cache_control(max_age=3600)
+    def my_view(request):
+        ...
+
+(If you *do* use the caching middleware, it already sets the ``max-age`` with
+the value of the :setting:`CACHE_MIDDLEWARE_SECONDS` setting. In that case,
+the custom ``max_age`` from the
+:func:`~django.views.decorators.cache.cache_control` decorator will take
+precedence, and the header values will be merged correctly.)
+
+Any valid ``Cache-Control`` response directive is valid in ``cache_control()``.
+Here are some more examples:
+
+* ``no_transform=True``
+* ``must_revalidate=True``
+* ``stale_while_revalidate=num_seconds``
+* ``no_cache=True``
+
+The full list of known directives can be found in the `IANA registry`_
+(note that not all of them apply to responses).
+
+.. _IANA registry: https://www.iana.org/assignments/http-cache-directives/http-cache-directives.xhtml
+
+If you want to use headers to disable caching altogether,
+:func:`~django.views.decorators.cache.never_cache` is a view decorator that
+adds headers to ensure the response won't be cached by browsers or other
+caches. Example::
+
+    from django.views.decorators.cache import never_cache
+
+
+    @never_cache
+    def myview(request):
+        ...
+
+Order of ``MIDDLEWARE``
+=======================
+
+If you use caching middleware, it's important to put each half in the right
+place within the :setting:`MIDDLEWARE` setting. That's because the cache
+middleware needs to know which headers by which to vary the cache storage.
+Middleware always adds something to the ``Vary`` response header when it can.
+
+``UpdateCacheMiddleware`` runs during the response phase, where middleware is
+run in reverse order, so an item at the top of the list runs *last* during the
+response phase. Thus, you need to make sure that ``UpdateCacheMiddleware``
+appears *before* any other middleware that might add something to the ``Vary``
+header. The following middleware modules do so:
+
+* ``SessionMiddleware`` adds ``Cookie``
+* ``GZipMiddleware`` adds ``Accept-Encoding``
+* ``LocaleMiddleware`` adds ``Accept-Language``
+
+``FetchFromCacheMiddleware``, on the other hand, runs during the request phase,
+where middleware is applied first-to-last, so an item at the top of the list
+runs *first* during the request phase. The ``FetchFromCacheMiddleware`` also
+needs to run after other middleware updates the ``Vary`` header, so
+``FetchFromCacheMiddleware`` must be *after* any item that does so.

testbed/django__django/docs/topics/class-based-views/generic-display.txt

@@ -0,0 +1,438 @@
+==================================
+Built-in class-based generic views
+==================================
+
+Writing web applications can be monotonous, because we repeat certain patterns
+again and again. Django tries to take away some of that monotony at the model
+and template layers, but web developers also experience this boredom at the view
+level.
+
+Django's *generic views* were developed to ease that pain. They take certain
+common idioms and patterns found in view development and abstract them so that
+you can quickly write common views of data without having to write too much
+code.
+
+We can recognize certain common tasks, like displaying a list of objects, and
+write code that displays a list of *any* object. Then the model in question can
+be passed as an extra argument to the URLconf.
+
+Django ships with generic views to do the following:
+
+* Display list and detail pages for a single object. If we were creating an
+  application to manage conferences then a ``TalkListView`` and a
+  ``RegisteredUserListView`` would be examples of list views. A single
+  talk page is an example of what we call a "detail" view.
+
+* Present date-based objects in year/month/day archive pages,
+  associated detail, and "latest" pages.
+
+* Allow users to create, update, and delete objects -- with or
+  without authorization.
+
+Taken together, these views provide interfaces to perform the most common tasks
+developers encounter.
+
+
+Extending generic views
+=======================
+
+There's no question that using generic views can speed up development
+substantially. In most projects, however, there comes a moment when the
+generic views no longer suffice. Indeed, the most common question asked by new
+Django developers is how to make generic views handle a wider array of
+situations.
+
+This is one of the reasons generic views were redesigned for the 1.3 release -
+previously, they were view functions with a bewildering array of options; now,
+rather than passing in a large amount of configuration in the URLconf, the
+recommended way to extend generic views is to subclass them, and override their
+attributes or methods.
+
+That said, generic views will have a limit. If you find you're struggling to
+implement your view as a subclass of a generic view, then you may find it more
+effective to write just the code you need, using your own class-based or
+functional views.
+
+More examples of generic views are available in some third party applications,
+or you could write your own as needed.
+
+
+Generic views of objects
+========================
+
+:class:`~django.views.generic.base.TemplateView` certainly is useful, but
+Django's generic views really shine when it comes to presenting views of your
+database content. Because it's such a common task, Django comes with a handful
+of built-in generic views to help generate list and detail views of objects.
+
+Let's start by looking at some examples of showing a list of objects or an
+individual object.
+
+We'll be using these models::
+
+    # models.py
+    from django.db import models
+
+
+    class Publisher(models.Model):
+        name = models.CharField(max_length=30)
+        address = models.CharField(max_length=50)
+        city = models.CharField(max_length=60)
+        state_province = models.CharField(max_length=30)
+        country = models.CharField(max_length=50)
+        website = models.URLField()
+
+        class Meta:
+            ordering = ["-name"]
+
+        def __str__(self):
+            return self.name
+
+
+    class Author(models.Model):
+        salutation = models.CharField(max_length=10)
+        name = models.CharField(max_length=200)
+        email = models.EmailField()
+        headshot = models.ImageField(upload_to="author_headshots")
+
+        def __str__(self):
+            return self.name
+
+
+    class Book(models.Model):
+        title = models.CharField(max_length=100)
+        authors = models.ManyToManyField("Author")
+        publisher = models.ForeignKey(Publisher, on_delete=models.CASCADE)
+        publication_date = models.DateField()
+
+Now we need to define a view::
+
+    # views.py
+    from django.views.generic import ListView
+    from books.models import Publisher
+
+
+    class PublisherListView(ListView):
+        model = Publisher
+
+Finally hook that view into your urls::
+
+    # urls.py
+    from django.urls import path
+    from books.views import PublisherListView
+
+    urlpatterns = [
+        path("publishers/", PublisherListView.as_view()),
+    ]
+
+That's all the Python code we need to write. We still need to write a template,
+however. We could explicitly tell the view which template to use by adding a
+``template_name`` attribute to the view, but in the absence of an explicit
+template Django will infer one from the object's name. In this case, the
+inferred template will be ``"books/publisher_list.html"`` -- the "books" part
+comes from the name of the app that defines the model, while the "publisher"
+bit is the lowercased version of the model's name.
+
+.. note::
+
+    Thus, when (for example) the ``APP_DIRS`` option of a ``DjangoTemplates``
+    backend is set to True in :setting:`TEMPLATES`, a template location could
+    be: /path/to/project/books/templates/books/publisher_list.html
+
+This template will be rendered against a context containing a variable called
+``object_list`` that contains all the publisher objects. A template might look
+like this:
+
+.. code-block:: html+django
+
+    {% extends "base.html" %}
+
+    {% block content %}
+        <h2>Publishers</h2>
+        <ul>
+            {% for publisher in object_list %}
+                <li>{{ publisher.name }}</li>
+            {% endfor %}
+        </ul>
+    {% endblock %}
+
+That's really all there is to it. All the cool features of generic views come
+from changing the attributes set on the generic view. The
+:doc:`generic views reference</ref/class-based-views/index>` documents all the
+generic views and their options in detail; the rest of this document will
+consider some of the common ways you might customize and extend generic views.
+
+
+Making "friendly" template contexts
+-----------------------------------
+
+You might have noticed that our sample publisher list template stores all the
+publishers in a variable named ``object_list``. While this works just fine, it
+isn't all that "friendly" to template authors: they have to "just know" that
+they're dealing with publishers here.
+
+Well, if you're dealing with a model object, this is already done for you. When
+you are dealing with an object or queryset, Django is able to populate the
+context using the lowercased version of the model class' name. This is provided
+in addition to the default ``object_list`` entry, but contains exactly the same
+data, i.e. ``publisher_list``.
+
+If this still isn't a good match, you can manually set the name of the
+context variable. The ``context_object_name`` attribute on a generic view
+specifies the context variable to use::
+
+    # views.py
+    from django.views.generic import ListView
+    from books.models import Publisher
+
+
+    class PublisherListView(ListView):
+        model = Publisher
+        context_object_name = "my_favorite_publishers"
+
+Providing a useful ``context_object_name`` is always a good idea. Your
+coworkers who design templates will thank you.
+
+
+.. _adding-extra-context:
+
+Adding extra context
+--------------------
+
+Often you need to present some extra information beyond that provided by the
+generic view. For example, think of showing a list of all the books on each
+publisher detail page. The :class:`~django.views.generic.detail.DetailView`
+generic view provides the publisher to the context, but how do we get
+additional information in that template?
+
+The answer is to subclass :class:`~django.views.generic.detail.DetailView`
+and provide your own implementation of the ``get_context_data`` method.
+The default implementation adds the object being displayed to the template, but
+you can override it to send more::
+
+    from django.views.generic import DetailView
+    from books.models import Book, Publisher
+
+
+    class PublisherDetailView(DetailView):
+        model = Publisher
+
+        def get_context_data(self, **kwargs):
+            # Call the base implementation first to get a context
+            context = super().get_context_data(**kwargs)
+            # Add in a QuerySet of all the books
+            context["book_list"] = Book.objects.all()
+            return context
+
+.. note::
+
+    Generally, ``get_context_data`` will merge the context data of all parent
+    classes with those of the current class. To preserve this behavior in your
+    own classes where you want to alter the context, you should be sure to call
+    ``get_context_data`` on the super class. When no two classes try to define the
+    same key, this will give the expected results. However if any class
+    attempts to override a key after parent classes have set it (after the call
+    to super), any children of that class will also need to explicitly set it
+    after super if they want to be sure to override all parents. If you're
+    having trouble, review the method resolution order of your view.
+
+    Another consideration is that the context data from class-based generic
+    views will override data provided by context processors; see
+    :meth:`~django.views.generic.detail.SingleObjectMixin.get_context_data` for
+    an example.
+
+.. _generic-views-list-subsets:
+
+Viewing subsets of objects
+--------------------------
+
+Now let's take a closer look at the ``model`` argument we've been
+using all along. The ``model`` argument, which specifies the database
+model that the view will operate upon, is available on all the
+generic views that operate on a single object or a collection of
+objects. However, the ``model`` argument is not the only way to
+specify the objects that the view will operate upon -- you can also
+specify the list of objects using the ``queryset`` argument::
+
+    from django.views.generic import DetailView
+    from books.models import Publisher
+
+
+    class PublisherDetailView(DetailView):
+        context_object_name = "publisher"
+        queryset = Publisher.objects.all()
+
+Specifying ``model = Publisher`` is shorthand for saying ``queryset =
+Publisher.objects.all()``. However, by using ``queryset`` to define a filtered
+list of objects you can be more specific about the objects that will be visible
+in the view (see :doc:`/topics/db/queries` for more information about
+:class:`~django.db.models.query.QuerySet` objects, and see the
+:doc:`class-based views reference </ref/class-based-views/index>` for the
+complete details).
+
+To pick an example, we might want to order a list of books by publication date,
+with the most recent first::
+
+    from django.views.generic import ListView
+    from books.models import Book
+
+
+    class BookListView(ListView):
+        queryset = Book.objects.order_by("-publication_date")
+        context_object_name = "book_list"
+
+That's a pretty minimal example, but it illustrates the idea nicely. You'll
+usually want to do more than just reorder objects. If you want to present a
+list of books by a particular publisher, you can use the same technique::
+
+    from django.views.generic import ListView
+    from books.models import Book
+
+
+    class AcmeBookListView(ListView):
+        context_object_name = "book_list"
+        queryset = Book.objects.filter(publisher__name="ACME Publishing")
+        template_name = "books/acme_list.html"
+
+Notice that along with a filtered ``queryset``, we're also using a custom
+template name. If we didn't, the generic view would use the same template as the
+"vanilla" object list, which might not be what we want.
+
+Also notice that this isn't a very elegant way of doing publisher-specific
+books. If we want to add another publisher page, we'd need another handful of
+lines in the URLconf, and more than a few publishers would get unreasonable.
+We'll deal with this problem in the next section.
+
+.. note::
+
+    If you get a 404 when requesting ``/books/acme/``, check to ensure you
+    actually have a Publisher with the name 'ACME Publishing'.  Generic
+    views have an ``allow_empty`` parameter for this case.  See the
+    :doc:`class-based-views reference</ref/class-based-views/index>` for more
+    details.
+
+
+Dynamic filtering
+-----------------
+
+Another common need is to filter down the objects given in a list page by some
+key in the URL. Earlier we hard-coded the publisher's name in the URLconf, but
+what if we wanted to write a view that displayed all the books by some arbitrary
+publisher?
+
+Handily, the ``ListView`` has a
+:meth:`~django.views.generic.list.MultipleObjectMixin.get_queryset` method we
+can override. By default, it returns the value of the ``queryset`` attribute,
+but we can use it to add more logic.
+
+The key part to making this work is that when class-based views are called,
+various useful things are stored on ``self``; as well as the request
+(``self.request``) this includes the positional (``self.args``) and name-based
+(``self.kwargs``) arguments captured according to the URLconf.
+
+Here, we have a URLconf with a single captured group::
+
+    # urls.py
+    from django.urls import path
+    from books.views import PublisherBookListView
+
+    urlpatterns = [
+        path("books/<publisher>/", PublisherBookListView.as_view()),
+    ]
+
+Next, we'll write the ``PublisherBookListView`` view itself::
+
+    # views.py
+    from django.shortcuts import get_object_or_404
+    from django.views.generic import ListView
+    from books.models import Book, Publisher
+
+
+    class PublisherBookListView(ListView):
+        template_name = "books/books_by_publisher.html"
+
+        def get_queryset(self):
+            self.publisher = get_object_or_404(Publisher, name=self.kwargs["publisher"])
+            return Book.objects.filter(publisher=self.publisher)
+
+Using ``get_queryset`` to add logic to the queryset selection is as convenient
+as it is powerful. For instance, if we wanted, we could use
+``self.request.user`` to filter using the current user, or other more complex
+logic.
+
+We can also add the publisher into the context at the same time, so we can
+use it in the template::
+
+        # ...
+
+
+        def get_context_data(self, **kwargs):
+            # Call the base implementation first to get a context
+            context = super().get_context_data(**kwargs)
+            # Add in the publisher
+            context["publisher"] = self.publisher
+            return context
+
+.. _generic-views-extra-work:
+
+Performing extra work
+---------------------
+
+The last common pattern we'll look at involves doing some extra work before
+or after calling the generic view.
+
+Imagine we had a ``last_accessed`` field on our ``Author`` model that we were
+using to keep track of the last time anybody looked at that author::
+
+    # models.py
+    from django.db import models
+
+
+    class Author(models.Model):
+        salutation = models.CharField(max_length=10)
+        name = models.CharField(max_length=200)
+        email = models.EmailField()
+        headshot = models.ImageField(upload_to="author_headshots")
+        last_accessed = models.DateTimeField()
+
+The generic ``DetailView`` class wouldn't know anything about this field, but
+once again we could write a custom view to keep that field updated.
+
+First, we'd need to add an author detail bit in the URLconf to point to a
+custom view::
+
+    from django.urls import path
+    from books.views import AuthorDetailView
+
+    urlpatterns = [
+        # ...
+        path("authors/<int:pk>/", AuthorDetailView.as_view(), name="author-detail"),
+    ]
+
+Then we'd write our new view -- ``get_object`` is the method that retrieves the
+object -- so we override it and wrap the call::
+
+    from django.utils import timezone
+    from django.views.generic import DetailView
+    from books.models import Author
+
+
+    class AuthorDetailView(DetailView):
+        queryset = Author.objects.all()
+
+        def get_object(self):
+            obj = super().get_object()
+            # Record the last accessed date
+            obj.last_accessed = timezone.now()
+            obj.save()
+            return obj
+
+.. note::
+
+    The URLconf here uses the named group ``pk`` - this name is the default
+    name that ``DetailView`` uses to find the value of the primary key used to
+    filter the queryset.
+
+    If you want to call the group something else, you can set
+    :attr:`~django.views.generic.detail.SingleObjectMixin.pk_url_kwarg`
+    on the view.

testbed/django__django/docs/topics/class-based-views/generic-editing.txt

@@ -0,0 +1,275 @@
+====================================
+Form handling with class-based views
+====================================
+
+Form processing generally has 3 paths:
+
+* Initial GET (blank or prepopulated form)
+* POST with invalid data (typically redisplay form with errors)
+* POST with valid data (process the data and typically redirect)
+
+Implementing this yourself often results in a lot of repeated boilerplate code
+(see :ref:`Using a form in a view<using-a-form-in-a-view>`). To help avoid
+this, Django provides a collection of generic class-based views for form
+processing.
+
+Basic forms
+===========
+
+Given a contact form:
+
+.. code-block:: python
+    :caption: ``forms.py``
+
+    from django import forms
+
+
+    class ContactForm(forms.Form):
+        name = forms.CharField()
+        message = forms.CharField(widget=forms.Textarea)
+
+        def send_email(self):
+            # send email using the self.cleaned_data dictionary
+            pass
+
+The view can be constructed using a ``FormView``:
+
+.. code-block:: python
+    :caption: ``views.py``
+
+    from myapp.forms import ContactForm
+    from django.views.generic.edit import FormView
+
+
+    class ContactFormView(FormView):
+        template_name = "contact.html"
+        form_class = ContactForm
+        success_url = "/thanks/"
+
+        def form_valid(self, form):
+            # This method is called when valid form data has been POSTed.
+            # It should return an HttpResponse.
+            form.send_email()
+            return super().form_valid(form)
+
+Notes:
+
+* FormView inherits
+  :class:`~django.views.generic.base.TemplateResponseMixin` so
+  :attr:`~django.views.generic.base.TemplateResponseMixin.template_name`
+  can be used here.
+* The default implementation for
+  :meth:`~django.views.generic.edit.FormMixin.form_valid` simply
+  redirects to the :attr:`~django.views.generic.edit.FormMixin.success_url`.
+
+Model forms
+===========
+
+Generic views really shine when working with models.  These generic
+views will automatically create a :class:`~django.forms.ModelForm`, so long as
+they can work out which model class to use:
+
+* If the :attr:`~django.views.generic.edit.ModelFormMixin.model` attribute is
+  given, that model class will be used.
+* If :meth:`~django.views.generic.detail.SingleObjectMixin.get_object()`
+  returns an object, the class of that object will be used.
+* If a :attr:`~django.views.generic.detail.SingleObjectMixin.queryset` is
+  given, the model for that queryset will be used.
+
+Model form views provide a
+:meth:`~django.views.generic.edit.ModelFormMixin.form_valid()` implementation
+that saves the model automatically.  You can override this if you have any
+special requirements; see below for examples.
+
+You don't even need to provide a ``success_url`` for
+:class:`~django.views.generic.edit.CreateView` or
+:class:`~django.views.generic.edit.UpdateView` - they will use
+:meth:`~django.db.models.Model.get_absolute_url()` on the model object if available.
+
+If you want to use a custom :class:`~django.forms.ModelForm` (for instance to
+add extra validation), set
+:attr:`~django.views.generic.edit.FormMixin.form_class` on your view.
+
+.. note::
+    When specifying a custom form class, you must still specify the model,
+    even though the :attr:`~django.views.generic.edit.FormMixin.form_class` may
+    be a :class:`~django.forms.ModelForm`.
+
+First we need to add :meth:`~django.db.models.Model.get_absolute_url()` to our
+``Author`` class:
+
+.. code-block:: python
+    :caption: ``models.py``
+
+    from django.db import models
+    from django.urls import reverse
+
+
+    class Author(models.Model):
+        name = models.CharField(max_length=200)
+
+        def get_absolute_url(self):
+            return reverse("author-detail", kwargs={"pk": self.pk})
+
+Then we can use :class:`CreateView` and friends to do the actual
+work. Notice how we're just configuring the generic class-based views
+here; we don't have to write any logic ourselves:
+
+.. code-block:: python
+    :caption: ``views.py``
+
+    from django.urls import reverse_lazy
+    from django.views.generic.edit import CreateView, DeleteView, UpdateView
+    from myapp.models import Author
+
+
+    class AuthorCreateView(CreateView):
+        model = Author
+        fields = ["name"]
+
+
+    class AuthorUpdateView(UpdateView):
+        model = Author
+        fields = ["name"]
+
+
+    class AuthorDeleteView(DeleteView):
+        model = Author
+        success_url = reverse_lazy("author-list")
+
+.. note::
+    We have to use :func:`~django.urls.reverse_lazy` instead of
+    ``reverse()``, as the urls are not loaded when the file is imported.
+
+The ``fields`` attribute works the same way as the ``fields`` attribute on the
+inner ``Meta`` class on :class:`~django.forms.ModelForm`. Unless you define the
+form class in another way, the attribute is required and the view will raise
+an :exc:`~django.core.exceptions.ImproperlyConfigured` exception if it's not.
+
+If you specify both the :attr:`~django.views.generic.edit.ModelFormMixin.fields`
+and :attr:`~django.views.generic.edit.FormMixin.form_class` attributes, an
+:exc:`~django.core.exceptions.ImproperlyConfigured` exception will be raised.
+
+Finally, we hook these new views into the URLconf:
+
+.. code-block:: python
+    :caption: ``urls.py``
+
+    from django.urls import path
+    from myapp.views import AuthorCreateView, AuthorDeleteView, AuthorUpdateView
+
+    urlpatterns = [
+        # ...
+        path("author/add/", AuthorCreateView.as_view(), name="author-add"),
+        path("author/<int:pk>/", AuthorUpdateView.as_view(), name="author-update"),
+        path("author/<int:pk>/delete/", AuthorDeleteView.as_view(), name="author-delete"),
+    ]
+
+.. note::
+
+    These views inherit
+    :class:`~django.views.generic.detail.SingleObjectTemplateResponseMixin`
+    which uses
+    :attr:`~django.views.generic.detail.SingleObjectTemplateResponseMixin.template_name_suffix`
+    to construct the
+    :attr:`~django.views.generic.base.TemplateResponseMixin.template_name`
+    based on the model.
+
+    In this example:
+
+    * :class:`CreateView` and :class:`UpdateView` use ``myapp/author_form.html``
+    * :class:`DeleteView` uses ``myapp/author_confirm_delete.html``
+
+    If you wish to have separate templates for :class:`CreateView` and
+    :class:`UpdateView`, you can set either
+    :attr:`~django.views.generic.base.TemplateResponseMixin.template_name` or
+    :attr:`~django.views.generic.detail.SingleObjectTemplateResponseMixin.template_name_suffix`
+    on your view class.
+
+Models and ``request.user``
+===========================
+
+To track the user that created an object using a :class:`CreateView`,
+you can use a custom :class:`~django.forms.ModelForm` to do this. First, add
+the foreign key relation to the model:
+
+.. code-block:: python
+    :caption: ``models.py``
+
+    from django.contrib.auth.models import User
+    from django.db import models
+
+
+    class Author(models.Model):
+        name = models.CharField(max_length=200)
+        created_by = models.ForeignKey(User, on_delete=models.CASCADE)
+
+        # ...
+
+In the view, ensure that you don't include ``created_by`` in the list of fields
+to edit, and override
+:meth:`~django.views.generic.edit.ModelFormMixin.form_valid()` to add the user:
+
+.. code-block:: python
+    :caption: ``views.py``
+
+    from django.contrib.auth.mixins import LoginRequiredMixin
+    from django.views.generic.edit import CreateView
+    from myapp.models import Author
+
+
+    class AuthorCreateView(LoginRequiredMixin, CreateView):
+        model = Author
+        fields = ["name"]
+
+        def form_valid(self, form):
+            form.instance.created_by = self.request.user
+            return super().form_valid(form)
+
+:class:`~django.contrib.auth.mixins.LoginRequiredMixin` prevents users who
+aren't logged in from accessing the form. If you omit that, you'll need to
+handle unauthorized users in :meth:`~.ModelFormMixin.form_valid()`.
+
+.. _content-negotiation-example:
+
+Content negotiation example
+===========================
+
+Here is an example showing how you might go about implementing a form that
+works with an API-based workflow as well as 'normal' form POSTs::
+
+    from django.http import JsonResponse
+    from django.views.generic.edit import CreateView
+    from myapp.models import Author
+
+
+    class JsonableResponseMixin:
+        """
+        Mixin to add JSON support to a form.
+        Must be used with an object-based FormView (e.g. CreateView)
+        """
+
+        def form_invalid(self, form):
+            response = super().form_invalid(form)
+            if self.request.accepts("text/html"):
+                return response
+            else:
+                return JsonResponse(form.errors, status=400)
+
+        def form_valid(self, form):
+            # We make sure to call the parent's form_valid() method because
+            # it might do some processing (in the case of CreateView, it will
+            # call form.save() for example).
+            response = super().form_valid(form)
+            if self.request.accepts("text/html"):
+                return response
+            else:
+                data = {
+                    "pk": self.object.pk,
+                }
+                return JsonResponse(data)
+
+
+    class AuthorCreateView(JsonableResponseMixin, CreateView):
+        model = Author
+        fields = ["name"]

testbed/django__django/docs/topics/class-based-views/index.txt

@@ -0,0 +1,165 @@
+=================
+Class-based views
+=================
+
+A view is a callable which takes a request and returns a
+response. This can be more than just a function, and Django provides
+an example of some classes which can be used as views. These allow you
+to structure your views and reuse code by harnessing inheritance and
+mixins. There are also some generic views for tasks which we'll get to later,
+but you may want to design your own structure of reusable views which suits
+your use case. For full details, see the :doc:`class-based views reference
+documentation</ref/class-based-views/index>`.
+
+.. toctree::
+   :maxdepth: 1
+
+   intro
+   generic-display
+   generic-editing
+   mixins
+
+Basic examples
+==============
+
+Django provides base view classes which will suit a wide range of applications.
+All views inherit from the :class:`~django.views.generic.base.View` class, which
+handles linking the view into the URLs, HTTP method dispatching and other
+common features. :class:`~django.views.generic.base.RedirectView` provides a
+HTTP redirect, and :class:`~django.views.generic.base.TemplateView` extends the
+base class to make it also render a template.
+
+
+Usage in your URLconf
+=====================
+
+The most direct way to use generic views is to create them directly in your
+URLconf. If you're only changing a few attributes on a class-based view, you
+can pass them into the :meth:`~django.views.generic.base.View.as_view` method
+call itself::
+
+    from django.urls import path
+    from django.views.generic import TemplateView
+
+    urlpatterns = [
+        path("about/", TemplateView.as_view(template_name="about.html")),
+    ]
+
+Any arguments passed to :meth:`~django.views.generic.base.View.as_view` will
+override attributes set on the class. In this example, we set ``template_name``
+on the ``TemplateView``. A similar overriding pattern can be used for the
+``url`` attribute on :class:`~django.views.generic.base.RedirectView`.
+
+
+Subclassing generic views
+=========================
+
+The second, more powerful way to use generic views is to inherit from an
+existing view and override attributes (such as the ``template_name``) or
+methods (such as ``get_context_data``) in your subclass to provide new values
+or methods. Consider, for example, a view that just displays one template,
+``about.html``. Django has a generic view to do this -
+:class:`~django.views.generic.base.TemplateView` - so we can subclass it, and
+override the template name::
+
+    # some_app/views.py
+    from django.views.generic import TemplateView
+
+
+    class AboutView(TemplateView):
+        template_name = "about.html"
+
+Then we need to add this new view into our URLconf.
+:class:`~django.views.generic.base.TemplateView` is a class, not a function, so
+we point the URL to the :meth:`~django.views.generic.base.View.as_view` class
+method instead, which provides a function-like entry to class-based views::
+
+    # urls.py
+    from django.urls import path
+    from some_app.views import AboutView
+
+    urlpatterns = [
+        path("about/", AboutView.as_view()),
+    ]
+
+
+For more information on how to use the built in generic views, consult the next
+topic on :doc:`generic class-based views</topics/class-based-views/generic-display>`.
+
+.. _supporting-other-http-methods:
+
+Supporting other HTTP methods
+-----------------------------
+
+Suppose somebody wants to access our book library over HTTP using the views
+as an API. The API client would connect every now and then and download book
+data for the books published since last visit. But if no new books appeared
+since then, it is a waste of CPU time and bandwidth to fetch the books from the
+database, render a full response and send it to the client. It might be
+preferable to ask the API when the most recent book was published.
+
+We map the URL to book list view in the URLconf::
+
+    from django.urls import path
+    from books.views import BookListView
+
+    urlpatterns = [
+        path("books/", BookListView.as_view()),
+    ]
+
+And the view::
+
+    from django.http import HttpResponse
+    from django.views.generic import ListView
+    from books.models import Book
+
+
+    class BookListView(ListView):
+        model = Book
+
+        def head(self, *args, **kwargs):
+            last_book = self.get_queryset().latest("publication_date")
+            response = HttpResponse(
+                # RFC 1123 date format.
+                headers={
+                    "Last-Modified": last_book.publication_date.strftime(
+                        "%a, %d %b %Y %H:%M:%S GMT"
+                    )
+                },
+            )
+            return response
+
+If the view is accessed from a ``GET`` request, an object list is returned in
+the response (using the ``book_list.html`` template). But if the client issues
+a ``HEAD`` request, the response has an empty body and the ``Last-Modified``
+header indicates when the most recent book was published.  Based on this
+information, the client may or may not download the full object list.
+
+.. _async-class-based-views:
+
+Asynchronous class-based views
+==============================
+
+As well as the synchronous (``def``) method handlers already shown, ``View``
+subclasses may define asynchronous (``async def``) method handlers to leverage
+asynchronous code using ``await``::
+
+    import asyncio
+    from django.http import HttpResponse
+    from django.views import View
+
+
+    class AsyncView(View):
+        async def get(self, request, *args, **kwargs):
+            # Perform io-blocking view logic using await, sleep for example.
+            await asyncio.sleep(1)
+            return HttpResponse("Hello async world!")
+
+Within a single view-class, all user-defined method handlers must be either
+synchronous, using ``def``, or all asynchronous, using ``async def``. An
+``ImproperlyConfigured`` exception will be raised in ``as_view()`` if ``def``
+and ``async def`` declarations are mixed.
+
+Django will automatically detect asynchronous views and run them in an
+asynchronous context. You can read more about Django's asynchronous support,
+and how to best use async views, in :doc:`/topics/async`.

testbed/django__django/docs/topics/class-based-views/intro.txt

@@ -0,0 +1,327 @@
+=================================
+Introduction to class-based views
+=================================
+
+Class-based views provide an alternative way to implement views as Python
+objects instead of functions. They do not replace function-based views, but
+have certain differences and advantages when compared to function-based views:
+
+* Organization of code related to specific HTTP methods (``GET``, ``POST``,
+  etc.) can be addressed by separate methods instead of conditional branching.
+
+* Object oriented techniques such as mixins (multiple inheritance) can be
+  used to factor code into reusable components.
+
+The relationship and history of generic views, class-based views, and class-based generic views
+===============================================================================================
+
+In the beginning there was only the view function contract, Django passed your
+function an :class:`~django.http.HttpRequest` and expected back an
+:class:`~django.http.HttpResponse`. This was the extent of what Django provided.
+
+Early on it was recognized that there were common idioms and patterns found in
+view development. Function-based generic views were introduced to abstract
+these patterns and ease view development for the common cases.
+
+The problem with function-based generic views is that while they covered the
+simple cases well, there was no way to extend or customize them beyond some
+configuration options, limiting their usefulness in many real-world
+applications.
+
+Class-based generic views were created with the same objective as
+function-based generic views, to make view development easier. However, the way
+the solution is implemented, through the use of mixins, provides a toolkit that
+results in class-based generic views being more extensible and flexible than
+their function-based counterparts.
+
+If you have tried function based generic views in the past and found them
+lacking, you should not think of class-based generic views as a class-based
+equivalent, but rather as a fresh approach to solving the original problems
+that generic views were meant to solve.
+
+The toolkit of base classes and mixins that Django uses to build class-based
+generic views are built for maximum flexibility, and as such have many hooks in
+the form of default method implementations and attributes that you are unlikely
+to be concerned with in the simplest use cases. For example, instead of
+limiting you to a class-based attribute for ``form_class``, the implementation
+uses a ``get_form`` method, which calls a ``get_form_class`` method, which in
+its default implementation returns the ``form_class`` attribute of the class.
+This gives you several options for specifying what form to use, from an
+attribute, to a fully dynamic, callable hook. These options seem to add hollow
+complexity for simple situations, but without them, more advanced designs would
+be limited.
+
+Using class-based views
+=======================
+
+At its core, a class-based view allows you to respond to different HTTP request
+methods with different class instance methods, instead of with conditionally
+branching code inside a single view function.
+
+So where the code to handle HTTP ``GET`` in a view function would look
+something like::
+
+    from django.http import HttpResponse
+
+
+    def my_view(request):
+        if request.method == "GET":
+            # <view logic>
+            return HttpResponse("result")
+
+In a class-based view, this would become::
+
+    from django.http import HttpResponse
+    from django.views import View
+
+
+    class MyView(View):
+        def get(self, request):
+            # <view logic>
+            return HttpResponse("result")
+
+Because Django's URL resolver expects to send the request and associated
+arguments to a callable function, not a class, class-based views have an
+:meth:`~django.views.generic.base.View.as_view` class method which returns a
+function that can be called when a request arrives for a URL matching the
+associated pattern. The function creates an instance of the class, calls
+:meth:`~django.views.generic.base.View.setup` to initialize its attributes, and
+then calls its :meth:`~django.views.generic.base.View.dispatch` method.
+``dispatch`` looks at the request to determine whether it is a ``GET``,
+``POST``, etc, and relays the request to a matching method if one is defined,
+or raises :class:`~django.http.HttpResponseNotAllowed` if not::
+
+    # urls.py
+    from django.urls import path
+    from myapp.views import MyView
+
+    urlpatterns = [
+        path("about/", MyView.as_view()),
+    ]
+
+
+It is worth noting that what your method returns is identical to what you
+return from a function-based view, namely some form of
+:class:`~django.http.HttpResponse`. This means that
+:doc:`http shortcuts </topics/http/shortcuts>` or
+:class:`~django.template.response.TemplateResponse` objects are valid to use
+inside a class-based view.
+
+While a minimal class-based view does not require any class attributes to
+perform its job, class attributes are useful in many class-based designs,
+and there are two ways to configure or set class attributes.
+
+The first is the standard Python way of subclassing and overriding attributes
+and methods in the subclass. So that if your parent class had an attribute
+``greeting`` like this::
+
+    from django.http import HttpResponse
+    from django.views import View
+
+
+    class GreetingView(View):
+        greeting = "Good Day"
+
+        def get(self, request):
+            return HttpResponse(self.greeting)
+
+You can override that in a subclass::
+
+    class MorningGreetingView(GreetingView):
+        greeting = "Morning to ya"
+
+Another option is to configure class attributes as keyword arguments to the
+:meth:`~django.views.generic.base.View.as_view` call in the URLconf::
+
+    urlpatterns = [
+        path("about/", GreetingView.as_view(greeting="G'day")),
+    ]
+
+.. note::
+
+    While your class is instantiated for each request dispatched to it, class
+    attributes set through the
+    :meth:`~django.views.generic.base.View.as_view` entry point are
+    configured only once at the time your URLs are imported.
+
+Using mixins
+============
+
+Mixins are a form of multiple inheritance where behaviors and attributes of
+multiple parent classes can be combined.
+
+For example, in the generic class-based views there is a mixin called
+:class:`~django.views.generic.base.TemplateResponseMixin` whose primary purpose
+is to define the method
+:meth:`~django.views.generic.base.TemplateResponseMixin.render_to_response`.
+When combined with the behavior of the :class:`~django.views.generic.base.View`
+base class, the result is a :class:`~django.views.generic.base.TemplateView`
+class that will dispatch requests to the appropriate matching methods (a
+behavior defined in the ``View`` base class), and that has a
+:meth:`~django.views.generic.base.TemplateResponseMixin.render_to_response`
+method that uses a
+:attr:`~django.views.generic.base.TemplateResponseMixin.template_name`
+attribute to return a :class:`~django.template.response.TemplateResponse`
+object (a behavior defined in the ``TemplateResponseMixin``).
+
+Mixins are an excellent way of reusing code across multiple classes, but they
+come with some cost. The more your code is scattered among mixins, the harder
+it will be to read a child class and know what exactly it is doing, and the
+harder it will be to know which methods from which mixins to override if you
+are subclassing something that has a deep inheritance tree.
+
+Note also that you can only inherit from one generic view - that is, only one
+parent class may inherit from :class:`~django.views.generic.base.View` and
+the rest (if any) should be mixins. Trying to inherit from more than one class
+that inherits from ``View`` - for example, trying to use a form at the top of a
+list and combining :class:`~django.views.generic.edit.ProcessFormView` and
+:class:`~django.views.generic.list.ListView` - won't work as expected.
+
+
+Handling forms with class-based views
+=====================================
+
+A basic function-based view that handles forms may look something like this::
+
+    from django.http import HttpResponseRedirect
+    from django.shortcuts import render
+
+    from .forms import MyForm
+
+
+    def myview(request):
+        if request.method == "POST":
+            form = MyForm(request.POST)
+            if form.is_valid():
+                # <process form cleaned data>
+                return HttpResponseRedirect("/success/")
+        else:
+            form = MyForm(initial={"key": "value"})
+
+        return render(request, "form_template.html", {"form": form})
+
+A similar class-based view might look like::
+
+    from django.http import HttpResponseRedirect
+    from django.shortcuts import render
+    from django.views import View
+
+    from .forms import MyForm
+
+
+    class MyFormView(View):
+        form_class = MyForm
+        initial = {"key": "value"}
+        template_name = "form_template.html"
+
+        def get(self, request, *args, **kwargs):
+            form = self.form_class(initial=self.initial)
+            return render(request, self.template_name, {"form": form})
+
+        def post(self, request, *args, **kwargs):
+            form = self.form_class(request.POST)
+            if form.is_valid():
+                # <process form cleaned data>
+                return HttpResponseRedirect("/success/")
+
+            return render(request, self.template_name, {"form": form})
+
+This is a minimal case, but you can see that you would then have the option
+of customizing this view by overriding any of the class attributes, e.g.
+``form_class``, via URLconf configuration, or subclassing and overriding one or
+more of the methods (or both!).
+
+Decorating class-based views
+============================
+
+The extension of class-based views isn't limited to using mixins. You can also
+use decorators. Since class-based views aren't functions, decorating them works
+differently depending on if you're using ``as_view()`` or creating a subclass.
+
+Decorating in URLconf
+---------------------
+
+You can adjust class-based views by decorating the result of the
+:meth:`~django.views.generic.base.View.as_view` method. The easiest place to do
+this is in the URLconf where you deploy your view::
+
+    from django.contrib.auth.decorators import login_required, permission_required
+    from django.views.generic import TemplateView
+
+    from .views import VoteView
+
+    urlpatterns = [
+        path("about/", login_required(TemplateView.as_view(template_name="secret.html"))),
+        path("vote/", permission_required("polls.can_vote")(VoteView.as_view())),
+    ]
+
+This approach applies the decorator on a per-instance basis. If you
+want every instance of a view to be decorated, you need to take a
+different approach.
+
+.. _decorating-class-based-views:
+
+Decorating the class
+--------------------
+
+To decorate every instance of a class-based view, you need to decorate
+the class definition itself. To do this you apply the decorator to the
+:meth:`~django.views.generic.base.View.dispatch` method of the class.
+
+A method on a class isn't quite the same as a standalone function, so you can't
+just apply a function decorator to the method -- you need to transform it into
+a method decorator first. The ``method_decorator`` decorator transforms a
+function decorator into a method decorator so that it can be used on an
+instance method. For example::
+
+    from django.contrib.auth.decorators import login_required
+    from django.utils.decorators import method_decorator
+    from django.views.generic import TemplateView
+
+
+    class ProtectedView(TemplateView):
+        template_name = "secret.html"
+
+        @method_decorator(login_required)
+        def dispatch(self, *args, **kwargs):
+            return super().dispatch(*args, **kwargs)
+
+Or, more succinctly, you can decorate the class instead and pass the name
+of the method to be decorated as the keyword argument ``name``::
+
+    @method_decorator(login_required, name="dispatch")
+    class ProtectedView(TemplateView):
+        template_name = "secret.html"
+
+If you have a set of common decorators used in several places, you can define
+a list or tuple of decorators and use this instead of invoking
+``method_decorator()`` multiple times. These two classes are equivalent::
+
+    decorators = [never_cache, login_required]
+
+
+    @method_decorator(decorators, name="dispatch")
+    class ProtectedView(TemplateView):
+        template_name = "secret.html"
+
+
+    @method_decorator(never_cache, name="dispatch")
+    @method_decorator(login_required, name="dispatch")
+    class ProtectedView(TemplateView):
+        template_name = "secret.html"
+
+The decorators will process a request in the order they are passed to the
+decorator. In the example, ``never_cache()`` will process the request before
+``login_required()``.
+
+In this example, every instance of ``ProtectedView`` will have login
+protection. These examples use ``login_required``, however, the same behavior
+can be obtained by using
+:class:`~django.contrib.auth.mixins.LoginRequiredMixin`.
+
+.. note::
+
+    ``method_decorator`` passes ``*args`` and ``**kwargs``
+    as parameters to the decorated method on the class. If your method
+    does not accept a compatible set of parameters it will raise a
+    ``TypeError`` exception.