Opened 7 weeks ago
Last modified 12 days ago
#36504 new Cleanup/optimization
Docs: LazyObject for storages with override_settings does not behave as described
Reported by: | Dennis Brinkman | Owned by: | |
---|---|---|---|
Component: | Documentation | Version: | 5.2 |
Severity: | Normal | Keywords: | |
Cc: | Dennis Brinkman | Triage Stage: | Accepted |
Has patch: | yes | Needs documentation: | no |
Needs tests: | no | Patch needs improvement: | yes |
Easy pickings: | no | UI/UX: | no |
Description
Dear Django Team,
While working on my own Django project using storages, I found an error in the [Managing Files - Using a callable](https://docs.djangoproject.com/en/5.2/topics/files/#using-a-callable) documentation (the last two code blocks to be precise). As it turns out, the solution of using the override_settings
decorator does not work as advertised while testing FileField
s.
I have made a minimal Django project (https://github.com/Brinky5678/django_incorrect_docs_demo) for easy replication. In the readme, I have included steps to how to replicate, as well as the cause of why I think it does not work as expected.
This ticket is not meant to provide a workable solution using the override_settings
decorator. Instead, I merely wish to have the documentation updated in such a way that the warning of the storage callables being evaluated during model loading remains, but without the incorrect documentation about using LazyObject
s.
Change History (4)
comment:1 by , 7 weeks ago
Triage Stage: | Unreviewed → Accepted |
---|
comment:3 by , 12 days ago
Has patch: | set |
---|
comment:4 by , 12 days ago
Patch needs improvement: | set |
---|
Thanks for the report and the test project. I confirmed using the test project that the documented example doesn't work. For reference, the section was added by #36269.