Backward compatability issues: BaseConnectionHandler.all() got an unexpected keyword argument 'initialized_only'

[ovsds]

In 3.5.0 used BaseConnectionHandler.all(initialized_only=True):
4b77ec7#diff-72ecd973e54107d746eff0947206cbdbe24cbb3c42216b00615e64d49ca70d73R216-R217

Which is only added in Django 4.1b1:
django/django@4f92cf8#diff-dbe1d4538efcca9f9a6157d5d3de919e0844835a7ccc698bb8c5d4a9eb06e274R75-R81

Which causes crash on any pageload if middleware debug_toolbar.middleware.DebugToolbarMiddleware is on.

[matthiask]

Hmm interesting. We should have unittests covering this. Also, I'm running django-debug-toolbar 3.5 locally with Django 4.0.x without any problems, including the cache panel. I'm not completely sure what's going on here.

cc @living180

[ovsds]

Hmm interesting. We should have unittests covering this. Also, I'm running django-debug-toolbar 3.5 locally with Django 4.0.x without any problems, including the cache panel. I'm not completely sure what's going on here.

cc @living180

If you need me to provide any additional info feel free to ask, but I tried it pretty straightforward way: created new app on default Django 4.0.5 template, added 3.5.0 toolbar using instructions and it crashed on slash page. Reversing toolbar to 3.4.0 worked. On the PRs above you can clearly see what broke there.

[tim-schilling]

If you need me to provide any additional info feel free to ask

Can you please provide the full stacktrace and error message?

[ovsds]

My bad, I rechecked and 3.5.0 works perfectly for 4.0+, but not for 3.2.*

Django added initialized_only attribute support for CacheHandler.all in 4.0a1:
django/django@958cdf6
In my original post i misplaced it with commit where it was moved to BaseConnectionHandler.

Not sure if it's intended, cus last compatability deprication was in 3.3.0 and it says:
Removed support for Django < 3.2.
Thought it would still leave room for 3.2.* to work.

Here is the trace with Django==3.2 and django_debug_toolbar==3.5.0:

Environment:


Request Method: GET
Request URL: http://127.0.0.1:7000/

Django Version: 3.2
Python Version: 3.9.13
Installed Applications:
['django.contrib.admin',
 'django.contrib.auth',
 'django.contrib.contenttypes',
 'django.contrib.sessions',
 'django.contrib.messages',
 'django.contrib.staticfiles',
 'debug_toolbar']
Installed Middleware:
['django.middleware.security.SecurityMiddleware',
 'django.contrib.sessions.middleware.SessionMiddleware',
 'django.middleware.common.CommonMiddleware',
 'django.middleware.csrf.CsrfViewMiddleware',
 'django.contrib.auth.middleware.AuthenticationMiddleware',
 'django.contrib.messages.middleware.MessageMiddleware',
 'django.middleware.clickjacking.XFrameOptionsMiddleware',
 'debug_toolbar.middleware.DebugToolbarMiddleware']



Traceback (most recent call last):
  File "/home/ovsds/Projects/djangoProject/venv/lib/python3.9/site-packages/django/core/handlers/exception.py", line 47, in inner
    response = get_response(request)
  File "/home/ovsds/Projects/djangoProject/venv/lib/python3.9/site-packages/debug_toolbar/middleware.py", line 55, in __call__
    panel.enable_instrumentation()
  File "/home/ovsds/Projects/djangoProject/venv/lib/python3.9/site-packages/debug_toolbar/panels/cache.py", line 206, in enable_instrumentation
    for cache in caches.all(initialized_only=True):

Exception Type: TypeError at /
Exception Value: all() got an unexpected keyword argument 'initialized_only'

[living180]

The commit you linked to was also backported to the 3.2.x branch and was first available in 3.2.4, released in June 2021. So yes, 3.2.0 won't work, but more recent 3.2 releases will. @matthiask and @tim-schilling is full compatiblity with all 3.2.x releases required? I when I used the initialized_only argument I didn't realize it was only added after 3.2.0.

[ovsds]

The commit you linked to was also backported to the 3.2.x branch and was first available in 3.2.4, released in June 2021. So yes, 3.2.0 won't work, but more recent 3.2 releases will. @matthiask and @tim-schilling is full compatiblity with all 3.2.x releases required? I when I used the initialized_only argument I didn't realize it was only added after 3.2.0.

Oh i see now, thanks for the 3.2.4 notice, didn't see it at first.

Still thinks it's a good idea to move version deprecation forward to <3.2.4 then.

[matthiask]

Thanks all! I think it's fine to depend on the latest version in the 3.2 LTS series. Maybe this should be documented somewhere, but since the Django developers decided that the change should be backported I'm fine with depending on this (since it reduces the work we have to do to nothing)

addendum: We might want to change the Django dependency to Django >= 3.2.4 in setup.cfg.

[ovsds]

addendum: We might want to change the Django dependency to Django >= 3.2.4 in setup.cfg.

That would be really nice. Thanks.