From 9423f8b47673779049f603a7da271d183de7dc1d Mon Sep 17 00:00:00 2001 From: Sarah Boyce <42296566+sarahboyce@users.noreply.github.com> Date: Tue, 8 Oct 2024 08:47:10 +0200 Subject: [PATCH 001/132] Fixed #35612 -- Added documentation on how the security team evaluates reports. Co-authored-by: Joshua Olatunji --- docs/internals/security.txt | 35 +++++++++++++++++++++++++++++++++++ 1 file changed, 35 insertions(+) diff --git a/docs/internals/security.txt b/docs/internals/security.txt index 55300b01e1..6aac9a6b66 100644 --- a/docs/internals/security.txt +++ b/docs/internals/security.txt @@ -38,6 +38,41 @@ action to be taken, you may receive further followup emails. .. _our public Trac instance: https://code.djangoproject.com/query +.. _security-report-evaluation: + +How does Django evaluate a report +================================= + +These are criteria used by the security team when evaluating whether a report +requires a security release: + +* The vulnerability is within a :ref:`supported version ` of + Django. + +* The vulnerability applies to a production-grade Django application. This means + the following do not require a security release: + + * Exploits that only affect local development, for example when using + :djadmin:`runserver`. + * Exploits which fail to follow security best practices, such as failure to + sanitize user input. For other examples, see our :ref:`security + documentation `. + * Exploits in AI generated code that do not adhere to security best practices. + +The security team may conclude that the source of the vulnerability is within +the Python standard library, in which case the reporter will be asked to report +the vulnerability to the Python core team. For further details see the `Python +security guidelines `_. + +On occasion, a security release may be issued to help resolve a security +vulnerability within a popular third-party package. These reports should come +from the package maintainers. + +If you are unsure whether your finding meets these criteria, please still report +it :ref:`privately by emailing security@djangoproject.com +`. The security team will review your report and +recommend the correct course of action. + .. _security-support: Supported versions From 263f7319192b217c4e3b1eea0ea7809836392bbc Mon Sep 17 00:00:00 2001 From: Mariusz Felisiak Date: Fri, 11 Oct 2024 13:50:51 +0200 Subject: [PATCH 002/132] Fixed docs build on Sphinx 8.1+. Sphinx 8.1 added :cve: role, so there is no need to define it in Django: - https://github.com/sphinx-doc/sphinx/pull/11781 This also changes used URL to the one used by Python and soonish to be used by Sphinx itself: - https://github.com/sphinx-doc/sphinx/pull/13006 --- docs/conf.py | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/docs/conf.py b/docs/conf.py index b72b1afcf5..9289e821fa 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -13,6 +13,8 @@ import functools import sys from os.path import abspath, dirname, join +from sphinx import version_info as sphinx_version + # Workaround for sphinx-build recursion limit overflow: # pickle.dump(doctree, f, pickle.HIGHEST_PROTOCOL) # RuntimeError: maximum recursion depth exceeded while pickling an object @@ -138,13 +140,15 @@ django_next_version = "5.2" extlinks = { "bpo": ("https://bugs.python.org/issue?@action=redirect&bpo=%s", "bpo-%s"), "commit": ("https://github.com/django/django/commit/%s", "%s"), - "cve": ("https://nvd.nist.gov/vuln/detail/CVE-%s", "CVE-%s"), "pypi": ("https://pypi.org/project/%s/", "%s"), # A file or directory. GitHub redirects from blob to tree if needed. "source": ("https://github.com/django/django/blob/main/%s", "%s"), "ticket": ("https://code.djangoproject.com/ticket/%s", "#%s"), } +if sphinx_version < (8, 1): + extlinks["cve"] = ("https://www.cve.org/CVERecord?id=CVE-%s", "CVE-%s") + # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. # language = None From 97c05a64ca87253e9789ebaab4b6d20a1b2370cf Mon Sep 17 00:00:00 2001 From: Bendeguz Csirmaz Date: Fri, 27 Sep 2024 00:04:33 +0800 Subject: [PATCH 003/132] Refs #373 -- Added additional validations to tuple lookups. --- django/db/models/fields/tuple_lookups.py | 36 ++++++- tests/foreign_object/test_tuple_lookups.py | 110 ++++++++++++++++++++- 2 files changed, 139 insertions(+), 7 deletions(-) diff --git a/django/db/models/fields/tuple_lookups.py b/django/db/models/fields/tuple_lookups.py index eb2d80b20f..a94582db95 100644 --- a/django/db/models/fields/tuple_lookups.py +++ b/django/db/models/fields/tuple_lookups.py @@ -2,7 +2,7 @@ import itertools from django.core.exceptions import EmptyResultSet from django.db.models import Field -from django.db.models.expressions import Func, Value +from django.db.models.expressions import ColPairs, Func, Value from django.db.models.lookups import ( Exact, GreaterThan, @@ -28,17 +28,32 @@ class Tuple(Func): class TupleLookupMixin: def get_prep_lookup(self): + self.check_rhs_is_tuple_or_list() self.check_rhs_length_equals_lhs_length() return self.rhs + def check_rhs_is_tuple_or_list(self): + if not isinstance(self.rhs, (tuple, list)): + lhs_str = self.get_lhs_str() + raise ValueError( + f"{self.lookup_name!r} lookup of {lhs_str} must be a tuple or a list" + ) + def check_rhs_length_equals_lhs_length(self): len_lhs = len(self.lhs) if len_lhs != len(self.rhs): + lhs_str = self.get_lhs_str() raise ValueError( - f"'{self.lookup_name}' lookup of '{self.lhs.field.name}' field " - f"must have {len_lhs} elements" + f"{self.lookup_name!r} lookup of {lhs_str} must have {len_lhs} elements" ) + def get_lhs_str(self): + if isinstance(self.lhs, ColPairs): + return repr(self.lhs.field.name) + else: + names = ", ".join(repr(f.name) for f in self.lhs) + return f"({names})" + def get_prep_lhs(self): if isinstance(self.lhs, (tuple, list)): return Tuple(*self.lhs) @@ -196,14 +211,25 @@ class TupleLessThanOrEqual(TupleLookupMixin, LessThanOrEqual): class TupleIn(TupleLookupMixin, In): def get_prep_lookup(self): + self.check_rhs_is_tuple_or_list() + self.check_rhs_is_collection_of_tuples_or_lists() self.check_rhs_elements_length_equals_lhs_length() - return super(TupleLookupMixin, self).get_prep_lookup() + return self.rhs # skip checks from mixin + + def check_rhs_is_collection_of_tuples_or_lists(self): + if not all(isinstance(vals, (tuple, list)) for vals in self.rhs): + lhs_str = self.get_lhs_str() + raise ValueError( + f"{self.lookup_name!r} lookup of {lhs_str} " + "must be a collection of tuples or lists" + ) def check_rhs_elements_length_equals_lhs_length(self): len_lhs = len(self.lhs) if not all(len_lhs == len(vals) for vals in self.rhs): + lhs_str = self.get_lhs_str() raise ValueError( - f"'{self.lookup_name}' lookup of '{self.lhs.field.name}' field " + f"{self.lookup_name!r} lookup of {lhs_str} " f"must have {len_lhs} elements each" ) diff --git a/tests/foreign_object/test_tuple_lookups.py b/tests/foreign_object/test_tuple_lookups.py index e2561676f3..06182d3bb5 100644 --- a/tests/foreign_object/test_tuple_lookups.py +++ b/tests/foreign_object/test_tuple_lookups.py @@ -1,3 +1,4 @@ +import itertools import unittest from django.db import NotSupportedError, connection @@ -129,6 +130,37 @@ class TupleLookupsTests(TestCase): (self.contact_1, self.contact_2, self.contact_5), ) + def test_tuple_in_rhs_must_be_collection_of_tuples_or_lists(self): + test_cases = ( + (1, 2, 3), + ((1, 2), (3, 4), None), + ) + + for rhs in test_cases: + with self.subTest(rhs=rhs): + with self.assertRaisesMessage( + ValueError, + "'in' lookup of ('customer_code', 'company_code') " + "must be a collection of tuples or lists", + ): + TupleIn((F("customer_code"), F("company_code")), rhs) + + def test_tuple_in_rhs_must_have_2_elements_each(self): + test_cases = ( + ((),), + ((1,),), + ((1, 2, 3),), + ) + + for rhs in test_cases: + with self.subTest(rhs=rhs): + with self.assertRaisesMessage( + ValueError, + "'in' lookup of ('customer_code', 'company_code') " + "must have 2 elements each", + ): + TupleIn((F("customer_code"), F("company_code")), rhs) + def test_lt(self): c1, c2, c3, c4, c5, c6 = ( self.contact_1, @@ -358,8 +390,8 @@ class TupleLookupsTests(TestCase): ) def test_lookup_errors(self): - m_2_elements = "'%s' lookup of 'customer' field must have 2 elements" - m_2_elements_each = "'in' lookup of 'customer' field must have 2 elements each" + m_2_elements = "'%s' lookup of 'customer' must have 2 elements" + m_2_elements_each = "'in' lookup of 'customer' must have 2 elements each" test_cases = ( ({"customer": 1}, m_2_elements % "exact"), ({"customer": (1, 2, 3)}, m_2_elements % "exact"), @@ -381,3 +413,77 @@ class TupleLookupsTests(TestCase): self.assertRaisesMessage(ValueError, message), ): Contact.objects.get(**kwargs) + + def test_tuple_lookup_names(self): + test_cases = ( + (TupleExact, "exact"), + (TupleGreaterThan, "gt"), + (TupleGreaterThanOrEqual, "gte"), + (TupleLessThan, "lt"), + (TupleLessThanOrEqual, "lte"), + (TupleIn, "in"), + (TupleIsNull, "isnull"), + ) + + for lookup_class, lookup_name in test_cases: + with self.subTest(lookup_name): + self.assertEqual(lookup_class.lookup_name, lookup_name) + + def test_tuple_lookup_rhs_must_be_tuple_or_list(self): + test_cases = itertools.product( + ( + TupleExact, + TupleGreaterThan, + TupleGreaterThanOrEqual, + TupleLessThan, + TupleLessThanOrEqual, + TupleIn, + ), + ( + 0, + 1, + None, + True, + False, + {"foo": "bar"}, + ), + ) + + for lookup_cls, rhs in test_cases: + lookup_name = lookup_cls.lookup_name + with self.subTest(lookup_name=lookup_name, rhs=rhs): + with self.assertRaisesMessage( + ValueError, + f"'{lookup_name}' lookup of ('customer_code', 'company_code') " + "must be a tuple or a list", + ): + lookup_cls((F("customer_code"), F("company_code")), rhs) + + def test_tuple_lookup_rhs_must_have_2_elements(self): + test_cases = itertools.product( + ( + TupleExact, + TupleGreaterThan, + TupleGreaterThanOrEqual, + TupleLessThan, + TupleLessThanOrEqual, + ), + ( + [], + [1], + [1, 2, 3], + (), + (1,), + (1, 2, 3), + ), + ) + + for lookup_cls, rhs in test_cases: + lookup_name = lookup_cls.lookup_name + with self.subTest(lookup_name=lookup_name, rhs=rhs): + with self.assertRaisesMessage( + ValueError, + f"'{lookup_name}' lookup of ('customer_code', 'company_code') " + "must have 2 elements", + ): + lookup_cls((F("customer_code"), F("company_code")), rhs) From 53ea4cce2fd08e84b9cdb6363267ccb9525f7060 Mon Sep 17 00:00:00 2001 From: Simon Charette Date: Mon, 14 Oct 2024 19:21:48 -0400 Subject: [PATCH 004/132] Fixed #35744 -- Relabelled external aliases of combined queries. Just like normal queries, combined queries' outer references might fully resolve before their reference is assigned its final alias. Refs #29338. Thanks Antony_K for the report and example, and thanks Mariusz Felisiak for the review. --- django/db/models/sql/query.py | 10 +++++++++ tests/queries/test_qs_combinators.py | 32 +++++++++++++++++++++++++++- 2 files changed, 41 insertions(+), 1 deletion(-) diff --git a/django/db/models/sql/query.py b/django/db/models/sql/query.py index aef3f48f10..b7b93c235a 100644 --- a/django/db/models/sql/query.py +++ b/django/db/models/sql/query.py @@ -1021,11 +1021,21 @@ class Query(BaseExpression): if alias == old_alias: table_aliases[pos] = new_alias break + + # 3. Rename the direct external aliases and the ones of combined + # queries (union, intersection, difference). self.external_aliases = { # Table is aliased or it's being changed and thus is aliased. change_map.get(alias, alias): (aliased or alias in change_map) for alias, aliased in self.external_aliases.items() } + for combined_query in self.combined_queries: + external_change_map = { + alias: aliased + for alias, aliased in change_map.items() + if alias in combined_query.external_aliases + } + combined_query.change_aliases(external_change_map) def bump_prefix(self, other_query, exclude=None): """ diff --git a/tests/queries/test_qs_combinators.py b/tests/queries/test_qs_combinators.py index ad1017c8af..2f6e93cde8 100644 --- a/tests/queries/test_qs_combinators.py +++ b/tests/queries/test_qs_combinators.py @@ -14,7 +14,16 @@ from django.db.models.functions import Mod from django.test import TestCase, skipIfDBFeature, skipUnlessDBFeature from django.test.utils import CaptureQueriesContext -from .models import Author, Celebrity, ExtraInfo, Number, ReservedName +from .models import ( + Annotation, + Author, + Celebrity, + ExtraInfo, + Note, + Number, + ReservedName, + Tag, +) @skipUnlessDBFeature("supports_select_union") @@ -450,6 +459,27 @@ class QuerySetSetOperationTests(TestCase): [8, 1], ) + @skipUnlessDBFeature("supports_select_intersection") + def test_intersection_in_nested_subquery(self): + tag = Tag.objects.create(name="tag") + note = Note.objects.create(tag=tag) + annotation = Annotation.objects.create(tag=tag) + tags = Tag.objects.order_by() + tags = tags.filter(id=OuterRef("tag_id")).intersection( + tags.filter(id=OuterRef(OuterRef("tag_id"))) + ) + qs = Note.objects.filter( + Exists( + Annotation.objects.filter( + Exists(tags), + notes__in=OuterRef("pk"), + ) + ) + ) + self.assertIsNone(qs.first()) + annotation.notes.add(note) + self.assertEqual(qs.first(), note) + def test_union_in_subquery_related_outerref(self): e1 = ExtraInfo.objects.create(value=7, info="e3") e2 = ExtraInfo.objects.create(value=5, info="e2") From 80c3697e96f5a0cbeac043dd5a67f26c076a4279 Mon Sep 17 00:00:00 2001 From: Ben Cail Date: Mon, 14 Oct 2024 09:12:56 -0400 Subject: [PATCH 005/132] Refs #35782 -- Documented the get_help_text methods in password validators. --- docs/topics/auth/passwords.txt | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/docs/topics/auth/passwords.txt b/docs/topics/auth/passwords.txt index 68f5453d54..e8a662e239 100644 --- a/docs/topics/auth/passwords.txt +++ b/docs/topics/auth/passwords.txt @@ -600,6 +600,11 @@ Django includes four validators: Validates that the password is of a minimum length. The minimum length can be customized with the ``min_length`` parameter. + .. method:: get_help_text() + + A hook for customizing the validator's help text. Defaults to ``"Your + password must contain at least characters."`` + .. class:: UserAttributeSimilarityValidator(user_attributes=DEFAULT_USER_ATTRIBUTES, max_similarity=0.7) Validates that the password is sufficiently different from certain @@ -617,6 +622,11 @@ Django includes four validators: ``user_attributes``, whereas a value of 1.0 rejects only passwords that are identical to an attribute's value. + .. method:: get_help_text() + + A hook for customizing the validator's help text. Defaults to ``"Your + password can’t be too similar to your other personal information."`` + .. class:: CommonPasswordValidator(password_list_path=DEFAULT_PASSWORD_LIST_PATH) Validates that the password is not a common password. This converts the @@ -628,10 +638,20 @@ Django includes four validators: common passwords. This file should contain one lowercase password per line and may be plain text or gzipped. + .. method:: get_help_text() + + A hook for customizing the validator's help text. Defaults to ``"Your + password can’t be a commonly used password."`` + .. class:: NumericPasswordValidator() Validate that the password is not entirely numeric. + .. method:: get_help_text() + + A hook for customizing the validator's help text. Defaults to ``"Your + password can’t be entirely numeric."`` + Integrating validation ---------------------- From dc626fbe3ae0225b765df71d08fab02971dc6c6f Mon Sep 17 00:00:00 2001 From: Yash Date: Wed, 4 Sep 2024 20:10:27 +0530 Subject: [PATCH 006/132] Fixed #35682 -- Updated docstrings for base view classes which require a response mixin. --- django/views/generic/dates.py | 44 +++++++++++++++++++++++++++------- django/views/generic/detail.py | 6 ++++- django/views/generic/edit.py | 6 ++--- django/views/generic/list.py | 6 ++++- 4 files changed, 49 insertions(+), 13 deletions(-) diff --git a/django/views/generic/dates.py b/django/views/generic/dates.py index d2b776c122..12ec4104cd 100644 --- a/django/views/generic/dates.py +++ b/django/views/generic/dates.py @@ -300,7 +300,11 @@ class DateMixin: class BaseDateListView(MultipleObjectMixin, DateMixin, View): - """Abstract base class for date-based views displaying a list of objects.""" + """ + Base class for date-based views displaying a list of objects. + + This requires subclassing to provide a response mixin. + """ allow_empty = False date_list_period = "year" @@ -388,7 +392,9 @@ class BaseDateListView(MultipleObjectMixin, DateMixin, View): class BaseArchiveIndexView(BaseDateListView): """ - Base class for archives of date-based items. Requires a response mixin. + Base view for archives of date-based items. + + This requires subclassing to provide a response mixin. """ context_object_name = "latest" @@ -411,7 +417,11 @@ class ArchiveIndexView(MultipleObjectTemplateResponseMixin, BaseArchiveIndexView class BaseYearArchiveView(YearMixin, BaseDateListView): - """List of objects published in a given year.""" + """ + Base view for a list of objects published in a given year. + + This requires subclassing to provide a response mixin. + """ date_list_period = "month" make_object_list = False @@ -463,7 +473,11 @@ class YearArchiveView(MultipleObjectTemplateResponseMixin, BaseYearArchiveView): class BaseMonthArchiveView(YearMixin, MonthMixin, BaseDateListView): - """List of objects published in a given month.""" + """ + Base view for a list of objects published in a given month. + + This requires subclassing to provide a response mixin. + """ date_list_period = "day" @@ -505,7 +519,11 @@ class MonthArchiveView(MultipleObjectTemplateResponseMixin, BaseMonthArchiveView class BaseWeekArchiveView(YearMixin, WeekMixin, BaseDateListView): - """List of objects published in a given week.""" + """ + Base view for a list of objects published in a given week. + + This requires subclassing to provide a response mixin. + """ def get_dated_items(self): """Return (date_list, items, extra_context) for this request.""" @@ -563,7 +581,11 @@ class WeekArchiveView(MultipleObjectTemplateResponseMixin, BaseWeekArchiveView): class BaseDayArchiveView(YearMixin, MonthMixin, DayMixin, BaseDateListView): - """List of objects published on a given day.""" + """ + Base view for a list of objects published on a given day. + + This requires subclassing to provide a response mixin. + """ def get_dated_items(self): """Return (date_list, items, extra_context) for this request.""" @@ -610,7 +632,11 @@ class DayArchiveView(MultipleObjectTemplateResponseMixin, BaseDayArchiveView): class BaseTodayArchiveView(BaseDayArchiveView): - """List of objects published today.""" + """ + Base view for a list of objects published today. + + This requires subclassing to provide a response mixin. + """ def get_dated_items(self): """Return (date_list, items, extra_context) for this request.""" @@ -625,8 +651,10 @@ class TodayArchiveView(MultipleObjectTemplateResponseMixin, BaseTodayArchiveView class BaseDateDetailView(YearMixin, MonthMixin, DayMixin, DateMixin, BaseDetailView): """ - Detail view of a single object on a single date; this differs from the + Base detail view for a single object on a single date; this differs from the standard DetailView by accepting a year/month/day in the URL. + + This requires subclassing to provide a response mixin. """ def get_object(self, queryset=None): diff --git a/django/views/generic/detail.py b/django/views/generic/detail.py index e4428c8036..a5f604bf1a 100644 --- a/django/views/generic/detail.py +++ b/django/views/generic/detail.py @@ -102,7 +102,11 @@ class SingleObjectMixin(ContextMixin): class BaseDetailView(SingleObjectMixin, View): - """A base view for displaying a single object.""" + """ + Base view for displaying a single object. + + This requires subclassing to provide a response mixin. + """ def get(self, request, *args, **kwargs): self.object = self.get_object() diff --git a/django/views/generic/edit.py b/django/views/generic/edit.py index 97934f58cb..ebd071cf00 100644 --- a/django/views/generic/edit.py +++ b/django/views/generic/edit.py @@ -170,7 +170,7 @@ class BaseCreateView(ModelFormMixin, ProcessFormView): """ Base view for creating a new object instance. - Using this base class requires subclassing to provide a response mixin. + This requires subclassing to provide a response mixin. """ def get(self, request, *args, **kwargs): @@ -194,7 +194,7 @@ class BaseUpdateView(ModelFormMixin, ProcessFormView): """ Base view for updating an existing object. - Using this base class requires subclassing to provide a response mixin. + This requires subclassing to provide a response mixin. """ def get(self, request, *args, **kwargs): @@ -242,7 +242,7 @@ class BaseDeleteView(DeletionMixin, FormMixin, BaseDetailView): """ Base view for deleting an object. - Using this base class requires subclassing to provide a response mixin. + This requires subclassing to provide a response mixin. """ form_class = Form diff --git a/django/views/generic/list.py b/django/views/generic/list.py index 830a8df630..8ed92920c4 100644 --- a/django/views/generic/list.py +++ b/django/views/generic/list.py @@ -148,7 +148,11 @@ class MultipleObjectMixin(ContextMixin): class BaseListView(MultipleObjectMixin, View): - """A base view for displaying a list of objects.""" + """ + Base view for displaying a list of objects. + + This requires subclassing to provide a response mixin. + """ def get(self, request, *args, **kwargs): self.object_list = self.get_queryset() From 06bf06a911695c5c84f746742f764c040e237ece Mon Sep 17 00:00:00 2001 From: leondaz Date: Mon, 9 Sep 2024 19:15:40 +0300 Subject: [PATCH 007/132] Fixed #35656 -- Added an autodetector attribute to the makemigrations and migrate commands. --- django/core/checks/__init__.py | 1 + django/core/checks/commands.py | 28 +++++++++ django/core/checks/registry.py | 1 + .../management/commands/makemigrations.py | 5 +- django/core/management/commands/migrate.py | 3 +- docs/ref/checks.txt | 9 +++ docs/releases/5.2.txt | 4 ++ .../management/commands/makemigrations.py | 7 +++ tests/check_framework/test_commands.py | 25 ++++++++ tests/migrations/test_commands.py | 63 ++++++++++++++++++- 10 files changed, 142 insertions(+), 4 deletions(-) create mode 100644 django/core/checks/commands.py create mode 100644 tests/check_framework/custom_commands_app/management/commands/makemigrations.py create mode 100644 tests/check_framework/test_commands.py diff --git a/django/core/checks/__init__.py b/django/core/checks/__init__.py index 998ab9dee2..2502450cdf 100644 --- a/django/core/checks/__init__.py +++ b/django/core/checks/__init__.py @@ -16,6 +16,7 @@ from .registry import Tags, register, run_checks, tag_exists # Import these to force registration of checks import django.core.checks.async_checks # NOQA isort:skip import django.core.checks.caches # NOQA isort:skip +import django.core.checks.commands # NOQA isort:skip import django.core.checks.compatibility.django_4_0 # NOQA isort:skip import django.core.checks.database # NOQA isort:skip import django.core.checks.files # NOQA isort:skip diff --git a/django/core/checks/commands.py b/django/core/checks/commands.py new file mode 100644 index 0000000000..eee1e937e8 --- /dev/null +++ b/django/core/checks/commands.py @@ -0,0 +1,28 @@ +from django.core.checks import Error, Tags, register + + +@register(Tags.commands) +def migrate_and_makemigrations_autodetector(**kwargs): + from django.core.management import get_commands, load_command_class + + commands = get_commands() + + make_migrations = load_command_class(commands["makemigrations"], "makemigrations") + migrate = load_command_class(commands["migrate"], "migrate") + + if make_migrations.autodetector is not migrate.autodetector: + return [ + Error( + "The migrate and makemigrations commands must have the same " + "autodetector.", + hint=( + f"makemigrations.Command.autodetector is " + f"{make_migrations.autodetector.__name__}, but " + f"migrate.Command.autodetector is " + f"{migrate.autodetector.__name__}." + ), + id="commands.E001", + ) + ] + + return [] diff --git a/django/core/checks/registry.py b/django/core/checks/registry.py index 146b28f65e..3139fc3ef4 100644 --- a/django/core/checks/registry.py +++ b/django/core/checks/registry.py @@ -12,6 +12,7 @@ class Tags: admin = "admin" async_support = "async_support" caches = "caches" + commands = "commands" compatibility = "compatibility" database = "database" files = "files" diff --git a/django/core/management/commands/makemigrations.py b/django/core/management/commands/makemigrations.py index a4e4d520e6..d5d3466201 100644 --- a/django/core/management/commands/makemigrations.py +++ b/django/core/management/commands/makemigrations.py @@ -24,6 +24,7 @@ from django.db.migrations.writer import MigrationWriter class Command(BaseCommand): + autodetector = MigrationAutodetector help = "Creates new migration(s) for apps." def add_arguments(self, parser): @@ -209,7 +210,7 @@ class Command(BaseCommand): log=self.log, ) # Set up autodetector - autodetector = MigrationAutodetector( + autodetector = self.autodetector( loader.project_state(), ProjectState.from_apps(apps), questioner, @@ -461,7 +462,7 @@ class Command(BaseCommand): # If they still want to merge it, then write out an empty # file depending on the migrations needing merging. numbers = [ - MigrationAutodetector.parse_number(migration.name) + self.autodetector.parse_number(migration.name) for migration in merge_migrations ] try: diff --git a/django/core/management/commands/migrate.py b/django/core/management/commands/migrate.py index 5e6b19c095..fa420ee6e3 100644 --- a/django/core/management/commands/migrate.py +++ b/django/core/management/commands/migrate.py @@ -15,6 +15,7 @@ from django.utils.text import Truncator class Command(BaseCommand): + autodetector = MigrationAutodetector help = ( "Updates database schema. Manages both apps with migrations and those without." ) @@ -329,7 +330,7 @@ class Command(BaseCommand): self.stdout.write(" No migrations to apply.") # If there's changes that aren't in migrations yet, tell them # how to fix it. - autodetector = MigrationAutodetector( + autodetector = self.autodetector( executor.loader.project_state(), ProjectState.from_apps(apps), ) diff --git a/docs/ref/checks.txt b/docs/ref/checks.txt index d78a6f76b2..2308a854c7 100644 --- a/docs/ref/checks.txt +++ b/docs/ref/checks.txt @@ -77,6 +77,7 @@ Django's system checks are organized using the following tags: * ``async_support``: Checks asynchronous-related configuration. * ``caches``: Checks cache related configuration. * ``compatibility``: Flags potential problems with version upgrades. +* ``commands``: Checks custom management commands related configuration. * ``database``: Checks database-related configuration issues. Database checks are not run by default because they do more than static code analysis as regular checks do. They are only run by the :djadmin:`migrate` command or if @@ -428,6 +429,14 @@ Models * **models.W047**: ```` does not support unique constraints with nulls distinct. +Management Commands +------------------- + +The following checks verify custom management commands are correctly configured: + +* **commands.E001**: The ``migrate`` and ``makemigrations`` commands must have + the same ``autodetector``. + Security -------- diff --git a/docs/releases/5.2.txt b/docs/releases/5.2.txt index eabc27c277..78c96688cf 100644 --- a/docs/releases/5.2.txt +++ b/docs/releases/5.2.txt @@ -230,6 +230,10 @@ Management Commands setting the :envvar:`HIDE_PRODUCTION_WARNING` environment variable to ``"true"``. +* The :djadmin:`makemigrations` and :djadmin:`migrate` commands have a new + ``Command.autodetector`` attribute for subclasses to override in order to use + a custom autodetector class. + Migrations ~~~~~~~~~~ diff --git a/tests/check_framework/custom_commands_app/management/commands/makemigrations.py b/tests/check_framework/custom_commands_app/management/commands/makemigrations.py new file mode 100644 index 0000000000..a6494cba4c --- /dev/null +++ b/tests/check_framework/custom_commands_app/management/commands/makemigrations.py @@ -0,0 +1,7 @@ +from django.core.management.commands.makemigrations import ( + Command as MakeMigrationsCommand, +) + + +class Command(MakeMigrationsCommand): + autodetector = int diff --git a/tests/check_framework/test_commands.py b/tests/check_framework/test_commands.py new file mode 100644 index 0000000000..a51db77402 --- /dev/null +++ b/tests/check_framework/test_commands.py @@ -0,0 +1,25 @@ +from django.core import checks +from django.core.checks import Error +from django.test import SimpleTestCase +from django.test.utils import isolate_apps, override_settings, override_system_checks + + +@isolate_apps("check_framework.custom_commands_app", attr_name="apps") +@override_settings(INSTALLED_APPS=["check_framework.custom_commands_app"]) +@override_system_checks([checks.commands.migrate_and_makemigrations_autodetector]) +class CommandCheckTests(SimpleTestCase): + def test_migrate_and_makemigrations_autodetector_different(self): + expected_error = Error( + "The migrate and makemigrations commands must have the same " + "autodetector.", + hint=( + "makemigrations.Command.autodetector is int, but " + "migrate.Command.autodetector is MigrationAutodetector." + ), + id="commands.E001", + ) + + self.assertEqual( + checks.run_checks(app_configs=self.apps.get_app_configs()), + [expected_error], + ) diff --git a/tests/migrations/test_commands.py b/tests/migrations/test_commands.py index cab2906ed1..724c88a28f 100644 --- a/tests/migrations/test_commands.py +++ b/tests/migrations/test_commands.py @@ -9,6 +9,10 @@ from unittest import mock from django.apps import apps from django.core.management import CommandError, call_command +from django.core.management.commands.makemigrations import ( + Command as MakeMigrationsCommand, +) +from django.core.management.commands.migrate import Command as MigrateCommand from django.db import ( ConnectionHandler, DatabaseError, @@ -19,10 +23,11 @@ from django.db import ( ) from django.db.backends.base.schema import BaseDatabaseSchemaEditor from django.db.backends.utils import truncate_name +from django.db.migrations.autodetector import MigrationAutodetector from django.db.migrations.exceptions import InconsistentMigrationHistory from django.db.migrations.recorder import MigrationRecorder from django.test import TestCase, override_settings, skipUnlessDBFeature -from django.test.utils import captured_stdout, extend_sys_path +from django.test.utils import captured_stdout, extend_sys_path, isolate_apps from django.utils import timezone from django.utils.version import get_docs_version @@ -3296,3 +3301,59 @@ class OptimizeMigrationTests(MigrationTestBase): msg = "Cannot find a migration matching 'nonexistent' from app 'migrations'." with self.assertRaisesMessage(CommandError, msg): call_command("optimizemigration", "migrations", "nonexistent") + + +class CustomMigrationCommandTests(MigrationTestBase): + @override_settings( + MIGRATION_MODULES={"migrations": "migrations.test_migrations"}, + INSTALLED_APPS=["migrations.migrations_test_apps.migrated_app"], + ) + @isolate_apps("migrations.migrations_test_apps.migrated_app") + def test_makemigrations_custom_autodetector(self): + class CustomAutodetector(MigrationAutodetector): + def changes(self, *args, **kwargs): + return [] + + class CustomMakeMigrationsCommand(MakeMigrationsCommand): + autodetector = CustomAutodetector + + class NewModel(models.Model): + class Meta: + app_label = "migrated_app" + + out = io.StringIO() + command = CustomMakeMigrationsCommand(stdout=out) + call_command(command, "migrated_app", stdout=out) + self.assertIn("No changes detected", out.getvalue()) + + @override_settings(INSTALLED_APPS=["migrations.migrations_test_apps.migrated_app"]) + @isolate_apps("migrations.migrations_test_apps.migrated_app") + def test_migrate_custom_autodetector(self): + class CustomAutodetector(MigrationAutodetector): + def changes(self, *args, **kwargs): + return [] + + class CustomMigrateCommand(MigrateCommand): + autodetector = CustomAutodetector + + class NewModel(models.Model): + class Meta: + app_label = "migrated_app" + + out = io.StringIO() + command = CustomMigrateCommand(stdout=out) + + out = io.StringIO() + try: + call_command(command, verbosity=0) + call_command(command, stdout=out, no_color=True) + command_stdout = out.getvalue().lower() + self.assertEqual( + "operations to perform:\n" + " apply all migrations: migrated_app\n" + "running migrations:\n" + " no migrations to apply.\n", + command_stdout, + ) + finally: + call_command(command, "migrated_app", "zero", verbosity=0) From ec7d69035a408b357f1803ca05a7c991cc358cfa Mon Sep 17 00:00:00 2001 From: Ben Cail Date: Thu, 26 Sep 2024 10:11:41 -0400 Subject: [PATCH 008/132] Fixed #35782 -- Allowed overriding password validation error messages. --- django/contrib/auth/password_validation.py | 36 ++++++----- docs/releases/5.2.txt | 4 ++ docs/topics/auth/passwords.txt | 39 ++++++++++-- tests/auth_tests/test_validators.py | 70 ++++++++++++++++++++++ 4 files changed, 131 insertions(+), 18 deletions(-) diff --git a/django/contrib/auth/password_validation.py b/django/contrib/auth/password_validation.py index 06f8fcc4e8..d24e69e0ce 100644 --- a/django/contrib/auth/password_validation.py +++ b/django/contrib/auth/password_validation.py @@ -106,17 +106,16 @@ class MinimumLengthValidator: def validate(self, password, user=None): if len(password) < self.min_length: - raise ValidationError( - ngettext( - "This password is too short. It must contain at least " - "%(min_length)d character.", - "This password is too short. It must contain at least " - "%(min_length)d characters.", - self.min_length, - ), - code="password_too_short", - params={"min_length": self.min_length}, - ) + raise ValidationError(self.get_error_message(), code="password_too_short") + + def get_error_message(self): + return ngettext( + "This password is too short. It must contain at least %d character." + % self.min_length, + "This password is too short. It must contain at least %d characters." + % self.min_length, + self.min_length, + ) def get_help_text(self): return ngettext( @@ -203,11 +202,14 @@ class UserAttributeSimilarityValidator: except FieldDoesNotExist: verbose_name = attribute_name raise ValidationError( - _("The password is too similar to the %(verbose_name)s."), + self.get_error_message(), code="password_too_similar", params={"verbose_name": verbose_name}, ) + def get_error_message(self): + return _("The password is too similar to the %(verbose_name)s.") + def get_help_text(self): return _( "Your password can’t be too similar to your other personal information." @@ -242,10 +244,13 @@ class CommonPasswordValidator: def validate(self, password, user=None): if password.lower().strip() in self.passwords: raise ValidationError( - _("This password is too common."), + self.get_error_message(), code="password_too_common", ) + def get_error_message(self): + return _("This password is too common.") + def get_help_text(self): return _("Your password can’t be a commonly used password.") @@ -258,9 +263,12 @@ class NumericPasswordValidator: def validate(self, password, user=None): if password.isdigit(): raise ValidationError( - _("This password is entirely numeric."), + self.get_error_message(), code="password_entirely_numeric", ) + def get_error_message(self): + return _("This password is entirely numeric.") + def get_help_text(self): return _("Your password can’t be entirely numeric.") diff --git a/docs/releases/5.2.txt b/docs/releases/5.2.txt index 78c96688cf..806abfa26d 100644 --- a/docs/releases/5.2.txt +++ b/docs/releases/5.2.txt @@ -82,6 +82,10 @@ Minor features improves performance. See :ref:`adding an async interface ` for more details. +* The :ref:`password validator classes ` + now have a new method ``get_error_message()``, which can be overridden in + subclasses to customize the error messages. + :mod:`django.contrib.contenttypes` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/docs/topics/auth/passwords.txt b/docs/topics/auth/passwords.txt index e8a662e239..8efd2bdebf 100644 --- a/docs/topics/auth/passwords.txt +++ b/docs/topics/auth/passwords.txt @@ -590,6 +590,8 @@ 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-password-validators: + Included validators ------------------- @@ -600,10 +602,18 @@ Django includes four validators: Validates that the password is of a minimum length. The minimum length can be customized with the ``min_length`` parameter. + .. method:: get_error_message() + + .. versionadded:: 5.2 + + A hook for customizing the ``ValidationError`` error message. Defaults + to ``"This password is too short. It must contain at least + characters."``. + .. method:: get_help_text() A hook for customizing the validator's help text. Defaults to ``"Your - password must contain at least characters."`` + password must contain at least characters."``. .. class:: UserAttributeSimilarityValidator(user_attributes=DEFAULT_USER_ATTRIBUTES, max_similarity=0.7) @@ -622,10 +632,17 @@ Django includes four validators: ``user_attributes``, whereas a value of 1.0 rejects only passwords that are identical to an attribute's value. + .. method:: get_error_message() + + .. versionadded:: 5.2 + + A hook for customizing the ``ValidationError`` error message. Defaults + to ``"The password is too similar to the ."``. + .. method:: get_help_text() A hook for customizing the validator's help text. Defaults to ``"Your - password can’t be too similar to your other personal information."`` + password can’t be too similar to your other personal information."``. .. class:: CommonPasswordValidator(password_list_path=DEFAULT_PASSWORD_LIST_PATH) @@ -638,19 +655,33 @@ Django includes four validators: common passwords. This file should contain one lowercase password per line and may be plain text or gzipped. + .. method:: get_error_message() + + .. versionadded:: 5.2 + + A hook for customizing the ``ValidationError`` error message. Defaults + to ``"This password is too common."``. + .. method:: get_help_text() A hook for customizing the validator's help text. Defaults to ``"Your - password can’t be a commonly used password."`` + password can’t be a commonly used password."``. .. class:: NumericPasswordValidator() Validate that the password is not entirely numeric. + .. method:: get_error_message() + + .. versionadded:: 5.2 + + A hook for customizing the ``ValidationError`` error message. Defaults + to ``"This password is entirely numeric."``. + .. method:: get_help_text() A hook for customizing the validator's help text. Defaults to ``"Your - password can’t be entirely numeric."`` + password can’t be entirely numeric."``. Integrating validation ---------------------- diff --git a/tests/auth_tests/test_validators.py b/tests/auth_tests/test_validators.py index 506c85c0ae..d7e4968951 100644 --- a/tests/auth_tests/test_validators.py +++ b/tests/auth_tests/test_validators.py @@ -144,6 +144,20 @@ class MinimumLengthValidatorTest(SimpleTestCase): "Your password must contain at least 8 characters.", ) + def test_custom_error(self): + class CustomMinimumLengthValidator(MinimumLengthValidator): + def get_error_message(self): + return "Your password must be %d characters long" % self.min_length + + expected_error = "Your password must be %d characters long" + + with self.assertRaisesMessage(ValidationError, expected_error % 8) as cm: + CustomMinimumLengthValidator().validate("1234567") + self.assertEqual(cm.exception.error_list[0].code, "password_too_short") + + with self.assertRaisesMessage(ValidationError, expected_error % 3) as cm: + CustomMinimumLengthValidator(min_length=3).validate("12") + class UserAttributeSimilarityValidatorTest(TestCase): def test_validate(self): @@ -213,6 +227,42 @@ class UserAttributeSimilarityValidatorTest(TestCase): "Your password can’t be too similar to your other personal information.", ) + def test_custom_error(self): + class CustomUserAttributeSimilarityValidator(UserAttributeSimilarityValidator): + def get_error_message(self): + return "The password is too close to the %(verbose_name)s." + + user = User.objects.create_user( + username="testclient", + password="password", + email="testclient@example.com", + first_name="Test", + last_name="Client", + ) + + expected_error = "The password is too close to the %s." + + with self.assertRaisesMessage(ValidationError, expected_error % "username"): + CustomUserAttributeSimilarityValidator().validate("testclient", user=user) + + def test_custom_error_verbose_name_not_used(self): + class CustomUserAttributeSimilarityValidator(UserAttributeSimilarityValidator): + def get_error_message(self): + return "The password is too close to a user attribute." + + user = User.objects.create_user( + username="testclient", + password="password", + email="testclient@example.com", + first_name="Test", + last_name="Client", + ) + + expected_error = "The password is too close to a user attribute." + + with self.assertRaisesMessage(ValidationError, expected_error): + CustomUserAttributeSimilarityValidator().validate("testclient", user=user) + class CommonPasswordValidatorTest(SimpleTestCase): def test_validate(self): @@ -247,6 +297,16 @@ class CommonPasswordValidatorTest(SimpleTestCase): "Your password can’t be a commonly used password.", ) + def test_custom_error(self): + class CustomCommonPasswordValidator(CommonPasswordValidator): + def get_error_message(self): + return "This password has been used too much." + + expected_error = "This password has been used too much." + + with self.assertRaisesMessage(ValidationError, expected_error): + CustomCommonPasswordValidator().validate("godzilla") + class NumericPasswordValidatorTest(SimpleTestCase): def test_validate(self): @@ -264,6 +324,16 @@ class NumericPasswordValidatorTest(SimpleTestCase): "Your password can’t be entirely numeric.", ) + def test_custom_error(self): + class CustomNumericPasswordValidator(NumericPasswordValidator): + def get_error_message(self): + return "This password is all digits." + + expected_error = "This password is all digits." + + with self.assertRaisesMessage(ValidationError, expected_error): + CustomNumericPasswordValidator().validate("42424242") + class UsernameValidatorsTests(SimpleTestCase): def test_unicode_validator(self): From 4a685bc0dca5298a7d5a4e162120a90cac7fd1a4 Mon Sep 17 00:00:00 2001 From: SaJH Date: Wed, 11 Sep 2024 21:23:23 +0900 Subject: [PATCH 009/132] Fixed #35727 -- Added HttpResponse.text property. Signed-off-by: SaJH --- django/http/response.py | 12 ++++++++++++ docs/ref/request-response.txt | 10 ++++++++++ docs/releases/5.2.txt | 3 +++ tests/httpwrappers/tests.py | 23 +++++++++++++++++++++++ 4 files changed, 48 insertions(+) diff --git a/django/http/response.py b/django/http/response.py index abe71718f2..1dbaf46add 100644 --- a/django/http/response.py +++ b/django/http/response.py @@ -21,6 +21,7 @@ from django.http.cookie import SimpleCookie from django.utils import timezone from django.utils.datastructures import CaseInsensitiveMapping from django.utils.encoding import iri_to_uri +from django.utils.functional import cached_property from django.utils.http import content_disposition_header, http_date from django.utils.regex_helper import _lazy_re_compile @@ -408,6 +409,11 @@ class HttpResponse(HttpResponseBase): content = self.make_bytes(value) # Create a list of properly encoded bytestrings to support write(). self._container = [content] + self.__dict__.pop("text", None) + + @cached_property + def text(self): + return self.content.decode(self.charset or "utf-8") def __iter__(self): return iter(self._container) @@ -460,6 +466,12 @@ class StreamingHttpResponse(HttpResponseBase): "`streaming_content` instead." % self.__class__.__name__ ) + @property + def text(self): + raise AttributeError( + "This %s instance has no `text` attribute." % self.__class__.__name__ + ) + @property def streaming_content(self): if self.is_async: diff --git a/docs/ref/request-response.txt b/docs/ref/request-response.txt index 31111a435a..afebd00d8b 100644 --- a/docs/ref/request-response.txt +++ b/docs/ref/request-response.txt @@ -833,6 +833,13 @@ Attributes A bytestring representing the content, encoded from a string if necessary. +.. attribute:: HttpResponse.text + + .. versionadded:: 5.2 + + A string representation of :attr:`HttpResponse.content`, decoded using the + response's :attr:`HttpResponse.charset` (defaulting to ``UTF-8`` if empty). + .. attribute:: HttpResponse.cookies A :py:obj:`http.cookies.SimpleCookie` object holding the cookies included @@ -1272,6 +1279,9 @@ with the following notable differences: :attr:`~StreamingHttpResponse.streaming_content` attribute. This can be used in middleware to wrap the response iterable, but should not be consumed. +* It has no ``text`` attribute, as it would require iterating the response + object. + * You cannot use the file-like object ``tell()`` or ``write()`` methods. Doing so will raise an exception. diff --git a/docs/releases/5.2.txt b/docs/releases/5.2.txt index 806abfa26d..9090f8b70a 100644 --- a/docs/releases/5.2.txt +++ b/docs/releases/5.2.txt @@ -268,6 +268,9 @@ Models Requests and Responses ~~~~~~~~~~~~~~~~~~~~~~ +* The new :attr:`.HttpResponse.text` property provides the string representation + of :attr:`.HttpResponse.content`. + * The new :meth:`.HttpRequest.get_preferred_type` method can be used to query the preferred media type the client accepts. diff --git a/tests/httpwrappers/tests.py b/tests/httpwrappers/tests.py index 2197c6f7ea..154e9517fe 100644 --- a/tests/httpwrappers/tests.py +++ b/tests/httpwrappers/tests.py @@ -530,6 +530,22 @@ class HttpResponseTests(SimpleTestCase): headers={"Content-Type": "text/csv"}, ) + def test_text_updates_when_content_updates(self): + response = HttpResponse("Hello, world!") + self.assertEqual(response.text, "Hello, world!") + response.content = "Updated content" + self.assertEqual(response.text, "Updated content") + + def test_text_charset(self): + for content_type, content in [ + (None, b"Ol\xc3\xa1 Mundo"), + ("text/plain; charset=utf-8", b"Ol\xc3\xa1 Mundo"), + ("text/plain; charset=iso-8859-1", b"Ol\xe1 Mundo"), + ]: + with self.subTest(content_type=content_type): + response = HttpResponse(content, content_type=content_type) + self.assertEqual(response.text, "Olá Mundo") + class HttpResponseSubclassesTests(SimpleTestCase): def test_redirect(self): @@ -756,6 +772,13 @@ class StreamingHttpResponseTests(SimpleTestCase): with self.assertWarnsMessage(Warning, msg): self.assertEqual(b"hello", await anext(aiter(r))) + def test_text_attribute_error(self): + r = StreamingHttpResponse(iter(["hello", "world"])) + msg = "This %s instance has no `text` attribute." % r.__class__.__name__ + + with self.assertRaisesMessage(AttributeError, msg): + r.text + class FileCloseTests(SimpleTestCase): def setUp(self): From 0c8177551500e960d2dc04bc4b0fa7060f9172ae Mon Sep 17 00:00:00 2001 From: SaJH Date: Wed, 16 Oct 2024 01:11:46 +0900 Subject: [PATCH 010/132] Refs #35727 -- Updated response.content.decode calls to use the HttpResponse.text property. Signed-off-by: SaJH --- django/test/client.py | 4 +- tests/admin_views/test_autocomplete_view.py | 20 +++++----- tests/admin_views/tests.py | 18 ++++----- tests/auth_tests/test_views.py | 4 +- tests/csrf_tests/tests.py | 6 ++- tests/httpwrappers/tests.py | 12 +++--- tests/serializers/tests.py | 2 +- tests/sitemaps_tests/test_generic.py | 6 +-- tests/sitemaps_tests/test_http.py | 42 ++++++++++----------- tests/sitemaps_tests/test_https.py | 8 ++-- tests/view_tests/tests/test_i18n.py | 4 +- tests/view_tests/tests/test_json.py | 2 +- 12 files changed, 63 insertions(+), 65 deletions(-) diff --git a/django/test/client.py b/django/test/client.py index a755aae05c..85d91b0c44 100644 --- a/django/test/client.py +++ b/django/test/client.py @@ -947,9 +947,7 @@ class ClientMixin: 'Content-Type header is "%s", not "application/json"' % response.get("Content-Type") ) - response._json = json.loads( - response.content.decode(response.charset), **extra - ) + response._json = json.loads(response.text, **extra) return response._json def _follow_redirect( diff --git a/tests/admin_views/test_autocomplete_view.py b/tests/admin_views/test_autocomplete_view.py index dc3789fc5b..d9595cdb28 100644 --- a/tests/admin_views/test_autocomplete_view.py +++ b/tests/admin_views/test_autocomplete_view.py @@ -102,7 +102,7 @@ class AutocompleteJsonViewTests(AdminViewBasicTestCase): request.user = self.superuser response = AutocompleteJsonView.as_view(**self.as_view_args)(request) self.assertEqual(response.status_code, 200) - data = json.loads(response.content.decode("utf-8")) + data = json.loads(response.text) self.assertEqual( data, { @@ -120,7 +120,7 @@ class AutocompleteJsonViewTests(AdminViewBasicTestCase): request.user = self.superuser response = AutocompleteJsonView.as_view(**self.as_view_args)(request) self.assertEqual(response.status_code, 200) - data = json.loads(response.content.decode("utf-8")) + data = json.loads(response.text) self.assertEqual( data, { @@ -150,7 +150,7 @@ class AutocompleteJsonViewTests(AdminViewBasicTestCase): request.user = self.superuser response = AutocompleteJsonView.as_view(**self.as_view_args)(request) self.assertEqual(response.status_code, 200) - data = json.loads(response.content.decode("utf-8")) + data = json.loads(response.text) self.assertEqual( data, { @@ -184,7 +184,7 @@ class AutocompleteJsonViewTests(AdminViewBasicTestCase): request.user = self.superuser response = AutocompleteJsonView.as_view(**self.as_view_args)(request) self.assertEqual(response.status_code, 200) - data = json.loads(response.content.decode("utf-8")) + data = json.loads(response.text) self.assertEqual( data, { @@ -205,7 +205,7 @@ class AutocompleteJsonViewTests(AdminViewBasicTestCase): request.user = self.superuser response = AutocompleteJsonView.as_view(**self.as_view_args)(request) self.assertEqual(response.status_code, 200) - data = json.loads(response.content.decode("utf-8")) + data = json.loads(response.text) self.assertEqual( data, { @@ -250,7 +250,7 @@ class AutocompleteJsonViewTests(AdminViewBasicTestCase): request.user = self.superuser response = AutocompleteJsonView.as_view(**self.as_view_args)(request) self.assertEqual(response.status_code, 200) - data = json.loads(response.content.decode("utf-8")) + data = json.loads(response.text) self.assertEqual( data, { @@ -306,7 +306,7 @@ class AutocompleteJsonViewTests(AdminViewBasicTestCase): with model_admin(Question, DistinctQuestionAdmin): response = AutocompleteJsonView.as_view(**self.as_view_args)(request) self.assertEqual(response.status_code, 200) - data = json.loads(response.content.decode("utf-8")) + data = json.loads(response.text) self.assertEqual(len(data["results"]), 3) def test_missing_search_fields(self): @@ -335,7 +335,7 @@ class AutocompleteJsonViewTests(AdminViewBasicTestCase): with model_admin(Question, PKOrderingQuestionAdmin): response = AutocompleteJsonView.as_view(**self.as_view_args)(request) self.assertEqual(response.status_code, 200) - data = json.loads(response.content.decode("utf-8")) + data = json.loads(response.text) self.assertEqual( data, { @@ -352,7 +352,7 @@ class AutocompleteJsonViewTests(AdminViewBasicTestCase): with model_admin(Question, PKOrderingQuestionAdmin): response = AutocompleteJsonView.as_view(**self.as_view_args)(request) self.assertEqual(response.status_code, 200) - data = json.loads(response.content.decode("utf-8")) + data = json.loads(response.text) self.assertEqual( data, { @@ -380,7 +380,7 @@ class AutocompleteJsonViewTests(AdminViewBasicTestCase): request ) self.assertEqual(response.status_code, 200) - data = json.loads(response.content.decode("utf-8")) + data = json.loads(response.text) self.assertEqual( data, { diff --git a/tests/admin_views/tests.py b/tests/admin_views/tests.py index f63a9ca56f..17174ff5e0 100644 --- a/tests/admin_views/tests.py +++ b/tests/admin_views/tests.py @@ -296,9 +296,7 @@ class AdminViewBasicTestCase(TestCase): self.assertLess( response.content.index(text1.encode()), response.content.index(text2.encode()), - (failing_msg or "") - + "\nResponse:\n" - + response.content.decode(response.charset), + (failing_msg or "") + "\nResponse:\n" + response.text, ) @@ -3603,7 +3601,7 @@ class AdminViewDeletedObjectsTest(TestCase): response = self.client.get( reverse("admin:admin_views_villain_delete", args=(self.v1.pk,)) ) - self.assertRegex(response.content.decode(), pattern) + self.assertRegex(response.text, pattern) def test_cyclic(self): """ @@ -8266,7 +8264,7 @@ class AdminKeepChangeListFiltersTests(TestCase): # Check the `change_view` link has the correct querystring. detail_link = re.search( '{}'.format(self.joepublicuser.username), - response.content.decode(), + response.text, ) self.assertURLEqual(detail_link[1], self.get_change_url()) @@ -8278,7 +8276,7 @@ class AdminKeepChangeListFiltersTests(TestCase): # Check the form action. form_action = re.search( '
', - response.content.decode(), + response.text, ) self.assertURLEqual( form_action[1], "?%s" % self.get_preserved_filters_querystring() @@ -8286,13 +8284,13 @@ class AdminKeepChangeListFiltersTests(TestCase): # Check the history link. history_link = re.search( - 'History', response.content.decode() + 'History', response.text ) self.assertURLEqual(history_link[1], self.get_history_url()) # Check the delete link. delete_link = re.search( - 'Delete', response.content.decode() + 'Delete', response.text ) self.assertURLEqual(delete_link[1], self.get_delete_url()) @@ -8332,7 +8330,7 @@ class AdminKeepChangeListFiltersTests(TestCase): self.client.force_login(viewuser) response = self.client.get(self.get_change_url()) close_link = re.search( - 'Close', response.content.decode() + 'Close', response.text ) close_link = close_link[1].replace("&", "&") self.assertURLEqual(close_link, self.get_changelist_url()) @@ -8350,7 +8348,7 @@ class AdminKeepChangeListFiltersTests(TestCase): # Check the form action. form_action = re.search( '', - response.content.decode(), + response.text, ) self.assertURLEqual( form_action[1], "?%s" % self.get_preserved_filters_querystring() diff --git a/tests/auth_tests/test_views.py b/tests/auth_tests/test_views.py index 97d0448ab1..98fdfe79b7 100644 --- a/tests/auth_tests/test_views.py +++ b/tests/auth_tests/test_views.py @@ -1521,7 +1521,7 @@ class ChangelistTests(MessagesTestMixin, AuthViewsTestCase): # Test the link inside password field help_text. rel_link = re.search( r'Reset password', - response.content.decode(), + response.text, )[1] self.assertEqual(urljoin(user_change_url, rel_link), password_change_url) @@ -1617,7 +1617,7 @@ class ChangelistTests(MessagesTestMixin, AuthViewsTestCase): # Test the link inside password field help_text. rel_link = re.search( r'Set password', - response.content.decode(), + response.text, )[1] self.assertEqual(urljoin(user_change_url, rel_link), password_change_url) diff --git a/tests/csrf_tests/tests.py b/tests/csrf_tests/tests.py index b736276534..956cff11d9 100644 --- a/tests/csrf_tests/tests.py +++ b/tests/csrf_tests/tests.py @@ -1481,9 +1481,11 @@ class CsrfInErrorHandlingViewsTests(CsrfFunctionTestMixin, SimpleTestCase): response = self.client.get("/does not exist/") # The error handler returns status code 599. self.assertEqual(response.status_code, 599) - token1 = response.content.decode("ascii") + response.charset = "ascii" + token1 = response.text response = self.client.get("/does not exist/") self.assertEqual(response.status_code, 599) - token2 = response.content.decode("ascii") + response.charset = "ascii" + token2 = response.text secret2 = _unmask_cipher_token(token2) self.assertMaskedSecretCorrect(token1, secret2) diff --git a/tests/httpwrappers/tests.py b/tests/httpwrappers/tests.py index 154e9517fe..3774ff2d67 100644 --- a/tests/httpwrappers/tests.py +++ b/tests/httpwrappers/tests.py @@ -630,7 +630,7 @@ class JsonResponseTests(SimpleTestCase): def test_json_response_non_ascii(self): data = {"key": "łóżko"} response = JsonResponse(data) - self.assertEqual(json.loads(response.content.decode()), data) + self.assertEqual(json.loads(response.text), data) def test_json_response_raises_type_error_with_default_setting(self): with self.assertRaisesMessage( @@ -642,16 +642,16 @@ class JsonResponseTests(SimpleTestCase): def test_json_response_text(self): response = JsonResponse("foobar", safe=False) - self.assertEqual(json.loads(response.content.decode()), "foobar") + self.assertEqual(json.loads(response.text), "foobar") def test_json_response_list(self): response = JsonResponse(["foo", "bar"], safe=False) - self.assertEqual(json.loads(response.content.decode()), ["foo", "bar"]) + self.assertEqual(json.loads(response.text), ["foo", "bar"]) def test_json_response_uuid(self): u = uuid.uuid4() response = JsonResponse(u, safe=False) - self.assertEqual(json.loads(response.content.decode()), str(u)) + self.assertEqual(json.loads(response.text), str(u)) def test_json_response_custom_encoder(self): class CustomDjangoJSONEncoder(DjangoJSONEncoder): @@ -659,11 +659,11 @@ class JsonResponseTests(SimpleTestCase): return json.dumps({"foo": "bar"}) response = JsonResponse({}, encoder=CustomDjangoJSONEncoder) - self.assertEqual(json.loads(response.content.decode()), {"foo": "bar"}) + self.assertEqual(json.loads(response.text), {"foo": "bar"}) def test_json_response_passing_arguments_to_json_dumps(self): response = JsonResponse({"foo": "bar"}, json_dumps_params={"indent": 2}) - self.assertEqual(response.content.decode(), '{\n "foo": "bar"\n}') + self.assertEqual(response.text, '{\n "foo": "bar"\n}') class StreamingHttpResponseTests(SimpleTestCase): diff --git a/tests/serializers/tests.py b/tests/serializers/tests.py index 6ca0c15e04..420246db0b 100644 --- a/tests/serializers/tests.py +++ b/tests/serializers/tests.py @@ -155,7 +155,7 @@ class SerializersTestBase: if isinstance(stream, StringIO): self.assertEqual(string_data, stream.getvalue()) else: - self.assertEqual(string_data, stream.content.decode()) + self.assertEqual(string_data, stream.text) def test_serialize_specific_fields(self): obj = ComplexModel(field1="first", field2="second", field3="third") diff --git a/tests/sitemaps_tests/test_generic.py b/tests/sitemaps_tests/test_generic.py index dc998eec93..f0cd14699b 100644 --- a/tests/sitemaps_tests/test_generic.py +++ b/tests/sitemaps_tests/test_generic.py @@ -45,7 +45,7 @@ class GenericViewsSitemapTests(SitemapTestsBase): "%s\n" "" ) % expected - self.assertXMLEqual(response.content.decode(), expected_content) + self.assertXMLEqual(response.text, expected_content) def test_generic_sitemap_lastmod(self): test_model = TestModel.objects.first() @@ -61,7 +61,7 @@ class GenericViewsSitemapTests(SitemapTestsBase): self.base_url, test_model.pk, ) - self.assertXMLEqual(response.content.decode(), expected_content) + self.assertXMLEqual(response.text, expected_content) self.assertEqual( response.headers["Last-Modified"], "Wed, 13 Mar 2013 10:00:00 GMT" ) @@ -89,4 +89,4 @@ class GenericViewsSitemapTests(SitemapTestsBase): http://example.com/simple/sitemap-generic.xml2013-03-13T10:00:00 """ - self.assertXMLEqual(response.content.decode("utf-8"), expected_content) + self.assertXMLEqual(response.text, expected_content) diff --git a/tests/sitemaps_tests/test_http.py b/tests/sitemaps_tests/test_http.py index 74d183a7b0..6ae7e0d7c4 100644 --- a/tests/sitemaps_tests/test_http.py +++ b/tests/sitemaps_tests/test_http.py @@ -29,7 +29,7 @@ class HTTPSitemapTests(SitemapTestsBase): self.base_url, date.today(), ) - self.assertXMLEqual(response.content.decode(), expected_content) + self.assertXMLEqual(response.text, expected_content) def test_sitemap_not_callable(self): """A sitemap may not be callable.""" @@ -42,7 +42,7 @@ class HTTPSitemapTests(SitemapTestsBase): self.base_url, date.today(), ) - self.assertXMLEqual(response.content.decode(), expected_content) + self.assertXMLEqual(response.text, expected_content) def test_paged_sitemap(self): """A sitemap may have multiple pages.""" @@ -54,7 +54,7 @@ class HTTPSitemapTests(SitemapTestsBase): """.format( self.base_url, date.today() ) - self.assertXMLEqual(response.content.decode(), expected_content) + self.assertXMLEqual(response.text, expected_content) @override_settings( TEMPLATES=[ @@ -76,7 +76,7 @@ class HTTPSitemapTests(SitemapTestsBase): self.base_url, date.today(), ) - self.assertXMLEqual(response.content.decode(), expected_content) + self.assertXMLEqual(response.text, expected_content) def test_simple_sitemap_section(self): "A simple sitemap section can be rendered" @@ -92,7 +92,7 @@ class HTTPSitemapTests(SitemapTestsBase): self.base_url, date.today(), ) - self.assertXMLEqual(response.content.decode(), expected_content) + self.assertXMLEqual(response.text, expected_content) def test_no_section(self): response = self.client.get("/simple/sitemap-simple2.xml") @@ -126,7 +126,7 @@ class HTTPSitemapTests(SitemapTestsBase): self.base_url, date.today(), ) - self.assertXMLEqual(response.content.decode(), expected_content) + self.assertXMLEqual(response.text, expected_content) @override_settings( TEMPLATES=[ @@ -148,7 +148,7 @@ class HTTPSitemapTests(SitemapTestsBase): self.base_url, date.today(), ) - self.assertXMLEqual(response.content.decode(), expected_content) + self.assertXMLEqual(response.text, expected_content) def test_sitemap_last_modified(self): "Last-Modified header is set correctly" @@ -268,7 +268,7 @@ class HTTPSitemapTests(SitemapTestsBase): "never0.5\n" "" ) % date.today() - self.assertXMLEqual(response.content.decode(), expected_content) + self.assertXMLEqual(response.text, expected_content) def test_sitemap_get_urls_no_site_1(self): """ @@ -316,7 +316,7 @@ class HTTPSitemapTests(SitemapTestsBase): self.base_url, date.today(), ) - self.assertXMLEqual(response.content.decode(), expected_content) + self.assertXMLEqual(response.text, expected_content) def test_x_robots_sitemap(self): response = self.client.get("/simple/index.xml") @@ -346,7 +346,7 @@ class HTTPSitemapTests(SitemapTestsBase): "never0.5\n" "" ).format(self.base_url, self.i18n_model.pk) - self.assertXMLEqual(response.content.decode(), expected_content) + self.assertXMLEqual(response.text, expected_content) @override_settings(LANGUAGES=(("en", "English"), ("pt", "Portuguese"))) def test_alternate_i18n_sitemap_index(self): @@ -374,7 +374,7 @@ class HTTPSitemapTests(SitemapTestsBase): f"{expected_urls}\n" f"" ) - self.assertXMLEqual(response.content.decode(), expected_content) + self.assertXMLEqual(response.text, expected_content) @override_settings( LANGUAGES=(("en", "English"), ("pt", "Portuguese"), ("es", "Spanish")) @@ -404,7 +404,7 @@ class HTTPSitemapTests(SitemapTestsBase): f"{expected_urls}\n" f"" ) - self.assertXMLEqual(response.content.decode(), expected_content) + self.assertXMLEqual(response.text, expected_content) @override_settings(LANGUAGES=(("en", "English"), ("pt", "Portuguese"))) def test_alternate_i18n_sitemap_xdefault(self): @@ -434,7 +434,7 @@ class HTTPSitemapTests(SitemapTestsBase): f"{expected_urls}\n" f"" ) - self.assertXMLEqual(response.content.decode(), expected_content) + self.assertXMLEqual(response.text, expected_content) @override_settings(LANGUAGES=(("en", "English"), ("pt", "Portuguese"))) def test_language_for_item_i18n_sitemap(self): @@ -460,7 +460,7 @@ class HTTPSitemapTests(SitemapTestsBase): f"{expected_urls}\n" f"" ) - self.assertXMLEqual(response.content.decode(), expected_content) + self.assertXMLEqual(response.text, expected_content) @override_settings(LANGUAGES=(("en", "English"), ("pt", "Portuguese"))) def test_alternate_language_for_item_i18n_sitemap(self): @@ -500,7 +500,7 @@ class HTTPSitemapTests(SitemapTestsBase): f"{expected_urls}\n" f"" ) - self.assertXMLEqual(response.content.decode(), expected_content) + self.assertXMLEqual(response.text, expected_content) def test_sitemap_without_entries(self): response = self.client.get("/sitemap-without-entries/sitemap.xml") @@ -510,7 +510,7 @@ class HTTPSitemapTests(SitemapTestsBase): 'xmlns:xhtml="http://www.w3.org/1999/xhtml">\n\n' "" ) - self.assertXMLEqual(response.content.decode(), expected_content) + self.assertXMLEqual(response.text, expected_content) def test_callable_sitemod_partial(self): """ @@ -535,8 +535,8 @@ class HTTPSitemapTests(SitemapTestsBase): "http://example.com/location/\n" "" ) - self.assertXMLEqual(index_response.content.decode(), expected_content_index) - self.assertXMLEqual(sitemap_response.content.decode(), expected_content_sitemap) + self.assertXMLEqual(index_response.text, expected_content_index) + self.assertXMLEqual(sitemap_response.text, expected_content_sitemap) def test_callable_sitemod_full(self): """ @@ -566,8 +566,8 @@ class HTTPSitemapTests(SitemapTestsBase): "2014-03-13\n" "" ) - self.assertXMLEqual(index_response.content.decode(), expected_content_index) - self.assertXMLEqual(sitemap_response.content.decode(), expected_content_sitemap) + self.assertXMLEqual(index_response.text, expected_content_index) + self.assertXMLEqual(sitemap_response.text, expected_content_sitemap) def test_callable_sitemod_no_items(self): index_response = self.client.get("/callable-lastmod-no-items/index.xml") @@ -577,4 +577,4 @@ class HTTPSitemapTests(SitemapTestsBase): http://example.com/simple/sitemap-callable-lastmod.xml """ - self.assertXMLEqual(index_response.content.decode(), expected_content_index) + self.assertXMLEqual(index_response.text, expected_content_index) diff --git a/tests/sitemaps_tests/test_https.py b/tests/sitemaps_tests/test_https.py index 2eae71e4cc..a5369869f9 100644 --- a/tests/sitemaps_tests/test_https.py +++ b/tests/sitemaps_tests/test_https.py @@ -20,7 +20,7 @@ class HTTPSSitemapTests(SitemapTestsBase): self.base_url, date.today(), ) - self.assertXMLEqual(response.content.decode(), expected_content) + self.assertXMLEqual(response.text, expected_content) def test_secure_sitemap_section(self): "A secure sitemap section can be rendered" @@ -36,7 +36,7 @@ class HTTPSSitemapTests(SitemapTestsBase): self.base_url, date.today(), ) - self.assertXMLEqual(response.content.decode(), expected_content) + self.assertXMLEqual(response.text, expected_content) @override_settings(SECURE_PROXY_SSL_HEADER=False) @@ -54,7 +54,7 @@ class HTTPSDetectionSitemapTests(SitemapTestsBase): self.base_url.replace("http://", "https://"), date.today(), ) - self.assertXMLEqual(response.content.decode(), expected_content) + self.assertXMLEqual(response.text, expected_content) def test_sitemap_section_with_https_request(self): "A sitemap section requested in HTTPS is rendered with HTTPS links" @@ -70,4 +70,4 @@ class HTTPSDetectionSitemapTests(SitemapTestsBase): self.base_url.replace("http://", "https://"), date.today(), ) - self.assertXMLEqual(response.content.decode(), expected_content) + self.assertXMLEqual(response.text, expected_content) diff --git a/tests/view_tests/tests/test_i18n.py b/tests/view_tests/tests/test_i18n.py index 93e91bcc83..229ce68bfc 100644 --- a/tests/view_tests/tests/test_i18n.py +++ b/tests/view_tests/tests/test_i18n.py @@ -295,7 +295,7 @@ class I18NViewTests(SimpleTestCase): """ with override("de"): response = self.client.get("/jsoni18n/") - data = json.loads(response.content.decode()) + data = json.loads(response.text) self.assertIn("catalog", data) self.assertIn("formats", data) self.assertEqual( @@ -329,7 +329,7 @@ class I18NViewTests(SimpleTestCase): """ with self.settings(LANGUAGE_CODE="es"), override("en-us"): response = self.client.get("/jsoni18n/") - data = json.loads(response.content.decode()) + data = json.loads(response.text) self.assertIn("catalog", data) self.assertIn("formats", data) self.assertIn("plural", data) diff --git a/tests/view_tests/tests/test_json.py b/tests/view_tests/tests/test_json.py index 145e6e05a4..b314510f3c 100644 --- a/tests/view_tests/tests/test_json.py +++ b/tests/view_tests/tests/test_json.py @@ -10,7 +10,7 @@ class JsonResponseTests(SimpleTestCase): self.assertEqual(response.status_code, 200) self.assertEqual(response.headers["content-type"], "application/json") self.assertEqual( - json.loads(response.content.decode()), + json.loads(response.text), { "a": [1, 2, 3], "foo": {"bar": "baz"}, From 438fc42ac667653488200578a47e59f6608f2b0b Mon Sep 17 00:00:00 2001 From: Maryam Yusuf Date: Tue, 13 Aug 2024 00:21:49 +0100 Subject: [PATCH 011/132] Expanded contributor docs on getting feedback from the wider community. --- .../writing-code/submitting-patches.txt | 63 ++++++++++++++++--- docs/spelling_wordlist | 1 + 2 files changed, 54 insertions(+), 10 deletions(-) diff --git a/docs/internals/contributing/writing-code/submitting-patches.txt b/docs/internals/contributing/writing-code/submitting-patches.txt index cac6848d04..799292e3fd 100644 --- a/docs/internals/contributing/writing-code/submitting-patches.txt +++ b/docs/internals/contributing/writing-code/submitting-patches.txt @@ -114,7 +114,7 @@ requirements: feature, the change should also contain documentation. When you think your work is ready to be reviewed, send :doc:`a GitHub pull -request `. +request `. If you can't send a pull request for some reason, you can also use patches in Trac. When using this style, follow these guidelines. @@ -140,20 +140,63 @@ Regardless of the way you submit your work, follow these steps. .. _ticket tracker: https://code.djangoproject.com/ .. _Development dashboard: https://dashboard.djangoproject.com/ -Non-trivial contributions -========================= +Contributions which require community feedback +============================================== -A "non-trivial" contribution is one that is more than a small bug fix. It's a -change that introduces new Django functionality and makes some sort of design -decision. +A wider community discussion is required when a patch introduces new Django +functionality and makes some sort of design decision. This is especially +important if the approach involves a :ref:`deprecation ` +or introduces breaking changes. -If you provide a non-trivial change, include evidence that alternatives have -been discussed on the `Django Forum`_ or |django-developers| list. +The following are different approaches for gaining feedback from the community. -If you're not sure whether your contribution should be considered non-trivial, -ask on the ticket for opinions. +The Django Forum or django-developers mailing list +-------------------------------------------------- + +You can propose a change on the `Django Forum`_ or |django-developers| mailing +list. You should explain the need for the change, go into details of the +approach and discuss alternatives. + +Please include a link to such discussions in your contributions. + +Third party package +------------------- + +Django does not accept experimental features. All features must follow our +:ref:`deprecation policy `. Hence, it can +take months or years for Django to iterate on an API design. + +If you need user feedback on a public interface, it is better to create a +third-party package first. You can iterate on the public API much faster, while +also validating the need for the feature. + +Once this package becomes stable and there are clear benefits of incorporating +aspects into Django core, starting a discussion on the `Django Forum`_ or +|django-developers| mailing list would be the next step. + +Django Enhancement Proposal (DEP) +--------------------------------- + +Similar to Python’s PEPs, Django has `Django Enhancement Proposals`_ or DEPs. A +DEP is a design document which provides information to the Django community, or +describes a new feature or process for Django. They provide concise technical +specifications of features, along with rationales. DEPs are also the primary +mechanism for proposing and collecting community input on major new features. + +Before considering writing a DEP, it is recommended to first open a discussion +on the `Django Forum`_ or |django-developers| mailing list. This allows the +community to provide feedback and helps refine the proposal. Once the DEP is +ready the :ref:`Steering Council ` votes on whether to accept +it. + +Some examples of DEPs that have been approved and fully implemented: + +* `DEP 181: ORM Expressions `_ +* `DEP 182: Multiple Template Engines `_ +* `DEP 201: Simplified routing syntax `_ .. _Django Forum: https://forum.djangoproject.com/ +.. _Django Enhancement Proposals: https://github.com/django/deps .. _deprecating-a-feature: diff --git a/docs/spelling_wordlist b/docs/spelling_wordlist index d30f2ce440..747a712a62 100644 --- a/docs/spelling_wordlist +++ b/docs/spelling_wordlist @@ -123,6 +123,7 @@ deduplicates deduplication deepcopy deferrable +DEP deprecations deserialization deserialize From 48fa531fbcd96af301781a6e5192509081d7dd2d Mon Sep 17 00:00:00 2001 From: Mariusz Felisiak Date: Thu, 17 Oct 2024 03:19:17 +0200 Subject: [PATCH 012/132] Refs #35844 -- Added Python 3.14 to daily builds. --- .github/workflows/schedule_tests.yml | 1 + tests/requirements/py3.txt | 4 ++-- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/.github/workflows/schedule_tests.yml b/.github/workflows/schedule_tests.yml index f99ef218aa..1ca766f7f3 100644 --- a/.github/workflows/schedule_tests.yml +++ b/.github/workflows/schedule_tests.yml @@ -20,6 +20,7 @@ jobs: - '3.11' - '3.12' - '3.13' + - '3.14-dev' name: Windows, SQLite, Python ${{ matrix.python-version }} continue-on-error: true steps: diff --git a/tests/requirements/py3.txt b/tests/requirements/py3.txt index a9679af97c..f0e208a115 100644 --- a/tests/requirements/py3.txt +++ b/tests/requirements/py3.txt @@ -6,8 +6,8 @@ black docutils >= 0.19 geoip2 jinja2 >= 2.11.0 -numpy -Pillow >= 6.2.1 +numpy; python_version < '3.14' +Pillow >= 6.2.1; sys.platform != 'win32' or python_version < '3.14' # pylibmc/libmemcached can't be built on Windows. pylibmc; sys_platform != 'win32' pymemcache >= 3.4.0 From 8b1a3a56438ce99fe9058f078a6bdd92a01e1130 Mon Sep 17 00:00:00 2001 From: Jay Patel Date: Sat, 5 Oct 2024 11:26:59 +0200 Subject: [PATCH 013/132] Fixed #35795 -- Added role="button" to links acting as buttons for screen readers. --- django/contrib/admin/static/admin/js/inlines.js | 10 +++++----- django/contrib/admin/templates/admin/actions.html | 4 ++-- django/views/templates/technical_500.html | 2 +- 3 files changed, 8 insertions(+), 8 deletions(-) diff --git a/django/contrib/admin/static/admin/js/inlines.js b/django/contrib/admin/static/admin/js/inlines.js index a4246d6e12..cd3726cf30 100644 --- a/django/contrib/admin/static/admin/js/inlines.js +++ b/django/contrib/admin/static/admin/js/inlines.js @@ -50,11 +50,11 @@ // If forms are laid out as table rows, insert the // "add" button in a new table row: const numCols = $this.eq(-1).children().length; - $parent.append('' + options.addText + ""); + $parent.append('' + options.addText + ""); addButton = $parent.find("tr:last a"); } else { // Otherwise, insert it immediately after the last form: - $this.filter(":last").after('
' + options.addText + "
"); + $this.filter(":last").after('
' + options.addText + "
"); addButton = $this.filter(":last").next().find("a"); } } @@ -104,15 +104,15 @@ if (row.is("tr")) { // If the forms are laid out in table rows, insert // the remove button into the last table cell: - row.children(":last").append('"); + row.children(":last").append('"); } else if (row.is("ul") || row.is("ol")) { // If they're laid out as an ordered/unordered list, // insert an
  • after the last list item: - row.append('
  • ' + options.deleteText + "
    • "); + row.append('
  • ' + options.deleteText + "
    • "); } else { // Otherwise, just insert the remove button as the // last child element of the form's container: - row.children(":first").append('' + options.deleteText + ""); + row.children(":first").append('' + options.deleteText + ""); } // Add delete handler for each row. row.find("a." + options.deleteCssClass).on('click', inlineDeleteHandler.bind(this)); diff --git a/django/contrib/admin/templates/admin/actions.html b/django/contrib/admin/templates/admin/actions.html index ca1327c6d5..f506c92334 100644 --- a/django/contrib/admin/templates/admin/actions.html +++ b/django/contrib/admin/templates/admin/actions.html @@ -13,9 +13,9 @@ {% if cl.result_count != cl.result_list|length %} - + {% endif %} {% endif %} {% endblock %} diff --git a/django/views/templates/technical_500.html b/django/views/templates/technical_500.html index 31f0dfe1b9..a2fc8415f5 100644 --- a/django/views/templates/technical_500.html +++ b/django/views/templates/technical_500.html @@ -212,7 +212,7 @@ {% endif %} {% if frames %}
    -

    Traceback{% if not is_email %} +

    Traceback{% if not is_email %} Switch to copy-and-paste view{% endif %}

    From bd3b1dfa2422e02ced3a894adb7544e42540c97d Mon Sep 17 00:00:00 2001 From: Mariusz Felisiak Date: Thu, 17 Oct 2024 15:15:10 +0200 Subject: [PATCH 014/132] Refs #35844 -- Used asgiref.sync.iscoroutinefunction() instead of deprecated asyncio.iscoroutinefunction(). Fixes DeprecationWarning: 'asyncio.iscoroutinefunction' is deprecated and slated for removal in Python 3.16; use inspect.iscoroutinefunction() instead. --- django/contrib/auth/decorators.py | 11 +++++------ tests/auth_tests/test_decorators.py | 2 +- 2 files changed, 6 insertions(+), 7 deletions(-) diff --git a/django/contrib/auth/decorators.py b/django/contrib/auth/decorators.py index 77fbc79855..4d62aec93a 100644 --- a/django/contrib/auth/decorators.py +++ b/django/contrib/auth/decorators.py @@ -1,8 +1,7 @@ -import asyncio from functools import wraps from urllib.parse import urlsplit -from asgiref.sync import async_to_sync, sync_to_async +from asgiref.sync import async_to_sync, iscoroutinefunction, sync_to_async from django.conf import settings from django.contrib.auth import REDIRECT_FIELD_NAME @@ -35,11 +34,11 @@ def user_passes_test( return redirect_to_login(path, resolved_login_url, redirect_field_name) - if asyncio.iscoroutinefunction(view_func): + if iscoroutinefunction(view_func): async def _view_wrapper(request, *args, **kwargs): auser = await request.auser() - if asyncio.iscoroutinefunction(test_func): + if iscoroutinefunction(test_func): test_pass = await test_func(auser) else: test_pass = await sync_to_async(test_func)(auser) @@ -51,7 +50,7 @@ def user_passes_test( else: def _view_wrapper(request, *args, **kwargs): - if asyncio.iscoroutinefunction(test_func): + if iscoroutinefunction(test_func): test_pass = async_to_sync(test_func)(request.user) else: test_pass = test_func(request.user) @@ -107,7 +106,7 @@ def permission_required(perm, login_url=None, raise_exception=False): perms = perm def decorator(view_func): - if asyncio.iscoroutinefunction(view_func): + if iscoroutinefunction(view_func): async def check_perms(user): # First check if the user has the permission (even anon users). diff --git a/tests/auth_tests/test_decorators.py b/tests/auth_tests/test_decorators.py index fa2672beb4..2c3f93d2ab 100644 --- a/tests/auth_tests/test_decorators.py +++ b/tests/auth_tests/test_decorators.py @@ -1,4 +1,4 @@ -from asyncio import iscoroutinefunction +from asgiref.sync import iscoroutinefunction from django.conf import settings from django.contrib.auth import models From 65f3cfce59395131f318cf1ecba144530ed6609e Mon Sep 17 00:00:00 2001 From: Clifford Gama <53076065+cliff688@users.noreply.github.com> Date: Thu, 17 Oct 2024 16:39:40 +0200 Subject: [PATCH 015/132] Fixed #26322 -- Consolidated lazy relationships details in docs/ref/models/fields.txt. Reorganized docs to list and explain the types of lazy relationships that can be defined in related fields. Co-authored-by: Natalia <124304+nessita@users.noreply.github.com> --- docs/ref/models/fields.txt | 195 ++++++++++++++++++++++++------------- 1 file changed, 127 insertions(+), 68 deletions(-) diff --git a/docs/ref/models/fields.txt b/docs/ref/models/fields.txt index 899947c17f..febb45108d 100644 --- a/docs/ref/models/fields.txt +++ b/docs/ref/models/fields.txt @@ -1628,80 +1628,25 @@ Django also defines a set of fields that represent relations. .. class:: ForeignKey(to, on_delete, **options) A many-to-one relationship. Requires two positional arguments: the class to -which the model is related and the :attr:`~ForeignKey.on_delete` option. - -.. _recursive-relationships: - -To create a recursive relationship -- an object that has a many-to-one -relationship with itself -- use ``models.ForeignKey('self', -on_delete=models.CASCADE)``. - -.. _lazy-relationships: - -If you need to create a relationship on a model that has not yet been defined, -you can use the name of the model, rather than the model object itself:: +which the model is related and the :attr:`~ForeignKey.on_delete` option:: from django.db import models - class Car(models.Model): - manufacturer = models.ForeignKey( - "Manufacturer", - on_delete=models.CASCADE, - ) - # ... - - class Manufacturer(models.Model): - # ... - pass + name = models.TextField() -Relationships defined this way on :ref:`abstract models -` are resolved when the model is subclassed as a -concrete model and are not relative to the abstract model's ``app_label``: - -.. code-block:: python - :caption: ``products/models.py`` - - from django.db import models - - - class AbstractCar(models.Model): - manufacturer = models.ForeignKey("Manufacturer", on_delete=models.CASCADE) - - class Meta: - abstract = True - -.. code-block:: python - :caption: ``production/models.py`` - - from django.db import models - from products.models import AbstractCar - - - class Manufacturer(models.Model): - pass - - - class Car(AbstractCar): - pass - - - # Car.manufacturer will point to `production.Manufacturer` here. - -To refer to models defined in another application, you can explicitly specify -a model with the full application label. For example, if the ``Manufacturer`` -model above is defined in another application called ``production``, you'd -need to use:: class Car(models.Model): - manufacturer = models.ForeignKey( - "production.Manufacturer", - on_delete=models.CASCADE, - ) + manufacturer = models.ForeignKey(Manufacturer, on_delete=models.CASCADE) -This sort of reference, called a lazy relationship, can be useful when -resolving circular import dependencies between two applications. +The first positional argument can be either a concrete model class or a +:ref:`lazy reference ` to a model class. +:ref:`Recursive relationships `, where a model has a +relationship with itself, are also supported. + +See :attr:`ForeignKey.on_delete` for details on the second positional +argument. A database index is automatically created on the ``ForeignKey``. You can disable this by setting :attr:`~Field.db_index` to ``False``. You may want to @@ -1714,9 +1659,9 @@ Database Representation Behind the scenes, Django appends ``"_id"`` to the field name to create its database column name. In the above example, the database table for the ``Car`` -model will have a ``manufacturer_id`` column. (You can change this explicitly by -specifying :attr:`~Field.db_column`) However, your code should never have to -deal with the database column name, unless you write custom SQL. You'll always +model will have a ``manufacturer_id`` column. You can change this explicitly by +specifying :attr:`~Field.db_column`, however, your code should never have to +deal with the database column name (unless you write custom SQL). You'll always deal with the field names of your model object. .. _foreign-key-arguments: @@ -2266,6 +2211,120 @@ accepted by :class:`ForeignKey`, plus one extra argument: See :doc:`One-to-one relationships ` for usage examples of ``OneToOneField``. +.. _lazy-relationships: + +Lazy relationships +------------------ + +Lazy relationships allow referencing models by their names (as strings) or +creating recursive relationships. Strings can be used as the first argument in +any relationship field to reference models lazily. A lazy reference can be +either :ref:`recursive `, +:ref:`relative ` or +:ref:`absolute `. + +.. _recursive-relationships: + +Recursive +~~~~~~~~~ + +To define a relationship where a model references itself, use ``"self"`` as the +first argument of the relationship field:: + + from django.db import models + + + class Manufacturer(models.Model): + name = models.TextField() + suppliers = models.ManyToManyField("self", symmetrical=False) + + +When used in an :ref:`abstract model `, the recursive +relationship resolves such that each concrete subclass references itself. + +.. _relative-relationships: + +Relative +~~~~~~~~ + +When a relationship needs to be created with a model that has not been defined +yet, it can be referenced by its name rather than the model object itself:: + + from django.db import models + + + class Car(models.Model): + manufacturer = models.ForeignKey( + "Manufacturer", + on_delete=models.CASCADE, + ) + + + class Manufacturer(models.Model): + name = models.TextField() + suppliers = models.ManyToManyField("self", symmetrical=False) + +Relationships defined this way on :ref:`abstract models +` are resolved when the model is subclassed as a +concrete model and are not relative to the abstract model's ``app_label``: + +.. code-block:: python + :caption: ``products/models.py`` + + from django.db import models + + + class AbstractCar(models.Model): + manufacturer = models.ForeignKey("Manufacturer", on_delete=models.CASCADE) + + class Meta: + abstract = True + +.. code-block:: python + :caption: ``production/models.py`` + + from django.db import models + from products.models import AbstractCar + + + class Manufacturer(models.Model): + name = models.TextField() + + + class Car(AbstractCar): + pass + +In this example, the ``Car.manufacturer`` relationship will resolve to +``production.Manufacturer``, as it points to the concrete model defined +within the ``production/models.py`` file. + +.. admonition:: Reusable models with relative references + + Relative references allow the creation of reusable abstract models with + relationships that can resolve to different implementations of the + referenced models in various subclasses across different applications. + +.. _absolute-relationships: + +Absolute +~~~~~~~~ + +Absolute references specify a model using its ``app_label`` and class name, +allowing for model references across different applications. This type of lazy +relationship can also help resolve circular imports. + +For example, if the ``Manufacturer`` model is defined in another application +called ``thirdpartyapp``, it can be referenced as:: + + class Car(models.Model): + manufacturer = models.ForeignKey( + "thirdpartyapp``.Manufacturer", + on_delete=models.CASCADE, + ) + +Absolute references always point to the same model, even when used in an +:ref:`abstract model `. + Field API reference =================== From 99dcc59237f384d7ade98acfd1cae8d90e6d60ab Mon Sep 17 00:00:00 2001 From: Justin Thurman Date: Wed, 16 Oct 2024 09:43:02 -0400 Subject: [PATCH 016/132] Fixed #35845 -- Updated DomainNameValidator to require entire string to be a valid domain name. Bug in 4971a9afe5642569f3dcfcd3972ebb39e88dd457. Thank you to kazet for the report and Claude Paroz for the review. --- django/core/validators.py | 9 ++++++--- docs/releases/5.1.3.txt | 5 ++++- tests/validators/tests.py | 14 ++++++++++++-- 3 files changed, 22 insertions(+), 6 deletions(-) diff --git a/django/core/validators.py b/django/core/validators.py index b1c5c053b8..8732ddf7ad 100644 --- a/django/core/validators.py +++ b/django/core/validators.py @@ -101,13 +101,16 @@ class DomainNameValidator(RegexValidator): if self.accept_idna: self.regex = _lazy_re_compile( - self.hostname_re + self.domain_re + self.tld_re, re.IGNORECASE + r"^" + self.hostname_re + self.domain_re + self.tld_re + r"$", + re.IGNORECASE, ) else: self.regex = _lazy_re_compile( - self.ascii_only_hostname_re + r"^" + + self.ascii_only_hostname_re + self.ascii_only_domain_re - + self.ascii_only_tld_re, + + self.ascii_only_tld_re + + r"$", re.IGNORECASE, ) super().__init__(**kwargs) diff --git a/docs/releases/5.1.3.txt b/docs/releases/5.1.3.txt index 5541a8824a..e3c62072b5 100644 --- a/docs/releases/5.1.3.txt +++ b/docs/releases/5.1.3.txt @@ -10,4 +10,7 @@ Django 5.1.3 fixes several bugs in 5.1.2 and adds compatibility with Python Bugfixes ======== -* ... +* Fixed a bug in Django 5.1 where + :class:`~django.core.validators.DomainNameValidator` accepted any input value + that contained a valid domain name, rather than only input values that were a + valid domain name (:ticket:`35845`). diff --git a/tests/validators/tests.py b/tests/validators/tests.py index ba1db5ea46..4ae0f6413e 100644 --- a/tests/validators/tests.py +++ b/tests/validators/tests.py @@ -635,8 +635,8 @@ TEST_DATA = [ (validate_domain_name, "python-python.com", None), (validate_domain_name, "python.name.uk", None), (validate_domain_name, "python.tips", None), - (validate_domain_name, "http://例子.测试", None), - (validate_domain_name, "http://dashinpunytld.xn---c", None), + (validate_domain_name, "例子.测试", None), + (validate_domain_name, "dashinpunytld.xn---c", None), (validate_domain_name, "python..org", ValidationError), (validate_domain_name, "python-.org", ValidationError), (validate_domain_name, "too-long-name." * 20 + "com", ValidationError), @@ -652,6 +652,16 @@ TEST_DATA = [ ), (DomainNameValidator(accept_idna=False), "ıçğü.com", ValidationError), (DomainNameValidator(accept_idna=False), "not-domain-name", ValidationError), + ( + DomainNameValidator(accept_idna=False), + "not-domain-name, but-has-domain-name-suffix.com", + ValidationError, + ), + ( + DomainNameValidator(accept_idna=False), + "not-domain-name.com, but has domain prefix", + ValidationError, + ), ] # Add valid and invalid URL tests. From c37f249ffa4b735d1492cda11981dedb947ee437 Mon Sep 17 00:00:00 2001 From: Nick Pope Date: Tue, 15 Oct 2024 09:26:12 +0100 Subject: [PATCH 017/132] Refs #35841 -- Updated GeoIP2 test database files. The mmdb files were taken from https://github.com/maxmind/MaxMind-DB/commit/679e37e18a4a3009949c2213ec2c0bb8090c10c7. --- .../data/geoip2/GeoIP2-City-Test.mmdb | Bin 22430 -> 22451 bytes .../data/geoip2/GeoIP2-Country-Test.mmdb | Bin 19628 -> 19744 bytes .../data/geoip2/GeoLite2-ASN-Test.mmdb | Bin 12653 -> 12653 bytes .../data/geoip2/GeoLite2-City-Test.mmdb | Bin 21117 -> 21117 bytes .../data/geoip2/GeoLite2-Country-Test.mmdb | Bin 18041 -> 18041 bytes tests/gis_tests/data/geoip2/LICENSE | 4 ---- tests/gis_tests/data/geoip2/README | 3 --- tests/gis_tests/data/geoip2/README.md | 14 ++++++++++++++ 8 files changed, 14 insertions(+), 7 deletions(-) delete mode 100644 tests/gis_tests/data/geoip2/LICENSE delete mode 100644 tests/gis_tests/data/geoip2/README create mode 100644 tests/gis_tests/data/geoip2/README.md diff --git a/tests/gis_tests/data/geoip2/GeoIP2-City-Test.mmdb b/tests/gis_tests/data/geoip2/GeoIP2-City-Test.mmdb index 3197ef122fa3522eb8b4e15ad0e6cf1e0e51e8a0..bf3cbe783593e60c16bf2e97f27ad7b692bb17c9 100644 GIT binary patch literal 22451 zcmZ{q2VfM{7WeP&%z%QZD4-yb33Wj!f(5LkXOob`6oMLzOR^+OlHIsPNJJkbsPtY$ z5D2}9gx-s;y>9HjrkDomQ{PkH)8|va|2=1Bi{JM}+27oA@0q#voOADt5Edb{Uxly= z(W#RV3a+jdLgkdkfL!KvW?UkK<#Qn}*HKX7FP%aqBqmQN~QhV~occeO0MU7J}blq&f6Ht+ayF|B(+(HEs@k#*4xI|F2oL2-x(>gi}Q9f_6YGD5~07)J@zFUN#9&cYKB;YlG*vG6qGOeF8D5a%MP z7r25i3K2w=UK8RaA-dEH@v;zIJ)HLn<5fae%;eWeU6ztHc$4u~xR%j7 z`~>9D)2|bjzML1wxISFO(oa})7REFBGX_M84CK2E5|+W7H-uq}6dB4zh7m3=6P6pf z$Z*tinXrriyuvaPC>EAcoOcsrG=zo1G6qN!mYZ343*%PCZH%#uag5s;cQEc`+{L(? zaSvlWZk;MD37kq~Br%d1DFoSBMxOze^l-{z=k{d?OC~F1F(xpwBPDaVWUjE>%XxW> z{78`kDk7gSF(NDymPwJ+eZq1->pc(_8a1;_7M2G&uY~as!+~Zx`RP-HrIdwb1gOdk z3CmPrDd)V3h|tA((}blmBCKLzwXnEZ!4t`=5tfI;DcslM3#Tl8VF}$h0j4h0TLB>mrmkFf) zim<#INxdd4?EftA-^iyTZ!+EzmbY2`ok-rhoEIYWFlzlC3*Tpa!1$2y5#wXVCyY-S ze`frJ@mI#*7=LFN{_i1SInQVF#gB*mGK+ncY;+gEDR*^SgXQN85#pK zOXhWET*A1N(S^~KaT%i<<8sCoj4K)48CNl`X7ph6Wb|UN|C3WgKD{@i4>qW83hQ;8 z>dS~@T+iso&>8WJ{)_>Pfw;>X^0vY{NLUB6a0tW37|IxiB4>s524I`8-U!?xtiw5P z1Y;zF{h#$FPK{=aVX*%b4{_>N2K=AZC9GqC3}GDy+|5pMEcj z6bWk{P#~_U1M&&-v4u!YG*dE93MVn{i@D1KC^XmpPs3e$x(z3F~8Aq20OurA_~iwS0x*#B915*b2_kFc%~)|ITVD(2Skf7T7c`ZTakSl4oqX9(9C zwqQLApCyIi*BFzxg@s#VgxguTgFsc3><9WtDMiXN{ z;{b#GpY;%@4l|B0jxvrhjx$aWs1hfI^%M(FGtLmMKBMWku3{ndW!s}bDupV+ zXsv?rQ7#n<&w1q%%8Tp9CA%=VN^xnNLY~rBD3=30g>nUOl~AtayzYcJZl7{B3wsc* z=b5bZfvc0EKj+!2c;JLP_Ex$%OuY z=Ts_#2ghuR9ST`O$>6+9g4r(@hd5OQ1&>gwIprpp175?zhY4n_eNZ?c6hE*+C;?!OP#ysu6Uua;PAD^2ua+>7 z>#01-!kL8YLY#UW3bTdsCr-_Z$*X5!1HoK)@PEoep*#u96UtLug#Dj6m*%r@0b$?@ zPA!7MQlTv7)DprV%n&(@%NWaJge#%2MJTZB%6g%!2G$B?4VQeHV0P;>EL=x02M+#E z*(8(=oVSrM=o?NoGBy*;p4bY7Jwn+A>=ep&F2ZALK4=#UcN5HReGUrygtC|Oo+p_1 zY+~X57~w%EyeE`HKu{=$fm1>`0vs30QC2t>qi}+SCkbYs!T%}egmQ-S&c-Obz`_>^ zrnPwq3U3PKW#BcTyuw9ZB@Eulsn;2A5X_Ez3kvTFsy;j5ItLg6!^{EhSe9;5I%3(pgV6mhBr3SSDP73dI3 z8w=YB<~m~kr(7hV*@Is};TxfR%?ke@n2r9Hh2Ig(yTIhB{}#&k0M^(Kz->bL5$GY5 ze*>CO{)2n|CX}CmUxe~A-{rpqbNT*{g})Mp7)5@Ex>dg7lj}jX5NtfCs=`8KBCiiy z4Yd;#x(T&2&_$^1|I|yVh|vbME9+fGFr2A+ITX4JmF=f`WsJgAtZ+5KsF~Um3O1qk z0^)^w4RF0suLZ6XYHwEPLogPX+LwiKgrNnT>c`Lt#&S~o<1T}QI)L*A#^eoV;Sd(4 zacU?OMhSHoFkGlNu<%BL;iuIREF4KNY?gWx6mAykXwDl$FyaFB78c%0Fvdt73xy(~ zjswz#dOMIH)H{H?g?c9|+(j@Jf_e`N#}mxX6{HIs{E5zLxpvoMD+j4Pqu3xxuq=5by=!EAdW3nvl`yQEHnLZwje1ImPYKj0AR z1HgkqEoOzu1oN>aEab^&-en34OJhnpahD3APUXCE!m!UcVam@d=+=RHC&mbN;Bg|!58>OTsFqe7htJT276fO$fN|5Kk3 z>Yspmq0VBx*#z@J4J@2PFl+rJ3!h>b{?8cO`MB9Kp)LRx3w0qESwt9)d;TueUs?S(g0Yj*1f?|gf7gxSlmfjjLQ{dxLPHrmR_jDCdP!sd zr(McIzNgleOI}7WOptat?$T3eR{&QD?Mg1vJx1?p7WN<*!>ILwLT{nL|H-FcOE6}u z)`x}H5zH#ZLE%QBT@MTrT0fw_&~z>tPcUyifQ17IMy#O?hQd&x4dFZ+!F=8@7T!QG z=7csJ3O5UF1aOnkMskr+1Y_=Mqglw^YCioID2x@_t(6q1^){3T-?qBoIch@z9c3m`pHloeBlJ(9$?BonY28gN2y{W2>i4fWjo9 zWdrvLEr*Nb63i~hLtdfK@;R@7U_Ngm3yWeD?t?Mn!A(?VMgtPR zxQ1YyWN2%luwH1-aNatCIpEK-a6^o66BPCdtr6HMw9UXap>5%kTM34R*0!^dr?6r2 zv|UhmPH4M1Zx6w2*j^SsPcR$S1cjqQ+YcNP+5s+dFh=h%3y%=Y${&NmNueF*yc4Wo ztd&zNJWVhkbQTJK7uq@CU7@`Iye704ftQ6AWQCUq<}7%Hg|8AuVff{oe;o>M3GEF| zy-6?^<=ZTLhhWwdvq1Y;XwAR}LVJ&kyiYLu^(*K&#Nc;F2u_bMmqO)7nXB*7E`sz7pC+R``-&Yyh;cS@@3_ zg>RwoZ=rn$d@rdL%GO*pzvRz{luxCS)m)J;QwSN|BrAJT7(q- z7us)(-w6;%VJ8d2%1}fnHLTD{V1l~my?SoqG)GQL!_Jn5Q!Nd9TN)Z#8kVKh_=hLvA>SLw3attqXr2{16FM7eN~x_WH8?<~_ZUGDNSPqki@nTLWN9pW;NUYwcdsdWUZox_pV9a$~)TU+X%Z)w=w zQh!|c>#h3C;?VNY;n2y@vCs+BYd>mtthqka6gmwq(HEv(Sg^ls-RblyPpQN2^0-@b z9HpfJucNfK#Oo+?1$>QV=~c+_2g;lk(Glc5|D7pgj4s&zbExZ|J4D#qQp$SR|`6;$m#RziB4~&ufl~w zGbdX^YtUE>N9a)Kbn}AHaXqvwbQryGqIoWQV3xix>%z9Pt*7?2J+a_oL*sefrjPE> zEqW(;p|8~&P2aE;X-@*uh$)gEe)$$8g{ib9K?{dJ+Z%S`9h3` z?x#}09S(hFc4#Z=ixF#n(ipS$gR4*`en{uk4a3(mtE++fu5R@;Bz_MdR#K- z(2E9i(~IS$Q+L=~>NmI4AH%QiPYKSJ*)!8aOG8JE`?j8V26I(kD?9e;xISn|VgcPU zHL)V#ci^4_Ch0|~i2;AG(XAIF;mB)gSS?pW{aLi2WAOs2JC)et(Pw6amNhrH zc2jdh=oBV~u^zHIPOrJR>$$e3Q|OFTzt`dN`_AWKpdD_HySCaB@RihfJu_-8o!fQG z7w9KjQ9r#`hn}3u^IeY{_$Y>0CcIe6#RKQcRVi)7!Ip-3_|^Ro&CCj|!)iQ@Nr~Uc zR71}+mdTE>ztEh0$J@7}W6mD^aO%4W|GGN9E`Cn@a#||R^B9@JeCmm$!u$k1Zh~PX z^8HvUKD{VA1@pDc<6|pn%!7tTG822+md?G<_#}a$z^f0rG5vE;7Uq1=?m@c8`fN0x4Z55L9UZr zkhW)kGbTxX3Uy6-erd&YXPI0Isrh_Sl$sxKmSW(GaS_~EhUqa0%dVwdUw=E;2H@&cot$z0FOWM{zdE3F`d7nhdi^kU}LVmc>OIeBIm+Y_qfb-9}= zjClkz-!SLmtSuMow@29wL!$yU&JC>~Gj}S=)VG~EY7D5HMz&w}=sOcog)j8D!r*FY zqsxOw{8Wo1X{l@V;-Vx^wLiE^FB=kDpq0%|b^`8G;vG)iotX{C3PaOir>o$^|)CiJ$8)t=rau!8$j|kBj`D;_GsZ znvP7WKz++S@yqo_V}1}Pt>ZMuPK?eIN7?;z{3$d6kt~!fM-PZpHHm}$1e;125DVw@31rK$j(`@3XUL=2t zNrJ(K&D={%Q%Ye@pMj;8-ut+|&?cIB0+PW<`EJX{UG92VPQa3aoi7x;{$zYzCRx&S zhj)t09lzWrw#Vj{2W-T^R(1h3r^SAiAY#P&W zt*GINw~Rxptp^adNTaHMNv zyI#hM%?lAHqPFl%SVfz6wl%G6U;i90`J5zL@*}yUa_SKGuouoLm6y^B(-nK+oYLSf z(+k%lCOt_jo4v42sgnz316J$dh>^0lZAHAiARLDDJ9s7fCZUj?myr=1Z?m_^-gV6(naW3(K$CX?@Ru0CL>%aRXIn*P*F5i5jV`R9mX+)C8j2blxW1_rc zE;;?=dx%pf+LI_wO`qs0^?SUigddmw;6Ztb?q81Sasmtd3~GehoFABTK7(S9+ERzl zZ|Q7|a9&D~Vh(#gVzOkHv)qFbR=-6*;HOyr$hmn~&dr9WeEjiH9A=+&n`gJH)Mb9^#{J9x_vp8!}%nA{*{>n1;J}$UfaMB&hp`e5lVHa#32K z%gC6S%L@CLyvROAM=*kD1ZHC3PkIqT3o{6jK?#Bo>{TK`i0)5HDNN934ocD&4$6uj z*JcJn;~#wO(6~ugqTA0+PWh#yYC&>FwbSqA-P2}eoE!x9G1zeUO0Yq2Ryloa55|qY zY1Azk1$sM) zxb5f$-JeP2FoqOS7QjX~Nu$<0hlbJIXURo>bb~Q~lNJvo+nYMURps}%9u4>P^g@?Y1rCPXD*i=@!-lKc?A#cwrQ=Kl`-*kHth$ay<^ARa%2e8%O!k#{PTx?OP7n#F{5|xnCowkugl>5 zf~T?;PTSVGKDr`G0xFWpo3ZRXXH8&Am8(+EggJ+|&CK@%5TbCZs31v7Z`4sLcml;_ zxPcI50>r^x6rbb=5T0bgHeB4eqP=Mux#fwJ?fQcr)^cI!`OpzFGI@q(!eQEPU);D$ z24ONB;ZQ%(aA;^#$>)Y|<2L0xJ%K8;>5{HdZR+hmg*FuwQRk)>I9$`IcQ5%4yAGM6 zof)oz`(%bAwQWgL`|&ea`zV2Fwi%Q2IN~O`okUz>yY#B4s*I(_vzr}nRE2{G+_}c- zl6CnkQWu-pg{l}aj0{lX?$334YO0*DBSvSJ>Yk}OM>j>2qPjNMQxm9ic#SLsP_OF_ z1T?6ojB{+_Gb6rfF?%Ut7S{*8biYxx<+e*JBb5nW_fj5ela7M`*rD`voKRHaA6&S+ z#3?3|0sTa4eZ9ldT4@3(6vVx|ZJR-pa$HTh}i|UtKjVI#a#q)O`+xE@_ zrX!a3E|K>}*IfD&R<{iSmd&P()z?b1L(5mXkMZM+N54_D<0-OZ_HW+&rRQN7F?PTaUHk3{5>g9eLo60SFqANN}yL*4pI)nRQM-VYCr4SdfF3vt>#E8Netz~Gz6KKO> zm=(l}sclCOVgC@WO2zowjar~WcJ6R=H`#3CxoAW;gb?A`e*J6rqjGs1^5IO!=i{Am zs=P#;RFr}Xu$TqtYr8yPk;epx@Y3>vC#V=a$tFzk+0C%%qY;_B>}%oQ)}t zvp*SLM>P_YQlg6=S2S+U2U@MpaYoZ0=KCZa2@8G+gqyU_VM%a%9qtYfP30D2BtX6v6TTJvte( zU~sd$3|htp^)yCk3EaXV!%SY7|6J@S{<+agTer(1_B7Y)C=bYq);&6=u>AH4#>&nCn?U@nkFCBQLm%Vo`bW<)Zu18JKgZ?wG97;U3RS?3Yb9*{~_x z7~Nm|hx>1q_m{_Gc>ET5rvEf7GD19k;iT46^V`?2k-w|)j-x4jlc*jUPaOh>XzPBb zd9G66ginyCMptD;&D}2Z%h4a$sL2>Bt*}zM4SBk7HQr056_!FnPF9(e=c+hV-A5iC zhn4fg55|@kC9%Zh3d;^{!G>4XRqib0sa@;wg*0$5gJCP3K8tFI3SN!uNqQ$*FP>xfxKy%KTKh52Jo3{;`Vsb=ZMwcLC6JT4;- zBadty-Y_AIrJj%RGIWPvqj7k$O!`uJ)@Js8R_obk<+eNOD2LBV%>k$wKhCIYH~`G| zOm#Uh20foPsy^WT@Hp5m8-OX;Yh>hTKQT~R;lM#7Ms0u$gk``kgN9)*9yi;{XZ+Hx zms3mmDu4x(o(Pj(E*CDEE3>5ykfsl&9nHmC+*9F@z1LojwfJ<-2-xlI`&OcH?Q4#N ztB4pY;!Dke2)iV_qDE|5g#g#qYYwVwZrIf&H(*&8u$fCM2%hp*I$d~cQV_s}ToJf< z7{RNYFm!3yXdDlqqR}?m$i}qE3T>8Wh~_I3d)xYr7iOVobX}94TD0ZG?sMg|PVn#D zv$1epWIfpN2FpE#_P^JRiSAloqtUeq9HwOQs|n*RYZ@KN!L$_FuC=0L69Rr2D3jlh zITHLsz>*%EEzcI&CPj_~X=7w>+qSK3ebXOS@$PWUGR%xw%;0R}VQ6w`ixWPRpbeEKYo zY!Qg_Tg<4*k!;R0OUbqicD+|u`5i^&_A6oWfZ-7Nk-AuY>=>f*#EE-lN+S9r-8 z+$%3}nnSttE*py!wZ*tN*RpFbf_tJ3PxsKpoA6}y-I$SgG4s~V$_R7Z){>gVu2&7~vDBo11UXU?HOt?N? z$Uixsuc0gKEX}uo3Dxoq8(xsfR(u)V&kxA$Wu|eUlNp$fSI%&$eO|y6#!qotre`|# zV1C+C;$$xTs&X#&U?_l<_6&j_xsgBKT#v5p*s%=T_>Ot}rkxL&?wUpQku^*EoG*>8 zwWm)nODuq|e(oj#xcLd5@!xOxYDP+R3D6LZ(vo_nfAgLc6oWmt`pTh$^ zyy!#BjnimZbNTH7b@&Qgm>rJt!Nw_AdgdKwPF6!Wq(-ac`*9r6o3Y+f3Kb5pAIfPz zuokVvY;RvM4_|PE=eab|XlUxJn1<%LY8_>A$9!FiF^6O{Uh+#88k%Q%N+;fx(dI5+ zUdbid*DhZclbp`1PtuB%)t5VZywiL{+KepJS5A-pT(zvW#tm449VZWkUm}p_Nv(MA z!M|xkW$kVbyl_t_R1qynG(82L8hP{h8Z zcAVJWzGi#4yDP@uLmf@?KGC=|j%5?7@djJAD1;W#mnx~U)4juJVx=Zb<+sIjQHt(P z3(kfJS1^OPAdko|3hODMr!VbGlJV=PcHj#k*EF01OY2pOXHNqEaFQFGjX94~U@C%nJh@xP)-$cAo@qUH zvf~V15S_p|FvWv%KD0FO>n)g*)pVXUNg7DZ4&yEv#xwD(urVb6@<4bBOK-k!rTh%1 zX<6&3HPHvfw(e%ru??5FlrZpvu-XRyPmHo7(uh-w+5In#$Fk--YkeiM7hr}OrjAScFf%`ollfq zl)DN9<+@pO)9ob7(|9>K`gMw$?w9;nh0#mk{p5rMA6A~jRVGIa&L<-Q2X07DL!v0t zNYv7icNV9D`^sb{ZKF_i995D3l-sCdEe&$l9~HTqcbFEGZyqMnmr%TljcSH5ej!*}sJHf+M!+^)X3eKo#M zz=SeSBl%wP8=*hkYv$zZ@KSbv^L#iI9C^Uo9mYTT?c8B}V}bE*LZ-CHczdXa_Tr-p zd`1UjT`zs&r0`U}FncAwEV_uV>QjTkT}Sm&TXUI>)!m7|)AWl*o#TnDBP{|B9GU%KYd{HUl4vm^+#*tT_3# z6Mgg*9$;I~83_0Lb~TSH@54uokB~KsedoMhuQfZKr5pR)Le*PyvIcjOZ*J*fNz0b74w*Kp+l~@^NcJb}p#S_tHH_Pb5 za$DC)@pbna=T1rZ7!eycydXe-_OCH&Dt+CE%Khk1JNKvE?#5O?$M+M6lyFAjly7Qe zsz|2j<(Ew1rR`$m!92*6JZVKm54IgVg7=>GD(nx9oS73s>zfyaPT#19&I}J7kcXM; zPPH9a7w%0AxlZ+!w%{tG=5={SrDX+5JX1^X5Y&1=^vjQdZzZDEX*lS^S9bO^*A#pJ zfR8p1A`Li?8GxT+`6FXFtZ-}`s`ROZ;A?0CY^Q@?9C3e5^ z$3Cw&$!hhSN`H}{E&McDsnDLczn$Qifs?SZ5v88$ix1$l8XOpu;1zPU!(USEnC9`8 zJmU1quUZ?ef6T=b9wlN~dn*%RAnvqjtJ;hNBv< z<#c?~f-hNN9X#%;+M$Vc6*+B9OWHOpXkXRTzUcY36Du-YHQ^R?vcpT12QZQFiLM^d eU&wIdOKJXy_r*?~GQG}Hgb5`+SDmx5@BabM@lxji literal 22430 zcmZ{K34ByV5_iqad!XR0pd67G&H?2RFTBZ}NkWK8fC$DoNrq$~nF%u)5q5DQiO78@ zhYAAWK19ML_o1WftrORC-2==8tLu8K_p0B&tKQ2@{Jt;zn16S5*L&5~)m7EqkH|)( z|3YLZ>ePwIfzmZZn$&aw&{bP!feVOiXNWG8S{H$?0v8EfEO3dyr2>};TrO~hz?A}5 z33L__sZ|R2 z1pEw&hpLFC0cH>dq%9~=Ef5lTNMJex^F1uDh2hSWwm%5`QDBz9BLaV7V7}SHcQ*so z2-FJH2|P+PH_Gss5a$uij}jLUE#w+45?Cy-L|`cczi*kaFDH6DN_>Keof?Q%Mv1G0 z2&Fs;g`6dN3b32#X?f4f11*Jj}gB`-He(;DEqEf#(GdF)+hnq9Z~)8YLbh zIxfT$0w<$wr-)8RYcI%aUnB}cq*sYvBI*L`dYP!}Bx(Dzz$*-0Yl&WCcGXKs@P@#f z(PzFT3~v*?6D3B7u=W(gy8?d^cu(Mcfe!>e6!?gNhxswlU!%28i2f#B{x0wjh`UQ( z`%i&03?R~{7}z4g{{2M;xI-)NCou%zRL|?YE z(^o`aM{Ahv|3+)y3d46q-!qYZh_?Mm^i#Ch(b|1vn<#vf+KHxQwnDN!AZ<mFlo^js>iti7ii*y9+=5$P%M&$fbWE2ZZufz{};n`}=? z?J0q$1=a|x6?g_cw~%d})Yc1Z5U3Z}D6mOjGs9)D`OCq&RfyXJwhQbK*eS3}K;j?d zrz;xC_M8y+Fesv}K}NJ!U?17`OBacM+~uIOJuh%b;4oeBsq{Q5a7^Gh1M{6A+sSC{ z6xmKomlp(H6bK8vB=9l=v;UcFuS9FFl1<{D?e!?}4Uy$dvb`njZ%5nSk+ulKRU4)D zuE1Xe-V=CV-~)jV1wIn^Sm3V$p9uU-;O_$e5HRE4gJe4^vY6^=l3KGsi$JSDo4`4N z^8)`8_)Oq)0mMHj#rB23e*`4{*}jsR#6R0NQj_>+`&Me-2}u02{UEg;1%49vS>S&H zzX<#)Ao0&mT(jE*P=!c#hkz!a3&65eTW5g_1TGZlBG6UfB7utqE)lp?;4%Riyn5Ib z0#^!LCD2WvyMV+$bY_Mg0zI)oeS_@1q}E#?PT*RBJ_3e7yg*-pegggRl-Jc`$v%MW z1BEz9z$q|TU>^Delq`-{=694Eysof%g_-FT$ zeH0*r?C=G4*$3Ef7s>7*`<>GBE{1M@l-fP$nMC%{QcDm>Waw_rSTee#kv&D)QaiMz z3(+OSkENCghKXd)0_2c=j1aR0#xhuMzZYF5kUbZWPgi>Yc?@b&$Duafs;M?bED*S_ z!&4@qXEE9D2NaRLP`W(Op^K?3cL!n#7$%dwR2bw9)}YITSl)qQ3K-^-eJWrk*((4+ zvR4AC$nFycKZEs@X+jJL(Ns@07^agwByA6MV0c)FGZ-u_{Q(R$WXFuz|3vm#(&dp3 zU1ke$P6uKw80M0_PTC%2uq1m-i1RuS7l2_E*%tyHC;KA6QnD|Wo=X@kktF`vm&X!$ z1w29a6~eHR!FnI!pM4$Kp9HKS`%}_I;@{O@OKq*dGYr;?5dZ8O$-Y6_>N~V;65{3# z#H~Wy#=s(NC;JW|?iAQ1@T|aYf#(GF2s8-n71$>r@y~uhY6k_L7dRwvSm20K3| z7}<{t@r1xhhHGTvxXWp>zraMUy(sH8O!k+e#FvFA`#<|DWPep2_F8)v#cLY-o9#sV zTV#J*dcGqN5oi>6SKu!K?=i3t@00z5Xiegu{Ufr&k{w@>{jZoD*^k*J{@Eq|*(Ltj z|3UVDqDzxVeTM93@8AjW$0n9j&njh&(QMNvi~5p9~pX?F+k#< z{eMC{CS88TYjv{!2C%D>PBlh{jiI-=LkFmes4)k1A$Dbm z8!5Gm!O)u=mjJqv<5IvCFW1w^y#9%#hun>nZ#LH|t zt_QrH}q%EJp8iT3w2~4z}c^?=aB*#QRAvq=q-~9}h zNDm0Hh{1Z8TZqLB{T`QEDV{Qw9Iy#TIXNZ^v5dju^9peagSn0z6=3j_qf**@4Az8K z32~Y*Tp_g}81|8)8t?=;u)-a6UdN>N2pHy& z<4;nX-Jz{Uh_wvX!g~}9i^wq-FrOTcNf(KKmMtw1;zEZ0c!OHLi@~sr9809OlwrV7 zsVx@}MOwraVAw>Cm4LP6SOs{B9IK`0lMI$xpBCa825aJ;0mBAztdq9&3xd(GDT*WU$owEEx8XW4E+D$6!6PL5O=h5ch-OU2+@% zgvoIbaGV^^1CEg6kT4wXz;INEGGmr{PJrPwIZjI3sSXS;2=PS*%iFvJhBwIZGT>Em z{8_rZ!Z7d&shMl@b>TZN#5ck44msYE+S?4)Oh<&+$Y2fnFJSnT9Pa@>A;k+Q`uw7t9ZCFi z$cQWreg=jw$nm)_{F}kD9>hOoC|`DX%GbDr`;Hvn0I))Ympb!T!m@!-% z42BV;4FL=#?KeiWT^l{khDrb6=^={ z;%B&St<o+#H4J${#gR~z3 zy-E8Ca4~5=0}$i>hiCpq+AqTXD}%X{(q(n%693G7qwWA-7t%FAXVTFJuhly-m|D^$ z{^=JA5yMnnx(ZyxV7egv56ZeoAYJ00et8GJD~0bW26Gzq?qKLaI^v&t^fe5o zwdy^E*o(muDGm(RlYT8=0O@@IeMvW@XFP-T=zc=%&tPUO`am!YCVh~!iJ!OLH$;fn zF_`nG!?Wl&kvTDl}K40~K^Ndn0X)}vFw;37Ru+R_;;IWvTq$zX2v^f6#4 zAUzv!FX>~YOAdpjf?TwXBRx;r@)@l6jThpC4h;8!;eOI5O4}rc;V((8P~ZUub8+bp zg27L^8&FO<;-Bszy+nGJcIY`-h-Dp!UNBUUK1JH5GFZY_3enerSOtdZq)!7>lOB*R zK?XDX)k8vjh{5#U`om!O1L-rQZ6<^13-mt9YarNuL8)MtTikKIyf9 zxun+#-=hqc)Q<^q9)qQ&1z=cA`a)@w_-C2h5+N>Su*6*sh9^mfz33}Re?q!Q{Ik}> zDj}|BFi$e{r@*k5^rxk54TCk|&j@i{2jT`W>><4#u$}acfGwnNlAfCxOb@MZ72-Aq z)8*+q!0;^TJEd(GgEg?-LVQk$=2~e0!y(f50uGSAPrB^yz;{rH&ofxU9|prQ(vL{n zQ3f+%)sGAD1cRl)Q(*W9>8Anjkp2STRnlJsyi9sn7{snEEBLbzUtt(wTI6eBc$4(k zrR@y{Yf-)>#J3qNIU`{Bkn~2td!)ZBUH-yg>E(SPe!yUj;Uh47Li)$j_E!c=h`$N( z?+oUqLjNZiz99V!ppEpifM(J^m7Yxumhnma(_5Kn$$1V8pOJoE82-gz$?~}n|J{M% zKVbNd^e+M5kp7i)`MLw2#6SI8Cf*>?LjN8NKau`}F#O11X#(+2#g6|8gD4pU(tlNS z(tl$>N!2>p1ndG1>ZEZ4x9LJew~l{jlS{nSGd|5I^Z0%4N>7ouH0-QRNm1qC*+h>o zEz$q*WPhOatgFQDtM>XlzUrpr5`U>DF=d?5Ib0OD-spZVvDA~A5(@aM+(w)fJc*v5 zk)Aj?VBDKH#XYvEc6(Fp@uu3{O|`X6waZhgs)r`#qCF7GimZ(6Yn&Z9895bcNSRqa zG$}i^_1SH$2lllYHlvd<*tjvR#2@li2WB+kea@TLr+b6`B9LukyT=qDhx7t%`WO{vNrT$8zATt*o{RYUTexoom*FVD@s`Ly+-6+m# zs@dFB^ITKy&Ze3pM#%WWn00^T@yNl*vB=@bQ3$vfVjga+i8Mq`0GAqzQ_n5j+p^|F zdWFBlUG4Szn#a0JNM0-XI>VZGRrq~nLOKO|P=Bs! zFEl^X@AHgdEqaD$`F*8+Uuu;eXtQIO$MC5$0}w`L@u;!zck5$fwxd?Wwn2H%9l zOrv`frf-5LSZySF0#k$KUUZsOXpgLh0I-zE0f@0Ma>R%%j~s+lM;qrsrrE~gtaDpV zH6P#8^60|zwe>B=;3ngy#DqL0Qs6q)MM^@@>+uyKQ^U=59-d$Bt*j~!#qU%WaMAE_@h|ao=ZGr9Sri1GCg?B^q>A8MYR)faU+{H_CT~qBs9y%H;!#foVW_&|qZR9u=0{(|**gCfwwof6Ob3z}Zdz+DxDi&?T z^)G|rsY(EgwXlD+T6fAV>~E@_k6$AM(yXk=8mzYym}LAa7hr5McClvaOO;|=FEnP~ z@zyO+%&9}~Pktxi>nr2y;+MqlWYhDU#mtP$V@)KD%S$lg#+Ys(uNtNoGzzj)u&he` zLGc3+BQrc7O+n=cf@&qe4r=S!5$tMNHt$^hT%Nc7|21Z%M(QKmBg-&dZ6}w2+BeCj z_07d#`%mg9rz5_o|Ni)C{ZEQy{om@FG$7&s(XY$@r=L>Z;A^KC-CK;5j4ZEjYWVpo zcrhbxz-FTm|BDNhd}^^CYO2}BGq{4Q4aQ$=tF*X(RLvR`CUM&f+tSJO!HQdl+V zc_ro3J*8?Xq~=MXAT=-KDZ#`Sq7dF*3iBv{Gia*WYQ5qyyuvc$H1ye_dSkk_NA_VE zT5h3j`MQ=z56gUIsredn^Z1JY_K8=9Jp7K+J#YE+v-r9k)79lw`%9*l`ztENn6H04 z-;^_1($YKuSndp%b3%njEW6N^P@&3YJ{A~u1V>(5cYgM!^EF#z zJekQ+4vBLjPq5oK9^=egP98ERRGE?U=Uv9W1c>md5jQTpO8MQg@blFyMUwKqGmOFs zN&d>}@D8JNP{$6<;&!qV@SLK+P*!(lHi9UEYQQ@cL2?Xg)#XNls+VAG<|b5zcW|-P zQ(>q^k5PE95T}JaMrlY9OR-#A7OjpoPa|aZ!c!2^gj4y+dIT;tC$q7P8W61D$BuJV z#WH0hco0mO9a{gl#OpZDsmV$_W4yFxOA{vRbU`%=c|XM0jWs15o>UHb%lz>>ja}vn z@6%(m(Y@73$xJGT+bb(6e|Z;7%9T{^R+SJOp_3-Sxt?EnsP)M$Er)BATiM28}g+^m=-!tM~d+mJ(i#REpRhNR7`k*u?Z88efPa#t<+3=aWd1)#t-09Qs z)G9t7F%~=NM2y2o`Et{TUGAEu46rDF`wRK6&5f_iWKWvz4itNR@jIRLxLV6<>ib-I z6<$7aB+q?jhPT4&GxEwkSbU39Tb9ko;%bdb+T-I<=$w--lblnI-c?wrYFTAQYj8TQ zRMmumz~4A+lXwBIY^vGB%UCVl7)y29yvD5D$YvxSD)~5te}`4P!?c}Sy07Kr!j|Vw z%IIdO85_c}fz;?8n9XHtbYtM;E8OvGkwT>0c+-fHH(;Q)JM#jbD!5;yavf5M{t;te z{|}7r{Xa>ro>ApVuY|zW?!XLlqI)+SHysE3kh>}rz%1u+(T~_%;Ixl43M~Q}5&Php zl!JPm#Sdsmhu~P_yh~BQ&RShi*HncobAJuU0hGWoh9#RRX zeYlJoPP6=;Zy!vUe{1F|YSj0A8LRv&7tfGzETN+lh zu6#$l6 zMxB(aWiwLah3#obpZ%9XHwokTeHjU%AVP8lztLq?@J^@WBTS7&z`8+%L+n6Wa-^wt z9w&WxJF*^mLb$#{dG%bljD3xB8f!S|gB_}rH>>sJe#p==ZwC?pnT)G28K)D^`Mt?y zqts*+U;E`p$&st#>+-BOx`(&xnr9^W#t|b%U``xIttDq1dlz}%cvlkVed*)9CDr}_ zgb1Nn9p0~sQ2*mFm!nwVCm|7}Iotn^vl*Ow%qVdOt8Jal8O}`!bI#$)Lr#|L^_2NB z!`dg%1AYqCkFw2!$~J2sQ!B7$dsEE;Ofp(#-3y~ciaRv20xvrV+dRoLJ7}WOc~B9n zc@Q=hgB~&p*oS-Emg6oQw8khNw8sbydcl}A=zU}HpdZ+mS*r>gmE7n?#Xv5CWCUKK zf3s15%)-h+R8E2%1e=j)4q}9oQpP11vjz+|77rK|pVSgRM)IK154?Kdwt~x`_0xqZ zKetsZOwOqER0m{xw9#>!ngaw~f4E#Lbul{Q+wd?kze3V@gWk zQD$bskg)L+`^`wQYRa5C4Mg(ZPLV7Ds|6+nhlU*l%F2ja4y`jnncNRk$O&aWTy%r- zX^nL}i`GU;t@%UN3N2XDpIvY27;iDS|WQv<*X^ z8gcRxrHBVs49d-a5aW7hqvOW-I;Z|mbG)N&y!j>-x2)k794o?bCt$d(MqI`OH})95 zGWEU!XXnmFVIJp%29ltdCY8|dG5wlaIs4TZu~HsKjKu~-IWtqn#aS(jm$a=}bH4r* z`XD2)LR)XoOL%QY4r@6j!(F8|4$jVxVCR5Jcs~NBqC$@1)YjEolxqobi`p?{MfM;T zsMMHOqqFncm>`$%;gK^B{+h1Vp!?w-IX7N=dwgAnY#01fXCP)fJ6FaE;z)oXnX*I7 z&h=D}*yUdVF6>rq*pv=XA2DU8Zb;wI*J{8bg6 zK|!TPrR);JKiQDvrl253wK@K(P=z~SHX(mHXcQx#ftV`Ianc)Rdedb2frQy2541GV z6m6&T!tqgI!o6O~g*55dSHlmbr{f4>D*hvat0HC@KLySUe}j9(PjTw`txvTchA&e! z=;aAEIdujC1INp|bc@l;E#@2X^7|L;JiO)YNmd+I&n{BWhH5Tsf_HXm?-+xfdVgaR z+>R_?6+K3ezJKKF6Sh6Ze$4g78$WkD$jcZ0E4qB)u2lA-+?BJFj-jbtp-R_=|F{7| z%a*NgIx^tto-*FmsG=J?g)|gGo-(!XMd_jN_A(BEwM&$zvi3ICuEyD=Nrjqc*eH=e zBLc`-PwS$cE!*eBj2rg}>Q61V{${Z*)7;dI4OXc2*5zc(6ljlp2{~O^VwQQt z&e?T3G>@OcG(`&Us^I8^lPJXI9V#@{?vfN2eJ~YIMhrOGkJi|#Z< z9njpaA7@uiQ-+xXts6Kae&>MZ*omtA2180Thm`0p$1#WU(H9#?-&8fc1NA~Kdcu3) zN02Zs;|v$6E>1aB!idh8t>qZOqZq?MxD}*}sV#>NVEfQ6O8My9qw02z<}%dHKHGdR z266GFG5Wst)rk-;S28{v=>&taF-}!Qm0+fz04x*&bnQ~-E9#U030_)m_$YTnB-sEH zpVK%;%-hv`st#v6t*iFLC$+nk?5J?}nMFwRtSOBgJ>{6Y^&GM5lpKErFFqij_@$xX zSFyj4OV%D;HUxaySUW#v=aY`^;RBp2WJT7);i#xTPiD#98%9&rdZnRo^_p#t(CV0Hz_3&7xji)7g5Eet&OlKx~Jr(`{%1ZvM zL~nQps%iyb3^*Bkilyg+&6-0onjgb_L)%wDjygU@J_>leyC}8Ot$_@%n;OF_g;|#>~U8|DH1EA!#BHXIwsxu{2PFl`3jtmcf!fa!Nz%5)i~r)r#>4{ zouhWwk-g?U2A0y;*2PfD!gjsH7+d-obCk}DzK{CToPfJ5qzvuy*qp-l>z^@KE=eFK zx^SytI9-^k%8mmZjI(xbEV$nlPzjhbW_aiyuCGKsIoK#Hw97Mc!#g-VQU_mNejXoz zc?KKBg&LpjiDhEDY=z0%4ef(5Lihjf`5V>q)#(^skNhbeYmTomjKu}b#}~A&U9Ems z;mV+){UI?L8O;hoKy+R{$U0WZ_aG*yL!&Ehjj`P>3(BAmY}8bal{Rjw3LENh;mQK! zAmd8Fp^Q~k)v+qhRQGU%$64iq_7`Kvi=J3wYK3J-HetW3WK}y0b!gXoWD!ps++e$x zPM^&ZLclBgK%^_vOp!XAm}k1LTKe%Xx59~>)|dX;P`xc6=hDWm7>n)l^Bbncrb~QD z9fy;i0AgQSdPtSv<ifD!&VuD{iTB8S1D<9W2BQhdFuwp3RqOYKO$TcXfEO zXkOd=r*M`Kqwci!(OmLU)LkToO5Ihs48r)Xy5Lil`^B)N7fgF_WyQtHLH14it>E^& zBhi#)yt_0sGiHbb$L=+Um?Ad>X?fUyi62J^alIfdC0OMS@5NMci6a)a<4DJzX5&M2 z=LVlTNJc`Y)|c8bn1K}cPi;$gV_Y#)lx*2h`RU8dA_nqVj9guZ%{Jvq#6cJA$CVhW zfW}#}bhE7X-raEgZ`H-u;erWiENi|)l;J0Y>&>&1b?7+mY>=i5cZ#ZfetS`*P8l5iP~+_VA-uCu!z;#wPaZRvGb*7@S*((=Q{15-U- zT$<#EP*5uZg=t7$mBDb)^wBsTfS|EH+H8i|WJNZrBSh=Q#MQEP{khrb8Y^qkV~aPv zc=Iy!ziz zY(l77CCX6jq>d+oze`xs!*kTpqWGlfsUUBRTrFF+w5)CT-74PMp0fQ$r_FYpKYZL?9Aa0g?fRL8ug}6Ae ziA&4!NC|hG;oYi;(;RN)3wA70NQ-@EtW`LB6sWt4HE{BL@&Lzp{@4;F;I3H5IQn1h zDorqp<`qVw#~TPK*VyC67*iPh{mZ5)WQ$TWv%R?P;~g2IQf9WNx?F0=r{Ky}TBsIV zj(bLMXd-SY)FCOHxy0Jp)?&-faff#Yaf_Ph_CAa&)LHr1D<4Msr>>fiNU2m%T~wr= zQ#nS5bbU0bKV{EXa|t_3>k=@bQeCj&eoT$x{a8IuQrpW+^FSvvG#xk22&p}vg+1V> zFfG$R9eXfbBV$X6lezYr%6Zs>p#xUh(@1{QM*c`+4OH8 zva~Z&G*v4vgit-##0X_u`T>N(&9ZXTWAfagQt!}&fV-GoSQgg}uET1x%>q-aq2RI7 z(+Il#;KMziT6+gsa`ou}EBpx*EQO_SS{-@j*npohuiOfu_#xFwk7@40oy8G4~o_+K|e|i+;|+Ky$4~>A_VQ zZ|?F`NiE6VH>tZ~rt_KgFRoh%~C$>UEfqY*P0KP>Ti0N9301}%ZLL} z|B~8vbZhJCt?lYAAAJuin(aQ(ESkr%36;3ORwFuw5%GsAseFAjgbgb-VX|BnbD;$4 zP7BWg2_?8e6gVQvMFGCtfy>7Inlp}VepzE3#4@jXQ_nxMuKmU+{_Xdmuq@eN724sO zW?(xa=F9t%Wc<1--T2_fI|b*!%6rYgy9H@uVT#of^RD@dkM0i9Fq{l%5!^5)r=wdWF+9g4fQFg6l9u} z8GPiOCAILLQq{=YD2R@uDvqCO8+Ev;R_*#@GI#3qVmr1jVi|r;D!=SF&PssxBst<3B9auzSJ=At%$Xw$-;_LA3O0k zU+oj@>{fzwzt?xxapisZF7YAuX7LAOR+_WZD08JH%iV)38DFM(D%}Abe556Nd|WDU zCF8>g6ibvtPDZ}PWc5v=`r@dm79XeKwtA1{gPncnDlf4j#_i(Mx${S3-ENkt!)ea0 zN%3{}n&(bQ_(BpJH(U@vpM58plB!rYZ0cU<(ZBEd?r+)uJnlVR71$q|Ewjc%);2DVoVebIoE#e2rw%jM9BM*i#c8pkwmtXd6&(|81 zSluS`Uo>fJf148O*siz!GsgWePQprumG~>qPr_F_D!x~S4U#UCho$P-W> ziPqbH--?fN+gmqe7KgkQrA3}9e@VG!_e@%H%a~GkwY%6I^c1NNQ!>*$epk-Op-K2~ zIkVIgEP<0(pWl9p&y@>@NTZ<|jePa}XtK#`I48TOdJMB&J@I-2(ixtI-IchOGw?+V zzPE*U@cSxe3{IR`KDMP{Y0J8Wtt%T^7eCi>^oa~_Rr?4!xez7FLNFwJ@rsXyU&!#` an`rqi_r*?~G6S9xqzOeq?@Uj9@Bafz;CX8R diff --git a/tests/gis_tests/data/geoip2/GeoIP2-Country-Test.mmdb b/tests/gis_tests/data/geoip2/GeoIP2-Country-Test.mmdb index d79c9933bb986e1ea01c7a6faebde862f1c1d4a7..a5989654ebd25f3e9d4c043692cd1e0e66915aac 100644 GIT binary patch literal 19744 zcmZXa2Ygh;_Q%iNy>~&H2w1V)&zpsu|x_WGU}l7QW(KK0rDznR~?*^Phw!1vCXIaAM^Gc${bA>!LB;sKr$@#3pW z#AM1Md_)VPC5l`pauQRmh}J|KqAk&mIGJcqoI-RUIuf0TQ;E}v(}^>PGl{c^&cxZo zImEfdd4x?Q5nYI`L^q;4(StajNG5s`7Z4W`y@=jKAL1h7V&W3wQsOeAFL60>1#u;D z6>&9j4RI}jc~+}(J&{7(K-@^A5@|#_(T~U=GKnlAoA49;i5w!A7(fgp1`&gao3Q*C ze;!jqh@r$V;%4F&VmNUtF@ne^ZX-q#w-W`#9YjFHz#5Jckp&`!z!Z@p<^_?uS7bC( z#YmOt`BHNhqHv6c63AGcC#6IgQBG8dRK`o*Nnuzd5*Jp9RI|=;#CT!?F;PP|G>PhW ziQF9*-lK)Sw?*!Y3nx?f92IIrYIUC6A20HN$W#g+j0>kxVLCBGWG0KuiWiwJGKa#s z#5`g?@euK_MoUNi5zMtEvJjJXL}U^0gvg`1h#uHtw)dFG5~?qa=RGd6ES_2}vLc>Z zNxfCXYLPWmUmGv7j(O{e4I&$L-bve7a#OtIlOmhZv%M_&6tP8QYrF`Qwo`8hu``~x zOXO(^cN2S>@>>1P%JvcaMGiFO$w84rR5(mL6VH2A1O}$2C`vpZ&wGKDy(sb$^Ij%i zAzme3BVH%oAl@Y2B4QfoqplEkB;Sg>!_>PPdX3%_d7r`$h!2U6h>wX+G_=B}BA-$C zuek8vBA-)ul=vc^S0{2To~q~g8blh=rLRSfi?j}ioY2rMe90nTX{fw!w7U9I`QH)W z$Lsuo3jY!LF)sW`}N1RNwCr%+ch|w{w&`FF_r!J-5Wn%QD-sSPUE5x{x!mEg@iED^!HQM~Z z)b$#AT2sWh0b}rsabsMV%7)U2bfO=TL1YqHM7D;Sm;R`1kQg~^D3=&OF#f4#@kh5l zSd5#Pmq!eV=M5EO7=EKy375#>Y$QAyC2j4)FXqKc?S)pv<8j;Zm) z1Y#mFNh4v-@M+xBBsA{j`0f*9G8Lu}HAHQ^4@cir5lY*eb?03b)6F zJE*sl*d=Yb4UOF_xrf+G>?8IQ2Z)0Ne5L_As` z#>-;7f`QeE@hVHcM!epnV7wv5oAK0JY#~M*A>Jn5A>Jk46XX53-UniQ7*Bn~A|H$K zNnH4;7@x&c{}KbSPp!k}#8LF~3$54oOKJNZg~y0`q5(yI5~GnR#6P8eg7}j7N<+zse~1H~Gvj$@iKjCa82>!yFm*0*Uc96&o+Jvp#D!hi zY&Y?AXI>BDd?K0XNnAi&Nc7TZSFE9j*@u-~L|jZq@h z1L8yCBjRJ?6XH|iGvZ&wzlqO@qr?|P9dV4PCmM)G;y7`F_>%aF_?q~J_?GyN_@4NI z_z&?T@e}bg@n7N>;#cA~;(x^N#2>_;#9tb?(W!Ot3T)mhUPD`}*P{WsvU{&dSQKIb zl&}R9P7`lSppAG>qOcXwTEp2L-nJ;xQM~Pd_M&cQ-jg*{EvF#W!A&_gH*Y7_a%!_$ zPDjae#d`+OS-fYm$XU&boK4|5&4lMcp^JEJ<|S#k1M5m*w`K}GppYTn^MNbGn+#ke z-kv}&@m@fM3!Bx_o5DU6I@5D86fP6*CCt0DnL=L*FV}Eq=}IW1i1#YsTJc`ZBG)u4 zavg=&Hxu3fg*5Tr$h=eycYNs-_G>20ghHNpvw(r(%?5JB>u1US8g7?zDIAa}#G;9J zka!0(?N_DE#e)JTkJkH$cLVeq#k&!BS-ejGd&Rp6*e>2D zfi2?QOogYYKAowp#5Ro%EtuK?g{Q^4lc`%`P6vt^ByLi(Qrqr*6#)JMw$1#Mn}gqUZn6P3Y~^tfx?I4eHAz&-q(OP#rrx-zM;{{ zV#@I^F$xz`_%;;Y6Yo1ry{mERRZP84d_duUnED6`pNscn;4|@lLgA+xr+vm0;-4Dd zzco&AR^=!Zj*0gR=GAGO>eN|JVS~o$+~MBiSjN`kJpsKx#QP=igLuCJz7_A+RQQGp z&c6MQ!tXWQg+mM8pT+wl^M2BB=M(GT{Y|{TFz;6lce4IR;qT29{zR8d@gn}2hIs$h zd8TNb&ely2gx6V_caJHDI0cVPNI*Xj4;modi7KNQP+{(_O@LY{EDwwiS%lTp^0o}yx zLSa`8SFbyTJv2_?J~ES`aG{tznRkJPv*2bg3VTz57Ghomg>o@31_p_V_-EcI=B2>Z zVqOMZA!c9dU9NEk)&X{AUP;hsJ3PSDHBh)-%xjstPQ%Shq3{L`XXBZOe`dCrX+VaU z=`7NZdR#Fxlfo>GGg~v|heEEH{h7*P-b|(j5CfYD2ScGiOvFEPxR`msFfoU)+B zv0{dpH%7y)vy{TJW7qf;%YBkP6AW|0M*u+$wawl>c6lRL)SnCX(=Xecs z7WHOR=%~+y!ZI=E0gJ?(4=fP#A(ni&SxKkag<9yuD)Uh&ED>`t6&`D*u$02bH99-n za5)s#iMaw;E#^uVS*79bqcs$+)o^EUJrtf0a|81>YPf^mMB$SfZY_v^)^;(s0N7(& zq5h+o+klvu+kt1r+yU$pb0@G{%w4SIX${xu?4fY4M&|`g?T5l4F%K|xP~&X+0`oA1 z&uF+_<2fk2B4!kLQOxIAd7n4S`+~wc z3LVR;hr-ulHUKBYY-Ew+8l4<_`I5q~G+dwc4HUi?^IPV9r_s@=^9Kt5qv5X6PgvrP zV*U)6Vq)sdKgIk7_@9`+QsFlZcO(2x;U60A`2K>rA?Dv&XbBbAtmUE5tKrPGg)&wf zv3$TuVzpqAmKsjatX34Z);MQ4Q*EKpUaWRZovh)E-8zNB4jPVMvN}QGe6daiY_U!Q z&JpW$;4HDupu(9NZnK>!JiA#f=TdlHvyw@urJGn?nAcU~9GaWeox&a(ZeNn2aFJL& zfnH+K=B*2Lk#p$|t=`n@qv6c1bukn!6YCP@U8>=1ZL2SZmuontZ(Rw6h*(zvL&drp z$Pf$h&q@{RS|CNN>!^3VhTG5$6yC_nob^kiFr9GXpOcq~$_9v)1@spyn??K@=fQcv z(^@%1u7(pytbtItNvuK48?51YMJtcOAsUX=S;L@EB-YKqNU?4KMu_Fu#I01P+qUwl zew&7~->uuB5D=??d3R{IlQoLM!e+uC6iUS!4TQuhW|0yWamGG|!m%1|LuF8?6sw$h z70ndxq%f@Enp+hV9u}(_xL>Ssz&&D(2PTO%feI6wDcnWj-5RcC-3x^&V%^8Q$r{f2 z)2gAcR>MwZ3S+Qli8U3NF4lt-PSbF=(+mn{YPjY$8w&Hpn!~)g8m{%sr|=;S#~oS= zps-r3M}VbbEd&;ewTLAj)o`M=#rS6}(L#4%h=0}!v6fL`xrXaQ82_wQRB(I<;-9ri zthK-fvDQ&uKN>v33K8#M%Sw7i%xo_h~pcDeC}*jDH@-q#$>VH%CxrTGru)csoy;yb3JEq~b*Fa&ThHDcipzys| zUjpBV^%aYJt>N14w-kP-;kNz*6n+xxKg|14!=1sODg3X7>luDUsrV|ERjbMRTf-+BPSrjSQkM9<%riBde)>=pdOq6j=|3@b63|I}tpNN} zm(~=v(Qu}~*A6NCQ%rHS+aE3P1H-&b%v_$NBVKMd8&Ha&3LrA~i{T*8%zByB^3DUkZSK z&T<2gCcYa1tO{MF+v{`+`)Rmi&qT^EzAWZ3{yFC6>rY{hhTGi%NDUR=K;S0v4Pp_- zKW9Jq@+cglar$Vch5^IHcQaGBFz;5T9E@ltybUS*v&@k|k@#*00^%#sMSOQ?I3C(J zio!w-$L0BgNa0_6I;|J$Ja=FrDvZ%^2UdzyM0{mHrTEHOq(Z~hyOYAOhHI@=NR1a? zHS@-4I0shW1PUi=xDDNf6n;s&8<;7+djR}%mU{s_b>0VH;U;T1M+aXGg|!-89$-oV z|I~9TQx9smn{qmZGc??O&O!>$nX`d;;+w-Fb2Z%Y&8P4o3Y~@)Acd#SN0_%z!|lYQ z6fV|qE)~8dNIfCGrNC`D*j+kq7R`OHo#?4p9RVu*jLyL&Vee$)5u zQ*!a`Ck_w?i9^I;@jXLzRq|O1@!9;pI)7nBc~z)9SYB1vudt#hn3gfDe{ry)JWv)a z2o*&O!o4!ocjS0lQ7|*3I$Tj1NDG$pE0`9H*uB$6hwUrV#smh{)o!S(Jy2J>xvsXh zu6BM#WmWIAJmiO~b7POhwjY@sI}|${+nO<{q<8wj%!Vh|H|*S=RajA7UKO5LXLpJw zU%os$6saiC-N;I_yB@bMxaHE8bMh)C2CB<~y^*%FbL(o>)YUvySNlX=&0ag-e$6htE%s1sS8RW5 zPi!ChwGF-7bEGD=HFgl3YezDV&)inOum+tB@bhS^bbwfjuf>3!u zP)$iNP+m}79;zreTG(^bGV^rT`)7s&XFI538$vq^@>j zUF{C^tNwv)^$*QLqjtV76Srygt65c7yHd~BCOh9Lg<3GR)GQq7iLJy0ZjbFk{|?5sV$x#sVh40m&FNM<;zvb| zhvs0J?a69^3xY>6J;R3R&ZZ9=l8R0`t2m@8pjJ3#U`C`WP*f4&GDfhD(do#FsAY_( z`AX@J~WoTbzudX_HK4QHfALcwyoZ$A*z z(&cwMU3~`aY`?0#W)J?h^E0ATRCZxD2DRIn`D6PYYZ^<(bI!t8(uV3PGt)|{s{*LA zYo?u&nO0pDU0H6YBaxj~SG!Pcikib%KO79|ec9%|eewQA0VV7&{ zNSBfJJE$AbxLkcBcE zRq4W9SdFq`cYig`UsnIX9xg+#hlV=s_G7y_{esn1k;0PFKzWhfH!CX`#+*;YLZp@k zxhCoU)Kc|bT&_D%J6*Y++WSvTUVWlwUBVW3G)mBe!Lf(+wmFdCe(DeH<}UB@1vgLU zZEwNg(g*6{XQY>e%CW~s3=URQmIlv{*m=Rq>QSYkLc3zL&CHbHkVW??VZa_-QCVFY z2s>HnS|9y`&282u*?qUN#>X5VxYv$!|2xUZ;0FAe zDhoq|2k0?fEhPM8&1&V3Y8PM?6XvnUBD*jzwg!G&`SQc~e-E7HOn9H;bGO$YnpywU zp(MMsTnphdkEP6kd(`56R~ zP1@DKXCnji@-SvY#kQ@n{mRcAnT-0E#uqYrcJO)B-+wTzs(+wTd9h?^3pa*DbO+p6 z20kjvVJi)b);27C($3d8%6;X=wqUvsxsD`RE=28rB-ZXtMeR9^hXWlG9c$-Qgo7~N zoFNs}2vAI=3{6+kUdoVNqs10Z9{_Q5qmE8Psu7%W>({J5vHanNt@E|r-mJ4j|Iovp z8Wwvh_Ou(99*Z5q9PH9@{lxN(&`h$EWkflY?aau z9beHcDkD3ye(u(Wy@%}lWR!qQU4;qW3ooML^ej7)Y+Q*33^SpD&d=wef$SXJKz4RT zdGT2MvHSYfC*}Zur6e0u>~!^4cIJt7iyQWAQT0zz^*^j*4|Nl2H>Hx@KGHsR*?c<{))Vy`rl`hWNEn=X@AqijpUc_vN5TP|F#0BYhG0ziD?LkzqMJ&! zsp25ESD9)JPK%rLBC0YNe@ zA+{GG0XxPSxe5!bH>s{1a$4`UI?3*~I&m7xeneN&oUWt=N)SuccJhuufKbWkMx@jA zXE3@2c7#YhPlu)__1`cVO+{opNMTK8TbIxDZse>>UdtWTOSIt@}m26F>K@&Sm`N8rf{tOV~6j@p`c;m z7S-TBr$HV|20QU^Fc&*xa7C#$Gf;)Zlq`HysDnnj{&J(><9dAhpj$gV!Fy+;cyy;e znB>Nm!@jZfN2aO6V`jsSRrL>SMGwpiogQ@WjF{9pp*t5x>YVQQc@WF;R|QJ-87V`3 z!R#}&L`?y+^cfQCj`JAq0%#$A=Jw;*R*IfuIv&-BG6WRmGW-qq&xO~ipSDqTCUH7i zb?EK1p9v3*7?7PADld1=2KeNZAeiYdH7Tlql42?H-I%t+xdAkrnEt9@bX9qg>Ja1G zK}^nEIDnmwMIN8=BqzwaCc!37T6Uu{!drEJ2HX-1MVE)03?nNoh*Ll{B5Y1tC|Ft% z#<%KLZdxe15lLk>=o-T9VkerYv+M4JSsI}AdN-NQV3?}9Mq#7iC_6=M+}y^+2NNyG zdNX0k`uud*nX>c|x{Jex;y4v7ED0&N$C$CW-=$B2)D;xkDT5OtLpn6jZU4~1lIX@e zt5u(I(w?FYdNqlMgJj<(yKtm0wjR!Z8q6El5_L~mf#j6fVVr}vIX6HU+@OZp80gHV zv0|}(W$3wkcrpHZ5fkfYFdN~=ea=qyW5bm-?|Dz$EOchdZT_$d8_5a%M)~No;Pdj_0sSl6bHv9D*R=dvH6-~Xg^Kbh{{i{^{>Y|3` zSE~!mqwpgLOm<}Wu>&(2mM&6%FWdstX{rQ6ZE=2r4Yit4jG^LCqHH>A*jVMqf^cLl zyJCY6E5y*1(Ws<4Vk35J(GDHw+!;-E+WFZi2@6&RJTSI8woi8hhckUOJhpe1o@}+j zTXt~TR_A_w&QwuN`I}b1zvfs=Hl1ANu=3(S7)~`SyIOszqqq7B>pM`E3Z`Mlg6Ha6 zH5@C>j0Y0Br8UFsm3jg|L`BcI)9YtVYn;BAJH6$Sqbj^6*lv$O+nnBH@D7_b1m`8X z8+^gHr(|VBDg)7Nm>vD4-5*YSShdIWQo_UQjB<7EN61rVs20a*|M=R&jdM4n3z(IY zdL}g8y3b^%>9j1pD*m+UQjA|Wp6z_Y;U}N;f(kHBp5Dng7vfN;=b@Ru(=|j_>X}fx z7`_)_zA5149y|Pa{frfu3tS6Tch)%F>AE1v?z$kMZx=kb*X1Rr-IxT{6cpN_kjrdv*Q7f!Yg0juE7CcBqH zfBn+s$0wtxZv2_V!ADj)gHL4$%84#i??ukLPgZJmq)JV3N^#=k zsci#2`A0Cyj!tnDVI}kMcsAuoP25V?uB~6Xl~&q1@wU+V=NXuZREB0;Fh@DonZ-}t ziw4YslcRSpE+Tj=z$rw%6eMgDrQWoA=fO6%#qD&^iAN9DZ(V>x311DcBCTIdT#+7) z=tnM}@Un74=m%~PeY0|d{7T8njc!(-xLxR6eG-LGoAK&qx&-$aeY{3E zKCyp}YI&0i$8GWw)}rSxFF0#4kW-K|FoZV(eFlX4${84}Dq#u%5WYeMVr7qm0}~^? z({R^RHz_O%{q1De9tRE%L^nt9I+Yd(O~BJs;ZPim_aF?bmoG#<6_VA3GxN9#Aj+Y& zc_nc&^3?$~$GKYMRFB643w&wYO4tPcO3%uv7?0Cnl|GbiNqDZ9hSMMl;5hOaB9%IY z?>$n3@i(rYk284VbUYO$w=GC$$(Z{-TEerMa@zxj1geWdy;H-1QF<%p>a?xXFoc25 zhn7}h76!4T9SKxG4{w9YLU-xzs24FkD-YwtofVXit{er+c55gcX~tHT>lyjv-g=p)R!{gb{o_K zkCy9;^nPu>s%Pp9j~C8y%C+aBD{6VRvDMuAmCInTjr(`fnYEjpFm2w~)a|9e^Ul^^ zy`j>n=Vu2ZCBZT^8SX1HURPKEZpA67EXY;TAzM9zV@pj|@uwEuo2w4owae>jr@C|J zSLL0}H5m6EbvxY|-(H!G`_?rqT8F7QSS#Xk>JPZol&t6! zh?H~9QhD09@{s}0%Wy4t4@f@wB{ePcj@*yNoCn&>6OS)zdeKaJ^Ic3sE)R|)J=m8M zaU`Pw>9bis{2eF@l!U^eF}S{~ojVb24+sBo0gq0B)#384i@=gbwryN<=-7eBj_ujs zcnI-iAFl5@E~{lzbL809LVX<^uABoF(W#}s(PLuNrlMPlRHi;6qEGnQMSF4eGY8&+@KToOMBN(3MAfs+&H723yF)!& z?8HNfJ|E^Px4v>&!_1|P3#Y>RP8pZbU$gvA)nCruZ3%B(+HYtB$tVkj@$6;y9qPR5 zt1R1*!sXt=PqEX-^$`B+Q0q(^NGZ1N45(P7Rj@=`ynTsT@_u!7AQ|@hFb0giwoLRsLV7 zMJe}nUUd<_qPR!GTv)aGJww0FV@*2tMK9drakB3!$Ey4BVaeYQzY*Z^IgATbR=;4m z{z~!p!%HeYm4C?Y7jO!w#~<|~URR5s32+YC;(Dj#j`eD%El6-k_+8?}KIM=)y4PRz z=G15GHcWz_li>H4NAT)1K$&k2?m0pA60K4xDuoM4P^a*N&K%@9DfJ$K)_2tJc-qd- z@t5LM?Bo;FP~yd^aF4VL+(7s83-<*@^s7 z7+-i|!RQLS##a@T1;$i_3&sV*5&R;z((}(;{7Bf8yCP>)b*QwcAXr&ZSYmpLt-0?H zC<;^sMg=0l0`(v~Fe_N$AAD)=bpH02QxuF8hC`KAsQD;<2OZg)`L>g94-H1D?0!xS zcJk=J*r4qcQT6t+(MLNtAy9@_d%LnaTv?$G78T{C6MOa#RW^0n=Z8xwt_~CjBZg^D d=wFUsX8HT$bH3+t!ofnskAg^OQgG$j{|7tQgZuyh literal 19628 zcmZXa2Yggj)5d4B_pT_QASfc18)__Av1>F5X(SW_2pSQWWQBz^cM}n8kSNlmC`FLo z5s)q&)Y$7{?=2+2tFOJjw(mLf+?(C_=@0&Q=A1co?##Jo5%Gxx)`=tm+eG|$x=qBQ zWD^167@`@foF{TDrQ?X^L<^!NaXfJX(TZqIoJh1G+7c%bCll?6Q;7D&sYD0jG~#sP z4B||}A(DxXL?@y%(S_(rbR$xTvxu{abBJ?^?gUoBtl9a*1;mBKMa0EK58@KyQsOe= za^ec&O5!TwYT_CqmAIC;jz}ZYi43AAkx66`*+dSJOY|c0h5Ce%Dh(W|);zr^oqL8?m7((1a3?*(Qf+9Zb;V==IB~k>87b#|02-3YGa9Fbs z!y%2(CnJTa9H}r08Kq@XLX;9^M7c;syyopxMns}>H`s1~WwGPyrqF@{q_hDyI`O zh?&I0#3PDk_fVRRwYEj(V6hI0%mp47c~r}EV)NMFe38d!upnNxP-IbDS}d|8E-j_q zGGe*N3YxEsS6Rif)x;W+wOV#8Dx0p?#cQq?*?^JlV$COrjUt=kRW^%kq1{#jEua;h z!*-D;soX*AY%DwOdsf*^>=D`9SSI^K_S4`1@l?F*X_05BtR=9^UVqQAvFAlzVA+er zOT^2>E5xhBYsBls8$?WjF=~TvVhO$xd5hB93Z36OBJWc99`Qc$0r4U6kwOhV7WstA zPvgqZL_VkT3*yUoS)ItCxKz*iHHaL>kiHfQIBaYS>4=?H%ed@YINi4%xcL~G(i@wJH?v=!e;ap`1M zX-AwQzV`95Q^nUoCEsa^7De&0GiY!o;V8`fI$}t-imwxJHOo4SuS?vntN6Obr4;d< z6_?JY!8zhPSCzi*@v`&8cYa*DKztX*rHg2HvG{t>?vi-frQ*Ac%FBr>h%1S!6fNLt zX7JZ2bXilycP-|SE57UE$~1PAPGk^0iA*Ak$R=_Wrs-a2tgra;*ik;wn_&Jk-Qth- z-cNkjv#fxi3v1Z`@eQQ%24WB~SfN#JWGgp`uaIRo6GP%vZef+7iWc9AFUTsxFwW=2 zhn@DV7GE(iQ+y$o-9`+Da_K8;ybALldhtz( zE2oO@p|~_neA8(+qfzOO%=fVP9%0!mVm2`c)11%V=Zf!9D(5NO85#H<6W;=sEo?0F zEu!6G@hyofng4vt#J8LVE8=A<#kZm^tQX$~w(bI) ze4DA<5?5}eo$JEer6pf<-wxK?N$eta6MKlg#6E)g&&T|yOYjt%ewuhje6_6kEb*Me zT{GVcn92{V`J(tbBIms#@_;?+h2-)rJ~JubaLyBKkhc$0XGc$;`feDB8X-V@*Z zap?nA`A~cx#g!k6?~}OnsrZol%szZhe1UO(sdgcP9shy&QKhmqtG54HkM3uBsvkD zi7rG}q8pJyoJBDIC7na*T%x-|Zk43-+4}{=g~Ua~#Y7L{65>+gGU9UL3gSxQD&lJ5 z8X}cI{xe&39g#+)6B$HLB9q7>vI#CvQZ6OrKhszq!Tguhn^GU5FVT;Q89^ zF_5@{7(@&vZX|9Z3W=MEA;c}jP~ui1NDL#2h+-n7FgtDLFq{~HTZ}Q1#Qc}U{FgL} zWz2s`rIgBua-xE`ok0Hc->F-i6qTe(DyxV)h|$EIs97pWV}SmWG#0N@jU?U0vb%|U zh$mxz~%SBO`M*NE4NH;5QfcTL3 zi1?WJg!q*BjQE`Rg7}iCBMuSuL<4b{I6@pH{zH64d`)Y`Q@hg?se)IPKj(4S*B>fL|e@oIIRQ^f)rSRU4e^AplH=W{767%ik z_bJedA6mcVN$z)*KcMFRV-j2OAB&o;#D5&nQvA(XrA3n}$5VMi6J=`{v=#q}ENi21 zC+0ti%9EQIoC1T(#NQrB5&x+`viLgyXNdna8l2vwl{2YysO0kaJHnug_&c$za}$HE zRCZIitK>fm1{a9`Y@oaN&ta8wn^ZZE%JZ8jFN8r4@n6KUixuAdE}`<$Cd$iU&{OsP z7y)lJ%3>l!+(ry1MksU;VeyZoauiXba1WPSrA++gaf1rey7+Gwe;4Hwo&Q7OZ<1U<~_u{#C^m#Vmwi;(B5mre}7zhfZa|I|AY8lVzKxqVt|iQ z$?re^WJ*(rsp5YKRc2C}CjRN{VTPhr1*L~kWw!Vqp)`wSh)WoOe-1HM(c0akdFb5{ z|9seeApXaI-Qr&WtP}r2V1@V>0ZYZdnC44p9;UR6SWe|(N-JToM*OQNt!CLzl-3fD zD^7HGdOZxbihl#JN&HW+%0^asm(pfpi^7|&+0-54-_Eip6>VI{+)3pwD&3Cuz~E)^ z?*(ebzYlmy{QFt+0BhD$dYX7f(RK`_XJPPy_@ATnyyB!&D7{F$MCF^5UV*`z;(rx* zL;SB%`MTm{^lo+~MjTXlyYdzc-WC7bEPF?BlH2BcRKBlhcLk*nVepsuKLWlH|HnX` z_&)(Y7yqZM@)->fHB7f(5ML@sVGfPT{Vu)q={F3a_yfsBEP; zr7xuu(Mo%A(0xlA(GjNVrU4Rs^y3($j;uLy;brzLpE8O?bIu{1#i`AWF%zs|l1yo+Ba9=zN z`OmsitRBE+VqL;2mnvLevM#5Rn|jJul&*q7s#sT3x<=8SLEO5Q%Ilga(_wJESQ$Vs zv3dg8Vr8->J=t5<94d1a-p1v@ppRJjEbFak4^K8;;OwDZELKhrtZ7s)0#j)c_O3x}P;4Xj1b*Dkmyh{g={Y7(67_6iQPSUenX4 zoUS%Dvv*xPOTfuoSSRmGX8a$@(CcTi#MGCK#B_j3; zv6cdO$CkmoUaaN7Gh(d(wu-e9STEKpV69lI*~%J)_xe6g{!16~#DdEh0nUZBB?3h(85naWobr@8ZcjY{S}?{$iymAAw?$g(#T zUfJ7JzC)$^TD%8?PsMs4_(-e|Smi^7o2RXhsr*FY#jMX@@TFLvv+N5+8@J6mDi0~V zJ!-%f+hQGt-7jJt0lpRMDDbsd|DnNGG(Z&-QC#2sMkQ|!-@)KVvA$=O9~7P^|3u}_ z3U94{g~8uq{RaFY*6*zHKZQ54KdGeapME)|e=yu6u|*}@r*P+P`>C`PZtr#g2JOW@ z1~^gdX21zz9}Bb)n_g!(R|B_OyCqvWzDX;ssBGP&W*f9}ve<1|c9P*zu%FJfbK8@mUUmk`W<-i)v-_O)VP0bDKi zm8^1=;!K7v`x+`!6>cW6uY*B`*l8?FSGZBp?nz~)!VSN6HVkeMI|t}1b}o=Fb}!b< zW6dz7-b5dT`@Y-#V9;Oe>seNy@D^(Tl>?h72f^SLu?GW%V&BLrH?fMlE;my-MB#Nb z6b8e@zLjOcCI&@R7Arh=yA1{ph&>#*L+lYix!9PBT_W~K8jNaUP)cQ)!rO-m7(~Us zon;Y)d;YX5sjN~s$&^OJ;9jxs1nv@h43%RQ-s^NXmG>w-ce@V;)nboh*?5KLJvCI` zuW-YmJpl%@#eNW&CiX;NirAA_bF#wC+BWl_{g5iXiNT5NhsB;jgP969hSZ3U)`u zUJbk~_8MT1*lU4JVm}US5Zet2>($)-lCqyr$!7j*{S&3lFxV;f7GS&BTdCZp@K%ZW z&)%U*&+B%v=5B=-g7%`7TCw*5Pl?U^XCG){_cZOEQFz<ZVep>V@34%?+w1RrDnC$o`}YwH zz7+do;4`s5VUo!IwO{-E%h#@^b$iv2Uoeo=Vi{Ef=rX@He5e)b0t5c^Nq{Ui2Y zRQ|1SmmnaJ@K0TQsthD4-2MUdFZjb$kcHx>lWrt%zxXV4uI{u$wUKyL}052Q-q0^l+UTnO}# zz(oLlUA$ z;T~86BdHvv@H#4mgkRFi0Q|Gea^MaLQ~av(smMA>CWmGO#bUZ|9C9p;Ut0=8jcq@VYXZGQ7MZ$0Tf%Qf&fei%z{byh! zrA@?U32dRcskxO(JU0EWF1M(>tTJ2{DyyvPSyWyeO3xhFYj~)l~?;Do*);EaC-C^SQf4f6+3z1vf;($rA}&I0VZeV}ezsq3)2Kocy}#6?N55)YUv*SG~(AbY5|aZjL=1+aB8!+Zo%9ac#!v zb{?#bZHny!r#sQCBU3ilKen$R5*i+kR$>sv7?%$95Qci*ajOP|qeH`GLqldsLcy}3 zRb}DwGT$-I^z^I(9eS^<+k{1n&4}$)(X8nvCz^|f4)33aZFa_) z4IUc$0?RY7zYaEIVE;4>(%r@Wl|i$^seLk|mBHfjD7P_+eXN~?qNv%%s9CRsan;Y5 zcx34WU9XNaoT4m@XH9Gdwhnzlo9uK9AL1&d_19H8M?20;i-tpGPLG}-mZjq#PKJ35 zIXSte_3EAY+bPVf9dC+@axkeK?#dt9J-=}-ZB9QGb4eedO=hK!sHzO2%}!ZPYF2tx zW$n^3Cj&xGL0!!p^HNkFz#bo-HbqCPHI|n6JLMFVn`bi*you}dO2x>+3h|#r(1=Bf)TG^os&`cd)FyY)ol+Rdi@Y zr2Nh?zGJwW$p@Ua$-n6L-gsI%78F3N}3 z7%%qTufsDJ)jzP4+i>o~1KfUlvfsR(p{mMg(TI{@S+Ub2J3AD?nvcOoq?LrYCmFeE zCFXf}nGT?4k_kOE_a7a%{Al&6gjd|P7=aP=i#?*R&EACYQ@?))-|~)M^5yBU`3*Q+ zMjxGiX2ytc8Q$@m`i06XNd8olZrnX zU4C_Py8Po5n#Q`eU>jX8hSzv=X#c_Gm_xrDwan``B3u%#s4&UL>5(8I4CH2+B1{nx zpz9>Fk%*Jk%S}A0nT1_USjVn&ouY!+3dC^}%MalHod}jw5PgnJ-%`JSO8pc2lbx<3 z`$s|*kx&$Qu1O^CSmI3Y7;!pv9Nn{WOhqWC6#Z5PBV)ek+^Tas{PjiW(dw0*FVJ1^ zsv|QM#50qF=mlrSEIN)uK$+1PwM-O4)I#=2jHVfx1Jm$cyn^@Q?PRChxvrm^2-*47 zbSzMIuG8tTb9QcacvvJ@g5fwlx-D>0@h1a+5K|DNOjtqQSf`N%AsPi(hDR`Ylgc*5 z_L#78a2(p765qGl(?ZXp{a*d(M7@F)CTMm06G02lwObLiGVxGe2G3}iyRu=ydZ$oJ zOt8w2ZN%d4_rgYsv`6D#B{uF)L*seOetler9OdMdM?!Gby#D1?NJo@X2V@xSxyEfh z7sU&k(HrX8wVI3iS0NSU*RNQ8bnzn%n`Ww)-k`3~7H3|Rw$;n8LtQha{oXCrC&##8M^Q;?HYKYdffuKiA- zseu5x4C}iKF~el#sZKP-*Tr=3LqZ1~o-IHJIeFSaPEL8*@KN~V^vE@jSOff(n&QJT z#r&0%b#&FdhMgNt`&j2b*hRC-=2)^Xw$-%%0NVHUNBbr?8b3Mz_a$h*4^u-9GVa;AEo%-H$iBjt{XyOY^!(FnEH7A zn(?OdtqGH}?)?s(=jLm7I$rmR($rmR~JY_~T`p#ek$<`zg9&4Oy zbhvVCD57CGHM4(Jcr5ckI2y&o`)VFALtz-k0Sn=OgC4L782)3skO1()xHC6NVEH;T zl=W`!otGy&otGyrL+OtgO1e9g^xz0&PUA)X9Havy)~dzw4U5b|_%BPC`x!6ZgboV^(y0onqETj{Ec1v=mYRtN z&3~%EymQTAyn2To0kR8fcWX7g$V;%(;}4GKTyqZ{xF1J=hB+Hehilvpc?jv}X1{*i z?96`UCF*9NNr0)@cqli=iVS`7a^6CnpB`&#CMCq`98|B}rpJ){*kbrMw*KHmb5zV~ z*t)F#flU~J)!rRJmk!849TJ9fLA1^tPA-pK*}0X$5j*ms=1 zaPmhF@e_6~4rwJAIhNy5J%S;9n2?d%aQ}2fo%)Gu&0rFj-zvxgMWL6$wz}v2CJWQcRIFWAR%`~uY_<=JGaUh7o9mHBCa>oL z*(nJ=aqOb&j1%6d^S2^bm4>74m6bdN@>49>KF2R(^W8b}dBXHW(U` z>pVA^n3L*`gjMRTcHJ9YrypF^d^F)j!NGOBd2#a(&)b*iLH6E+Ej#b01MZS#+@wPs zH~@#IP|=96fp=&bg|E4cvCw*oA}6(9LT1Q-1%{nFplC$x+S{wlm~pNiZ;o}<$r!>wLn;j^`$i1VA@9*ca zu(?cTH|65%%}L3{3s>57KRu5|C ziz}?{>9<$tEGK7(rAI}+Hhc7oRYPaZlEzUwg*X4J{biC;OY7ejlhZ%;@*T|sbz$t zG9UcNs2CaF^!lk24^NuMH@(@UFC3)T1mEr2ce6X1On$Lu_s4OG;Ra8L?Wx(B(TZU0 zW~`1rY52oo54$#Bw-OOv3(CwXA1Tkcq1ha_|06389G<=bL%^yW+b*H&=I4!byH3y6 zUCB+aD#84<^BngX0YBx~ttP>^W%?%LSco&Bu0xY}r!CYj)s--BF=8*$d}G4PKXhPW z{p2NB3w#8c;XLdPr_-!tr_-#2v7Pl83DG+hx;8gGEk=w9w76#KW_el)qxbx7z_hMSp&w;lN;ES0( zpmuL$R49zEzyVcwFb;x;+mYPOrs$&^E+%TviQ&R6))cS|;cT4u37A{IVDXW0sH&Ym zkvRG2Qg`xcOhI|IbIk3Kd&`rZRu!!@OPre0ybq?HRt3ofI)wjfxYB-=mKnsNXaThZ5cqU`LwoOx%&KhcS+PUf5;l zhcOO(LG;MZ5Ai8AJHK{=dBoR+mg-3qE{b8`Jes&ADJ??gJM=Mp#^~`H>GY^*e^IH+C3d#mgYkW zo5FZI&hy7U{era{qPUAn4~Fl=MO4uM9E^7&4V!x|WImIU&F5v-5tBenKx?rhaWM+b z0X5J4w8*O(jq4P|(w4WtC-7HBc3$~toCYiPP`WYUa$+J*gQ$Sx$b4ifa|+*eup09} zym}_i;D;ySVko6$?}VOw)89o;xI{ByyLbO!RdKj`S|m73U&VZt9hKn-ecT7tR$>+U zvZfOamctG=fyP6(>u}8dm#)eqc<@#Q^=p?7gJ*j!6b-RrOA$Y6urm9N$9mazh6esE z3~_xMw#>uO;Xn;jCLP*qPM9stYI)x=L;uLf916Vn8j5iAS^dqEap2?UnCl$X>v!}X z^Z|!nTefQ<+ zhwmQqb-FG7dSxBny{cjEDlE`f!)67GA=kojh zgr8lvG6#w7mp|l&hFs>TtXzH?_Q=kS;7n{jT?Qr`q;NoI1+%1l(sYG^n#((Eulp?n zr}HY}gV`Ll+=$?2^urT3n@Fi)q1BrSUf1krTr{Pp@etfQEeekghKtP-BU1KC!>23c zkq}bzTw#n}LgZ7b-B@f2^@xZu;YSvY;^s#UTm|7?EHQ|BEsU%+*ETok1vcLfb8WE= z7bSW=%r{|u>7s@y3l7hj0PkyEoG@Oi>@PE3uHMZFS6v!6)Il;!!x7wiIXworclf5r zakU7!gZPLL%B_vx=?|!#q_$CwPYAWVCd1*9foIOqRdbHcHus<2=Q`UmzYF}Ut)d|v zVvBI)H5u^|UrGqh=7@*;zu0#C9D)7WghCUWb{fS7{64YMD3M+f!Us3H)RFPC@N2@+ z2c{gIeSrRSV%vn(NLn|+tVVBrA9KWDZ<#l3Rzg6+uMkIfn}F2D`}{S>jq^rr z#v}VoitRhsiS6$m+hXnm9@|^LBcxb4iyl8}#6e^r{Y474- zWpG$98X9V@fBR&I%5(c&)IEd0^yL+YqD7H#MI~DP0>63=>CSS;Eq4ZlqLofhw*@EV zw&19c<5n^4p6g(YPUy~HDemZ+9anONWgrwnB!Qr8(&vNeU cRfgYT`D^1dfo*w_P!aOS&}evUXz6MH2e+pR^8f$< diff --git a/tests/gis_tests/data/geoip2/GeoLite2-ASN-Test.mmdb b/tests/gis_tests/data/geoip2/GeoLite2-ASN-Test.mmdb index afa7e956e4cd55d4398ffb9d4805ad2dde507cf3..fe2123f9e0fc3e1867c9ff5420003e510ee0b4ea 100644 GIT binary patch delta 16 YcmaEx^fqb3UIUhN*8Xdg4;rii07-8MK>z>% delta 16 YcmaEx^fqb3UIUiY=svT_2MyK$07#Pu^Z)<= diff --git a/tests/gis_tests/data/geoip2/GeoLite2-City-Test.mmdb b/tests/gis_tests/data/geoip2/GeoLite2-City-Test.mmdb index 028a6984d93fb2e93c1ac39b828e91484d57a442..9eea131c76b70774e1c81ba78b30f01f33954aad 100644 GIT binary patch delta 18 acmeyngz@hZ#to+fS<+eiuT4H5xDEhW+X+Vi delta 18 acmeyngz@hZ#to+fSyH3>%qE`?Tn7MH{|Nd3 diff --git a/tests/gis_tests/data/geoip2/GeoLite2-Country-Test.mmdb b/tests/gis_tests/data/geoip2/GeoLite2-Country-Test.mmdb index a2cbb0831697342a4b9b136d3c892ec84acc1348..0233bba39b822b43dda9cb44d70b19c00cb0ee84 100644 GIT binary patch delta 18 acmey_!}zm@al=7ZmUPzsYm<+ delta 18 acmey_!}zm@al=7ZmelAzv&lzYw*UZCeF&TY diff --git a/tests/gis_tests/data/geoip2/LICENSE b/tests/gis_tests/data/geoip2/LICENSE deleted file mode 100644 index f86abbd73e..0000000000 --- a/tests/gis_tests/data/geoip2/LICENSE +++ /dev/null @@ -1,4 +0,0 @@ -This work is licensed under the Creative Commons Attribution-ShareAlike 3.0 -Unported License. To view a copy of this license, visit -http://creativecommons.org/licenses/by-sa/3.0/ or send a letter to Creative -Commons, 444 Castro Street, Suite 900, Mountain View, California, 94041, USA. diff --git a/tests/gis_tests/data/geoip2/README b/tests/gis_tests/data/geoip2/README deleted file mode 100644 index b6a21720a3..0000000000 --- a/tests/gis_tests/data/geoip2/README +++ /dev/null @@ -1,3 +0,0 @@ -These test databases are taken from the following repository: - -https://github.com/maxmind/MaxMind-DB/ diff --git a/tests/gis_tests/data/geoip2/README.md b/tests/gis_tests/data/geoip2/README.md new file mode 100644 index 0000000000..36328671b2 --- /dev/null +++ b/tests/gis_tests/data/geoip2/README.md @@ -0,0 +1,14 @@ +# GeoIP2 and GeoLite2 Test Databases + +The following test databases are provided under [this license][0]: + +- `GeoIP2-City-Test.mmdb` +- `GeoIP2-Country-Test.mmdb` +- `GeoLite2-ASN-Test.mmdb` +- `GeoLite2-City-Test.mmdb` +- `GeoLite2-Country-Test.mmdb` + +Updates can be found in [this repository][1]. + +[0]: https://github.com/maxmind/MaxMind-DB/blob/main/LICENSE-MIT +[1]: https://github.com/maxmind/MaxMind-DB/tree/main/test-data From 5873f10177ebda66d38e698218cf85dc6397e7d9 Mon Sep 17 00:00:00 2001 From: Nick Pope Date: Tue, 15 Oct 2024 09:58:19 +0100 Subject: [PATCH 018/132] Refs #35841 -- Adjusted GeoIP2 tests for easier test case extension. These changes will make it easier to introduce tests for alternate databases that may have different results without the need to duplicate lots of the tests definition. --- tests/gis_tests/test_geoip2.py | 104 ++++++++++++++++----------------- 1 file changed, 49 insertions(+), 55 deletions(-) diff --git a/tests/gis_tests/test_geoip2.py b/tests/gis_tests/test_geoip2.py index 11c73bec0c..f6f6ab0397 100644 --- a/tests/gis_tests/test_geoip2.py +++ b/tests/gis_tests/test_geoip2.py @@ -32,6 +32,33 @@ class GeoLite2Test(SimpleTestCase): ipv6_addr = ipaddress.ip_address(ipv6_str) query_values = (fqdn, ipv4_str, ipv6_str, ipv4_addr, ipv6_addr) + expected_city = { + "accuracy_radius": 100, + "city": "Boxford", + "continent_code": "EU", + "continent_name": "Europe", + "country_code": "GB", + "country_name": "United Kingdom", + "is_in_european_union": False, + "latitude": 51.75, + "longitude": -1.25, + "metro_code": None, + "postal_code": "OX1", + "region_code": "ENG", + "region_name": "England", + "time_zone": "Europe/London", + # Kept for backward compatibility. + "dma_code": None, + "region": "ENG", + } + expected_country = { + "continent_code": "EU", + "continent_name": "Europe", + "country_code": "GB", + "country_name": "United Kingdom", + "is_in_european_union": False, + } + @classmethod def setUpClass(cls): # Avoid referencing __file__ at module level. @@ -100,85 +127,52 @@ class GeoLite2Test(SimpleTestCase): self.assertIs(g._metadata.database_type.endswith("Country"), True) for query in self.query_values: with self.subTest(query=query): + self.assertEqual(g.country(query), self.expected_country) self.assertEqual( - g.country(query), - { - "continent_code": "EU", - "continent_name": "Europe", - "country_code": "GB", - "country_name": "United Kingdom", - "is_in_european_union": False, - }, + g.country_code(query), self.expected_country["country_code"] + ) + self.assertEqual( + g.country_name(query), self.expected_country["country_name"] ) - self.assertEqual(g.country_code(query), "GB") - self.assertEqual(g.country_name(query), "United Kingdom") def test_country_using_city_database(self): g = GeoIP2(country="") self.assertIs(g._metadata.database_type.endswith("City"), True) for query in self.query_values: with self.subTest(query=query): + self.assertEqual(g.country(query), self.expected_country) self.assertEqual( - g.country(query), - { - "continent_code": "EU", - "continent_name": "Europe", - "country_code": "GB", - "country_name": "United Kingdom", - "is_in_european_union": False, - }, + g.country_code(query), self.expected_country["country_code"] + ) + self.assertEqual( + g.country_name(query), self.expected_country["country_name"] ) - self.assertEqual(g.country_code(query), "GB") - self.assertEqual(g.country_name(query), "United Kingdom") def test_city(self): g = GeoIP2(country="") self.assertIs(g._metadata.database_type.endswith("City"), True) for query in self.query_values: with self.subTest(query=query): - self.assertEqual( - g.city(query), - { - "accuracy_radius": 100, - "city": "Boxford", - "continent_code": "EU", - "continent_name": "Europe", - "country_code": "GB", - "country_name": "United Kingdom", - "is_in_european_union": False, - "latitude": 51.75, - "longitude": -1.25, - "metro_code": None, - "postal_code": "OX1", - "region_code": "ENG", - "region_name": "England", - "time_zone": "Europe/London", - # Kept for backward compatibility. - "dma_code": None, - "region": "ENG", - }, - ) + self.assertEqual(g.city(query), self.expected_city) geom = g.geos(query) self.assertIsInstance(geom, GEOSGeometry) self.assertEqual(geom.srid, 4326) - self.assertEqual(geom.tuple, (-1.25, 51.75)) - self.assertEqual(g.lat_lon(query), (51.75, -1.25)) - self.assertEqual(g.lon_lat(query), (-1.25, 51.75)) + expected_lat = self.expected_city["latitude"] + expected_lon = self.expected_city["longitude"] + self.assertEqual(geom.tuple, (expected_lon, expected_lat)) + self.assertEqual(g.lat_lon(query), (expected_lat, expected_lon)) + self.assertEqual(g.lon_lat(query), (expected_lon, expected_lat)) + # Country queries should still work. + self.assertEqual(g.country(query), self.expected_country) self.assertEqual( - g.country(query), - { - "continent_code": "EU", - "continent_name": "Europe", - "country_code": "GB", - "country_name": "United Kingdom", - "is_in_european_union": False, - }, + g.country_code(query), self.expected_country["country_code"] + ) + self.assertEqual( + g.country_name(query), self.expected_country["country_name"] ) - self.assertEqual(g.country_code(query), "GB") - self.assertEqual(g.country_name(query), "United Kingdom") def test_not_found(self): g1 = GeoIP2(city="") From 3fad712a91a8a8f6f6f904aff3d895e3b06b24c7 Mon Sep 17 00:00:00 2001 From: Nick Pope Date: Tue, 15 Oct 2024 09:48:59 +0100 Subject: [PATCH 019/132] Fixed #35841 -- Restored support for DB-IP databases in GeoIP2. Thanks Felix Farquharson for the report and Claude Paroz for the review. Regression in 40b5b1596f7505416bd30d5d7582b5a9004ea7d5. Co-authored-by: Natalia <124304+nessita@users.noreply.github.com> --- django/contrib/gis/geoip2.py | 28 +++++++++++++--- docs/releases/5.1.3.txt | 3 ++ tests/gis_tests/data/geoip2/README.md | 14 ++++++++ .../data/geoip2/dbip-city-lite-test.mmdb | Bin 0 -> 1481 bytes .../data/geoip2/dbip-country-lite-test.mmdb | Bin 0 -> 1314 bytes tests/gis_tests/test_geoip2.py | 30 ++++++++++++++++-- 6 files changed, 67 insertions(+), 8 deletions(-) create mode 100644 tests/gis_tests/data/geoip2/dbip-city-lite-test.mmdb create mode 100644 tests/gis_tests/data/geoip2/dbip-country-lite-test.mmdb diff --git a/django/contrib/gis/geoip2.py b/django/contrib/gis/geoip2.py index f5058c1c05..a5fe429b89 100644 --- a/django/contrib/gis/geoip2.py +++ b/django/contrib/gis/geoip2.py @@ -34,6 +34,18 @@ else: __all__ += ["GeoIP2", "GeoIP2Exception"] +# These are the values stored in the `database_type` field of the metadata. +# See https://maxmind.github.io/MaxMind-DB/#database_type for details. +SUPPORTED_DATABASE_TYPES = { + "DBIP-City-Lite", + "DBIP-Country-Lite", + "GeoIP2-City", + "GeoIP2-Country", + "GeoLite2-City", + "GeoLite2-Country", +} + + class GeoIP2Exception(Exception): pass @@ -106,7 +118,7 @@ class GeoIP2: ) database_type = self._metadata.database_type - if not database_type.endswith(("City", "Country")): + if database_type not in SUPPORTED_DATABASE_TYPES: raise GeoIP2Exception(f"Unable to handle database edition: {database_type}") def __del__(self): @@ -123,6 +135,14 @@ class GeoIP2: def _metadata(self): return self._reader.metadata() + @cached_property + def is_city(self): + return "City" in self._metadata.database_type + + @cached_property + def is_country(self): + return "Country" in self._metadata.database_type + def _query(self, query, *, require_city=False): if not isinstance(query, (str, ipaddress.IPv4Address, ipaddress.IPv6Address)): raise TypeError( @@ -130,9 +150,7 @@ class GeoIP2: "IPv6Address, not type %s" % type(query).__name__, ) - is_city = self._metadata.database_type.endswith("City") - - if require_city and not is_city: + if require_city and not self.is_city: raise GeoIP2Exception(f"Invalid GeoIP city data file: {self._path}") try: @@ -141,7 +159,7 @@ class GeoIP2: # GeoIP2 only takes IP addresses, so try to resolve a hostname. query = socket.gethostbyname(query) - function = self._reader.city if is_city else self._reader.country + function = self._reader.city if self.is_city else self._reader.country return function(query) def city(self, query): diff --git a/docs/releases/5.1.3.txt b/docs/releases/5.1.3.txt index e3c62072b5..0dd5b42cb8 100644 --- a/docs/releases/5.1.3.txt +++ b/docs/releases/5.1.3.txt @@ -14,3 +14,6 @@ Bugfixes :class:`~django.core.validators.DomainNameValidator` accepted any input value that contained a valid domain name, rather than only input values that were a valid domain name (:ticket:`35845`). + +* Fixed a regression in Django 5.1 that prevented the use of DB-IP databases + with :class:`~django.contrib.gis.geoip2.GeoIP2` (:ticket:`35841`). diff --git a/tests/gis_tests/data/geoip2/README.md b/tests/gis_tests/data/geoip2/README.md index 36328671b2..f2a703b457 100644 --- a/tests/gis_tests/data/geoip2/README.md +++ b/tests/gis_tests/data/geoip2/README.md @@ -12,3 +12,17 @@ Updates can be found in [this repository][1]. [0]: https://github.com/maxmind/MaxMind-DB/blob/main/LICENSE-MIT [1]: https://github.com/maxmind/MaxMind-DB/tree/main/test-data + +# DB-IP Lite Test Databases + +The following test databases are provided under [this license][2]: + +- `dbip-city-lite-test.mmdb` +- `dbip-country-lite-test.mmdb` + +They have been modified to strip them down to a minimal dataset for testing. + +Updates can be found at [this download page][3] from DB-IP. + +[2]: https://creativecommons.org/licenses/by/4.0/ +[3]: https://db-ip.com/db/lite.php diff --git a/tests/gis_tests/data/geoip2/dbip-city-lite-test.mmdb b/tests/gis_tests/data/geoip2/dbip-city-lite-test.mmdb new file mode 100644 index 0000000000000000000000000000000000000000..5f0d657c841ad687085c88a037010b02816e54c8 GIT binary patch literal 1481 zcmZ9}&2tn*7{~D@Mj{{q1$h&2KvV+mk_3qIB9dj7-OVN;Auph))VhS8)?=#x1xNU&C$qI&Q~K zOyCYoVhVR+8Z(&1F3e#!_FymW!anR5;*b!#$pbiuLpY3ka4)`rZ{j|D3*W|f(8hPs z!92R?p~U?-Aw)rlB3V5cIY2mwB`l*B!VsdW3gJB={0Ad}5FxpWBRGn`VN_Kk9L6K~ zK7N2l@k1QLkMJ0NjGy4A_!&mco*c31W9(nF2T@}_QQ`#xZU@{?ff49+|(bnpLqT`Lq zQmG~D8XYPvb@*4(HJ(hQhPn#U)GKV|6+8Fbj+z$2YMQi~cc!YosmQczsyg&*e_I{J z&g7C?W6}Je3T&lq$pS~)RjrH`O&Jv!n{Cqxw&)$wDwLj;Q@Y@pa;9WlCybWf$&{jZ zSoLIad-nJK#eX!}*^<$PsiEt?W{&Op^Pg*JEyGdcAM9<9x3zDKw{^6}Ti3O3=nkrR zPmQP`+9;UTILS%rlrEGU?OnThzsEV$qqG-yP5IuwywZ+ev-can?1XmNIbeKyMEdpG z@rM7;D*bTwYA#<@CC`=>;}#nm3e97edORm|@=hS_uvU@1$wamS2_Xp}D5!|KY_f-Bft-!I8=4J!@0}~T)u-?Q z9ACg225-Fb6E z;{sfWi*PY6!4h1G%WyfC;tDLomADF5;~HFx8m`0jxB)lfCftl$upGDIHr$RoFn|?U ziB(vQHCT%~aTo5!J-8S5;eI@T2k{Ud#v^zX>oAD*7{V|%U<4a6iZP616EZ2_ z6CxwTaqj(;u-A1vv>~AqmJEZU;>k9qQoBbf3TDgX|nZuq?gc#{rCYD z+L*-)=%9-p=5PQ9aR`TT1TUgr>Se+eyo#fE4X@)3yotB)Hr~OzLcAl~6XHJM0Y1b> z_!ytyQ+$Tc@ddubSNIy=;9H#T>a^mYXEK_!m1ilbyvb0~Hf1o}5lcy185yZtX1eaw zSHB=3!czn8L{O@RaL%!_GLp1&%5#RlX(j2pP}!GJe^I;T>Xy_lw~VX)M&Z3 z&e@TmRz9Iswsa`VlcpB8RLZn75hcAr+v#hnsi>~0s_@^+>e`Q=e>59I&6YANl6K~M zSHe<;GpzU6PR8)`jL~a5`hav?{|n>!|Ib?L@9g_{B4_oRy3E?ibU}WqxVxj-G(00= zxKj6qv$8D|jJ5{qr>_%e@+*s*(oH&6*7Faax^ibI7>Kq`)u9EnXshPg+OOp?EBmL4 n!f3ytQaK|f-Mj*SS4{cs^zZGr>C;%;kxAPzb=Mk^") - self.assertIs(g._metadata.database_type.endswith("Country"), True) + self.assertIs(g.is_city, False) + self.assertIs(g.is_country, True) for query in self.query_values: with self.subTest(query=query): self.assertEqual(g.country(query), self.expected_country) @@ -137,7 +138,8 @@ class GeoLite2Test(SimpleTestCase): def test_country_using_city_database(self): g = GeoIP2(country="") - self.assertIs(g._metadata.database_type.endswith("City"), True) + self.assertIs(g.is_city, True) + self.assertIs(g.is_country, False) for query in self.query_values: with self.subTest(query=query): self.assertEqual(g.country(query), self.expected_country) @@ -150,7 +152,8 @@ class GeoLite2Test(SimpleTestCase): def test_city(self): g = GeoIP2(country="") - self.assertIs(g._metadata.database_type.endswith("City"), True) + self.assertIs(g.is_city, True) + self.assertIs(g.is_country, False) for query in self.query_values: with self.subTest(query=query): self.assertEqual(g.city(query), self.expected_city) @@ -224,6 +227,27 @@ class GeoIP2Test(GeoLite2Test): """Non-free GeoIP2 databases are supported.""" +@skipUnless(HAS_GEOIP2, "GeoIP2 is required.") +@override_settings( + GEOIP_CITY="dbip-city-lite-test.mmdb", + GEOIP_COUNTRY="dbip-country-lite-test.mmdb", +) +class DBIPLiteTest(GeoLite2Test): + """DB-IP Lite databases are supported.""" + + expected_city = GeoLite2Test.expected_city | { + "accuracy_radius": None, + "city": "London (Shadwell)", + "latitude": 51.5181, + "longitude": -0.0714189, + "postal_code": None, + "region_code": None, + "time_zone": None, + # Kept for backward compatibility. + "region": None, + } + + @skipUnless(HAS_GEOIP2, "GeoIP2 is required.") class ErrorTest(SimpleTestCase): def test_missing_path(self): From f59cdd00093338427acde555c9b687acc5ac67ea Mon Sep 17 00:00:00 2001 From: Mariusz Felisiak Date: Mon, 21 Oct 2024 19:20:03 +0200 Subject: [PATCH 020/132] Updated tutorial part count from 7 to 8 in docs/intro/reusable-apps.txt. --- docs/intro/reusable-apps.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/intro/reusable-apps.txt b/docs/intro/reusable-apps.txt index a9c0768e3b..5acf8c2b18 100644 --- a/docs/intro/reusable-apps.txt +++ b/docs/intro/reusable-apps.txt @@ -6,7 +6,7 @@ This advanced tutorial begins where :doc:`Tutorial 8 ` left off. We'll be turning our web-poll into a standalone Python package you can reuse in new projects and share with other people. -If you haven't recently completed Tutorials 1–7, we encourage you to review +If you haven't recently completed Tutorials 1–8, we encourage you to review these so that your example project matches the one described below. Reusability matters From 5a91ad3d7115c692d497663a155edee5ebc8989c Mon Sep 17 00:00:00 2001 From: amirreza sohrabi far <119850973+amirreza8002@users.noreply.github.com> Date: Tue, 22 Oct 2024 01:01:39 +0330 Subject: [PATCH 021/132] Updated Hypercorn links in docs/howto/deployment/asgi/hypercorn.txt. --- docs/howto/deployment/asgi/hypercorn.txt | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/howto/deployment/asgi/hypercorn.txt b/docs/howto/deployment/asgi/hypercorn.txt index ea5ce3cc72..3abd2d54ef 100644 --- a/docs/howto/deployment/asgi/hypercorn.txt +++ b/docs/howto/deployment/asgi/hypercorn.txt @@ -17,7 +17,7 @@ You can install Hypercorn with ``pip``: Running Django in Hypercorn =========================== -When Hypercorn is installed, a ``hypercorn`` command is available +When :pypi:`Hypercorn` is installed, a ``hypercorn`` command is available which runs ASGI applications. Hypercorn needs to be called with the location of a module containing an ASGI application object, followed by what the application is called (separated by a colon). @@ -35,4 +35,4 @@ this command from the same directory as your ``manage.py`` file. For more advanced usage, please read the `Hypercorn documentation `_. -.. _Hypercorn: https://pgjones.gitlab.io/hypercorn/ +.. _Hypercorn: https://hypercorn.readthedocs.io/ From bcb91611eca154f022211633fe485e3e1a3c608d Mon Sep 17 00:00:00 2001 From: Mariusz Felisiak Date: Tue, 22 Oct 2024 11:06:34 +0200 Subject: [PATCH 022/132] Fixed example indentation in howto/overriding-templates.txt. --- docs/howto/overriding-templates.txt | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/howto/overriding-templates.txt b/docs/howto/overriding-templates.txt index f636948a20..f99a1203a8 100644 --- a/docs/howto/overriding-templates.txt +++ b/docs/howto/overriding-templates.txt @@ -111,15 +111,15 @@ reimplement the entire template. For example, you can use this technique to add a custom logo to the ``admin/base_site.html`` template: - .. code-block:: html+django - :caption: ``templates/admin/base_site.html`` +.. code-block:: html+django + :caption: ``templates/admin/base_site.html`` - {% extends "admin/base_site.html" %} + {% extends "admin/base_site.html" %} - {% block branding %} - logo - {{ block.super }} - {% endblock %} + {% block branding %} + logo + {{ block.super }} + {% endblock %} Key points to note: From df6013b2b4e93ed6d127c2f572e6de0ba46d1d6a Mon Sep 17 00:00:00 2001 From: ssanger Date: Fri, 18 Oct 2024 18:18:43 -0700 Subject: [PATCH 023/132] Added missing alt attribute to tag in docs. --- docs/ref/templates/builtins.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/ref/templates/builtins.txt b/docs/ref/templates/builtins.txt index d34742f210..8673727861 100644 --- a/docs/ref/templates/builtins.txt +++ b/docs/ref/templates/builtins.txt @@ -3100,7 +3100,7 @@ slightly different call: {% load static %} {% static "images/hi.jpg" as myphoto %} - + Hi! .. admonition:: Using Jinja2 templates? From dd0a116b93c40f9febf0e09614ad666af1191744 Mon Sep 17 00:00:00 2001 From: Daniele Procida Date: Tue, 22 Oct 2024 20:10:25 +0200 Subject: [PATCH 024/132] Restructured how-to docs landing page. Previously, this was a bare list of sub-pages, not in any discernible order, and hard to parse. Now the sub-pages are grouped in sections by topic. It's unlikely to be the final word on how this material is arranged, but it's a clear improvement on the existing arrangement and provides a good basis for next steps. --- docs/howto/index.txt | 78 ++++++++++++++++++++++++++++++-------------- 1 file changed, 53 insertions(+), 25 deletions(-) diff --git a/docs/howto/index.txt b/docs/howto/index.txt index 0034032ce2..d799ca7906 100644 --- a/docs/howto/index.txt +++ b/docs/howto/index.txt @@ -1,11 +1,57 @@ -=============== -"How-to" guides -=============== +============= +How-to guides +============= -Here you'll find short answers to "How do I....?" types of questions. These -how-to guides don't cover topics in depth -- you'll find that material in the -:doc:`/topics/index` and the :doc:`/ref/index`. However, these guides will help -you quickly accomplish common tasks. +Practical guides covering common tasks and problems. + +Models, data and databases +========================== + +.. toctree:: + :maxdepth: 1 + + initial-data + legacy-databases + custom-model-fields + writing-migrations + custom-lookups + +Templates and output +==================== + +.. toctree:: + :maxdepth: 1 + + outputting-csv + outputting-pdf + overriding-templates + custom-template-backend + custom-template-tags + +Project configuration and management +==================================== + +.. toctree:: + :maxdepth: 1 + + static-files/index + logging + error-reporting + delete-app + +Installing, deploying and upgrading +=================================== + +.. toctree:: + :maxdepth: 1 + + upgrade-version + windows + deployment/index + static-files/deployment + +Other guides +============ .. toctree:: :maxdepth: 1 @@ -13,25 +59,7 @@ you quickly accomplish common tasks. auth-remote-user csrf custom-management-commands - custom-model-fields - custom-lookups - custom-template-backend - custom-template-tags custom-file-storage - deployment/index - upgrade-version - error-reporting - initial-data - legacy-databases - logging - outputting-csv - outputting-pdf - overriding-templates - static-files/index - static-files/deployment - windows - writing-migrations - delete-app .. seealso:: From 04adff9f98a93a546d7b4d7453b80965233d22a3 Mon Sep 17 00:00:00 2001 From: David Smith <39445562+smithdc1@users.noreply.github.com> Date: Tue, 22 Oct 2024 21:24:36 +0100 Subject: [PATCH 025/132] Refs #34406 -- Added support for GDAL curved geometries. Co-authored-by: Fabien Le Frapper --- django/contrib/gis/gdal/geometries.py | 63 +++++++++- django/contrib/gis/gdal/prototypes/geom.py | 7 ++ docs/ref/contrib/gis/gdal.txt | 20 +++ docs/releases/5.2.txt | 6 +- tests/gis_tests/data/geometries.json | 82 ++++++++++++ tests/gis_tests/gdal_tests/test_geom.py | 137 ++++++++++++++++++--- 6 files changed, 292 insertions(+), 23 deletions(-) diff --git a/django/contrib/gis/gdal/geometries.py b/django/contrib/gis/gdal/geometries.py index 44e1026e3f..9e712037c0 100644 --- a/django/contrib/gis/gdal/geometries.py +++ b/django/contrib/gis/gdal/geometries.py @@ -64,6 +64,7 @@ class OGRGeometry(GDALBase): """Encapsulate an OGR geometry.""" destructor = capi.destroy_geom + geos_support = True def __init__(self, geom_input, srs=None): """Initialize Geometry on either WKT or an OGR pointer as input.""" @@ -304,6 +305,19 @@ class OGRGeometry(GDALBase): f"Input to 'set_measured' must be a boolean, got '{value!r}'." ) + @property + def has_curve(self): + """Return True if the geometry is or has curve geometry.""" + return capi.has_curve_geom(self.ptr, 0) + + def get_linear_geometry(self): + """Return a linear version of this geometry.""" + return OGRGeometry(capi.get_linear_geom(self.ptr, 0, None)) + + def get_curve_geometry(self): + """Return a curve version of this geometry.""" + return OGRGeometry(capi.get_curve_geom(self.ptr, None)) + # #### SpatialReference-related Properties #### # The SRS property @@ -360,9 +374,14 @@ class OGRGeometry(GDALBase): @property def geos(self): "Return a GEOSGeometry object from this OGRGeometry." - from django.contrib.gis.geos import GEOSGeometry + if self.geos_support: + from django.contrib.gis.geos import GEOSGeometry - return GEOSGeometry(self._geos_ptr(), self.srid) + return GEOSGeometry(self._geos_ptr(), self.srid) + else: + from django.contrib.gis.geos import GEOSException + + raise GEOSException(f"GEOS does not support {self.__class__.__qualname__}.") @property def gml(self): @@ -727,6 +746,18 @@ class Polygon(OGRGeometry): return sum(self[i].point_count for i in range(self.geom_count)) +class CircularString(LineString): + geos_support = False + + +class CurvePolygon(Polygon): + geos_support = False + + +class CompoundCurve(OGRGeometry): + geos_support = False + + # Geometry Collection base class. class GeometryCollection(OGRGeometry): "The Geometry Collection class." @@ -788,6 +819,14 @@ class MultiPolygon(GeometryCollection): pass +class MultiSurface(GeometryCollection): + geos_support = False + + +class MultiCurve(GeometryCollection): + geos_support = False + + # Class mapping dictionary (using the OGRwkbGeometryType as the key) GEO_CLASSES = { 1: Point, @@ -797,7 +836,17 @@ GEO_CLASSES = { 5: MultiLineString, 6: MultiPolygon, 7: GeometryCollection, + 8: CircularString, + 9: CompoundCurve, + 10: CurvePolygon, + 11: MultiCurve, + 12: MultiSurface, 101: LinearRing, + 1008: CircularString, # CIRCULARSTRING Z + 1009: CompoundCurve, # COMPOUNDCURVE Z + 1010: CurvePolygon, # CURVEPOLYGON Z + 1011: MultiCurve, # MULTICURVE Z + 1012: MultiSurface, # MULTICURVE Z 2001: Point, # POINT M 2002: LineString, # LINESTRING M 2003: Polygon, # POLYGON M @@ -805,6 +854,11 @@ GEO_CLASSES = { 2005: MultiLineString, # MULTILINESTRING M 2006: MultiPolygon, # MULTIPOLYGON M 2007: GeometryCollection, # GEOMETRYCOLLECTION M + 2008: CircularString, # CIRCULARSTRING M + 2009: CompoundCurve, # COMPOUNDCURVE M + 2010: CurvePolygon, # CURVEPOLYGON M + 2011: MultiCurve, # MULTICURVE M + 2012: MultiSurface, # MULTICURVE M 3001: Point, # POINT ZM 3002: LineString, # LINESTRING ZM 3003: Polygon, # POLYGON ZM @@ -812,6 +866,11 @@ GEO_CLASSES = { 3005: MultiLineString, # MULTILINESTRING ZM 3006: MultiPolygon, # MULTIPOLYGON ZM 3007: GeometryCollection, # GEOMETRYCOLLECTION ZM + 3008: CircularString, # CIRCULARSTRING ZM + 3009: CompoundCurve, # COMPOUNDCURVE ZM + 3010: CurvePolygon, # CURVEPOLYGON ZM + 3011: MultiCurve, # MULTICURVE ZM + 3012: MultiSurface, # MULTISURFACE ZM 1 + OGRGeomType.wkb25bit: Point, # POINT Z 2 + OGRGeomType.wkb25bit: LineString, # LINESTRING Z 3 + OGRGeomType.wkb25bit: Polygon, # POLYGON Z diff --git a/django/contrib/gis/gdal/prototypes/geom.py b/django/contrib/gis/gdal/prototypes/geom.py index 25af48570b..9066dbd423 100644 --- a/django/contrib/gis/gdal/prototypes/geom.py +++ b/django/contrib/gis/gdal/prototypes/geom.py @@ -85,6 +85,13 @@ is_3d = bool_output(lgdal.OGR_G_Is3D, [c_void_p]) set_3d = void_output(lgdal.OGR_G_Set3D, [c_void_p, c_int], errcheck=False) is_measured = bool_output(lgdal.OGR_G_IsMeasured, [c_void_p]) set_measured = void_output(lgdal.OGR_G_SetMeasured, [c_void_p, c_int], errcheck=False) +has_curve_geom = bool_output(lgdal.OGR_G_HasCurveGeometry, [c_void_p, c_int]) +get_linear_geom = geom_output( + lgdal.OGR_G_GetLinearGeometry, [c_void_p, c_double, POINTER(c_char_p)] +) +get_curve_geom = geom_output( + lgdal.OGR_G_GetCurveGeometry, [c_void_p, POINTER(c_char_p)] +) # Geometry modification routines. add_geom = void_output(lgdal.OGR_G_AddGeometry, [c_void_p, c_void_p]) diff --git a/docs/ref/contrib/gis/gdal.txt b/docs/ref/contrib/gis/gdal.txt index c2a333f895..726cd83756 100644 --- a/docs/ref/contrib/gis/gdal.txt +++ b/docs/ref/contrib/gis/gdal.txt @@ -611,6 +611,26 @@ coordinate transformation: >>> polygon.geom_count 1 + .. attribute:: has_curve + + .. versionadded:: 5.2 + + A boolean indicating if this geometry is or contains a curve geometry. + + .. method:: get_linear_geometry + + .. versionadded:: 5.2 + + Returns a linear version of the geometry. If no conversion can be made, the + original geometry is returned. + + .. method:: get_curve_geometry + + .. versionadded:: 5.2 + + Returns a curved version of the geometry. If no conversion can be made, the + original geometry is returned. + .. attribute:: point_count Returns the number of points used to describe this geometry: diff --git a/docs/releases/5.2.txt b/docs/releases/5.2.txt index 9090f8b70a..507676d998 100644 --- a/docs/releases/5.2.txt +++ b/docs/releases/5.2.txt @@ -94,7 +94,11 @@ Minor features :mod:`django.contrib.gis` ~~~~~~~~~~~~~~~~~~~~~~~~~ -* ... +* GDAL now supports curved geometries ``CurvePolygon``, ``CompoundCurve``, + ``CircularString``, ``MultiSurface``, and ``MultiCurve`` via the new + :attr:`.OGRGeometry.has_curve` property, and the + :meth:`.OGRGeometry.get_linear_geometry` and + :meth:`.OGRGeometry.get_curve_geometry` methods. :mod:`django.contrib.messages` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/tests/gis_tests/data/geometries.json b/tests/gis_tests/data/geometries.json index 7786f26e9b..eb6c64b6d9 100644 --- a/tests/gis_tests/data/geometries.json +++ b/tests/gis_tests/data/geometries.json @@ -137,5 +137,87 @@ "union_geoms": [ {"wkt": "POLYGON ((-5 0,-5 10,5 10,5 5,10 5,10 -5,0 -5,0 0,-5 0))"}, {"wkt": "POLYGON ((2 0, 2 15, 18 15, 18 0, 2 0))"} + ], +"curved_geoms": [ + {"wkt": "CIRCULARSTRING(1 5, 6 2, 7 3)", + "name": "CircularString", + "num": 8 + }, + {"wkt": "COMPOUNDCURVE((5 3, 5 13), CIRCULARSTRING(5 13, 7 15, 9 13), (9 13, 9 3), CIRCULARSTRING(9 3, 7 1, 5 3))", + "name": "CompoundCurve", + "num": 9 + }, + {"wkt": "CURVEPOLYGON(CIRCULARSTRING(0 0, 4 0, 4 4, 0 4, 0 0),(1 1, 3 3, 3 1, 1 1))", + "name": "CurvePolygon", + "num": 10 + }, + {"wkt": "MULTICURVE((0 0, 5 5), CIRCULARSTRING(4 0, 4 4, 8 4))", + "name": "MultiCurve", + "num": 11 + }, + {"wkt": "MULTISURFACE(((0 0, 0 1, 1 1, 1 0, 0 0)), ((1 1, 1 2, 2 2, 2 1, 1 1)))", + "name": "MultiSurface", + "num": 12 + }, + {"wkt": "CIRCULARSTRING Z (1 5 1, 6 2 2, 7 3 3)", + "name": "CircularStringZ", + "num": 1008 + }, + {"wkt": "COMPOUNDCURVE Z ((5 3 0, 5 13 0), CIRCULARSTRING Z (5 13 0, 7 15 0, 9 13 0), (9 13 0 , 9 3 0), CIRCULARSTRING(9 3 0, 7 1 0, 5 3 0))", + "name": "CompoundCurveZ", + "num": 1009 + }, + {"wkt": "CURVEPOLYGON Z(CIRCULARSTRING Z (0 0 0, 4 0 0, 4 4 0, 0 4 0, 0 0 0),(1 1 0, 3 3 0, 3 1 0, 1 1 0))", + "name": "CurvePolygonZ", + "num": 1010 + }, + {"wkt": "MULTICURVE Z ((0 0 1, 5 5 2), CIRCULARSTRING Z (4 0 0, 4 4 0, 8 4 0))", + "name": "MultiCurveZ", + "num": 1011 + }, + {"wkt": "MULTISURFACE Z (((0 0 1, 0 1 2, 1 1 3, 1 0 4, 0 0 5)), ((1 1 0, 1 2 0, 2 2 0, 2 1 0, 1 1 0)))", + "name": "MultiSurfaceZ", + "num": 1012 + }, + {"wkt": "CIRCULARSTRING M (1 5 1, 6 2 2, 7 3 3)", + "name": "CircularStringM", + "num": 2008 + }, + {"wkt": "COMPOUNDCURVE M ((5 3 0, 5 13 0), CIRCULARSTRING M (5 13 0, 7 15 0, 9 13 0), (9 13 0 , 9 3 0), CIRCULARSTRING M (9 3 0, 7 1 0, 5 3 0))", + "name": "CompoundCurveM", + "num": 2009 + }, + {"wkt": "CURVEPOLYGON M (CIRCULARSTRING M (0 0 0, 4 0 0, 4 4 0, 0 4 0, 0 0 0),(1 1 0, 3 3 1, 3 1 1, 1 1 2))", + "name": "CurvePolygonM", + "num": 2010 + }, + {"wkt": "MULTICURVE M ((0 0 1, 5 5 2), CIRCULARSTRING M (4 0 0, 4 4 0, 8 4 0))", + "name": "MultiCurveM", + "num": 2011 + }, + {"wkt": "MULTISURFACE M (((0 0 1, 0 1 2, 1 1 3, 1 0 4, 0 0 5)), ((1 1 0, 1 2 0, 2 2 0, 2 1 0, 1 1 0)))", + "name": "MultiSurfaceM", + "num": 2012 + }, + {"wkt": "CIRCULARSTRING ZM (1 5 0 1, 6 2 0 2, 7 3 0 3)", + "name": "CircularStringZM", + "num": 3008 + }, + {"wkt": "COMPOUNDCURVE ZM ((5 3 0 0, 5 13 0 0), CIRCULARSTRING ZM (5 13 0 0, 7 15 0 0, 9 13 0 0), (9 13 0 0, 9 3 0 0), CIRCULARSTRING ZM (9 3 0 0, 7 1 0 0, 5 3 0 0))", + "name": "CompoundCurveZM", + "num": 3009 + }, + {"wkt": "CURVEPOLYGON ZM (CIRCULARSTRING ZM (0 0 0 0, 4 0 0 0, 4 4 0 0, 0 4 0 0, 0 0 0 0), (1 1 0 0, 3 3 0 0, 3 1 0 0, 1 1 0 0))", + "name": "CurvePolygonZM", + "num": 3010 + }, + {"wkt": "MULTICURVE ZM ((0 0 0 1, 5 5 0 2), CIRCULARSTRING ZM (4 0 0 0, 4 4 0 0, 8 4 0 0))", + "name": "MultiCurveZM", + "num": 3011 + }, + {"wkt": "MULTISURFACE ZM (((0 0 0 1, 0 1 0 2, 1 1 0 3, 1 0 0 4, 0 0 0 5)), ((1 1 0 0, 1 2 0 0, 2 2 0 0, 2 1 0 0, 1 1 0 0)))", + "name": "MultiSurfaceZM", + "num": 3012 + } ] } diff --git a/tests/gis_tests/gdal_tests/test_geom.py b/tests/gis_tests/gdal_tests/test_geom.py index 5c23a6f2cf..6c551d0804 100644 --- a/tests/gis_tests/gdal_tests/test_geom.py +++ b/tests/gis_tests/gdal_tests/test_geom.py @@ -8,6 +8,8 @@ from django.contrib.gis.gdal import ( OGRGeomType, SpatialReference, ) +from django.contrib.gis.gdal.geometries import CircularString, CurvePolygon +from django.contrib.gis.geos import GEOSException from django.template import Context from django.template.engine import Engine from django.test import SimpleTestCase @@ -646,11 +648,11 @@ class OGRGeomTest(SimpleTestCase, TestDataMixin): ("Multilinestring", 5, True), ("MultiPolygon", 6, True), ("GeometryCollection", 7, True), - ("CircularString", 8, False), - ("CompoundCurve", 9, False), - ("CurvePolygon", 10, False), - ("MultiCurve", 11, False), - ("MultiSurface", 12, False), + ("CircularString", 8, True), + ("CompoundCurve", 9, True), + ("CurvePolygon", 10, True), + ("MultiCurve", 11, True), + ("MultiSurface", 12, True), # 13 (Curve) and 14 (Surface) are abstract types. ("PolyhedralSurface", 15, False), ("TIN", 16, False), @@ -664,11 +666,11 @@ class OGRGeomTest(SimpleTestCase, TestDataMixin): ("Multilinestring Z", -2147483643, True), # 1005 ("MultiPolygon Z", -2147483642, True), # 1006 ("GeometryCollection Z", -2147483641, True), # 1007 - ("CircularString Z", 1008, False), - ("CompoundCurve Z", 1009, False), - ("CurvePolygon Z", 1010, False), - ("MultiCurve Z", 1011, False), - ("MultiSurface Z", 1012, False), + ("CircularString Z", 1008, True), + ("CompoundCurve Z", 1009, True), + ("CurvePolygon Z", 1010, True), + ("MultiCurve Z", 1011, True), + ("MultiSurface Z", 1012, True), ("PolyhedralSurface Z", 1015, False), ("TIN Z", 1016, False), ("Triangle Z", 1017, False), @@ -679,11 +681,11 @@ class OGRGeomTest(SimpleTestCase, TestDataMixin): ("MultiLineString M", 2005, True), ("MultiPolygon M", 2006, True), ("GeometryCollection M", 2007, True), - ("CircularString M", 2008, False), - ("CompoundCurve M", 2009, False), - ("CurvePolygon M", 2010, False), - ("MultiCurve M", 2011, False), - ("MultiSurface M", 2012, False), + ("CircularString M", 2008, True), + ("CompoundCurve M", 2009, True), + ("CurvePolygon M", 2010, True), + ("MultiCurve M", 2011, True), + ("MultiSurface M", 2012, True), ("PolyhedralSurface M", 2015, False), ("TIN M", 2016, False), ("Triangle M", 2017, False), @@ -694,11 +696,11 @@ class OGRGeomTest(SimpleTestCase, TestDataMixin): ("MultiLineString ZM", 3005, True), ("MultiPolygon ZM", 3006, True), ("GeometryCollection ZM", 3007, True), - ("CircularString ZM", 3008, False), - ("CompoundCurve ZM", 3009, False), - ("CurvePolygon ZM", 3010, False), - ("MultiCurve ZM", 3011, False), - ("MultiSurface ZM", 3012, False), + ("CircularString ZM", 3008, True), + ("CompoundCurve ZM", 3009, True), + ("CurvePolygon ZM", 3010, True), + ("MultiCurve ZM", 3011, True), + ("MultiSurface ZM", 3012, True), ("PolyhedralSurface ZM", 3015, False), ("TIN ZM", 3016, False), ("Triangle ZM", 3017, False), @@ -967,6 +969,101 @@ class OGRGeomTest(SimpleTestCase, TestDataMixin): geom = OGRGeometry(geom_input) self.assertIs(geom.is_measured, True) + def test_has_curve(self): + for geom in self.geometries.curved_geoms: + with self.subTest(wkt=geom.wkt): + geom = OGRGeometry(geom.wkt) + self.assertIs(geom.has_curve, True) + msg = f"GEOS does not support {geom.__class__.__qualname__}." + with self.assertRaisesMessage(GEOSException, msg): + geom.geos + geom = OGRGeometry("POINT (0 1)") + self.assertIs(geom.has_curve, False) + + def test_get_linear_geometry(self): + geom = OGRGeometry("CIRCULARSTRING (-0.797 0.466,-0.481 0.62,-0.419 0.473)") + linear = geom.get_linear_geometry() + self.assertEqual(linear.geom_name, "LINESTRING") + self.assertIs(linear.has_curve, False) + + def test_get_linear_geometry_no_conversion_possible(self): + wkt = "POINT (0 0)" + geom = OGRGeometry(wkt) + geom2 = geom.get_linear_geometry() + self.assertEqual(geom2.wkt, wkt) + + def test_get_curve_geometry(self): + linear_string = OGRGeometry( + "LINESTRING (-0.797 0.466,-0.797500910583869 0.479079607685707," + "-0.797096828208069 0.49216256476959,-0.795789684575482 0.505186328593822," + "-0.793585728444384 0.518088639471983,-0.79049549575663 0.530807818319715," + "-0.786533759270668 0.543283061509385,-0.781719457941079 0.555454731539925," + "-0.776075606381369 0.567264642132187,-0.769629184843353 0.578656336386302," + "-0.76241101023902 0.589575356672327,-0.754455588821145 0.599969504963013," + "-0.745800951227352 0.609789092364991,-0.736488470675795 0.618987176654798," + "-0.726562665181888 0.627519786684672,-0.716070984741265 0.635346132585369," + "-0.705063584496685 0.642428800760598,-0.693593084972889 0.648733932741749," + "-0.681714320525941 0.654231387047048,-0.669484077209319 0.658894883272069," + "-0.656960821309923 0.662702127722269,-0.644204419852031 0.665634919987354," + "-0.631275854404748 0.667679239947688,-0.618236929561618 0.668825314797118," + "-0.60514997748578 0.669067665761503,-0.592077559933017 0.66840513428977," + "-0.579082169177269 0.666840887592428,-0.566225929268313 0.664382403500809," + "-0.553570299049824 0.661041434719465,-0.541175778357228 0.656833952642756," + "-0.529101618800212 0.651780071004197,-0.5174055405123 0.645903949723276," + "-0.506143456221622 0.639233679409784,-0.495369203961872 0.631801147077652," + "-0.485134289701335 0.623641883709865,-0.475487641120239 0.614794894404014," + "-0.46647537371355 0.605302471909454,-0.458140570337321 0.595209994448282," + "-0.450523075252448 0.58456570878613,-0.443659303650563 0.573420499590156," + "-0.437582067572208 0.561827646176397,-0.432320419050072 0.549842567809747," + "-0.427899511226613 0.537522558773986,-0.424340478110267 0.524926514478182," + "-0.421660333544978 0.512114649909193,-0.419871889876113 0.499148211775737," + "-0.418983696701434 0.486089185720561,-0.419 0.473)" + ) + curve = linear_string.get_curve_geometry() + self.assertEqual(curve.geom_name, "CIRCULARSTRING") + self.assertEqual( + curve.wkt, + "CIRCULARSTRING (-0.797 0.466,-0.618236929561618 " + "0.668825314797118,-0.419 0.473)", + ) + + def test_get_curve_geometry_no_conversion_possible(self): + geom = OGRGeometry("LINESTRING (0 0, 1 0, 2 0)") + geom2 = geom.get_curve_geometry() + self.assertEqual(geom2.wkt, geom.wkt) + + def test_curved_geometries(self): + for geom in self.geometries.curved_geoms: + with self.subTest(wkt=geom.wkt, geom_name=geom.name): + g = OGRGeometry(geom.wkt) + self.assertEqual(geom.name, g.geom_type.name) + self.assertEqual(geom.num, g.geom_type.num) + msg = f"GEOS does not support {g.__class__.__qualname__}." + with self.assertRaisesMessage(GEOSException, msg): + g.geos + + def test_circularstring_has_linestring_features(self): + geom = OGRGeometry("CIRCULARSTRING ZM (1 5 0 1, 6 2 0 2, 7 3 0 3)") + self.assertIsInstance(geom, CircularString) + self.assertEqual(geom.x, [1, 6, 7]) + self.assertEqual(geom.y, [5, 2, 3]) + self.assertEqual(geom.z, [0, 0, 0]) + self.assertEqual(geom.m, [1, 2, 3]) + self.assertEqual( + geom.tuple, + ((1.0, 5.0, 0.0, 1.0), (6.0, 2.0, 0.0, 2.0), (7.0, 3.0, 0.0, 3.0)), + ) + self.assertEqual(geom[0], (1, 5, 0, 1)) + self.assertEqual(len(geom), 3) + + def test_curvepolygon_has_polygon_features(self): + geom = OGRGeometry( + "CURVEPOLYGON ZM (CIRCULARSTRING ZM (0 0 0 0, 4 0 0 0, 4 4 0 0, 0 4 0 0, " + "0 0 0 0), (1 1 0 0, 3 3 0 0, 3 1 0 0, 1 1 0 0))" + ) + self.assertIsInstance(geom, CurvePolygon) + self.assertIsInstance(geom.shell, CircularString) + class DeprecationTests(SimpleTestCase): def test_coord_setter_deprecation(self): From 35ab2e018214479fa712d73f070198299ef670a1 Mon Sep 17 00:00:00 2001 From: Yash Date: Wed, 16 Oct 2024 14:38:31 +0530 Subject: [PATCH 026/132] Fixed #35731 -- Extended db_default docs. This added a missing db_default reference in docs/topics/db/models.txt, and added a reference to the DatabaseDefault object. --- docs/ref/models/fields.txt | 5 +++++ docs/topics/db/models.txt | 9 +++++++++ 2 files changed, 14 insertions(+) diff --git a/docs/ref/models/fields.txt b/docs/ref/models/fields.txt index febb45108d..b2da1b519c 100644 --- a/docs/ref/models/fields.txt +++ b/docs/ref/models/fields.txt @@ -426,6 +426,11 @@ precedence when creating instances in Python code. ``db_default`` will still be set at the database level and will be used when inserting rows outside of the ORM or when adding a new field in a migration. +If a field has a ``db_default`` without a ``default`` set and no value is +assigned to the field, a ``DatabaseDefault`` object is returned as the field +value on unsaved model instances. The actual value for the field is determined +by the database when the model instance is saved. + ``db_index`` ------------ diff --git a/docs/topics/db/models.txt b/docs/topics/db/models.txt index e7bc1681fb..f7f575eb3f 100644 --- a/docs/topics/db/models.txt +++ b/docs/topics/db/models.txt @@ -224,6 +224,15 @@ ones: object. If callable it will be called every time a new object is created. +:attr:`~Field.db_default` + The database-computed default value for the field. This can be a literal + value or a database function. + + If both ``db_default`` and :attr:`Field.default` are set, ``default`` will + take precedence when creating instances in Python code. ``db_default`` will + still be set at the database level and will be used when inserting rows + outside of the ORM or when adding a new field in a migration. + :attr:`~Field.help_text` Extra "help" text to be displayed with the form widget. It's useful for documentation even if your field isn't used on a form. From be138f32ed32a4bf3e62305145423285e462c853 Mon Sep 17 00:00:00 2001 From: Clifford Gama Date: Thu, 17 Oct 2024 17:59:58 +0200 Subject: [PATCH 027/132] Refs #28999 -- Added tests for reversing a class-based view by instance. --- tests/urlpatterns_reverse/tests.py | 9 +++++++++ tests/urlpatterns_reverse/urls.py | 3 +++ tests/urlpatterns_reverse/views.py | 9 ++++++++- 3 files changed, 20 insertions(+), 1 deletion(-) diff --git a/tests/urlpatterns_reverse/tests.py b/tests/urlpatterns_reverse/tests.py index 5843382a8c..216545b5f5 100644 --- a/tests/urlpatterns_reverse/tests.py +++ b/tests/urlpatterns_reverse/tests.py @@ -522,6 +522,15 @@ class URLPatternReverse(SimpleTestCase): with self.assertRaisesMessage(NoReverseMatch, msg): reverse("places", kwargs={"arg1": 2}) + def test_func_view_from_cbv(self): + expected = "/hello/world/" + url = reverse(views.view_func_from_cbv, kwargs={"name": "world"}) + self.assertEqual(url, expected) + + def test_func_view_from_cbv_no_expected_kwarg(self): + with self.assertRaises(NoReverseMatch): + reverse(views.view_func_from_cbv) + class ResolverTests(SimpleTestCase): def test_resolver_repr(self): diff --git a/tests/urlpatterns_reverse/urls.py b/tests/urlpatterns_reverse/urls.py index c745331483..5bf20a3f63 100644 --- a/tests/urlpatterns_reverse/urls.py +++ b/tests/urlpatterns_reverse/urls.py @@ -8,6 +8,7 @@ from .views import ( empty_view_partial, empty_view_wrapped, nested_view, + view_func_from_cbv, ) other_patterns = [ @@ -136,4 +137,6 @@ urlpatterns = [ path("includes/", include(other_patterns)), # Security tests re_path("(.+)/security/$", empty_view, name="security"), + # View function from cbv + path("hello//", view_func_from_cbv), ] diff --git a/tests/urlpatterns_reverse/views.py b/tests/urlpatterns_reverse/views.py index 17c7fe1c3d..aa55917ec0 100644 --- a/tests/urlpatterns_reverse/views.py +++ b/tests/urlpatterns_reverse/views.py @@ -3,7 +3,7 @@ from functools import partial, update_wrapper from django.contrib.auth.decorators import user_passes_test from django.http import HttpResponse from django.urls import reverse_lazy -from django.views.generic import RedirectView +from django.views.generic import RedirectView, View def empty_view(request, *args, **kwargs): @@ -58,6 +58,13 @@ def bad_view(request, *args, **kwargs): raise ValueError("I don't think I'm getting good value for this view") +class _HelloView(View): + def get(self, request, *args, **kwargs): + return HttpResponse(f"Hello {self.kwargs['name']}") + + +view_func_from_cbv = _HelloView.as_view() + empty_view_partial = partial(empty_view, template_name="template.html") empty_view_nested_partial = partial( empty_view_partial, template_name="nested_partial.html" From 4d11ea1ef01eba14b3a48a727f07f723f782fd84 Mon Sep 17 00:00:00 2001 From: Clifford Gama Date: Tue, 22 Oct 2024 14:12:02 +0200 Subject: [PATCH 028/132] Fixed #28999 -- Documented how to reverse a class-based view by instance. Co-authored-by: Sarah Boyce <42296566+sarahboyce@users.noreply.github.com> --- docs/ref/urlresolvers.txt | 23 ++++++++++++++++++++++- tests/urlpatterns_reverse/tests.py | 4 ++-- tests/urlpatterns_reverse/urls.py | 2 +- tests/urlpatterns_reverse/views.py | 4 ++-- 4 files changed, 27 insertions(+), 6 deletions(-) diff --git a/docs/ref/urlresolvers.txt b/docs/ref/urlresolvers.txt index b335d1fc39..3c3be76e75 100644 --- a/docs/ref/urlresolvers.txt +++ b/docs/ref/urlresolvers.txt @@ -13,7 +13,8 @@ your code, Django provides the following function: .. function:: reverse(viewname, urlconf=None, args=None, kwargs=None, current_app=None) ``viewname`` can be a :ref:`URL pattern name ` or the -callable view object. For example, given the following ``url``:: +callable view object used in the URLconf. For example, given the following +``url``:: from news import views @@ -79,6 +80,26 @@ use for reversing. By default, the root URLconf for the current thread is used. Applying further encoding (such as :func:`urllib.parse.quote`) to the output of ``reverse()`` may produce undesirable results. +.. admonition:: Reversing class-based views by view object + + The view object can also be the result of calling + :meth:`~django.views.generic.base.View.as_view` if the same view object is + used in the URLConf. Following the original example, the view object could + be defined as: + + .. code-block:: python + :caption: ``news/views.py`` + + from django.views import View + + + class ArchiveView(View): ... + + + archive = ArchiveView.as_view() + + However, remember that namespaced views cannot be reversed by view object. + ``reverse_lazy()`` ================== diff --git a/tests/urlpatterns_reverse/tests.py b/tests/urlpatterns_reverse/tests.py index 216545b5f5..91d3f237ec 100644 --- a/tests/urlpatterns_reverse/tests.py +++ b/tests/urlpatterns_reverse/tests.py @@ -522,12 +522,12 @@ class URLPatternReverse(SimpleTestCase): with self.assertRaisesMessage(NoReverseMatch, msg): reverse("places", kwargs={"arg1": 2}) - def test_func_view_from_cbv(self): + def test_view_func_from_cbv(self): expected = "/hello/world/" url = reverse(views.view_func_from_cbv, kwargs={"name": "world"}) self.assertEqual(url, expected) - def test_func_view_from_cbv_no_expected_kwarg(self): + def test_view_func_from_cbv_no_expected_kwarg(self): with self.assertRaises(NoReverseMatch): reverse(views.view_func_from_cbv) diff --git a/tests/urlpatterns_reverse/urls.py b/tests/urlpatterns_reverse/urls.py index 5bf20a3f63..aca2d06ef7 100644 --- a/tests/urlpatterns_reverse/urls.py +++ b/tests/urlpatterns_reverse/urls.py @@ -137,6 +137,6 @@ urlpatterns = [ path("includes/", include(other_patterns)), # Security tests re_path("(.+)/security/$", empty_view, name="security"), - # View function from cbv + # View function from cbv. path("hello//", view_func_from_cbv), ] diff --git a/tests/urlpatterns_reverse/views.py b/tests/urlpatterns_reverse/views.py index aa55917ec0..01dfc1309e 100644 --- a/tests/urlpatterns_reverse/views.py +++ b/tests/urlpatterns_reverse/views.py @@ -58,12 +58,12 @@ def bad_view(request, *args, **kwargs): raise ValueError("I don't think I'm getting good value for this view") -class _HelloView(View): +class HelloView(View): def get(self, request, *args, **kwargs): return HttpResponse(f"Hello {self.kwargs['name']}") -view_func_from_cbv = _HelloView.as_view() +view_func_from_cbv = HelloView.as_view() empty_view_partial = partial(empty_view, template_name="template.html") empty_view_nested_partial = partial( From de2bb73904009313bae3664ef71edfd60df9912b Mon Sep 17 00:00:00 2001 From: David D Lowe Date: Wed, 23 Oct 2024 18:20:36 +0100 Subject: [PATCH 029/132] Doc'd that unusable passwords are defined by metadata in the password field. --- docs/ref/contrib/auth.txt | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/docs/ref/contrib/auth.txt b/docs/ref/contrib/auth.txt index c8699a2913..103aff8e0b 100644 --- a/docs/ref/contrib/auth.txt +++ b/docs/ref/contrib/auth.txt @@ -54,7 +54,8 @@ Fields Required. A hash of, and metadata about, the password. (Django doesn't store the raw password.) Raw passwords can be arbitrarily long and can - contain any character. See the :doc:`password documentation + contain any character. The metadata in this field may mark the password + as unusable. See the :doc:`password documentation `. .. attribute:: groups @@ -175,8 +176,9 @@ Methods .. method:: set_unusable_password() - Marks the user as having no password set. This isn't the same as - having a blank string for a password. + Marks the user as having no password set by updating the metadata in + the :attr:`~django.contrib.auth.models.User.password` field. This isn't + the same as having a blank string for a password. :meth:`~django.contrib.auth.models.User.check_password()` for this user will never return ``True``. Doesn't save the :class:`~django.contrib.auth.models.User` object. From ef28b05767482bf9c98acc19ffd1334f75165b5a Mon Sep 17 00:00:00 2001 From: Mariusz Felisiak Date: Sat, 28 Sep 2024 20:55:21 +0200 Subject: [PATCH 030/132] Refs #35803 -- Added more tests for __coveredby and __covers GIS lookups. Co-authored-by: David Smith --- tests/gis_tests/geoapp/tests.py | 36 +++++++++++++++++++++++++++++++++ 1 file changed, 36 insertions(+) diff --git a/tests/gis_tests/geoapp/tests.py b/tests/gis_tests/geoapp/tests.py index 7ee47ee9a8..962d4f2217 100644 --- a/tests/gis_tests/geoapp/tests.py +++ b/tests/gis_tests/geoapp/tests.py @@ -496,6 +496,42 @@ class GeoLookupTest(TestCase): with self.assertNoLogs("django.contrib.gis", "ERROR"): State.objects.filter(poly__intersects="LINESTRING(0 0, 1 1, 5 5)") + @skipUnlessGISLookup("coveredby") + def test_coveredby_lookup(self): + poly = Polygon(LinearRing((0, 0), (0, 5), (5, 5), (5, 0), (0, 0))) + state = State.objects.create(name="Test", poly=poly) + + small_poly = Polygon(LinearRing((0, 0), (1, 4), (4, 4), (4, 1), (0, 0))) + qs = State.objects.filter(poly__coveredby=small_poly) + self.assertSequenceEqual(qs, []) + + large_poly = Polygon(LinearRing((0, 0), (-1, 6), (6, 6), (6, -1), (0, 0))) + qs = State.objects.filter(poly__coveredby=large_poly) + self.assertSequenceEqual(qs, [state]) + + if not connection.ops.oracle: + # On Oracle, COVEREDBY doesn't match for EQUAL objects. + qs = State.objects.filter(poly__coveredby=poly) + self.assertSequenceEqual(qs, [state]) + + @skipUnlessGISLookup("covers") + def test_covers_lookup(self): + poly = Polygon(LinearRing((0, 0), (0, 5), (5, 5), (5, 0), (0, 0))) + state = State.objects.create(name="Test", poly=poly) + + small_poly = Polygon(LinearRing((0, 0), (1, 4), (4, 4), (4, 1), (0, 0))) + qs = State.objects.filter(poly__covers=small_poly) + self.assertSequenceEqual(qs, [state]) + + large_poly = Polygon(LinearRing((-1, -1), (-1, 6), (6, 6), (6, -1), (-1, -1))) + qs = State.objects.filter(poly__covers=large_poly) + self.assertSequenceEqual(qs, []) + + if not connection.ops.oracle: + # On Oracle, COVERS doesn't match for EQUAL objects. + qs = State.objects.filter(poly__covers=poly) + self.assertSequenceEqual(qs, [state]) + @skipUnlessDBFeature("supports_relate_lookup") def test_relate_lookup(self): "Testing the 'relate' lookup type." From b8e9cdf13b7ab6621926a5d2aad3e2bb745aae00 Mon Sep 17 00:00:00 2001 From: koresi Date: Wed, 25 Sep 2024 03:57:20 +0200 Subject: [PATCH 031/132] Fixed #22828 -- Warned that ModelAdmin get hooks return the property itself rather a copy. --- docs/ref/contrib/admin/index.txt | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/docs/ref/contrib/admin/index.txt b/docs/ref/contrib/admin/index.txt index 407dd88e71..716e3180db 100644 --- a/docs/ref/contrib/admin/index.txt +++ b/docs/ref/contrib/admin/index.txt @@ -1465,6 +1465,27 @@ templates used by the :class:`ModelAdmin` views: See also :ref:`saving-objects-in-the-formset`. +.. warning:: + + All hooks that return a ``ModelAdmin`` property return the property itself + rather than a copy of its value. Dynamically modifying the value can lead + to surprising results. + + Let's take :meth:`ModelAdmin.get_readonly_fields` as an example:: + + class PersonAdmin(admin.ModelAdmin): + readonly_fields = ["name"] + + def get_readonly_fields(self, request, obj=None): + readonly = super().get_readonly_fields(request, obj) + if not request.user.is_superuser: + readonly.append("age") # Edits the class attribute. + return readonly + + This results in ``readonly_fields`` becoming + ``["name", "age", "age", ...]``, even for a superuser, as ``"age"`` is added + each time non-superuser visits the page. + .. method:: ModelAdmin.get_ordering(request) The ``get_ordering`` method takes a ``request`` as parameter and From 6ae0dc89c53e51ec1d74ffba630686ad1988466a Mon Sep 17 00:00:00 2001 From: AfiMaameDufie Date: Thu, 24 Oct 2024 09:28:52 +0200 Subject: [PATCH 032/132] Updated authentication solutions list on using REMOTE_USER how-to. --- docs/howto/auth-remote-user.txt | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/docs/howto/auth-remote-user.txt b/docs/howto/auth-remote-user.txt index 19b25432fe..f8492e367a 100644 --- a/docs/howto/auth-remote-user.txt +++ b/docs/howto/auth-remote-user.txt @@ -6,12 +6,11 @@ This document describes how to make use of external authentication sources (where the web server sets the ``REMOTE_USER`` environment variable) in your Django applications. This type of authentication solution is typically seen on intranet sites, with single sign-on solutions such as IIS and Integrated -Windows Authentication or Apache and `mod_authnz_ldap`_, `CAS`_, `Cosign`_, -`WebAuth`_, `mod_auth_sspi`_, etc. +Windows Authentication or Apache and `mod_authnz_ldap`_, `CAS`_, `WebAuth`_, +`mod_auth_sspi`_, etc. -.. _mod_authnz_ldap: https://httpd.apache.org/docs/2.2/mod/mod_authnz_ldap.html +.. _mod_authnz_ldap: https://httpd.apache.org/docs/current/mod/mod_authnz_ldap.html .. _CAS: https://www.apereo.org/projects/cas -.. _Cosign: http://weblogin.org .. _WebAuth: https://uit.stanford.edu/service/authentication .. _mod_auth_sspi: https://sourceforge.net/projects/mod-auth-sspi From 2d612162d8cabfe7dcfe07e097ec8d198b3ff8cd Mon Sep 17 00:00:00 2001 From: Paolo Melchiorre Date: Thu, 24 Oct 2024 09:43:43 +0200 Subject: [PATCH 033/132] Used webbroswer module in docs Makefile. --- docs/Makefile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/Makefile b/docs/Makefile index d97a7ff07c..596e7fc2dd 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -61,7 +61,7 @@ html: @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." htmlview: html - $(PYTHON) -c "import webbrowser; webbrowser.open('_build/html/index.html')" + $(PYTHON) -m webbrowser "$(BUILDDIR)/html/index.html" dirhtml: $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml From 34066d6cf3d66b8a3c7fac86912455dbb2ed0ed6 Mon Sep 17 00:00:00 2001 From: Mariusz Felisiak Date: Thu, 24 Oct 2024 16:41:37 +0200 Subject: [PATCH 034/132] Refs #35844 -- Fixed tests for test --parallel option on Python 3.14+. "forkserver" is the new default on POSIX systems, and Django doesn't support parallel tests with "forkserver": https://github.com/python/cpython/commit/b65f2cdfa77d8d12c213aec663ddaaa30d75a4b2 --- tests/test_runner/test_discover_runner.py | 1 + tests/test_runner/tests.py | 5 +++++ 2 files changed, 6 insertions(+) diff --git a/tests/test_runner/test_discover_runner.py b/tests/test_runner/test_discover_runner.py index a845f6dd67..4f13cceeff 100644 --- a/tests/test_runner/test_discover_runner.py +++ b/tests/test_runner/test_discover_runner.py @@ -45,6 +45,7 @@ def change_loader_patterns(patterns): @mock.patch.dict(os.environ, {}, clear=True) @mock.patch.object(multiprocessing, "cpu_count", return_value=12) # Python 3.8 on macOS defaults to 'spawn' mode. +# Python 3.14 on POSIX systems defaults to 'forkserver' mode. @mock.patch.object(multiprocessing, "get_start_method", return_value="fork") class DiscoverRunnerParallelArgumentTests(SimpleTestCase): def get_parser(self): diff --git a/tests/test_runner/tests.py b/tests/test_runner/tests.py index b900ff69ea..fba8dd3b6f 100644 --- a/tests/test_runner/tests.py +++ b/tests/test_runner/tests.py @@ -506,6 +506,7 @@ class ManageCommandTests(unittest.TestCase): @mock.patch.dict(os.environ, {}, clear=True) @mock.patch.object(multiprocessing, "cpu_count", return_value=12) class ManageCommandParallelTests(SimpleTestCase): + @mock.patch.object(multiprocessing, "get_start_method", return_value="fork") def test_parallel_default(self, *mocked_objects): with captured_stderr() as stderr: call_command( @@ -515,6 +516,7 @@ class ManageCommandParallelTests(SimpleTestCase): ) self.assertIn("parallel=12", stderr.getvalue()) + @mock.patch.object(multiprocessing, "get_start_method", return_value="fork") def test_parallel_auto(self, *mocked_objects): with captured_stderr() as stderr: call_command( @@ -550,12 +552,14 @@ class ManageCommandParallelTests(SimpleTestCase): self.assertEqual(stderr.getvalue(), "") @mock.patch.dict(os.environ, {"DJANGO_TEST_PROCESSES": "7"}) + @mock.patch.object(multiprocessing, "get_start_method", return_value="fork") def test_no_parallel_django_test_processes_env(self, *mocked_objects): with captured_stderr() as stderr: call_command("test", testrunner="test_runner.tests.MockTestRunner") self.assertEqual(stderr.getvalue(), "") @mock.patch.dict(os.environ, {"DJANGO_TEST_PROCESSES": "invalid"}) + @mock.patch.object(multiprocessing, "get_start_method", return_value="fork") def test_django_test_processes_env_non_int(self, *mocked_objects): with self.assertRaises(ValueError): call_command( @@ -565,6 +569,7 @@ class ManageCommandParallelTests(SimpleTestCase): ) @mock.patch.dict(os.environ, {"DJANGO_TEST_PROCESSES": "7"}) + @mock.patch.object(multiprocessing, "get_start_method", return_value="fork") def test_django_test_processes_parallel_default(self, *mocked_objects): for parallel in ["--parallel", "--parallel=auto"]: with self.subTest(parallel=parallel): From 6dcab75d5d8c2ef18de15323930057e6fa9ec00f Mon Sep 17 00:00:00 2001 From: Carlton Gibson Date: Thu, 24 Oct 2024 16:57:04 +0200 Subject: [PATCH 035/132] Refs #26029 -- Extended docs for the StorageHandler default instance. Third-party packages that provide storages need to rely on the StorageHandler API in order to allow users to use the `storages` module instance to override defaults. Minimally documenting these methods allows package authors to rely on them. Co-authored-by: Sarah Boyce <42296566+sarahboyce@users.noreply.github.com> --- docs/ref/files/storage.txt | 20 +++++++++++++++++++- 1 file changed, 19 insertions(+), 1 deletion(-) diff --git a/docs/ref/files/storage.txt b/docs/ref/files/storage.txt index f7c290a150..52c8f90427 100644 --- a/docs/ref/files/storage.txt +++ b/docs/ref/files/storage.txt @@ -11,7 +11,25 @@ Django provides convenient ways to access the default storage class: .. data:: storages - Storage instances as defined by :setting:`STORAGES`. + A dictionary-like object that allows retrieving a storage instance using + its alias as defined by :setting:`STORAGES`. + + ``storages`` has an attribute ``backends``, which defaults to the raw value + provided in :setting:`STORAGES`. + + Additionally, ``storages`` provides a ``create_storage()`` method that + accepts the dictionary used in :setting:`STORAGES` for a backend, and + returns a storage instance based on that backend definition. This may be + useful for third-party packages needing to instantiate storages in tests: + + .. code-block:: pycon + + >>> from django.core.files.storage import storages + >>> storages.backends + {'default': {'BACKEND': 'django.core.files.storage.FileSystemStorage'}, + 'staticfiles': {'BACKEND': 'django.contrib.staticfiles.storage.StaticFilesStorage'}, + 'custom': {'BACKEND': 'package.storage.CustomStorage'}} + >>> storage_instance = storages.create_storage({"BACKEND": "package.storage.CustomStorage"}) .. class:: DefaultStorage From 0b7edb9fcdd33d47ec5701b4f9b9553e27a88e95 Mon Sep 17 00:00:00 2001 From: Mariusz Felisiak Date: Fri, 27 Sep 2024 21:08:20 +0200 Subject: [PATCH 036/132] Refs #35803 -- Added support for __coveredby GIS lookup on MySQL and MariaDB 11.7+. --- .../gis/db/backends/mysql/operations.py | 3 + docs/ref/contrib/gis/db-api.txt | 70 +++++++++---------- docs/ref/contrib/gis/geoquerysets.txt | 8 ++- docs/releases/5.2.txt | 4 ++ 4 files changed, 49 insertions(+), 36 deletions(-) diff --git a/django/contrib/gis/db/backends/mysql/operations.py b/django/contrib/gis/db/backends/mysql/operations.py index 1004cfb564..f4533a3b4e 100644 --- a/django/contrib/gis/db/backends/mysql/operations.py +++ b/django/contrib/gis/db/backends/mysql/operations.py @@ -45,6 +45,7 @@ class MySQLOperations(BaseSpatialOperations, DatabaseOperations): "bboverlaps": SpatialOperator(func="MBROverlaps"), # ... "contained": SpatialOperator(func="MBRWithin"), # ... "contains": SpatialOperator(func="ST_Contains"), + "coveredby": SpatialOperator(func="MBRCoveredBy"), "crosses": SpatialOperator(func="ST_Crosses"), "disjoint": SpatialOperator(func="ST_Disjoint"), "equals": SpatialOperator(func="ST_Equals"), @@ -57,6 +58,8 @@ class MySQLOperations(BaseSpatialOperations, DatabaseOperations): } if self.connection.mysql_is_mariadb: operators["relate"] = SpatialOperator(func="ST_Relate") + if self.connection.mysql_version < (11, 7): + del operators["coveredby"] return operators @cached_property diff --git a/docs/ref/contrib/gis/db-api.txt b/docs/ref/contrib/gis/db-api.txt index bce6f2efcc..8afc29869e 100644 --- a/docs/ref/contrib/gis/db-api.txt +++ b/docs/ref/contrib/gis/db-api.txt @@ -339,42 +339,42 @@ divided into the three categories described in the :ref:`raster lookup details `: native support ``N``, bilateral native support ``B``, and geometry conversion support ``C``. -================================= ========= ======== ========= ============ ========== ======== -Lookup Type PostGIS Oracle MariaDB MySQL [#]_ SpatiaLite PGRaster -================================= ========= ======== ========= ============ ========== ======== -:lookup:`bbcontains` X X X X N -:lookup:`bboverlaps` X X X X N -:lookup:`contained` X X X X N -:lookup:`contains ` X X X X X B -:lookup:`contains_properly` X B -:lookup:`coveredby` X X X B -:lookup:`covers` X X X B -:lookup:`crosses` X X X X C -:lookup:`disjoint` X X X X X B -:lookup:`distance_gt` X X X X X N -:lookup:`distance_gte` X X X X X N -:lookup:`distance_lt` X X X X X N -:lookup:`distance_lte` X X X X X N -:lookup:`dwithin` X X X B -:lookup:`equals` X X X X X C -:lookup:`exact ` X X X X X B -:lookup:`intersects` X X X X X B +================================= ========= ======== ========== ============ ========== ======== +Lookup Type PostGIS Oracle MariaDB MySQL [#]_ SpatiaLite PGRaster +================================= ========= ======== ========== ============ ========== ======== +:lookup:`bbcontains` X X X X N +:lookup:`bboverlaps` X X X X N +:lookup:`contained` X X X X N +:lookup:`contains ` X X X X X B +:lookup:`contains_properly` X B +:lookup:`coveredby` X X X (≥ 11.7) X X B +:lookup:`covers` X X X B +:lookup:`crosses` X X X X C +:lookup:`disjoint` X X X X X B +:lookup:`distance_gt` X X X X X N +:lookup:`distance_gte` X X X X X N +:lookup:`distance_lt` X X X X X N +:lookup:`distance_lte` X X X X X N +:lookup:`dwithin` X X X B +:lookup:`equals` X X X X X C +:lookup:`exact ` X X X X X B +:lookup:`intersects` X X X X X B :lookup:`isempty` X -:lookup:`isvalid` X X X X -:lookup:`overlaps` X X X X X B -:lookup:`relate` X X X X C -:lookup:`same_as` X X X X X B -:lookup:`touches` X X X X X B -:lookup:`within` X X X X X B -:lookup:`left` X C -:lookup:`right` X C -:lookup:`overlaps_left` X B -:lookup:`overlaps_right` X B -:lookup:`overlaps_above` X C -:lookup:`overlaps_below` X C -:lookup:`strictly_above` X C -:lookup:`strictly_below` X C -================================= ========= ======== ========= ============ ========== ======== +:lookup:`isvalid` X X X X +:lookup:`overlaps` X X X X X B +:lookup:`relate` X X X X C +:lookup:`same_as` X X X X X B +:lookup:`touches` X X X X X B +:lookup:`within` X X X X X B +:lookup:`left` X C +:lookup:`right` X C +:lookup:`overlaps_left` X B +:lookup:`overlaps_right` X B +:lookup:`overlaps_above` X C +:lookup:`overlaps_below` X C +:lookup:`strictly_above` X C +:lookup:`strictly_below` X C +================================= ========= ======== ========== ============ ========== ======== .. _database-functions-compatibility: diff --git a/docs/ref/contrib/gis/geoquerysets.txt b/docs/ref/contrib/gis/geoquerysets.txt index b639c5271e..2bafa8eb43 100644 --- a/docs/ref/contrib/gis/geoquerysets.txt +++ b/docs/ref/contrib/gis/geoquerysets.txt @@ -183,7 +183,7 @@ PostGIS ``ST_ContainsProperly(poly, geom)`` ------------- *Availability*: `PostGIS `__, -Oracle, PGRaster (Bilateral), SpatiaLite +Oracle, MariaDB 11.7+, MySQL, PGRaster (Bilateral), SpatiaLite Tests if no point in the geometry field is outside the lookup geometry. [#fncovers]_ @@ -197,9 +197,15 @@ Backend SQL Equivalent ========== ============================= PostGIS ``ST_CoveredBy(poly, geom)`` Oracle ``SDO_COVEREDBY(poly, geom)`` +MariaDB ``MBRCoveredBy(poly, geom)`` +MySQL ``MBRCoveredBy(poly, geom)`` SpatiaLite ``CoveredBy(poly, geom)`` ========== ============================= +.. versionchanged:: 5.2 + + MySQL and MariaDB 11.7+ support was added. + .. fieldlookup:: covers ``covers`` diff --git a/docs/releases/5.2.txt b/docs/releases/5.2.txt index 507676d998..faee74548e 100644 --- a/docs/releases/5.2.txt +++ b/docs/releases/5.2.txt @@ -100,6 +100,10 @@ Minor features :meth:`.OGRGeometry.get_linear_geometry` and :meth:`.OGRGeometry.get_curve_geometry` methods. +* :lookup:`coveredby` lookup is now supported on MySQL. + +* :lookup:`coveredby` lookup is now supported on MariaDB 11.7+. + :mod:`django.contrib.messages` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ From c77573716a58af32ffcfc4fe87ff9e5c97909bd2 Mon Sep 17 00:00:00 2001 From: Mariusz Felisiak Date: Fri, 27 Sep 2024 22:26:35 +0200 Subject: [PATCH 037/132] Fixed #35803 -- Added support for Collect, GeoHash, and IsValid on MariaDB 11.7+. --- .../gis/db/backends/mysql/operations.py | 8 ++++-- docs/ref/contrib/gis/db-api.txt | 25 ++++++++--------- docs/ref/contrib/gis/functions.txt | 12 ++++++-- docs/ref/contrib/gis/geoquerysets.txt | 28 ++++++++++++------- docs/releases/5.2.txt | 6 +++- 5 files changed, 51 insertions(+), 28 deletions(-) diff --git a/django/contrib/gis/db/backends/mysql/operations.py b/django/contrib/gis/db/backends/mysql/operations.py index f4533a3b4e..e9aec1e96c 100644 --- a/django/contrib/gis/db/backends/mysql/operations.py +++ b/django/contrib/gis/db/backends/mysql/operations.py @@ -71,7 +71,10 @@ class MySQLOperations(BaseSpatialOperations, DatabaseOperations): models.Union, ] is_mariadb = self.connection.mysql_is_mariadb - if is_mariadb or self.connection.mysql_version < (8, 0, 24): + if is_mariadb: + if self.connection.mysql_version < (11, 7): + disallowed_aggregates.insert(0, models.Collect) + elif self.connection.mysql_version < (8, 0, 24): disallowed_aggregates.insert(0, models.Collect) return tuple(disallowed_aggregates) @@ -105,7 +108,8 @@ class MySQLOperations(BaseSpatialOperations, DatabaseOperations): } if self.connection.mysql_is_mariadb: unsupported.remove("PointOnSurface") - unsupported.update({"GeoHash", "IsValid"}) + if self.connection.mysql_version < (11, 7): + unsupported.update({"GeoHash", "IsValid"}) return unsupported def geo_db_type(self, f): diff --git a/docs/ref/contrib/gis/db-api.txt b/docs/ref/contrib/gis/db-api.txt index 8afc29869e..b587f1d9be 100644 --- a/docs/ref/contrib/gis/db-api.txt +++ b/docs/ref/contrib/gis/db-api.txt @@ -360,7 +360,7 @@ Lookup Type PostGIS Oracle MariaDB MySQL [#]_ S :lookup:`exact ` X X X X X B :lookup:`intersects` X X X X X B :lookup:`isempty` X -:lookup:`isvalid` X X X X +:lookup:`isvalid` X X X (≥ 11.7) X X :lookup:`overlaps` X X X X X B :lookup:`relate` X X X X C :lookup:`same_as` X X X X X B @@ -406,10 +406,10 @@ Function PostGIS Oracle MariaDB MySQL :class:`ForcePolygonCW` X X :class:`FromWKB` X X X X X :class:`FromWKT` X X X X X -:class:`GeoHash` X X X (LWGEOM/RTTOPO) +:class:`GeoHash` X X (≥ 11.7) X X (LWGEOM/RTTOPO) :class:`Intersection` X X X X X :class:`IsEmpty` X -:class:`IsValid` X X X X +:class:`IsValid` X X X (≥ 11.7) X X :class:`Length` X X X X X :class:`LineLocatePoint` X X :class:`MakeValid` X X (LWGEOM/RTTOPO) @@ -431,20 +431,19 @@ Aggregate Functions ------------------- The following table provides a summary of what GIS-specific aggregate functions -are available on each spatial backend. Please note that MariaDB does not -support any of these aggregates, and is thus excluded from the table. +are available on each spatial backend. .. currentmodule:: django.contrib.gis.db.models -======================= ======= ====== ============ ========== -Aggregate PostGIS Oracle MySQL SpatiaLite -======================= ======= ====== ============ ========== -:class:`Collect` X X (≥ 8.0.24) X -:class:`Extent` X X X +======================= ======= ====== ========== ============ ========== +Aggregate PostGIS Oracle MariaDB MySQL SpatiaLite +======================= ======= ====== ========== ============ ========== +:class:`Collect` X X (≥ 11.7) X (≥ 8.0.24) X +:class:`Extent` X X X :class:`Extent3D` X -:class:`MakeLine` X X -:class:`Union` X X X -======================= ======= ====== ============ ========== +:class:`MakeLine` X X +:class:`Union` X X X +======================= ======= ====== ========== ============ ========== .. rubric:: Footnotes .. [#fnwkt] *See* Open Geospatial Consortium, Inc., `OpenGIS Simple Feature Specification For SQL `_, Document 99-049 (May 5, 1999), at Ch. 3.2.5, p. 3-11 (SQL Textual Representation of Geometry). diff --git a/docs/ref/contrib/gis/functions.txt b/docs/ref/contrib/gis/functions.txt index ff05d0ec96..ff62c17580 100644 --- a/docs/ref/contrib/gis/functions.txt +++ b/docs/ref/contrib/gis/functions.txt @@ -393,7 +393,7 @@ Creates geometry from `Well-known text (WKT)`_ representation. The optional .. class:: GeoHash(expression, precision=None, **extra) -*Availability*: `MySQL +*Availability*: MariaDB, `MySQL `__, `PostGIS `__, SpatiaLite (LWGEOM/RTTOPO) @@ -406,6 +406,10 @@ result. __ https://en.wikipedia.org/wiki/Geohash +.. versionchanged:: 5.2 + + MariaDB 11.7+ support was added. + ``GeometryDistance`` ==================== @@ -444,13 +448,17 @@ geometry. Returns ``True`` if its value is empty and ``False`` otherwise. .. class:: IsValid(expr) -*Availability*: `MySQL +*Availability*: MariaDB, `MySQL `__, `PostGIS `__, Oracle, SpatiaLite Accepts a geographic field or expression and tests if the value is well formed. Returns ``True`` if its value is a valid geometry and ``False`` otherwise. +.. versionchanged:: 5.2 + + MariaDB 11.7+ support was added. + ``Length`` ========== diff --git a/docs/ref/contrib/gis/geoquerysets.txt b/docs/ref/contrib/gis/geoquerysets.txt index 2bafa8eb43..607e743a2d 100644 --- a/docs/ref/contrib/gis/geoquerysets.txt +++ b/docs/ref/contrib/gis/geoquerysets.txt @@ -370,8 +370,8 @@ Example:: ``isvalid`` ----------- -*Availability*: MySQL, `PostGIS `__, -Oracle, SpatiaLite +*Availability*: MariaDB, MySQL, +`PostGIS `__, Oracle, SpatiaLite Tests if the geometry is valid. @@ -379,12 +379,16 @@ Example:: Zipcode.objects.filter(poly__isvalid=True) -========================== ================================================================ -Backend SQL Equivalent -========================== ================================================================ -MySQL, PostGIS, SpatiaLite ``ST_IsValid(poly)`` -Oracle ``SDO_GEOM.VALIDATE_GEOMETRY_WITH_CONTEXT(poly, 0.05) = 'TRUE'`` -========================== ================================================================ +=================================== ================================================================ +Backend SQL Equivalent +=================================== ================================================================ +MariaDB, MySQL, PostGIS, SpatiaLite ``ST_IsValid(poly)`` +Oracle ``SDO_GEOM.VALIDATE_GEOMETRY_WITH_CONTEXT(poly, 0.05) = 'TRUE'`` +=================================== ================================================================ + +.. versionchanged:: 5.2 + + MariaDB 11.7+ support was added. .. fieldlookup:: overlaps @@ -876,8 +880,8 @@ Example: .. class:: Collect(geo_field, filter=None) -*Availability*: `PostGIS `__, MySQL, -SpatiaLite +*Availability*: `PostGIS `__, +MariaDB, MySQL, SpatiaLite Returns a ``GEOMETRYCOLLECTION`` or a ``MULTI`` geometry object from the geometry column. This is analogous to a simplified version of the :class:`Union` @@ -889,6 +893,10 @@ caring about dissolving boundaries. MySQL 8.0.24+ support was added. +.. versionchanged:: 5.2 + + MariaDB 11.7+ support was added. + ``Extent`` ~~~~~~~~~~ diff --git a/docs/releases/5.2.txt b/docs/releases/5.2.txt index faee74548e..72fd0e219b 100644 --- a/docs/releases/5.2.txt +++ b/docs/releases/5.2.txt @@ -102,7 +102,11 @@ Minor features * :lookup:`coveredby` lookup is now supported on MySQL. -* :lookup:`coveredby` lookup is now supported on MariaDB 11.7+. +* :lookup:`coveredby` and :lookup:`isvalid` lookups, + :class:`~django.contrib.gis.db.models.Collect` aggregation, and + :class:`~django.contrib.gis.db.models.functions.GeoHash` and + :class:`~django.contrib.gis.db.models.functions.IsValid` database functions + are now supported on MariaDB 11.7+. :mod:`django.contrib.messages` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ From 5cf88dcc570f6c9ed04f5183e7884ea49048b9ea Mon Sep 17 00:00:00 2001 From: Mariusz Felisiak Date: Sun, 29 Sep 2024 19:46:26 +0200 Subject: [PATCH 038/132] Refs #35803 -- Added support for __covers GIS lookup on MySQL. --- django/contrib/gis/db/backends/mysql/operations.py | 2 ++ docs/ref/contrib/gis/db-api.txt | 2 +- docs/ref/contrib/gis/geoquerysets.txt | 7 ++++++- docs/releases/5.2.txt | 2 +- 4 files changed, 10 insertions(+), 3 deletions(-) diff --git a/django/contrib/gis/db/backends/mysql/operations.py b/django/contrib/gis/db/backends/mysql/operations.py index e9aec1e96c..5c02d5e5a7 100644 --- a/django/contrib/gis/db/backends/mysql/operations.py +++ b/django/contrib/gis/db/backends/mysql/operations.py @@ -60,6 +60,8 @@ class MySQLOperations(BaseSpatialOperations, DatabaseOperations): operators["relate"] = SpatialOperator(func="ST_Relate") if self.connection.mysql_version < (11, 7): del operators["coveredby"] + else: + operators["covers"] = SpatialOperator(func="MBRCovers") return operators @cached_property diff --git a/docs/ref/contrib/gis/db-api.txt b/docs/ref/contrib/gis/db-api.txt index b587f1d9be..e33d9a514f 100644 --- a/docs/ref/contrib/gis/db-api.txt +++ b/docs/ref/contrib/gis/db-api.txt @@ -348,7 +348,7 @@ Lookup Type PostGIS Oracle MariaDB MySQL [#]_ S :lookup:`contains ` X X X X X B :lookup:`contains_properly` X B :lookup:`coveredby` X X X (≥ 11.7) X X B -:lookup:`covers` X X X B +:lookup:`covers` X X X X B :lookup:`crosses` X X X X C :lookup:`disjoint` X X X X X B :lookup:`distance_gt` X X X X X N diff --git a/docs/ref/contrib/gis/geoquerysets.txt b/docs/ref/contrib/gis/geoquerysets.txt index 607e743a2d..19411b7304 100644 --- a/docs/ref/contrib/gis/geoquerysets.txt +++ b/docs/ref/contrib/gis/geoquerysets.txt @@ -212,7 +212,7 @@ SpatiaLite ``CoveredBy(poly, geom)`` ---------- *Availability*: `PostGIS `__, -Oracle, PGRaster (Bilateral), SpatiaLite +Oracle, MySQL, PGRaster (Bilateral), SpatiaLite Tests if no point in the lookup geometry is outside the geometry field. [#fncovers]_ @@ -226,9 +226,14 @@ Backend SQL Equivalent ========== ========================== PostGIS ``ST_Covers(poly, geom)`` Oracle ``SDO_COVERS(poly, geom)`` +MySQL ``MBRCovers(poly, geom)`` SpatiaLite ``Covers(poly, geom)`` ========== ========================== +.. versionchanged:: 5.2 + + MySQL support was added. + .. fieldlookup:: crosses ``crosses`` diff --git a/docs/releases/5.2.txt b/docs/releases/5.2.txt index 72fd0e219b..e103de847b 100644 --- a/docs/releases/5.2.txt +++ b/docs/releases/5.2.txt @@ -100,7 +100,7 @@ Minor features :meth:`.OGRGeometry.get_linear_geometry` and :meth:`.OGRGeometry.get_curve_geometry` methods. -* :lookup:`coveredby` lookup is now supported on MySQL. +* :lookup:`coveredby` and :lookup:`covers` lookup are now supported on MySQL. * :lookup:`coveredby` and :lookup:`isvalid` lookups, :class:`~django.contrib.gis.db.models.Collect` aggregation, and From c973d9ee82a36419a408b193d4195f69734a8e33 Mon Sep 17 00:00:00 2001 From: mbcodes Date: Wed, 23 Oct 2024 12:22:38 -0700 Subject: [PATCH 039/132] Improved readability of triage workflow image by increasing its size and color contrast. --- docs/internals/_images/triage_process.svg | 40 +++++++++---------- .../contributing/triaging-tickets.txt | 4 +- 2 files changed, 22 insertions(+), 22 deletions(-) diff --git a/docs/internals/_images/triage_process.svg b/docs/internals/_images/triage_process.svg index 2b5e0d3ced..6fbf1cbcc7 100644 --- a/docs/internals/_images/triage_process.svg +++ b/docs/internals/_images/triage_process.svg @@ -232,47 +232,47 @@ - - - The ticket was already reported, was - already rejected, isn't a bug, doesn't contain - enough information, or can't be reproduced. + + + The ticket was already reported, was + already rejected, isn't a bug, doesn't contain + enough information, or can't be reproduced. - + - + - - - The ticket is a - bug and should - be fixed. + + + The ticket is a + bug and should + be fixed. - + - + - - - The ticket has a patch which applies cleanly and includes all - needed tests and docs. A merger can commit it as is. + + + The ticket has a patch which applies cleanly and includes all + needed tests and docs. A merger can commit it as is. - + - + diff --git a/docs/internals/contributing/triaging-tickets.txt b/docs/internals/contributing/triaging-tickets.txt index 852219c96c..7987d63e9a 100644 --- a/docs/internals/contributing/triaging-tickets.txt +++ b/docs/internals/contributing/triaging-tickets.txt @@ -49,8 +49,8 @@ attribute easily tells us what and who each ticket is waiting on. Since a picture is worth a thousand words, let's start there: .. image:: /internals/_images/triage_process.* - :height: 501 - :width: 400 + :height: 750 + :width: 600 :alt: Django's ticket triage workflow We've got two roles in this diagram: From 7a1fa20e9bca47c4c70734aec99209e402e0f076 Mon Sep 17 00:00:00 2001 From: Mariusz Felisiak Date: Fri, 25 Oct 2024 09:41:11 +0200 Subject: [PATCH 040/132] Made GitHub actions display all warnings in Python tests. --- .github/workflows/python_matrix.yml | 2 +- .github/workflows/schedule_tests.yml | 4 ++-- .github/workflows/tests.yml | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/.github/workflows/python_matrix.yml b/.github/workflows/python_matrix.yml index ab48c2be83..5901e584aa 100644 --- a/.github/workflows/python_matrix.yml +++ b/.github/workflows/python_matrix.yml @@ -49,4 +49,4 @@ jobs: run: python -m pip install --upgrade pip setuptools wheel - run: python -m pip install -r tests/requirements/py3.txt -e . - name: Run tests - run: python tests/runtests.py -v2 + run: python -Wall tests/runtests.py -v2 diff --git a/.github/workflows/schedule_tests.yml b/.github/workflows/schedule_tests.yml index 1ca766f7f3..5e6038fb31 100644 --- a/.github/workflows/schedule_tests.yml +++ b/.github/workflows/schedule_tests.yml @@ -36,7 +36,7 @@ jobs: run: python -m pip install --upgrade pip setuptools wheel - run: python -m pip install -r tests/requirements/py3.txt -e . - name: Run tests - run: python tests/runtests.py -v2 + run: python -Wall tests/runtests.py -v2 pyc-only: runs-on: ubuntu-latest @@ -62,7 +62,7 @@ jobs: find $DJANGO_PACKAGE_ROOT -name '*.py' -print -delete - run: python -m pip install -r tests/requirements/py3.txt - name: Run tests - run: python tests/runtests.py --verbosity=2 + run: python -Wall tests/runtests.py --verbosity=2 pypy-sqlite: runs-on: ubuntu-latest diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml index 5de554721d..3373f82e0a 100644 --- a/.github/workflows/tests.yml +++ b/.github/workflows/tests.yml @@ -38,7 +38,7 @@ jobs: run: python -m pip install --upgrade pip setuptools wheel - run: python -m pip install -r tests/requirements/py3.txt -e . - name: Run tests - run: python tests/runtests.py -v2 + run: python -Wall tests/runtests.py -v2 javascript-tests: runs-on: ubuntu-latest From 4c3897bb154a3d3a94e5f7e146d0b8bf41e27d81 Mon Sep 17 00:00:00 2001 From: Tainara Palmeira Date: Thu, 24 Oct 2024 11:27:56 +0200 Subject: [PATCH 041/132] Refs #35844 -- Corrected expected error messages in commands tests on Python 3.14+. Updated CommandTests.test_subparser_invalid_option and CommandDBOptionChoiceTests.test_invalid_choice_db_option to address changes in Python 3.14+ error handling. --- django/utils/version.py | 1 + tests/admin_scripts/tests.py | 16 +++++++++++----- tests/user_commands/tests.py | 6 +++++- 3 files changed, 17 insertions(+), 6 deletions(-) diff --git a/django/utils/version.py b/django/utils/version.py index 55509f4c85..4ef8cfbcfe 100644 --- a/django/utils/version.py +++ b/django/utils/version.py @@ -19,6 +19,7 @@ PY310 = sys.version_info >= (3, 10) PY311 = sys.version_info >= (3, 11) PY312 = sys.version_info >= (3, 12) PY313 = sys.version_info >= (3, 13) +PY314 = sys.version_info >= (3, 14) def get_version(version=None): diff --git a/tests/admin_scripts/tests.py b/tests/admin_scripts/tests.py index 29023b74c3..fefe4f50bb 100644 --- a/tests/admin_scripts/tests.py +++ b/tests/admin_scripts/tests.py @@ -34,7 +34,7 @@ from django.db.migrations.recorder import MigrationRecorder from django.test import LiveServerTestCase, SimpleTestCase, TestCase, override_settings from django.test.utils import captured_stderr, captured_stdout from django.urls import path -from django.utils.version import PY313, get_docs_version +from django.utils.version import PY313, PY314, get_docs_version from django.views.static import serve from . import urls @@ -2355,10 +2355,16 @@ class Discovery(SimpleTestCase): class CommandDBOptionChoiceTests(SimpleTestCase): def test_invalid_choice_db_option(self): - expected_error = ( - "Error: argument --database: invalid choice: " - "'deflaut' (choose from 'default', 'other')" - ) + if PY314: + expected_error = ( + "Error: argument --database: invalid choice: 'deflaut' " + "(choose from default, other)" + ) + else: + expected_error = ( + "Error: argument --database: invalid choice: 'deflaut' " + "(choose from 'default', 'other')" + ) args = [ "changepassword", "createsuperuser", diff --git a/tests/user_commands/tests.py b/tests/user_commands/tests.py index 65e176620d..8dd07e1c67 100644 --- a/tests/user_commands/tests.py +++ b/tests/user_commands/tests.py @@ -20,6 +20,7 @@ from django.db import connection from django.test import SimpleTestCase, override_settings from django.test.utils import captured_stderr, extend_sys_path from django.utils import translation +from django.utils.version import PY314 from .management.commands import dance @@ -400,7 +401,10 @@ class CommandTests(SimpleTestCase): self.assertIn("bar", out.getvalue()) def test_subparser_invalid_option(self): - msg = "invalid choice: 'test' (choose from 'foo')" + if PY314: + msg = "invalid choice: 'test' (choose from foo)" + else: + msg = "invalid choice: 'test' (choose from 'foo')" with self.assertRaisesMessage(CommandError, msg): management.call_command("subparser", "test", 12) msg = "Error: the following arguments are required: subcommand" From b5669f08bc8523a7fa35e4e9f037628bb40e2e42 Mon Sep 17 00:00:00 2001 From: Paolo Melchiorre Date: Fri, 25 Oct 2024 15:26:46 +0200 Subject: [PATCH 042/132] Improved the writing documentation contributing guide. --- .../contributing/writing-documentation.txt | 49 ++++++++++++++----- 1 file changed, 37 insertions(+), 12 deletions(-) diff --git a/docs/internals/contributing/writing-documentation.txt b/docs/internals/contributing/writing-documentation.txt index 763039e61a..a8db5d93fd 100644 --- a/docs/internals/contributing/writing-documentation.txt +++ b/docs/internals/contributing/writing-documentation.txt @@ -159,9 +159,14 @@ Spelling check Before you commit your docs, it's a good idea to run the spelling checker. You'll need to install :pypi:`sphinxcontrib-spelling` first. Then from the -``docs`` directory, run ``make spelling``. Wrong words (if any) along with the -file and line number where they occur will be saved to -``_build/spelling/output.txt``. +``docs`` directory, run: + +.. console:: + + $ make spelling + +Wrong words (if any) along with the file and line number where they occur will +be saved to ``_build/spelling/output.txt``. If you encounter false-positives (error output that actually is correct), do one of the following: @@ -179,10 +184,21 @@ Link check Links in documentation can become broken or changed such that they are no longer the canonical link. Sphinx provides a builder that can check whether the -links in the documentation are working. From the ``docs`` directory, run ``make -linkcheck``. Output is printed to the terminal, but can also be found in +links in the documentation are working. From the ``docs`` directory, run: + +.. console:: + + $ make linkcheck + +Output is printed to the terminal, but can also be found in ``_build/linkcheck/output.txt`` and ``_build/linkcheck/output.json``. +.. warning:: + + The execution of the command requires an internet connection and takes + several minutes to complete, because the command tests all the links + that are found in the documentation. + Entries that have a status of "working" are fine, those that are "unchecked" or "ignored" have been skipped because they either cannot be checked or have matched ignore rules in the configuration. @@ -290,7 +306,8 @@ documentation: display a link with the title "auth". * All Python code blocks should be formatted using the :pypi:`blacken-docs` - auto-formatter. This will be run by ``pre-commit`` if that is configured. + auto-formatter. This will be run by :ref:`pre-commit + ` if that is configured. * Use :mod:`~sphinx.ext.intersphinx` to reference Python's and Sphinx' documentation. @@ -324,8 +341,9 @@ documentation: Five ^^^^ -* Use :rst:role:`:rfc:` to reference RFC and try to link to the relevant - section if possible. For example, use ``:rfc:`2324#section-2.3.2``` or +* Use :rst:role:`:rfc:` to reference a Request for Comments (RFC) and + try to link to the relevant section if possible. For example, use + ``:rfc:`2324#section-2.3.2``` or ``:rfc:`Custom link text <2324#section-2.3.2>```. * Use :rst:role:`:pep:` to reference a Python Enhancement Proposal (PEP) @@ -339,6 +357,9 @@ documentation: also need to define a reference to the documentation for that environment variable using :rst:dir:`.. envvar:: `. +* Use :rst:role:`:cve:` to reference a Common Vulnerabilities and + Exposures (CVE) identifier. For example, use ``:cve:`2019-14232```. + Django-specific markup ====================== @@ -518,7 +539,7 @@ Minimizing images Optimize image compression where possible. For PNG files, use OptiPNG and AdvanceCOMP's ``advpng``: -.. code-block:: console +.. console:: $ cd docs $ optipng -o7 -zm1-9 -i0 -strip all `find . -type f -not -path "./_build/*" -name "*.png"` @@ -619,6 +640,10 @@ included in the Django repository and the releases as ``docs/man/django-admin.1``. There isn't a need to update this file when updating the documentation, as it's updated once as part of the release process. -To generate an updated version of the man page, run ``make man`` in the -``docs`` directory. The new man page will be written in -``docs/_build/man/django-admin.1``. +To generate an updated version of the man page, in the ``docs`` directory, run: + +.. console:: + + $ make man + +The new man page will be written in ``docs/_build/man/django-admin.1``. From 43287cbb87bc5e99a2fd384082a719d8b4d253c6 Mon Sep 17 00:00:00 2001 From: Claude Paroz Date: Fri, 25 Oct 2024 21:06:31 +0200 Subject: [PATCH 043/132] Refs #35742 -- Used curly quote in add user form message. --- django/contrib/admin/templates/admin/auth/user/add_form.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/django/contrib/admin/templates/admin/auth/user/add_form.html b/django/contrib/admin/templates/admin/auth/user/add_form.html index a13e75e89a..7c7ca1d1ad 100644 --- a/django/contrib/admin/templates/admin/auth/user/add_form.html +++ b/django/contrib/admin/templates/admin/auth/user/add_form.html @@ -3,7 +3,7 @@ {% block form_top %} {% if not is_popup %} -

    {% translate "After you've created a user, you’ll be able to edit more user options." %}

    +

    {% translate "After you’ve created a user, you’ll be able to edit more user options." %}

    {% endif %} {% endblock %} {% block extrahead %} From 555f2412cba4c5844408042e92f3bf9fa5c2392c Mon Sep 17 00:00:00 2001 From: earthyoung Date: Mon, 28 Oct 2024 15:59:18 +0900 Subject: [PATCH 044/132] Refs #34900 -- Removed usage of deprecated glob.glob1(). --- django/core/cache/backends/filebased.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/django/core/cache/backends/filebased.py b/django/core/cache/backends/filebased.py index 29d49c0ede..cbf47e4e16 100644 --- a/django/core/cache/backends/filebased.py +++ b/django/core/cache/backends/filebased.py @@ -166,5 +166,5 @@ class FileBasedCache(BaseCache): """ return [ os.path.join(self._dir, fname) - for fname in glob.glob1(self._dir, "*%s" % self.cache_suffix) + for fname in glob.glob(f"*{self.cache_suffix}", root_dir=self._dir) ] From 738e0601d597d4b6bee0000f645994495af984d8 Mon Sep 17 00:00:00 2001 From: antoliny0919 Date: Tue, 29 Oct 2024 08:44:37 +0900 Subject: [PATCH 045/132] Fixed #35871 -- Corrected example on altering the base_fields attribute in forms docs. --- docs/ref/forms/api.txt | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/ref/forms/api.txt b/docs/ref/forms/api.txt index 33d0806859..8abe273a59 100644 --- a/docs/ref/forms/api.txt +++ b/docs/ref/forms/api.txt @@ -406,8 +406,8 @@ process: .. code-block:: pycon >>> f.base_fields["subject"].label_suffix = "?" - >>> another_f = CommentForm(auto_id=False) - >>> f.as_div().split("
    ")[0] + >>> another_f = ContactForm(auto_id=False) + >>> another_f.as_div().split("

    ")[0] '
    ' Accessing "clean" data From cf9da6fadd44cc7654681026d202387022b30d8d Mon Sep 17 00:00:00 2001 From: Peter Ruszel <3279147+pruszel@users.noreply.github.com> Date: Mon, 28 Oct 2024 15:37:10 -0700 Subject: [PATCH 046/132] Fixed #35868 -- Removed unneeded AttributeError catching in collectstatic's delete_file(). --- .../contrib/staticfiles/management/commands/collectstatic.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/django/contrib/staticfiles/management/commands/collectstatic.py b/django/contrib/staticfiles/management/commands/collectstatic.py index c346038df8..d5cd3f56ca 100644 --- a/django/contrib/staticfiles/management/commands/collectstatic.py +++ b/django/contrib/staticfiles/management/commands/collectstatic.py @@ -279,14 +279,14 @@ class Command(BaseCommand): try: # When was the target file modified last time? target_last_modified = self.storage.get_modified_time(prefixed_path) - except (OSError, NotImplementedError, AttributeError): + except (OSError, NotImplementedError): # The storage doesn't support get_modified_time() or failed pass else: try: # When was the source file modified last time? source_last_modified = source_storage.get_modified_time(path) - except (OSError, NotImplementedError, AttributeError): + except (OSError, NotImplementedError): pass else: # The full path of the target file From 889be2f45520ff7ee9296d89b30f33c1464112e3 Mon Sep 17 00:00:00 2001 From: Mike Edmunds Date: Mon, 28 Oct 2024 14:29:00 +0100 Subject: [PATCH 047/132] Refs #35581 -- Clarified some test names and comments in mail tests. --- tests/mail/tests.py | 66 ++++++++++++++++++++++++++++----------------- 1 file changed, 41 insertions(+), 25 deletions(-) diff --git a/tests/mail/tests.py b/tests/mail/tests.py index 6280bfa5c8..286da93dfe 100644 --- a/tests/mail/tests.py +++ b/tests/mail/tests.py @@ -17,6 +17,7 @@ from unittest import mock, skipUnless from django.core import mail from django.core.mail import ( DNS_NAME, + BadHeaderError, EmailAlternative, EmailAttachment, EmailMessage, @@ -27,7 +28,7 @@ from django.core.mail import ( send_mass_mail, ) from django.core.mail.backends import console, dummy, filebased, locmem, smtp -from django.core.mail.message import BadHeaderError, sanitize_address +from django.core.mail.message import sanitize_address from django.test import SimpleTestCase, override_settings from django.test.utils import requires_tz_support from django.utils.translation import gettext_lazy @@ -45,7 +46,7 @@ class HeadersCheckMixin: """ Asserts that the `message` has all `headers`. - message: can be an instance of an email.Message subclass or a string + message: can be an instance of an email.Message subclass or bytes with the contents of an email message. headers: should be a set of (header-name, header-value) tuples. """ @@ -323,9 +324,9 @@ class MailTests(HeadersCheckMixin, SimpleTestCase): ["Name\nInjection test "], ).message() - def test_space_continuation(self): + def test_folding_white_space(self): """ - Test for space continuation character in long (ASCII) subject headers (#7747) + Test for correct use of "folding white space" in long headers (#7747) """ email = EmailMessage( "Long subject lines that get wrapped should contain a space continuation " @@ -515,10 +516,10 @@ class MailTests(HeadersCheckMixin, SimpleTestCase): message["Comments"], "=?utf-8?q?My_S=C3=BCrname_is_non-ASCII?=" ) - def test_safe_mime_multipart(self): + def test_non_utf8_headers_multipart(self): """ Make sure headers can be set with a different encoding than utf-8 in - SafeMIMEMultipart as well + EmailMultiAlternatives as well. """ headers = {"Date": "Fri, 09 Nov 2001 01:08:47 -0000", "Message-ID": "foo"} from_email, to = "from@example.com", '"Sürname, Firstname" ' @@ -542,7 +543,7 @@ class MailTests(HeadersCheckMixin, SimpleTestCase): "=?iso-8859-1?q?Message_from_Firstname_S=FCrname?=", ) - def test_safe_mime_multipart_with_attachments(self): + def test_multipart_with_attachments(self): """ EmailMultiAlternatives includes alternatives if the body is empty and it has attachments. @@ -643,7 +644,10 @@ class MailTests(HeadersCheckMixin, SimpleTestCase): ) self.assertEqual(message.get_payload(), "Firstname S=FCrname is a great guy.") - # MIME attachments works correctly with other encodings than utf-8. + def test_encoding_alternatives(self): + """ + Encode alternatives correctly with other encodings than utf-8. + """ text_content = "Firstname Sürname is a great guy." html_content = "

    Firstname Sürname is a great guy.

    " msg = EmailMultiAlternatives( @@ -655,6 +659,8 @@ class MailTests(HeadersCheckMixin, SimpleTestCase): self.assertMessageHasHeaders( payload0, { + # (The MIME-Version header is neither required nor meaningful + # in a subpart, and this check for it can be safely removed.) ("MIME-Version", "1.0"), ("Content-Type", 'text/plain; charset="iso-8859-1"'), ("Content-Transfer-Encoding", "quoted-printable"), @@ -667,6 +673,8 @@ class MailTests(HeadersCheckMixin, SimpleTestCase): self.assertMessageHasHeaders( payload1, { + # (The MIME-Version header is neither required nor meaningful + # in a subpart, and this check for it can be safely removed.) ("MIME-Version", "1.0"), ("Content-Type", 'text/html; charset="iso-8859-1"'), ("Content-Transfer-Encoding", "quoted-printable"), @@ -739,8 +747,20 @@ class MailTests(HeadersCheckMixin, SimpleTestCase): attachments = self.get_decoded_attachments(msg) self.assertEqual(attachments[0], (file_name, file_content.encode(), mime_type)) - def test_decoded_attachments(self): - """Regression test for #9367""" + def test_attachments_constructor_omit_mimetype(self): + """ + The mimetype can be omitted from an attachment tuple. + """ + msg = EmailMessage(attachments=[("filename1", "content1")]) + filename, content, mimetype = self.get_decoded_attachments(msg)[0] + self.assertEqual(filename, "filename1") + self.assertEqual(content, b"content1") + self.assertEqual(mimetype, "application/octet-stream") + + def test_attachments_with_alternative_parts(self): + """ + Message with attachment and alternative has correct structure (#9367). + """ headers = {"Date": "Fri, 09 Nov 2001 01:08:47 -0000", "Message-ID": "foo"} subject, from_email, to = "hello", "from@example.com", "to@example.com" text_content = "This is an important message." @@ -759,13 +779,6 @@ class MailTests(HeadersCheckMixin, SimpleTestCase): self.assertEqual(payload[0].get_content_type(), "multipart/alternative") self.assertEqual(payload[1].get_content_type(), "application/pdf") - def test_decoded_attachments_two_tuple(self): - msg = EmailMessage(attachments=[("filename1", "content1")]) - filename, content, mimetype = self.get_decoded_attachments(msg)[0] - self.assertEqual(filename, "filename1") - self.assertEqual(content, b"content1") - self.assertEqual(mimetype, "application/octet-stream") - def test_decoded_attachments_MIMEText(self): txt = MIMEText("content1") msg = EmailMessage(attachments=[txt]) @@ -788,8 +801,8 @@ class MailTests(HeadersCheckMixin, SimpleTestCase): def test_attach_file(self): """ Test attaching a file against different mimetypes and make sure that - a file will be attached and sent properly even if an invalid mimetype - is specified. + a file will be attached and sent in some form even if a mismatched + mimetype is specified. """ files = ( # filename, actual mimetype @@ -832,7 +845,7 @@ class MailTests(HeadersCheckMixin, SimpleTestCase): def test_attach_utf8_text_as_bytes(self): """ Non-ASCII characters encoded as valid UTF-8 are correctly transported - and decoded. + in a form that can be decoded at the receiving end. """ msg = EmailMessage("subject", "body", "from@example.com", ["to@example.com"]) msg.attach("file.txt", b"\xc3\xa4") # UTF-8 encoded a umlaut. @@ -854,7 +867,7 @@ class MailTests(HeadersCheckMixin, SimpleTestCase): self.assertEqual(content, b"\xff") self.assertEqual(mimetype, "application/octet-stream") - def test_attach_mimetext_content_mimetype(self): + def test_attach_mimebase_prohibits_other_params(self): email_msg = EmailMessage() txt = MIMEText("content") msg = ( @@ -866,7 +879,7 @@ class MailTests(HeadersCheckMixin, SimpleTestCase): with self.assertRaisesMessage(ValueError, msg): email_msg.attach(txt, mimetype="text/plain") - def test_attach_content_none(self): + def test_attach_content_is_required(self): email_msg = EmailMessage() msg = "content must be provided." with self.assertRaisesMessage(ValueError, msg): @@ -1145,20 +1158,23 @@ class MailTests(HeadersCheckMixin, SimpleTestCase): ("A name ", "utf-8", "A name "), ('"A name" ', "ascii", "A name "), ('"A name" ', "utf-8", "A name "), - # Unicode addresses (supported per RFC-6532). - ("tó@example.com", "utf-8", "=?utf-8?b?dMOz?=@example.com"), + # Unicode addresses: IDNA encoded domain supported per RFC-5890. ("to@éxample.com", "utf-8", "to@xn--xample-9ua.com"), + # The next three cases should be removed when fixing #35713. + # (An 'encoded-word' localpart is prohibited by RFC-2047, and not + # supported by any known mail service.) + ("tó@example.com", "utf-8", "=?utf-8?b?dMOz?=@example.com"), ( ("Tó Example", "tó@example.com"), "utf-8", "=?utf-8?q?T=C3=B3_Example?= <=?utf-8?b?dMOz?=@example.com>", ), - # Unicode addresses with display names. ( "Tó Example ", "utf-8", "=?utf-8?q?T=C3=B3_Example?= <=?utf-8?b?dMOz?=@example.com>", ), + # IDNA addresses with display names. ( "To Example ", "ascii", From 4d76adfacde5594c5735a5e76b3d5478cb4ba8de Mon Sep 17 00:00:00 2001 From: Mike Edmunds Date: Mon, 28 Oct 2024 14:41:00 +0100 Subject: [PATCH 048/132] Refs #35581 -- Verified attachments in the generated message in mail tests. This also removed send() calls, as this doesn't check the serialized content, and the backend tests cover sending. --- tests/mail/tests.py | 35 ++++++++++++++++++++++++----------- 1 file changed, 24 insertions(+), 11 deletions(-) diff --git a/tests/mail/tests.py b/tests/mail/tests.py index 286da93dfe..4e4930f221 100644 --- a/tests/mail/tests.py +++ b/tests/mail/tests.py @@ -818,25 +818,38 @@ class MailTests(HeadersCheckMixin, SimpleTestCase): for basename, real_mimetype in files: for mimetype in test_mimetypes: - email = EmailMessage( - "subject", "body", "from@example.com", ["to@example.com"] - ) self.assertEqual(mimetypes.guess_type(basename)[0], real_mimetype) - self.assertEqual(email.attachments, []) - file_path = os.path.join( - os.path.dirname(__file__), "attachments", basename + expected_mimetype = ( + mimetype or real_mimetype or "application/octet-stream" ) + file_path = Path(__file__).parent / "attachments" / basename + expected_content = file_path.read_bytes() + if expected_mimetype.startswith("text/"): + try: + expected_content = expected_content.decode() + except UnicodeDecodeError: + expected_mimetype = "application/octet-stream" + + email = EmailMessage() email.attach_file(file_path, mimetype=mimetype) + + # Check EmailMessage.attachments. self.assertEqual(len(email.attachments), 1) - self.assertIn(basename, email.attachments[0]) - msgs_sent_num = email.send() - self.assertEqual(msgs_sent_num, 1) + self.assertEqual(email.attachments[0].filename, basename) + self.assertEqual(email.attachments[0].mimetype, expected_mimetype) + self.assertEqual(email.attachments[0].content, expected_content) + + # Check attachments in generated message. + # (The actual content is not checked as variations in platform + # line endings and rfc822 refolding complicate the logic.) + actual_attachment = self.get_decoded_attachments(email)[0] + actual_filename, actual_content, actual_mimetype = actual_attachment + self.assertEqual(actual_filename, basename) + self.assertEqual(actual_mimetype, expected_mimetype) def test_attach_text_as_bytes(self): msg = EmailMessage("subject", "body", "from@example.com", ["to@example.com"]) msg.attach("file.txt", b"file content") - sent_num = msg.send() - self.assertEqual(sent_num, 1) filename, content, mimetype = self.get_decoded_attachments(msg)[0] self.assertEqual(filename, "file.txt") self.assertEqual(content, b"file content") From 00861c4ca7ff51b24ee650e283a0c693573983cf Mon Sep 17 00:00:00 2001 From: Mike Edmunds Date: Mon, 28 Oct 2024 14:42:53 +0100 Subject: [PATCH 049/132] Refs #35581 -- Identified mail tests that check for Python 2 behavior. This also removed a duplicate CTE case (that used to be distinct in Python 2). --- tests/mail/tests.py | 30 +++++++++++++----------------- 1 file changed, 13 insertions(+), 17 deletions(-) diff --git a/tests/mail/tests.py b/tests/mail/tests.py index 4e4930f221..aea757ad1d 100644 --- a/tests/mail/tests.py +++ b/tests/mail/tests.py @@ -1027,21 +1027,9 @@ class MailTests(HeadersCheckMixin, SimpleTestCase): ) self.assertNotIn(b">From the future", email.message().as_bytes()) - def test_dont_base64_encode(self): - # Ticket #3472 - # Shouldn't use Base64 encoding at all - msg = EmailMessage( - "Subject", - "UTF-8 encoded body", - "bounce@example.com", - ["to@example.com"], - headers={"From": "from@example.com"}, - ) - self.assertIn(b"Content-Transfer-Encoding: 7bit", msg.message().as_bytes()) - - # Ticket #11212 - # Shouldn't use quoted printable, should detect it can represent - # content with 7 bit data. + def test_body_content_transfer_encoding(self): + # Shouldn't use base64 or quoted-printable, instead should detect it + # can represent content with 7-bit data (#3472, #11212). msg = EmailMessage( "Subject", "Body with only ASCII characters.", @@ -1052,8 +1040,8 @@ class MailTests(HeadersCheckMixin, SimpleTestCase): s = msg.message().as_bytes() self.assertIn(b"Content-Transfer-Encoding: 7bit", s) - # Shouldn't use quoted printable, should detect it can represent - # content with 8 bit data. + # Shouldn't use base64 or quoted-printable, instead should detect + # it can represent content with 8-bit data. msg = EmailMessage( "Subject", "Body with latin characters: àáä.", @@ -1063,9 +1051,16 @@ class MailTests(HeadersCheckMixin, SimpleTestCase): ) s = msg.message().as_bytes() self.assertIn(b"Content-Transfer-Encoding: 8bit", s) + # The following test is left over from Python 2 and can be safely removed. + # 8bit CTE within a Unicode str is not meaningful, and Python's modern + # email api won't generate it. (The test still works with the legacy api.) s = msg.message().as_string() self.assertIn("Content-Transfer-Encoding: 8bit", s) + # Long body lines that require folding should use quoted-printable or base64, + # whichever is shorter. However, Python's legacy email API avoids re-folding + # non-ASCII text and just uses CTE 8bit. (The modern API would correctly choose + # base64 here. Any of these is deliverable.) msg = EmailMessage( "Subject", "Body with non latin characters: А Б В Г Д Е Ж Ѕ З И І К Л М Н О П.", @@ -1075,6 +1070,7 @@ class MailTests(HeadersCheckMixin, SimpleTestCase): ) s = msg.message().as_bytes() self.assertIn(b"Content-Transfer-Encoding: 8bit", s) + # The following test is left over from Python 2. s = msg.message().as_string() self.assertIn("Content-Transfer-Encoding: 8bit", s) From cf4d902eb5c55b0b5966f8c920ba1009fae0d774 Mon Sep 17 00:00:00 2001 From: Mike Edmunds Date: Sat, 24 Aug 2024 12:49:58 -0700 Subject: [PATCH 050/132] Refs #35581 -- Reduced boilerplate in mail tests. --- tests/mail/tests.py | 204 ++++++++++---------------------------------- 1 file changed, 45 insertions(+), 159 deletions(-) diff --git a/tests/mail/tests.py b/tests/mail/tests.py index aea757ad1d..302b746245 100644 --- a/tests/mail/tests.py +++ b/tests/mail/tests.py @@ -348,24 +348,12 @@ class MailTests(HeadersCheckMixin, SimpleTestCase): default values (#9233) """ headers = {"date": "Fri, 09 Nov 2001 01:08:47 -0000", "Message-ID": "foo"} - email = EmailMessage( - "subject", - "content", - "from@example.com", - ["to@example.com"], - headers=headers, - ) + email = EmailMessage(headers=headers) self.assertMessageHasHeaders( email.message(), { - ("Content-Transfer-Encoding", "7bit"), - ("Content-Type", 'text/plain; charset="utf-8"'), - ("From", "from@example.com"), - ("MIME-Version", "1.0"), ("Message-ID", "foo"), - ("Subject", "subject"), - ("To", "to@example.com"), ("date", "Fri, 09 Nov 2001 01:08:47 -0000"), }, ) @@ -375,10 +363,7 @@ class MailTests(HeadersCheckMixin, SimpleTestCase): Make sure we can manually set the From header (#9214) """ email = EmailMessage( - "Subject", - "Content", - "bounce@example.com", - ["to@example.com"], + from_email="bounce@example.com", headers={"From": "from@example.com"}, ) message = email.message() @@ -389,10 +374,7 @@ class MailTests(HeadersCheckMixin, SimpleTestCase): Make sure we can manually set the To header (#17444) """ email = EmailMessage( - "Subject", - "Content", - "bounce@example.com", - ["list-subscriber@example.com", "list-subscriber2@example.com"], + to=["list-subscriber@example.com", "list-subscriber2@example.com"], headers={"To": "mailing-list@example.com"}, ) message = email.message() @@ -404,10 +386,7 @@ class MailTests(HeadersCheckMixin, SimpleTestCase): # If we don't set the To header manually, it should default to the `to` # argument to the constructor. email = EmailMessage( - "Subject", - "Content", - "bounce@example.com", - ["list-subscriber@example.com", "list-subscriber2@example.com"], + to=["list-subscriber@example.com", "list-subscriber2@example.com"], ) message = email.message() self.assertEqual( @@ -420,9 +399,6 @@ class MailTests(HeadersCheckMixin, SimpleTestCase): def test_to_in_headers_only(self): message = EmailMessage( - "Subject", - "Content", - "bounce@example.com", headers={"To": "to@example.com"}, ).message() self.assertEqual(message.get_all("To"), ["to@example.com"]) @@ -432,10 +408,6 @@ class MailTests(HeadersCheckMixin, SimpleTestCase): Specifying 'Reply-To' in headers should override reply_to. """ email = EmailMessage( - "Subject", - "Content", - "bounce@example.com", - ["to@example.com"], reply_to=["foo@example.com"], headers={"Reply-To": "override@example.com"}, ) @@ -444,10 +416,6 @@ class MailTests(HeadersCheckMixin, SimpleTestCase): def test_reply_to_in_headers_only(self): message = EmailMessage( - "Subject", - "Content", - "from@example.com", - ["to@example.com"], headers={"Reply-To": "reply_to@example.com"}, ).message() self.assertEqual(message.get_all("Reply-To"), ["reply_to@example.com"]) @@ -458,10 +426,7 @@ class MailTests(HeadersCheckMixin, SimpleTestCase): calling EmailMessage.message() """ email = EmailMessage( - "Subject", - "Content", - "bounce@example.com", - ["to@example.com"], + from_email="bounce@example.com", headers={"From": "from@example.com"}, ) message = email.message() @@ -476,20 +441,15 @@ class MailTests(HeadersCheckMixin, SimpleTestCase): regards to commas) """ email = EmailMessage( - "Subject", - "Content", - "from@example.com", - ['"Firstname Sürname" ', "other@example.com"], + to=['"Firstname Sürname" ', "other@example.com"], ) self.assertEqual( email.message()["To"], "=?utf-8?q?Firstname_S=C3=BCrname?= , other@example.com", ) + email = EmailMessage( - "Subject", - "Content", - "from@example.com", - ['"Sürname, Firstname" ', "other@example.com"], + to=['"Sürname, Firstname" ', "other@example.com"], ) self.assertEqual( email.message()["To"], @@ -498,10 +458,8 @@ class MailTests(HeadersCheckMixin, SimpleTestCase): def test_unicode_headers(self): email = EmailMessage( - "Gżegżółka", - "Content", - "from@example.com", - ["to@example.com"], + subject="Gżegżółka", + to=["to@example.com"], headers={ "Sender": '"Firstname Sürname" ', "Comments": "My Sürname is non-ASCII", @@ -522,7 +480,8 @@ class MailTests(HeadersCheckMixin, SimpleTestCase): EmailMultiAlternatives as well. """ headers = {"Date": "Fri, 09 Nov 2001 01:08:47 -0000", "Message-ID": "foo"} - from_email, to = "from@example.com", '"Sürname, Firstname" ' + from_email = "from@example.com" + to = '"Sürname, Firstname" ' text_content = "This is an important message." html_content = "

    This is an important message.

    " msg = EmailMultiAlternatives( @@ -612,9 +571,7 @@ class MailTests(HeadersCheckMixin, SimpleTestCase): @mock.patch("socket.getfqdn", return_value="漢字") def test_non_ascii_dns_non_unicode_email(self, mocked_getfqdn): delattr(DNS_NAME, "_fqdn") - email = EmailMessage( - "subject", "content", "from@example.com", ["to@example.com"] - ) + email = EmailMessage() email.encoding = "iso-8859-1" self.assertIn("@xn--p8s937b>", email.message()["Message-ID"]) @@ -623,12 +580,7 @@ class MailTests(HeadersCheckMixin, SimpleTestCase): Regression for #12791 - Encode body correctly with other encodings than utf-8 """ - email = EmailMessage( - "Subject", - "Firstname Sürname is a great guy.", - "from@example.com", - ["other@example.com"], - ) + email = EmailMessage(body="Firstname Sürname is a great guy.") email.encoding = "iso-8859-1" message = email.message() self.assertMessageHasHeaders( @@ -637,9 +589,6 @@ class MailTests(HeadersCheckMixin, SimpleTestCase): ("MIME-Version", "1.0"), ("Content-Type", 'text/plain; charset="iso-8859-1"'), ("Content-Transfer-Encoding", "quoted-printable"), - ("Subject", "Subject"), - ("From", "from@example.com"), - ("To", "other@example.com"), }, ) self.assertEqual(message.get_payload(), "Firstname S=FCrname is a great guy.") @@ -650,12 +599,12 @@ class MailTests(HeadersCheckMixin, SimpleTestCase): """ text_content = "Firstname Sürname is a great guy." html_content = "

    Firstname Sürname is a great guy.

    " - msg = EmailMultiAlternatives( - "Subject", text_content, "from@example.com", ["to@example.com"] - ) - msg.encoding = "iso-8859-1" - msg.attach_alternative(html_content, "text/html") - payload0 = msg.message().get_payload(0) + email = EmailMultiAlternatives(body=text_content) + email.encoding = "iso-8859-1" + email.attach_alternative(html_content, "text/html") + message = email.message() + # Check the text/plain part. + payload0 = message.get_payload(0) self.assertMessageHasHeaders( payload0, { @@ -669,7 +618,8 @@ class MailTests(HeadersCheckMixin, SimpleTestCase): self.assertTrue( payload0.as_bytes().endswith(b"\n\nFirstname S=FCrname is a great guy.") ) - payload1 = msg.message().get_payload(1) + # Check the text/html alternative. + payload1 = message.get_payload(1) self.assertMessageHasHeaders( payload1, { @@ -761,13 +711,9 @@ class MailTests(HeadersCheckMixin, SimpleTestCase): """ Message with attachment and alternative has correct structure (#9367). """ - headers = {"Date": "Fri, 09 Nov 2001 01:08:47 -0000", "Message-ID": "foo"} - subject, from_email, to = "hello", "from@example.com", "to@example.com" text_content = "This is an important message." html_content = "

    This is an important message.

    " - msg = EmailMultiAlternatives( - subject, text_content, from_email, [to], headers=headers - ) + msg = EmailMultiAlternatives(body=text_content) msg.attach_alternative(html_content, "text/html") msg.attach("an attachment.pdf", b"%PDF-1.4.%...", mimetype="application/pdf") msg_bytes = msg.message().as_bytes() @@ -787,10 +733,7 @@ class MailTests(HeadersCheckMixin, SimpleTestCase): def test_non_ascii_attachment_filename(self): """Regression test for #14964""" - headers = {"Date": "Fri, 09 Nov 2001 01:08:47 -0000", "Message-ID": "foo"} - subject, from_email, to = "hello", "from@example.com", "to@example.com" - content = "This is the message." - msg = EmailMessage(subject, content, from_email, [to], headers=headers) + msg = EmailMessage(body="Content") # Unicode in file name msg.attach("une pièce jointe.pdf", b"%PDF-1.4.%...", mimetype="application/pdf") msg_bytes = msg.message().as_bytes() @@ -848,7 +791,7 @@ class MailTests(HeadersCheckMixin, SimpleTestCase): self.assertEqual(actual_mimetype, expected_mimetype) def test_attach_text_as_bytes(self): - msg = EmailMessage("subject", "body", "from@example.com", ["to@example.com"]) + msg = EmailMessage() msg.attach("file.txt", b"file content") filename, content, mimetype = self.get_decoded_attachments(msg)[0] self.assertEqual(filename, "file.txt") @@ -860,7 +803,7 @@ class MailTests(HeadersCheckMixin, SimpleTestCase): Non-ASCII characters encoded as valid UTF-8 are correctly transported in a form that can be decoded at the receiving end. """ - msg = EmailMessage("subject", "body", "from@example.com", ["to@example.com"]) + msg = EmailMessage() msg.attach("file.txt", b"\xc3\xa4") # UTF-8 encoded a umlaut. filename, content, mimetype = self.get_decoded_attachments(msg)[0] self.assertEqual(filename, "file.txt") @@ -872,7 +815,7 @@ class MailTests(HeadersCheckMixin, SimpleTestCase): Binary data that can't be decoded as UTF-8 overrides the MIME type instead of decoding the data. """ - msg = EmailMessage("subject", "body", "from@example.com", ["to@example.com"]) + msg = EmailMessage() msg.attach("file.txt", b"\xff") # Invalid UTF-8. filename, content, mimetype = self.get_decoded_attachments(msg)[0] self.assertEqual(filename, "file.txt") @@ -903,13 +846,7 @@ class MailTests(HeadersCheckMixin, SimpleTestCase): Make sure that dummy backends returns correct number of sent messages """ connection = dummy.EmailBackend() - email = EmailMessage( - "Subject", - "Content", - "bounce@example.com", - ["to@example.com"], - headers={"From": "from@example.com"}, - ) + email = EmailMessage(to=["to@example.com"]) self.assertEqual(connection.send_messages([email, email, email]), 3) def test_arbitrary_keyword(self): @@ -924,13 +861,7 @@ class MailTests(HeadersCheckMixin, SimpleTestCase): """Test custom backend defined in this suite.""" conn = mail.get_connection("mail.custombackend.EmailBackend") self.assertTrue(hasattr(conn, "test_outbox")) - email = EmailMessage( - "Subject", - "Content", - "bounce@example.com", - ["to@example.com"], - headers={"From": "from@example.com"}, - ) + email = EmailMessage(to=["to@example.com"]) conn.send_messages([email]) self.assertEqual(len(conn.test_outbox), 1) @@ -1018,37 +949,19 @@ class MailTests(HeadersCheckMixin, SimpleTestCase): def test_dont_mangle_from_in_body(self): # Regression for #13433 - Make sure that EmailMessage doesn't mangle # 'From ' in message body. - email = EmailMessage( - "Subject", - "From the future", - "bounce@example.com", - ["to@example.com"], - headers={"From": "from@example.com"}, - ) + email = EmailMessage(body="From the future") self.assertNotIn(b">From the future", email.message().as_bytes()) def test_body_content_transfer_encoding(self): # Shouldn't use base64 or quoted-printable, instead should detect it # can represent content with 7-bit data (#3472, #11212). - msg = EmailMessage( - "Subject", - "Body with only ASCII characters.", - "bounce@example.com", - ["to@example.com"], - headers={"From": "from@example.com"}, - ) + msg = EmailMessage(body="Body with only ASCII characters.") s = msg.message().as_bytes() self.assertIn(b"Content-Transfer-Encoding: 7bit", s) # Shouldn't use base64 or quoted-printable, instead should detect # it can represent content with 8-bit data. - msg = EmailMessage( - "Subject", - "Body with latin characters: àáä.", - "bounce@example.com", - ["to@example.com"], - headers={"From": "from@example.com"}, - ) + msg = EmailMessage(body="Body with latin characters: àáä.") s = msg.message().as_bytes() self.assertIn(b"Content-Transfer-Encoding: 8bit", s) # The following test is left over from Python 2 and can be safely removed. @@ -1302,9 +1215,7 @@ class MailTimeZoneTests(SimpleTestCase): """ EMAIL_USE_LOCALTIME=False creates a datetime in UTC. """ - email = EmailMessage( - "Subject", "Body", "bounce@example.com", ["to@example.com"] - ) + email = EmailMessage() self.assertTrue(email.message()["Date"].endswith("-0000")) @override_settings( @@ -1314,9 +1225,7 @@ class MailTimeZoneTests(SimpleTestCase): """ EMAIL_USE_LOCALTIME=True creates a datetime in the local time zone. """ - email = EmailMessage( - "Subject", "Body", "bounce@example.com", ["to@example.com"] - ) + email = EmailMessage() self.assertTrue( email.message()["Date"].endswith("+0100") ) # Africa/Algiers is UTC+1 @@ -1435,12 +1344,8 @@ class BaseEmailBackendTests(HeadersCheckMixin): ) def test_send_many(self): - email1 = EmailMessage( - "Subject", "Content1", "from@example.com", ["to@example.com"] - ) - email2 = EmailMessage( - "Subject", "Content2", "from@example.com", ["to@example.com"] - ) + email1 = EmailMessage(to=["to-1@example.com"]) + email2 = EmailMessage(to=["to-2@example.com"]) # send_messages() may take a list or an iterator. emails_lists = ([email1, email2], iter((email1, email2))) for emails_list in emails_lists: @@ -1448,21 +1353,17 @@ class BaseEmailBackendTests(HeadersCheckMixin): self.assertEqual(num_sent, 2) messages = self.get_mailbox_content() self.assertEqual(len(messages), 2) - self.assertEqual(messages[0].get_payload(), "Content1") - self.assertEqual(messages[1].get_payload(), "Content2") + self.assertEqual(messages[0]["To"], "to-1@example.com") + self.assertEqual(messages[1]["To"], "to-2@example.com") self.flush_mailbox() def test_send_verbose_name(self): email = EmailMessage( - "Subject", - "Content", - '"Firstname Sürname" ', - ["to@example.com"], + from_email='"Firstname Sürname" ', + to=["to@example.com"], ) email.send() message = self.get_the_message() - self.assertEqual(message["subject"], "Subject") - self.assertEqual(message.get_payload(), "Content") self.assertEqual( message["from"], "=?utf-8?q?Firstname_S=C3=BCrname?= " ) @@ -1613,17 +1514,15 @@ class BaseEmailBackendTests(HeadersCheckMixin): """ self.assertTrue(send_mail("Subject", "Content", "from@öäü.com", ["to@öäü.com"])) message = self.get_the_message() - self.assertEqual(message.get("subject"), "Subject") self.assertEqual(message.get("from"), "from@xn--4ca9at.com") self.assertEqual(message.get("to"), "to@xn--4ca9at.com") self.flush_mailbox() m = EmailMessage( - "Subject", "Content", "from@öäü.com", ["to@öäü.com"], cc=["cc@öäü.com"] + from_email="from@öäü.com", to=["to@öäü.com"], cc=["cc@öäü.com"] ) m.send() message = self.get_the_message() - self.assertEqual(message.get("subject"), "Subject") self.assertEqual(message.get("from"), "from@xn--4ca9at.com") self.assertEqual(message.get("to"), "to@xn--4ca9at.com") self.assertEqual(message.get("cc"), "cc@xn--4ca9at.com") @@ -1634,7 +1533,6 @@ class BaseEmailBackendTests(HeadersCheckMixin): """ self.assertTrue(send_mail("Subject", "Content", "tester", ["django"])) message = self.get_the_message() - self.assertEqual(message.get("subject"), "Subject") self.assertEqual(message.get("from"), "tester") self.assertEqual(message.get("to"), "django") @@ -1650,10 +1548,8 @@ class BaseEmailBackendTests(HeadersCheckMixin): self.flush_mailbox() m = EmailMessage( - "Subject", - "Content", - _("tester"), - [_("to1"), _("to2")], + from_email=_("tester"), + to=[_("to1"), _("to2")], cc=[_("cc1"), _("cc2")], bcc=[_("bcc")], reply_to=[_("reply")], @@ -1716,13 +1612,7 @@ class LocmemBackendTests(BaseEmailBackendTests, SimpleTestCase): """ connection = locmem.EmailBackend() connection2 = locmem.EmailBackend() - email = EmailMessage( - "Subject", - "Content", - "bounce@example.com", - ["to@example.com"], - headers={"From": "from@example.com"}, - ) + email = EmailMessage(to=["to@example.com"]) connection.send_messages([email]) connection2.send_messages([email]) self.assertEqual(len(mail.outbox), 2) @@ -1737,8 +1627,6 @@ class LocmemBackendTests(BaseEmailBackendTests, SimpleTestCase): def test_outbox_not_mutated_after_send(self): email = EmailMessage( subject="correct subject", - body="test body", - from_email="from@example.com", to=["to@example.com"], ) email.send() @@ -2147,9 +2035,7 @@ class SMTPBackendTests(BaseEmailBackendTests, SMTPBackendTestsBase): # connection exception. backend.connection = mock.Mock(spec=object()) backend.open = lambda: None - email = EmailMessage( - "Subject", "Content", "from@example.com", ["to@example.com"] - ) + email = EmailMessage(to=["to@example.com"]) self.assertEqual(backend.send_messages([email]), 0) def test_send_messages_empty_list(self): From 799c3778186167eca3ed43f0e480738a607381de Mon Sep 17 00:00:00 2001 From: Clifford Gama Date: Sun, 27 Oct 2024 12:12:55 +0200 Subject: [PATCH 051/132] Fixed typo in ref/models/fields.txt. --- docs/ref/models/fields.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/ref/models/fields.txt b/docs/ref/models/fields.txt index b2da1b519c..14fc767ad7 100644 --- a/docs/ref/models/fields.txt +++ b/docs/ref/models/fields.txt @@ -2323,7 +2323,7 @@ called ``thirdpartyapp``, it can be referenced as:: class Car(models.Model): manufacturer = models.ForeignKey( - "thirdpartyapp``.Manufacturer", + "thirdpartyapp.Manufacturer", on_delete=models.CASCADE, ) From 163e72ebbaa84804877f3d1ae212575e479b533b Mon Sep 17 00:00:00 2001 From: Maria Hynes Date: Sun, 27 Oct 2024 11:05:49 +0000 Subject: [PATCH 052/132] Removed unneeded OS reference on running the test suite in contributing docs. This is not needed as the console snippet has buttons that allows the user to choose their OS. --- docs/intro/contributing.txt | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/docs/intro/contributing.txt b/docs/intro/contributing.txt index 7d590e76a2..0900fdae37 100644 --- a/docs/intro/contributing.txt +++ b/docs/intro/contributing.txt @@ -217,8 +217,7 @@ a dependency for one or more of the Python packages. Consult the failing package's documentation or search the web with the error message that you encounter. -Now we are ready to run the test suite. If you're using GNU/Linux, macOS, or -some other flavor of Unix, run: +Now we are ready to run the test suite: .. console:: From d7f78eb5d6c9250789fb3975b01e2a71d0e39577 Mon Sep 17 00:00:00 2001 From: aruseni Date: Sun, 27 Oct 2024 21:46:13 +0200 Subject: [PATCH 053/132] Corrected note on importing fields in model field reference docs. --- docs/ref/models/fields.txt | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/ref/models/fields.txt b/docs/ref/models/fields.txt index 14fc767ad7..07e86785d9 100644 --- a/docs/ref/models/fields.txt +++ b/docs/ref/models/fields.txt @@ -22,9 +22,9 @@ This document contains all the API references of :class:`Field` including the .. note:: - Technically, these models are defined in :mod:`django.db.models.fields`, but - for convenience they're imported into :mod:`django.db.models`; the standard - convention is to use ``from django.db import models`` and refer to fields as + Fields are defined in :mod:`django.db.models.fields`, but for convenience + they're imported into :mod:`django.db.models`. The standard convention is + to use ``from django.db import models`` and refer to fields as ``models.Field``. .. _common-model-field-options: From fc22fdd34f1e55adde161f5f2dca8db90bbfce80 Mon Sep 17 00:00:00 2001 From: Tainara Palmeira Date: Mon, 28 Oct 2024 14:46:20 +0100 Subject: [PATCH 054/132] Refs #35844 -- Expanded compatibility for expected error messages in command tests on Python 3.12 and 3.13. Updated CommandTests.test_subparser_invalid_option and CommandDBOptionChoiceTests.test_invalid_choice_db_option to use assertRaisesRegex() for compatibility with modified error messages in Python 3.12, 3.13, and 3.14+.. --- tests/admin_scripts/tests.py | 18 ++++++------------ tests/user_commands/tests.py | 8 ++------ 2 files changed, 8 insertions(+), 18 deletions(-) diff --git a/tests/admin_scripts/tests.py b/tests/admin_scripts/tests.py index fefe4f50bb..6fdd873661 100644 --- a/tests/admin_scripts/tests.py +++ b/tests/admin_scripts/tests.py @@ -34,7 +34,7 @@ from django.db.migrations.recorder import MigrationRecorder from django.test import LiveServerTestCase, SimpleTestCase, TestCase, override_settings from django.test.utils import captured_stderr, captured_stdout from django.urls import path -from django.utils.version import PY313, PY314, get_docs_version +from django.utils.version import PY313, get_docs_version from django.views.static import serve from . import urls @@ -2355,16 +2355,10 @@ class Discovery(SimpleTestCase): class CommandDBOptionChoiceTests(SimpleTestCase): def test_invalid_choice_db_option(self): - if PY314: - expected_error = ( - "Error: argument --database: invalid choice: 'deflaut' " - "(choose from default, other)" - ) - else: - expected_error = ( - "Error: argument --database: invalid choice: 'deflaut' " - "(choose from 'default', 'other')" - ) + expected_error = ( + r"Error: argument --database: invalid choice: 'deflaut' " + r"\(choose from '?default'?, '?other'?\)" + ) args = [ "changepassword", "createsuperuser", @@ -2384,7 +2378,7 @@ class CommandDBOptionChoiceTests(SimpleTestCase): ] for arg in args: - with self.assertRaisesMessage(CommandError, expected_error): + with self.assertRaisesRegex(CommandError, expected_error): call_command(arg, "--database", "deflaut", verbosity=0) diff --git a/tests/user_commands/tests.py b/tests/user_commands/tests.py index 8dd07e1c67..2a1e904f3b 100644 --- a/tests/user_commands/tests.py +++ b/tests/user_commands/tests.py @@ -20,7 +20,6 @@ from django.db import connection from django.test import SimpleTestCase, override_settings from django.test.utils import captured_stderr, extend_sys_path from django.utils import translation -from django.utils.version import PY314 from .management.commands import dance @@ -401,11 +400,8 @@ class CommandTests(SimpleTestCase): self.assertIn("bar", out.getvalue()) def test_subparser_invalid_option(self): - if PY314: - msg = "invalid choice: 'test' (choose from foo)" - else: - msg = "invalid choice: 'test' (choose from 'foo')" - with self.assertRaisesMessage(CommandError, msg): + msg = r"invalid choice: 'test' \(choose from '?foo'?\)" + with self.assertRaisesRegex(CommandError, msg): management.call_command("subparser", "test", 12) msg = "Error: the following arguments are required: subcommand" with self.assertRaisesMessage(CommandError, msg): From 8f3dee1dfdc4242348c6cd6ead1c359cda78c2b5 Mon Sep 17 00:00:00 2001 From: antoliny0919 Date: Wed, 30 Oct 2024 07:17:55 +0900 Subject: [PATCH 055/132] Fixed #35873 -- Corrected Form.as_table() call in form docs. --- docs/ref/forms/api.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/ref/forms/api.txt b/docs/ref/forms/api.txt index 8abe273a59..a43ffff11d 100644 --- a/docs/ref/forms/api.txt +++ b/docs/ref/forms/api.txt @@ -770,7 +770,7 @@ The template used by ``as_table()``. Default: ``'django/forms/table.html'``. >>> f = ContactForm() >>> f.as_table() '\n\n\n' - >>> print(f) + >>> print(f.as_table()) From 17c8ee7e3f7bf400128281b4fb283d7c209ca02b Mon Sep 17 00:00:00 2001 From: Mike Edmunds Date: Mon, 28 Oct 2024 12:54:20 -0700 Subject: [PATCH 056/132] Fixed #35864 -- Documented EmailMessage.connection is ignored when using send_messages(). --- docs/topics/email.txt | 15 +++++++++------ 1 file changed, 9 insertions(+), 6 deletions(-) diff --git a/docs/topics/email.txt b/docs/topics/email.txt index 150e25958e..74468063b8 100644 --- a/docs/topics/email.txt +++ b/docs/topics/email.txt @@ -311,9 +311,11 @@ All parameters are optional and can be set at any time prior to calling the * ``bcc``: A list or tuple of addresses used in the "Bcc" header when sending the email. -* ``connection``: An email backend instance. Use this parameter if - you want to use the same connection for multiple messages. If omitted, a - new connection is created when ``send()`` is called. +* ``connection``: An :ref:`email backend ` instance. Use + this parameter if you are sending the ``EmailMessage`` via ``send()`` and you + want to use the same connection for multiple messages. If omitted, a new + connection is created when ``send()`` is called. This parameter is ignored + when using :ref:`send_messages() `. * ``attachments``: A list of attachments to put on the message. These can be instances of :class:`~email.mime.base.MIMEBase` or @@ -728,9 +730,10 @@ destroying a connection every time you want to send an email. There are two ways you tell an email backend to reuse a connection. -Firstly, you can use the ``send_messages()`` method. ``send_messages()`` takes -a list of :class:`~django.core.mail.EmailMessage` instances (or subclasses), -and sends them all using a single connection. +Firstly, you can use the ``send_messages()`` method on a connection. This takes +a list of :class:`EmailMessage` (or subclass) instances, and sends them all +using that single connection. As a consequence, any :class:`connection +` set on an individual message is ignored. For example, if you have a function called ``get_notification_email()`` that returns a list of :class:`~django.core.mail.EmailMessage` objects representing From a8f8b5a477bbf6a4fdf3006987117b90634ffba7 Mon Sep 17 00:00:00 2001 From: aruseni Date: Sun, 27 Oct 2024 21:31:36 +0200 Subject: [PATCH 057/132] Clarified default behavior when fields and fieldsets are not set on ModelAdmin. --- docs/ref/contrib/admin/index.txt | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/ref/contrib/admin/index.txt b/docs/ref/contrib/admin/index.txt index 716e3180db..d9e12f0165 100644 --- a/docs/ref/contrib/admin/index.txt +++ b/docs/ref/contrib/admin/index.txt @@ -337,7 +337,8 @@ subclass:: If neither ``fields`` nor :attr:`~ModelAdmin.fieldsets` options are present, Django will default to displaying each field that isn't an ``AutoField`` and has ``editable=True``, in a single fieldset, in the same order as the fields - are defined in the model. + are defined in the model, followed by any fields defined in + :attr:`~ModelAdmin.readonly_fields`. .. attribute:: ModelAdmin.fieldsets From 97a6a678c406b0049bd17bcd34f1d71d96141994 Mon Sep 17 00:00:00 2001 From: Johanan-Ayadata Date: Tue, 22 Oct 2024 22:20:55 +0000 Subject: [PATCH 058/132] Added missing lang attributes to html elements in docs. --- docs/intro/overview.txt | 2 +- docs/ref/contrib/flatpages.txt | 2 +- docs/topics/http/views.txt | 4 ++-- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/intro/overview.txt b/docs/intro/overview.txt index 0c41446d01..af87a01bb4 100644 --- a/docs/intro/overview.txt +++ b/docs/intro/overview.txt @@ -309,7 +309,7 @@ Here's what the "base.html" template, including the use of :doc:`static files :caption: ``templates/base.html`` {% load static %} - + {% block title %}{% endblock %} diff --git a/docs/ref/contrib/flatpages.txt b/docs/ref/contrib/flatpages.txt index c82fb5de85..01e5553ff3 100644 --- a/docs/ref/contrib/flatpages.txt +++ b/docs/ref/contrib/flatpages.txt @@ -256,7 +256,7 @@ Here's a sample :file:`flatpages/default.html` template: .. code-block:: html+django - + {{ flatpage.title }} diff --git a/docs/topics/http/views.txt b/docs/topics/http/views.txt index 2985bfb72b..feb4eaa4ec 100644 --- a/docs/topics/http/views.txt +++ b/docs/topics/http/views.txt @@ -23,7 +23,7 @@ Here's a view that returns the current date and time, as an HTML document:: def current_datetime(request): now = datetime.datetime.now() - html = "It is now %s." % now + html = 'It is now %s.' % now return HttpResponse(html) Let's step through this code one line at a time: @@ -225,7 +225,7 @@ Here's an example of an async view:: async def current_datetime(request): now = datetime.datetime.now() - html = "It is now %s." % now + html = 'It is now %s.' % now return HttpResponse(html) You can read more about Django's async support, and how to best use async From 3a8f52fbc6fe2ff646a2da4165497d82117e4a92 Mon Sep 17 00:00:00 2001 From: Anthony Joseph Date: Wed, 23 Oct 2024 22:13:18 +1100 Subject: [PATCH 059/132] Fixed #35856 -- Added QuerySet.explain() support for MEMORY/SERIALIZE option on PostgreSQL 17+. --- django/db/backends/postgresql/features.py | 4 ++++ django/db/backends/postgresql/operations.py | 5 +++++ docs/ref/models/querysets.txt | 5 +++++ docs/releases/5.2.txt | 3 +++ tests/queries/test_explain.py | 13 ++++++++++++- 5 files changed, 29 insertions(+), 1 deletion(-) diff --git a/django/db/backends/postgresql/features.py b/django/db/backends/postgresql/features.py index 6170b5501a..16653a0519 100644 --- a/django/db/backends/postgresql/features.py +++ b/django/db/backends/postgresql/features.py @@ -160,6 +160,10 @@ class DatabaseFeatures(BaseDatabaseFeatures): def is_postgresql_16(self): return self.connection.pg_version >= 160000 + @cached_property + def is_postgresql_17(self): + return self.connection.pg_version >= 170000 + supports_unlimited_charfield = True supports_nulls_distinct_unique_constraints = property( operator.attrgetter("is_postgresql_15") diff --git a/django/db/backends/postgresql/operations.py b/django/db/backends/postgresql/operations.py index 4b179ca83f..d89f81bf7e 100644 --- a/django/db/backends/postgresql/operations.py +++ b/django/db/backends/postgresql/operations.py @@ -32,7 +32,9 @@ class DatabaseOperations(BaseDatabaseOperations): "BUFFERS", "COSTS", "GENERIC_PLAN", + "MEMORY", "SETTINGS", + "SERIALIZE", "SUMMARY", "TIMING", "VERBOSE", @@ -365,6 +367,9 @@ class DatabaseOperations(BaseDatabaseOperations): def explain_query_prefix(self, format=None, **options): extra = {} + if serialize := options.pop("serialize", None): + if serialize.upper() in {"TEXT", "BINARY"}: + extra["SERIALIZE"] = serialize.upper() # Normalize options. if options: options = { diff --git a/docs/ref/models/querysets.txt b/docs/ref/models/querysets.txt index c6af3dd7f0..ec27936cdb 100644 --- a/docs/ref/models/querysets.txt +++ b/docs/ref/models/querysets.txt @@ -3110,6 +3110,11 @@ there are triggers or if a function is called, even for a ``SELECT`` query. Support for the ``generic_plan`` option on PostgreSQL 16+ was added. +.. versionchanged:: 5.2 + + Support for the ``memory`` and ``serialize`` options on PostgreSQL 17+ was + added. + .. _field-lookups: ``Field`` lookups diff --git a/docs/releases/5.2.txt b/docs/releases/5.2.txt index e103de847b..96007887bc 100644 --- a/docs/releases/5.2.txt +++ b/docs/releases/5.2.txt @@ -277,6 +277,9 @@ Models longer required to be set on SQLite, which supports unlimited ``VARCHAR`` columns. +* :meth:`.QuerySet.explain` now supports the ``memory`` and ``serialize`` + options on PostgreSQL 17+. + Requests and Responses ~~~~~~~~~~~~~~~~~~~~~~ diff --git a/tests/queries/test_explain.py b/tests/queries/test_explain.py index 67440cb502..95ca913cfc 100644 --- a/tests/queries/test_explain.py +++ b/tests/queries/test_explain.py @@ -90,13 +90,24 @@ class ExplainTests(TestCase): ] if connection.features.is_postgresql_16: test_options.append({"generic_plan": True}) + if connection.features.is_postgresql_17: + test_options.append({"memory": True}) + test_options.append({"serialize": "TEXT", "analyze": True}) + test_options.append({"serialize": "text", "analyze": True}) + test_options.append({"serialize": "BINARY", "analyze": True}) + test_options.append({"serialize": "binary", "analyze": True}) for options in test_options: with self.subTest(**options), transaction.atomic(): with CaptureQueriesContext(connection) as captured_queries: qs.explain(format="text", **options) self.assertEqual(len(captured_queries), 1) for name, value in options.items(): - option = "{} {}".format(name.upper(), "true" if value else "false") + if isinstance(value, str): + option = "{} {}".format(name.upper(), value.upper()) + else: + option = "{} {}".format( + name.upper(), "true" if value else "false" + ) self.assertIn(option, captured_queries[0]["sql"]) @skipUnlessDBFeature("supports_select_union") From b50d1a020d3a988ab9f45724138943dc807c5ecc Mon Sep 17 00:00:00 2001 From: maddrum Date: Sat, 26 Oct 2024 14:46:46 +0300 Subject: [PATCH 060/132] Fixed #35866 -- Clarified the positioning Python magic methods on models in the internal style guide. --- docs/internals/contributing/writing-code/coding-style.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/internals/contributing/writing-code/coding-style.txt b/docs/internals/contributing/writing-code/coding-style.txt index c1838b77a3..20605aef56 100644 --- a/docs/internals/contributing/writing-code/coding-style.txt +++ b/docs/internals/contributing/writing-code/coding-style.txt @@ -417,7 +417,7 @@ Model style * All database fields * Custom manager attributes * ``class Meta`` - * ``def __str__()`` + * ``def __str__()`` and other Python magic methods * ``def save()`` * ``def get_absolute_url()`` * Any custom methods From 0eaaadd47fa00baabe12be3ed736aa016b6d327e Mon Sep 17 00:00:00 2001 From: Ben Cail Date: Tue, 17 Sep 2024 15:10:39 -0400 Subject: [PATCH 061/132] Fixed #35180 -- Recreated PostgreSQL _like indexes when changing between TextField and CharField field types. --- django/db/backends/postgresql/schema.py | 23 +++++++++---- tests/schema/tests.py | 45 +++++++++++++++++++++++++ 2 files changed, 61 insertions(+), 7 deletions(-) diff --git a/django/db/backends/postgresql/schema.py b/django/db/backends/postgresql/schema.py index 0c8548a5d6..75bf331472 100644 --- a/django/db/backends/postgresql/schema.py +++ b/django/db/backends/postgresql/schema.py @@ -140,6 +140,13 @@ class DatabaseSchemaEditor(BaseDatabaseSchemaEditor): return sequence["name"] return None + def _is_changing_type_of_indexed_text_column(self, old_field, old_type, new_type): + return (old_field.db_index or old_field.unique) and ( + (old_type.startswith("varchar") and not new_type.startswith("varchar")) + or (old_type.startswith("text") and not new_type.startswith("text")) + or (old_type.startswith("citext") and not new_type.startswith("citext")) + ) + def _alter_column_type_sql( self, model, old_field, new_field, new_type, old_collation, new_collation ): @@ -147,11 +154,7 @@ class DatabaseSchemaEditor(BaseDatabaseSchemaEditor): # different type. old_db_params = old_field.db_parameters(connection=self.connection) old_type = old_db_params["type"] - if (old_field.db_index or old_field.unique) and ( - (old_type.startswith("varchar") and not new_type.startswith("varchar")) - or (old_type.startswith("text") and not new_type.startswith("text")) - or (old_type.startswith("citext") and not new_type.startswith("citext")) - ): + if self._is_changing_type_of_indexed_text_column(old_field, old_type, new_type): index_name = self._create_index_name( model._meta.db_table, [old_field.column], suffix="_like" ) @@ -277,8 +280,14 @@ class DatabaseSchemaEditor(BaseDatabaseSchemaEditor): strict, ) # Added an index? Create any PostgreSQL-specific indexes. - if (not (old_field.db_index or old_field.unique) and new_field.db_index) or ( - not old_field.unique and new_field.unique + if ( + (not (old_field.db_index or old_field.unique) and new_field.db_index) + or (not old_field.unique and new_field.unique) + or ( + self._is_changing_type_of_indexed_text_column( + old_field, old_type, new_type + ) + ) ): like_index_statement = self._create_like_index_sql(model, new_field) if like_index_statement is not None: diff --git a/tests/schema/tests.py b/tests/schema/tests.py index 33a4bc527b..935267c2d6 100644 --- a/tests/schema/tests.py +++ b/tests/schema/tests.py @@ -5223,6 +5223,51 @@ class SchemaTests(TransactionTestCase): ["schema_tag_slug_2c418ba3_like", "schema_tag_slug_key"], ) + @isolate_apps("schema") + @unittest.skipUnless(connection.vendor == "postgresql", "PostgreSQL specific") + def test_indexed_charfield_to_textfield(self): + class SimpleModel(Model): + field1 = CharField(max_length=10, db_index=True) + + class Meta: + app_label = "schema" + + with connection.schema_editor() as editor: + editor.create_model(SimpleModel) + self.assertEqual( + self.get_constraints_for_column(SimpleModel, "field1"), + [ + "schema_simplemodel_field1_f07a3d6a", + "schema_simplemodel_field1_f07a3d6a_like", + ], + ) + # Change to TextField. + old_field1 = SimpleModel._meta.get_field("field1") + new_field1 = TextField(db_index=True) + new_field1.set_attributes_from_name("field1") + with connection.schema_editor() as editor: + editor.alter_field(SimpleModel, old_field1, new_field1, strict=True) + self.assertEqual( + self.get_constraints_for_column(SimpleModel, "field1"), + [ + "schema_simplemodel_field1_f07a3d6a", + "schema_simplemodel_field1_f07a3d6a_like", + ], + ) + # Change back to CharField. + old_field1 = SimpleModel._meta.get_field("field1") + new_field1 = CharField(max_length=10, db_index=True) + new_field1.set_attributes_from_name("field1") + with connection.schema_editor() as editor: + editor.alter_field(SimpleModel, old_field1, new_field1, strict=True) + self.assertEqual( + self.get_constraints_for_column(SimpleModel, "field1"), + [ + "schema_simplemodel_field1_f07a3d6a", + "schema_simplemodel_field1_f07a3d6a_like", + ], + ) + def test_alter_field_add_index_to_integerfield(self): # Create the table and verify no initial indexes. with connection.schema_editor() as editor: From 2c029c718f45341cdd43ee094c24488743c633e6 Mon Sep 17 00:00:00 2001 From: Sarah Boyce <42296566+sarahboyce@users.noreply.github.com> Date: Wed, 30 Oct 2024 09:27:57 +0100 Subject: [PATCH 062/132] Fixed #35876 -- Displayed non-ASCII fieldset names when rendering ModelAdmin.fieldsets. Thank you to Namhong Kim for the report, and to Mariusz Felisiak and Marijke Luttekes for the review. Regression in 01ed59f753139afb514170ee7f7384c155ecbc2d. --- .../admin/templates/admin/includes/fieldset.html | 10 ++++------ docs/releases/5.1.3.txt | 3 +++ tests/admin_inlines/tests.py | 4 ++-- tests/admin_views/admin.py | 1 + tests/admin_views/tests.py | 13 +++++++++++++ 5 files changed, 23 insertions(+), 8 deletions(-) diff --git a/django/contrib/admin/templates/admin/includes/fieldset.html b/django/contrib/admin/templates/admin/includes/fieldset.html index 8c1830da62..9c9b31965a 100644 --- a/django/contrib/admin/templates/admin/includes/fieldset.html +++ b/django/contrib/admin/templates/admin/includes/fieldset.html @@ -1,8 +1,7 @@ -{% with name=fieldset.name|default:""|slugify %} -
    - {% if name %} +
    + {% if fieldset.name %} {% if fieldset.is_collapsible %}
    {% endif %} - {{ fieldset.name }} + {{ fieldset.name }} {% if fieldset.is_collapsible %}{% endif %} {% endif %} {% if fieldset.description %} @@ -36,6 +35,5 @@ {% if not line.fields|length == 1 %}
    {% endif %} {% endfor %} - {% if name and fieldset.is_collapsible %}{% endif %} + {% if fieldset.name and fieldset.is_collapsible %}{% endif %} -{% endwith %} diff --git a/docs/releases/5.1.3.txt b/docs/releases/5.1.3.txt index 0dd5b42cb8..2ef34bfc8a 100644 --- a/docs/releases/5.1.3.txt +++ b/docs/releases/5.1.3.txt @@ -17,3 +17,6 @@ Bugfixes * Fixed a regression in Django 5.1 that prevented the use of DB-IP databases with :class:`~django.contrib.gis.geoip2.GeoIP2` (:ticket:`35841`). + +* Fixed a regression in Django 5.1 where non-ASCII fieldset names were not + displayed when rendering admin fieldsets (:ticket:`35876`). diff --git a/tests/admin_inlines/tests.py b/tests/admin_inlines/tests.py index 8e69edb841..9c32f6fb8e 100644 --- a/tests/admin_inlines/tests.py +++ b/tests/admin_inlines/tests.py @@ -1801,7 +1801,7 @@ class TestInlineWithFieldsets(TestDataMixin, TestCase): # The second and third have the same "Advanced options" name, but the # second one has the "collapse" class. for x, classes in ((1, ""), (2, "collapse")): - heading_id = f"fieldset-0-advanced-options-{x}-heading" + heading_id = f"fieldset-0-{x}-heading" with self.subTest(heading_id=heading_id): self.assertContains( response, @@ -1846,7 +1846,7 @@ class TestInlineWithFieldsets(TestDataMixin, TestCase): # Every fieldset defined for an inline's form. for z, fieldset in enumerate(inline_admin_form): if fieldset.name: - heading_id = f"{prefix}-{y}-details-{z}-heading" + heading_id = f"{prefix}-{y}-{z}-heading" self.assertContains( response, f'
    ' ) + self.assertContains( + response, + '

    Some fields

    ', + ) + self.assertContains( + response, + '

    ' + "Some other fields

    ", + ) + self.assertContains( + response, + '

    이름

    ', + ) post = self.client.post( reverse("admin:admin_views_article_add"), add_dict, follow=False ) From 8864125d1f423ee94c2bb1cc36ea998619d47c3f Mon Sep 17 00:00:00 2001 From: antoliny0919 Date: Thu, 31 Oct 2024 07:49:24 +0900 Subject: [PATCH 063/132] Updated the "Built-in Field classes" section reference to a link. --- docs/ref/forms/api.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/ref/forms/api.txt b/docs/ref/forms/api.txt index a43ffff11d..9ce16ff2ab 100644 --- a/docs/ref/forms/api.txt +++ b/docs/ref/forms/api.txt @@ -511,7 +511,7 @@ empty string, because ``nick_name`` is ``CharField``, and ``CharField``\s treat empty values as an empty string. Each field type knows what its "blank" value is -- e.g., for ``DateField``, it's ``None`` instead of the empty string. For full details on each field's behavior in this case, see the "Empty value" note -for each field in the "Built-in ``Field`` classes" section below. +for each field in the :ref:`built-in-fields` section below. You can write code to perform validation for particular form fields (based on their name) or for the form as a whole (considering combinations of various From 03c0a3de722c4a7de9f3edfeb26417ebc8b90fe9 Mon Sep 17 00:00:00 2001 From: Simon Charette Date: Thu, 31 Oct 2024 09:05:58 -0400 Subject: [PATCH 064/132] Refs #373 -- Used a feature flag to disable composite subquery test on MySQL. --- tests/foreign_object/test_tuple_lookups.py | 10 +++------- 1 file changed, 3 insertions(+), 7 deletions(-) diff --git a/tests/foreign_object/test_tuple_lookups.py b/tests/foreign_object/test_tuple_lookups.py index 06182d3bb5..499329e7ca 100644 --- a/tests/foreign_object/test_tuple_lookups.py +++ b/tests/foreign_object/test_tuple_lookups.py @@ -1,7 +1,6 @@ import itertools -import unittest -from django.db import NotSupportedError, connection +from django.db import NotSupportedError from django.db.models import F from django.db.models.fields.tuple_lookups import ( TupleExact, @@ -12,7 +11,7 @@ from django.db.models.fields.tuple_lookups import ( TupleLessThan, TupleLessThanOrEqual, ) -from django.test import TestCase +from django.test import TestCase, skipUnlessDBFeature from .models import Contact, Customer @@ -119,10 +118,7 @@ class TupleLookupsTests(TestCase): Contact.objects.filter(lookup).order_by("id"), contacts ) - @unittest.skipIf( - connection.vendor == "mysql", - "MySQL doesn't support LIMIT & IN/ALL/ANY/SOME subquery", - ) + @skipUnlessDBFeature("allow_sliced_subqueries_with_in") def test_in_subquery(self): subquery = Customer.objects.filter(id=self.customer_1.id)[:1] self.assertSequenceEqual( From 611bf6c2e2a1b4ab93273980c45150c099ab146d Mon Sep 17 00:00:00 2001 From: Sarah Boyce <42296566+sarahboyce@users.noreply.github.com> Date: Mon, 14 Oct 2024 13:59:00 +0200 Subject: [PATCH 065/132] Fixed #35837 -- Added missing alters_data=True to QuerySet and UserManager methods. Thank you to Jason Chambers for the report and to Mariusz Felisiak for the review. --- django/contrib/auth/models.py | 8 +++++++ django/db/models/query.py | 16 +++++++++++++ docs/releases/5.2.txt | 16 +++++++++++++ tests/template_backends/test_jinja2.py | 31 +++++++++++++++++++++++++- 4 files changed, 70 insertions(+), 1 deletion(-) diff --git a/django/contrib/auth/models.py b/django/contrib/auth/models.py index d4a8dd902b..623b169801 100644 --- a/django/contrib/auth/models.py +++ b/django/contrib/auth/models.py @@ -174,11 +174,15 @@ class UserManager(BaseUserManager): extra_fields.setdefault("is_superuser", False) return self._create_user(username, email, password, **extra_fields) + create_user.alters_data = True + async def acreate_user(self, username, email=None, password=None, **extra_fields): extra_fields.setdefault("is_staff", False) extra_fields.setdefault("is_superuser", False) return await self._acreate_user(username, email, password, **extra_fields) + acreate_user.alters_data = True + def create_superuser(self, username, email=None, password=None, **extra_fields): extra_fields.setdefault("is_staff", True) extra_fields.setdefault("is_superuser", True) @@ -190,6 +194,8 @@ class UserManager(BaseUserManager): return self._create_user(username, email, password, **extra_fields) + create_superuser.alters_data = True + async def acreate_superuser( self, username, email=None, password=None, **extra_fields ): @@ -203,6 +209,8 @@ class UserManager(BaseUserManager): return await self._acreate_user(username, email, password, **extra_fields) + acreate_superuser.alters_data = True + def with_perm( self, perm, is_active=True, include_superusers=True, backend=None, obj=None ): diff --git a/django/db/models/query.py b/django/db/models/query.py index a4277d05fc..21d5534cc9 100644 --- a/django/db/models/query.py +++ b/django/db/models/query.py @@ -660,9 +660,13 @@ class QuerySet(AltersData): obj.save(force_insert=True, using=self.db) return obj + create.alters_data = True + async def acreate(self, **kwargs): return await sync_to_async(self.create)(**kwargs) + acreate.alters_data = True + def _prepare_for_bulk_create(self, objs): from django.db.models.expressions import DatabaseDefault @@ -835,6 +839,8 @@ class QuerySet(AltersData): return objs + bulk_create.alters_data = True + async def abulk_create( self, objs, @@ -853,6 +859,8 @@ class QuerySet(AltersData): unique_fields=unique_fields, ) + abulk_create.alters_data = True + def bulk_update(self, objs, fields, batch_size=None): """ Update the given fields in each of the given objects in the database. @@ -941,12 +949,16 @@ class QuerySet(AltersData): pass raise + get_or_create.alters_data = True + async def aget_or_create(self, defaults=None, **kwargs): return await sync_to_async(self.get_or_create)( defaults=defaults, **kwargs, ) + aget_or_create.alters_data = True + def update_or_create(self, defaults=None, create_defaults=None, **kwargs): """ Look up an object with the given kwargs, updating one with defaults @@ -992,6 +1004,8 @@ class QuerySet(AltersData): obj.save(using=self.db) return obj, False + update_or_create.alters_data = True + async def aupdate_or_create(self, defaults=None, create_defaults=None, **kwargs): return await sync_to_async(self.update_or_create)( defaults=defaults, @@ -999,6 +1013,8 @@ class QuerySet(AltersData): **kwargs, ) + aupdate_or_create.alters_data = True + def _extract_model_params(self, defaults, **kwargs): """ Prepare `params` for creating a model instance based on the given diff --git a/docs/releases/5.2.txt b/docs/releases/5.2.txt index 96007887bc..8327de7405 100644 --- a/docs/releases/5.2.txt +++ b/docs/releases/5.2.txt @@ -392,6 +392,22 @@ Miscellaneous * The :func:`~django.template.context_processors.debug` context processor is no longer included in the default project template. +* The following methods now have ``alters_data=True`` set to prevent side + effects when :ref:`rendering a template context `: + + * :meth:`.UserManager.create_user` + * :meth:`.UserManager.acreate_user` + * :meth:`.UserManager.create_superuser` + * :meth:`.UserManager.acreate_superuser` + * :meth:`.QuerySet.create` + * :meth:`.QuerySet.acreate` + * :meth:`.QuerySet.bulk_create` + * :meth:`.QuerySet.abulk_create` + * :meth:`.QuerySet.get_or_create` + * :meth:`.QuerySet.aget_or_create` + * :meth:`.QuerySet.update_or_create` + * :meth:`.QuerySet.aupdate_or_create` + .. _deprecated-features-5.2: Features deprecated in 5.2 diff --git a/tests/template_backends/test_jinja2.py b/tests/template_backends/test_jinja2.py index 55c9299f85..508971f581 100644 --- a/tests/template_backends/test_jinja2.py +++ b/tests/template_backends/test_jinja2.py @@ -1,8 +1,9 @@ from pathlib import Path from unittest import mock, skipIf +from django.contrib.auth.models import User from django.template import TemplateSyntaxError -from django.test import RequestFactory +from django.test import RequestFactory, TestCase from .test_dummy import TemplateStringsTests @@ -135,3 +136,31 @@ class Jinja2Tests(TemplateStringsTests): self.assertEqual(len(debug["source_lines"]), 0) self.assertTrue(debug["name"].endswith("nonexistent.html")) self.assertIn("message", debug) + + +@skipIf(jinja2 is None, "this test requires jinja2") +class Jinja2SandboxTests(TestCase): + engine_class = Jinja2 + backend_name = "jinja2" + options = {"environment": "jinja2.sandbox.SandboxedEnvironment"} + + @classmethod + def setUpClass(cls): + super().setUpClass() + params = { + "DIRS": [], + "APP_DIRS": True, + "NAME": cls.backend_name, + "OPTIONS": cls.options, + } + cls.engine = cls.engine_class(params) + + def test_set_alters_data(self): + template = self.engine.from_string( + "{% set test = User.objects.create_superuser(" + "username='evil', email='a@b.com', password='xxx') %}" + "{{ test }}" + ) + with self.assertRaises(jinja2.exceptions.SecurityError): + template.render(context={"User": User}) + self.assertEqual(User.objects.count(), 0) From f7601aed515a125cde776ebbf6ff6e8432cbafdb Mon Sep 17 00:00:00 2001 From: Bendeguz Csirmaz Date: Tue, 15 Oct 2024 01:31:27 +0800 Subject: [PATCH 066/132] Refs #373 -- Added TupleIn subqueries. --- django/db/models/fields/tuple_lookups.py | 41 ++++++++++++++++++++-- tests/foreign_object/test_tuple_lookups.py | 41 ++++++++++++++++++++++ 2 files changed, 79 insertions(+), 3 deletions(-) diff --git a/django/db/models/fields/tuple_lookups.py b/django/db/models/fields/tuple_lookups.py index a94582db95..6342937cd6 100644 --- a/django/db/models/fields/tuple_lookups.py +++ b/django/db/models/fields/tuple_lookups.py @@ -12,6 +12,7 @@ from django.db.models.lookups import ( LessThan, LessThanOrEqual, ) +from django.db.models.sql import Query from django.db.models.sql.where import AND, OR, WhereNode @@ -211,9 +212,14 @@ class TupleLessThanOrEqual(TupleLookupMixin, LessThanOrEqual): class TupleIn(TupleLookupMixin, In): def get_prep_lookup(self): - self.check_rhs_is_tuple_or_list() - self.check_rhs_is_collection_of_tuples_or_lists() - self.check_rhs_elements_length_equals_lhs_length() + if self.rhs_is_direct_value(): + self.check_rhs_is_tuple_or_list() + self.check_rhs_is_collection_of_tuples_or_lists() + self.check_rhs_elements_length_equals_lhs_length() + else: + self.check_rhs_is_query() + self.check_rhs_select_length_equals_lhs_length() + return self.rhs # skip checks from mixin def check_rhs_is_collection_of_tuples_or_lists(self): @@ -233,6 +239,25 @@ class TupleIn(TupleLookupMixin, In): f"must have {len_lhs} elements each" ) + def check_rhs_is_query(self): + if not isinstance(self.rhs, Query): + lhs_str = self.get_lhs_str() + rhs_cls = self.rhs.__class__.__name__ + raise ValueError( + f"{self.lookup_name!r} subquery lookup of {lhs_str} " + f"must be a Query object (received {rhs_cls!r})" + ) + + def check_rhs_select_length_equals_lhs_length(self): + len_rhs = len(self.rhs.select) + len_lhs = len(self.lhs) + if len_rhs != len_lhs: + lhs_str = self.get_lhs_str() + raise ValueError( + f"{self.lookup_name!r} subquery lookup of {lhs_str} " + f"must have {len_lhs} fields (received {len_rhs})" + ) + def process_rhs(self, compiler, connection): rhs = self.rhs if not rhs: @@ -255,10 +280,17 @@ class TupleIn(TupleLookupMixin, In): return Tuple(*result).as_sql(compiler, connection) + def as_sql(self, compiler, connection): + if not self.rhs_is_direct_value(): + return self.as_subquery(compiler, connection) + return super().as_sql(compiler, connection) + def as_sqlite(self, compiler, connection): rhs = self.rhs if not rhs: raise EmptyResultSet + if not self.rhs_is_direct_value(): + return self.as_subquery(compiler, connection) # e.g.: (a, b, c) in [(x1, y1, z1), (x2, y2, z2)] as SQL: # WHERE (a = x1 AND b = y1 AND c = z1) OR (a = x2 AND b = y2 AND c = z2) @@ -271,6 +303,9 @@ class TupleIn(TupleLookupMixin, In): return root.as_sql(compiler, connection) + def as_subquery(self, compiler, connection): + return compiler.compile(In(self.lhs, self.rhs)) + tuple_lookups = { "exact": TupleExact, diff --git a/tests/foreign_object/test_tuple_lookups.py b/tests/foreign_object/test_tuple_lookups.py index 499329e7ca..797fea1c8a 100644 --- a/tests/foreign_object/test_tuple_lookups.py +++ b/tests/foreign_object/test_tuple_lookups.py @@ -11,6 +11,7 @@ from django.db.models.fields.tuple_lookups import ( TupleLessThan, TupleLessThanOrEqual, ) +from django.db.models.lookups import In from django.test import TestCase, skipUnlessDBFeature from .models import Contact, Customer @@ -126,6 +127,46 @@ class TupleLookupsTests(TestCase): (self.contact_1, self.contact_2, self.contact_5), ) + def test_tuple_in_subquery_must_be_query(self): + lhs = (F("customer_code"), F("company_code")) + # If rhs is any non-Query object with an as_sql() function. + rhs = In(F("customer_code"), [1, 2, 3]) + with self.assertRaisesMessage( + ValueError, + "'in' subquery lookup of ('customer_code', 'company_code') " + "must be a Query object (received 'In')", + ): + TupleIn(lhs, rhs) + + def test_tuple_in_subquery_must_have_2_fields(self): + lhs = (F("customer_code"), F("company_code")) + rhs = Customer.objects.values_list("customer_id").query + with self.assertRaisesMessage( + ValueError, + "'in' subquery lookup of ('customer_code', 'company_code') " + "must have 2 fields (received 1)", + ): + TupleIn(lhs, rhs) + + def test_tuple_in_subquery(self): + customers = Customer.objects.values_list("customer_id", "company") + test_cases = ( + (self.customer_1, (self.contact_1, self.contact_2, self.contact_5)), + (self.customer_2, (self.contact_3,)), + (self.customer_3, (self.contact_4,)), + (self.customer_4, ()), + (self.customer_5, (self.contact_6,)), + ) + + for customer, contacts in test_cases: + lhs = (F("customer_code"), F("company_code")) + rhs = customers.filter(id=customer.id).query + lookup = TupleIn(lhs, rhs) + qs = Contact.objects.filter(lookup).order_by("id") + + with self.subTest(customer=customer.id, query=str(qs.query)): + self.assertSequenceEqual(qs, contacts) + def test_tuple_in_rhs_must_be_collection_of_tuples_or_lists(self): test_cases = ( (1, 2, 3), From cd4497254e8b52e7d28dda764b6a2567253059f4 Mon Sep 17 00:00:00 2001 From: David Smith Date: Sat, 2 Nov 2024 15:47:07 +0000 Subject: [PATCH 067/132] Fixed #35883 -- Confirmed support for GDAL 3.9. Updated test for change to exportToXML() which now errors out on unsupported projection methods. See https://github.com/OSGeo/gdal/issues/9223. Co-authored-by: Mariusz Felisiak --- django/contrib/gis/gdal/libgdal.py | 2 ++ docs/ref/contrib/gis/install/geolibs.txt | 9 +++++---- tests/gis_tests/gdal_tests/test_srs.py | 4 +++- 3 files changed, 10 insertions(+), 5 deletions(-) diff --git a/django/contrib/gis/gdal/libgdal.py b/django/contrib/gis/gdal/libgdal.py index 9f88bbedc8..c9757a546f 100644 --- a/django/contrib/gis/gdal/libgdal.py +++ b/django/contrib/gis/gdal/libgdal.py @@ -22,6 +22,7 @@ if lib_path: elif os.name == "nt": # Windows NT shared libraries lib_names = [ + "gdal309", "gdal308", "gdal307", "gdal306", @@ -36,6 +37,7 @@ elif os.name == "posix": lib_names = [ "gdal", "GDAL", + "gdal3.9.0", "gdal3.8.0", "gdal3.7.0", "gdal3.6.0", diff --git a/docs/ref/contrib/gis/install/geolibs.txt b/docs/ref/contrib/gis/install/geolibs.txt index d988cd33f6..d9bd1dddea 100644 --- a/docs/ref/contrib/gis/install/geolibs.txt +++ b/docs/ref/contrib/gis/install/geolibs.txt @@ -5,16 +5,16 @@ Installing Geospatial libraries GeoDjango uses and/or provides interfaces for the following open source geospatial libraries: -======================== ==================================== ================================ ====================================== +======================== ==================================== ================================ =========================================== Program Description Required Supported Versions -======================== ==================================== ================================ ====================================== +======================== ==================================== ================================ =========================================== :doc:`GEOS <../geos>` Geometry Engine Open Source Yes 3.12, 3.11, 3.10, 3.9, 3.8 `PROJ`_ Cartographic Projections library Yes (PostgreSQL and SQLite only) 9.x, 8.x, 7.x, 6.x -:doc:`GDAL <../gdal>` Geospatial Data Abstraction Library Yes 3.8, 3.7, 3.6, 3.5, 3.4, 3.3, 3.2, 3.1 +:doc:`GDAL <../gdal>` Geospatial Data Abstraction Library Yes 3.9, 3.8, 3.7, 3.6, 3.5, 3.4, 3.3, 3.2, 3.1 :doc:`GeoIP <../geoip2>` IP-based geolocation library No 2 `PostGIS`__ Spatial extensions for PostgreSQL Yes (PostgreSQL only) 3.4, 3.3, 3.2, 3.1 `SpatiaLite`__ Spatial extensions for SQLite Yes (SQLite only) 5.1, 5.0, 4.3 -======================== ==================================== ================================ ====================================== +======================== ==================================== ================================ =========================================== Note that older or more recent versions of these libraries *may* also work totally fine with GeoDjango. Your mileage may vary. @@ -34,6 +34,7 @@ totally fine with GeoDjango. Your mileage may vary. GDAL 3.6.0 2022-11-03 GDAL 3.7.0 2023-05-10 GDAL 3.8.0 2023-11-13 + GDAL 3.9.0 2024-05-10 PostGIS 3.1.0 2020-12-18 PostGIS 3.2.0 2021-12-18 PostGIS 3.3.0 2022-08-27 diff --git a/tests/gis_tests/gdal_tests/test_srs.py b/tests/gis_tests/gdal_tests/test_srs.py index 5d82a8175a..62ebc63889 100644 --- a/tests/gis_tests/gdal_tests/test_srs.py +++ b/tests/gis_tests/gdal_tests/test_srs.py @@ -1,4 +1,5 @@ from django.contrib.gis.gdal import ( + GDAL_VERSION, AxisOrder, CoordTransform, GDALException, @@ -353,7 +354,8 @@ class SpatialRefTest(SimpleTestCase): self.assertEqual(srs.name, "DHDN / Soldner 39 Langschoß") self.assertEqual(srs.wkt, wkt) self.assertIn("Langschoß", srs.pretty_wkt) - self.assertIn("Langschoß", srs.xml) + if GDAL_VERSION < (3, 9): + self.assertIn("Langschoß", srs.xml) def test_axis_order(self): wgs84_trad = SpatialReference(4326, axis_order=AxisOrder.TRADITIONAL) From f223729f8f8380901473b244c0fc7c7dc397e3f1 Mon Sep 17 00:00:00 2001 From: 0saurabh0 Date: Fri, 1 Nov 2024 08:26:10 +0100 Subject: [PATCH 068/132] Fixed #26001 -- Fixed non-string field exact lookups in ModelAdmin.search_fields. --- django/contrib/admin/options.py | 31 ++++++++++++++++++++++++++++--- tests/admin_changelist/admin.py | 1 + tests/admin_changelist/tests.py | 19 +++++++++++++++++++ 3 files changed, 48 insertions(+), 3 deletions(-) diff --git a/django/contrib/admin/options.py b/django/contrib/admin/options.py index 6d5c0708a3..78063a134d 100644 --- a/django/contrib/admin/options.py +++ b/django/contrib/admin/options.py @@ -41,6 +41,7 @@ from django.core.exceptions import ( from django.core.paginator import Paginator from django.db import models, router, transaction from django.db.models.constants import LOOKUP_SEP +from django.db.models.functions import Cast from django.forms.formsets import DELETION_FIELD_NAME, all_valid from django.forms.models import ( BaseInlineFormSet, @@ -1207,9 +1208,33 @@ class ModelAdmin(BaseModelAdmin): may_have_duplicates = False search_fields = self.get_search_fields(request) if search_fields and search_term: - orm_lookups = [ - construct_search(str(search_field)) for search_field in search_fields - ] + str_annotations = {} + orm_lookups = [] + for field in search_fields: + if field.endswith("__exact"): + field_name = field.rsplit("__exact", 1)[0] + try: + field_obj = queryset.model._meta.get_field(field_name) + except FieldDoesNotExist: + lookup = construct_search(field) + orm_lookups.append(lookup) + continue + # Add string cast annotations for non-string exact lookups. + if not isinstance(field_obj, (models.CharField, models.TextField)): + str_annotations[f"{field_name}_str"] = Cast( + field_name, output_field=models.CharField() + ) + orm_lookups.append(f"{field_name}_str__exact") + else: + lookup = construct_search(field) + orm_lookups.append(lookup) + else: + lookup = construct_search(str(field)) + orm_lookups.append(lookup) + + if str_annotations: + queryset = queryset.annotate(**str_annotations) + term_queries = [] for bit in smart_split(search_term): if bit.startswith(('"', "'")) and bit[0] == bit[-1]: diff --git a/tests/admin_changelist/admin.py b/tests/admin_changelist/admin.py index 349ef7d465..d9dc498e84 100644 --- a/tests/admin_changelist/admin.py +++ b/tests/admin_changelist/admin.py @@ -48,6 +48,7 @@ class ChildAdmin(admin.ModelAdmin): list_display = ["name", "parent"] list_per_page = 10 list_filter = ["parent", "age"] + search_fields = ["age__exact", "name__exact"] def get_queryset(self, request): return super().get_queryset(request).select_related("parent") diff --git a/tests/admin_changelist/tests.py b/tests/admin_changelist/tests.py index d8055a809b..a823a72f7d 100644 --- a/tests/admin_changelist/tests.py +++ b/tests/admin_changelist/tests.py @@ -860,6 +860,25 @@ class ChangeListTests(TestCase): cl = m.get_changelist_instance(request) self.assertCountEqual(cl.queryset, [abcd]) + def test_search_with_exact_lookup_for_non_string_field(self): + child = Child.objects.create(name="Asher", age=11) + model_admin = ChildAdmin(Child, custom_site) + + for search_term, expected_result in [ + ("11", [child]), + ("Asher", [child]), + ("1", []), + ("A", []), + ("random", []), + ]: + request = self.factory.get("/", data={SEARCH_VAR: search_term}) + request.user = self.superuser + with self.subTest(search_term=search_term): + # 1 query for filtered result, 1 for filtered count, 1 for total count. + with self.assertNumQueries(3): + cl = model_admin.get_changelist_instance(request) + self.assertCountEqual(cl.queryset, expected_result) + def test_no_distinct_for_m2m_in_list_filter_without_params(self): """ If a ManyToManyField is in list_filter but isn't in any lookup params, From 4fcbdb11b114bc4d2dc50663f8053de2f18c0770 Mon Sep 17 00:00:00 2001 From: antoliny0919 Date: Mon, 4 Nov 2024 09:10:58 +0100 Subject: [PATCH 069/132] Made minor edits to form fields docs. --- docs/ref/forms/fields.txt | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/ref/forms/fields.txt b/docs/ref/forms/fields.txt index ac1df1bd86..3871e3e8e1 100644 --- a/docs/ref/forms/fields.txt +++ b/docs/ref/forms/fields.txt @@ -112,7 +112,7 @@ validation may not be correct when adding and deleting formsets. The ``label`` argument lets you specify the "human-friendly" label for this field. This is used when the ``Field`` is displayed in a ``Form``. -As explained in "Outputting forms as HTML" above, the default label for a +As explained in :ref:`ref-forms-api-outputting-html`, the default label for a ``Field`` is generated from the field name by converting all underscores to spaces and upper-casing the first letter. Specify ``label`` if that default behavior doesn't result in an adequate label. @@ -226,7 +226,7 @@ validation if a particular field's value is not given. ``initial`` values are >>> f = CommentForm(data) >>> f.is_valid() False - # The form does *not* fall back to using the initial values. + # The form does *not* fallback to using the initial values. >>> f.errors {'url': ['This field is required.'], 'name': ['This field is required.']} @@ -375,7 +375,7 @@ See the :doc:`validators documentation ` for more information. The ``localize`` argument enables the localization of form data input, as well as the rendered output. -See the :doc:`format localization ` documentation for +See the :doc:`format localization documentation ` for more information. ``disabled`` From 968397228fe03968bb855856532569586c8a8a1c Mon Sep 17 00:00:00 2001 From: sai-ganesh-03 Date: Thu, 31 Oct 2024 19:10:00 +0530 Subject: [PATCH 070/132] Fixed #35867, Refs #2411 -- Allowed links in admindocs view details summary. --- .../templates/admin_doc/view_detail.html | 2 +- django/contrib/admindocs/utils.py | 4 ++++ django/contrib/admindocs/views.py | 6 +++--- tests/admin_docs/test_views.py | 16 ++++++++++++++-- tests/admin_docs/urls.py | 1 + tests/admin_docs/views.py | 9 +++++++++ 6 files changed, 32 insertions(+), 6 deletions(-) diff --git a/django/contrib/admindocs/templates/admin_doc/view_detail.html b/django/contrib/admindocs/templates/admin_doc/view_detail.html index d1aa3ab98f..5a5b47247e 100644 --- a/django/contrib/admindocs/templates/admin_doc/view_detail.html +++ b/django/contrib/admindocs/templates/admin_doc/view_detail.html @@ -15,7 +15,7 @@

    {{ name }}

    -

    {{ summary|striptags }}

    +

    {{ summary }}

    {{ body }} diff --git a/django/contrib/admindocs/utils.py b/django/contrib/admindocs/utils.py index 3708a32813..3a7ca4e781 100644 --- a/django/contrib/admindocs/utils.py +++ b/django/contrib/admindocs/utils.py @@ -242,3 +242,7 @@ def remove_non_capturing_groups(pattern): final_pattern += pattern[prev_end:start] prev_end = end return final_pattern + pattern[prev_end:] + + +def strip_p_tags(value): + return mark_safe(value.replace("

    ", "").replace("

    ", "")) diff --git a/django/contrib/admindocs/views.py b/django/contrib/admindocs/views.py index 38a2bb9286..3fdb34e0d1 100644 --- a/django/contrib/admindocs/views.py +++ b/django/contrib/admindocs/views.py @@ -30,7 +30,7 @@ from django.utils.inspect import ( from django.utils.translation import gettext as _ from django.views.generic import TemplateView -from .utils import get_view_name +from .utils import get_view_name, strip_p_tags # Exclude methods starting with these strings from documentation MODEL_METHODS_EXCLUDE = ("_", "add_", "delete", "save", "set_") @@ -195,7 +195,7 @@ class ViewDetailView(BaseAdminDocsView): **{ **kwargs, "name": view, - "summary": title, + "summary": strip_p_tags(title), "body": body, "meta": metadata, } @@ -384,7 +384,7 @@ class ModelDetailView(BaseAdminDocsView): **{ **kwargs, "name": opts.label, - "summary": title, + "summary": strip_p_tags(title), "description": body, "fields": fields, "methods": methods, diff --git a/tests/admin_docs/test_views.py b/tests/admin_docs/test_views.py index 064ce27fb0..c48a89a1b0 100644 --- a/tests/admin_docs/test_views.py +++ b/tests/admin_docs/test_views.py @@ -89,6 +89,18 @@ class AdminDocViewTests(TestDataMixin, AdminDocsTestCase): # View docstring self.assertContains(response, "Base view for admindocs views.") + def testview_docstring_links(self): + summary = ( + '

    This is a view for ' + '' + "myapp.Company

    " + ) + url = reverse( + "django-admindocs-views-detail", args=["admin_docs.views.CompanyView"] + ) + response = self.client.get(url) + self.assertContains(response, summary, html=True) + @override_settings(ROOT_URLCONF="admin_docs.namespace_urls") def test_namespaced_view_detail(self): url = reverse( @@ -408,9 +420,9 @@ class TestModelDetailView(TestDataMixin, AdminDocsTestCase): def test_model_docstring_renders_correctly(self): summary = ( - '

    Stores information about a person, related to ' + '

    Stores information about a person, related to ' '' - "myapp.Company.

    " + "myapp.Company." ) subheading = "

    Notes

    " body = ( diff --git a/tests/admin_docs/urls.py b/tests/admin_docs/urls.py index de23d9baf5..779d5f9f5f 100644 --- a/tests/admin_docs/urls.py +++ b/tests/admin_docs/urls.py @@ -14,6 +14,7 @@ urlpatterns = [ path("admin/", admin.site.urls), path("admindocs/", include("django.contrib.admindocs.urls")), path("", include(ns_patterns, namespace="test")), + path("company/", views.CompanyView.as_view()), path("xview/func/", views.xview_dec(views.xview)), path("xview/class/", views.xview_dec(views.XViewClass.as_view())), path("xview/callable_object/", views.xview_dec(views.XViewCallableObject())), diff --git a/tests/admin_docs/views.py b/tests/admin_docs/views.py index 21fe382bba..5bccaf29a0 100644 --- a/tests/admin_docs/views.py +++ b/tests/admin_docs/views.py @@ -18,3 +18,12 @@ class XViewClass(View): class XViewCallableObject(View): def __call__(self, request): return HttpResponse() + + +class CompanyView(View): + """ + This is a view for :model:`myapp.Company` + """ + + def get(self, request): + return HttpResponse() From ecd81ac8b786ac6f4e8a5626e0d029bcb11064a5 Mon Sep 17 00:00:00 2001 From: Mariusz Felisiak Date: Tue, 5 Nov 2024 05:55:58 +0100 Subject: [PATCH 071/132] Added release date for 5.1.3. --- docs/releases/5.1.3.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/releases/5.1.3.txt b/docs/releases/5.1.3.txt index 2ef34bfc8a..9e251f221f 100644 --- a/docs/releases/5.1.3.txt +++ b/docs/releases/5.1.3.txt @@ -2,7 +2,7 @@ Django 5.1.3 release notes ========================== -*Expected November 5, 2024* +*November 5, 2024* Django 5.1.3 fixes several bugs in 5.1.2 and adds compatibility with Python 3.13. From 5bd58058116d2e6f07b72881218548fd9904167e Mon Sep 17 00:00:00 2001 From: Mariusz Felisiak Date: Tue, 5 Nov 2024 06:30:22 +0100 Subject: [PATCH 072/132] Added stub release notes for 5.1.4. --- docs/releases/5.1.4.txt | 12 ++++++++++++ docs/releases/index.txt | 1 + 2 files changed, 13 insertions(+) create mode 100644 docs/releases/5.1.4.txt diff --git a/docs/releases/5.1.4.txt b/docs/releases/5.1.4.txt new file mode 100644 index 0000000000..bee40f243e --- /dev/null +++ b/docs/releases/5.1.4.txt @@ -0,0 +1,12 @@ +========================== +Django 5.1.4 release notes +========================== + +*Expected December 3, 2024* + +Django 5.1.4 fixes several bugs in 5.1.3. + +Bugfixes +======== + +* ... diff --git a/docs/releases/index.txt b/docs/releases/index.txt index a38053c2a9..66cc107c35 100644 --- a/docs/releases/index.txt +++ b/docs/releases/index.txt @@ -32,6 +32,7 @@ versions of the documentation contain the release notes for any later releases. .. toctree:: :maxdepth: 1 + 5.1.4 5.1.3 5.1.2 5.1.1 From 5fa4ccab7e42e86fa4a0681d21bd1326c9c5eac3 Mon Sep 17 00:00:00 2001 From: Sarah Boyce <42296566+sarahboyce@users.noreply.github.com> Date: Mon, 4 Nov 2024 16:09:55 +0100 Subject: [PATCH 073/132] Refs #26001 -- Handled relationship exact lookups in ModelAdmin.search_fields. --- django/contrib/admin/options.py | 53 +++++++++++++++------------------ tests/admin_changelist/admin.py | 1 + tests/admin_changelist/tests.py | 22 ++++++++++++++ 3 files changed, 47 insertions(+), 29 deletions(-) diff --git a/django/contrib/admin/options.py b/django/contrib/admin/options.py index 78063a134d..69b0cc0373 100644 --- a/django/contrib/admin/options.py +++ b/django/contrib/admin/options.py @@ -1178,17 +1178,17 @@ class ModelAdmin(BaseModelAdmin): # Apply keyword searches. def construct_search(field_name): if field_name.startswith("^"): - return "%s__istartswith" % field_name.removeprefix("^") + return "%s__istartswith" % field_name.removeprefix("^"), None elif field_name.startswith("="): - return "%s__iexact" % field_name.removeprefix("=") + return "%s__iexact" % field_name.removeprefix("="), None elif field_name.startswith("@"): - return "%s__search" % field_name.removeprefix("@") + return "%s__search" % field_name.removeprefix("@"), None # Use field_name if it includes a lookup. opts = queryset.model._meta lookup_fields = field_name.split(LOOKUP_SEP) # Go through the fields, following all relations. prev_field = None - for path_part in lookup_fields: + for i, path_part in enumerate(lookup_fields): if path_part == "pk": path_part = opts.pk.name try: @@ -1196,44 +1196,39 @@ class ModelAdmin(BaseModelAdmin): except FieldDoesNotExist: # Use valid query lookups. if prev_field and prev_field.get_lookup(path_part): - return field_name + if path_part == "exact" and not isinstance( + prev_field, (models.CharField, models.TextField) + ): + field_name_without_exact = "__".join(lookup_fields[:i]) + alias = Cast( + field_name_without_exact, + output_field=models.CharField(), + ) + alias_name = "_".join(lookup_fields[:i]) + return f"{alias_name}_str", alias + else: + return field_name, None else: prev_field = field if hasattr(field, "path_infos"): # Update opts to follow the relation. opts = field.path_infos[-1].to_opts # Otherwise, use the field with icontains. - return "%s__icontains" % field_name + return "%s__icontains" % field_name, None may_have_duplicates = False search_fields = self.get_search_fields(request) if search_fields and search_term: - str_annotations = {} + str_aliases = {} orm_lookups = [] for field in search_fields: - if field.endswith("__exact"): - field_name = field.rsplit("__exact", 1)[0] - try: - field_obj = queryset.model._meta.get_field(field_name) - except FieldDoesNotExist: - lookup = construct_search(field) - orm_lookups.append(lookup) - continue - # Add string cast annotations for non-string exact lookups. - if not isinstance(field_obj, (models.CharField, models.TextField)): - str_annotations[f"{field_name}_str"] = Cast( - field_name, output_field=models.CharField() - ) - orm_lookups.append(f"{field_name}_str__exact") - else: - lookup = construct_search(field) - orm_lookups.append(lookup) - else: - lookup = construct_search(str(field)) - orm_lookups.append(lookup) + lookup, str_alias = construct_search(str(field)) + orm_lookups.append(lookup) + if str_alias: + str_aliases[lookup] = str_alias - if str_annotations: - queryset = queryset.annotate(**str_annotations) + if str_aliases: + queryset = queryset.alias(**str_aliases) term_queries = [] for bit in smart_split(search_term): diff --git a/tests/admin_changelist/admin.py b/tests/admin_changelist/admin.py index d9dc498e84..937beea48f 100644 --- a/tests/admin_changelist/admin.py +++ b/tests/admin_changelist/admin.py @@ -56,6 +56,7 @@ class ChildAdmin(admin.ModelAdmin): class GrandChildAdmin(admin.ModelAdmin): list_display = ["name", "parent__name", "parent__parent__name"] + search_fields = ["parent__name__exact", "parent__age__exact"] site.register(GrandChild, GrandChildAdmin) diff --git a/tests/admin_changelist/tests.py b/tests/admin_changelist/tests.py index a823a72f7d..0be6a54ed4 100644 --- a/tests/admin_changelist/tests.py +++ b/tests/admin_changelist/tests.py @@ -879,6 +879,28 @@ class ChangeListTests(TestCase): cl = model_admin.get_changelist_instance(request) self.assertCountEqual(cl.queryset, expected_result) + def test_search_with_exact_lookup_relationship_field(self): + child = Child.objects.create(name="I am a child", age=11) + grandchild = GrandChild.objects.create(name="I am a grandchild", parent=child) + model_admin = GrandChildAdmin(GrandChild, custom_site) + + request = self.factory.get("/", data={SEARCH_VAR: "'I am a child'"}) + request.user = self.superuser + cl = model_admin.get_changelist_instance(request) + self.assertCountEqual(cl.queryset, [grandchild]) + for search_term, expected_result in [ + ("11", [grandchild]), + ("'I am a child'", [grandchild]), + ("1", []), + ("A", []), + ("random", []), + ]: + request = self.factory.get("/", data={SEARCH_VAR: search_term}) + request.user = self.superuser + with self.subTest(search_term=search_term): + cl = model_admin.get_changelist_instance(request) + self.assertCountEqual(cl.queryset, expected_result) + def test_no_distinct_for_m2m_in_list_filter_without_params(self): """ If a ManyToManyField is in list_filter but isn't in any lookup params, From 72de38239fdc97751e1e4ed245c7073c31bbd28a Mon Sep 17 00:00:00 2001 From: antoliny0919 Date: Tue, 5 Nov 2024 07:59:14 +0900 Subject: [PATCH 074/132] Fixed #35880 -- Removed invalid example in form Field.required docs due to CharField.strip. CharField.strip was introduced in 11cac1bd8ef7546ca32d9969d4348bf412dc6664, and is True by default, meaning the previous example of " " raised a ValidationError. --- docs/ref/forms/fields.txt | 2 -- 1 file changed, 2 deletions(-) diff --git a/docs/ref/forms/fields.txt b/docs/ref/forms/fields.txt index 3871e3e8e1..6051122617 100644 --- a/docs/ref/forms/fields.txt +++ b/docs/ref/forms/fields.txt @@ -65,8 +65,6 @@ an empty value -- either ``None`` or the empty string (``""``) -- then Traceback (most recent call last): ... ValidationError: ['This field is required.'] - >>> f.clean(" ") - ' ' >>> f.clean(0) '0' >>> f.clean(True) From 2bfb1211c0a88e4dd4ccf2220c320a221d7a5043 Mon Sep 17 00:00:00 2001 From: Mariusz Felisiak Date: Tue, 5 Nov 2024 12:14:55 +0100 Subject: [PATCH 075/132] Fixed typo in docs/internals/howto-release-django.txt. --- docs/internals/howto-release-django.txt | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/internals/howto-release-django.txt b/docs/internals/howto-release-django.txt index c0a8ab8ab1..131c60fec8 100644 --- a/docs/internals/howto-release-django.txt +++ b/docs/internals/howto-release-django.txt @@ -624,9 +624,9 @@ need to be done by the releaser. message, add a "refs #XXXX" to the original ticket where the deprecation began if possible. -#. Remove ``.. versionadded::``, ``.. versionadded::``, and ``.. deprecated::`` - annotations in the documentation from two releases ago. For example, in - Django 4.2, notes for 4.0 will be removed. +#. Remove ``.. versionadded::``, ``.. versionchanged::``, and + ``.. deprecated::`` annotations in the documentation from two releases ago. + For example, in Django 4.2, notes for 4.0 will be removed. #. Add the new branch to `Read the Docs `_. Since the automatically From db5980ddd1e739b7348662b07c9d91478d911877 Mon Sep 17 00:00:00 2001 From: Maria Hynes Date: Mon, 4 Nov 2024 08:59:45 +0000 Subject: [PATCH 076/132] Clarified instructions on how to claim a ticket. --- .../contributing/writing-code/submitting-patches.txt | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/docs/internals/contributing/writing-code/submitting-patches.txt b/docs/internals/contributing/writing-code/submitting-patches.txt index 799292e3fd..c3d0e1745f 100644 --- a/docs/internals/contributing/writing-code/submitting-patches.txt +++ b/docs/internals/contributing/writing-code/submitting-patches.txt @@ -47,10 +47,14 @@ and time availability), claim it by following these steps: any activity, it's probably safe to reassign it to yourself. * Log into your account, if you haven't already, by clicking "GitHub Login" - or "DjangoProject Login" in the upper left of the ticket page. + or "DjangoProject Login" in the upper left of the ticket page. Once logged + in, you can then click the "Modify Ticket" button near the bottom of the + page. -* Claim the ticket by clicking the "assign to myself" radio button under - "Action" near the bottom of the page, then click "Submit changes." +* Claim the ticket by clicking the "assign to" radio button in the "Action" + section. Your username will be filled in the text box by default. + +* Finally click the "Submit changes" button at the bottom to save. .. note:: The Django software foundation requests that anyone contributing more than From 5c3b9d04d2fd19c7976a17d80b2bdb5ade62dd57 Mon Sep 17 00:00:00 2001 From: Sarah Boyce <42296566+sarahboyce@users.noreply.github.com> Date: Tue, 5 Nov 2024 12:35:50 +0100 Subject: [PATCH 077/132] Removed definition of JSONObject ArgJoiner class in as_native function. --- django/db/models/functions/comparison.py | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/django/db/models/functions/comparison.py b/django/db/models/functions/comparison.py index d06f0a25a4..c897fc262f 100644 --- a/django/db/models/functions/comparison.py +++ b/django/db/models/functions/comparison.py @@ -160,16 +160,15 @@ class JSONObject(Func): ) return super().as_sql(compiler, connection, **extra_context) - def as_native(self, compiler, connection, *, returning, **extra_context): - class ArgJoiner: - def join(self, args): - pairs = zip(args[::2], args[1::2], strict=True) - return ", ".join([" VALUE ".join(pair) for pair in pairs]) + def join(self, args): + pairs = zip(args[::2], args[1::2], strict=True) + return ", ".join([" VALUE ".join(pair) for pair in pairs]) + def as_native(self, compiler, connection, *, returning, **extra_context): return self.as_sql( compiler, connection, - arg_joiner=ArgJoiner(), + arg_joiner=self, template=f"%(function)s(%(expressions)s RETURNING {returning})", **extra_context, ) From 18b3a9dd395278232354a4f2507660a4f849c6eb Mon Sep 17 00:00:00 2001 From: antoliny0919 Date: Wed, 6 Nov 2024 18:47:54 +0900 Subject: [PATCH 078/132] Fixed #35889 -- Corrected reference of default widgets in "Styling widget instance" docs. --- docs/ref/forms/widgets.txt | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/ref/forms/widgets.txt b/docs/ref/forms/widgets.txt index dd2ba0ac4c..38647aa1c2 100644 --- a/docs/ref/forms/widgets.txt +++ b/docs/ref/forms/widgets.txt @@ -142,9 +142,9 @@ For example, take the following form:: url = forms.URLField() comment = forms.CharField() -This form will include three default :class:`TextInput` widgets, with default -rendering -- no CSS class, no extra attributes. This means that the input boxes -provided for each widget will be rendered exactly the same: +This form will include :class:`TextInput` widgets for the name and comment +fields, and a :class:`URLInput` widget for the url field. Each has default +rendering - no CSS class, no extra attributes: .. code-block:: pycon @@ -154,11 +154,11 @@ provided for each widget will be rendered exactly the same:
    Url:
    Comment:
    -On a real web page, you probably don't want every widget to look the same. You -might want a larger input element for the comment, and you might want the -'name' widget to have some special CSS class. It is also possible to specify -the 'type' attribute to take advantage of the new HTML5 input types. To do -this, you use the :attr:`Widget.attrs` argument when creating the widget:: +On a real web page, you probably want to customize this. You might want a +larger input element for the comment, and you might want the 'name' widget to +have some special CSS class. It is also possible to specify the 'type' +attribute to use a different HTML5 input type. To do this, you use the +:attr:`Widget.attrs` argument when creating the widget:: class CommentForm(forms.Form): name = forms.CharField(widget=forms.TextInput(attrs={"class": "special"})) From 78c9a2703151432f8e35cb63fca5a566fee5f8ed Mon Sep 17 00:00:00 2001 From: John Parton Date: Thu, 26 Sep 2024 10:52:12 -0500 Subject: [PATCH 079/132] Fixed #35778 -- Used JSON_OBJECT database function on PostgreSQL 16+ with server-side bindings. --- django/db/models/functions/comparison.py | 41 +++++++++++++----------- 1 file changed, 23 insertions(+), 18 deletions(-) diff --git a/django/db/models/functions/comparison.py b/django/db/models/functions/comparison.py index c897fc262f..76ef5d219b 100644 --- a/django/db/models/functions/comparison.py +++ b/django/db/models/functions/comparison.py @@ -162,7 +162,8 @@ class JSONObject(Func): def join(self, args): pairs = zip(args[::2], args[1::2], strict=True) - return ", ".join([" VALUE ".join(pair) for pair in pairs]) + # Wrap 'key' in parentheses in case of postgres cast :: syntax. + return ", ".join([f"({key}) VALUE {value}" for key, value in pairs]) def as_native(self, compiler, connection, *, returning, **extra_context): return self.as_sql( @@ -174,24 +175,28 @@ class JSONObject(Func): ) def as_postgresql(self, compiler, connection, **extra_context): - if ( - not connection.features.is_postgresql_16 - or connection.features.uses_server_side_binding - ): - copy = self.copy() - copy.set_source_expressions( - [ - Cast(expression, TextField()) if index % 2 == 0 else expression - for index, expression in enumerate(copy.get_source_expressions()) - ] + # Casting keys to text is only required when using JSONB_BUILD_OBJECT + # or when using JSON_OBJECT on PostgreSQL 16+ with server-side bindings. + # This is done in all cases for consistency. + copy = self.copy() + copy.set_source_expressions( + [ + Cast(expression, TextField()) if index % 2 == 0 else expression + for index, expression in enumerate(copy.get_source_expressions()) + ] + ) + + if connection.features.is_postgresql_16: + return copy.as_native( + compiler, connection, returning="JSONB", **extra_context ) - return super(JSONObject, copy).as_sql( - compiler, - connection, - function="JSONB_BUILD_OBJECT", - **extra_context, - ) - return self.as_native(compiler, connection, returning="JSONB", **extra_context) + + return super(JSONObject, copy).as_sql( + compiler, + connection, + function="JSONB_BUILD_OBJECT", + **extra_context, + ) def as_oracle(self, compiler, connection, **extra_context): return self.as_native(compiler, connection, returning="CLOB", **extra_context) From c2c544cf01107da158cb8c0c539555eafa0628db Mon Sep 17 00:00:00 2001 From: sai-ganesh-03 Date: Sun, 3 Nov 2024 11:03:48 +0530 Subject: [PATCH 080/132] Fixed #27409 -- Made admindocs support custom link text in docstrings. --- django/contrib/admindocs/utils.py | 20 ++++++++++++++++++-- docs/ref/contrib/admin/admindocs.txt | 9 +++++++++ docs/releases/5.2.txt | 5 ++++- tests/admin_docs/models.py | 10 ++++++++++ tests/admin_docs/test_views.py | 19 +++++++++++++++++++ 5 files changed, 60 insertions(+), 3 deletions(-) diff --git a/django/contrib/admindocs/utils.py b/django/contrib/admindocs/utils.py index 3a7ca4e781..5b28a8d2c6 100644 --- a/django/contrib/admindocs/utils.py +++ b/django/contrib/admindocs/utils.py @@ -99,6 +99,21 @@ ROLES = { "tag": "%s/tags/#%s", } +explicit_title_re = re.compile(r"^(.+?)\s*(?$", re.DOTALL) + + +def split_explicit_title(text): + """ + Split role content into title and target, if given. + + From sphinx.util.nodes.split_explicit_title + See https://github.com/sphinx-doc/sphinx/blob/230ccf2/sphinx/util/nodes.py#L389 + """ + match = explicit_title_re.match(text) + if match: + return True, match.group(1), match.group(2) + return False, text, text + def create_reference_role(rolename, urlbase): # Views and template names are case-sensitive. @@ -107,14 +122,15 @@ def create_reference_role(rolename, urlbase): def _role(name, rawtext, text, lineno, inliner, options=None, content=None): if options is None: options = {} + _, title, target = split_explicit_title(text) node = docutils.nodes.reference( rawtext, - text, + title, refuri=( urlbase % ( inliner.document.settings.link_base, - text if is_case_sensitive else text.lower(), + target if is_case_sensitive else target.lower(), ) ), **options, diff --git a/docs/ref/contrib/admin/admindocs.txt b/docs/ref/contrib/admin/admindocs.txt index edc29b4a5c..240def8efb 100644 --- a/docs/ref/contrib/admin/admindocs.txt +++ b/docs/ref/contrib/admin/admindocs.txt @@ -31,6 +31,8 @@ Once those steps are complete, you can start browsing the documentation by going to your admin interface and clicking the "Documentation" link in the upper right of the page. +.. _admindocs-helpers: + Documentation helpers ===================== @@ -47,6 +49,13 @@ Template filters ``:filter:`filtername``` Templates ``:template:`path/to/template.html``` ================= ======================= +Each of these support custom link text with the format +``:role:`link text ```. For example, ``:tag:`block ```. + +.. versionchanged:: 5.2 + + Support for custom link text was added. + Model reference =============== diff --git a/docs/releases/5.2.txt b/docs/releases/5.2.txt index 8327de7405..d07e9cb098 100644 --- a/docs/releases/5.2.txt +++ b/docs/releases/5.2.txt @@ -44,7 +44,10 @@ Minor features :mod:`django.contrib.admindocs` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -* ... +* Links to components in docstrings now supports custom link text, using the + format ``:role:`link text ```. See :ref:`documentation helpers + ` for more details. + :mod:`django.contrib.auth` ~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/tests/admin_docs/models.py b/tests/admin_docs/models.py index b4ef84caba..4b52b4a4ea 100644 --- a/tests/admin_docs/models.py +++ b/tests/admin_docs/models.py @@ -15,6 +15,16 @@ class Group(models.Model): class Family(models.Model): + """ + Links with different link text. + + This is a line with tag :tag:`extends ` + This is a line with model :model:`Family ` + This is a line with view :view:`Index ` + This is a line with template :template:`index template ` + This is a line with filter :filter:`example filter ` + """ + last_name = models.CharField(max_length=200) diff --git a/tests/admin_docs/test_views.py b/tests/admin_docs/test_views.py index c48a89a1b0..f7232a7e03 100644 --- a/tests/admin_docs/test_views.py +++ b/tests/admin_docs/test_views.py @@ -441,6 +441,25 @@ class TestModelDetailView(TestDataMixin, AdminDocsTestCase): self.assertContains(self.response, body, html=True) self.assertContains(self.response, model_body, html=True) + def test_model_docstring_built_in_tag_links(self): + summary = "Links with different link text." + body = ( + '

    This is a line with tag extends\n' + 'This is a line with model Family\n' + 'This is a line with view Index\n' + 'This is a line with template index template\n' + 'This is a line with filter example filter

    ' + ) + url = reverse("django-admindocs-models-detail", args=["admin_docs", "family"]) + response = self.client.get(url) + self.assertContains(response, summary, html=True) + self.assertContains(response, body, html=True) + def test_model_detail_title(self): self.assertContains(self.response, "

    admin_docs.Person

    ", html=True) From c4c076223eb73553d3bc8fbc11be2c529d9aea6b Mon Sep 17 00:00:00 2001 From: ssanger Date: Sat, 2 Nov 2024 10:52:14 -0700 Subject: [PATCH 081/132] Fixed #35863 -- Replaced bold text with heading level 3 in new contributors docs. This improves accessibility for screen reader users, see WCAG SC 1.3.1 Info and Relationships: https://www.w3.org/WAI/WCAG22/Understanding/info-and-relationships.html --- .../contributing/new-contributors.txt | 186 +++++++++--------- 1 file changed, 98 insertions(+), 88 deletions(-) diff --git a/docs/internals/contributing/new-contributors.txt b/docs/internals/contributing/new-contributors.txt index 8e81031b32..c728abccd6 100644 --- a/docs/internals/contributing/new-contributors.txt +++ b/docs/internals/contributing/new-contributors.txt @@ -21,53 +21,55 @@ First steps Start with these steps to discover Django's development process. -* **Triage tickets** +Triage tickets +-------------- - If an `unreviewed ticket`_ reports a bug, try and reproduce it. If you - can reproduce it and it seems valid, make a note that you confirmed the bug - and accept the ticket. Make sure the ticket is filed under the correct - component area. Consider writing a patch that adds a test for the bug's - behavior, even if you don't fix the bug itself. See more at - :ref:`how-can-i-help-with-triaging` +If an `unreviewed ticket`_ reports a bug, try and reproduce it. If you can +reproduce it and it seems valid, make a note that you confirmed the bug and +accept the ticket. Make sure the ticket is filed under the correct component +area. Consider writing a patch that adds a test for the bug's behavior, even if +you don't fix the bug itself. See more at :ref:`how-can-i-help-with-triaging` -* **Look for tickets that are accepted and review patches to build familiarity - with the codebase and the process** +Review patches of accepted tickets +---------------------------------- - Mark the appropriate flags if a patch needs docs or tests. Look through the - changes a patch makes, and keep an eye out for syntax that is incompatible - with older but still supported versions of Python. :doc:`Run the tests - ` and make sure they pass. - Where possible and relevant, try them out on a database other than SQLite. - Leave comments and feedback! +This will help you build familiarity with the codebase and processes. Mark the +appropriate flags if a patch needs docs or tests. Look through the changes a +patch makes, and keep an eye out for syntax that is incompatible with older but +still supported versions of Python. :doc:`Run the tests +` and make sure they pass. +Where possible and relevant, try them out on a database other than SQLite. +Leave comments and feedback! -* **Keep old patches up to date** +Keep old patches up-to-date +--------------------------- - Oftentimes the codebase will change between a patch being submitted and the - time it gets reviewed. Make sure it still applies cleanly and functions as - expected. Updating a patch is both useful and important! See more on - :doc:`writing-code/submitting-patches`. +Oftentimes the codebase will change between a patch being submitted and the +time it gets reviewed. Make sure it still applies cleanly and functions as +expected. Updating a patch is both useful and important! See more on +:doc:`writing-code/submitting-patches`. -* **Write some documentation** +Write some documentation +------------------------ - Django's documentation is great but it can always be improved. Did you find - a typo? Do you think that something should be clarified? Go ahead and - suggest a documentation patch! See also the guide on - :doc:`writing-documentation`. +Django's documentation is great but it can always be improved. Did you find a +typo? Do you think that something should be clarified? Go ahead and suggest a +documentation patch! See also the guide on :doc:`writing-documentation`. - .. note:: +.. note:: - The `reports page`_ contains links to many useful Trac queries, including - several that are useful for triaging tickets and reviewing patches as - suggested above. + The `reports page`_ contains links to many useful Trac queries, including + several that are useful for triaging tickets and reviewing patches as + suggested above. - .. _reports page: https://code.djangoproject.com/wiki/Reports + .. _reports page: https://code.djangoproject.com/wiki/Reports -* **Sign the Contributor License Agreement** +Sign the Contributor License Agreement +-------------------------------------- - The code that you write belongs to you or your employer. If your - contribution is more than one or two lines of code, you need to sign the - `CLA`_. See the `Contributor License Agreement FAQ`_ for a more thorough - explanation. +The code that you write belongs to you or your employer. If your contribution +is more than one or two lines of code, you need to sign the `CLA`_. See the +`Contributor License Agreement FAQ`_ for a more thorough explanation. .. _CLA: https://www.djangoproject.com/foundation/cla/ .. _Contributor License Agreement FAQ: https://www.djangoproject.com/foundation/cla/faq/ @@ -80,78 +82,86 @@ Guidelines As a newcomer on a large project, it's easy to experience frustration. Here's some advice to make your work on Django more useful and rewarding. -* **Pick a subject area that you care about, that you are familiar with, or - that you want to learn about** +Pick a subject area +------------------- - You don't already have to be an expert on the area you want to work on; you - become an expert through your ongoing contributions to the code. +This should be something that you care about, that you are familiar with or +that you want to learn about. You don't already have to be an expert on the +area you want to work on; you become an expert through your ongoing +contributions to the code. -* **Analyze tickets' context and history** +Analyze tickets' context and history +------------------------------------ - Trac isn't an absolute; the context is just as important as the words. - When reading Trac, you need to take into account who says things, and when - they were said. Support for an idea two years ago doesn't necessarily mean - that the idea will still have support. You also need to pay attention to who - *hasn't* spoken -- for example, if an experienced contributor hasn't been - recently involved in a discussion, then a ticket may not have the support - required to get into Django. +Trac isn't an absolute; the context is just as important as the words. When +reading Trac, you need to take into account who says things, and when they were +said. Support for an idea two years ago doesn't necessarily mean that the idea +will still have support. You also need to pay attention to who *hasn't* spoken +-- for example, if an experienced contributor hasn't been recently involved in +a discussion, then a ticket may not have the support required to get into +Django. -* **Start small** +Start small +----------- - It's easier to get feedback on a little issue than on a big one. See the - `easy pickings`_. +It's easier to get feedback on a little issue than on a big one. See the +`easy pickings`_. -* **If you're going to engage in a big task, make sure that your idea has - support first** +Confirm support before engaging in a big task +--------------------------------------------- - This means getting someone else to confirm that a bug is real before you fix - the issue, and ensuring that there's consensus on a proposed feature before - you go implementing it. +This means getting someone else to confirm that a bug is real before you fix +the issue, and ensuring that there's consensus on a proposed feature before you +go implementing it. -* **Be bold! Leave feedback!** +Be bold! Leave feedback! +------------------------ - Sometimes it can be scary to put your opinion out to the world and say "this - ticket is correct" or "this patch needs work", but it's the only way the - project moves forward. The contributions of the broad Django community - ultimately have a much greater impact than that of any one person. We can't - do it without **you**! +Sometimes it can be scary to put your opinion out to the world and say "this +ticket is correct" or "this patch needs work", but it's the only way the +project moves forward. The contributions of the broad Django community +ultimately have a much greater impact than that of any one person. We can't do +it without **you**! -* **Err on the side of caution when marking things Ready For Check-in** +Be cautious when marking things "Ready For Check-in" +---------------------------------------------------- - If you're really not certain if a ticket is ready, don't mark it as - such. Leave a comment instead, letting others know your thoughts. If you're - mostly certain, but not completely certain, you might also try asking on IRC - to see if someone else can confirm your suspicions. +If you're really not certain if a ticket is ready, don't mark it as such. Leave +a comment instead, letting others know your thoughts. If you're mostly certain, +but not completely certain, you might also try asking on IRC to see if someone +else can confirm your suspicions. -* **Wait for feedback, and respond to feedback that you receive** +Wait for feedback, and respond to feedback that you receive +----------------------------------------------------------- - Focus on one or two tickets, see them through from start to finish, and - repeat. The shotgun approach of taking on lots of tickets and letting some - fall by the wayside ends up doing more harm than good. +Focus on one or two tickets, see them through from start to finish, and repeat. +The shotgun approach of taking on lots of tickets and letting some fall by the +wayside ends up doing more harm than good. -* **Be rigorous** +Be rigorous +----------- - When we say ":pep:`8`, and must have docs and tests", we mean it. If a patch - doesn't have docs and tests, there had better be a good reason. Arguments - like "I couldn't find any existing tests of this feature" don't carry much - weight--while it may be true, that means you have the extra-important job of - writing the very first tests for that feature, not that you get a pass from - writing tests altogether. +When we say ":pep:`8`, and must have docs and tests", we mean it. If a patch +doesn't have docs and tests, there had better be a good reason. Arguments like +"I couldn't find any existing tests of this feature" don't carry much weight. +While it may be true, that means you have the extra-important job of writing +the very first tests for that feature, not that you get a pass from writing +tests altogether. -* **Be patient** +Be patient +---------- - It's not always easy for your ticket or your patch to be reviewed quickly. - This isn't personal. There are a lot of tickets and pull requests to get - through. +It's not always easy for your ticket or your patch to be reviewed quickly. This +isn't personal. There are a lot of tickets and pull requests to get through. - Keeping your patch up to date is important. Review the ticket on Trac to - ensure that the *Needs tests*, *Needs documentation*, and *Patch needs - improvement* flags are unchecked once you've addressed all review comments. +Keeping your patch up to date is important. Review the ticket on Trac to ensure +that the *Needs tests*, *Needs documentation*, and *Patch needs improvement* +flags are unchecked once you've addressed all review comments. - Remember that Django has an eight-month release cycle, so there's plenty of - time for your patch to be reviewed. +Remember that Django has an eight-month release cycle, so there's plenty of +time for your patch to be reviewed. - Finally, a well-timed reminder can help. See :ref:`contributing code FAQ - ` for ideas here. +Finally, a well-timed reminder can help. See :ref:`contributing code FAQ +` for ideas here. .. _easy pickings: https://code.djangoproject.com/query?status=!closed&easy=1 From 41da8a4f5a55c11fb28d2a172a7ad2cff53ca9ec Mon Sep 17 00:00:00 2001 From: David Winiecki Date: Wed, 16 Oct 2024 15:40:01 -0700 Subject: [PATCH 082/132] Refs #35849 -- Added a handle_event hook to ParallelTestSuite. --- django/test/runner.py | 17 ++++++++++------- 1 file changed, 10 insertions(+), 7 deletions(-) diff --git a/django/test/runner.py b/django/test/runner.py index 27eb9613e9..3912273b61 100644 --- a/django/test/runner.py +++ b/django/test/runner.py @@ -547,18 +547,21 @@ class ParallelTestSuite(unittest.TestSuite): tests = list(self.subsuites[subsuite_index]) for event in events: - event_name = event[0] - handler = getattr(result, event_name, None) - if handler is None: - continue - test = tests[event[1]] - args = event[2:] - handler(test, *args) + self.handle_event(result, tests, event) pool.join() return result + def handle_event(self, result, tests, event): + event_name = event[0] + handler = getattr(result, event_name, None) + if handler is None: + return + test = tests[event[1]] + args = event[2:] + handler(test, *args) + def __iter__(self): return iter(self.subsuites) From 661dfdd59809f4abd5077f7a2529735d07b98ba4 Mon Sep 17 00:00:00 2001 From: David Winiecki Date: Wed, 16 Oct 2024 15:40:26 -0700 Subject: [PATCH 083/132] Fixed #35849 -- Made ParallelTestSuite report correct error location. --- AUTHORS | 1 + django/test/runner.py | 26 +++++- tests/test_runner/test_parallel.py | 140 +++++++++++++++++++++++++++-- 3 files changed, 158 insertions(+), 9 deletions(-) diff --git a/AUTHORS b/AUTHORS index 573a030ea1..1fe38b5666 100644 --- a/AUTHORS +++ b/AUTHORS @@ -282,6 +282,7 @@ answer newbie questions, and generally made Django that much better: David Sanders David Schein David Tulig + David Winiecki David Winterbottom David Wobrock Davide Ceretti diff --git a/django/test/runner.py b/django/test/runner.py index 3912273b61..a52c52fe21 100644 --- a/django/test/runner.py +++ b/django/test/runner.py @@ -12,6 +12,7 @@ import random import sys import textwrap import unittest +import unittest.suite from collections import defaultdict from contextlib import contextmanager from importlib import import_module @@ -292,7 +293,15 @@ failure and get a correct traceback. def addError(self, test, err): self.check_picklable(test, err) - self.events.append(("addError", self.test_index, err)) + + event_occurred_before_first_test = self.test_index == -1 + if event_occurred_before_first_test and isinstance( + test, unittest.suite._ErrorHolder + ): + self.events.append(("addError", self.test_index, test.id(), err)) + else: + self.events.append(("addError", self.test_index, err)) + super().addError(test, err) def addFailure(self, test, err): @@ -558,8 +567,19 @@ class ParallelTestSuite(unittest.TestSuite): handler = getattr(result, event_name, None) if handler is None: return - test = tests[event[1]] - args = event[2:] + test_index = event[1] + event_occurred_before_first_test = test_index == -1 + if ( + event_name == "addError" + and event_occurred_before_first_test + and len(event) >= 4 + ): + test_id = event[2] + test = unittest.suite._ErrorHolder(test_id) + args = event[3:] + else: + test = tests[test_index] + args = event[2:] handler(test, *args) def __iter__(self): diff --git a/tests/test_runner/test_parallel.py b/tests/test_runner/test_parallel.py index 73ef480cc1..318472e478 100644 --- a/tests/test_runner/test_parallel.py +++ b/tests/test_runner/test_parallel.py @@ -1,9 +1,12 @@ import pickle import sys import unittest +from unittest.case import TestCase +from unittest.result import TestResult +from unittest.suite import TestSuite, _ErrorHolder from django.test import SimpleTestCase -from django.test.runner import RemoteTestResult +from django.test.runner import ParallelTestSuite, RemoteTestResult from django.utils.version import PY311, PY312 try: @@ -59,6 +62,18 @@ class SampleFailingSubtest(SimpleTestCase): self.fail("expected failure") +class SampleErrorTest(SimpleTestCase): + @classmethod + def setUpClass(cls): + raise ValueError("woops") + super().setUpClass() + + # This method name doesn't begin with "test" to prevent test discovery + # from seeing it. + def dummy_test(self): + raise AssertionError("SampleErrorTest.dummy_test() was called") + + class RemoteTestResultTest(SimpleTestCase): def _test_error_exc_info(self): try: @@ -72,29 +87,70 @@ class RemoteTestResultTest(SimpleTestCase): def test_was_successful_one_success(self): result = RemoteTestResult() - result.addSuccess(None) + test = None + result.startTest(test) + try: + result.addSuccess(test) + finally: + result.stopTest(test) self.assertIs(result.wasSuccessful(), True) def test_was_successful_one_expected_failure(self): result = RemoteTestResult() - result.addExpectedFailure(None, self._test_error_exc_info()) + test = None + result.startTest(test) + try: + result.addExpectedFailure(test, self._test_error_exc_info()) + finally: + result.stopTest(test) self.assertIs(result.wasSuccessful(), True) def test_was_successful_one_skip(self): result = RemoteTestResult() - result.addSkip(None, "Skipped") + test = None + result.startTest(test) + try: + result.addSkip(test, "Skipped") + finally: + result.stopTest(test) self.assertIs(result.wasSuccessful(), True) @unittest.skipUnless(tblib is not None, "requires tblib to be installed") def test_was_successful_one_error(self): result = RemoteTestResult() - result.addError(None, self._test_error_exc_info()) + test = None + result.startTest(test) + try: + result.addError(test, self._test_error_exc_info()) + finally: + result.stopTest(test) self.assertIs(result.wasSuccessful(), False) @unittest.skipUnless(tblib is not None, "requires tblib to be installed") def test_was_successful_one_failure(self): result = RemoteTestResult() - result.addFailure(None, self._test_error_exc_info()) + test = None + result.startTest(test) + try: + result.addFailure(test, self._test_error_exc_info()) + finally: + result.stopTest(test) + self.assertIs(result.wasSuccessful(), False) + + @unittest.skipUnless(tblib is not None, "requires tblib to be installed") + def test_add_error_before_first_test(self): + result = RemoteTestResult() + test_id = "test_foo (tests.test_foo.FooTest.test_foo)" + test = _ErrorHolder(test_id) + # Call addError() without a call to startTest(). + result.addError(test, self._test_error_exc_info()) + + (event,) = result.events + self.assertEqual(event[0], "addError") + self.assertEqual(event[1], -1) + self.assertEqual(event[2], test_id) + (error_type, _, _) = event[3] + self.assertEqual(error_type, ValueError) self.assertIs(result.wasSuccessful(), False) def test_picklable(self): @@ -161,3 +217,75 @@ class RemoteTestResultTest(SimpleTestCase): result = RemoteTestResult() result.addDuration(None, 2.3) self.assertEqual(result.collectedDurations, [("None", 2.3)]) + + +class ParallelTestSuiteTest(SimpleTestCase): + def test_handle_add_error_before_first_test(self): + dummy_subsuites = [] + pts = ParallelTestSuite(dummy_subsuites, processes=2) + result = TestResult() + remote_result = RemoteTestResult() + test = SampleErrorTest(methodName="dummy_test") + suite = TestSuite([test]) + suite.run(remote_result) + for event in remote_result.events: + pts.handle_event(result, tests=list(suite), event=event) + + self.assertEqual(len(result.errors), 1) + actual_test, tb_and_details_str = result.errors[0] + self.assertIsInstance(actual_test, _ErrorHolder) + self.assertEqual( + actual_test.id(), "setUpClass (test_runner.test_parallel.SampleErrorTest)" + ) + self.assertIn("Traceback (most recent call last):", tb_and_details_str) + self.assertIn("ValueError: woops", tb_and_details_str) + + def test_handle_add_error_during_test(self): + dummy_subsuites = [] + pts = ParallelTestSuite(dummy_subsuites, processes=2) + result = TestResult() + test = TestCase() + err = _test_error_exc_info() + event = ("addError", 0, err) + pts.handle_event(result, tests=[test], event=event) + + self.assertEqual(len(result.errors), 1) + actual_test, tb_and_details_str = result.errors[0] + self.assertIsInstance(actual_test, TestCase) + self.assertEqual(actual_test.id(), "unittest.case.TestCase.runTest") + self.assertIn("Traceback (most recent call last):", tb_and_details_str) + self.assertIn("ValueError: woops", tb_and_details_str) + + def test_handle_add_failure(self): + dummy_subsuites = [] + pts = ParallelTestSuite(dummy_subsuites, processes=2) + result = TestResult() + test = TestCase() + err = _test_error_exc_info() + event = ("addFailure", 0, err) + pts.handle_event(result, tests=[test], event=event) + + self.assertEqual(len(result.failures), 1) + actual_test, tb_and_details_str = result.failures[0] + self.assertIsInstance(actual_test, TestCase) + self.assertEqual(actual_test.id(), "unittest.case.TestCase.runTest") + self.assertIn("Traceback (most recent call last):", tb_and_details_str) + self.assertIn("ValueError: woops", tb_and_details_str) + + def test_handle_add_success(self): + dummy_subsuites = [] + pts = ParallelTestSuite(dummy_subsuites, processes=2) + result = TestResult() + test = TestCase() + event = ("addSuccess", 0) + pts.handle_event(result, tests=[test], event=event) + + self.assertEqual(len(result.errors), 0) + self.assertEqual(len(result.failures), 0) + + +def _test_error_exc_info(): + try: + raise ValueError("woops") + except ValueError: + return sys.exc_info() From 042b381e2e37c0c37b8a8f6cc9947f1a2ebfa0dd Mon Sep 17 00:00:00 2001 From: John Parton Date: Tue, 5 Nov 2024 11:05:13 -0600 Subject: [PATCH 084/132] Refs #23968 -- Removed unnecessary list comprehension in contrib.admin.helpers. --- django/contrib/admin/helpers.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/django/contrib/admin/helpers.py b/django/contrib/admin/helpers.py index d28a382814..51450d1d9e 100644 --- a/django/contrib/admin/helpers.py +++ b/django/contrib/admin/helpers.py @@ -121,7 +121,7 @@ class Fieldset: @cached_property def is_collapsible(self): - if any([field in self.fields for field in self.form.errors]): + if any(field in self.fields for field in self.form.errors): return False return "collapse" in self.classes From 40bfd7b09aa0907b143e96f0b055538f476e544e Mon Sep 17 00:00:00 2001 From: Jacob Rief Date: Wed, 30 Oct 2024 17:04:46 +0100 Subject: [PATCH 085/132] Fixed #35011, Refs #28900 -- Added tests for QuerySet.union() with multiple models and DateTimeField annotations. Ticket was resolved by 65ad4ade74dc9208b9d686a451cd6045df0c9c3a as part of #28900. --- tests/queries/test_qs_combinators.py | 38 +++++++++++++++++++++++++++- 1 file changed, 37 insertions(+), 1 deletion(-) diff --git a/tests/queries/test_qs_combinators.py b/tests/queries/test_qs_combinators.py index 2f6e93cde8..ba44b5ed87 100644 --- a/tests/queries/test_qs_combinators.py +++ b/tests/queries/test_qs_combinators.py @@ -1,7 +1,9 @@ import operator +from datetime import datetime from django.db import DatabaseError, NotSupportedError, connection from django.db.models import ( + DateTimeField, Exists, F, IntegerField, @@ -10,12 +12,13 @@ from django.db.models import ( Transform, Value, ) -from django.db.models.functions import Mod +from django.db.models.functions import Cast, Mod from django.test import TestCase, skipIfDBFeature, skipUnlessDBFeature from django.test.utils import CaptureQueriesContext from .models import ( Annotation, + Article, Author, Celebrity, ExtraInfo, @@ -440,6 +443,39 @@ class QuerySetSetOperationTests(TestCase): [("c1", -10, "cb"), ("rn1", 10, "rn")], ) + def test_union_multiple_models_with_values_list_and_datetime_annotations(self): + gen_x = datetime(1966, 6, 6) + Article.objects.create(name="Bellatrix", created=gen_x) + column_names = ["name", "created", "order"] + qs1 = Article.objects.annotate(order=Value(1)).values_list(*column_names) + + gen_y = datetime(1991, 10, 10) + ReservedName.objects.create(name="Rigel", order=2) + qs2 = ReservedName.objects.annotate( + created=Cast(Value(gen_y), DateTimeField()) + ).values_list(*column_names) + + expected_result = [("Bellatrix", gen_x, 1), ("Rigel", gen_y, 2)] + self.assertEqual(list(qs1.union(qs2).order_by("order")), expected_result) + + def test_union_multiple_models_with_values_and_datetime_annotations(self): + gen_x = datetime(1966, 6, 6) + Article.objects.create(name="Bellatrix", created=gen_x) + column_names = ["name", "created", "order"] + qs1 = Article.objects.values(*column_names, order=Value(1)) + + gen_y = datetime(1991, 10, 10) + ReservedName.objects.create(name="Rigel", order=2) + qs2 = ReservedName.objects.values( + *column_names, created=Cast(Value(gen_y), DateTimeField()) + ) + + expected_result = [ + {"name": "Bellatrix", "created": gen_x, "order": 1}, + {"name": "Rigel", "created": gen_y, "order": 2}, + ] + self.assertEqual(list(qs1.union(qs2).order_by("order")), expected_result) + def test_union_in_subquery(self): ReservedName.objects.bulk_create( [ From ae5743d461ee30c6241c8bb207b98039aaa6255b Mon Sep 17 00:00:00 2001 From: Mariusz Felisiak Date: Mon, 11 Nov 2024 09:44:01 +0100 Subject: [PATCH 086/132] Fixed typo in django/db/backends/sqlite3/features.py. --- django/db/backends/sqlite3/features.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/django/db/backends/sqlite3/features.py b/django/db/backends/sqlite3/features.py index 669e875b59..2c1aa32506 100644 --- a/django/db/backends/sqlite3/features.py +++ b/django/db/backends/sqlite3/features.py @@ -101,7 +101,7 @@ class DatabaseFeatures(BaseDatabaseFeatures): "servers.tests.LiveServerTestCloseConnectionTest." "test_closes_connections", }, - "For SQLite in-memory tests, closing the connection destroys" + "For SQLite in-memory tests, closing the connection destroys " "the database.": { "test_utils.tests.AssertNumQueriesUponConnectionTests." "test_ignores_connection_configuration_queries", From 46eb256ccedcac6b1f6bc957461506d881d468fb Mon Sep 17 00:00:00 2001 From: Mariusz Felisiak Date: Sat, 9 Nov 2024 20:00:37 +0100 Subject: [PATCH 087/132] Refs #32365 -- Removed pytz from list of test dependencies in unit test docs. Follow up to e6f82438d4e3750e8d299bfd79dac98eebe9f1e0. --- docs/internals/contributing/writing-code/unit-tests.txt | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/internals/contributing/writing-code/unit-tests.txt b/docs/internals/contributing/writing-code/unit-tests.txt index 3641bfb8cc..76f4a9e754 100644 --- a/docs/internals/contributing/writing-code/unit-tests.txt +++ b/docs/internals/contributing/writing-code/unit-tests.txt @@ -322,7 +322,6 @@ dependencies: * :pypi:`numpy` * :pypi:`Pillow` 6.2.1+ * :pypi:`PyYAML` -* :pypi:`pytz` (required) * :pypi:`pywatchman` * :pypi:`redis` 3.4+ * :pypi:`setuptools` From 398cec434bc9359529fea141d22742d71ed25d41 Mon Sep 17 00:00:00 2001 From: Mariusz Felisiak Date: Fri, 8 Nov 2024 22:02:50 +0100 Subject: [PATCH 088/132] Refs #35849 -- Skipped ParallelTestSuiteTest.test_handle_add_error_before_first_test() without tblib. Follow up to 661dfdd59809f4abd5077f7a2529735d07b98ba4. --- tests/test_runner/test_parallel.py | 1 + 1 file changed, 1 insertion(+) diff --git a/tests/test_runner/test_parallel.py b/tests/test_runner/test_parallel.py index 318472e478..99352318c1 100644 --- a/tests/test_runner/test_parallel.py +++ b/tests/test_runner/test_parallel.py @@ -220,6 +220,7 @@ class RemoteTestResultTest(SimpleTestCase): class ParallelTestSuiteTest(SimpleTestCase): + @unittest.skipUnless(tblib is not None, "requires tblib to be installed") def test_handle_add_error_before_first_test(self): dummy_subsuites = [] pts = ParallelTestSuite(dummy_subsuites, processes=2) From 2bc43ccbdb28b9d87da172ef119ff3b48e6ff71a Mon Sep 17 00:00:00 2001 From: Mariusz Felisiak Date: Fri, 8 Nov 2024 22:06:29 +0100 Subject: [PATCH 089/132] Removed redundant RemoteTestResultTest._test_error_exc_info() test hook. --- tests/test_runner/test_parallel.py | 28 +++++++++++----------------- 1 file changed, 11 insertions(+), 17 deletions(-) diff --git a/tests/test_runner/test_parallel.py b/tests/test_runner/test_parallel.py index 99352318c1..5026bc36c5 100644 --- a/tests/test_runner/test_parallel.py +++ b/tests/test_runner/test_parallel.py @@ -15,6 +15,13 @@ except ImportError: tblib = None +def _test_error_exc_info(): + try: + raise ValueError("woops") + except ValueError: + return sys.exc_info() + + class ExceptionThatFailsUnpickling(Exception): """ After pickling, this class fails unpickling with an error about incorrect @@ -75,12 +82,6 @@ class SampleErrorTest(SimpleTestCase): class RemoteTestResultTest(SimpleTestCase): - def _test_error_exc_info(self): - try: - raise ValueError("woops") - except ValueError: - return sys.exc_info() - def test_was_successful_no_events(self): result = RemoteTestResult() self.assertIs(result.wasSuccessful(), True) @@ -100,7 +101,7 @@ class RemoteTestResultTest(SimpleTestCase): test = None result.startTest(test) try: - result.addExpectedFailure(test, self._test_error_exc_info()) + result.addExpectedFailure(test, _test_error_exc_info()) finally: result.stopTest(test) self.assertIs(result.wasSuccessful(), True) @@ -121,7 +122,7 @@ class RemoteTestResultTest(SimpleTestCase): test = None result.startTest(test) try: - result.addError(test, self._test_error_exc_info()) + result.addError(test, _test_error_exc_info()) finally: result.stopTest(test) self.assertIs(result.wasSuccessful(), False) @@ -132,7 +133,7 @@ class RemoteTestResultTest(SimpleTestCase): test = None result.startTest(test) try: - result.addFailure(test, self._test_error_exc_info()) + result.addFailure(test, _test_error_exc_info()) finally: result.stopTest(test) self.assertIs(result.wasSuccessful(), False) @@ -143,7 +144,7 @@ class RemoteTestResultTest(SimpleTestCase): test_id = "test_foo (tests.test_foo.FooTest.test_foo)" test = _ErrorHolder(test_id) # Call addError() without a call to startTest(). - result.addError(test, self._test_error_exc_info()) + result.addError(test, _test_error_exc_info()) (event,) = result.events self.assertEqual(event[0], "addError") @@ -283,10 +284,3 @@ class ParallelTestSuiteTest(SimpleTestCase): self.assertEqual(len(result.errors), 0) self.assertEqual(len(result.failures), 0) - - -def _test_error_exc_info(): - try: - raise ValueError("woops") - except ValueError: - return sys.exc_info() From fdca036827b7059c9915680da490ef3520f720fc Mon Sep 17 00:00:00 2001 From: yatami38 Date: Sun, 3 Nov 2024 05:46:27 +0900 Subject: [PATCH 090/132] Fixed a typo in some tests. --- tests/test_client_regress/tests.py | 2 +- tests/test_utils/tests.py | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/tests/test_client_regress/tests.py b/tests/test_client_regress/tests.py index 4d47fb63af..b8efdca4f2 100644 --- a/tests/test_client_regress/tests.py +++ b/tests/test_client_regress/tests.py @@ -198,7 +198,7 @@ class AssertContainsTests(SimpleTestCase): long_content = ( b"This is a very very very very very very very very long message which " - b"exceedes the max limit of truncation." + b"exceeds the max limit of truncation." ) response = HttpResponse(long_content) msg = f"Couldn't find 'thrice' in the following response\n{long_content}" diff --git a/tests/test_utils/tests.py b/tests/test_utils/tests.py index 4fd9267429..359cf07402 100644 --- a/tests/test_utils/tests.py +++ b/tests/test_utils/tests.py @@ -1046,7 +1046,7 @@ class InHTMLTests(SimpleTestCase): def test_long_haystack(self): haystack = ( "

    This is a very very very very very very very very long message which " - "exceedes the max limit of truncation.

    " + "exceeds the max limit of truncation.

    " ) msg = f"Couldn't find 'Hello' in the following response\n{haystack!r}" with self.assertRaisesMessage(AssertionError, msg): From 54774e790d461d94653a4a83a7f5cc456e6d246a Mon Sep 17 00:00:00 2001 From: Adam Zapletal Date: Fri, 1 Nov 2024 14:32:57 -0500 Subject: [PATCH 091/132] Updated BRIN index links in contrib.postgres indexes docs. --- docs/ref/contrib/postgres/indexes.txt | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/ref/contrib/postgres/indexes.txt b/docs/ref/contrib/postgres/indexes.txt index 73ef195309..107d9c278d 100644 --- a/docs/ref/contrib/postgres/indexes.txt +++ b/docs/ref/contrib/postgres/indexes.txt @@ -34,14 +34,14 @@ available from the ``django.contrib.postgres.indexes`` module. .. class:: BrinIndex(*expressions, autosummarize=None, pages_per_range=None, **options) Creates a `BRIN index - `_. + `_. Set the ``autosummarize`` parameter to ``True`` to enable `automatic summarization`_ to be performed by autovacuum. The ``pages_per_range`` argument takes a positive integer. - .. _automatic summarization: https://www.postgresql.org/docs/current/brin-intro.html#BRIN-OPERATION + .. _automatic summarization: https://www.postgresql.org/docs/current/brin.html#BRIN-OPERATION ``BTreeIndex`` ============== From 63dbe30d3363715deaf280214d75b03f6d65a571 Mon Sep 17 00:00:00 2001 From: antoliny0919 Date: Thu, 7 Nov 2024 09:39:29 +0900 Subject: [PATCH 092/132] Updated validate_slug regular expression in form validation docs. Outdated since 014247ad1922931a2f17beaf6249247298e9dc44. --- docs/ref/forms/validation.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/ref/forms/validation.txt b/docs/ref/forms/validation.txt index 7a037eaf75..614b345b5a 100644 --- a/docs/ref/forms/validation.txt +++ b/docs/ref/forms/validation.txt @@ -254,7 +254,7 @@ Common cases such as validating against an email or a regular expression can be handled using existing validator classes available in Django. For example, ``validators.validate_slug`` is an instance of a :class:`~django.core.validators.RegexValidator` constructed with the first -argument being the pattern: ``^[-a-zA-Z0-9_]+$``. See the section on +argument being the pattern: ``^[-a-zA-Z0-9_]+\Z``. See the section on :doc:`writing validators ` to see a list of what is already available and for an example of how to write a validator. From c4614b53d355561d426b0fed903e96c3c198e10d Mon Sep 17 00:00:00 2001 From: Tim Graham Date: Tue, 8 Oct 2024 20:25:48 -0400 Subject: [PATCH 093/132] Fixed #35815 -- Made system check accept db_default literals when DatabaseFeatures.supports_expression_defaults = False. --- django/db/models/fields/__init__.py | 5 ++++- .../test_ordinary_fields.py | 17 +++++++++++++++++ 2 files changed, 21 insertions(+), 1 deletion(-) diff --git a/django/db/models/fields/__init__.py b/django/db/models/fields/__init__.py index d1f31f0211..f9cafdb4bb 100644 --- a/django/db/models/fields/__init__.py +++ b/django/db/models/fields/__init__.py @@ -392,7 +392,10 @@ class Field(RegisterLookupMixin): if ( self.db_default is NOT_PROVIDED - or isinstance(self.db_default, Value) + or ( + isinstance(self.db_default, Value) + or not hasattr(self.db_default, "resolve_expression") + ) or databases is None ): return [] diff --git a/tests/invalid_models_tests/test_ordinary_fields.py b/tests/invalid_models_tests/test_ordinary_fields.py index e30d411138..1fcf3f708d 100644 --- a/tests/invalid_models_tests/test_ordinary_fields.py +++ b/tests/invalid_models_tests/test_ordinary_fields.py @@ -1207,6 +1207,23 @@ class InvalidDBDefaultTests(TestCase): expected_error = Error(msg=msg, obj=field, id="fields.E012") self.assertEqual(errors, [expected_error]) + def test_literals_not_treated_as_expressions(self): + """ + DatabaseFeatures.supports_expression_defaults = False shouldn't + prevent non-expression literals (integer, float, boolean, etc.) from + being used as database defaults. + """ + + class Model(models.Model): + field = models.FloatField(db_default=1.0) + + field = Model._meta.get_field("field") + with unittest.mock.patch.object( + connection.features, "supports_expression_defaults", False + ): + errors = field.check(databases=self.databases) + self.assertEqual(errors, []) + @isolate_apps("invalid_models_tests") class GeneratedFieldTests(TestCase): From ef8ae06c2acd7b3673fee15b379213169153c7b0 Mon Sep 17 00:00:00 2001 From: Tim Graham Date: Thu, 17 Oct 2024 14:38:05 -0400 Subject: [PATCH 094/132] Fixed #35903 -- Made admin's "view on site" URL accept non-integer ContentType pks. --- django/contrib/admin/sites.py | 2 +- tests/admin_views/tests.py | 13 +++++++++++++ 2 files changed, 14 insertions(+), 1 deletion(-) diff --git a/django/contrib/admin/sites.py b/django/contrib/admin/sites.py index dc67262afc..3399bd87b8 100644 --- a/django/contrib/admin/sites.py +++ b/django/contrib/admin/sites.py @@ -282,7 +282,7 @@ class AdminSite: path("autocomplete/", wrap(self.autocomplete_view), name="autocomplete"), path("jsi18n/", wrap(self.i18n_javascript, cacheable=True), name="jsi18n"), path( - "r///", + "r///", wrap(contenttype_views.shortcut), name="view_on_site", ), diff --git a/tests/admin_views/tests.py b/tests/admin_views/tests.py index c5d8b8f4f6..3f106f6814 100644 --- a/tests/admin_views/tests.py +++ b/tests/admin_views/tests.py @@ -8664,6 +8664,19 @@ class AdminViewOnSiteTests(TestCase): ), ) + def test_view_on_site_url_non_integer_ids(self): + """The view_on_site URL accepts non-integer ids.""" + self.assertEqual( + reverse( + "admin:view_on_site", + kwargs={ + "content_type_id": "37156b6a-8a82", + "object_id": "37156b6a-8a83", + }, + ), + "/test_admin/admin/r/37156b6a-8a82/37156b6a-8a83/", + ) + @override_settings(ROOT_URLCONF="admin_views.urls") class InlineAdminViewOnSiteTest(TestCase): From c12bc980e5b2bb25e447cd8dee550cad767f1ad2 Mon Sep 17 00:00:00 2001 From: sai-ganesh-03 Date: Thu, 7 Nov 2024 16:01:14 +0530 Subject: [PATCH 095/132] Fixed #17905 -- Restricted access to model pages in admindocs. Only users with view or change model permissions can access. Thank you to Sarah Boyce for the review. --- django/contrib/admindocs/views.py | 24 +++++- docs/ref/contrib/admin/admindocs.txt | 16 +++- docs/releases/5.2.txt | 4 +- tests/admin_docs/test_views.py | 106 +++++++++++++++++++++++++++ 4 files changed, 143 insertions(+), 7 deletions(-) diff --git a/django/contrib/admindocs/views.py b/django/contrib/admindocs/views.py index 3fdb34e0d1..0c4ece29fe 100644 --- a/django/contrib/admindocs/views.py +++ b/django/contrib/admindocs/views.py @@ -13,7 +13,12 @@ from django.contrib.admindocs.utils import ( replace_named_groups, replace_unnamed_groups, ) -from django.core.exceptions import ImproperlyConfigured, ViewDoesNotExist +from django.contrib.auth import get_permission_codename +from django.core.exceptions import ( + ImproperlyConfigured, + PermissionDenied, + ViewDoesNotExist, +) from django.db import models from django.http import Http404 from django.template.engine import Engine @@ -202,11 +207,24 @@ class ViewDetailView(BaseAdminDocsView): ) +def user_has_model_view_permission(user, opts): + """Based off ModelAdmin.has_view_permission.""" + codename_view = get_permission_codename("view", opts) + codename_change = get_permission_codename("change", opts) + return user.has_perm("%s.%s" % (opts.app_label, codename_view)) or user.has_perm( + "%s.%s" % (opts.app_label, codename_change) + ) + + class ModelIndexView(BaseAdminDocsView): template_name = "admin_doc/model_index.html" def get_context_data(self, **kwargs): - m_list = [m._meta for m in apps.get_models()] + m_list = [ + m._meta + for m in apps.get_models() + if user_has_model_view_permission(self.request.user, m._meta) + ] return super().get_context_data(**{**kwargs, "models": m_list}) @@ -228,6 +246,8 @@ class ModelDetailView(BaseAdminDocsView): ) opts = model._meta + if not user_has_model_view_permission(self.request.user, opts): + raise PermissionDenied title, body, metadata = utils.parse_docstring(model.__doc__) title = title and utils.parse_rst(title, "model", _("model:") + model_name) diff --git a/docs/ref/contrib/admin/admindocs.txt b/docs/ref/contrib/admin/admindocs.txt index 240def8efb..5a605748ad 100644 --- a/docs/ref/contrib/admin/admindocs.txt +++ b/docs/ref/contrib/admin/admindocs.txt @@ -56,13 +56,16 @@ Each of these support custom link text with the format Support for custom link text was added. +.. _admindocs-model-reference: + Model reference =============== -The **models** section of the ``admindocs`` page describes each model in the -system along with all the fields, properties, and methods available on it. -Relationships to other models appear as hyperlinks. Descriptions are pulled -from ``help_text`` attributes on fields or from docstrings on model methods. +The **models** section of the ``admindocs`` page describes each model that the +user has access to along with all the fields, properties, and methods available +on it. Relationships to other models appear as hyperlinks. Descriptions are +pulled from ``help_text`` attributes on fields or from docstrings on model +methods. A model with useful documentation might look like this:: @@ -86,6 +89,11 @@ A model with useful documentation might look like this:: """Makes the blog entry live on the site.""" ... +.. versionchanged:: 5.2 + + Access was restricted to only allow users with model view or change + permissions. + View reference ============== diff --git a/docs/releases/5.2.txt b/docs/releases/5.2.txt index d07e9cb098..88a1daa45d 100644 --- a/docs/releases/5.2.txt +++ b/docs/releases/5.2.txt @@ -47,7 +47,9 @@ Minor features * Links to components in docstrings now supports custom link text, using the format ``:role:`link text ```. See :ref:`documentation helpers ` for more details. - + +* The :ref:`model pages ` are now restricted to only + allow access to users with the corresponding model view or change permissions. :mod:`django.contrib.auth` ~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/tests/admin_docs/test_views.py b/tests/admin_docs/test_views.py index f7232a7e03..11b70d6cd9 100644 --- a/tests/admin_docs/test_views.py +++ b/tests/admin_docs/test_views.py @@ -5,6 +5,8 @@ from django.conf import settings from django.contrib import admin from django.contrib.admindocs import utils, views from django.contrib.admindocs.views import get_return_data_type, simplify_regex +from django.contrib.auth.models import Permission, User +from django.contrib.contenttypes.models import ContentType from django.contrib.sites.models import Site from django.db import models from django.db.models import fields @@ -482,6 +484,110 @@ class TestModelDetailView(TestDataMixin, AdminDocsTestCase): ) self.assertEqual(response.status_code, 404) + def test_model_permission_denied(self): + person_url = reverse( + "django-admindocs-models-detail", args=["admin_docs", "person"] + ) + company_url = reverse( + "django-admindocs-models-detail", args=["admin_docs", "company"] + ) + staff_user = User.objects.create_user( + username="staff", password="secret", is_staff=True + ) + self.client.force_login(staff_user) + response_for_person = self.client.get(person_url) + response_for_company = self.client.get(company_url) + # No access without permissions. + self.assertEqual(response_for_person.status_code, 403) + self.assertEqual(response_for_company.status_code, 403) + company_content_type = ContentType.objects.get_for_model(Company) + person_content_type = ContentType.objects.get_for_model(Person) + view_company = Permission.objects.get( + codename="view_company", content_type=company_content_type + ) + change_person = Permission.objects.get( + codename="change_person", content_type=person_content_type + ) + staff_user.user_permissions.add(view_company, change_person) + response_for_person = self.client.get(person_url) + response_for_company = self.client.get(company_url) + # View or change permission grants access. + self.assertEqual(response_for_person.status_code, 200) + self.assertEqual(response_for_company.status_code, 200) + + +@unittest.skipUnless(utils.docutils_is_available, "no docutils installed.") +class TestModelIndexView(TestDataMixin, AdminDocsTestCase): + def test_model_index_superuser(self): + self.client.force_login(self.superuser) + index_url = reverse("django-admindocs-models-index") + response = self.client.get(index_url) + self.assertContains( + response, + 'Family', + html=True, + ) + self.assertContains( + response, + 'Person', + html=True, + ) + self.assertContains( + response, + 'Company', + html=True, + ) + + def test_model_index_with_model_permission(self): + staff_user = User.objects.create_user( + username="staff", password="secret", is_staff=True + ) + self.client.force_login(staff_user) + index_url = reverse("django-admindocs-models-index") + response = self.client.get(index_url) + # Models are not listed without permissions. + self.assertNotContains( + response, + 'Family', + html=True, + ) + self.assertNotContains( + response, + 'Person', + html=True, + ) + self.assertNotContains( + response, + 'Company', + html=True, + ) + company_content_type = ContentType.objects.get_for_model(Company) + person_content_type = ContentType.objects.get_for_model(Person) + view_company = Permission.objects.get( + codename="view_company", content_type=company_content_type + ) + change_person = Permission.objects.get( + codename="change_person", content_type=person_content_type + ) + staff_user.user_permissions.add(view_company, change_person) + response = self.client.get(index_url) + # View or change permission grants access. + self.assertNotContains( + response, + 'Family', + html=True, + ) + self.assertContains( + response, + 'Person', + html=True, + ) + self.assertContains( + response, + 'Company', + html=True, + ) + class CustomField(models.Field): description = "A custom field type" From b9aa3239ab1328c915684d89b87a49459cabd30b Mon Sep 17 00:00:00 2001 From: Adam Zapletal Date: Sat, 9 Nov 2024 21:20:22 -0600 Subject: [PATCH 096/132] Refs #21286 -- Fixed YAML serialization of TimeField primary key. Handling for PyYAML not being able to serialize `datetime.time` values is moved from `handle_field` to `_value_from_field` as only non-primary key, non-relation fields are passed into `handle_field`. --- django/core/serializers/pyyaml.py | 12 ++++++------ tests/serializers/models/data.py | 5 +++-- tests/serializers/test_data.py | 3 ++- 3 files changed, 11 insertions(+), 9 deletions(-) diff --git a/django/core/serializers/pyyaml.py b/django/core/serializers/pyyaml.py index ed6e4b3895..c72d1fa03b 100644 --- a/django/core/serializers/pyyaml.py +++ b/django/core/serializers/pyyaml.py @@ -5,6 +5,7 @@ Requires PyYaml (https://pyyaml.org/), but that's checked for in __init__. """ import collections +import datetime import decimal import yaml @@ -12,7 +13,6 @@ import yaml from django.core.serializers.base import DeserializationError from django.core.serializers.python import Deserializer as PythonDeserializer from django.core.serializers.python import Serializer as PythonSerializer -from django.db import models # Use the C (faster) implementation if possible try: @@ -44,17 +44,17 @@ class Serializer(PythonSerializer): internal_use_only = False - def handle_field(self, obj, field): + def _value_from_field(self, obj, field): # A nasty special case: base YAML doesn't support serialization of time # types (as opposed to dates or datetimes, which it does support). Since # we want to use the "safe" serializer for better interoperability, we # need to do something with those pesky times. Converting 'em to strings # isn't perfect, but it's better than a "!!python/time" type which would # halt deserialization under any other language. - if isinstance(field, models.TimeField) and getattr(obj, field.name) is not None: - self._current[field.name] = str(getattr(obj, field.name)) - else: - super().handle_field(obj, field) + value = super()._value_from_field(obj, field) + if isinstance(value, datetime.time): + value = str(value) + return value def end_serialization(self): self.options.setdefault("allow_unicode", True) diff --git a/tests/serializers/models/data.py b/tests/serializers/models/data.py index 212ea0e06f..bb76bfba48 100644 --- a/tests/serializers/models/data.py +++ b/tests/serializers/models/data.py @@ -245,8 +245,9 @@ class SmallPKData(models.Model): # class TextPKData(models.Model): # data = models.TextField(primary_key=True) -# class TimePKData(models.Model): -# data = models.TimeField(primary_key=True) + +class TimePKData(models.Model): + data = models.TimeField(primary_key=True) class UUIDData(models.Model): diff --git a/tests/serializers/test_data.py b/tests/serializers/test_data.py index 33ea3458de..1f8f38ba0f 100644 --- a/tests/serializers/test_data.py +++ b/tests/serializers/test_data.py @@ -69,6 +69,7 @@ from .models import ( Tag, TextData, TimeData, + TimePKData, UniqueAnchor, UUIDData, UUIDDefaultData, @@ -390,7 +391,7 @@ The end.""", # It contains line breaks. # Several of them. # The end."""), - # (pk_obj, 770, TimePKData, datetime.time(10, 42, 37)), + (pk_obj, 770, TimePKData, datetime.time(10, 42, 37)), (pk_obj, 791, UUIDData, uuid_obj), (fk_obj, 792, FKToUUID, uuid_obj), (pk_obj, 793, UUIDDefaultData, uuid_obj), From 299b072498b23d1d7fe9f1545f7b27b73ca8e22b Mon Sep 17 00:00:00 2001 From: Clifford Gama <53076065+cliff688@users.noreply.github.com> Date: Wed, 13 Nov 2024 20:14:16 +0200 Subject: [PATCH 097/132] Fixed #35843 -- Clarified formset docs about reordering forms. --- docs/topics/forms/formsets.txt | 11 ++++------- 1 file changed, 4 insertions(+), 7 deletions(-) diff --git a/docs/topics/forms/formsets.txt b/docs/topics/forms/formsets.txt index 1f49044e6e..3b68ed614c 100644 --- a/docs/topics/forms/formsets.txt +++ b/docs/topics/forms/formsets.txt @@ -48,13 +48,10 @@ following example will create a formset class to display two blank forms: >>> ArticleFormSet = formset_factory(ArticleForm, extra=2) -Iterating over a formset will render the forms in the order they were -created. You can change this order by providing an alternate implementation for -the ``__iter__()`` method. - -Formsets can also be indexed into, which returns the corresponding form. If you -override ``__iter__``, you will need to also override ``__getitem__`` to have -matching behavior. +Formsets can be iterated and indexed, accessing forms in the order they were +created. You can reorder the forms by overriding the default +:py:meth:`iteration ` and +:py:meth:`indexing ` behavior if needed. .. _formsets-initial-data: From 56ffd9f20a98a486b817b0d1dc5ccbe6a557a965 Mon Sep 17 00:00:00 2001 From: Laurence Mercer Date: Wed, 13 Nov 2024 19:28:34 +0000 Subject: [PATCH 098/132] Fixed a typo in docs/howto/static-files/deployment.txt. --- docs/howto/static-files/deployment.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/howto/static-files/deployment.txt b/docs/howto/static-files/deployment.txt index d6d1158249..19b7c9df82 100644 --- a/docs/howto/static-files/deployment.txt +++ b/docs/howto/static-files/deployment.txt @@ -15,7 +15,7 @@ Serving static files in production The basic outline of putting static files into production consists of two steps: run the :djadmin:`collectstatic` command when static files change, then arrange for the collected static files directory (:setting:`STATIC_ROOT`) to be -moved to the static file server and served. Depending the ``staticfiles`` +moved to the static file server and served. Depending on the ``staticfiles`` :setting:`STORAGES` alias, files may need to be moved to a new location manually or the :func:`post_process ` method of From 7e759d9af714b4db6735f7e53f62a5933a6260b8 Mon Sep 17 00:00:00 2001 From: Maria Hynes Date: Wed, 13 Nov 2024 19:55:01 +0000 Subject: [PATCH 099/132] Fixed #17430 -- Documented access to the Django admin when using a custom auth backend. --- docs/topics/auth/customizing.txt | 18 +++++++++++------- 1 file changed, 11 insertions(+), 7 deletions(-) diff --git a/docs/topics/auth/customizing.txt b/docs/topics/auth/customizing.txt index 6fdcd136c0..4874f199f6 100644 --- a/docs/topics/auth/customizing.txt +++ b/docs/topics/auth/customizing.txt @@ -127,15 +127,19 @@ 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 -`. 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. +`. For example, for a user to access the admin, +:attr:`.User.is_staff` and :attr:`.User.is_active` must be ``True`` (see +:meth:`.AdminSite.has_permission` for details). + +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:: +object the first time a user authenticates. In this example, the created Django +``User`` object is a superuser who will have full access to the admin:: from django.conf import settings from django.contrib.auth.backends import BaseBackend @@ -162,7 +166,7 @@ object the first time a user authenticates:: 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 = User(username=username) # is_active defaults to True. user.is_staff = True user.is_superuser = True user.save() From da2432cccae841f0d7629f17a5d79ec47ed7b7cb Mon Sep 17 00:00:00 2001 From: AfiMaameDufie Date: Tue, 12 Nov 2024 21:33:39 +0000 Subject: [PATCH 100/132] Replaced message suggestions from IRC to Discord in contributing docs. --- docs/faq/contributing.txt | 6 ++++-- docs/internals/contributing/index.txt | 1 - docs/internals/contributing/new-contributors.txt | 7 +++++-- 3 files changed, 9 insertions(+), 5 deletions(-) diff --git a/docs/faq/contributing.txt b/docs/faq/contributing.txt index 71a6a7a476..d281ce8b75 100644 --- a/docs/faq/contributing.txt +++ b/docs/faq/contributing.txt @@ -53,8 +53,8 @@ To determine the right time, you need to keep an eye on the schedule. If you post your message right before a release deadline, you're not likely to get the sort of attention you require. -Gentle IRC reminders can also work -- again, strategically timed if possible. -During a bug sprint would be a very good time, for example. +Gentle reminders in the ``#contributing-getting-started`` channel in the +`Django Discord server`_ can work. Another way to get traction is to pull several related tickets together. When someone sits down to review a bug in an area they haven't touched for @@ -68,6 +68,8 @@ issue over and over again. This sort of behavior will not gain you any additional attention -- certainly not the attention that you need in order to get your issue addressed. +.. _`Django Discord server`: https://discord.gg/xcRH6mN4fa + But I've reminded you several times and you keep ignoring my contribution! ========================================================================== diff --git a/docs/internals/contributing/index.txt b/docs/internals/contributing/index.txt index 6e3fd948ee..b547e468b7 100644 --- a/docs/internals/contributing/index.txt +++ b/docs/internals/contributing/index.txt @@ -46,7 +46,6 @@ a great ecosystem to work in: .. _posting guidelines: https://code.djangoproject.com/wiki/UsingTheMailingList .. _#django IRC channel: https://web.libera.chat/#django -.. _#django-dev IRC channel: https://web.libera.chat/#django-dev .. _community page: https://www.djangoproject.com/community/ .. _Django Discord server: https://discord.gg/xcRH6mN4fa .. _Django forum: https://forum.djangoproject.com/ diff --git a/docs/internals/contributing/new-contributors.txt b/docs/internals/contributing/new-contributors.txt index c728abccd6..201fe4afc2 100644 --- a/docs/internals/contributing/new-contributors.txt +++ b/docs/internals/contributing/new-contributors.txt @@ -128,8 +128,11 @@ Be cautious when marking things "Ready For Check-in" If you're really not certain if a ticket is ready, don't mark it as such. Leave a comment instead, letting others know your thoughts. If you're mostly certain, -but not completely certain, you might also try asking on IRC to see if someone -else can confirm your suspicions. +but not completely certain, you might also try asking on the +``#contributing-getting-started`` channel in the `Django Discord server`_ to +see if someone else can confirm your suspicions. + +.. _`Django Discord server`: https://discord.gg/xcRH6mN4fa Wait for feedback, and respond to feedback that you receive ----------------------------------------------------------- From 512a2bad0574a3748cb2f141a761a286a67f0ae9 Mon Sep 17 00:00:00 2001 From: Anthony Joseph Date: Wed, 6 Nov 2024 18:52:48 +1100 Subject: [PATCH 101/132] Removed misleading list of tested OS in GEOS API docs. --- docs/ref/contrib/gis/geos.txt | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/docs/ref/contrib/gis/geos.txt b/docs/ref/contrib/gis/geos.txt index 8b1ae62c2f..b3825e09c4 100644 --- a/docs/ref/contrib/gis/geos.txt +++ b/docs/ref/contrib/gis/geos.txt @@ -34,8 +34,7 @@ features include: may be used outside of a Django project/application. In other words, no need to have :envvar:`DJANGO_SETTINGS_MODULE` set or use a database, etc. * Mutability: :class:`GEOSGeometry` objects may be modified. -* Cross-platform and tested; compatible with Windows, Linux, Solaris, and - macOS platforms. +* Cross-platform tested. .. _geos-tutorial: From 8590d05d44a4f3df56d988229e43d66c37df79da Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Alexander=20Lazarevi=C4=87?= Date: Wed, 13 Nov 2024 09:01:57 +0100 Subject: [PATCH 102/132] Fixed #35887 -- Added imports and admin.site.register to non-partial admin inline doc examples. --- docs/ref/contrib/admin/index.txt | 23 ++++++++++++++++------- docs/topics/db/multi-db.txt | 4 ++++ 2 files changed, 20 insertions(+), 7 deletions(-) diff --git a/docs/ref/contrib/admin/index.txt b/docs/ref/contrib/admin/index.txt index d9e12f0165..1b02b7d403 100644 --- a/docs/ref/contrib/admin/index.txt +++ b/docs/ref/contrib/admin/index.txt @@ -2251,6 +2251,7 @@ information. inlines to a model by specifying them in a ``ModelAdmin.inlines``:: from django.contrib import admin + from myapp.models import Author, Book class BookInline(admin.TabularInline): @@ -2262,6 +2263,9 @@ information. BookInline, ] + + admin.site.register(Author, AuthorAdmin) + Django provides two subclasses of ``InlineModelAdmin`` and they are: * :class:`~django.contrib.admin.TabularInline` @@ -2494,6 +2498,10 @@ Take this model for instance:: from django.db import models + class Person(models.Model): + name = models.CharField(max_length=128) + + class Friendship(models.Model): to_person = models.ForeignKey( Person, on_delete=models.CASCADE, related_name="friends" @@ -2507,7 +2515,7 @@ you need to explicitly define the foreign key since it is unable to do so automatically:: from django.contrib import admin - from myapp.models import Friendship + from myapp.models import Friendship, Person class FriendshipInline(admin.TabularInline): @@ -2520,6 +2528,9 @@ automatically:: FriendshipInline, ] + + admin.site.register(Person, PersonAdmin) + Working with many-to-many models -------------------------------- @@ -2548,24 +2559,22 @@ If you want to display many-to-many relations using an inline, you can do so by defining an ``InlineModelAdmin`` object for the relationship:: from django.contrib import admin + from myapp.models import Group class MembershipInline(admin.TabularInline): model = Group.members.through - class PersonAdmin(admin.ModelAdmin): - inlines = [ - MembershipInline, - ] - - class GroupAdmin(admin.ModelAdmin): inlines = [ MembershipInline, ] exclude = ["members"] + + admin.site.register(Group, GroupAdmin) + There are two features worth noting in this example. Firstly - the ``MembershipInline`` class references ``Group.members.through``. diff --git a/docs/topics/db/multi-db.txt b/docs/topics/db/multi-db.txt index be7e9953fa..11be913f4c 100644 --- a/docs/topics/db/multi-db.txt +++ b/docs/topics/db/multi-db.txt @@ -683,6 +683,10 @@ Once you've written your model admin definitions, they can be registered with any ``Admin`` instance:: from django.contrib import admin + from myapp.models import Author, Book, Publisher + + # Import our custom ModelAdmin and TabularInline from where they're defined. + from myproject.admin import MultiDBModelAdmin, MultiDBTabularInline # Specialize the multi-db admin objects for use with specific models. From 91c879eda595c12477bbfa6f51115e88b75ddf88 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lorenzo=20Pe=C3=B1a?= Date: Thu, 14 Nov 2024 19:53:49 +0100 Subject: [PATCH 103/132] Fixed #35784 -- Added support for preserving the HTTP request method in HttpResponseRedirectBase. Co-authored-by: Natalia <124304+nessita@users.noreply.github.com> --- django/http/response.py | 6 +++++- django/shortcuts.py | 12 ++++++++---- docs/ref/request-response.txt | 18 +++++++++++++++-- docs/releases/5.2.txt | 10 ++++++++++ docs/topics/http/shortcuts.txt | 36 +++++++++++++++++++++++++++++++--- tests/httpwrappers/tests.py | 21 ++++++++++++++++++++ tests/shortcuts/tests.py | 21 ++++++++++++++++++++ 7 files changed, 114 insertions(+), 10 deletions(-) diff --git a/django/http/response.py b/django/http/response.py index 1dbaf46add..4a0ea67013 100644 --- a/django/http/response.py +++ b/django/http/response.py @@ -627,10 +627,12 @@ class FileResponse(StreamingHttpResponse): class HttpResponseRedirectBase(HttpResponse): allowed_schemes = ["http", "https", "ftp"] - def __init__(self, redirect_to, *args, **kwargs): + def __init__(self, redirect_to, preserve_request=False, *args, **kwargs): super().__init__(*args, **kwargs) self["Location"] = iri_to_uri(redirect_to) parsed = urlsplit(str(redirect_to)) + if preserve_request: + self.status_code = self.status_code_preserve_request if parsed.scheme and parsed.scheme not in self.allowed_schemes: raise DisallowedRedirect( "Unsafe redirect to URL with protocol '%s'" % parsed.scheme @@ -652,10 +654,12 @@ class HttpResponseRedirectBase(HttpResponse): class HttpResponseRedirect(HttpResponseRedirectBase): status_code = 302 + status_code_preserve_request = 307 class HttpResponsePermanentRedirect(HttpResponseRedirectBase): status_code = 301 + status_code_preserve_request = 308 class HttpResponseNotModified(HttpResponse): diff --git a/django/shortcuts.py b/django/shortcuts.py index b8b5be1f5f..6274631dba 100644 --- a/django/shortcuts.py +++ b/django/shortcuts.py @@ -26,7 +26,7 @@ def render( return HttpResponse(content, content_type, status) -def redirect(to, *args, permanent=False, **kwargs): +def redirect(to, *args, permanent=False, preserve_request=False, **kwargs): """ Return an HttpResponseRedirect to the appropriate URL for the arguments passed. @@ -40,13 +40,17 @@ def redirect(to, *args, permanent=False, **kwargs): * A URL, which will be used as-is for the redirect location. - Issues a temporary redirect by default; pass permanent=True to issue a - permanent redirect. + Issues a temporary redirect by default. Set permanent=True to issue a + permanent redirect. Set preserve_request=True to instruct the user agent + to preserve the original HTTP method and body when following the redirect. """ redirect_class = ( HttpResponsePermanentRedirect if permanent else HttpResponseRedirect ) - return redirect_class(resolve_url(to, *args, **kwargs)) + return redirect_class( + resolve_url(to, *args, **kwargs), + preserve_request=preserve_request, + ) def _get_queryset(klass): diff --git a/docs/ref/request-response.txt b/docs/ref/request-response.txt index afebd00d8b..26fcb5fa08 100644 --- a/docs/ref/request-response.txt +++ b/docs/ref/request-response.txt @@ -1070,18 +1070,32 @@ types of HTTP responses. Like ``HttpResponse``, these subclasses live in (e.g. ``'https://www.yahoo.com/search/'``), an absolute path with no domain (e.g. ``'/search/'``), or even a relative path (e.g. ``'search/'``). In that last case, the client browser will reconstruct the full URL itself - according to the current path. See :class:`HttpResponse` for other optional - constructor arguments. Note that this returns an HTTP status code 302. + according to the current path. + + The constructor accepts an optional ``preserve_request`` keyword argument + that defaults to ``False``, producing a response with a 302 status code. If + ``preserve_request`` is ``True``, the status code will be 307 instead. + + See :class:`HttpResponse` for other optional constructor arguments. .. attribute:: HttpResponseRedirect.url This read-only attribute represents the URL the response will redirect to (equivalent to the ``Location`` response header). + .. versionchanged:: 5.2 + + The ``preserve_request`` argument was added. + .. class:: HttpResponsePermanentRedirect Like :class:`HttpResponseRedirect`, but it returns a permanent redirect (HTTP status code 301) instead of a "found" redirect (status code 302). + When ``preserve_request=True``, the response's status code is 308. + + .. versionchanged:: 5.2 + + The ``preserve_request`` argument was added. .. class:: HttpResponseNotModified diff --git a/docs/releases/5.2.txt b/docs/releases/5.2.txt index 88a1daa45d..0ee4868246 100644 --- a/docs/releases/5.2.txt +++ b/docs/releases/5.2.txt @@ -294,6 +294,16 @@ Requests and Responses * The new :meth:`.HttpRequest.get_preferred_type` method can be used to query the preferred media type the client accepts. +* The new ``preserve_request`` argument for + :class:`~django.http.HttpResponseRedirect` and + :class:`~django.http.HttpResponsePermanentRedirect` + determines whether the HTTP status codes 302/307 or 301/308 are used, + respectively. + +* The new ``preserve_request`` argument for + :func:`~django.shortcuts.redirect` allows to instruct the user agent to reuse + the HTTP method and body during redirection using specific status codes. + Security ~~~~~~~~ diff --git a/docs/topics/http/shortcuts.txt b/docs/topics/http/shortcuts.txt index 171cfc3c93..308eae0855 100644 --- a/docs/topics/http/shortcuts.txt +++ b/docs/topics/http/shortcuts.txt @@ -91,7 +91,7 @@ This example is equivalent to:: ``redirect()`` ============== -.. function:: redirect(to, *args, permanent=False, **kwargs) +.. function:: redirect(to, *args, permanent=False, preserve_request=False, **kwargs) Returns an :class:`~django.http.HttpResponseRedirect` to the appropriate URL for the arguments passed. @@ -107,8 +107,27 @@ This example is equivalent to:: * An absolute or relative URL, which will be used as-is for the redirect location. - By default issues a temporary redirect; pass ``permanent=True`` to issue a - permanent redirect. + By default, a temporary redirect is issued with a 302 status code. If + ``permanent=True``, a permanent redirect is issued with a 301 status code. + + If ``preserve_request=True``, the response instructs the user agent to + preserve the method and body of the original request when issuing the + redirect. In this case, temporary redirects use a 307 status code, and + permanent redirects use a 308 status code. This is better illustrated in the + following table: + + ========= ================ ================ + permanent preserve_request HTTP status code + ========= ================ ================ + ``True`` ``False`` 301 + ``False`` ``False`` 302 + ``False`` ``True`` 307 + ``True`` ``True`` 308 + ========= ================ ================ + + .. versionchanged:: 5.2 + + The argument ``preserve_request`` was added. Examples -------- @@ -158,6 +177,17 @@ will be returned:: obj = MyModel.objects.get(...) return redirect(obj, permanent=True) +Additionally, the ``preserve_request`` argument can be used to preserve the +original HTTP method:: + + def my_view(request): + # ... + obj = MyModel.objects.get(...) + if request.method in ("POST", "PUT"): + # Redirection preserves the original request method. + return redirect(obj, preserve_request=True) + # ... + ``get_object_or_404()`` ======================= diff --git a/tests/httpwrappers/tests.py b/tests/httpwrappers/tests.py index 3774ff2d67..f85d33e823 100644 --- a/tests/httpwrappers/tests.py +++ b/tests/httpwrappers/tests.py @@ -566,6 +566,27 @@ class HttpResponseSubclassesTests(SimpleTestCase): r = HttpResponseRedirect(lazystr("/redirected/")) self.assertEqual(r.url, "/redirected/") + def test_redirect_modifiers(self): + cases = [ + (HttpResponseRedirect, "Moved temporarily", False, 302), + (HttpResponseRedirect, "Moved temporarily preserve method", True, 307), + (HttpResponsePermanentRedirect, "Moved permanently", False, 301), + ( + HttpResponsePermanentRedirect, + "Moved permanently preserve method", + True, + 308, + ), + ] + for response_class, content, preserve_request, expected_status_code in cases: + with self.subTest(status_code=expected_status_code): + response = response_class( + "/redirected/", content=content, preserve_request=preserve_request + ) + self.assertEqual(response.status_code, expected_status_code) + self.assertEqual(response.content.decode(), content) + self.assertEqual(response.url, response.headers["Location"]) + def test_redirect_repr(self): response = HttpResponseRedirect("/redirected/") expected = ( diff --git a/tests/shortcuts/tests.py b/tests/shortcuts/tests.py index 8e9c13d206..b80b8f5951 100644 --- a/tests/shortcuts/tests.py +++ b/tests/shortcuts/tests.py @@ -1,3 +1,5 @@ +from django.http.response import HttpResponseRedirectBase +from django.shortcuts import redirect from django.test import SimpleTestCase, override_settings from django.test.utils import require_jinja2 @@ -35,3 +37,22 @@ class RenderTests(SimpleTestCase): self.assertEqual(response.content, b"DTL\n") response = self.client.get("/render/using/?using=jinja2") self.assertEqual(response.content, b"Jinja2\n") + + +class RedirectTests(SimpleTestCase): + def test_redirect_response_status_code(self): + tests = [ + (True, False, 301), + (False, False, 302), + (False, True, 307), + (True, True, 308), + ] + for permanent, preserve_request, expected_status_code in tests: + with self.subTest(permanent=permanent, preserve_request=preserve_request): + response = redirect( + "/path/is/irrelevant/", + permanent=permanent, + preserve_request=preserve_request, + ) + self.assertIsInstance(response, HttpResponseRedirectBase) + self.assertEqual(response.status_code, expected_status_code) From 037e740ec56674e69e564b97e1151950757c410d Mon Sep 17 00:00:00 2001 From: GappleBee Date: Mon, 7 Oct 2024 16:09:21 +0200 Subject: [PATCH 104/132] Refs #28215 -- Marked auth form passwords as sensitive variables. --- django/contrib/auth/forms.py | 5 + tests/auth_tests/test_auth_backends.py | 132 ++++++++++++++++++++++++- 2 files changed, 136 insertions(+), 1 deletion(-) diff --git a/django/contrib/auth/forms.py b/django/contrib/auth/forms.py index edf672a6e5..093f525245 100644 --- a/django/contrib/auth/forms.py +++ b/django/contrib/auth/forms.py @@ -15,6 +15,7 @@ from django.utils.http import urlsafe_base64_encode from django.utils.text import capfirst from django.utils.translation import gettext from django.utils.translation import gettext_lazy as _ +from django.views.decorators.debug import sensitive_variables UserModel = get_user_model() logger = logging.getLogger("django.contrib.auth") @@ -122,6 +123,7 @@ class SetPasswordMixin: ) return password1, password2 + @sensitive_variables("password1", "password2") def validate_passwords( self, password1_field_name="password1", @@ -151,6 +153,7 @@ class SetPasswordMixin: ) self.add_error(password2_field_name, error) + @sensitive_variables("password") def validate_password_for_user(self, user, password_field_name="password2"): password = self.cleaned_data.get(password_field_name) if password: @@ -348,6 +351,7 @@ class AuthenticationForm(forms.Form): if self.fields["username"].label is None: self.fields["username"].label = capfirst(self.username_field.verbose_name) + @sensitive_variables() def clean(self): username = self.cleaned_data.get("username") password = self.cleaned_data.get("password") @@ -539,6 +543,7 @@ class PasswordChangeForm(SetPasswordForm): field_order = ["old_password", "new_password1", "new_password2"] + @sensitive_variables("old_password") def clean_old_password(self): """ Validate that the old_password field is correct. diff --git a/tests/auth_tests/test_auth_backends.py b/tests/auth_tests/test_auth_backends.py index b612d27ab0..32fb092cf4 100644 --- a/tests/auth_tests/test_auth_backends.py +++ b/tests/auth_tests/test_auth_backends.py @@ -1,6 +1,7 @@ import sys from datetime import date from unittest import mock +from unittest.mock import patch from asgiref.sync import sync_to_async @@ -14,19 +15,22 @@ from django.contrib.auth import ( signals, ) from django.contrib.auth.backends import BaseBackend, ModelBackend +from django.contrib.auth.forms import PasswordChangeForm, SetPasswordForm from django.contrib.auth.hashers import MD5PasswordHasher from django.contrib.auth.models import AnonymousUser, Group, Permission, User from django.contrib.contenttypes.models import ContentType from django.core.exceptions import ImproperlyConfigured, PermissionDenied from django.http import HttpRequest from django.test import ( + Client, RequestFactory, SimpleTestCase, TestCase, modify_settings, override_settings, ) -from django.views.debug import technical_500_response +from django.urls import reverse +from django.views.debug import ExceptionReporter, technical_500_response from django.views.decorators.debug import sensitive_variables from .models import ( @@ -38,6 +42,16 @@ from .models import ( ) +class FilteredExceptionReporter(ExceptionReporter): + def get_traceback_frames(self): + frames = super().get_traceback_frames() + return [ + frame + for frame in frames + if not isinstance(dict(frame["vars"]).get("self"), Client) + ] + + class SimpleBackend(BaseBackend): def get_user_permissions(self, user_obj, obj=None): return ["user_perm"] @@ -1040,6 +1054,15 @@ class TypeErrorBackend: raise TypeError +class TypeErrorValidator: + """ + Always raises a TypeError. + """ + + def validate(self, password=None, user=None): + raise TypeError + + class SkippedBackend: def authenticate(self): # Doesn't accept any credentials so is skipped by authenticate(). @@ -1127,6 +1150,113 @@ class AuthenticateTests(TestCase): status_code=500, ) + @override_settings( + ROOT_URLCONF="django.contrib.auth.urls", + AUTHENTICATION_BACKENDS=["auth_tests.test_auth_backends.TypeErrorBackend"], + ) + def test_login_process_sensitive_variables(self): + try: + self.client.post( + reverse("login"), + dict(username="testusername", password=self.sensitive_password), + ) + except TypeError: + exc_info = sys.exc_info() + + rf = RequestFactory() + with patch("django.views.debug.ExceptionReporter", FilteredExceptionReporter): + response = technical_500_response(rf.get("/"), *exc_info) + + self.assertNotContains(response, self.sensitive_password, status_code=500) + self.assertContains(response, "TypeErrorBackend", status_code=500) + + # AuthenticationForm.clean(). + self.assertContains( + response, + 'password' + "
    '********************'
    ", + html=True, + status_code=500, + ) + + def test_setpasswordform_validate_passwords_sensitive_variables(self): + password_form = SetPasswordForm(AnonymousUser()) + password_form.cleaned_data = { + "password1": self.sensitive_password, + "password2": self.sensitive_password + "2", + } + try: + password_form.validate_passwords() + except ValueError: + exc_info = sys.exc_info() + + rf = RequestFactory() + response = technical_500_response(rf.get("/"), *exc_info) + self.assertNotContains(response, self.sensitive_password, status_code=500) + self.assertNotContains(response, self.sensitive_password + "2", status_code=500) + + self.assertContains( + response, + 'password1' + "
    '********************'
    ", + html=True, + status_code=500, + ) + + self.assertContains( + response, + 'password2' + "
    '********************'
    ", + html=True, + status_code=500, + ) + + @override_settings( + AUTH_PASSWORD_VALIDATORS=[ + {"NAME": __name__ + ".TypeErrorValidator"}, + ] + ) + def test_setpasswordform_validate_password_for_user_sensitive_variables(self): + password_form = SetPasswordForm(AnonymousUser()) + password_form.cleaned_data = {"password2": self.sensitive_password} + try: + password_form.validate_password_for_user(AnonymousUser()) + except TypeError: + exc_info = sys.exc_info() + + rf = RequestFactory() + response = technical_500_response(rf.get("/"), *exc_info) + self.assertNotContains(response, self.sensitive_password, status_code=500) + + self.assertContains( + response, + 'password' + "
    '********************'
    ", + html=True, + status_code=500, + ) + + def test_passwordchangeform_clean_old_password_sensitive_variables(self): + password_form = PasswordChangeForm(User()) + password_form.cleaned_data = {"old_password": self.sensitive_password} + password_form.error_messages = None + try: + password_form.clean_old_password() + except TypeError: + exc_info = sys.exc_info() + + rf = RequestFactory() + response = technical_500_response(rf.get("/"), *exc_info) + self.assertNotContains(response, self.sensitive_password, status_code=500) + + self.assertContains( + response, + 'old_password' + "
    '********************'
    ", + html=True, + status_code=500, + ) + @override_settings( AUTHENTICATION_BACKENDS=( "auth_tests.test_auth_backends.SkippedBackend", From 2debd018dbc7aba0b98b4c082bbb1fa1d195a47e Mon Sep 17 00:00:00 2001 From: nessita <124304+nessita@users.noreply.github.com> Date: Fri, 15 Nov 2024 23:30:47 -0300 Subject: [PATCH 105/132] Made cosmetic edits to 5.2 release notes, including line wrapping at 79 cols. --- docs/releases/5.2.txt | 41 +++++++++++++++++++---------------------- 1 file changed, 19 insertions(+), 22 deletions(-) diff --git a/docs/releases/5.2.txt b/docs/releases/5.2.txt index 0ee4868246..a977e6c803 100644 --- a/docs/releases/5.2.txt +++ b/docs/releases/5.2.txt @@ -48,8 +48,8 @@ Minor features format ``:role:`link text ```. See :ref:`documentation helpers ` for more details. -* The :ref:`model pages ` are now restricted to only - allow access to users with the corresponding model view or change permissions. +* The :ref:`model pages ` are now restricted to + users with the corresponding view or change permissions. :mod:`django.contrib.auth` ~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -83,8 +83,8 @@ Minor features * Auth backends can now provide async implementations which are used when calling async auth functions (e.g. - :func:`~.django.contrib.auth.aauthenticate`) to reduce context-switching which - improves performance. See :ref:`adding an async interface + :func:`~.django.contrib.auth.aauthenticate`) to reduce context-switching + which improves performance. See :ref:`adding an async interface ` for more details. * The :ref:`password validator classes ` @@ -246,10 +246,9 @@ Logging Management Commands ~~~~~~~~~~~~~~~~~~~ -* A new warning is printed to the console when running :djadmin:`runserver` that - ``runserver`` is unsuitable for production. This warning can be hidden by - setting the :envvar:`HIDE_PRODUCTION_WARNING` environment variable to - ``"true"``. +* A new warning is displayed when running :djadmin:`runserver`, indicating that + it is unsuitable for production. This warning can be suppressed by setting + the :envvar:`HIDE_PRODUCTION_WARNING` environment variable to ``"true"``. * The :djadmin:`makemigrations` and :djadmin:`migrate` commands have a new ``Command.autodetector`` attribute for subclasses to override in order to use @@ -263,13 +262,11 @@ Migrations Models ~~~~~~ -* The ``SELECT`` clause generated when using - :meth:`QuerySet.values()` and - :meth:`~django.db.models.query.QuerySet.values_list` now matches the - specified order of the referenced expressions. Previously the order was based - of a set of counterintuitive rules which made query combination through - methods such as - :meth:`QuerySet.union()` unpredictable. +* The ``SELECT`` clause generated when using :meth:`.QuerySet.values` and + :meth:`.QuerySet.values_list` now matches the specified order of the + referenced expressions. Previously, the order was based of a set of + counterintuitive rules which made query combination through methods such as + :meth:`.QuerySet.union` unpredictable. * Added support for validation of model constraints which use a :class:`~django.db.models.GeneratedField`. @@ -288,8 +285,8 @@ Models Requests and Responses ~~~~~~~~~~~~~~~~~~~~~~ -* The new :attr:`.HttpResponse.text` property provides the string representation - of :attr:`.HttpResponse.content`. +* The new :attr:`.HttpResponse.text` property provides the string + representation of :attr:`.HttpResponse.content`. * The new :meth:`.HttpRequest.get_preferred_type` method can be used to query the preferred media type the client accepts. @@ -396,13 +393,13 @@ Miscellaneous * The minimum supported version of ``gettext`` is increased from 0.15 to 0.19. -* ``HttpRequest.accepted_types`` is now sorted by the client's preference, based - on the request's ``Accept`` header. +* ``HttpRequest.accepted_types`` is now sorted by the client's preference, + based on the request's ``Accept`` header. -* :attr:`.UniqueConstraint.violation_error_code` and +* The attributes :attr:`.UniqueConstraint.violation_error_code` and :attr:`.UniqueConstraint.violation_error_message` are now always used when - provided. Previously, these were ignored when :attr:`.UniqueConstraint.fields` - were set without a :attr:`.UniqueConstraint.condition`. + provided. Previously, they were ignored if :attr:`.UniqueConstraint.fields` + was set without a :attr:`.UniqueConstraint.condition`. * The :func:`~django.template.context_processors.debug` context processor is no longer included in the default project template. From 9609b48b9149aa0b96208588b99ce6161be6a287 Mon Sep 17 00:00:00 2001 From: Ben Cail Date: Thu, 17 Oct 2024 16:32:36 -0400 Subject: [PATCH 106/132] Fixed #18392 -- Changed default mysql encoding to "utf8mb4". --- django/db/backends/mysql/base.py | 2 +- django/db/backends/mysql/features.py | 22 ++++------------------ docs/ref/contrib/auth.txt | 5 +---- docs/ref/databases.txt | 18 +++++++++--------- docs/releases/5.2.txt | 12 +++++++++++- tests/dbshell/test_mysql.py | 4 ++-- 6 files changed, 28 insertions(+), 35 deletions(-) diff --git a/django/db/backends/mysql/base.py b/django/db/backends/mysql/base.py index b8d2d09c94..eb0e361d8d 100644 --- a/django/db/backends/mysql/base.py +++ b/django/db/backends/mysql/base.py @@ -215,7 +215,7 @@ class DatabaseWrapper(BaseDatabaseWrapper): def get_connection_params(self): kwargs = { "conv": django_conversions, - "charset": "utf8", + "charset": "utf8mb4", } settings_dict = self.settings_dict if settings_dict["USER"]: diff --git a/django/db/backends/mysql/features.py b/django/db/backends/mysql/features.py index 21088544ac..414f552d94 100644 --- a/django/db/backends/mysql/features.py +++ b/django/db/backends/mysql/features.py @@ -71,21 +71,11 @@ class DatabaseFeatures(BaseDatabaseFeatures): @cached_property def test_collations(self): - charset = "utf8" - if ( - self.connection.mysql_is_mariadb - and self.connection.mysql_version >= (10, 6) - ) or ( - not self.connection.mysql_is_mariadb - and self.connection.mysql_version >= (8, 0, 30) - ): - # utf8 is an alias for utf8mb3 in MariaDB 10.6+ and MySQL 8.0.30+. - charset = "utf8mb3" return { - "ci": f"{charset}_general_ci", - "non_default": f"{charset}_esperanto_ci", - "swedish_ci": f"{charset}_swedish_ci", - "virtual": f"{charset}_esperanto_ci", + "ci": "utf8mb4_general_ci", + "non_default": "utf8mb4_esperanto_ci", + "swedish_ci": "utf8mb4_swedish_ci", + "virtual": "utf8mb4_esperanto_ci", } test_now_utc_template = "UTC_TIMESTAMP(6)" @@ -99,10 +89,6 @@ class DatabaseFeatures(BaseDatabaseFeatures): "db_functions.comparison.test_least.LeastTests." "test_coalesce_workaround", }, - "Running on MySQL requires utf8mb4 encoding (#18392).": { - "model_fields.test_textfield.TextFieldTests.test_emoji", - "model_fields.test_charfield.TestCharField.test_emoji", - }, "MySQL doesn't support functional indexes on a function that " "returns JSON": { "schema.tests.SchemaTests.test_func_index_json_key_transform", diff --git a/docs/ref/contrib/auth.txt b/docs/ref/contrib/auth.txt index 103aff8e0b..3e1cdfd978 100644 --- a/docs/ref/contrib/auth.txt +++ b/docs/ref/contrib/auth.txt @@ -30,10 +30,7 @@ Fields The ``max_length`` should be sufficient for many use cases. If you need a longer length, please use a :ref:`custom user model - `. If you use MySQL with the ``utf8mb4`` - encoding (recommended for proper Unicode support), specify at most - ``max_length=191`` because MySQL can only create unique indexes with - 191 characters in that case by default. + `. .. attribute:: first_name diff --git a/docs/ref/databases.txt b/docs/ref/databases.txt index 73a67475fe..57e94140c2 100644 --- a/docs/ref/databases.txt +++ b/docs/ref/databases.txt @@ -517,7 +517,7 @@ You can `create your database`_ using the command-line tools and this SQL: .. code-block:: sql - CREATE DATABASE CHARACTER SET utf8; + CREATE DATABASE CHARACTER SET utf8mb4; This ensures all tables and columns will use UTF-8 by default. @@ -542,21 +542,21 @@ Django doesn't provide an API to change them. .. _documented thoroughly: https://dev.mysql.com/doc/refman/en/charset.html By default, with a UTF-8 database, MySQL will use the -``utf8_general_ci`` collation. This results in all string equality +``utf8mb4_0900_ai_ci`` collation. This results in all string equality comparisons being done in a *case-insensitive* manner. That is, ``"Fred"`` and ``"freD"`` are considered equal at the database level. If you have a unique constraint on a field, it would be illegal to try to insert both ``"aa"`` and ``"AA"`` into the same column, since they compare as equal (and, hence, non-unique) with the default collation. If you want case-sensitive comparisons on a particular column or table, change the column or table to use the -``utf8_bin`` collation. +``utf8mb4_0900_as_cs`` collation. Please note that according to `MySQL Unicode Character Sets`_, comparisons for -the ``utf8_general_ci`` collation are faster, but slightly less correct, than -comparisons for ``utf8_unicode_ci``. If this is acceptable for your application, -you should use ``utf8_general_ci`` because it is faster. If this is not acceptable -(for example, if you require German dictionary order), use ``utf8_unicode_ci`` -because it is more accurate. +the ``utf8mb4_general_ci`` collation are faster, but slightly less correct, +than comparisons for ``utf8mb4_unicode_ci``. If this is acceptable for your +application, you should use ``utf8mb4_general_ci`` because it is faster. If +this is not acceptable (for example, if you require German dictionary order), +use ``utf8mb4_unicode_ci`` because it is more accurate. .. _MySQL Unicode Character Sets: https://dev.mysql.com/doc/refman/en/charset-unicode-sets.html @@ -602,7 +602,7 @@ Here's a sample configuration which uses a MySQL option file:: database = NAME user = USER password = PASSWORD - default-character-set = utf8 + default-character-set = utf8mb4 Several other `MySQLdb connection options`_ may be useful, such as ``ssl``, ``init_command``, and ``sql_mode``. diff --git a/docs/releases/5.2.txt b/docs/releases/5.2.txt index a977e6c803..3cc71b7f68 100644 --- a/docs/releases/5.2.txt +++ b/docs/releases/5.2.txt @@ -174,7 +174,9 @@ CSRF Database backends ~~~~~~~~~~~~~~~~~ -* ... +* MySQL connections now default to using the ``utf8mb4`` character set, + instead of ``utf8``, which is an alias for the deprecated character set + ``utf8mb3``. Decorators ~~~~~~~~~~ @@ -385,6 +387,14 @@ Dropped support for PostgreSQL 13 Upstream support for PostgreSQL 13 ends in November 2025. Django 5.2 supports PostgreSQL 14 and higher. +Changed MySQL connection character set default +---------------------------------------------- + +MySQL connections now default to using the ``utf8mb4`` character set, instead +of ``utf8``, which is an alias for the deprecated character set ``utf8mb3``. +``utf8mb3`` can be specified in the ``OPTIONS`` part of the ``DATABASES`` +setting, if needed for legacy databases. + Miscellaneous ------------- diff --git a/tests/dbshell/test_mysql.py b/tests/dbshell/test_mysql.py index 13007ec037..6088a8b61a 100644 --- a/tests/dbshell/test_mysql.py +++ b/tests/dbshell/test_mysql.py @@ -112,7 +112,7 @@ class MySqlDbshellCommandTestCase(SimpleTestCase): "--user=someuser", "--host=somehost", "--port=444", - "--default-character-set=utf8", + "--default-character-set=utf8mb4", "somedbname", ] expected_env = {"MYSQL_PWD": "somepassword"} @@ -124,7 +124,7 @@ class MySqlDbshellCommandTestCase(SimpleTestCase): "PASSWORD": "somepassword", "HOST": "somehost", "PORT": 444, - "OPTIONS": {"charset": "utf8"}, + "OPTIONS": {"charset": "utf8mb4"}, } ), (expected_args, expected_env), From ca113adbae1cc2129256f51ac71e8aed2a381576 Mon Sep 17 00:00:00 2001 From: Caitlin Hogan Date: Sat, 16 Nov 2024 10:40:40 -0800 Subject: [PATCH 107/132] Fixed typo in docs/topics/performance.txt. --- docs/topics/performance.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/topics/performance.txt b/docs/topics/performance.txt index cedd824e30..4e23d1b6bc 100644 --- a/docs/topics/performance.txt +++ b/docs/topics/performance.txt @@ -137,7 +137,7 @@ one that it is comfortable to code for. Firstly, in a real-life case you need to consider what is happening before and after your count to work out what's an optimal way of doing it *in that - particular context*. The database optimization documents describes :ref:`a + particular context*. The database optimization document describes :ref:`a case where counting in the template would be better `. From 3434fab758c5a293c8f376bb5990af6acbf89e32 Mon Sep 17 00:00:00 2001 From: Adam Johnson Date: Mon, 18 Nov 2024 14:41:24 +0100 Subject: [PATCH 108/132] Refs #35882 -- Added test for migration questioner KeyboardInterrupt. --- tests/migrations/test_questioner.py | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/tests/migrations/test_questioner.py b/tests/migrations/test_questioner.py index c1aebcb224..a212fbf65f 100644 --- a/tests/migrations/test_questioner.py +++ b/tests/migrations/test_questioner.py @@ -66,6 +66,11 @@ class QuestionerHelperMethodsTests(SimpleTestCase): self.questioner._ask_default() self.assertIn("Invalid input: ", self.prompt.getvalue()) + @mock.patch("builtins.input", side_effect=[KeyboardInterrupt()]) + def test_questioner_no_default_keyboard_interrupt(self, mock_input): + with self.assertRaises(KeyboardInterrupt): + self.questioner._ask_default() + @mock.patch("builtins.input", side_effect=["", "n"]) def test_questioner_no_default_no_user_entry_boolean(self, mock_input): value = self.questioner._boolean_input("Proceed?") From e035db1bc3bbeb4282a177ad106add3b07d97b09 Mon Sep 17 00:00:00 2001 From: Adam Johnson Date: Mon, 18 Nov 2024 14:39:55 +0100 Subject: [PATCH 109/132] Fixed #35882 -- Made migration questioner loop on all errors. --- django/db/migrations/questioner.py | 4 ++-- tests/migrations/test_questioner.py | 21 +++++++++++++++++++-- 2 files changed, 21 insertions(+), 4 deletions(-) diff --git a/django/db/migrations/questioner.py b/django/db/migrations/questioner.py index e1081ab70a..2e61195581 100644 --- a/django/db/migrations/questioner.py +++ b/django/db/migrations/questioner.py @@ -160,8 +160,8 @@ class InteractiveMigrationQuestioner(MigrationQuestioner): else: try: return eval(code, {}, {"datetime": datetime, "timezone": timezone}) - except (SyntaxError, NameError) as e: - self.prompt_output.write("Invalid input: %s" % e) + except Exception as e: + self.prompt_output.write(f"{e.__class__.__name__}: {e}") def ask_not_null_addition(self, field_name, model_name): """Adding a NOT NULL field to a model.""" diff --git a/tests/migrations/test_questioner.py b/tests/migrations/test_questioner.py index a212fbf65f..ec1013923b 100644 --- a/tests/migrations/test_questioner.py +++ b/tests/migrations/test_questioner.py @@ -61,10 +61,27 @@ class QuestionerHelperMethodsTests(SimpleTestCase): ) @mock.patch("builtins.input", side_effect=["bad code", "exit"]) - def test_questioner_no_default_bad_user_entry_code(self, mock_input): + def test_questioner_no_default_syntax_error(self, mock_input): with self.assertRaises(SystemExit): self.questioner._ask_default() - self.assertIn("Invalid input: ", self.prompt.getvalue()) + self.assertIn("SyntaxError: invalid syntax", self.prompt.getvalue()) + + @mock.patch("builtins.input", side_effect=["datetim", "exit"]) + def test_questioner_no_default_name_error(self, mock_input): + with self.assertRaises(SystemExit): + self.questioner._ask_default() + self.assertIn( + "NameError: name 'datetim' is not defined", self.prompt.getvalue() + ) + + @mock.patch("builtins.input", side_effect=["datetime.dat", "exit"]) + def test_questioner_no_default_attribute_error(self, mock_input): + with self.assertRaises(SystemExit): + self.questioner._ask_default() + self.assertIn( + "AttributeError: module 'datetime' has no attribute 'dat'", + self.prompt.getvalue(), + ) @mock.patch("builtins.input", side_effect=[KeyboardInterrupt()]) def test_questioner_no_default_keyboard_interrupt(self, mock_input): From 8d7b1423f89bcc3df57333fc79fa5aead17b0cbc Mon Sep 17 00:00:00 2001 From: Mariusz Felisiak Date: Sun, 17 Nov 2024 16:07:23 +0100 Subject: [PATCH 110/132] Refs #35844 -- Fixed copying BaseContext and its subclasses on Python 3.14+. super objects are copyable on Python 3.14+: https://github.com/python/cpython/commit/5ca4e34bc1aab8321911aac6d5b2b9e75ff764d8 and can no longer be used in BaseContext.__copy__(). --- django/template/context.py | 4 +++- tests/template_tests/test_context.py | 8 ++++++++ 2 files changed, 11 insertions(+), 1 deletion(-) diff --git a/django/template/context.py b/django/template/context.py index 0c28b479cd..90825fcdb5 100644 --- a/django/template/context.py +++ b/django/template/context.py @@ -37,7 +37,9 @@ class BaseContext: self.dicts.append(value) def __copy__(self): - duplicate = copy(super()) + duplicate = BaseContext() + duplicate.__class__ = self.__class__ + duplicate.__dict__ = copy(self.__dict__) duplicate.dicts = self.dicts[:] return duplicate diff --git a/tests/template_tests/test_context.py b/tests/template_tests/test_context.py index 6d8ee7a6e6..f71cf1ff25 100644 --- a/tests/template_tests/test_context.py +++ b/tests/template_tests/test_context.py @@ -1,3 +1,4 @@ +from copy import copy from unittest import mock from django.http import HttpRequest @@ -314,3 +315,10 @@ class RequestContextTests(SimpleTestCase): with self.assertRaisesMessage(TypeError, msg): with request_context.bind_template(Template("")): pass + + def test_context_copyable(self): + request_context = RequestContext(HttpRequest()) + request_context_copy = copy(request_context) + self.assertIsInstance(request_context_copy, RequestContext) + self.assertEqual(request_context_copy.dicts, request_context.dicts) + self.assertIsNot(request_context_copy.dicts, request_context.dicts) From c56e1273a9d87ffad3a84fb597550f79b9820281 Mon Sep 17 00:00:00 2001 From: antoliny0919 Date: Sat, 16 Nov 2024 11:12:51 +0900 Subject: [PATCH 111/132] Refs #32339 -- Updated formset docs to reflect default rendering as as_div. --- docs/topics/forms/formsets.txt | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/docs/topics/forms/formsets.txt b/docs/topics/forms/formsets.txt index 3b68ed614c..14d4962eb6 100644 --- a/docs/topics/forms/formsets.txt +++ b/docs/topics/forms/formsets.txt @@ -1005,10 +1005,11 @@ deal with the management form: The above ends up calling the :meth:`BaseFormSet.render` method on the formset class. This renders the formset using the template specified by the :attr:`~BaseFormSet.template_name` attribute. Similar to forms, by default the -formset will be rendered ``as_table``, with other helper methods of ``as_p`` -and ``as_ul`` being available. The rendering of the formset can be customized -by specifying the ``template_name`` attribute, or more generally by -:ref:`overriding the default template `. +formset will be rendered ``as_div``, with other helper methods of ``as_p``, +``as_ul``, and ``as_table`` being available. The rendering of the formset can +be customized by specifying the ``template_name`` attribute, or more generally +by :ref:`overriding the default template +`. .. _manually-rendered-can-delete-and-can-order: From 17e544ece7e51c5eaeff9bdadc3de263fdd98dee Mon Sep 17 00:00:00 2001 From: Tim Schilling Date: Thu, 14 Nov 2024 07:52:56 -0600 Subject: [PATCH 112/132] Updated maintainers of Django Debug Toolbar to Django Commons. --- docs/intro/tutorial08.txt | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/docs/intro/tutorial08.txt b/docs/intro/tutorial08.txt index 463db3221e..98bf70d330 100644 --- a/docs/intro/tutorial08.txt +++ b/docs/intro/tutorial08.txt @@ -22,10 +22,11 @@ Installing Django Debug Toolbar =============================== Django Debug Toolbar is a useful tool for debugging Django web applications. -It's a third-party package maintained by the `Jazzband -`_ organization. The toolbar helps you understand how your -application functions and to identify problems. It does so by providing panels -that provide debug information about the current request and response. +It's a third-party package that is maintained by the community organization +`Django Commons `_. The toolbar helps you +understand how your application functions and to identify problems. It does so +by providing panels that provide debug information about the current request +and response. To install a third-party application like the toolbar, you need to install the package by running the below command within an activated virtual @@ -67,7 +68,7 @@ resolve the issue yourself, there are options available to you. `_ that outlines troubleshooting options. #. Search for similar issues on the package's issue tracker. Django Debug - Toolbar’s is `on GitHub `_. + Toolbar’s is `on GitHub `_. #. Consult the `Django Forum `_. #. Join the `Django Discord server `_. #. Join the #Django IRC channel on `Libera.chat `_. From 9543c605c38b80b3ace3836b110e9e1938a44a97 Mon Sep 17 00:00:00 2001 From: David Smith Date: Sat, 2 Nov 2024 21:06:28 +0000 Subject: [PATCH 113/132] Fixed #35775 -- Confirmed support for GEOS 3.13. --- docs/ref/contrib/gis/install/geolibs.txt | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/ref/contrib/gis/install/geolibs.txt b/docs/ref/contrib/gis/install/geolibs.txt index d9bd1dddea..54c9789720 100644 --- a/docs/ref/contrib/gis/install/geolibs.txt +++ b/docs/ref/contrib/gis/install/geolibs.txt @@ -8,7 +8,7 @@ geospatial libraries: ======================== ==================================== ================================ =========================================== Program Description Required Supported Versions ======================== ==================================== ================================ =========================================== -:doc:`GEOS <../geos>` Geometry Engine Open Source Yes 3.12, 3.11, 3.10, 3.9, 3.8 +:doc:`GEOS <../geos>` Geometry Engine Open Source Yes 3.13, 3.12, 3.11, 3.10, 3.9, 3.8 `PROJ`_ Cartographic Projections library Yes (PostgreSQL and SQLite only) 9.x, 8.x, 7.x, 6.x :doc:`GDAL <../gdal>` Geospatial Data Abstraction Library Yes 3.9, 3.8, 3.7, 3.6, 3.5, 3.4, 3.3, 3.2, 3.1 :doc:`GeoIP <../geoip2>` IP-based geolocation library No 2 @@ -26,6 +26,7 @@ totally fine with GeoDjango. Your mileage may vary. GEOS 3.10.0 2021-10-20 GEOS 3.11.0 2022-07-01 GEOS 3.12.0 2023-06-27 + GEOS 3.13.0 2024-09-06 GDAL 3.1.0 2020-05-07 GDAL 3.2.0 2020-11-02 GDAL 3.3.0 2021-05-03 From 4c452cc377f6f43acd90c6e54826ebd2e6219b0d Mon Sep 17 00:00:00 2001 From: Jake Howard Date: Tue, 19 Nov 2024 17:35:02 +0000 Subject: [PATCH 114/132] Fixed #35535 -- Added template tag decorator simple_block_tag(). Co-authored-by: Natalia <124304+nessita@users.noreply.github.com> --- django/template/library.py | 101 ++++++ docs/howto/custom-template-tags.txt | 189 +++++++++++ docs/releases/5.2.txt | 4 +- tests/template_tests/templatetags/custom.py | 174 ++++++++++ tests/template_tests/test_custom.py | 337 ++++++++++++++++++++ tests/template_tests/test_library.py | 41 +++ 6 files changed, 845 insertions(+), 1 deletion(-) diff --git a/django/template/library.py b/django/template/library.py index 4ee96cea89..d181caa832 100644 --- a/django/template/library.py +++ b/django/template/library.py @@ -153,6 +153,90 @@ class Library: else: raise ValueError("Invalid arguments provided to simple_tag") + def simple_block_tag(self, func=None, takes_context=None, name=None, end_name=None): + """ + Register a callable as a compiled block template tag. Example: + + @register.simple_block_tag + def hello(content): + return 'world' + """ + + def dec(func): + nonlocal end_name + + ( + params, + varargs, + varkw, + defaults, + kwonly, + kwonly_defaults, + _, + ) = getfullargspec(unwrap(func)) + function_name = name or func.__name__ + + if end_name is None: + end_name = f"end{function_name}" + + @wraps(func) + def compile_func(parser, token): + tag_params = params.copy() + + if takes_context: + if len(tag_params) >= 2 and tag_params[1] == "content": + del tag_params[1] + else: + raise TemplateSyntaxError( + f"{function_name!r} is decorated with takes_context=True so" + " it must have a first argument of 'context' and a second " + "argument of 'content'" + ) + elif tag_params and tag_params[0] == "content": + del tag_params[0] + else: + raise TemplateSyntaxError( + f"'{function_name}' must have a first argument of 'content'" + ) + + bits = token.split_contents()[1:] + target_var = None + if len(bits) >= 2 and bits[-2] == "as": + target_var = bits[-1] + bits = bits[:-2] + + nodelist = parser.parse((end_name,)) + parser.delete_first_token() + + args, kwargs = parse_bits( + parser, + bits, + tag_params, + varargs, + varkw, + defaults, + kwonly, + kwonly_defaults, + takes_context, + function_name, + ) + + return SimpleBlockNode( + nodelist, func, takes_context, args, kwargs, target_var + ) + + self.tag(function_name, compile_func) + return func + + if func is None: + # @register.simple_block_tag(...) + return dec + elif callable(func): + # @register.simple_block_tag + return dec(func) + else: + raise ValueError("Invalid arguments provided to simple_block_tag") + def inclusion_tag(self, filename, func=None, takes_context=None, name=None): """ Register a callable as an inclusion tag: @@ -243,6 +327,23 @@ class SimpleNode(TagHelperNode): return output +class SimpleBlockNode(SimpleNode): + def __init__(self, nodelist, *args, **kwargs): + super().__init__(*args, **kwargs) + self.nodelist = nodelist + + def get_resolved_arguments(self, context): + resolved_args, resolved_kwargs = super().get_resolved_arguments(context) + + # Restore the "content" argument. + # It will move depending on whether takes_context was passed. + resolved_args.insert( + 1 if self.takes_context else 0, self.nodelist.render(context) + ) + + return resolved_args, resolved_kwargs + + class InclusionNode(TagHelperNode): def __init__(self, func, takes_context, args, kwargs, filename): super().__init__(func, takes_context, args, kwargs) diff --git a/docs/howto/custom-template-tags.txt b/docs/howto/custom-template-tags.txt index 15bef9b5fb..b5577eef7b 100644 --- a/docs/howto/custom-template-tags.txt +++ b/docs/howto/custom-template-tags.txt @@ -498,6 +498,195 @@ you see fit: {% current_time "%Y-%m-%d %I:%M %p" as the_time %}

    The time is {{ the_time }}.

    +.. _howto-custom-template-tags-simple-block-tags: + +Simple block tags +----------------- + +.. versionadded:: 5.2 + +.. method:: django.template.Library.simple_block_tag() + +When a section of rendered template needs to be passed into a custom tag, +Django provides the ``simple_block_tag`` helper function to accomplish this. +Similar to :meth:`~django.template.Library.simple_tag()`, this function accepts +a custom tag function, but with the additional ``content`` argument, which +contains the rendered content as defined inside the tag. This allows dynamic +template sections to be easily incorporated into custom tags. + +For example, a custom block tag which creates a chart could look like this:: + + from django import template + from myapp.charts import render_chart + + register = template.Library() + + + @register.simple_block_tag + def chart(content): + return render_chart(source=content) + +The ``content`` argument contains everything in between the ``{% chart %}`` +and ``{% endchart %}`` tags: + +.. code-block:: html+django + + {% chart %} + digraph G { + label = "Chart for {{ request.user }}" + A -> {B C} + } + {% endchart %} + +If there are other template tags or variables inside the ``content`` block, +they will be rendered before being passed to the tag function. In the example +above, ``request.user`` will be resolved by the time ``render_chart`` is +called. + +Block tags are closed with ``end{name}`` (for example, ``endchart``). This can +be customized with the ``end_name`` parameter:: + + @register.simple_block_tag(end_name="endofchart") + def chart(content): + return render_chart(source=content) + +Which would require a template definition like this: + +.. code-block:: html+django + + {% chart %} + digraph G { + label = "Chart for {{ request.user }}" + A -> {B C} + } + {% endofchart %} + +A few things to note about ``simple_block_tag``: + +* The first argument must be called ``content``, and it will contain the + contents of the template tag as a rendered string. +* Variables passed to the tag are not included in the rendering context of the + content, as would be when using the ``{% with %}`` tag. + +Just like :ref:`simple_tag`, +``simple_block_tag``: + +* Validates the quantity and quality of the arguments. +* Strips quotes from arguments if necessary. +* Escapes the output accordingly. +* Supports passing ``takes_context=True`` at registration time to access + context. Note that in this case, the first argument to the custom function + *must* be called ``context``, and ``content`` must follow. +* Supports renaming the tag by passing the ``name`` argument when registering. +* Supports accepting any number of positional or keyword arguments. +* Supports storing the result in a template variable using the ``as`` variant. + +.. admonition:: Content Escaping + + ``simple_block_tag`` behaves similarly to ``simple_tag`` regarding + auto-escaping. For details on escaping and safety, refer to ``simple_tag``. + Because the ``content`` argument has already been rendered by Django, it is + already escaped. + +A complete example +~~~~~~~~~~~~~~~~~~ + +Consider a custom template tag that generates a message box that supports +multiple message levels and content beyond a simple phrase. This could be +implemented using a ``simple_block_tag`` as follows: + +.. code-block:: python + :caption: ``testapp/templatetags/testapptags.py`` + + from django import template + from django.utils.html import format_html + + + register = template.Library() + + + @register.simple_block_tag(takes_context=True) + def msgbox(context, content, level): + format_kwargs = { + "level": level.lower(), + "level_title": level.capitalize(), + "content": content, + "open": " open" if level.lower() == "error" else "", + "site": context.get("site", "My Site"), + } + result = """ +
    + + + {level_title}: Please read for {site} + +

    + {content} +

    + +
    + """ + return format_html(result, **format_kwargs) + +When combined with a minimal view and corresponding template, as shown here: + +.. code-block:: python + :caption: ``testapp/views.py`` + + from django.shortcuts import render + + + def simpleblocktag_view(request): + return render(request, "test.html", context={"site": "Important Site"}) + + +.. code-block:: html+django + :caption: ``testapp/templates/test.html`` + + {% extends "base.html" %} + + {% load testapptags %} + + {% block content %} + + {% msgbox level="error" %} + Please fix all errors. Further documentation can be found at + Docs. + {% endmsgbox %} + + {% msgbox level="info" %} + More information at: Other Site/ + {% endmsgbox %} + + {% endblock %} + +The following HTML is produced as the rendered output: + +.. code-block:: html + +
    +
    + + Error: Please read for Important Site + +

    + Please fix all errors. Further documentation can be found at + Docs. +

    +
    +
    + +
    +
    + + Info: Please read for Important Site + +

    + More information at: Other Site +

    +
    +
    + .. _howto-custom-template-tags-inclusion-tags: Inclusion tags diff --git a/docs/releases/5.2.txt b/docs/releases/5.2.txt index 3cc71b7f68..f1ffe07569 100644 --- a/docs/releases/5.2.txt +++ b/docs/releases/5.2.txt @@ -323,7 +323,9 @@ Signals Templates ~~~~~~~~~ -* ... +* The new :meth:`~django.template.Library.simple_block_tag` decorator enables + the creation of simple block tags, which can accept and use a section of the + template. Tests ~~~~~ diff --git a/tests/template_tests/templatetags/custom.py b/tests/template_tests/templatetags/custom.py index 8d1130ae78..2c0a1b7f3f 100644 --- a/tests/template_tests/templatetags/custom.py +++ b/tests/template_tests/templatetags/custom.py @@ -20,6 +20,16 @@ def make_data_div(value): return '
    ' % value +@register.simple_block_tag +def div(content, id="test"): + return format_html("
    {}
    ", id, content) + + +@register.simple_block_tag(end_name="divend") +def div_custom_end(content): + return format_html("
    {}
    ", content) + + @register.filter def noop(value, param=None): """A noop filter that always return its first argument and does nothing with @@ -51,6 +61,12 @@ def one_param(arg): one_param.anything = "Expected one_param __dict__" +@register.simple_block_tag +def one_param_block(content, arg): + """Expected one_param_block __doc__""" + return f"one_param_block - Expected result: {arg} with content {content}" + + @register.simple_tag(takes_context=False) def explicit_no_context(arg): """Expected explicit_no_context __doc__""" @@ -60,6 +76,12 @@ def explicit_no_context(arg): explicit_no_context.anything = "Expected explicit_no_context __dict__" +@register.simple_block_tag(takes_context=False) +def explicit_no_context_block(content, arg): + """Expected explicit_no_context_block __doc__""" + return f"explicit_no_context_block - Expected result: {arg} with content {content}" + + @register.simple_tag(takes_context=True) def no_params_with_context(context): """Expected no_params_with_context __doc__""" @@ -72,6 +94,15 @@ def no_params_with_context(context): no_params_with_context.anything = "Expected no_params_with_context __dict__" +@register.simple_block_tag(takes_context=True) +def no_params_with_context_block(context, content): + """Expected no_params_with_context_block __doc__""" + return ( + "no_params_with_context_block - Expected result (context value: %s) " + "(content value: %s)" % (context["value"], content) + ) + + @register.simple_tag(takes_context=True) def params_and_context(context, arg): """Expected params_and_context __doc__""" @@ -84,6 +115,20 @@ def params_and_context(context, arg): params_and_context.anything = "Expected params_and_context __dict__" +@register.simple_block_tag(takes_context=True) +def params_and_context_block(context, content, arg): + """Expected params_and_context_block __doc__""" + return ( + "params_and_context_block - Expected result (context value: %s) " + "(content value: %s): %s" + % ( + context["value"], + content, + arg, + ) + ) + + @register.simple_tag def simple_two_params(one, two): """Expected simple_two_params __doc__""" @@ -93,16 +138,48 @@ def simple_two_params(one, two): simple_two_params.anything = "Expected simple_two_params __dict__" +@register.simple_block_tag +def simple_two_params_block(content, one, two): + """Expected simple_two_params_block __doc__""" + return "simple_two_params_block - Expected result (content value: %s): %s, %s" % ( + content, + one, + two, + ) + + @register.simple_tag def simple_keyword_only_param(*, kwarg): return "simple_keyword_only_param - Expected result: %s" % kwarg +@register.simple_block_tag +def simple_keyword_only_param_block(content, *, kwarg): + return ( + "simple_keyword_only_param_block - Expected result (content value: %s): %s" + % ( + content, + kwarg, + ) + ) + + @register.simple_tag def simple_keyword_only_default(*, kwarg=42): return "simple_keyword_only_default - Expected result: %s" % kwarg +@register.simple_block_tag +def simple_keyword_only_default_block(content, *, kwarg=42): + return ( + "simple_keyword_only_default_block - Expected result (content value: %s): %s" + % ( + content, + kwarg, + ) + ) + + @register.simple_tag def simple_one_default(one, two="hi"): """Expected simple_one_default __doc__""" @@ -112,6 +189,16 @@ def simple_one_default(one, two="hi"): simple_one_default.anything = "Expected simple_one_default __dict__" +@register.simple_block_tag +def simple_one_default_block(content, one, two="hi"): + """Expected simple_one_default_block __doc__""" + return "simple_one_default_block - Expected result (content value: %s): %s, %s" % ( + content, + one, + two, + ) + + @register.simple_tag def simple_unlimited_args(one, two="hi", *args): """Expected simple_unlimited_args __doc__""" @@ -123,6 +210,15 @@ def simple_unlimited_args(one, two="hi", *args): simple_unlimited_args.anything = "Expected simple_unlimited_args __dict__" +@register.simple_block_tag +def simple_unlimited_args_block(content, one, two="hi", *args): + """Expected simple_unlimited_args_block __doc__""" + return "simple_unlimited_args_block - Expected result (content value: %s): %s" % ( + content, + ", ".join(str(arg) for arg in [one, two, *args]), + ) + + @register.simple_tag def simple_only_unlimited_args(*args): """Expected simple_only_unlimited_args __doc__""" @@ -134,6 +230,18 @@ def simple_only_unlimited_args(*args): simple_only_unlimited_args.anything = "Expected simple_only_unlimited_args __dict__" +@register.simple_block_tag +def simple_only_unlimited_args_block(content, *args): + """Expected simple_only_unlimited_args_block __doc__""" + return ( + "simple_only_unlimited_args_block - Expected result (content value: %s): %s" + % ( + content, + ", ".join(str(arg) for arg in args), + ) + ) + + @register.simple_tag def simple_unlimited_args_kwargs(one, two="hi", *args, **kwargs): """Expected simple_unlimited_args_kwargs __doc__""" @@ -146,6 +254,38 @@ def simple_unlimited_args_kwargs(one, two="hi", *args, **kwargs): simple_unlimited_args_kwargs.anything = "Expected simple_unlimited_args_kwargs __dict__" +@register.simple_block_tag +def simple_unlimited_args_kwargs_block(content, one, two="hi", *args, **kwargs): + """Expected simple_unlimited_args_kwargs_block __doc__""" + return ( + "simple_unlimited_args_kwargs_block - Expected result (content value: %s): " + "%s / %s" + % ( + content, + ", ".join(str(arg) for arg in [one, two, *args]), + ", ".join("%s=%s" % (k, v) for (k, v) in kwargs.items()), + ) + ) + + +@register.simple_block_tag(takes_context=True) +def simple_block_tag_without_context_parameter(arg): + """Expected simple_block_tag_without_context_parameter __doc__""" + return "Expected result" + + +@register.simple_block_tag +def simple_tag_without_content_parameter(arg): + """Expected simple_tag_without_content_parameter __doc__""" + return "Expected result" + + +@register.simple_block_tag(takes_context=True) +def simple_tag_with_context_without_content_parameter(context, arg): + """Expected simple_tag_with_context_without_content_parameter __doc__""" + return "Expected result" + + @register.simple_tag(takes_context=True) def simple_tag_without_context_parameter(arg): """Expected simple_tag_without_context_parameter __doc__""" @@ -157,6 +297,12 @@ simple_tag_without_context_parameter.anything = ( ) +@register.simple_block_tag(takes_context=True) +def simple_tag_takes_context_without_params_block(): + """Expected simple_tag_takes_context_without_params_block __doc__""" + return "Expected result" + + @register.simple_tag(takes_context=True) def simple_tag_takes_context_without_params(): """Expected simple_tag_takes_context_without_params __doc__""" @@ -168,24 +314,52 @@ simple_tag_takes_context_without_params.anything = ( ) +@register.simple_block_tag +def simple_block_tag_without_content(): + return "Expected result" + + +@register.simple_block_tag(takes_context=True) +def simple_block_tag_with_context_without_content(): + return "Expected result" + + @register.simple_tag(takes_context=True) def escape_naive(context): """A tag that doesn't even think about escaping issues""" return "Hello {}!".format(context["name"]) +@register.simple_block_tag(takes_context=True) +def escape_naive_block(context, content): + """A block tag that doesn't even think about escaping issues""" + return "Hello {}: {}!".format(context["name"], content) + + @register.simple_tag(takes_context=True) def escape_explicit(context): """A tag that uses escape explicitly""" return escape("Hello {}!".format(context["name"])) +@register.simple_block_tag(takes_context=True) +def escape_explicit_block(context, content): + """A block tag that uses escape explicitly""" + return escape("Hello {}: {}!".format(context["name"], content)) + + @register.simple_tag(takes_context=True) def escape_format_html(context): """A tag that uses format_html""" return format_html("Hello {0}!", context["name"]) +@register.simple_block_tag(takes_context=True) +def escape_format_html_block(context, content): + """A block tag that uses format_html""" + return format_html("Hello {0}: {1}!", context["name"], content) + + @register.simple_tag(takes_context=True) def current_app(context): return str(context.current_app) diff --git a/tests/template_tests/test_custom.py b/tests/template_tests/test_custom.py index 1697d16ef5..9ec27b481f 100644 --- a/tests/template_tests/test_custom.py +++ b/tests/template_tests/test_custom.py @@ -243,6 +243,343 @@ class SimpleTagTests(TagTestCase): ) +class SimpleBlockTagTests(TagTestCase): + def test_simple_block_tags(self): + c = Context({"value": 42}) + + templates = [ + ( + "{% load custom %}{% div %}content{% enddiv %}", + "
    content
    ", + ), + ( + "{% load custom %}{% one_param_block 37 %}inner" + "{% endone_param_block %}", + "one_param_block - Expected result: 37 with content inner", + ), + ( + "{% load custom %}{% explicit_no_context_block 37 %}inner" + "{% endexplicit_no_context_block %}", + "explicit_no_context_block - Expected result: 37 with content inner", + ), + ( + "{% load custom %}{% no_params_with_context_block %}inner" + "{% endno_params_with_context_block %}", + "no_params_with_context_block - Expected result (context value: 42) " + "(content value: inner)", + ), + ( + "{% load custom %}{% params_and_context_block 37 %}inner" + "{% endparams_and_context_block %}", + "params_and_context_block - Expected result (context value: 42) " + "(content value: inner): 37", + ), + ( + "{% load custom %}{% simple_two_params_block 37 42 %}inner" + "{% endsimple_two_params_block %}", + "simple_two_params_block - Expected result (content value: inner): " + "37, 42", + ), + ( + "{% load custom %}{% simple_keyword_only_param_block kwarg=37 %}thirty " + "seven{% endsimple_keyword_only_param_block %}", + "simple_keyword_only_param_block - Expected result (content value: " + "thirty seven): 37", + ), + ( + "{% load custom %}{% simple_keyword_only_default_block %}forty two" + "{% endsimple_keyword_only_default_block %}", + "simple_keyword_only_default_block - Expected result (content value: " + "forty two): 42", + ), + ( + "{% load custom %}{% simple_keyword_only_default_block kwarg=37 %}" + "thirty seven{% endsimple_keyword_only_default_block %}", + "simple_keyword_only_default_block - Expected result (content value: " + "thirty seven): 37", + ), + ( + "{% load custom %}{% simple_one_default_block 37 %}inner" + "{% endsimple_one_default_block %}", + "simple_one_default_block - Expected result (content value: inner): " + "37, hi", + ), + ( + '{% load custom %}{% simple_one_default_block 37 two="hello" %}inner' + "{% endsimple_one_default_block %}", + "simple_one_default_block - Expected result (content value: inner): " + "37, hello", + ), + ( + '{% load custom %}{% simple_one_default_block one=99 two="hello" %}' + "inner{% endsimple_one_default_block %}", + "simple_one_default_block - Expected result (content value: inner): " + "99, hello", + ), + ( + "{% load custom %}{% simple_one_default_block 37 42 %}inner" + "{% endsimple_one_default_block %}", + "simple_one_default_block - Expected result (content value: inner): " + "37, 42", + ), + ( + "{% load custom %}{% simple_unlimited_args_block 37 %}thirty seven" + "{% endsimple_unlimited_args_block %}", + "simple_unlimited_args_block - Expected result (content value: thirty " + "seven): 37, hi", + ), + ( + "{% load custom %}{% simple_unlimited_args_block 37 42 56 89 %}numbers" + "{% endsimple_unlimited_args_block %}", + "simple_unlimited_args_block - Expected result " + "(content value: numbers): 37, 42, 56, 89", + ), + ( + "{% load custom %}{% simple_only_unlimited_args_block %}inner" + "{% endsimple_only_unlimited_args_block %}", + "simple_only_unlimited_args_block - Expected result (content value: " + "inner): ", + ), + ( + "{% load custom %}{% simple_only_unlimited_args_block 37 42 56 89 %}" + "numbers{% endsimple_only_unlimited_args_block %}", + "simple_only_unlimited_args_block - Expected result " + "(content value: numbers): 37, 42, 56, 89", + ), + ( + "{% load custom %}" + '{% simple_unlimited_args_kwargs_block 37 40|add:2 56 eggs="scrambled" ' + "four=1|add:3 %}inner content" + "{% endsimple_unlimited_args_kwargs_block %}", + "simple_unlimited_args_kwargs_block - Expected result (content value: " + "inner content): 37, 42, 56 / eggs=scrambled, four=4", + ), + ] + + for entry in templates: + with self.subTest(entry[0]): + t = self.engine.from_string(entry[0]) + self.assertEqual(t.render(c), entry[1]) + + def test_simple_block_tag_errors(self): + errors = [ + ( + "'simple_one_default_block' received unexpected keyword argument " + "'three'", + "{% load custom %}" + '{% simple_one_default_block 99 two="hello" three="foo" %}' + "{% endsimple_one_default_block %}", + ), + ( + "'simple_two_params_block' received too many positional arguments", + "{% load custom %}{% simple_two_params_block 37 42 56 %}" + "{% endsimple_two_params_block %}", + ), + ( + "'simple_one_default_block' received too many positional arguments", + "{% load custom %}{% simple_one_default_block 37 42 56 %}" + "{% endsimple_one_default_block %}", + ), + ( + "'simple_keyword_only_param_block' did not receive value(s) for the " + "argument(s): 'kwarg'", + "{% load custom %}{% simple_keyword_only_param_block %}" + "{% endsimple_keyword_only_param_block %}", + ), + ( + "'simple_keyword_only_param_block' received multiple values for " + "keyword argument 'kwarg'", + "{% load custom %}" + "{% simple_keyword_only_param_block kwarg=42 kwarg=37 %}" + "{% endsimple_keyword_only_param_block %}", + ), + ( + "'simple_keyword_only_default_block' received multiple values for " + "keyword argument 'kwarg'", + "{% load custom %}{% simple_keyword_only_default_block kwarg=42 " + "kwarg=37 %}{% endsimple_keyword_only_default_block %}", + ), + ( + "'simple_unlimited_args_kwargs_block' received some positional " + "argument(s) after some keyword argument(s)", + "{% load custom %}" + '{% simple_unlimited_args_kwargs_block 37 40|add:2 eggs="scrambled" 56 ' + "four=1|add:3 %}{% endsimple_unlimited_args_kwargs_block %}", + ), + ( + "'simple_unlimited_args_kwargs_block' received multiple values for " + "keyword argument 'eggs'", + "{% load custom %}" + "{% simple_unlimited_args_kwargs_block 37 " + 'eggs="scrambled" eggs="scrambled" %}' + "{% endsimple_unlimited_args_kwargs_block %}", + ), + ( + "Unclosed tag on line 1: 'div'. Looking for one of: enddiv.", + "{% load custom %}{% div %}Some content", + ), + ( + "Unclosed tag on line 1: 'simple_one_default_block'. Looking for one " + "of: endsimple_one_default_block.", + "{% load custom %}{% simple_one_default_block %}Some content", + ), + ( + "'simple_tag_without_content_parameter' must have a first argument " + "of 'content'", + "{% load custom %}{% simple_tag_without_content_parameter %}", + ), + ( + "'simple_tag_with_context_without_content_parameter' is decorated with " + "takes_context=True so it must have a first argument of 'context' and " + "a second argument of 'content'", + "{% load custom %}" + "{% simple_tag_with_context_without_content_parameter %}", + ), + ] + + for entry in errors: + with self.subTest(entry[1]): + with self.assertRaisesMessage(TemplateSyntaxError, entry[0]): + self.engine.from_string(entry[1]) + + def test_simple_block_tag_escaping_autoescape_off(self): + c = Context({"name": "Jack & Jill"}, autoescape=False) + t = self.engine.from_string( + "{% load custom %}{% escape_naive_block %}{{ name }} again" + "{% endescape_naive_block %}" + ) + self.assertEqual(t.render(c), "Hello Jack & Jill: Jack & Jill again!") + + def test_simple_block_tag_naive_escaping(self): + c = Context({"name": "Jack & Jill"}) + t = self.engine.from_string( + "{% load custom %}{% escape_naive_block %}{{ name }} again" + "{% endescape_naive_block %}" + ) + self.assertEqual( + t.render(c), "Hello Jack & Jill: Jack &amp; Jill again!" + ) + + def test_simple_block_tag_explicit_escaping(self): + # Check we don't double escape + c = Context({"name": "Jack & Jill"}) + t = self.engine.from_string( + "{% load custom %}{% escape_explicit_block %}again" + "{% endescape_explicit_block %}" + ) + self.assertEqual(t.render(c), "Hello Jack & Jill: again!") + + def test_simple_block_tag_format_html_escaping(self): + # Check we don't double escape + c = Context({"name": "Jack & Jill"}) + t = self.engine.from_string( + "{% load custom %}{% escape_format_html_block %}again" + "{% endescape_format_html_block %}" + ) + self.assertEqual(t.render(c), "Hello Jack & Jill: again!") + + def test_simple_block_tag_missing_context(self): + # The 'context' parameter must be present when takes_context is True + msg = ( + "'simple_block_tag_without_context_parameter' is decorated with " + "takes_context=True so it must have a first argument of 'context'" + ) + with self.assertRaisesMessage(TemplateSyntaxError, msg): + self.engine.from_string( + "{% load custom %}{% simple_block_tag_without_context_parameter 123 %}" + "{% endsimple_block_tag_without_context_parameter %}" + ) + + def test_simple_block_tag_missing_context_no_params(self): + msg = ( + "'simple_tag_takes_context_without_params_block' is decorated with " + "takes_context=True so it must have a first argument of 'context'" + ) + with self.assertRaisesMessage(TemplateSyntaxError, msg): + self.engine.from_string( + "{% load custom %}{% simple_tag_takes_context_without_params_block %}" + "{% endsimple_tag_takes_context_without_params_block %}" + ) + + def test_simple_block_tag_missing_content(self): + # The 'content' parameter must be present when takes_context is True + msg = ( + "'simple_block_tag_without_content' must have a first argument of 'content'" + ) + with self.assertRaisesMessage(TemplateSyntaxError, msg): + self.engine.from_string( + "{% load custom %}{% simple_block_tag_without_content %}" + "{% endsimple_block_tag_without_content %}" + ) + + def test_simple_block_tag_with_context_missing_content(self): + # The 'content' parameter must be present when takes_context is True + msg = "'simple_block_tag_with_context_without_content' is decorated with " + "takes_context=True so it must have a first argument of 'context' and a " + "second argument of 'content'" + with self.assertRaisesMessage(TemplateSyntaxError, msg): + self.engine.from_string( + "{% load custom %}{% simple_block_tag_with_context_without_content %}" + "{% endsimple_block_tag_with_context_without_content %}" + ) + + def test_simple_block_gets_context(self): + c = Context({"name": "Jack & Jill"}) + t = self.engine.from_string("{% load custom %}{% div %}{{ name }}{% enddiv %}") + self.assertEqual(t.render(c), "
    Jack & Jill
    ") + + def test_simple_block_capture_as(self): + c = Context({"name": "Jack & Jill"}) + t = self.engine.from_string( + "{% load custom %}{% div as div_content %}{{ name }}{% enddiv %}" + "My div is: {{ div_content }}" + ) + self.assertEqual(t.render(c), "My div is:
    Jack & Jill
    ") + + def test_simple_block_nested(self): + c = Context({"name": "Jack & Jill"}) + t = self.engine.from_string( + "{% load custom %}Start{% div id='outer' %}Before{% div id='inner' %}" + "{{ name }}{% enddiv %}After{% enddiv %}End" + ) + self.assertEqual( + t.render(c), + "Start
    Before
    Jack & Jill
    After" + "
    End", + ) + + def test_different_simple_block_nested(self): + c = Context({"name": "Jack & Jill"}) + t = self.engine.from_string( + "{% load custom %}Start{% div id='outer' %}Before" + "{% simple_keyword_only_default_block %}Inner" + "{% endsimple_keyword_only_default_block %}" + "After{% enddiv %}End" + ) + self.assertEqual( + t.render(c), + "Start
    Before" + "simple_keyword_only_default_block - Expected result (content value: " + "Inner): 42After
    End", + ) + + def test_custom_end_tag(self): + c = Context({"name": "Jack & Jill"}) + t = self.engine.from_string( + "{% load custom %}{% div_custom_end %}{{ name }}{% divend %}" + ) + self.assertEqual(t.render(c), "
    Jack & Jill
    ") + + with self.assertRaisesMessage( + TemplateSyntaxError, + "'enddiv_custom_end', expected 'divend'. Did you forget to register or " + "load this tag?", + ): + self.engine.from_string( + "{% load custom %}{% div_custom_end %}{{ name }}{% enddiv_custom_end %}" + ) + + class InclusionTagTests(TagTestCase): def test_inclusion_tags(self): c = Context({"value": 42}) diff --git a/tests/template_tests/test_library.py b/tests/template_tests/test_library.py index 7376832879..98e9d228aa 100644 --- a/tests/template_tests/test_library.py +++ b/tests/template_tests/test_library.py @@ -120,6 +120,47 @@ class SimpleTagRegistrationTests(SimpleTestCase): self.assertTrue(hasattr(func_wrapped, "cache_info")) +class SimpleBlockTagRegistrationTests(SimpleTestCase): + def setUp(self): + self.library = Library() + + def test_simple_block_tag(self): + @self.library.simple_block_tag + def func(content): + return content + + self.assertIn("func", self.library.tags) + + def test_simple_block_tag_parens(self): + @self.library.simple_tag() + def func(content): + return content + + self.assertIn("func", self.library.tags) + + def test_simple_block_tag_name_kwarg(self): + @self.library.simple_block_tag(name="name") + def func(content): + return content + + self.assertIn("name", self.library.tags) + + def test_simple_block_tag_invalid(self): + msg = "Invalid arguments provided to simple_block_tag" + with self.assertRaisesMessage(ValueError, msg): + self.library.simple_block_tag("invalid") + + def test_simple_tag_wrapped(self): + @self.library.simple_block_tag + @functools.lru_cache(maxsize=32) + def func(content): + return content + + func_wrapped = self.library.tags["func"].__wrapped__ + self.assertIs(func_wrapped, func) + self.assertTrue(hasattr(func_wrapped, "cache_info")) + + class TagRegistrationTests(SimpleTestCase): def setUp(self): self.library = Library() From f60d5e46e131b94d6ecc92b6891689ccc94bd1c9 Mon Sep 17 00:00:00 2001 From: antoliny0919 Date: Sun, 17 Nov 2024 11:25:44 +0900 Subject: [PATCH 115/132] Fixed #35913 -- Prevented formset name suffix 'FormFormSet'. --- django/forms/formsets.py | 7 ++++++- tests/forms_tests/tests/test_formsets.py | 6 ++++++ 2 files changed, 12 insertions(+), 1 deletion(-) diff --git a/django/forms/formsets.py b/django/forms/formsets.py index c8e5893f19..c2663154d4 100644 --- a/django/forms/formsets.py +++ b/django/forms/formsets.py @@ -570,7 +570,12 @@ def formset_factory( "validate_max": validate_max, "renderer": renderer, } - return type(form.__name__ + "FormSet", (formset,), attrs) + form_name = form.__name__ + if form_name.endswith("Form"): + formset_name = form_name + "Set" + else: + formset_name = form_name + "FormSet" + return type(formset_name, (formset,), attrs) def all_valid(formsets): diff --git a/tests/forms_tests/tests/test_formsets.py b/tests/forms_tests/tests/test_formsets.py index f80c1dc09e..9f7012a11f 100644 --- a/tests/forms_tests/tests/test_formsets.py +++ b/tests/forms_tests/tests/test_formsets.py @@ -149,6 +149,12 @@ class FormsFormsetTestCase(SimpleTestCase): self.assertFalse(formset.is_valid()) self.assertFalse(formset.has_changed()) + def test_formset_name(self): + ArticleFormSet = formset_factory(ArticleForm) + ChoiceFormSet = formset_factory(Choice) + self.assertEqual(ArticleFormSet.__name__, "ArticleFormSet") + self.assertEqual(ChoiceFormSet.__name__, "ChoiceFormSet") + def test_form_kwargs_formset(self): """ Custom kwargs set on the formset instance are passed to the From 857b1048d53ebf5fc5581c110e85c212b81ca83a Mon Sep 17 00:00:00 2001 From: GappleBee Date: Thu, 24 Oct 2024 19:44:31 +0100 Subject: [PATCH 116/132] Fixed #34619 -- Associated FilteredSelectMultiple elements to their label and help text. --- .../admin/static/admin/css/responsive.css | 3 +- django/contrib/admin/static/admin/css/rtl.css | 8 +- .../admin/static/admin/css/widgets.css | 39 ++++--- .../admin/static/admin/js/SelectFilter2.js | 106 +++++++++++------- js_tests/admin/SelectFilter2.test.js | 24 +++- tests/admin_inlines/tests.py | 38 ++++--- .../test_related_object_lookups.py | 4 +- tests/admin_views/tests.py | 4 +- tests/admin_widgets/tests.py | 50 +++++---- 9 files changed, 168 insertions(+), 108 deletions(-) diff --git a/django/contrib/admin/static/admin/css/responsive.css b/django/contrib/admin/static/admin/css/responsive.css index 932e824c1c..7d296b150f 100644 --- a/django/contrib/admin/static/admin/css/responsive.css +++ b/django/contrib/admin/static/admin/css/responsive.css @@ -299,7 +299,7 @@ input[type="submit"], button { background-position: 0 -80px; } - a.selector-chooseall, a.selector-clearall { + .selector-chooseall, .selector-clearall { align-self: center; } @@ -649,6 +649,7 @@ input[type="submit"], button { .related-widget-wrapper .selector { order: 1; + flex: 1 0 auto; } .related-widget-wrapper > a { diff --git a/django/contrib/admin/static/admin/css/rtl.css b/django/contrib/admin/static/admin/css/rtl.css index b8f60e0a34..5b55b63013 100644 --- a/django/contrib/admin/static/admin/css/rtl.css +++ b/django/contrib/admin/static/admin/css/rtl.css @@ -235,19 +235,19 @@ fieldset .fieldBox { background-position: 0 -112px; } -a.selector-chooseall { +.selector-chooseall { background: url(../img/selector-icons.svg) right -128px no-repeat; } -a.active.selector-chooseall:focus, a.active.selector-chooseall:hover { +.active.selector-chooseall:focus, .active.selector-chooseall:hover { background-position: 100% -144px; } -a.selector-clearall { +.selector-clearall { background: url(../img/selector-icons.svg) 0 -160px no-repeat; } -a.active.selector-clearall:focus, a.active.selector-clearall:hover { +.active.selector-clearall:focus, .active.selector-clearall:hover { background-position: 0 -176px; } diff --git a/django/contrib/admin/static/admin/css/widgets.css b/django/contrib/admin/static/admin/css/widgets.css index cc64811a2b..c8bf90b3b2 100644 --- a/django/contrib/admin/static/admin/css/widgets.css +++ b/django/contrib/admin/static/admin/css/widgets.css @@ -2,7 +2,7 @@ .selector { display: flex; - flex-grow: 1; + flex: 1; gap: 0 10px; } @@ -14,17 +14,20 @@ } .selector-available, .selector-chosen { - text-align: center; display: flex; flex-direction: column; flex: 1 1; } -.selector-available h2, .selector-chosen h2 { +.selector-available-title, .selector-chosen-title { border: 1px solid var(--border-color); border-radius: 4px 4px 0 0; } +.selector .helptext { + font-size: 0.6875rem; +} + .selector-chosen .list-footer-display { border: 1px solid var(--border-color); border-top: none; @@ -40,14 +43,20 @@ color: var(--breadcrumbs-fg); } -.selector-chosen h2 { +.selector-chosen-title { background: var(--secondary); color: var(--header-link-color); + padding: 8px; +} + +.selector-chosen-title label { + color: var(--header-link-color); } -.selector .selector-available h2 { +.selector-available-title { background: var(--darkened-bg); color: var(--body-quiet-color); + padding: 8px; } .selector .selector-filter { @@ -121,6 +130,7 @@ overflow: hidden; cursor: default; opacity: 0.55; + border: none; } .active.selector-add, .active.selector-remove { @@ -147,7 +157,7 @@ background-position: 0 -80px; } -a.selector-chooseall, a.selector-clearall { +.selector-chooseall, .selector-clearall { display: inline-block; height: 16px; text-align: left; @@ -158,38 +168,39 @@ a.selector-chooseall, a.selector-clearall { color: var(--body-quiet-color); text-decoration: none; opacity: 0.55; + border: none; } -a.active.selector-chooseall:focus, a.active.selector-clearall:focus, -a.active.selector-chooseall:hover, a.active.selector-clearall:hover { +.active.selector-chooseall:focus, .active.selector-clearall:focus, +.active.selector-chooseall:hover, .active.selector-clearall:hover { color: var(--link-fg); } -a.active.selector-chooseall, a.active.selector-clearall { +.active.selector-chooseall, .active.selector-clearall { opacity: 1; } -a.active.selector-chooseall:hover, a.active.selector-clearall:hover { +.active.selector-chooseall:hover, .active.selector-clearall:hover { cursor: pointer; } -a.selector-chooseall { +.selector-chooseall { padding: 0 18px 0 0; background: url(../img/selector-icons.svg) right -160px no-repeat; cursor: default; } -a.active.selector-chooseall:focus, a.active.selector-chooseall:hover { +.active.selector-chooseall:focus, .active.selector-chooseall:hover { background-position: 100% -176px; } -a.selector-clearall { +.selector-clearall { padding: 0 0 0 18px; background: url(../img/selector-icons.svg) 0 -128px no-repeat; cursor: default; } -a.active.selector-clearall:focus, a.active.selector-clearall:hover { +.active.selector-clearall:focus, .active.selector-clearall:hover { background-position: 0 -144px; } diff --git a/django/contrib/admin/static/admin/js/SelectFilter2.js b/django/contrib/admin/static/admin/js/SelectFilter2.js index 133d809d52..7f0cfef8c9 100644 --- a/django/contrib/admin/static/admin/js/SelectFilter2.js +++ b/django/contrib/admin/static/admin/js/SelectFilter2.js @@ -15,6 +15,7 @@ Requires core.js and SelectBox.js. const from_box = document.getElementById(field_id); from_box.id += '_from'; // change its ID from_box.className = 'filtered'; + from_box.setAttribute('aria-labelledby', field_id + '_from_title'); for (const p of from_box.parentNode.getElementsByTagName('p')) { if (p.classList.contains("info")) { @@ -38,18 +39,15 @@ Requires core.js and SelectBox.js. //
    const selector_available = quickElement('div', selector_div); selector_available.className = 'selector-available'; - const title_available = quickElement('h2', selector_available, interpolate(gettext('Available %s') + ' ', [field_name])); + const selector_available_title = quickElement('div', selector_available); + selector_available_title.id = field_id + '_from_title'; + selector_available_title.className = 'selector-available-title'; + quickElement('label', selector_available_title, interpolate(gettext('Available %s') + ' ', [field_name]), 'for', field_id + '_from'); quickElement( - 'span', title_available, '', - 'class', 'help help-tooltip help-icon', - 'title', interpolate( - gettext( - 'This is the list of available %s. You may choose some by ' + - 'selecting them in the box below and then clicking the ' + - '"Choose" arrow between the two boxes.' - ), - [field_name] - ) + 'p', + selector_available_title, + interpolate(gettext('Choose %s by selecting them and then select the "Choose" arrow button.'), [field_name]), + 'class', 'helptext' ); const filter_p = quickElement('p', selector_available, '', 'id', field_id + '_filter'); @@ -60,7 +58,7 @@ Requires core.js and SelectBox.js. quickElement( 'span', search_filter_label, '', 'class', 'help-tooltip search-label-icon', - 'title', interpolate(gettext("Type into this box to filter down the list of available %s."), [field_name]) + 'aria-label', interpolate(gettext("Type into this box to filter down the list of available %s."), [field_name]) ); filter_p.appendChild(document.createTextNode(' ')); @@ -69,32 +67,44 @@ Requires core.js and SelectBox.js. filter_input.id = field_id + '_input'; selector_available.appendChild(from_box); - const choose_all = quickElement('a', selector_available, gettext('Choose all'), 'title', interpolate(gettext('Click to choose all %s at once.'), [field_name]), 'href', '#', 'id', field_id + '_add_all_link'); - choose_all.className = 'selector-chooseall'; + const choose_all = quickElement( + 'button', + selector_available, + interpolate(gettext('Choose all %s'), [field_name]), + 'id', field_id + '_add_all', + 'class', 'selector-chooseall' + ); //
      const selector_chooser = quickElement('ul', selector_div); selector_chooser.className = 'selector-chooser'; - const add_link = quickElement('a', quickElement('li', selector_chooser), gettext('Choose'), 'title', gettext('Choose'), 'href', '#', 'id', field_id + '_add_link'); - add_link.className = 'selector-add'; - const remove_link = quickElement('a', quickElement('li', selector_chooser), gettext('Remove'), 'title', gettext('Remove'), 'href', '#', 'id', field_id + '_remove_link'); - remove_link.className = 'selector-remove'; + const add_button = quickElement( + 'button', + quickElement('li', selector_chooser), + interpolate(gettext('Choose selected %s'), [field_name]), + 'id', field_id + '_add', + 'class', 'selector-add' + ); + const remove_button = quickElement( + 'button', + quickElement('li', selector_chooser), + interpolate(gettext('Remove selected chosen %s'), [field_name]), + 'id', field_id + '_remove', + 'class', 'selector-remove' + ); //
      const selector_chosen = quickElement('div', selector_div, '', 'id', field_id + '_selector_chosen'); selector_chosen.className = 'selector-chosen'; - const title_chosen = quickElement('h2', selector_chosen, interpolate(gettext('Chosen %s') + ' ', [field_name])); + const selector_chosen_title = quickElement('div', selector_chosen); + selector_chosen_title.className = 'selector-chosen-title'; + selector_chosen_title.id = field_id + '_to_title'; + quickElement('label', selector_chosen_title, interpolate(gettext('Chosen %s') + ' ', [field_name]), 'for', field_id + '_to'); quickElement( - 'span', title_chosen, '', - 'class', 'help help-tooltip help-icon', - 'title', interpolate( - gettext( - 'This is the list of chosen %s. You may remove some by ' + - 'selecting them in the box below and then clicking the ' + - '"Remove" arrow between the two boxes.' - ), - [field_name] - ) + 'p', + selector_chosen_title, + interpolate(gettext('Remove %s by selecting them and then select the "Remove" arrow button.'), [field_name]), + 'class', 'helptext' ); const filter_selected_p = quickElement('p', selector_chosen, '', 'id', field_id + '_filter_selected'); @@ -105,7 +115,7 @@ Requires core.js and SelectBox.js. quickElement( 'span', search_filter_selected_label, '', 'class', 'help-tooltip search-label-icon', - 'title', interpolate(gettext("Type into this box to filter down the list of selected %s."), [field_name]) + 'aria-label', interpolate(gettext("Type into this box to filter down the list of selected %s."), [field_name]) ); filter_selected_p.appendChild(document.createTextNode(' ')); @@ -113,15 +123,27 @@ Requires core.js and SelectBox.js. const filter_selected_input = quickElement('input', filter_selected_p, '', 'type', 'text', 'placeholder', gettext("Filter")); filter_selected_input.id = field_id + '_selected_input'; - const to_box = quickElement('select', selector_chosen, '', 'id', field_id + '_to', 'multiple', '', 'size', from_box.size, 'name', from_box.name); - to_box.className = 'filtered'; - + quickElement( + 'select', + selector_chosen, + '', + 'id', field_id + '_to', + 'multiple', '', + 'size', from_box.size, + 'name', from_box.name, + 'aria-labelledby', field_id + '_to_title', + 'class', 'filtered' + ); const warning_footer = quickElement('div', selector_chosen, '', 'class', 'list-footer-display'); quickElement('span', warning_footer, '', 'id', field_id + '_list-footer-display-text'); quickElement('span', warning_footer, ' ' + gettext('(click to clear)'), 'class', 'list-footer-display__clear'); - - const clear_all = quickElement('a', selector_chosen, gettext('Remove all'), 'title', interpolate(gettext('Click to remove all chosen %s at once.'), [field_name]), 'href', '#', 'id', field_id + '_remove_all_link'); - clear_all.className = 'selector-clearall'; + const clear_all = quickElement( + 'button', + selector_chosen, + interpolate(gettext('Remove all %s'), [field_name]), + 'id', field_id + '_remove_all', + 'class', 'selector-clearall' + ); from_box.name = from_box.name + '_old'; @@ -138,10 +160,10 @@ Requires core.js and SelectBox.js. choose_all.addEventListener('click', function(e) { move_selection(e, this, SelectBox.move_all, field_id + '_from', field_id + '_to'); }); - add_link.addEventListener('click', function(e) { + add_button.addEventListener('click', function(e) { move_selection(e, this, SelectBox.move, field_id + '_from', field_id + '_to'); }); - remove_link.addEventListener('click', function(e) { + remove_button.addEventListener('click', function(e) { move_selection(e, this, SelectBox.move, field_id + '_to', field_id + '_from'); }); clear_all.addEventListener('click', function(e) { @@ -227,11 +249,11 @@ Requires core.js and SelectBox.js. const from = document.getElementById(field_id + '_from'); const to = document.getElementById(field_id + '_to'); // Active if at least one item is selected - document.getElementById(field_id + '_add_link').classList.toggle('active', SelectFilter.any_selected(from)); - document.getElementById(field_id + '_remove_link').classList.toggle('active', SelectFilter.any_selected(to)); + document.getElementById(field_id + '_add').classList.toggle('active', SelectFilter.any_selected(from)); + document.getElementById(field_id + '_remove').classList.toggle('active', SelectFilter.any_selected(to)); // Active if the corresponding box isn't empty - document.getElementById(field_id + '_add_all_link').classList.toggle('active', from.querySelector('option')); - document.getElementById(field_id + '_remove_all_link').classList.toggle('active', to.querySelector('option')); + document.getElementById(field_id + '_add_all').classList.toggle('active', from.querySelector('option')); + document.getElementById(field_id + '_remove_all').classList.toggle('active', to.querySelector('option')); SelectFilter.refresh_filtered_warning(field_id); }, filter_key_press: function(event, field_id, source, target) { diff --git a/js_tests/admin/SelectFilter2.test.js b/js_tests/admin/SelectFilter2.test.js index 0b1317cff5..af227c0c1e 100644 --- a/js_tests/admin/SelectFilter2.test.js +++ b/js_tests/admin/SelectFilter2.test.js @@ -12,13 +12,25 @@ QUnit.test('init', function(assert) { SelectFilter.init('id', 'things', 0); assert.equal($('#test').children().first().prop("tagName"), "DIV"); assert.equal($('#test').children().first().attr("class"), "selector"); - assert.equal($('.selector-available h2').text().trim(), "Available things"); - assert.equal($('.selector-chosen h2').text().trim(), "Chosen things"); + assert.equal($('.selector-available label').text().trim(), "Available things"); + assert.equal($('.selector-chosen label').text().trim(), "Chosen things"); assert.equal($('.selector-chosen select')[0].getAttribute('multiple'), ''); - assert.equal($('.selector-chooseall').text(), "Choose all"); - assert.equal($('.selector-add').text(), "Choose"); - assert.equal($('.selector-remove').text(), "Remove"); - assert.equal($('.selector-clearall').text(), "Remove all"); + assert.equal($('.selector-chooseall').text(), "Choose all things"); + assert.equal($('.selector-chooseall').prop("tagName"), "BUTTON"); + assert.equal($('.selector-add').text(), "Choose selected things"); + assert.equal($('.selector-add').prop("tagName"), "BUTTON"); + assert.equal($('.selector-remove').text(), "Remove selected chosen things"); + assert.equal($('.selector-remove').prop("tagName"), "BUTTON"); + assert.equal($('.selector-clearall').text(), "Remove all things"); + assert.equal($('.selector-clearall').prop("tagName"), "BUTTON"); + assert.equal($('.selector-available .filtered').attr("aria-labelledby"), "id_from_title"); + assert.equal($('.selector-available .selector-available-title label').text(), "Available things "); + assert.equal($('.selector-available .selector-available-title .helptext').text(), 'Choose things by selecting them and then select the "Choose" arrow button.'); + assert.equal($('.selector-chosen .filtered').attr("aria-labelledby"), "id_to_title"); + assert.equal($('.selector-chosen .selector-chosen-title label').text(), "Chosen things "); + assert.equal($('.selector-chosen .selector-chosen-title .helptext').text(), 'Remove things by selecting them and then select the "Remove" arrow button.'); + assert.equal($('.selector-filter label .help-tooltip')[0].getAttribute("aria-label"), "Type into this box to filter down the list of available things."); + assert.equal($('.selector-filter label .help-tooltip')[1].getAttribute("aria-label"), "Type into this box to filter down the list of selected things."); }); QUnit.test('filtering available options', function(assert) { diff --git a/tests/admin_inlines/tests.py b/tests/admin_inlines/tests.py index 9c32f6fb8e..b08ab3a52a 100644 --- a/tests/admin_inlines/tests.py +++ b/tests/admin_inlines/tests.py @@ -2420,31 +2420,43 @@ class SeleniumTests(AdminSeleniumTestCase): "admin:admin_inlines_courseproxy1_add", "admin:admin_inlines_courseproxy2_add", ] - css_selector = ".dynamic-class_set#class_set-%s h2" + css_available_selector = ( + ".dynamic-class_set#class_set-%s .selector-available-title" + ) + css_chosen_selector = ".dynamic-class_set#class_set-%s .selector-chosen-title" for url_name in tests: with self.subTest(url=url_name): self.selenium.get(self.live_server_url + reverse(url_name)) # First inline shows the verbose_name. - available, chosen = self.selenium.find_elements( - By.CSS_SELECTOR, css_selector % 0 + available = self.selenium.find_element( + By.CSS_SELECTOR, css_available_selector % 0 ) - self.assertEqual(available.text, "AVAILABLE ATTENDANT") - self.assertEqual(chosen.text, "CHOSEN ATTENDANT") + chosen = self.selenium.find_element( + By.CSS_SELECTOR, css_chosen_selector % 0 + ) + self.assertIn("Available attendant", available.text) + self.assertIn("Chosen attendant", chosen.text) # Added inline should also have the correct verbose_name. self.selenium.find_element(By.LINK_TEXT, "Add another Class").click() - available, chosen = self.selenium.find_elements( - By.CSS_SELECTOR, css_selector % 1 + available = self.selenium.find_element( + By.CSS_SELECTOR, css_available_selector % 1 ) - self.assertEqual(available.text, "AVAILABLE ATTENDANT") - self.assertEqual(chosen.text, "CHOSEN ATTENDANT") + chosen = self.selenium.find_element( + By.CSS_SELECTOR, css_chosen_selector % 1 + ) + self.assertIn("Available attendant", available.text) + self.assertIn("Chosen attendant", chosen.text) # Third inline should also have the correct verbose_name. self.selenium.find_element(By.LINK_TEXT, "Add another Class").click() - available, chosen = self.selenium.find_elements( - By.CSS_SELECTOR, css_selector % 2 + available = self.selenium.find_element( + By.CSS_SELECTOR, css_available_selector % 2 ) - self.assertEqual(available.text, "AVAILABLE ATTENDANT") - self.assertEqual(chosen.text, "CHOSEN ATTENDANT") + chosen = self.selenium.find_element( + By.CSS_SELECTOR, css_chosen_selector % 2 + ) + self.assertIn("Available attendant", available.text) + self.assertIn("Chosen attendant", chosen.text) def test_tabular_inline_layout(self): from selenium.webdriver.common.by import By diff --git a/tests/admin_views/test_related_object_lookups.py b/tests/admin_views/test_related_object_lookups.py index 4b2171a09f..b591117460 100644 --- a/tests/admin_views/test_related_object_lookups.py +++ b/tests/admin_views/test_related_object_lookups.py @@ -162,7 +162,7 @@ class SeleniumTests(AdminSeleniumTestCase): # Move the new value to the from box. self.selenium.find_element(By.XPATH, "//*[@id='id_m2m_to']/option").click() - self.selenium.find_element(By.XPATH, "//*[@id='id_m2m_remove_link']").click() + self.selenium.find_element(By.XPATH, "//*[@id='id_m2m_remove']").click() self.assertHTMLEqual( m2m_box.get_attribute("innerHTML"), @@ -172,7 +172,7 @@ class SeleniumTests(AdminSeleniumTestCase): # Move the new value to the to box. self.selenium.find_element(By.XPATH, "//*[@id='id_m2m_from']/option").click() - self.selenium.find_element(By.XPATH, "//*[@id='id_m2m_add_link']").click() + self.selenium.find_element(By.XPATH, "//*[@id='id_m2m_add']").click() self.assertHTMLEqual(m2m_box.get_attribute("innerHTML"), "") self.assertHTMLEqual( diff --git a/tests/admin_views/tests.py b/tests/admin_views/tests.py index 3f106f6814..1ff29fc3db 100644 --- a/tests/admin_views/tests.py +++ b/tests/admin_views/tests.py @@ -6225,9 +6225,7 @@ class SeleniumTests(AdminSeleniumTestCase): self.take_screenshot("selectbox-available-perms-some-selected") # Move permissions to the "Chosen" list, but none is selected yet. - self.selenium.find_element( - By.CSS_SELECTOR, "#id_user_permissions_add_link" - ).click() + self.selenium.find_element(By.CSS_SELECTOR, "#id_user_permissions_add").click() self.take_screenshot("selectbox-chosen-perms-none-selected") # Select some permissions from the "Chosen" list. diff --git a/tests/admin_widgets/tests.py b/tests/admin_widgets/tests.py index 5da4adf8c9..a81f5802d1 100644 --- a/tests/admin_widgets/tests.py +++ b/tests/admin_widgets/tests.py @@ -1257,15 +1257,19 @@ class HorizontalVerticalFilterSeleniumTests(AdminWidgetSeleniumTestCase): def assertActiveButtons( self, mode, field_name, choose, remove, choose_all=None, remove_all=None ): - choose_link = "#id_%s_add_link" % field_name - choose_all_link = "#id_%s_add_all_link" % field_name - remove_link = "#id_%s_remove_link" % field_name - remove_all_link = "#id_%s_remove_all_link" % field_name - self.assertEqual(self.has_css_class(choose_link, "active"), choose) - self.assertEqual(self.has_css_class(remove_link, "active"), remove) + choose_button = "#id_%s_add" % field_name + choose_all_button = "#id_%s_add_all" % field_name + remove_button = "#id_%s_remove" % field_name + remove_all_button = "#id_%s_remove_all" % field_name + self.assertEqual(self.has_css_class(choose_button, "active"), choose) + self.assertEqual(self.has_css_class(remove_button, "active"), remove) if mode == "horizontal": - self.assertEqual(self.has_css_class(choose_all_link, "active"), choose_all) - self.assertEqual(self.has_css_class(remove_all_link, "active"), remove_all) + self.assertEqual( + self.has_css_class(choose_all_button, "active"), choose_all + ) + self.assertEqual( + self.has_css_class(remove_all_button, "active"), remove_all + ) def execute_basic_operations(self, mode, field_name): from selenium.webdriver.common.by import By @@ -1274,10 +1278,10 @@ class HorizontalVerticalFilterSeleniumTests(AdminWidgetSeleniumTestCase): from_box = "#id_%s_from" % field_name to_box = "#id_%s_to" % field_name - choose_link = "id_%s_add_link" % field_name - choose_all_link = "id_%s_add_all_link" % field_name - remove_link = "id_%s_remove_link" % field_name - remove_all_link = "id_%s_remove_all_link" % field_name + choose_button = "id_%s_add" % field_name + choose_all_button = "id_%s_add_all" % field_name + remove_button = "id_%s_remove" % field_name + remove_all_button = "id_%s_remove_all" % field_name # Initial positions --------------------------------------------------- self.assertSelectOptions( @@ -1296,7 +1300,7 @@ class HorizontalVerticalFilterSeleniumTests(AdminWidgetSeleniumTestCase): # Click 'Choose all' -------------------------------------------------- if mode == "horizontal": - self.selenium.find_element(By.ID, choose_all_link).click() + self.selenium.find_element(By.ID, choose_all_button).click() elif mode == "vertical": # There 's no 'Choose all' button in vertical mode, so individually # select all options and click 'Choose'. @@ -1304,7 +1308,7 @@ class HorizontalVerticalFilterSeleniumTests(AdminWidgetSeleniumTestCase): By.CSS_SELECTOR, from_box + " > option" ): option.click() - self.selenium.find_element(By.ID, choose_link).click() + self.selenium.find_element(By.ID, choose_button).click() self.assertSelectOptions(from_box, []) self.assertSelectOptions( to_box, @@ -1323,7 +1327,7 @@ class HorizontalVerticalFilterSeleniumTests(AdminWidgetSeleniumTestCase): # Click 'Remove all' -------------------------------------------------- if mode == "horizontal": - self.selenium.find_element(By.ID, remove_all_link).click() + self.selenium.find_element(By.ID, remove_all_button).click() elif mode == "vertical": # There 's no 'Remove all' button in vertical mode, so individually # select all options and click 'Remove'. @@ -1331,7 +1335,7 @@ class HorizontalVerticalFilterSeleniumTests(AdminWidgetSeleniumTestCase): By.CSS_SELECTOR, to_box + " > option" ): option.click() - self.selenium.find_element(By.ID, remove_link).click() + self.selenium.find_element(By.ID, remove_button).click() self.assertSelectOptions( from_box, [ @@ -1364,7 +1368,7 @@ class HorizontalVerticalFilterSeleniumTests(AdminWidgetSeleniumTestCase): self.select_option(from_box, str(self.bob.id)) self.select_option(from_box, str(self.john.id)) self.assertActiveButtons(mode, field_name, True, False, True, False) - self.selenium.find_element(By.ID, choose_link).click() + self.selenium.find_element(By.ID, choose_button).click() self.assertActiveButtons(mode, field_name, False, False, True, True) self.assertSelectOptions( @@ -1399,7 +1403,7 @@ class HorizontalVerticalFilterSeleniumTests(AdminWidgetSeleniumTestCase): self.select_option(to_box, str(self.lisa.id)) self.select_option(to_box, str(self.bob.id)) self.assertActiveButtons(mode, field_name, False, True, True, True) - self.selenium.find_element(By.ID, remove_link).click() + self.selenium.find_element(By.ID, remove_button).click() self.assertActiveButtons(mode, field_name, False, False, True, True) self.assertSelectOptions( @@ -1418,7 +1422,7 @@ class HorizontalVerticalFilterSeleniumTests(AdminWidgetSeleniumTestCase): # Choose some more options -------------------------------------------- self.select_option(from_box, str(self.arthur.id)) self.select_option(from_box, str(self.cliff.id)) - self.selenium.find_element(By.ID, choose_link).click() + self.selenium.find_element(By.ID, choose_button).click() self.assertSelectOptions( from_box, @@ -1445,7 +1449,7 @@ class HorizontalVerticalFilterSeleniumTests(AdminWidgetSeleniumTestCase): # Confirm they're selected after clicking inactive buttons: ticket #26575 self.assertSelectedOptions(from_box, [str(self.peter.id), str(self.lisa.id)]) - self.selenium.find_element(By.ID, remove_link).click() + self.selenium.find_element(By.ID, remove_button).click() self.assertSelectedOptions(from_box, [str(self.peter.id), str(self.lisa.id)]) # Unselect the options ------------------------------------------------ @@ -1458,7 +1462,7 @@ class HorizontalVerticalFilterSeleniumTests(AdminWidgetSeleniumTestCase): # Confirm they're selected after clicking inactive buttons: ticket #26575 self.assertSelectedOptions(to_box, [str(self.jason.id), str(self.john.id)]) - self.selenium.find_element(By.ID, choose_link).click() + self.selenium.find_element(By.ID, choose_button).click() self.assertSelectedOptions(to_box, [str(self.jason.id), str(self.john.id)]) # Unselect the options ------------------------------------------------ @@ -1520,8 +1524,8 @@ class HorizontalVerticalFilterSeleniumTests(AdminWidgetSeleniumTestCase): for field_name in ["students", "alumni"]: from_box = "#id_%s_from" % field_name to_box = "#id_%s_to" % field_name - choose_link = "id_%s_add_link" % field_name - remove_link = "id_%s_remove_link" % field_name + choose_link = "id_%s_add" % field_name + remove_link = "id_%s_remove" % field_name input = self.selenium.find_element(By.ID, "id_%s_input" % field_name) # Initial values. self.assertSelectOptions( From 2e190a48d6ffda4f9f67df3657b835fa6075a25d Mon Sep 17 00:00:00 2001 From: Adam Zapletal Date: Tue, 26 Nov 2024 14:10:39 -0600 Subject: [PATCH 117/132] Added missing backticks to class-based views docs. --- docs/topics/class-based-views/generic-editing.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/topics/class-based-views/generic-editing.txt b/docs/topics/class-based-views/generic-editing.txt index 4310ae9dcc..73d1e2eb8d 100644 --- a/docs/topics/class-based-views/generic-editing.txt +++ b/docs/topics/class-based-views/generic-editing.txt @@ -278,7 +278,7 @@ The above example assumes that if the client supports ``text/html``, that they would prefer it. However, this may not always be true. When requesting a ``.css`` file, many browsers will send the header ``Accept: text/css,*/*;q=0.1``, indicating that they would prefer CSS, but -anything else is fine. This means ``request.accepts("text/html") will be +anything else is fine. This means ``request.accepts("text/html")`` will be ``True``. To determine the correct format, taking into consideration the client's From c635decb00ac957daf81c08541cdc9cf46f6d86d Mon Sep 17 00:00:00 2001 From: Tommy Allen Date: Tue, 26 Nov 2024 15:15:00 -0500 Subject: [PATCH 118/132] Fixed #35942 -- Fixed createsuperuser crash on Python 3.13+ when username is unavailable. Thanks Mariusz Felisiak and Jacob Tyler Walls for reviews. --- django/contrib/auth/management/__init__.py | 10 ++++++---- docs/releases/5.1.4.txt | 3 ++- tests/auth_tests/test_management.py | 7 +++++++ 3 files changed, 15 insertions(+), 5 deletions(-) diff --git a/django/contrib/auth/management/__init__.py b/django/contrib/auth/management/__init__.py index c40f2aa69d..a8639cb258 100644 --- a/django/contrib/auth/management/__init__.py +++ b/django/contrib/auth/management/__init__.py @@ -115,10 +115,12 @@ def get_system_username(): """ try: result = getpass.getuser() - except (ImportError, KeyError): - # KeyError will be raised by os.getpwuid() (called by getuser()) - # if there is no corresponding entry in the /etc/passwd file - # (a very restricted chroot environment, for example). + except (ImportError, KeyError, OSError): + # TODO: Drop ImportError and KeyError when dropping support for PY312. + # KeyError (Python <3.13) or OSError (Python 3.13+) will be raised by + # os.getpwuid() (called by getuser()) if there is no corresponding + # entry in the /etc/passwd file (for example, in a very restricted + # chroot environment). return "" return result diff --git a/docs/releases/5.1.4.txt b/docs/releases/5.1.4.txt index bee40f243e..468bd46381 100644 --- a/docs/releases/5.1.4.txt +++ b/docs/releases/5.1.4.txt @@ -9,4 +9,5 @@ Django 5.1.4 fixes several bugs in 5.1.3. Bugfixes ======== -* ... +* Fixed a crash in ``createsuperuser`` on Python 3.13+ caused by an unhandled + ``OSError`` when the username could not be determined (:ticket:`35942`). diff --git a/tests/auth_tests/test_management.py b/tests/auth_tests/test_management.py index 8dd91cf6ed..9f12e631cc 100644 --- a/tests/auth_tests/test_management.py +++ b/tests/auth_tests/test_management.py @@ -126,6 +126,13 @@ class GetDefaultUsernameTestCase(TestCase): def test_actual_implementation(self): self.assertIsInstance(management.get_system_username(), str) + def test_getuser_raises_exception(self): + # TODO: Drop ImportError and KeyError when dropping support for PY312. + for exc in (ImportError, KeyError, OSError): + with self.subTest(exc=str(exc)): + with mock.patch("getpass.getuser", side_effect=exc): + self.assertEqual(management.get_system_username(), "") + def test_simple(self): management.get_system_username = lambda: "joe" self.assertEqual(management.get_default_username(), "joe") From a5bc0cfd35c50d3446215c0674e60786d9e498d1 Mon Sep 17 00:00:00 2001 From: Jacob Walls Date: Sat, 23 Nov 2024 16:43:38 -0500 Subject: [PATCH 119/132] Refs #33735 -- Captured stderr during ASGITest.test_file_response. --- tests/asgi/tests.py | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/tests/asgi/tests.py b/tests/asgi/tests.py index 658e9d853e..66ec4369d9 100644 --- a/tests/asgi/tests.py +++ b/tests/asgi/tests.py @@ -21,6 +21,7 @@ from django.test import ( modify_settings, override_settings, ) +from django.test.utils import captured_stderr from django.urls import path from django.utils.http import http_date from django.views.decorators.csrf import csrf_exempt @@ -95,7 +96,8 @@ class ASGITest(SimpleTestCase): with open(test_filename, "rb") as test_file: test_file_contents = test_file.read() # Read the response. - response_start = await communicator.receive_output() + with captured_stderr(): + response_start = await communicator.receive_output() self.assertEqual(response_start["type"], "http.response.start") self.assertEqual(response_start["status"], 200) headers = response_start["headers"] From d8eb13f0f88d4462e70af74f4e9c930126e14306 Mon Sep 17 00:00:00 2001 From: Brock Date: Mon, 25 Nov 2024 20:04:24 -0500 Subject: [PATCH 120/132] Fixed #35939 -- Linked documentation of Permission.content_type to the ContentType model. --- docs/ref/contrib/auth.txt | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/ref/contrib/auth.txt b/docs/ref/contrib/auth.txt index 3e1cdfd978..6014a4e78f 100644 --- a/docs/ref/contrib/auth.txt +++ b/docs/ref/contrib/auth.txt @@ -419,8 +419,8 @@ fields: .. attribute:: content_type - Required. A reference to the ``django_content_type`` database table, - which contains a record for each installed model. + Required. A foreign key to the + :class:`~django.contrib.contenttypes.models.ContentType` model. .. attribute:: codename From d4b2e06a67c2e1458305c3eac6c4b2b3e917daf9 Mon Sep 17 00:00:00 2001 From: Jacob Walls Date: Wed, 20 Nov 2024 09:07:11 -0500 Subject: [PATCH 121/132] Fixed #35921 -- Fixed failure when running tests in parallel on postgres. Follow-up to a060a22ee2dde7aa29a5a29120087c4864887325. --- tests/migration_test_data_persistence/tests.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tests/migration_test_data_persistence/tests.py b/tests/migration_test_data_persistence/tests.py index a04259bba1..ca044f310f 100644 --- a/tests/migration_test_data_persistence/tests.py +++ b/tests/migration_test_data_persistence/tests.py @@ -32,7 +32,7 @@ class MigrationDataPersistenceClassSetup(TransactionTestCase): @classmethod def setUpClass(cls): # Simulate another TransactionTestCase having just torn down. - call_command("flush", verbosity=0, interactive=False) + call_command("flush", verbosity=0, interactive=False, allow_cascade=True) super().setUpClass() cls.book = Book.objects.first() From 2544c1585473c1e82dab1274b52052744f97ca72 Mon Sep 17 00:00:00 2001 From: Sarah Boyce <42296566+sarahboyce@users.noreply.github.com> Date: Wed, 27 Nov 2024 14:30:12 +0100 Subject: [PATCH 122/132] Added stub release notes and release date for 5.1.4, 5.0.10, and 4.2.17. --- docs/releases/4.2.17.txt | 8 ++++++++ docs/releases/5.0.10.txt | 8 ++++++++ docs/releases/5.1.4.txt | 5 +++-- docs/releases/index.txt | 2 ++ 4 files changed, 21 insertions(+), 2 deletions(-) create mode 100644 docs/releases/4.2.17.txt create mode 100644 docs/releases/5.0.10.txt diff --git a/docs/releases/4.2.17.txt b/docs/releases/4.2.17.txt new file mode 100644 index 0000000000..5139d7034d --- /dev/null +++ b/docs/releases/4.2.17.txt @@ -0,0 +1,8 @@ +=========================== +Django 4.2.17 release notes +=========================== + +*December 4, 2024* + +Django 4.2.17 fixes one security issue with severity "high" and one security +issue with severity "moderate" in 4.2.16. diff --git a/docs/releases/5.0.10.txt b/docs/releases/5.0.10.txt new file mode 100644 index 0000000000..b06c376038 --- /dev/null +++ b/docs/releases/5.0.10.txt @@ -0,0 +1,8 @@ +=========================== +Django 5.0.10 release notes +=========================== + +*December 4, 2024* + +Django 5.0.10 fixes one security issue with severity "high" and one security +issue with severity "moderate" in 5.0.9. diff --git a/docs/releases/5.1.4.txt b/docs/releases/5.1.4.txt index 468bd46381..0c21d99566 100644 --- a/docs/releases/5.1.4.txt +++ b/docs/releases/5.1.4.txt @@ -2,9 +2,10 @@ Django 5.1.4 release notes ========================== -*Expected December 3, 2024* +*December 4, 2024* -Django 5.1.4 fixes several bugs in 5.1.3. +Django 5.1.4 fixes one security issue with severity "high", one security issue +with severity "moderate", and several bugs in 5.1.3. Bugfixes ======== diff --git a/docs/releases/index.txt b/docs/releases/index.txt index 66cc107c35..536e5917ab 100644 --- a/docs/releases/index.txt +++ b/docs/releases/index.txt @@ -43,6 +43,7 @@ versions of the documentation contain the release notes for any later releases. .. toctree:: :maxdepth: 1 + 5.0.10 5.0.9 5.0.8 5.0.7 @@ -60,6 +61,7 @@ versions of the documentation contain the release notes for any later releases. .. toctree:: :maxdepth: 1 + 4.2.17 4.2.16 4.2.15 4.2.14 From e9ed5da3cb0d037d274e5af42d9f09b70a09ebc2 Mon Sep 17 00:00:00 2001 From: Adam Zapletal Date: Wed, 27 Nov 2024 10:13:28 -0600 Subject: [PATCH 123/132] Removed trailing whitespace in docs. --- docs/internals/contributing/writing-documentation.txt | 2 +- docs/ref/contrib/auth.txt | 2 +- docs/ref/forms/api.txt | 2 +- docs/ref/forms/fields.txt | 2 +- docs/releases/3.1.6.txt | 2 +- docs/releases/5.1.txt | 4 ++-- 6 files changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/internals/contributing/writing-documentation.txt b/docs/internals/contributing/writing-documentation.txt index a8db5d93fd..10b7edbca8 100644 --- a/docs/internals/contributing/writing-documentation.txt +++ b/docs/internals/contributing/writing-documentation.txt @@ -198,7 +198,7 @@ Output is printed to the terminal, but can also be found in The execution of the command requires an internet connection and takes several minutes to complete, because the command tests all the links that are found in the documentation. - + Entries that have a status of "working" are fine, those that are "unchecked" or "ignored" have been skipped because they either cannot be checked or have matched ignore rules in the configuration. diff --git a/docs/ref/contrib/auth.txt b/docs/ref/contrib/auth.txt index 6014a4e78f..7b0de1173f 100644 --- a/docs/ref/contrib/auth.txt +++ b/docs/ref/contrib/auth.txt @@ -679,7 +679,7 @@ The following backends are available in :mod:`django.contrib.auth.backends`: user permissions and group permissions. Returns an empty set if :attr:`~django.contrib.auth.models.AbstractBaseUser.is_anonymous` or :attr:`~django.contrib.auth.models.CustomUser.is_active` is ``False``. - + .. versionchanged:: 5.2 ``aget_all_permissions()`` function was added. diff --git a/docs/ref/forms/api.txt b/docs/ref/forms/api.txt index 9ce16ff2ab..c6c83dcdfb 100644 --- a/docs/ref/forms/api.txt +++ b/docs/ref/forms/api.txt @@ -1416,7 +1416,7 @@ Methods of ``BoundField`` .. method:: BoundField.render(template_name=None, context=None, renderer=None) - The render method is called by ``as_field_group``. All arguments are + The render method is called by ``as_field_group``. All arguments are optional and default to: * ``template_name``: :attr:`.BoundField.template_name` diff --git a/docs/ref/forms/fields.txt b/docs/ref/forms/fields.txt index 6051122617..2b4b344844 100644 --- a/docs/ref/forms/fields.txt +++ b/docs/ref/forms/fields.txt @@ -392,7 +392,7 @@ be ignored in favor of the value from the form's initial data. .. attribute:: Field.template_name The ``template_name`` argument allows a custom template to be used when the -field is rendered with :meth:`~django.forms.BoundField.as_field_group`. By +field is rendered with :meth:`~django.forms.BoundField.as_field_group`. By default this value is set to ``"django/forms/field.html"``. Can be changed per field by overriding this attribute or more generally by overriding the default template, see also :ref:`overriding-built-in-field-templates`. diff --git a/docs/releases/3.1.6.txt b/docs/releases/3.1.6.txt index 027d2f3b16..9805e32579 100644 --- a/docs/releases/3.1.6.txt +++ b/docs/releases/3.1.6.txt @@ -17,5 +17,5 @@ dot segments. Bugfixes ======== -* Fixed an admin layout issue in Django 3.1 where changelist filter controls +* Fixed an admin layout issue in Django 3.1 where changelist filter controls would become squashed (:ticket:`32391`). diff --git a/docs/releases/5.1.txt b/docs/releases/5.1.txt index 037c76fd54..799f3ee819 100644 --- a/docs/releases/5.1.txt +++ b/docs/releases/5.1.txt @@ -116,8 +116,8 @@ Minor features * The default iteration count for the PBKDF2 password hasher is increased from 720,000 to 870,000. -* The default ``parallelism`` of the ``ScryptPasswordHasher`` is - increased from 1 to 5, to follow OWASP recommendations. +* The default ``parallelism`` of the ``ScryptPasswordHasher`` is increased from + 1 to 5, to follow OWASP recommendations. * The new :class:`~django.contrib.auth.forms.AdminUserCreationForm` and the existing :class:`~django.contrib.auth.forms.AdminPasswordChangeForm` now From 73d532d9a92d4d472564f3251499a428d1da9835 Mon Sep 17 00:00:00 2001 From: David Smith <39445562+smithdc1@users.noreply.github.com> Date: Wed, 27 Nov 2024 18:20:49 +0000 Subject: [PATCH 124/132] Upgraded to Python 3.12, Ubuntu 24.04, and enabled fail_on_warning for docs builds. --- .github/workflows/docs.yml | 3 +-- .readthedocs.yml | 5 +++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index f61692ef79..46c2cf8707 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -21,8 +21,7 @@ permissions: jobs: docs: - # OS must be the same as on djangoproject.com. - runs-on: ubuntu-20.04 + runs-on: ubuntu-24.04 name: docs steps: - name: Checkout diff --git a/.readthedocs.yml b/.readthedocs.yml index bde8b64da0..915d51de46 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -4,12 +4,13 @@ version: 2 build: - os: ubuntu-20.04 + os: ubuntu-24.04 tools: - python: "3.8" + python: "3.12" sphinx: configuration: docs/conf.py + fail_on_warning: true python: install: From e9929cb4946ca334668cff85ca72d1cddeaa8b07 Mon Sep 17 00:00:00 2001 From: Clifford Gama <53076065+cliff688@users.noreply.github.com> Date: Wed, 27 Nov 2024 20:26:14 +0200 Subject: [PATCH 125/132] Made reverse() docs more self-contained. --- docs/ref/urlresolvers.txt | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/ref/urlresolvers.txt b/docs/ref/urlresolvers.txt index 3c3be76e75..eca00cf106 100644 --- a/docs/ref/urlresolvers.txt +++ b/docs/ref/urlresolvers.txt @@ -7,8 +7,8 @@ ``reverse()`` ============= -If you need to use something similar to the :ttag:`url` template tag in -your code, Django provides the following function: +The ``reverse()`` function can be used to return an absolute path reference +for a given view and optional parameters, similar to the :ttag:`url` tag: .. function:: reverse(viewname, urlconf=None, args=None, kwargs=None, current_app=None) From 0977ec671a1672ae5a5bb6e4ec4749f7aee7273d Mon Sep 17 00:00:00 2001 From: Paolo Melchiorre Date: Wed, 27 Nov 2024 22:15:25 +0100 Subject: [PATCH 126/132] Added parallelism support via --jobs to docs build Makefile rule. --- docs/Makefile | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/Makefile b/docs/Makefile index 596e7fc2dd..15383bdd38 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -8,6 +8,7 @@ SPHINXBUILD ?= sphinx-build PAPER ?= BUILDDIR ?= _build LANGUAGE ?= +JOBS ?= auto # Set the default language. ifndef LANGUAGE @@ -21,7 +22,7 @@ LANGUAGEOPT = $(firstword $(subst _, ,$(LANGUAGE))) # Internal variables. PAPEROPT_a4 = -D latex_paper_size=a4 PAPEROPT_letter = -D latex_paper_size=letter -ALLSPHINXOPTS = -n -d $(BUILDDIR)/doctrees -D language=$(LANGUAGEOPT) $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . +ALLSPHINXOPTS = -n -d $(BUILDDIR)/doctrees -D language=$(LANGUAGEOPT) --jobs $(JOBS) $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . # the i18n builder cannot share the environment and doctrees with the others I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . From 1636912bf1bacc1da65011c2b26ff48b2c9fad43 Mon Sep 17 00:00:00 2001 From: Adam Zapletal Date: Tue, 12 Nov 2024 08:15:17 -0600 Subject: [PATCH 127/132] Refs #21286 -- Fixed serializer test with primary key TextField. --- tests/serializers/models/data.py | 7 +++++-- tests/serializers/test_data.py | 18 ++++++++++++++---- 2 files changed, 19 insertions(+), 6 deletions(-) diff --git a/tests/serializers/models/data.py b/tests/serializers/models/data.py index bb76bfba48..b82e8b4b33 100644 --- a/tests/serializers/models/data.py +++ b/tests/serializers/models/data.py @@ -242,8 +242,11 @@ class SmallPKData(models.Model): data = models.SmallIntegerField(primary_key=True) -# class TextPKData(models.Model): -# data = models.TextField(primary_key=True) +class TextPKData(models.Model): + data = models.TextField(primary_key=True) + + class Meta: + required_db_features = ["supports_index_on_text_field"] class TimePKData(models.Model): diff --git a/tests/serializers/test_data.py b/tests/serializers/test_data.py index 1f8f38ba0f..808db41634 100644 --- a/tests/serializers/test_data.py +++ b/tests/serializers/test_data.py @@ -68,6 +68,7 @@ from .models import ( SmallPKData, Tag, TextData, + TextPKData, TimeData, TimePKData, UniqueAnchor, @@ -387,10 +388,15 @@ The end.""", (pk_obj, 750, SmallPKData, 12), (pk_obj, 751, SmallPKData, -12), (pk_obj, 752, SmallPKData, 0), - # (pk_obj, 760, TextPKData, """This is a long piece of text. - # It contains line breaks. - # Several of them. - # The end."""), + ( + pk_obj, + 760, + TextPKData, + """This is a long piece of text. + It contains line breaks. + Several of them. + The end.""", + ), (pk_obj, 770, TimePKData, datetime.time(10, 42, 37)), (pk_obj, 791, UUIDData, uuid_obj), (fk_obj, 792, FKToUUID, uuid_obj), @@ -429,6 +435,10 @@ if connection.features.interprets_empty_strings_as_nulls: ] +if not connection.features.supports_index_on_text_field: + test_data = [data for data in test_data if data[2] != TextPKData] + + class SerializerDataTests(TestCase): pass From 1722f2db5808708de6fc6e0f48af2d518be1e348 Mon Sep 17 00:00:00 2001 From: Klaas van Schelven Date: Fri, 8 Nov 2024 09:55:28 +0100 Subject: [PATCH 128/132] Fixed #35897 -- Removed unnecessary escaping in template's get_exception_info(). --- django/template/base.py | 10 +++---- .../templates/test_extends_block_error.html | 2 +- tests/template_tests/tests.py | 27 ++++++++++++++++--- 3 files changed, 30 insertions(+), 9 deletions(-) diff --git a/django/template/base.py b/django/template/base.py index b974495c9c..eaca428b10 100644 --- a/django/template/base.py +++ b/django/template/base.py @@ -57,7 +57,7 @@ from enum import Enum from django.template.context import BaseContext from django.utils.formats import localize -from django.utils.html import conditional_escape, escape +from django.utils.html import conditional_escape from django.utils.regex_helper import _lazy_re_compile from django.utils.safestring import SafeData, SafeString, mark_safe from django.utils.text import get_text_list, smart_split, unescape_string_literal @@ -247,10 +247,10 @@ class Template: for num, next in enumerate(linebreak_iter(self.source)): if start >= upto and end <= next: line = num - before = escape(self.source[upto:start]) - during = escape(self.source[start:end]) - after = escape(self.source[end:next]) - source_lines.append((num, escape(self.source[upto:next]))) + before = self.source[upto:start] + during = self.source[start:end] + after = self.source[end:next] + source_lines.append((num, self.source[upto:next])) upto = next total = len(source_lines) diff --git a/tests/template_tests/templates/test_extends_block_error.html b/tests/template_tests/templates/test_extends_block_error.html index c4733747a2..8133c93ccd 100644 --- a/tests/template_tests/templates/test_extends_block_error.html +++ b/tests/template_tests/templates/test_extends_block_error.html @@ -1,2 +1,2 @@ {% extends "test_extends_block_error_parent.html" %} -{% block content %}{% include "missing.html" %}{% endblock %} +{% block content %}{% include "index.html" %}{% include "missing.html" %}{% include "index.html" %}{% endblock %} diff --git a/tests/template_tests/tests.py b/tests/template_tests/tests.py index 14df81669b..7364c7ca64 100644 --- a/tests/template_tests/tests.py +++ b/tests/template_tests/tests.py @@ -5,7 +5,6 @@ from django.template.base import UNKNOWN_SOURCE from django.test import SimpleTestCase, override_settings from django.urls import NoReverseMatch from django.utils import translation -from django.utils.html import escape class TemplateTestMixin: @@ -158,9 +157,31 @@ class TemplateTestMixin: template.render(context) if self.debug_engine: self.assertEqual( - cm.exception.template_debug["during"], - escape('{% include "missing.html" %}'), + cm.exception.template_debug["before"], + '{% block content %}{% include "index.html" %}', ) + self.assertEqual( + cm.exception.template_debug["during"], + '{% include "missing.html" %}', + ) + self.assertEqual( + cm.exception.template_debug["after"], + '{% include "index.html" %}{% endblock %}\n', + ) + self.assertEqual( + cm.exception.template_debug["source_lines"][0], + (1, '{% extends "test_extends_block_error_parent.html" %}\n'), + ) + self.assertEqual( + cm.exception.template_debug["source_lines"][1], + ( + 2, + '{% block content %}{% include "index.html" %}' + '{% include "missing.html" %}' + '{% include "index.html" %}{% endblock %}\n', + ), + ) + self.assertEqual(cm.exception.template_debug["source_lines"][2], (3, "")) def test_super_errors(self): """ From b92511b47475ce7fa1626d7d8c6180ae84bf0a19 Mon Sep 17 00:00:00 2001 From: Salvo Polizzi Date: Thu, 28 Nov 2024 13:52:25 +0100 Subject: [PATCH 129/132] Refs #35038 -- Added test for drop and recreation of a constraint. --- tests/migrations/test_autodetector.py | 37 +++++++++++++++++++++++++++ 1 file changed, 37 insertions(+) diff --git a/tests/migrations/test_autodetector.py b/tests/migrations/test_autodetector.py index d4345208ca..d93114564a 100644 --- a/tests/migrations/test_autodetector.py +++ b/tests/migrations/test_autodetector.py @@ -2981,6 +2981,43 @@ class AutodetectorTests(BaseAutodetectorTests): changes, "testapp", 0, 0, model_name="author", name="name_contains_bob" ) + def test_constraint_dropped_and_recreated(self): + altered_constraint = models.CheckConstraint( + condition=models.Q(name__contains="bob"), + name="name_contains_bob", + ) + author_name_check_constraint_lowercased = copy.deepcopy( + self.author_name_check_constraint + ) + author_name_check_constraint_lowercased.options = { + "constraints": [altered_constraint] + } + changes = self.get_changes( + [self.author_name_check_constraint], + [author_name_check_constraint_lowercased], + ) + + self.assertNumberMigrations(changes, "testapp", 1) + self.assertOperationTypes( + changes, "testapp", 0, ["RemoveConstraint", "AddConstraint"] + ) + self.assertOperationAttributes( + changes, + "testapp", + 0, + 0, + model_name="author", + name="name_contains_bob", + ) + self.assertOperationAttributes( + changes, + "testapp", + 0, + 1, + model_name="author", + constraint=altered_constraint, + ) + def test_add_unique_together(self): """Tests unique_together detection.""" changes = self.get_changes( From b82f80906a563741e34aecac537b53c19945a44f Mon Sep 17 00:00:00 2001 From: Salvo Polizzi Date: Thu, 28 Nov 2024 13:52:58 +0100 Subject: [PATCH 130/132] Fixed #35038 -- Created AlterConstraint operation. --- django/db/migrations/autodetector.py | 62 ++++++++++++++++- django/db/migrations/operations/__init__.py | 2 + django/db/migrations/operations/models.py | 54 +++++++++++++++ django/db/migrations/state.py | 13 ++++ django/db/models/constraints.py | 2 + docs/ref/migration-operations.txt | 10 +++ docs/releases/5.2.txt | 3 +- tests/migrations/test_autodetector.py | 65 ++++++++++++++++++ tests/migrations/test_operations.py | 75 +++++++++++++++++++++ tests/migrations/test_optimizer.py | 74 ++++++++++++++++++++ 10 files changed, 357 insertions(+), 3 deletions(-) diff --git a/django/db/migrations/autodetector.py b/django/db/migrations/autodetector.py index 353b992258..1dc6377494 100644 --- a/django/db/migrations/autodetector.py +++ b/django/db/migrations/autodetector.py @@ -219,6 +219,7 @@ class MigrationAutodetector: self.generate_altered_unique_together() self.generate_added_indexes() self.generate_added_constraints() + self.generate_altered_constraints() self.generate_altered_db_table() self._sort_migrations() @@ -1450,6 +1451,19 @@ class MigrationAutodetector: ), ) + def _constraint_should_be_dropped_and_recreated( + self, old_constraint, new_constraint + ): + old_path, old_args, old_kwargs = old_constraint.deconstruct() + new_path, new_args, new_kwargs = new_constraint.deconstruct() + + for attr in old_constraint.non_db_attrs: + old_kwargs.pop(attr, None) + for attr in new_constraint.non_db_attrs: + new_kwargs.pop(attr, None) + + return (old_path, old_args, old_kwargs) != (new_path, new_args, new_kwargs) + def create_altered_constraints(self): option_name = operations.AddConstraint.option_name for app_label, model_name in sorted(self.kept_model_keys): @@ -1461,14 +1475,41 @@ class MigrationAutodetector: old_constraints = old_model_state.options[option_name] new_constraints = new_model_state.options[option_name] - add_constraints = [c for c in new_constraints if c not in old_constraints] - rem_constraints = [c for c in old_constraints if c not in new_constraints] + + alt_constraints = [] + alt_constraints_name = [] + + for old_c in old_constraints: + for new_c in new_constraints: + old_c_dec = old_c.deconstruct() + new_c_dec = new_c.deconstruct() + if ( + old_c_dec != new_c_dec + and old_c.name == new_c.name + and not self._constraint_should_be_dropped_and_recreated( + old_c, new_c + ) + ): + alt_constraints.append(new_c) + alt_constraints_name.append(new_c.name) + + add_constraints = [ + c + for c in new_constraints + if c not in old_constraints and c.name not in alt_constraints_name + ] + rem_constraints = [ + c + for c in old_constraints + if c not in new_constraints and c.name not in alt_constraints_name + ] self.altered_constraints.update( { (app_label, model_name): { "added_constraints": add_constraints, "removed_constraints": rem_constraints, + "altered_constraints": alt_constraints, } } ) @@ -1503,6 +1544,23 @@ class MigrationAutodetector: ), ) + def generate_altered_constraints(self): + for ( + app_label, + model_name, + ), alt_constraints in self.altered_constraints.items(): + dependencies = self._get_dependencies_for_model(app_label, model_name) + for constraint in alt_constraints["altered_constraints"]: + self.add_operation( + app_label, + operations.AlterConstraint( + model_name=model_name, + name=constraint.name, + constraint=constraint, + ), + dependencies=dependencies, + ) + @staticmethod def _get_dependencies_for_foreign_key(app_label, model_name, field, project_state): remote_field_model = None diff --git a/django/db/migrations/operations/__init__.py b/django/db/migrations/operations/__init__.py index 90dbdf8256..012f2027d4 100644 --- a/django/db/migrations/operations/__init__.py +++ b/django/db/migrations/operations/__init__.py @@ -2,6 +2,7 @@ from .fields import AddField, AlterField, RemoveField, RenameField from .models import ( AddConstraint, AddIndex, + AlterConstraint, AlterIndexTogether, AlterModelManagers, AlterModelOptions, @@ -36,6 +37,7 @@ __all__ = [ "RenameField", "AddConstraint", "RemoveConstraint", + "AlterConstraint", "SeparateDatabaseAndState", "RunSQL", "RunPython", diff --git a/django/db/migrations/operations/models.py b/django/db/migrations/operations/models.py index 2469d01efb..40526b94c3 100644 --- a/django/db/migrations/operations/models.py +++ b/django/db/migrations/operations/models.py @@ -1230,6 +1230,12 @@ class AddConstraint(IndexOperation): and self.constraint.name == operation.name ): return [] + if ( + isinstance(operation, AlterConstraint) + and self.model_name_lower == operation.model_name_lower + and self.constraint.name == operation.name + ): + return [AddConstraint(self.model_name, operation.constraint)] return super().reduce(operation, app_label) @@ -1274,3 +1280,51 @@ class RemoveConstraint(IndexOperation): @property def migration_name_fragment(self): return "remove_%s_%s" % (self.model_name_lower, self.name.lower()) + + +class AlterConstraint(IndexOperation): + category = OperationCategory.ALTERATION + option_name = "constraints" + + def __init__(self, model_name, name, constraint): + self.model_name = model_name + self.name = name + self.constraint = constraint + + def state_forwards(self, app_label, state): + state.alter_constraint( + app_label, self.model_name_lower, self.name, self.constraint + ) + + def database_forwards(self, app_label, schema_editor, from_state, to_state): + pass + + def database_backwards(self, app_label, schema_editor, from_state, to_state): + pass + + def deconstruct(self): + return ( + self.__class__.__name__, + [], + { + "model_name": self.model_name, + "name": self.name, + "constraint": self.constraint, + }, + ) + + def describe(self): + return f"Alter constraint {self.name} on {self.model_name}" + + @property + def migration_name_fragment(self): + return "alter_%s_%s" % (self.model_name_lower, self.constraint.name.lower()) + + def reduce(self, operation, app_label): + if ( + isinstance(operation, (AlterConstraint, RemoveConstraint)) + and self.model_name_lower == operation.model_name_lower + and self.name == operation.name + ): + return [operation] + return super().reduce(operation, app_label) diff --git a/django/db/migrations/state.py b/django/db/migrations/state.py index e13de5ba6f..f3b70196db 100644 --- a/django/db/migrations/state.py +++ b/django/db/migrations/state.py @@ -211,6 +211,14 @@ class ProjectState: model_state.options[option_name] = [obj for obj in objs if obj.name != obj_name] self.reload_model(app_label, model_name, delay=True) + def _alter_option(self, app_label, model_name, option_name, obj_name, alt_obj): + model_state = self.models[app_label, model_name] + objs = model_state.options[option_name] + model_state.options[option_name] = [ + obj if obj.name != obj_name else alt_obj for obj in objs + ] + self.reload_model(app_label, model_name, delay=True) + def add_index(self, app_label, model_name, index): self._append_option(app_label, model_name, "indexes", index) @@ -237,6 +245,11 @@ class ProjectState: def remove_constraint(self, app_label, model_name, constraint_name): self._remove_option(app_label, model_name, "constraints", constraint_name) + def alter_constraint(self, app_label, model_name, constraint_name, constraint): + self._alter_option( + app_label, model_name, "constraints", constraint_name, constraint + ) + def add_field(self, app_label, model_name, name, field, preserve_default): # If preserve default is off, don't use the default for future state. if not preserve_default: diff --git a/django/db/models/constraints.py b/django/db/models/constraints.py index 788e2b635b..00829aee28 100644 --- a/django/db/models/constraints.py +++ b/django/db/models/constraints.py @@ -23,6 +23,8 @@ class BaseConstraint: violation_error_code = None violation_error_message = None + non_db_attrs = ("violation_error_code", "violation_error_message") + # RemovedInDjango60Warning: When the deprecation ends, replace with: # def __init__( # self, *, name, violation_error_code=None, violation_error_message=None diff --git a/docs/ref/migration-operations.txt b/docs/ref/migration-operations.txt index 9e90b78623..b969b3dbfd 100644 --- a/docs/ref/migration-operations.txt +++ b/docs/ref/migration-operations.txt @@ -278,6 +278,16 @@ the model with ``model_name``. Removes the constraint named ``name`` from the model with ``model_name``. +``AlterConstraint`` +------------------- + +.. versionadded:: 5.2 + +.. class:: AlterConstraint(model_name, name, constraint) + +Alters the constraint named ``name`` of the model with ``model_name`` with the +new ``constraint`` without affecting the database. + Special Operations ================== diff --git a/docs/releases/5.2.txt b/docs/releases/5.2.txt index f1ffe07569..2ec90429d0 100644 --- a/docs/releases/5.2.txt +++ b/docs/releases/5.2.txt @@ -259,7 +259,8 @@ Management Commands Migrations ~~~~~~~~~~ -* ... +* The new operation :class:`.AlterConstraint` is a no-op operation that alters + constraints without dropping and recreating constraints in the database. Models ~~~~~~ diff --git a/tests/migrations/test_autodetector.py b/tests/migrations/test_autodetector.py index d93114564a..de62170eb3 100644 --- a/tests/migrations/test_autodetector.py +++ b/tests/migrations/test_autodetector.py @@ -2969,6 +2969,71 @@ class AutodetectorTests(BaseAutodetectorTests): ["CreateModel", "AddField", "AddIndex"], ) + def test_alter_constraint(self): + book_constraint = models.CheckConstraint( + condition=models.Q(title__contains="title"), + name="title_contains_title", + ) + book_altered_constraint = models.CheckConstraint( + condition=models.Q(title__contains="title"), + name="title_contains_title", + violation_error_code="error_code", + ) + author_altered_constraint = models.CheckConstraint( + condition=models.Q(name__contains="Bob"), + name="name_contains_bob", + violation_error_message="Name doesn't contain Bob", + ) + + book_check_constraint = copy.deepcopy(self.book) + book_check_constraint_with_error_message = copy.deepcopy(self.book) + author_name_check_constraint_with_error_message = copy.deepcopy( + self.author_name_check_constraint + ) + + book_check_constraint.options = {"constraints": [book_constraint]} + book_check_constraint_with_error_message.options = { + "constraints": [book_altered_constraint] + } + author_name_check_constraint_with_error_message.options = { + "constraints": [author_altered_constraint] + } + + changes = self.get_changes( + [self.author_name_check_constraint, book_check_constraint], + [ + author_name_check_constraint_with_error_message, + book_check_constraint_with_error_message, + ], + ) + + self.assertNumberMigrations(changes, "testapp", 1) + self.assertOperationTypes(changes, "testapp", 0, ["AlterConstraint"]) + self.assertOperationAttributes( + changes, + "testapp", + 0, + 0, + model_name="author", + name="name_contains_bob", + constraint=author_altered_constraint, + ) + + self.assertNumberMigrations(changes, "otherapp", 1) + self.assertOperationTypes(changes, "otherapp", 0, ["AlterConstraint"]) + self.assertOperationAttributes( + changes, + "otherapp", + 0, + 0, + model_name="book", + name="title_contains_title", + constraint=book_altered_constraint, + ) + self.assertMigrationDependencies( + changes, "otherapp", 0, [("testapp", "auto_1")] + ) + def test_remove_constraints(self): """Test change detection of removed constraints.""" changes = self.get_changes( diff --git a/tests/migrations/test_operations.py b/tests/migrations/test_operations.py index 3ac813b899..da0ec93dcd 100644 --- a/tests/migrations/test_operations.py +++ b/tests/migrations/test_operations.py @@ -4366,6 +4366,81 @@ class OperationTests(OperationTestBase): {"model_name": "Pony", "name": "test_remove_constraint_pony_pink_gt_2"}, ) + def test_alter_constraint(self): + constraint = models.UniqueConstraint( + fields=["pink"], name="test_alter_constraint_pony_fields_uq" + ) + project_state = self.set_up_test_model( + "test_alterconstraint", constraints=[constraint] + ) + + new_state = project_state.clone() + violation_error_message = "Pink isn't unique" + uq_constraint = models.UniqueConstraint( + fields=["pink"], + name="test_alter_constraint_pony_fields_uq", + violation_error_message=violation_error_message, + ) + uq_operation = migrations.AlterConstraint( + "Pony", "test_alter_constraint_pony_fields_uq", uq_constraint + ) + self.assertEqual( + uq_operation.describe(), + "Alter constraint test_alter_constraint_pony_fields_uq on Pony", + ) + self.assertEqual( + uq_operation.formatted_description(), + "~ Alter constraint test_alter_constraint_pony_fields_uq on Pony", + ) + self.assertEqual( + uq_operation.migration_name_fragment, + "alter_pony_test_alter_constraint_pony_fields_uq", + ) + + uq_operation.state_forwards("test_alterconstraint", new_state) + self.assertEqual( + project_state.models["test_alterconstraint", "pony"] + .options["constraints"][0] + .violation_error_message, + "Constraint “%(name)s” is violated.", + ) + self.assertEqual( + new_state.models["test_alterconstraint", "pony"] + .options["constraints"][0] + .violation_error_message, + violation_error_message, + ) + + with connection.schema_editor() as editor, self.assertNumQueries(0): + uq_operation.database_forwards( + "test_alterconstraint", editor, project_state, new_state + ) + self.assertConstraintExists( + "test_alterconstraint_pony", + "test_alter_constraint_pony_fields_uq", + value=False, + ) + with connection.schema_editor() as editor, self.assertNumQueries(0): + uq_operation.database_backwards( + "test_alterconstraint", editor, project_state, new_state + ) + self.assertConstraintExists( + "test_alterconstraint_pony", + "test_alter_constraint_pony_fields_uq", + value=False, + ) + definition = uq_operation.deconstruct() + self.assertEqual(definition[0], "AlterConstraint") + self.assertEqual(definition[1], []) + self.assertEqual( + definition[2], + { + "model_name": "Pony", + "name": "test_alter_constraint_pony_fields_uq", + "constraint": uq_constraint, + }, + ) + def test_add_partial_unique_constraint(self): project_state = self.set_up_test_model("test_addpartialuniqueconstraint") partial_unique_constraint = models.UniqueConstraint( diff --git a/tests/migrations/test_optimizer.py b/tests/migrations/test_optimizer.py index 0a40b50edc..a871e67a45 100644 --- a/tests/migrations/test_optimizer.py +++ b/tests/migrations/test_optimizer.py @@ -1232,6 +1232,80 @@ class OptimizerTests(OptimizerTestBase): ], ) + def test_multiple_alter_constraints(self): + gt_constraint_violation_msg_added = models.CheckConstraint( + condition=models.Q(pink__gt=2), + name="pink_gt_2", + violation_error_message="ERROR", + ) + gt_constraint_violation_msg_altered = models.CheckConstraint( + condition=models.Q(pink__gt=2), + name="pink_gt_2", + violation_error_message="error", + ) + self.assertOptimizesTo( + [ + migrations.AlterConstraint( + "Pony", "pink_gt_2", gt_constraint_violation_msg_added + ), + migrations.AlterConstraint( + "Pony", "pink_gt_2", gt_constraint_violation_msg_altered + ), + ], + [ + migrations.AlterConstraint( + "Pony", "pink_gt_2", gt_constraint_violation_msg_altered + ) + ], + ) + other_constraint_violation_msg = models.CheckConstraint( + condition=models.Q(weight__gt=3), + name="pink_gt_3", + violation_error_message="error", + ) + self.assertDoesNotOptimize( + [ + migrations.AlterConstraint( + "Pony", "pink_gt_2", gt_constraint_violation_msg_added + ), + migrations.AlterConstraint( + "Pony", "pink_gt_3", other_constraint_violation_msg + ), + ] + ) + + def test_alter_remove_constraint(self): + self.assertOptimizesTo( + [ + migrations.AlterConstraint( + "Pony", + "pink_gt_2", + models.CheckConstraint( + condition=models.Q(pink__gt=2), name="pink_gt_2" + ), + ), + migrations.RemoveConstraint("Pony", "pink_gt_2"), + ], + [migrations.RemoveConstraint("Pony", "pink_gt_2")], + ) + + def test_add_alter_constraint(self): + constraint = models.CheckConstraint( + condition=models.Q(pink__gt=2), name="pink_gt_2" + ) + constraint_with_error = models.CheckConstraint( + condition=models.Q(pink__gt=2), + name="pink_gt_2", + violation_error_message="error", + ) + self.assertOptimizesTo( + [ + migrations.AddConstraint("Pony", constraint), + migrations.AlterConstraint("Pony", "pink_gt_2", constraint_with_error), + ], + [migrations.AddConstraint("Pony", constraint_with_error)], + ) + def test_create_model_add_index(self): self.assertOptimizesTo( [ From 28b9b8d6d900feea731d0724b996959a73ff33b5 Mon Sep 17 00:00:00 2001 From: Jaap Roes Date: Thu, 28 Nov 2024 14:41:44 +0100 Subject: [PATCH 131/132] Refs #35530 -- Added basic test cases for auth.login. --- tests/auth_tests/test_login.py | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) create mode 100644 tests/auth_tests/test_login.py diff --git a/tests/auth_tests/test_login.py b/tests/auth_tests/test_login.py new file mode 100644 index 0000000000..607833a095 --- /dev/null +++ b/tests/auth_tests/test_login.py @@ -0,0 +1,25 @@ +from django.contrib import auth +from django.contrib.auth.models import User +from django.http import HttpRequest +from django.test import TestCase + + +class TestLogin(TestCase): + @classmethod + def setUpTestData(cls): + cls.user = User.objects.create_user(username="testuser", password="password") + + def setUp(self): + self.request = HttpRequest() + self.request.session = self.client.session + + def test_user_login(self): + auth.login(self.request, self.user) + self.assertEqual(self.request.session[auth.SESSION_KEY], str(self.user.pk)) + + def test_inactive_user(self): + self.user.is_active = False + self.user.save(update_fields=["is_active"]) + + auth.login(self.request, self.user) + self.assertEqual(self.request.session[auth.SESSION_KEY], str(self.user.pk)) From ceecd518b19044181a3598c55ebed7c2545963cc Mon Sep 17 00:00:00 2001 From: Jaap Roes Date: Thu, 28 Nov 2024 14:42:59 +0100 Subject: [PATCH 132/132] Fixed #35530 -- Deprecated request.user fallback in auth.login and auth.alogin. --- django/contrib/auth/__init__.py | 21 +++++++++++++ docs/internals/deprecation.txt | 4 +++ docs/releases/5.2.txt | 4 +++ tests/async/test_async_auth.py | 54 +++++++++++++++++++++++++++++++-- tests/auth_tests/test_login.py | 49 +++++++++++++++++++++++++++++- 5 files changed, 129 insertions(+), 3 deletions(-) diff --git a/django/contrib/auth/__init__.py b/django/contrib/auth/__init__.py index 689567ca6c..8e359ec7ff 100644 --- a/django/contrib/auth/__init__.py +++ b/django/contrib/auth/__init__.py @@ -1,11 +1,13 @@ import inspect import re +import warnings from django.apps import apps as django_apps from django.conf import settings from django.core.exceptions import ImproperlyConfigured, PermissionDenied from django.middleware.csrf import rotate_token from django.utils.crypto import constant_time_compare +from django.utils.deprecation import RemovedInDjango61Warning from django.utils.module_loading import import_string from django.views.decorators.debug import sensitive_variables @@ -154,9 +156,19 @@ def login(request, user, backend=None): have to reauthenticate on every request. Note that data set during the anonymous session is retained when the user logs in. """ + # RemovedInDjango61Warning: When the deprecation ends, replace with: + # session_auth_hash = user.get_session_auth_hash() session_auth_hash = "" + # RemovedInDjango61Warning. if user is None: user = request.user + warnings.warn( + "Fallback to request.user when user is None will be removed.", + RemovedInDjango61Warning, + stacklevel=2, + ) + + # RemovedInDjango61Warning. if hasattr(user, "get_session_auth_hash"): session_auth_hash = user.get_session_auth_hash() @@ -187,9 +199,18 @@ def login(request, user, backend=None): async def alogin(request, user, backend=None): """See login().""" + # RemovedInDjango61Warning: When the deprecation ends, replace with: + # session_auth_hash = user.get_session_auth_hash() session_auth_hash = "" + # RemovedInDjango61Warning. if user is None: + warnings.warn( + "Fallback to request.user when user is None will be removed.", + RemovedInDjango61Warning, + stacklevel=2, + ) user = await request.auser() + # RemovedInDjango61Warning. if hasattr(user, "get_session_auth_hash"): session_auth_hash = user.get_session_auth_hash() diff --git a/docs/internals/deprecation.txt b/docs/internals/deprecation.txt index 85ad0d400f..171d9ecbe3 100644 --- a/docs/internals/deprecation.txt +++ b/docs/internals/deprecation.txt @@ -18,6 +18,10 @@ details on these changes. * The ``all`` keyword argument of ``django.contrib.staticfiles.finders.find()`` will be removed. +* The fallback to ``request.user`` when ``user`` is ``None`` in + ``django.contrib.auth.login()`` and ``django.contrib.auth.alogin()`` will be + removed. + .. _deprecation-removed-in-6.0: 6.0 diff --git a/docs/releases/5.2.txt b/docs/releases/5.2.txt index 2ec90429d0..7af0b955f6 100644 --- a/docs/releases/5.2.txt +++ b/docs/releases/5.2.txt @@ -443,3 +443,7 @@ Miscellaneous * The ``all`` argument for the ``django.contrib.staticfiles.finders.find()`` function is deprecated in favor of the ``find_all`` argument. + +* The fallback to ``request.user`` when ``user`` is ``None`` in + ``django.contrib.auth.login()`` and ``django.contrib.auth.alogin()`` will be + removed. diff --git a/tests/async/test_async_auth.py b/tests/async/test_async_auth.py index 37884d13a6..3d5a6b678d 100644 --- a/tests/async/test_async_auth.py +++ b/tests/async/test_async_auth.py @@ -8,6 +8,7 @@ from django.contrib.auth import ( from django.contrib.auth.models import AnonymousUser, User from django.http import HttpRequest from django.test import TestCase, override_settings +from django.utils.deprecation import RemovedInDjango61Warning class AsyncAuthTest(TestCase): @@ -60,7 +61,52 @@ class AsyncAuthTest(TestCase): self.assertIsInstance(user, User) self.assertEqual(user.username, second_user.username) - async def test_alogin_without_user(self): + # RemovedInDjango61Warning: When the deprecation ends, replace with: + # async def test_alogin_without_user(self): + async def test_alogin_without_user_no_request_user(self): + request = HttpRequest() + request.session = await self.client.asession() + # RemovedInDjango61Warning: When the deprecation ends, replace with: + # with self.assertRaisesMessage( + # AttributeError, + # "'NoneType' object has no attribute 'get_session_auth_hash'", + # ): + # await alogin(request, None) + with ( + self.assertRaisesMessage( + AttributeError, + "'HttpRequest' object has no attribute 'auser'", + ), + self.assertWarnsMessage( + RemovedInDjango61Warning, + "Fallback to request.user when user is None will be removed.", + ), + ): + await alogin(request, None) + + # RemovedInDjango61Warning: When the deprecation ends, remove completely. + async def test_alogin_without_user_anonymous_request(self): + async def auser(): + return AnonymousUser() + + request = HttpRequest() + request.user = AnonymousUser() + request.auser = auser + request.session = await self.client.asession() + with ( + self.assertRaisesMessage( + AttributeError, + "'AnonymousUser' object has no attribute '_meta'", + ), + self.assertWarnsMessage( + RemovedInDjango61Warning, + "Fallback to request.user when user is None will be removed.", + ), + ): + await alogin(request, None) + + # RemovedInDjango61Warning: When the deprecation ends, remove completely. + async def test_alogin_without_user_authenticated_request(self): async def auser(): return self.test_user @@ -68,7 +114,11 @@ class AsyncAuthTest(TestCase): request.user = self.test_user request.auser = auser request.session = await self.client.asession() - await alogin(request, None) + with self.assertWarnsMessage( + RemovedInDjango61Warning, + "Fallback to request.user when user is None will be removed.", + ): + await alogin(request, None) user = await aget_user(request) self.assertIsInstance(user, User) self.assertEqual(user.username, self.test_user.username) diff --git a/tests/auth_tests/test_login.py b/tests/auth_tests/test_login.py index 607833a095..2c0c1c5796 100644 --- a/tests/auth_tests/test_login.py +++ b/tests/auth_tests/test_login.py @@ -1,7 +1,8 @@ from django.contrib import auth -from django.contrib.auth.models import User +from django.contrib.auth.models import AnonymousUser, User from django.http import HttpRequest from django.test import TestCase +from django.utils.deprecation import RemovedInDjango61Warning class TestLogin(TestCase): @@ -23,3 +24,49 @@ class TestLogin(TestCase): auth.login(self.request, self.user) self.assertEqual(self.request.session[auth.SESSION_KEY], str(self.user.pk)) + + # RemovedInDjango61Warning: When the deprecation ends, replace with: + # def test_without_user(self): + def test_without_user_no_request_user(self): + # RemovedInDjango61Warning: When the deprecation ends, replace with: + # with self.assertRaisesMessage( + # AttributeError, + # "'NoneType' object has no attribute 'get_session_auth_hash'", + # ): + # auth.login(self.request, None) + with ( + self.assertRaisesMessage( + AttributeError, + "'HttpRequest' object has no attribute 'user'", + ), + self.assertWarnsMessage( + RemovedInDjango61Warning, + "Fallback to request.user when user is None will be removed.", + ), + ): + auth.login(self.request, None) + + # RemovedInDjango61Warning: When the deprecation ends, remove completely. + def test_without_user_anonymous_request(self): + self.request.user = AnonymousUser() + with ( + self.assertRaisesMessage( + AttributeError, + "'AnonymousUser' object has no attribute '_meta'", + ), + self.assertWarnsMessage( + RemovedInDjango61Warning, + "Fallback to request.user when user is None will be removed.", + ), + ): + auth.login(self.request, None) + + # RemovedInDjango61Warning: When the deprecation ends, remove completely. + def test_without_user_authenticated_request(self): + self.request.user = self.user + self.assertNotIn(auth.SESSION_KEY, self.request.session) + + msg = "Fallback to request.user when user is None will be removed." + with self.assertWarnsMessage(RemovedInDjango61Warning, msg): + auth.login(self.request, None) + self.assertEqual(self.request.session[auth.SESSION_KEY], str(self.user.pk))