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 f99ef218aa..5e6038fb31 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: @@ -35,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 @@ -61,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 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('
' + options.deleteText + "
"); + row.children(":last").append('
' + options.deleteText + "
"); } 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/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 %} 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/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/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/django/contrib/gis/db/backends/mysql/operations.py b/django/contrib/gis/db/backends/mysql/operations.py index 1004cfb564..5c02d5e5a7 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,10 @@ 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"] + else: + operators["covers"] = SpatialOperator(func="MBRCovers") return operators @cached_property @@ -68,7 +73,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) @@ -102,7 +110,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/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/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/django/contrib/postgres/operations.py b/django/contrib/postgres/operations.py index 1ee5fbc2e2..84360febf9 100644 --- a/django/contrib/postgres/operations.py +++ b/django/contrib/postgres/operations.py @@ -237,6 +237,11 @@ class CreateCollation(CollationOperation): def migration_name_fragment(self): return "create_collation_%s" % self.name.lower() + def reduce(self, operation, app_label): + if isinstance(operation, RemoveCollation) and self.name == operation.name: + return [] + return super().reduce(operation, app_label) + class RemoveCollation(CollationOperation): """Remove a collation.""" 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 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) ] 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/exceptions.py b/django/core/exceptions.py index 31c18ee7e1..7a02aa19df 100644 --- a/django/core/exceptions.py +++ b/django/core/exceptions.py @@ -1,5 +1,5 @@ """ -Global Django exception and warning classes. +Global Django exception classes. """ import operator 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/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/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/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/django/db/models/constraints.py b/django/db/models/constraints.py index 3859a60e2f..788e2b635b 100644 --- a/django/db/models/constraints.py +++ b/django/db/models/constraints.py @@ -690,11 +690,19 @@ class UniqueConstraint(BaseConstraint): queryset = queryset.exclude(pk=model_class_pk) if not self.condition: if queryset.exists(): - if self.fields: - # When fields are defined, use the unique_error_message() for - # backward compatibility. + if ( + self.fields + and self.violation_error_message + == self.default_violation_error_message + ): + # When fields are defined, use the unique_error_message() as + # a default for backward compatibility. + validation_error_message = instance.unique_error_message( + model, self.fields + ) raise ValidationError( - instance.unique_error_message(model, self.fields), + validation_error_message, + code=validation_error_message.code, ) raise ValidationError( self.get_violation_error_message(), 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/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/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/django/template/base.py b/django/template/base.py index ee2e145c04..b974495c9c 100644 --- a/django/template/base.py +++ b/django/template/base.py @@ -533,9 +533,13 @@ class Parser: def extend_nodelist(self, nodelist, node, token): # Check that non-text nodes don't appear before an extends tag. if node.must_be_first and nodelist.contains_nontext: + if self.origin.template_name: + origin = repr(self.origin.template_name) + else: + origin = "the template" raise self.error( token, - "%r must be the first tag in the template." % node, + "{%% %s %%} must be the first tag in %s." % (token.contents, origin), ) if not isinstance(node, TextNode): nodelist.contains_nontext = True 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/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/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() 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 %}

    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 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 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 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/ 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:: 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: 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: 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 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/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``. 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 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:: 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/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 diff --git a/docs/intro/tutorial01.txt b/docs/intro/tutorial01.txt index 041da0a404..c5ac5a1107 100644 --- a/docs/intro/tutorial01.txt +++ b/docs/intro/tutorial01.txt @@ -293,7 +293,8 @@ app will still work. .. admonition:: When to use :func:`~django.urls.include()` You should always use ``include()`` when you include other URL patterns. - ``admin.site.urls`` is the only exception to this. + The only exception is ``admin.site.urls``, which is a pre-built URLconf + provided by Django for the default admin site. You have now wired an ``index`` view into the URLconf. Verify it's working with the following command: 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/ref/contrib/admin/index.txt b/docs/ref/contrib/admin/index.txt index 407dd88e71..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 @@ -1465,6 +1466,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 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. 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/ref/contrib/gis/db-api.txt b/docs/ref/contrib/gis/db-api.txt index bce6f2efcc..e33d9a514f 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 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 (≥ 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 +: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: @@ -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/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/ref/contrib/gis/geoquerysets.txt b/docs/ref/contrib/gis/geoquerysets.txt index b639c5271e..19411b7304 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,16 +197,22 @@ 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`` ---------- *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]_ @@ -220,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`` @@ -364,8 +375,8 @@ Example:: ``isvalid`` ----------- -*Availability*: MySQL, `PostGIS `__, -Oracle, SpatiaLite +*Availability*: MariaDB, MySQL, +`PostGIS `__, Oracle, SpatiaLite Tests if the geometry is valid. @@ -373,12 +384,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 @@ -870,8 +885,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` @@ -883,6 +898,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/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 diff --git a/docs/ref/forms/api.txt b/docs/ref/forms/api.txt index 33d0806859..9ce16ff2ab 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 @@ -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 @@ -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()) diff --git a/docs/ref/models/constraints.txt b/docs/ref/models/constraints.txt index 7dfc3b7d28..c1f140c265 100644 --- a/docs/ref/models/constraints.txt +++ b/docs/ref/models/constraints.txt @@ -282,27 +282,47 @@ PostgreSQL 15+. .. attribute:: UniqueConstraint.violation_error_code -The error code used when ``ValidationError`` is raised during -:ref:`model validation `. Defaults to ``None``. +The error code used when a ``ValidationError`` is raised during +:ref:`model validation `. -This code is *not used* for :class:`UniqueConstraint`\s with -:attr:`~UniqueConstraint.fields` and without a -:attr:`~UniqueConstraint.condition`. Such :class:`~UniqueConstraint`\s have the -same error code as constraints defined with :attr:`.Field.unique` or in -:attr:`Meta.unique_together `. +Defaults to :attr:`.BaseConstraint.violation_error_code`, when either +:attr:`.UniqueConstraint.condition` is set or :attr:`.UniqueConstraint.fields` +is not set. + +If :attr:`.UniqueConstraint.fields` is set without a +:attr:`.UniqueConstraint.condition`, defaults to the :attr:`Meta.unique_together +` error code when there are multiple +fields, and to the :attr:`.Field.unique` error code when there is a single +field. + +.. versionchanged:: 5.2 + + In older versions, the provided + :attr:`.UniqueConstraint.violation_error_code` was not used when + :attr:`.UniqueConstraint.fields` was set without a + :attr:`.UniqueConstraint.condition`. ``violation_error_message`` --------------------------- .. attribute:: UniqueConstraint.violation_error_message -The error message used when ``ValidationError`` is raised during -:ref:`model validation `. Defaults to -:attr:`.BaseConstraint.violation_error_message`. +The error message used when a ``ValidationError`` is raised during +:ref:`model validation `. -This message is *not used* for :class:`UniqueConstraint`\s with -:attr:`~UniqueConstraint.fields` and without a -:attr:`~UniqueConstraint.condition`. Such :class:`~UniqueConstraint`\s show the -same message as constraints defined with -:attr:`.Field.unique` or in -:attr:`Meta.unique_together `. +Defaults to :attr:`.BaseConstraint.violation_error_message`, when either +:attr:`.UniqueConstraint.condition` is set or :attr:`.UniqueConstraint.fields` +is not set. + +If :attr:`.UniqueConstraint.fields` is set without a +:attr:`.UniqueConstraint.condition`, defaults to the :attr:`Meta.unique_together +` error message when there are +multiple fields, and to the :attr:`.Field.unique` error message when there is a +single field. + +.. versionchanged:: 5.2 + + In older versions, the provided + :attr:`.UniqueConstraint.violation_error_message` was not used when + :attr:`.UniqueConstraint.fields` was set without a + :attr:`.UniqueConstraint.condition`. diff --git a/docs/ref/models/fields.txt b/docs/ref/models/fields.txt index 899947c17f..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: @@ -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`` ------------ @@ -1628,80 +1633,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 +1664,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 +2216,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 =================== 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/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/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? 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/docs/releases/5.1.3.txt b/docs/releases/5.1.3.txt index 5541a8824a..2ef34bfc8a 100644 --- a/docs/releases/5.1.3.txt +++ b/docs/releases/5.1.3.txt @@ -10,4 +10,13 @@ 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`). + +* 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/docs/releases/5.2.txt b/docs/releases/5.2.txt index 9aa232b902..96007887bc 100644 --- a/docs/releases/5.2.txt +++ b/docs/releases/5.2.txt @@ -52,29 +52,29 @@ Minor features * The default iteration count for the PBKDF2 password hasher is increased from 870,000 to 1,000,000. -* The following new asynchronous methods on are now provided, using an ``a`` +* The following new asynchronous methods are now provided, using an ``a`` prefix: * :meth:`.UserManager.acreate_user` * :meth:`.UserManager.acreate_superuser` * :meth:`.BaseUserManager.aget_by_natural_key` - * :meth:`.User.aget_user_permissions()` - * :meth:`.User.aget_all_permissions()` - * :meth:`.User.aget_group_permissions()` - * :meth:`.User.ahas_perm()` - * :meth:`.User.ahas_perms()` - * :meth:`.User.ahas_module_perms()` - * :meth:`.User.aget_user_permissions()` - * :meth:`.User.aget_group_permissions()` - * :meth:`.User.ahas_perm()` - * :meth:`.ModelBackend.aauthenticate()` - * :meth:`.ModelBackend.aget_user_permissions()` - * :meth:`.ModelBackend.aget_group_permissions()` - * :meth:`.ModelBackend.aget_all_permissions()` - * :meth:`.ModelBackend.ahas_perm()` - * :meth:`.ModelBackend.ahas_module_perms()` - * :meth:`.RemoteUserBackend.aauthenticate()` - * :meth:`.RemoteUserBackend.aconfigure_user()` + * :meth:`.User.aget_user_permissions` + * :meth:`.User.aget_all_permissions` + * :meth:`.User.aget_group_permissions` + * :meth:`.User.ahas_perm` + * :meth:`.User.ahas_perms` + * :meth:`.User.ahas_module_perms` + * :meth:`.User.aget_user_permissions` + * :meth:`.User.aget_group_permissions` + * :meth:`.User.ahas_perm` + * :meth:`.ModelBackend.aauthenticate` + * :meth:`.ModelBackend.aget_user_permissions` + * :meth:`.ModelBackend.aget_group_permissions` + * :meth:`.ModelBackend.aget_all_permissions` + * :meth:`.ModelBackend.ahas_perm` + * :meth:`.ModelBackend.ahas_module_perms` + * :meth:`.RemoteUserBackend.aauthenticate` + * :meth:`.RemoteUserBackend.aconfigure_user` * Auth backends can now provide async implementations which are used when calling async auth functions (e.g. @@ -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` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -90,7 +94,19 @@ 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. + +* :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 + :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` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -230,6 +246,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 ~~~~~~~~~~ @@ -257,9 +277,15 @@ 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 ~~~~~~~~~~~~~~~~~~~~~~ +* 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. @@ -358,6 +384,11 @@ Miscellaneous * ``HttpRequest.accepted_types`` is now sorted by the client's preference, based on the request's ``Accept`` header. +* :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`. + * The :func:`~django.template.context_processors.debug` context processor is no longer included in the default project template. 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 diff --git a/docs/topics/auth/passwords.txt b/docs/topics/auth/passwords.txt index 68f5453d54..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,6 +602,19 @@ 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."``. + .. class:: UserAttributeSimilarityValidator(user_attributes=DEFAULT_USER_ATTRIBUTES, max_similarity=0.7) Validates that the password is sufficiently different from certain @@ -617,6 +632,18 @@ 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."``. + .. class:: CommonPasswordValidator(password_list_path=DEFAULT_PASSWORD_LIST_PATH) Validates that the password is not a common password. This converts the @@ -628,10 +655,34 @@ 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."``. + .. 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."``. + Integrating validation ---------------------- 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. 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 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 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 ) @@ -3603,7 +3614,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 +8277,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 +8289,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 +8297,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 +8343,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 +8361,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_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 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): 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/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/constraints/models.py b/tests/constraints/models.py index 829f671cdd..95a29ffa4d 100644 --- a/tests/constraints/models.py +++ b/tests/constraints/models.py @@ -72,15 +72,13 @@ class GeneratedFieldVirtualProduct(models.Model): class UniqueConstraintProduct(models.Model): name = models.CharField(max_length=255) color = models.CharField(max_length=32, null=True) + age = models.IntegerField(null=True) class Meta: constraints = [ models.UniqueConstraint( fields=["name", "color"], name="name_color_uniq", - # Custom message and error code are ignored. - violation_error_code="custom_code", - violation_error_message="Custom message", ) ] diff --git a/tests/constraints/tests.py b/tests/constraints/tests.py index e1c431956f..9047710098 100644 --- a/tests/constraints/tests.py +++ b/tests/constraints/tests.py @@ -953,6 +953,41 @@ class UniqueConstraintTests(TestCase): ChildUniqueConstraintProduct(name=self.p1.name, color=self.p1.color), ) + def test_validate_unique_custom_code_and_message(self): + product = UniqueConstraintProduct.objects.create( + name="test", color="red", age=42 + ) + code = "custom_code" + message = "Custom message" + multiple_fields_constraint = models.UniqueConstraint( + fields=["color", "age"], + name="color_age_uniq", + violation_error_code=code, + violation_error_message=message, + ) + single_field_constraint = models.UniqueConstraint( + fields=["color"], + name="color_uniq", + violation_error_code=code, + violation_error_message=message, + ) + + with self.assertRaisesMessage(ValidationError, message) as cm: + multiple_fields_constraint.validate( + UniqueConstraintProduct, + UniqueConstraintProduct( + name="new-test", color=product.color, age=product.age + ), + ) + self.assertEqual(cm.exception.code, code) + + with self.assertRaisesMessage(ValidationError, message) as cm: + single_field_constraint.validate( + UniqueConstraintProduct, + UniqueConstraintProduct(name="new-test", color=product.color), + ) + self.assertEqual(cm.exception.code, code) + @skipUnlessDBFeature("supports_table_check_constraints") def test_validate_fields_unattached(self): Product.objects.create(price=42) 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/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) diff --git a/tests/gis_tests/data/geoip2/GeoIP2-City-Test.mmdb b/tests/gis_tests/data/geoip2/GeoIP2-City-Test.mmdb index 3197ef122f..bf3cbe7835 100644 Binary files a/tests/gis_tests/data/geoip2/GeoIP2-City-Test.mmdb and b/tests/gis_tests/data/geoip2/GeoIP2-City-Test.mmdb differ diff --git a/tests/gis_tests/data/geoip2/GeoIP2-Country-Test.mmdb b/tests/gis_tests/data/geoip2/GeoIP2-Country-Test.mmdb index d79c9933bb..a5989654eb 100644 Binary files a/tests/gis_tests/data/geoip2/GeoIP2-Country-Test.mmdb and b/tests/gis_tests/data/geoip2/GeoIP2-Country-Test.mmdb differ diff --git a/tests/gis_tests/data/geoip2/GeoLite2-ASN-Test.mmdb b/tests/gis_tests/data/geoip2/GeoLite2-ASN-Test.mmdb index afa7e956e4..fe2123f9e0 100644 Binary files a/tests/gis_tests/data/geoip2/GeoLite2-ASN-Test.mmdb and b/tests/gis_tests/data/geoip2/GeoLite2-ASN-Test.mmdb differ diff --git a/tests/gis_tests/data/geoip2/GeoLite2-City-Test.mmdb b/tests/gis_tests/data/geoip2/GeoLite2-City-Test.mmdb index 028a6984d9..9eea131c76 100644 Binary files a/tests/gis_tests/data/geoip2/GeoLite2-City-Test.mmdb and b/tests/gis_tests/data/geoip2/GeoLite2-City-Test.mmdb differ diff --git a/tests/gis_tests/data/geoip2/GeoLite2-Country-Test.mmdb b/tests/gis_tests/data/geoip2/GeoLite2-Country-Test.mmdb index a2cbb08316..0233bba39b 100644 Binary files a/tests/gis_tests/data/geoip2/GeoLite2-Country-Test.mmdb and b/tests/gis_tests/data/geoip2/GeoLite2-Country-Test.mmdb differ 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..f2a703b457 --- /dev/null +++ b/tests/gis_tests/data/geoip2/README.md @@ -0,0 +1,28 @@ +# 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 + +# 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 0000000000..5f0d657c84 Binary files /dev/null and b/tests/gis_tests/data/geoip2/dbip-city-lite-test.mmdb differ diff --git a/tests/gis_tests/data/geoip2/dbip-country-lite-test.mmdb b/tests/gis_tests/data/geoip2/dbip-country-lite-test.mmdb new file mode 100644 index 0000000000..8410d1893c Binary files /dev/null and b/tests/gis_tests/data/geoip2/dbip-country-lite-test.mmdb differ 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): 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." diff --git a/tests/gis_tests/test_geoip2.py b/tests/gis_tests/test_geoip2.py index 11c73bec0c..61b3565d1c 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. @@ -97,88 +124,58 @@ class GeoLite2Test(SimpleTestCase): def test_country(self): g = GeoIP2(city="") - 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) 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) + 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) 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) + 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), - { - "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="") @@ -230,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): diff --git a/tests/httpwrappers/tests.py b/tests/httpwrappers/tests.py index 2197c6f7ea..3774ff2d67 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): @@ -614,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( @@ -626,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): @@ -643,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): @@ -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): diff --git a/tests/mail/tests.py b/tests/mail/tests.py index 6280bfa5c8..302b746245 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 " @@ -347,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"), }, ) @@ -374,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() @@ -388,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() @@ -403,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( @@ -419,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"]) @@ -431,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"}, ) @@ -443,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"]) @@ -457,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() @@ -475,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"], @@ -497,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", @@ -515,13 +474,14 @@ 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" ' + 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( @@ -542,7 +502,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. @@ -611,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"]) @@ -622,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( @@ -636,25 +589,27 @@ 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.") - # 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( - "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, { + # (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"), @@ -663,10 +618,13 @@ 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, { + # (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,15 +697,23 @@ 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""" - headers = {"Date": "Fri, 09 Nov 2001 01:08:47 -0000", "Message-ID": "foo"} - subject, from_email, to = "hello", "from@example.com", "to@example.com" + 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). + """ 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() @@ -759,13 +725,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]) @@ -774,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() @@ -788,8 +744,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 @@ -805,25 +761,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 = EmailMessage() 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") @@ -832,9 +801,9 @@ 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 = 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") @@ -846,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") @@ -854,7 +823,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 +835,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): @@ -877,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): @@ -898,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) @@ -992,54 +949,31 @@ 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_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. - msg = EmailMessage( - "Subject", - "Body with only ASCII characters.", - "bounce@example.com", - ["to@example.com"], - headers={"From": "from@example.com"}, - ) + 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(body="Body with only ASCII characters.") 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. - msg = EmailMessage( - "Subject", - "Body with latin characters: àáä.", - "bounce@example.com", - ["to@example.com"], - headers={"From": "from@example.com"}, - ) + # Shouldn't use base64 or quoted-printable, instead should detect + # it can represent content with 8-bit data. + 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. + # 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: А Б В Г Д Е Ж Ѕ З И І К Л М Н О П.", @@ -1049,6 +983,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) @@ -1145,20 +1080,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", @@ -1277,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( @@ -1289,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 @@ -1410,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: @@ -1423,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?= " ) @@ -1588,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") @@ -1609,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") @@ -1625,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")], @@ -1691,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) @@ -1712,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() @@ -2122,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): 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) diff --git a/tests/postgres_tests/test_operations.py b/tests/postgres_tests/test_operations.py index f344d4ae74..322f38148b 100644 --- a/tests/postgres_tests/test_operations.py +++ b/tests/postgres_tests/test_operations.py @@ -318,7 +318,7 @@ class CreateExtensionTests(PostgreSQLTestCase): @unittest.skipUnless(connection.vendor == "postgresql", "PostgreSQL specific tests.") -class CreateCollationTests(PostgreSQLTestCase): +class CreateCollationTests(OptimizerTestBase, PostgreSQLTestCase): app_label = "test_allow_create_collation" @override_settings(DATABASE_ROUTERS=[NoMigrationRouter()]) @@ -459,6 +459,24 @@ class CreateCollationTests(PostgreSQLTestCase): "),", ) + def test_reduce_create_remove(self): + self.assertOptimizesTo( + [ + CreateCollation( + "sample_collation", + "und-u-ks-level2", + provider="icu", + deterministic=False, + ), + RemoveCollation( + "sample_collation", + # Different locale + "de-u-ks-level1", + ), + ], + [], + ) + @unittest.skipUnless(connection.vendor == "postgresql", "PostgreSQL specific tests.") class RemoveCollationTests(PostgreSQLTestCase): 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") 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") 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 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: 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/template_tests/test_extends.py b/tests/template_tests/test_extends.py index ce1838654b..0d2a93468c 100644 --- a/tests/template_tests/test_extends.py +++ b/tests/template_tests/test_extends.py @@ -1,9 +1,9 @@ import os -from django.template import Context, Engine, TemplateDoesNotExist +from django.template import Context, Engine, TemplateDoesNotExist, TemplateSyntaxError from django.test import SimpleTestCase -from .utils import ROOT +from .utils import ROOT, setup RECURSIVE = os.path.join(ROOT, "recursive_templates") @@ -181,3 +181,17 @@ class ExtendsBehaviorTests(SimpleTestCase): ) template = engine.get_template("base.html") self.assertEqual(template.render(Context({})), "12AB") + + @setup( + {"index.html": "{% block content %}B{% endblock %}{% extends 'base.html' %}"} + ) + def test_extends_not_first_tag_in_extended_template(self): + msg = "{% extends 'base.html' %} must be the first tag in 'index.html'." + with self.assertRaisesMessage(TemplateSyntaxError, msg): + self.engine.get_template("index.html") + + def test_extends_not_first_tag_in_extended_template_from_string(self): + template_string = "{% block content %}B{% endblock %}{% extends 'base.html' %}" + msg = "{% extends 'base.html' %} must be the first tag in the template." + with self.assertRaisesMessage(TemplateSyntaxError, msg): + Engine().from_string(template_string) 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): diff --git a/tests/urlpatterns_reverse/tests.py b/tests/urlpatterns_reverse/tests.py index 5843382a8c..91d3f237ec 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_view_func_from_cbv(self): + expected = "/hello/world/" + url = reverse(views.view_func_from_cbv, kwargs={"name": "world"}) + self.assertEqual(url, expected) + + def test_view_func_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..aca2d06ef7 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..01dfc1309e 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" diff --git a/tests/user_commands/tests.py b/tests/user_commands/tests.py index 65e176620d..2a1e904f3b 100644 --- a/tests/user_commands/tests.py +++ b/tests/user_commands/tests.py @@ -400,8 +400,8 @@ class CommandTests(SimpleTestCase): self.assertIn("bar", out.getvalue()) def test_subparser_invalid_option(self): - 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): 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. 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"},