Opened 4 weeks ago

Closed 3 weeks ago

#35869 closed Cleanup/optimization (wontfix)

Add explicit warning when AppConfig.create() can't choose from multiple subclasses of AppConfig

Reported by: schnee Owned by: schnee
Component: Core (Other) Version: 5.0
Severity: Normal Keywords: AppConfig
Cc: Aymeric Augustin Triage Stage: Accepted
Has patch: yes Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: no UI/UX: no

Description

When I upgraded my Django project from 3.2 to 4.2, I found that the ready method in my custom AppConfig was never executed.

Example Code:

# apps/demo/__init__.py

default_app_config = "apps.demo.CustomAppConfig"
# apps/demo/apps.py

from django.apps import AppConfig


class PlugableAppConfig(AppConfig):

    def ready(self):
        # do something...


class CustomAppConfig(PlugableAppConfig):
    name = "apps.demo"
    
    def ready(self):
        super().ready()
        # do something...

After debugging, reading documentation, and comparing version code, I determined that the reason was that Django 3.2 added support for automatic detection for AppConfig to replace default_app_config, and support for the latter was completely removed in version 4.1.

This is a great new feature, but if there are multiple subclasses of AppConfig in apps.py and none of them specify default as True (legacy code), AppConfig.create() will default to using the Base AppConfig without any explicit warning.

This could lead to additional troubleshooting costs for developers. Therefore, I suggest that when AppConfig.create() cannot choose among multiple subclasses of AppConfig and defaults to using the Base AppConfig, a warning should be raised to alert developers.

Change History (5)

comment:1 by schnee, 4 weeks ago

Cc: schnee removed

comment:2 by Sarah Boyce, 4 weeks ago

Cc: Aymeric Augustin added
Triage Stage: UnreviewedAccepted

Thank you, this makes sense to me

comment:3 by Sarah Boyce, 4 weeks ago

Owner: set to schnee
Status: newassigned

comment:5 by Sarah Boyce, 3 weeks ago

Resolution: wontfix
Status: assignedclosed

In reviewing the patch, I saw that there was a similar deprecation warning which has been removed as we are out of the depreciation period, see https://github.com/django/django/commit/e5fce539bcd7d5cf73cf79aa068cb42aab39a726#diff-0f8bc657bc27c9f80385c4814c2c2ebc033bda3e03285a7212965309a481cc70R163-R170

As you experienced this updating from 3.2 to 4.2, this warning would have been available, the question is now whether we should have a permanent warning or whether this was only a case for upgrading between versions

If you think a warning is still valuable, you need to start a discussion on the Django forum and get community agreement that this is needed.
I will close the ticket for now as wontfix this can be reopened if the community agrees this is needed

Note: See TracTickets for help on using tickets.
Back to Top