Django 5.0 Tracking Issue

[adamchainz]

This is a tracking issue for changes that will be needed for Django 5.0, based on in-development release notes.

EDIT: Please see #1493 (comment) for an up to date progress list.

(Collapsed original list that is now outdated)

• warnings in django.utils.deprecation
• admin facets - ModelAdmin.show_facets, django.contrib.admin.ShowFacets enum
• form field groups - BoundField.as_field_group(), django.forms.Field.template_name, django.forms.renderers.BaseRenderer.field_template_name
• Database-computed default values - db_default arg and attr on model Field
• django.contrib.admin.AdminSite.get_log_entries
• django.http.HttpRequest.auser from AuthenticationMiddleware
• django.contrib.gis.db.models.functions.ClosestPoint
• django.contrib.postgres.constraints.ExclusionConstraint.violation_error_code
• choices args to form ChoiceField and model Field support Choices classes directly.
• django.forms.URLField new assume_scheme arg
• QuerySet.update_or_create and aupdate_or_create new create_defaults arg
• new violation_error_code arg for BaseConstraint, CheckConstraint, and UniqueConstraint
• new arg error_messages for django.core.paginator.Paginator.error_messages
• new Signal.asend() and Signal.asend_robust() methods
• The instance argument of the undocumented BaseModelFormSet.save_existing() method is renamed to obj.
• The undocumented django.contrib.admin.helpers.checkbox is removed.
• The undocumented Query.annotation_select_mask attribute is changed from a set of strings to an ordered list of strings.
• Passing positional arguments name and violation_error_message to BaseConstraint is deprecated in favor of keyword-only arguments. (Let's make them keyword-only in the stubs in 5.0.)
• request is added to the signature of ModelAdmin.lookup_allowed(). Support for ModelAdmin subclasses that do not accept this argument is deprecated.
• The get_joining_columns() method of ForeignObject and ForeignObjectRel is deprecated. Starting with Django 6.0, django.db.models.sql.datastructures.Join will no longer fallback to get_joining_columns(). Subclasses should implement get_joining_fields() instead.
• The undocumented django.utils.baseconv module is removed.
• The undocumented django.utils.datetime_safe module is removed.
• The extra_tests argument for DiscoverRunner.build_suite() and DiscoverRunner.run_tests() is removed.
• The USE_L10N setting is removed.
• Support for pytz timezones is removed.
• The is_dst argument is removed from:
  • QuerySet.datetimes()
  • django.utils.timezone.make_aware()
  • django.db.models.functions.Trunc()
  • django.db.models.functions.TruncSecond()
  • django.db.models.functions.TruncMinute()
  • django.db.models.functions.TruncHour()
  • django.db.models.functions.TruncDay()
  • django.db.models.functions.TruncWeek()
  • django.db.models.functions.TruncMonth()
  • django.db.models.functions.TruncQuarter()
  • django.db.models.functions.TruncYear()
• The django.contrib.gis.admin.GeoModelAdmin and OSMGeoAdmin classes are removed.
• [ ]The undocumented BaseForm._html_output() method is removed.
• The ability to return a str, rather than a SafeString, when rendering an ErrorDict and ErrorList is removed.
• The SitemapIndexItem.__str__() method is removed.
• The name argument of django.utils.functional.cached_property() is removed.
• The opclasses argument of django.contrib.postgres.constraints.ExclusionConstraint is removed.
• The undocumented ability to pass errors=None to SimpleTestCase.assertFormError() and assertFormsetError() is removed.
• django.contrib.sessions.serializers.PickleSerializer is removed.
• created=True is required in the signature of RemoteUserBackend.configure_user() subclasses.
• Support for logging out via GET requests in the django.contrib.auth.views.LogoutView and django.contrib.auth.views.logout_then_login() is removed.
• The django.utils.timezone.utc alias to datetime.timezone.utc is removed.
• Passing a response object and a form/formset name to SimpleTestCase.assertFormError() and assertFormSetError() is no longer allowed.
• The django.contrib.gis.admin.OpenLayersWidget is removed.
• The django.contrib.auth.hashers.CryptPasswordHasher is removed.
• Passing nulls_first=False or nulls_last=False to Expression.asc() and Expression.desc() methods, and the OrderBy expression is no longer allowed.

[adamchainz]

I hope that if we have such a list we can run through them after 5.0 is released, rather than have small issues trickle in as users discover what has been missed.

[intgr]

Agreed, this is helpful, thanks!

I think it would be more urgent to compile such a list for Django 4.2 (and we also probably missed some stuff in 4.1 and older even)

[adamchainz]

I did this one first because it's easier, since I didn't need to find related issues here...

[bigfootjon]

More changes since @adamchainz 's original message:

(Collapsed original list that is now outdated)

• django.db.models.GeneratedField
• django.contrib.admin.AdminSite.get_model_admin
• django.contrib.admin.ModelAdmin.list_display now supports boolean attribute
• django.contrib.auth.aauthenticate,aget_user,alogin,alogout,aupdate_session_auth_hash
• django.contrib.auth.hashers.acheck_password
• django.contrib.gis.GEOSGeometry.equals_identical
• django.contrib.messages.MessagesTestMixin.assertMessages
• Model.save now supports tuples passed to force_insert
• UniqueConstraint.nulls_distinct
• aget_object_or_404 and aget_list_or_404
• aprefetch_related_objects
• Client and AsyncClient have asession,alogin,aforce_login,alogout
• AsyncClient now has follow parameter
• StepValueValidator now has offset parameter
• DatabaseFeatures.supports_expression_defaults,supports_default_keyword_in_insert,supports_default_keyword_in_bulk_insert
• django.contrib.sitemaps.ping_google removed
• QuerySet.update_or_create now has create_defaults (if a model has that field name it now uses create_defaults__exact
• AlreadyRegistered,NotRegistered moved: django.contrib.admin.{sites,exceptions}
• DjangoDivFormRenderer,Jinja2DivFormRenderer deprecated
• ForeignObject.get_reverse_joining_columns deprecated
• format_html called without args or kwargs is deprecated
• DatabaseOperations.field_cast_sql deprecated
• django.db.models.enums.ChoicesMeta renamed to ChoicesType
• Prefetch.get_current_queryset deprecated
• USE_DEPRECATED_PYTZ removed
• CSRF_COOKIE_MASKED removed

I think I got everything, I'll try and tackle everything in the list I just made first since I can click the checkboxes.

Question for maintainers, how big of a PR should I make? Should each line item here be its own commit in one massive PR? How should we handle the version bumps in a separate PR?

[adamchainz]

I prefer small PRs that can be easily reviewed, each with a link to the relevant commit/source. Happy if they group some related features but not too large.

I’m not sure when we’d aim to support 5.0. It would be more productive right now to whittle down the outstanding todo list per the contributing guide.

[bigfootjon]

I just put up my first PR against this issue: #1741

For anyone else working on this, I found the blame view of the release notes on GitHub to be really helpful in tracking down the exact commit for a change: https://github.com/django/django/blame/main/docs/releases/5.0.txt

I'm about to go on a work trip for a few days so I won't be terribly responsive, but I wanted to get the first one of these going to make sure I'm doing everything right before I burn through more of the changes. Hopefully this PR isn't too far off base!

[intgr]

Since 5.0 was officially released, I opened PR #1859 to update to it in our CI. (UPDATE: Merged now)

Also generated a separate stubtest allowlist for Django 5.0:

https://github.com/typeddjango/django-stubs/blob/master/scripts/stubtest/allowlist_todo_django50.txt

[Skorpyon]

Holy thing. Looks like giant work.
db_default already affected me.

(venv) ➜  backend git:(main) ✗ mypy server
server/apps/main/models.py:25: error: Unexpected keyword argument "db_default" for "CharField"; did you mean "default"?  [call-arg]
Found 1 error in 1 file (checked 25 source files)

[intgr]

Holy thing. Looks like giant work.

Yep. To repeat just in case: if someone's interested in contributing, please keep PRs small and focused on one topic.

[Skorpyon]

please keep PRs small and focused on one topic

If talk about db_default at first look it simple:

class CharField(Field[_ST, _GT]):
    def __init__(
        self,
        ...
        db_default: Any = ...,
        ...
    ) -> None: ...

but I not understand how split .pyi versions between Django <5 and >=5
May you advice how django-stubs control Django version's features?

[intgr]

If talk about db_default at first look it simple:

Great! 🎉

but I not understand how split .pyi versions between Django <5 and >=5
May you advice how django-stubs control Django version's features?

Don't worry about that. When there are differences between Django versions, django-stubs tracks the latest Django version (discussion here: #1095 (comment)).

[christianbundy]

Do we have a sense for which of these TODOs are release blockers? Right now django-stubs is my only dependency blocking a Django 5.0 upgrade, so I'm interested to know what the next steps are to add enough compatibility.

[Viicos]

I will have some time this week to work on the 5.0 changes

[intgr]

Do we have a sense for which of these TODOs are release blockers?

I wouldn't consider any of them release blockers. No reason to delay improvements that are ready now, because everything is not yet perfect. But of course additional updates would be great to have.

But the priority for the release should be on getting open PRs reviewed and merged (ones that are close to being ready -- ignore the older messy ones).

The real reason for the lack of releases is that nobody has stepped up to do the release. Usually I was the one handling releases and reviewing PRs that fell through the cracks. But I had a long vacation and after that haven't found the right combination of time and motivation to push the next release forward. In retrospect I should have been more explicit about communicating my absence. But I didn't expect it to take this long.

If someone (preferably a current maintainer) is interested in handling the release, I'd be happy to instruct and help. But if not, I will get to it, but don't want to make promises yet.

Right now django-stubs is my only dependency blocking a Django 5.0 upgrade

Don't let that block your upgrade. django-stubs 4.2.7 works fine with Django 5.0 too, I've been using it myself. Any new or changed Django APIs may give type errors, but those can be solved with # type: ignore suppression until django-stubs catches up.

[JaeHyuckSa]

We've merged lots of 5.0 PRs, but haven't kept these checklists up to date.

How do you think we should handle this checklist maintenance?

@sobolevn Is it viable to grant privileges to frequent contributors like q0w and ngnpope such that they can edit the checklists themselves?

@sobolevn Could you give me permission to update the checklist temporarily? I need it because I got confused checking while I was working on it.

[intgr]

@saJaeHyukc Feel free to copy & paste the whole checklist to a new comment, and I will edit the previous comment to collapse it.

Here's the Markdown content of the last checklist: https://gist.github.com/intgr/126c9e366170e671e1bc6d12a2bc575a

[JaeHyuckSa]

This is a list created by @sudosubin.

This is the current list of tasks I have organized manually. It may be missing some from version 5.0, or include changes from version 4.2.

I think allowlist_todo_django50.txt can also help fill in the missing changes for version 5.0.

Django 4.2.8 (compare, release notes)

• django.db.models.sql.query
  • django.db.models.sql.query.Query.resolve_lookup_value's summarize argument was added 4.2.8: Update Query.resolve_lookup_value() parameters #2136

Django 5.0 (compare, release notes)

django.conf

• django.conf.__init__
  • django.conf.USE_DEPRECATED_PYTZ_DEPRECATED_MSG was removed
  • django.conf.USE_L10N_DEPRECATED_MSG was removed
  • django.conf.CSRF_COOKIE_MASKED_DEPRECATED_MSG was removed
  • django.conf.FORMS_URLFIELD_ASSUME_HTTPS_DEPRECATED_MSG was added 5.0: Update django.conf #2008
• django.conf.global_settings
  • django.conf.global_settings.USE_DEPRECATED_PYTZ was removed
  • django.conf.global_settings.USE_L10N was removed 5.0: Remove global setting USE_L10N #1979
  • django.conf.global_settings.FORMS_URLFIELD_ASSUME_HTTPS was added 5.0: Update django.conf #2008
  • django.conf.global_settings.DATA_UPLOAD_MAX_NUMBER_FILES was added
  • django.conf.global_settings.CSRF_COOKIE_MASKED was removed 5.0: Update django.conf #2008

django.contrib

• django.contrib.admin.__init__
  • django.contrib.admin.ShowFacets was added 5.0: Update django.contrib.admin #2004
• django.contrib.admin.exceptions
  • django.contrib.admin.exceptions.AlreadyRegistered was added 5.0: Update django.contrib.admin #2004
  • django.contrib.admin.exceptions.NotRegistered was added 5.0: Update django.contrib.admin #2004
• django.contrib.admin.filters
  • django.contrib.admin.filters.ListFilter.request was added 5.0: Update django.contrib.admin #2004
  • django.contrib.admin.filters.FacetsMixin was added 5.0: Update django.contrib.admin #2004
  • django.contrib.admin.filters.SimpleListFilter was changed 5.0: Update django.contrib.admin #2004
  • django.contrib.admin.filters.FieldListFilter was changed 5.0: Update django.contrib.admin #2004
  • django.contrib.admin.filters.RelatedFieldListFilter was changed 5.0: Update django.contrib.admin #2004
  • django.contrib.admin.filters.BooleanFieldListFilter was changed 5.0: Update django.contrib.admin #2004
  • django.contrib.admin.filters.ChoicesFieldListFilter was changed 5.0: Update django.contrib.admin #2004
  • django.contrib.admin.filters.DateFieldListFilter was changed 5.0: Update django.contrib.admin #2004
  • django.contrib.admin.filters.AllValuesFieldListFilter was changed 5.0: Update django.contrib.admin #2004
  • django.contrib.admin.filters.RelatedOnlyFieldListFilter was changed 5.0: Update django.contrib.admin #2004
  • django.contrib.admin.filters.EmptyFieldListFilter was changed 5.0: Update django.contrib.admin #2004
• django.contrib.admin.helpers
  • django.contrib.admin.helpers.checkbox was removed 5.0: Remove admin.helpers.checkbox #1972
• django.contrib.admin.options
  • django.contrib.admin.options.IS_FACETS_VAR 5.0: Update django.contrib.admin #2004
  • django.contrib.admin.options.ShowFacets was added 5.0: Add ModelAdmin.show_facets #1967
  • django.contrib.admin.options.BaseModelAdmin.lookup_allowed's request argument was added 5.0: Add request arg to ModelAdmin.lookup_allowed #1976
  • django.contrib.admin.options.ModelAdmin.show_facets was added 5.0: Add ModelAdmin.show_facets #1967
  • django.contrib.admin.options.ModelAdmin._get_preserved_qsl was added
• django.contrib.admin.sites
  • django.contrib.admin.sites.AlreadyRegistered was removed 5.0: Update django.contrib.admin #2004
  • django.contrib.admin.sites.NotRegistered was removed 5.0: Update django.contrib.admin #2004
  • django.contrib.admin.sites.AdminSite.get_model_admin was added Add first stub for get_model_admin #2029
  • django.contrib.admin.sites.AdminSite.get_log_entries was added 5.0: Add AdminSite.get_log_entries #1963
• django.contrib.admin.utils
  • django.contrib.admin.utils.get_last_value_from_parameters was added 5.0: Update django.contrib.admin #2004
  • django.contrib.admin.utils.prepare_lookup_value was changed 5.0: Update django.contrib.admin #2004
  • django.contrib.admin.utils.build_q_object_from_lookup_parameters was added 5.0: Update django.contrib.admin #2004
• django.contrib.admin.views.main
  • django.contrib.admin.views.main.ChangeList.add_facets was added 5.0: Update django.contrib.admin.views and django.forms.forms.Form metaclass #2079
  • django.contrib.admin.views.main.ChangeList.is_facets_optional was added 5.0: Update django.contrib.admin.views and django.forms.forms.Form metaclass #2079
  • django.contrib.admin.views.main.ChangeList.filter_params was added 5.0: Update django.contrib.admin.views and django.forms.forms.Form metaclass #2079
  • django.contrib.admin.views.main.ChangeList.remove_facet_link was added 5.0: Update django.contrib.admin.views and django.forms.forms.Form metaclass #2079
  • django.contrib.admin.views.main.ChangeList.add_facet_link was added 5.0: Update django.contrib.admin.views and django.forms.forms.Form metaclass #2079
  • django.contrib.admin.views.main.ChangeList.get_queryset's exclude_parameters argument was added 5.0: Update django.contrib.admin #2004
• django.contrib.admin.widgets
  • django.contrib.admin.widgets.BaseAdminDateWidget was added 5.0: Update django.contrib.admin.widgets #2105
  • django.contrib.admin.widgets.AdminDateWidget was changed 5.0: Update django.contrib.admin.widgets #2105
  • django.contrib.admin.widgets.BaseAdminTimeWidget was added 5.0: Update django.contrib.admin.widgets #2105
  • django.contrib.admin.widgets.AdminTimeWidget was changed 5.0: Update django.contrib.admin.widgets #2105
  • django.contrib.admin.widgets.RelatedFieldWidgetWrapper.choices was added 5.0: Update django.contrib.admin.widgets #2105
• django.contrib.auth.__init__
  • django.contrib.auth.aauthenticate was added [5.0] Added many new a-prefixed asynchronous methods #1741
  • django.contrib.auth.alogin was added [5.0] Added many new a-prefixed asynchronous methods #1741
  • django.contrib.auth.alogout was added [5.0] Added many new a-prefixed asynchronous methods #1741
  • django.contrib.auth.aget_user was added [5.0] Added many new a-prefixed asynchronous methods #1741
  • django.contrib.auth.aupdate_session_auth_hash was added [5.0] Added many new a-prefixed asynchronous methods #1741
• django.contrib.auth.admin
  • django.contrib.auth.admin.django.contrib.auth.admin.lookup_allowed's request argument was added 5.0: Add request arg to ModelAdmin.lookup_allowed #1976
• django.contrib.auth.backends
  • django.contrib.auth.backends.RemoteUserBackend.configure_user's created argument was added 5.0: Update django.contrib.auth.backends #2111
• django.contrib.auth.base_user
  • django.contrib.auth.base_user.AbstractBaseUser.acheck_password was added [5.0] Added many new a-prefixed asynchronous methods #1741
  • django.contrib.auth.base_user.AbstractBaseUser.get_session_auth_fallback_hash was added 5.0: Update django.contrib.auth.base_user #2113
• django.contrib.auth.hashers
  • django.contrib.auth.hashers.verify_password was added 5.0: Update django.contrib.auth #2009
  • django.contrib.auth.hashers.acheck_password was added [5.0] Added many new a-prefixed asynchronous methods #1741
  • django.contrib.auth.hashers.CryptPasswordHasher was removed 5.0: Update django.contrib.auth #2009
• django.contrib.auth.middleware
  • django.contrib.auth.middleware.auser was added 5.0: Add auth.middleware.auser #1966
• django.contrib.contenttypes.fields
  • django.contrib.contenttypes.fields.GenericForeignKey.get_content_type's model argument was added 5.0: Update django.contrib.contenttypes.fields.GenericForeignKey methods #2137
  • django.contrib.contenttypes.fields.GenericForeignKey.get_prefetch_querysets was added 5.0: Update django.contrib.contenttypes.fields.GenericForeignKey methods #2137
• django.contrib.contenttypes.prefetch
  • django.contrib.contenttypes.prefetch.GenericPrefetch was added 5.0: Update django.contrib.contenttypes.prefetch #2115
• django.contrib.gis.admin.__init__
  • django.contrib.gis.admin.GeoModelAdmin was removed 5.0: Remove OSMGeoAdmin, GeoModelAdmin #1981
  • django.contrib.gis.admin.OpenLayersWidget was removed 5.0: Update django.contrib.gis.admin.widgets and django.contrib.gis.admin.options #2116
  • django.contrib.gis.admin.OSMGeoAdmin was removed 5.0: Remove OSMGeoAdmin, GeoModelAdmin #1981
• django.contrib.gis.admin.options
  • django.contrib.gis.admin.options.spherical_mercator_srid was removed 5.0: Update django.contrib.gis.admin.widgets and django.contrib.gis.admin.options #2116
  • django.contrib.gis.admin.options.GeoModelAdmin was removed 5.0: Remove OSMGeoAdmin, GeoModelAdmin #1981
  • django.contrib.gis.admin.options.OSMGeoAdmin was removed 5.0: Remove OSMGeoAdmin, GeoModelAdmin #1981
• django.contrib.gis.admin.widgets was removed 5.0: Update django.contrib.gis.admin.widgets and django.contrib.gis.admin.options #2116
• django.contrib.gis.db.backends.postgis.operations
  • django.contrib.gis.db.backends.postgis.operations.PostGISOperator.check_geography was added 5.0: Update django.contrib.gis.db.backends.postgis.operations #2138
• django.contrib.gis.db.backends.spatialite.schema
  • django.contrib.gis.db.backends.spatialite.schema.SpatialiteSchemaEditor.alter_db_table's disable_constraints argument was removed 5.0: Update django.contrib.gis.db.backends.sqatialite.schema #2123
• django.contrib.gis.db.models.functions
  • django.contrib.gis.db.models.functions.ClosestPoint was added 5.0: Add gis ClosestPoint #1968
• django.contrib.gis.geos.geometry
  • django.contrib.gis.geos.geometry.GEOSGeometryBase.equals_identical was added [5.0] Add missing stubs for geos #2034
• django.contrib.gis.geos.prototypes.__init__
  • django.contrib.gis.geos.prototypes.geos_equalsidentical was added [5.0] Add missing stubs for geos #2034
• django.contrib.gis.geos.prototypes.io
  • django.contrib.gis.geos.prototypes.io.default_trim_value was added [5.0] Add missing stubs for geos #2034
  • django.contrib.gis.geos.prototypes.io.DEFAULT_TRIM_VALUE was added
• django.contrib.gis.geos.prototypes.predicates
  • django.contrib.gis.geos.prototypes.predicates.geos_equalsidentical was added [5.0] Add missing stubs for geos #2034
• django.contrib.messages.__init__
  • django.contrib.messages.Message was added
• django.contrib.messages.storage.cookie
  • django.contrib.messages.storage.cookie.MessagePartSerializer was added 5.0: Update django.contrib.messages.storage.cookie #2106
  • django.contrib.messages.storage.cookie.MessagePartGatherSerializer was added 5.0: Update django.contrib.messages.storage.cookie #2106
  • django.contrib.messages.storage.cookie.MessageSerializer was changed 5.0: Update django.contrib.messages.storage.cookie #2106
  • django.contrib.messages.storage.cookie.CookieStorage.not_finished_json was added 5.0: Update django.contrib.messages.storage.cookie #2106
  • django.contrib.messages.storage.cookie.bisect_keep_left was added 5.0: Update django.contrib.messages.storage.cookie #2106
  • django.contrib.messages.storage.cookie.bisect_keep_right was added 5.0: Update django.contrib.messages.storage.cookie #2106
• django.contrib.messages.test was added 5.0: Update django.contrib.messages.test #2126
• django.contrib.postgres.aggregates.general
  • django.contrib.postgres.aggregates.general.NOT_PROVIDED was removed
  • django.contrib.postgres.aggregates.general.DeprecatedConvertValueMixin was removed
  • django.contrib.postgres.aggregates.general.DeprecatedConvertValueMixin was removed
• django.contrib.postgres.constraints
  • django.contrib.postgres.constraints.ExclusionConstraint.__init__'s opclasses argument was removed 5.0: Update django.contrib.postgres #2078
  • django.contrib.postgres.constraints.ExclusionConstraint.__init__'s violation_error_code argument was added 5.0: Add BaseConstraint.violation_error_code #1969
  • django.contrib.postgres.constraints.ExclusionConstraint.__init__'s violation_error_code argument was added 5.0: Add BaseConstraint.violation_error_code #1969
• django.contrib.sessions.serializers
  • django.contrib.sessions.serializers.PickleSerializer was removed 5.0: Update django.contrib.sessions.serializers, django.core.serializers #2068
• django.contrib.sitemaps.__init__
  • django.contrib.sitemaps.PING_URL was removed 5.0: Update django.contrib.sitemaps, django.contrib.staticfiles #2076
  • django.contrib.sitemaps.SitemapNotFound was removed 5.0: Update django.contrib.sitemaps, django.contrib.staticfiles #2076
  • django.contrib.sitemaps.ping_google was removed 5.0: Update django.contrib.sitemaps, django.contrib.staticfiles #2076
• django.contrib.sitemaps.management.commands.ping_google was removed 5.0: Update django.contrib.sitemaps, django.contrib.staticfiles #2076
• django.contrib.sites.requests
  • django.contrib.sites.requests.RequestSite.save's foce_insert argument now accept Union[bool, Tuple[ModelBase, ...]] 5.0: Update django.contrib.sitemaps, django.contrib.staticfiles #2076
• django.contrib.staticfiles.checks
  • django.contrib.staticfiles.checks.E005 was added 5.0: Update django.contrib.sitemaps, django.contrib.staticfiles #2076
  • django.contrib.staticfiles.checks.check_storages was added 5.0: Update django.contrib.sitemaps, django.contrib.staticfiles #2076
• django.contrib.staticfiles.storage
  • django.contrib.staticfiles.storage.HashedFilesMixin.support_js_module_import_aggregation was added Add ManifestStaticFilesStorage new parameters #1528

django.core

• django.core.cache.backends.base
  • django.core.cache.backends.base.memcached_error_chars_re was added [5.0] Update core.cache.backends, add RedisCache and related classes #1948
• django.core.exceptions
  • django.core.exceptions.TooManyFilesSent was added Django core cache #1774
• django.core.files.base
  • django.core.files.base.File.open's signature was changed [5.0] Update core.files #1949
• django.core.handlers.asgi
  • django.core.handlers.asgi.get_script_prefix was added 5.0: Update django.core.handlers #2066
  • django.core.handlers.asgi.ASGIHandler.listen_for_disconnect was added 5.0: Update django.core.handlers #2066
  • django.core.handlers.asgi.ASGIHandler.run_get_response was added 5.0: Update django.core.handlers #2066
  • django.core.handlers.asgi.ASGIHandler.get_script_prefix was removed 5.0: Update django.core.handlers #2066
• django.core.management.commands.inspectdb
  • django.core.management.commands.inspectdb.Command.normalize_table_name was added 5.0: Update django.core.management #2067
• django.core.management.commands.optimizemigration was added 5.0: Update django.core.management #2067
• django.core.management.commands.runserver
  • django.core.management.commands.runserver.Command.on_bind was added Various improvements in django.core.management.commands modules #1829
• django.core.paginator
  • django.core.paginator.Paginator.default_error_messages was added [5.0] Update core.paginator #1946
  • django.core.paginator.Paginator.__init__'s error_messages argument was added [5.0] Update core.paginator #1946
• django.core.serializers.base
  • django.core.serializers.base.PickleSerializer was removed 5.0: Update django.contrib.sessions.serializers, django.core.serializers #2068
• django.core.servers.basehttp
  • django.core.servers.basehttp.ServerHandler.finish_response was added
  • django.core.servers.basehttp.run's on_bind argument was added 5.0: Update django.core.servers.basehttp #2070
• django.core.validators
  • django.core.validators.URLValidator.max_length was added django.core.management stub update #1787
  • django.core.validators.StepValueValidator.__init__ was changed [5.0] Update core.validators #1947
  • django.core.validators.StepValueValidator.offset was added [5.0] Update core.validators #1947

django.db

• django.db.backends.base.base

  • django.db.backends.base.base.timezone_constructor wsa removed 5.0: Remove pytz support #1980

• django.db.backends.base.features

  • django.db.backends.base.features.BaseDatabaseFeatures.delete_can_self_reference_subquery was added 5.0: Update django.db.backends.base.features.BaseDatabaseFeature #2099
  • django.db.backends.base.features.BaseDatabaseFeatures.supports_nulls_distinct_unique_constraints was added 5.0: Update django.db.backends.base.features.BaseDatabaseFeature #2099
  • django.db.backends.base.features.BaseDatabaseFeatures.supports_atomic_references_rename was removed 5.0: Update django.db.backends.base.features.BaseDatabaseFeature #2099
  • django.db.backends.base.features.BaseDatabaseFeatures.supports_expression_defaults was added 5.0: Update django.db.backends.base.features.BaseDatabaseFeature #2099
  • django.db.backends.base.features.BaseDatabaseFeatures.supports_default_keyword_in_insert was added 5.0: Update django.db.backends.base.features.BaseDatabaseFeature #2099
  • django.db.backends.base.features.BaseDatabaseFeatures.supports_default_keyword_in_bulk_insert was added 5.0: Update django.db.backends.base.features.BaseDatabaseFeature #2099
  • django.db.backends.base.features.BaseDatabaseFeatures.supports_stored_generated_columns was added 5.0: Update django.db.backends.base.features.BaseDatabaseFeature #2099
  • django.db.backends.base.features.BaseDatabaseFeatures.supports_virtual_generated_columns was added 5.0: Update django.db.backends.base.features.BaseDatabaseFeature #2099
  • django.db.backends.base.features.BaseDatabaseFeatures.insert_test_table_with_defaults was added 5.0: Update django.db.backends.base.features.BaseDatabaseFeature #2099

• django.db.backends.base.operations

  • django.db.backends.base.operations.BaseDatabaseOperations.prepare_join_on_clause was added 5.0: Update django.db.backends.base.operations.BaseDatabaseOperations #2100

• django.db.backends.base.schema

  • django.db.backends.base.schema.BaseDatabaseSchemaEditor.db_default_sql was added [5.0] Add db_default= parameter to models Field classes #1876

• django.db.backends.mysql.base

  • django.db.backends.mysql.base.DatabaseWrapper.data_types was changed Improve typing of django.db.backends.mysql.base.DatabaseWrapper attributes #2125

• django.db.backends.oracle.base

  • django.db.backends.oracle.base.DatabaseWrapper.cx_oracle_version was removed 5.0: Update django.db.backends.oracle.base #2057

• django.db.backends.oracle.introspection

  • django.db.backends.oracle.introspection.DatabaseIntrospection.data_types_reverse was changed

• django.db.backends.oracle.oracledb_any was added

• django.db.backends.postgresql.features was added

  • django.db.backends.postgresql.features.uses_server_side_binding was added
  • django.db.backends.postgresql.features.is_postgresql_15 was added

• django.db.backends.sqlite3.features

  • django.db.backends.sqlite3.features.DatabaseFeatures.can_alter_table_rename_column was removed

• django.db.backends.utils

  • django.db.backends.utils.CursorWrapper.APPS_NOT_READY_WARNING_MSG was added 5.0: Update django.db.backends.utils #2102

• django.db.migrations.serializer

  • django.db.migrations.serializer.BaseUnorderedSequenceSerializer was added 5.0: Update django.db.migrations.serializer #2109
  • django.db.migrations.serializer.FrozensetSerializer was changed 5.0: Update django.db.migrations.serializer #2109
  • django.db.migrations.serializer.SetSerializer was changed 5.0: Update django.db.migrations.serializer #2109

• django.db.models.__init__

  • django.db.models.GeneratedField was added [5.0] Add django.db.models.GeneratedField #1944

• django.db.models.base

  • django.db.models.base.Model.save's foce_insert argument now accept Union[bool, Tuple[ModelBase, ...]] 5.0: Update django.contrib.sitemaps, django.contrib.staticfiles #2076
  • django.db.models.base.Model.asave's foce_insert argument now accept Union[bool, Tuple[ModelBase, ...]] 5.0: Update django.contrib.sitemaps, django.contrib.staticfiles #2076
  • django.db.models.base.Model.save_base's foce_insert argument now accept Union[bool, Tuple[ModelBase, ...]] 5.0: Update django.contrib.sitemaps, django.contrib.staticfiles #2076

• django.db.models.constraints

  • django.db.models.constraints.BaseConstraint.violation_error_code was added 5.0: Add BaseConstraint.violation_error_code #1969 5.0: Pass positional args name and violation_error_message to BaseConstraint #1974
  • django.db.models.constraints.BaseConstraint.__init__'s violation_error_code argument was added fixup: Pass violation_error_code to init #1975 5.0: Pass positional args name and violation_error_message to BaseConstraint #1974
  • django.db.models.constraints.CheckConstraint.__init__'s violation_error_code argument was added 5.0: Add BaseConstraint.violation_error_code #1969
  • django.db.models.constraints.CheckConstraint.__init__'s violation_error_code argument was added 5.0: Add BaseConstraint.violation_error_code #1969
  • django.db.models.constraints.UniqueConstraint.__init__'s nulls_distinct, violation_error_code argument was added Fix types for UniqueConstraint instantiation #1880
  • django.db.models.constraints.UniqueConstraint.nulls_distinct was added 5.0: Update django.db.models.constraints.UniqueConstraint #2175

• django.db.models.enums

  • django.db.models.enums.ChoicesType was added 5.0: Add ChoicesType #1942
  • django.db.models.enums.IntegerChoices was changed 5.0: Update django.db.models.enums #2148
  • django.db.models.enums.TextChoices was changed 5.0: Update django.db.models.enums #2148

• django.db.models.expressions

  • django.db.models.expressions.BaseExpression.allowed_default was added 5.0: Update django.db.models.expressions #2110
  • django.db.models.expressions.BaseExpression.contains_subquery was added
  • django.db.models.expressions.DatabaseDefault was added 5.0: Update django.db.models.expressions #2110
  • django.db.models.expressions.Subquery.subquery was added 5.0: Update django.db.models.expressions #2110

• django.db.models.fields.__init__

  • django.db.models.fields.Field.generated was added 5.0: Update django.db.models.field: add generated attribute to model fields #2152
  • django.db.models.fields.Field.__init__'s db_default argument was added [5.0] Add db_default= parameter to models Field classes #1876
  • django.db.models.fields.Field.db_default was added [5.0] Add db_default= parameter to models Field classes #1876

• django.db.models.fields.generated

  • django.db.models.fields.generated.GeneratedField was added [5.0] Add django.db.models.GeneratedField #1944

• django.db.models.fields.related

  • django.db.models.fields.related.ForeignObject.get_joining_fields was added 5.0: Update django.db.models.field.related #2151
  • django.db.models.fields.related.ForeignObject.get_reverse_joining_fields was added 5.0: Update django.db.models.field.related #2151

• django.db.models.fields.related_descriptors

  • django.db.models.fields.related_descriptors.ForwardManyToOneDescriptor.get_prefetch_querysets was added 5.0: Update django.db.models.field.related_descriptors #2157
  • django.db.models.fields.related_descriptors.ReverseOneToOneDescriptor.get_prefetch_querysets was added 5.0: Update django.db.models.field.related_descriptors #2157

• django.db.models.fields.reverse_related

  • django.db.models.fields.reverse_related.ForeignObjectRel.get_lookups was added 5.0: Update django.db.models.fields.reverse_related #2158
  • django.db.models.fields.reverse_related.ForeignObjectRel.get_transform was added 5.0: Update django.db.models.fields.reverse_related #2158
  • django.db.models.fields.reverse_related.ForeignObjectRel.get_joining_fields was added 5.0: Update django.db.models.fields.reverse_related #2158

• django.db.models.functions.datetime

  • django.db.models.functions.datetime.Now.as_oracle was added 5.0: Update django.db.models.functions.datetime.Now #2173
  • django.db.models.functions.datetime.TruncBase.__init__'s is_dst argument was removed 5.0: Update django.db.models.functions.datetime #2167
  • django.db.models.functions.datetime.TruncBase.is_dst was removed 5.0: Update django.db.models.functions.datetime #2167
  • django.db.models.functions.datetime.Trunc.__init__'s is_dst argument was removed 5.0: Update django.db.models.functions.datetime #2167

• django.db.models.lookups

  • django.db.models.lookups.IntegerFieldOverflow was added 5.0: Update django.db.models.lookups #2103
  • django.db.models.lookups.IntegerFieldExact was added 5.0: Update django.db.models.lookups #2103
  • django.db.models.lookups.IntegerGreaterThan was added 5.0: Update django.db.models.lookups #2103
  • django.db.models.lookups.IntegerGreaterThanOrEqual was changed 5.0: Update django.db.models.lookups #2103
  • django.db.models.lookups.IntegerLessThan was changed 5.0: Update django.db.models.lookups #2103
  • django.db.models.lookups.IntegerLessThanOrEqual was added 5.0: Update django.db.models.lookups #2103

• django.db.models.query

  • django.db.models.query.QuerySet.update_or_create's create_defaults argument was added 5.0: Add QuerySet.(a)update_or_create new create_defaults arg #1970
  • django.db.models.query.QuerySet.aupdate_or_create's create_defaults argument was added 5.0: Add QuerySet.(a)update_or_create new create_defaults arg #1970
  • django.db.models.query.Prefetch.get_current_querysets was added 5.0: Update django.db.models.query #2160
  • django.db.models.query.aprefetch_related_objects was added [5.0] Added many new a-prefixed asynchronous methods #1741

• django.db.models.query_utils

  • django.db.models.query_utils.Q.identity was added 5.0: Update django.db.models.query_utils #2165
  • django.db.models.query_utils.FilteredRelation.path was removed 5.0: Update django.db.models.query_utils #2165
  • django.db.models.query_utils.FilteredRelation.relabeled_clone was added 5.0: Update django.db.models.query_utils #2165
  • django.db.models.query_utils.FilteredRelation.resolve_expression was added 5.0: Update django.db.models.query_utils #2165

• django.db.models.sql.compiler

  • django.db.models.sql.compiler.PositionRef was added 5.0: Update django.db.models.sql.compiler #2166

• django.db.models.sql.datastructures

  • django.db.models.sql.datastructures.Join.equals was removed 5.0: Update django.db.models.sql.datastructures #2159
  • django.db.models.sql.datastructures.BaseTable.equals was removed 5.0: Update django.db.models.sql.datastructures #2159

• django.db.models.sql.query

  • django.db.models.sql.query.get_paths_from_expression was added
  • django.db.models.sql.query.get_child_with_renamed_prefix was added
  • django.db.models.sql.query.rename_prefix_from_q was added
  • django.db.models.sql.query.Query.annotation_select_mask's signature was changed 5.0: Change annotation_select_mask from set[str] to list[str] #1973
  • django.db.models.sql.query.Query.join's reuse_with_filtered_relation argument was removed 5.0: Update django.db.models.sql.query.Query #2172
  • django.db.models.sql.query.Query.resolve_lookup_value's summarize argument was added 4.2.8: Update Query.resolve_lookup_value() parameters #2136
  • django.db.models.sql.query.Query.build_filter's reuse_with_filtered_relation argument was removed 5.0: Update django.db.models.sql.query.Query #2172
  • django.db.models.sql.query.Query.build_filter's update_join_types argument was added 5.0: Update django.db.models.sql.query.Query #2172
  • django.db.models.sql.query.Query.build_filtered_relation_q was removed 5.0: Update django.db.models.sql.query.Query #2172
  • django.db.models.sql.query.Query.setup_joins was removed 5.0: Update django.db.models.sql.query.Query #2172

• Passing nulls_first=False or nulls_last=False to Expression.asc() and Expression.desc() methods, and the OrderBy expression is no longer allowed.

django.dispatch

• django.dispatch.dispatcher
  • django.dispatch.dispatcher.Signal.asend was added 5.0: Add Signal.asend and Signal.asend_robust #1965
  • django.dispatch.dispatcher.Signal.asend_robust was added 5.0: Add Signal.asend and Signal.asend_robust #1965

django.forms

• django.forms.boundfield
  • django.forms.boundfield.BoundField was changed 5.0: Update django.forms.boundfield and django.forms.utils #2118
  • django.forms.boundfield.BoundField.renderer was added (might be placed in RenderableMixin) 5.0: Update django.forms.boundfield and django.forms.utils #2118
  • django.forms.boundfield.BoundField.template_name was added (might be placed in RenderableMixin) 5.0: Update django.forms.boundfield and django.forms.utils #2118
  • django.forms.boundfield.BoundField.get_context was added (might be placed in RenderableMixin) 5.0: Update django.forms.boundfield and django.forms.utils #2118
• django.forms.fields
  • django.forms.fields.Field.__init__'s template_name argument was added 5.0: Update django.forms.field.Field #2107
  • django.forms.fields.Field.template_name was added
  • django.forms.fields.URLField.__init__'s assume_scheme argument was added [5.0] add assume_scheme to forms.URLField #1929
  • django.forms.fields.URLField.assume_scheme was added
  • django.forms.fields.CallableChoiceIterator was removed 5.0: Add django.utils.choices #2075
• django.forms.forms
  • django.forms.forms.BaseForm._html_output was removed 5.0: Update django.forms.forms #2122
• django.forms.formsets
  • django.forms.formsets.BaseFormSet.form_renderer was added 5.0: Update django.forms.formsets #2145
  • django.forms.formsets.BaseFormSet.renderer was added (might be placed in RenderableMixin) 5.0: Update django.forms.formsets #2145
• django.forms.models
  • django.forms.models.fields_for_model's form_declared_fields argument was added 5.0: Update django.forms.models #2146
  • django.forms.models.save_existing's instance argument was changed to obj 5.0: Rename save_existing arg instance to obj #1971
  • django.forms.models.ModelChoiceIterator was changed 5.0: Add django.utils.choices #2075
• django.forms.renderers
  • django.forms.renderers.BaseRenderer.field_template_name was added 5.0: Update django.forms.renderers #2119
• django.forms.utils
  • django.forms.utils.DEFAULT_TEMPLATE_DEPRECATION_MSG was removed
  • django.forms.utils.RenderableFieldMixin was added 5.0: Update django.forms.boundfield and django.forms.utils #2118
• django.forms.widgets
  • django.forms.widgets.FileInput.allow_multiple_selected was added 5.0: Update django.forms.widgets #2147
  • django.forms.widgets.ClearableFileInput.checked was added 5.0: Update django.forms.widgets #2147

django.http

• django.http.multipartparser
  • django.http.multipartparser.FIELD_TYPES was added 5.0: Update django.http #2064
• django.http.request
  • django.http.request.HttpRequest.auser was added 5.0: Update django.http #2064

django.middleware

• django.middleware.locale
  • django.middleware.locale.LocaleMiddleware.get_fallback_language was removed

django.shortcuts

• django.shortcuts
  • django.shortcuts.aget_object_or_404 was added [5.0] Added many new a-prefixed asynchronous methods #1741
  • django.shortcuts.aget_list_or_404 was added [5.0] Added many new a-prefixed asynchronous methods #1741

django.template, django.templatetags

• django.template.base
  • django.template.base.Template.__iter__ was removed 5.0: Update django.template, django.templatetags #2063
• django.template.defaultfilters
  • django.template.defaultfilters.escapeseq was added 5.0: Update django.template, django.templatetags #2063
• django.templatetags.tz
  • django.templatetags.tz.UnknownTimezoneException was removed
  • django.templatetags.tz.timezone_constructor was removed

django.test

• django.test.client
  • django.test.client.REDIRECT_STATUS_CODES was added 5.0: Update django.test.client #2059
  • django.test.client.aclosing_iterator_wrapper was added 5.0: Update django.test.client #2059
  • django.test.client.ClientMixin.asession was added [5.0] Added many new a-prefixed asynchronous methods #1741
  • django.test.client.ClientMixin.alogin was added [5.0] Added many new a-prefixed asynchronous methods #1741
  • django.test.client.ClientMixin.aforce_login was added [5.0] Added many new a-prefixed asynchronous methods #1741
  • django.test.client.ClientMixin.alogout was added [5.0] Added many new a-prefixed asynchronous methods #1741
  • django.test.client.AsyncClient.get was added 5.0: Update django.test #2005
  • django.test.client.AsyncClient.post was added 5.0: Update django.test #2005
  • django.test.client.AsyncClient.head was added 5.0: Update django.test #2005
  • django.test.client.AsyncClient.options was added 5.0: Update django.test #2005
  • django.test.client.AsyncClient.put was added 5.0: Update django.test #2005
  • django.test.client.AsyncClient.patch was added 5.0: Update django.test #2005
  • django.test.client.AsyncClient.delete was added 5.0: Update django.test #2005
  • django.test.client.AsyncClient.trace was added 5.0: Update django.test #2005
• django.test.html
  • django.test.html.Parser.SELF_CLOSING_TAGS was removed 5.0: Update django.test.html #2060
• django.test.runner
  • django.test.runner.RemoteTestResult.addDuration was added 5.0: Update django.test #2005
  • django.test.runner.ParallelTestSuite.used_aliases was added 5.0: Update django.test.runner #2061
  • django.test.runner.DiscoverRunner.__init__'s durations argument was added 5.0: Update django.test #2005
  • django.test.runner.DiscoverRunner.build_suite's extra_tests argument was removed 5.0: Remove extra_tests arg for DiscoverRunner.build_suite/run_tests #1978
  • django.test.runner.DiscoverRunner.run_tests's extra_tests argument was removed 5.0: Remove extra_tests arg for DiscoverRunner.build_suite/run_tests #1978
• django.test.testcases
  • django.test.testcases.SimpleTestCase.assertFormError's signature was changed (response and form/formset name) 5.0: Update django.test.testcases #2062
  • django.test.testcases.SimpleTestCase.assertFormSetError's signature was changed (response and form/formset name) 5.0: Update django.test.testcases #2062
  • django.test.testcases._AssertTemplateUsedContext.rendered_template_names was removed 5.0: Update django.test.testcases #2062
  • django.test.testcases._AssertFormErrorDeprecationHelper was removed

django.utils

• django.utils.baseconv was removed 5.0: Remove django.utils baseconv and datetime_safe modules #1977
• django.utils.choices was added
  • django.utils.choices.BaseChoiceIterator was added 5.0: Add django.utils.choices #2075
  • django.utils.choices.BlankChoiceIterator was added 5.0: Add django.utils.choices #2075
  • django.utils.choices.CallableChoiceIterator was added 5.0: Add django.utils.choices #2075
  • django.utils.choices.flatten_choices was added 5.0: Add django.utils.choices #2075
  • django.utils.choices.normalize_choices was added 5.0: Add django.utils.choices #2075
• django.utils.crypto
  • django.utils.crypto.md5 was removed
  • django.utils.crypto.new_hash was removed
• django.utils.datetime_safe was removed 5.0: Remove django.utils baseconv and datetime_safe modules #1977
• django.utils.deprecation
  • django.utils.deprecation.RemovedInDjango50Warning was removed 5.0: Update django.utils #2006
  • django.utils.deprecation.RemovedInDjango60Warning was added 5.0: Update django.utils #2006
  • django.utils.deprecation.RemovedInNextVersionWarning was changed 5.0: Update django.utils #2006
  • django.utils.deprecation.RemovedAfterNextVersionWarning was changed 5.0: Update django.utils #2006
• django.utils.html
  • django.utils.html.VOID_ELEMENTS was added 5.0: Update django.utils #2006
• django.utils.text
  • django.utils.text.add_truncation_text was added 5.0: Update django.utils #2006
  • django.utils.text.Truncator.MAX_LENGTH_HTML was added
  • django.utils.text.Truncator.add_truncation_text was removed
• django.utils.timezone
  • django.utils.timezone.NOT_PASSED was removed
  • django.utils.timezone.utc (alias) was removed
  • django.utils.timezone.make_aware's argument is_dst was removed 5.0: Update django.utils #2006
  • django.utils.timezone._is_pytz_zone was removed 5.0: Remove pytz support #1980
• django.utils.topological_sort was removed 5.0: Update django.utils #2006
• django.utils.translation.trans_real
  • django.utils.translation.trans_real.ACCEPT_LANGUAGE_HEADER_MAX_LENGTH was added
• django.utils.version
  • django.utils.version.PY312 was added

django.views

• django.views.csrf
  • django.views.csrf.CSRF_FAILURE_TEMPLATE was removed 5.0: Update django.views #2007
  • django.views.csrf.builtin_template_path was added 5.0: Update django.views #2007
• django.views.decorators.debug
  • django.views.decorators.debug.coroutine_functions_to_sensitive_variables was added 5.0: Update django.views #2007
• django.views.generic.edit
  • django.views.generic.edit.DeleteViewCustomDeleteWarning was removed 5.0: Update django.views #2007
  • django.views.generic.edit.BaseDeleteView.__init__ was removed 5.0: Update django.views #2007
• django.views.i18n
  • django.views.i18n.builtin_template_path was added 5.0: Update django.views #2007
  • django.views.i18n.js_catalog_template was removed 5.0: Update django.views #2007
• django.views.static
  • django.views.static.builtin_template_path was added 5.0: Update django.views #2007
  • django.views.static.DEFAULT_DIRECTORY_INDEX_TEMPLATE was removed 5.0: Update django.views #2007

Django 5.0.1 (compare, release notes)

• django.db.backends.oracle.base
  • django.db.backends.oracle.base.FormatStylePlaceholderCursor.__init__'s database argument was added 5.0: Update django.db.backends.oracle.base #2057

Django 5.0.2 (compare, release notes)

• django.db.models.sql.query
  • django.db.models.sql.query.get_child_with_renamed_prefix's child argument was changed

Django 5.0.3 (compare, release notes)

• django.utils.text
  • django.utils.text.re_notag was added Update django to 5.0.3 #1990
  • django.utils.text.re_prt was added Update django to 5.0.3 #1990
  • django.utils.text.WordsRegex was added Update django to 5.0.3 #1990
  • django.utils.text.FakeMatch was added Update django to 5.0.3 #1990
  • django.utils.text.re_words was changed Update django to 5.0.3 #1990

Django 5.0.4 (compare, release notes)

No interface changes.

Django 5.0.5 e696331 (compare, release notes)

No interface changes.

Django 5.0.6 (compare, release notes)

No interface changes.