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.