5.0.0

[intgr]

Announcements

• QuerySet class no longer derives from Collection. If you run into errors like incompatible type "_QuerySet[User, User]"; expected "Collection[User]", please read this announcement.

Headline changes

• Remove incorrect Collection base class and __contains__ method from QuerySet by @fidoriel in Remove incorrect Collection base class and __contains__ method from QuerySet #1925
• Pyright joins the workflow in an advisory capacity by @jorenham in Pyright joins the workflow in an advisory capacity #2019
• feat: Allow setting django_settings_module from env by @armanckeser in feat: Allow setting django_settings_module from env #2021
• Add ManyRelatedManager.through attribute and generic type parameter by @flaeppe in Add ManyRelatedManager.through attribute and generic type parameter #2026

What's Changed

• Make StrPromise not inherit from Sequence[str] by @intgr in Make StrPromise not inherit from Sequence[str] #1841
• Update and prepare for Django 5.0 by @intgr in Update and prepare for Django 5.0 #1859
• Ensure mypy plugin processes inherited many to many fields by @flaeppe in Ensure mypy plugin processes inherited many to many fields #1864
• Include ModelBase subclasses in plugin base class hook condition by @flaeppe in Include ModelBase subclasses in plugin base class hook condition #1863
• [5.0] Added many new a-prefixed asynchronous methods by @bigfootjon in [5.0] Added many new a-prefixed asynchronous methods #1741
• Remove section regarding custom queryset methods from README by @flaeppe in Remove section regarding custom queryset methods from README #1865
• Fix type of AppConfig.models_module by @Viicos in Fix type of AppConfig.models_module #1866
• Allow None in settings MIGRATION_MODULES dict values by @asottile in Allow None in settings MIGRATION_MODULES dict values #1871
• Add type hints for JSONField.from_db_value by @flaeppe in Add type hints for JSONField.from_db_value #1879
• Fix/pyright unknown by @dephiros in Fix/pyright unknown #1873
• Fix type hints of converters in urls.resolvers by @Viicos in Fix type hints of converters in urls.resolvers #1892
• Update mypy to 1.8.0 by @sobolevn in Update mypy to 1.8.0 #1885
• Add @type_check_only to all Protocols and known stubs-only classes by @intgr in Add @type_check_only to all Protocols and known stubs-only classes #1894
• Fix types for UniqueConstraint instantiation by @flaeppe in Fix types for UniqueConstraint instantiation #1880
• Add ModuleType as a possible type to URLResolver.urlconf_name by @Viicos in Add ModuleType as a possible type to URLResolver.urlconf_name #1891
• Fix type hint of URLPattern.default_args by @Viicos in Fix type hint of URLPattern.default_args #1895
• Update ruff and silence PYI046 by @sobolevn in Update ruff and silence PYI046 #1907
• Use PEP 570 syntax by @Viicos in Use PEP 570 syntax #1908
• Fix readme settings example by @Viicos in Fix readme settings example #1910
• Fix type hint of EmailBackend.ssl_keyfile and EmailBackend.ssl_certfile by @Viicos in Fix type hint of EmailBackend.ssl_keyfile and EmailBackend.ssl_certfile #1911
• Add type of django.VERSION by @Viicos in Add type of django.VERSION #1916
• Added CommandParser to commands.__init__ by @jamesbraza in Added CommandParser to commands.__init__ #1927
• [5.0] add assume_scheme to forms.URLField by @asottile in [5.0] add assume_scheme to forms.URLField #1929
• Fix return type of BaseModelAdmin.formfield_for_dbfield by @Viicos in Fix return type of BaseModelAdmin.formfield_for_dbfield #1934
• Revert pre-commit==3.6.1 by @sobolevn in Revert pre-commit==3.6.1 #1936
• Fix type hint of Response.set_cookie.max_age by @Viicos in Fix type hint of Response.set_cookie.max_age #1941
• 5.0: Add ChoicesType by @q0w in 5.0: Add ChoicesType #1942
• Add through_defaults for RelatedManager methods by @mfosterw in Add through_defaults for RelatedManager methods #1943
• Update type hints of core.signing by @Viicos in Update type hints of core.signing #1945
• [5.0] Update core.validators by @Viicos in [5.0] Update core.validators #1947
• [5.0] Update core.paginator by @Viicos in [5.0] Update core.paginator #1946
• Generic forms.ModelChoiceField by @UnknownPlatypus in Generic forms.ModelChoiceField #1889
• Support processing of other relations and fields when one is broken by @flaeppe in Support processing of other relations and fields when one is broken #1877
• Allowing set in model_to_dict's exclude by @jamesbraza in Allowing set in model_to_dict's exclude #1952
• [5.0] Add django.db.models.GeneratedField by @palfrey in [5.0] Add django.db.models.GeneratedField #1944
• Fix type hint of BaseEngine.template_dirs by @Viicos in Fix type hint of BaseEngine.template_dirs #1954
• Update type hints of contrib.auth.hashers by @yhay81 in Update type hints of contrib.auth.hashers #1955
• deps: Upgrade pre-commit for newer versions of python by @delfick in deps: Upgrade pre-commit for newer versions of python #1961
• 5.0: Add auth.middleware.auser by @q0w in 5.0: Add auth.middleware.auser #1966
• 5.0: Add ModelAdmin.show_facets by @q0w in 5.0: Add ModelAdmin.show_facets #1967
• ruff: Fix config warnings by @q0w in ruff: Fix config warnings #1964
• 5.0: Add BaseConstraint.violation_error_code by @q0w in 5.0: Add BaseConstraint.violation_error_code #1969
• 5.0: Add Signal.asend and Signal.asend_robust by @q0w in 5.0: Add Signal.asend and Signal.asend_robust #1965
• 5.0: Add QuerySet.(a)update_or_create new create_defaults arg by @q0w in 5.0: Add QuerySet.(a)update_or_create new create_defaults arg #1970
• 5.0: Add AdminSite.get_log_entries by @q0w in 5.0: Add AdminSite.get_log_entries #1963
• 5.0: Add gis ClosestPoint by @q0w in 5.0: Add gis ClosestPoint #1968
• 5.0: Rename save_existing arg instance to obj by @q0w in 5.0: Rename save_existing arg instance to obj #1971
• 5.0: Remove admin.helpers.checkbox by @q0w in 5.0: Remove admin.helpers.checkbox #1972
• 5.0: Change annotation_select_mask from set[str] to list[str] by @q0w in 5.0: Change annotation_select_mask from set[str] to list[str] #1973
• fixup: Pass violation_error_code to init by @q0w in fixup: Pass violation_error_code to init #1975
• Avoid returning None from get_field_related_model_cls by @SingingTree in Avoid returning None from get_field_related_model_cls #1956
• 5.0: Pass positional args name and violation_error_message to BaseConstraint by @q0w in 5.0: Pass positional args name and violation_error_message to BaseConstraint #1974
• 5.0: Remove pytz support by @q0w in 5.0: Remove pytz support #1980
• 5.0: Remove global setting USE_L10N by @q0w in 5.0: Remove global setting USE_L10N #1979
• 5.0: Remove OSMGeoAdmin, GeoModelAdmin by @q0w in 5.0: Remove OSMGeoAdmin, GeoModelAdmin #1981
• 5.0: Remove extra_tests arg for DiscoverRunner.build_suite/run_tests by @q0w in 5.0: Remove extra_tests arg for DiscoverRunner.build_suite/run_tests #1978
• 5.0: Remove django.utils baseconv and datetime_safe modules by @q0w in 5.0: Remove django.utils baseconv and datetime_safe modules #1977
• 5.0: Add request arg to ModelAdmin.lookup_allowed by @q0w in 5.0: Add request arg to ModelAdmin.lookup_allowed #1976
• Add URL converter protocol type by @adamchainz in Add URL converter protocol type #1984
• Fix type annotation for RegisterLookupMixin.class_lookups by @avoronov-box in Fix type annotation for RegisterLookupMixin.class_lookups #1962
• Update django to 5.0.3 by @sobolevn in Update django to 5.0.3 #1990
• Remove some deprecated Django 3.x APIs by @sobolevn in Remove some deprecated Django 3.x APIs #1991
• Fix BaseModelAdmin.view_on_site annotation by @cuu508 in Fix BaseModelAdmin.view_on_site annotation #1993
• Allow immutable extra_context on TemplateViews by @samueljsb in Allow immutable extra_context on TemplateViews #1994
• Add BoundField.html() by @pelme in Add BoundField.__html__() #1999
• Allow timedelta type for session.set_expiry() argument by @mlazar-endear in Allow timedelta type for session.set_expiry() argument #2001
• Bump pytest-mypy-plugins to 3.1.1 by @sobolevn in Bump pytest-mypy-plugins to 3.1.1 #2003
• Update mypy, add a bit more metadata by @sobolevn in Update mypy, add a bit more metadata #1997
• 5.0: Update django.contrib.auth by @ngnpope in 5.0: Update django.contrib.auth #2009
• 5.0: Update django.conf by @ngnpope in 5.0: Update django.conf #2008
• 5.0: Update django.views by @ngnpope in 5.0: Update django.views #2007
• 5.0: Update django.test by @ngnpope in 5.0: Update django.test #2005
• 5.0: Update django.utils by @ngnpope in 5.0: Update django.utils #2006
• Specify d.c.serializers.base.DeserializedObject.object type by @j00bar in Specify d.c.serializers.base.DeserializedObject.object type #2010
• Clean the cache on each run of stubtest by @sobolevn in Clean the cache on each run of stubtest #2015
• Keep abstract Django models internally in the plugin by @flaeppe in Keep abstract Django models internally in the plugin #2017
• Add GitHub actions release workflow by @flaeppe in Add GitHub actions release workflow #1950
• Adding missing Q methods: check(), flatten() by @Alexerson in Adding missing Q methods: check(), flatten() #1899
• Improve types in utils.termcolors by @Viicos in Improve types in utils.termcolors #1901
• Set the calculated metaclass when creating type info in the plugin by @flaeppe in Set the calculated metaclass when creating type info in the plugin #2025
• Do not annotate PRs with pyright by @sobolevn in Do not annotate PRs with pyright #2023
• Use PRI_MYPY in get_additional_deps hook by @sobolevn in Use PRI_MYPY in get_additional_deps hook #2024
• Update _default_manager and _base_manager to be Manager by @flaeppe in Update _default_manager and _base_manager to be Manager #2022
• Determine the type of queryset methods on unions by @delfick in Determine the type of queryset methods on unions #2027
• Add first stub for get_model_admin by @nebiyuelias1 in Add first stub for get_model_admin #2029
• 5.0: Update django.contrib.admin by @ngnpope in 5.0: Update django.contrib.admin #2004
• [5.0] Update core.files by @Viicos in [5.0] Update core.files #1949
• [5.0] Update core.cache.backends, add RedisCache and related classes by @Viicos in [5.0] Update core.cache.backends, add RedisCache and related classes #1948
• Fix AsyncClient.defaults attribute typing by @flaeppe in Fix AsyncClient.defaults attribute typing #1878
• Relax type for fields argument of Model.refresh_from_db() by @mthuurne in Relax type for fields argument of Model.refresh_from_db() #2035
• [5.0] Add missing stubs for geos by @nebiyuelias1 in [5.0] Add missing stubs for geos #2034
• Make AdminSite.get_model_admin generic by @Viicos in Make AdminSite.get_model_admin generic #2038
• [5.0] Add db_default= parameter to models Field classes by @Skorpyon in [5.0] Add db_default= parameter to models Field classes #1876
• Remove class Meta from Model and Form class stubs by @jorenham in Remove class Meta from Model and Form class stubs #2000
• Add datetime.timedelta as valid type for HttpRequest.get_signed_cookie() max_age argument. by @pelme in Add datetime.timedelta as valid type for HttpRequest.get_signed_cookie() max_age argument. #2045
• CI: Update Django 4.2 version used for test suite by @intgr in CI: Update Django 4.2 version used for test suite #2049
• Refine return type for ManyToOneRel.get_accessor_name() by @mthuurne in Refine return type for ManyToOneRel.get_accessor_name() #2052
• Add DeferredAttribute.__get__() by @mthuurne in Add DeferredAttribute.__get__() #2050
• Add missing methods and superclass to FieldFile by @mthuurne in Add missing methods and superclass to FieldFile #2051
• Add db_comment= parameter to Postgres and GIS model fields by @saJaeHyukc in Add db_comment= parameter to Postgres and GIS model fields #2054
• Correct type for db.models.sql.query.Query.join() argument by @mthuurne in Correct type for db.models.sql.query.Query.join() argument #2055
• 5.0: Update django.db.backends.oracle.base by @sudosubin in 5.0: Update django.db.backends.oracle.base #2057
• 5.0: Update django.test.client by @sudosubin in 5.0: Update django.test.client #2059
• 5.0: Update django.test.html by @sudosubin in 5.0: Update django.test.html #2060
• 5.0: Update django.test.runner by @sudosubin in 5.0: Update django.test.runner #2061
• 5.0: Update django.template, django.templatetags by @sudosubin in 5.0: Update django.template, django.templatetags #2063
• 5.0: Update django.test.testcases by @sudosubin in 5.0: Update django.test.testcases #2062
• 5.0: Update django.http by @sudosubin in 5.0: Update django.http #2064
• 5.0: Update django.core.management by @sudosubin in 5.0: Update django.core.management #2067
• 5.0: Update django.core.handlers by @sudosubin in 5.0: Update django.core.handlers #2066
• 5.0: Update django.contrib.sessions.serializers, django.core.serializers by @sudosubin in 5.0: Update django.contrib.sessions.serializers, django.core.serializers #2068
• Update django app related types by @sudosubin in Update django app related types #2071
• Add a returncode attribute to CommandError by @flaeppe in Add a returncode attribute to CommandError #2072
• Disable mypy ignore_missing_imports option by @sudosubin in Disable mypy ignore_missing_imports option #2058
• fix typing for URL validator.call by @asottile in fix typing for URL validator.__call__ #2074
• Use field generic types for descriptors by @md384 in Use field generic types for descriptors #2048
• 5.0: Update django.core.servers.basehttp by @sudosubin in 5.0: Update django.core.servers.basehttp #2070
• Update django.template.base.Template.render() argument type by @Majsvaffla in Update django.template.base.Template.render() argument type #1160
• 5.0: Add django.utils.choices by @sudosubin in 5.0: Add django.utils.choices #2075
• 5.0: Update django.contrib.sitemaps, django.contrib.staticfiles by @sudosubin in 5.0: Update django.contrib.sitemaps, django.contrib.staticfiles #2076
• Update pyright report options (reportMissingTypeArgument, reportPrivateUsage) by @sudosubin in Update pyright report options (reportMissingTypeArgument, reportPrivateUsage) #2077
• 5.0: Update django.contrib.postgres by @sudosubin in 5.0: Update django.contrib.postgres #2078
• Add path signature for async views by @jlost in Add path signature for async views #2085
• Remove incorrect Reversible base class from QuerySet by @intgr in Remove incorrect Reversible base class from QuerySet #2094
• Version 5.0.0 release (django-stubs, django-stubs-ext) by @flaeppe in Version 5.0.0 release (django-stubs, django-stubs-ext) #2087

New Contributors

• @Viicos made their first contribution in Fix type of AppConfig.models_module #1866
• @dephiros made their first contribution in Fix/pyright unknown #1873
• @jamesbraza made their first contribution in Added CommandParser to commands.__init__ #1927
• @mfosterw made their first contribution in Add through_defaults for RelatedManager methods #1943
• @palfrey made their first contribution in [5.0] Add django.db.models.GeneratedField #1944
• @yhay81 made their first contribution in Update type hints of contrib.auth.hashers #1955
• @delfick made their first contribution in deps: Upgrade pre-commit for newer versions of python #1961
• @SingingTree made their first contribution in Avoid returning None from get_field_related_model_cls #1956
• @avoronov-box made their first contribution in Fix type annotation for RegisterLookupMixin.class_lookups #1962
• @cuu508 made their first contribution in Fix BaseModelAdmin.view_on_site annotation #1993
• @samueljsb made their first contribution in Allow immutable extra_context on TemplateViews #1994
• @pelme made their first contribution in Add BoundField.__html__() #1999
• @mlazar-endear made their first contribution in Allow timedelta type for session.set_expiry() argument #2001
• @j00bar made their first contribution in Specify d.c.serializers.base.DeserializedObject.object type #2010
• @jorenham made their first contribution in Pyright joins the workflow in an advisory capacity #2019
• @fidoriel made their first contribution in Remove incorrect Collection base class and __contains__ method from QuerySet #1925
• @armanckeser made their first contribution in feat: Allow setting django_settings_module from env #2021
• @nebiyuelias1 made their first contribution in Add first stub for get_model_admin #2029
• @Skorpyon made their first contribution in [5.0] Add db_default= parameter to models Field classes #1876
• @saJaeHyukc made their first contribution in Add db_comment= parameter to Postgres and GIS model fields #2054
• @sudosubin made their first contribution in 5.0: Update django.db.backends.oracle.base #2057
• @md384 made their first contribution in Use field generic types for descriptors #2048
• @Majsvaffla made their first contribution in Update django.template.base.Template.render() argument type #1160
• @jlost made their first contribution in Add path signature for async views #2085

Full Changelog: 4.2.7...5.0.0

---

This discussion was created from the release 5.0.0.

[asottile]

please find a way to not ping everyone for the next one!

[intgr]

Haha, oops, good point!

I'd say this is a GitHub issue. We're using GitHub's autogenerated release note and I just checked this checkbox under the release options. It didn't give me any option to edit the message, just copypasted whole release notes with all user mentions.

[jorenham]

I don't mind 🤷🏻‍♂️