Package: django-cleanup
FeaturesThe django-cleanup app automatically deletes files forFileField,ImageFieldand
subclasses. When aFileField’s value is changed and the model is saved, the old file is
deleted. When a model that has aFileFieldis deleted, the file is also deleted. A file that
is set as theFileField’s default value will not be deleted.CompatibilityDjango 3.2, 4.1, 4.2, 5.0 (See Django Supported Versions)Python 3.6+Compatible withsorl-thumbnailCompatible witheasy-thumbnailHow does it work?In order to track changes of aFileFieldand facilitate file deletions, django-cleanup
connectspost_init,pre_save,post_saveandpost_deletesignals to
signal handlers for eachINSTALLED_APPSmodel that has aFileField. In order to tell
whether or not aFileField’s value has changed a local cache of original values is kept on
the model instance. If a condition is detected that should result in a file deletion, a function to
delete the file is setup and inserted into the commit phase of the current transaction.Warning! Please be aware of the known limitations documented below!Installationpip install django-cleanupConfigurationAdddjango_cleanupto the bottom ofINSTALLED_APPSinsettings.pyINSTALLED_APPS=(...,'django_cleanup.apps.CleanupConfig',)That is all, no other configuration is necessary.Note: Order ofINSTALLED_APPSis important. To ensure that exceptions inside other apps’ signal
handlers do not affect the integrity of file deletions within transactions,django_cleanupshould be placed last inINSTALLED_APPS.TroubleshootingIf you notice thatdjango-cleanupis not removing files when expected, check that your models
are being properlyloaded:You must define or import all models in your application’s models.py or models/__init__.py.
Otherwise, the application registry may not be fully populated at this point, which could cause
the ORM to malfunction.If your models are not loaded,django-cleanupwill not be able to discover theirFileField’s.You can check if yourModelis loaded by usingfromdjango.appsimportappsapps.get_models()Known limitationsDatabase should support transactionsIf you are using a database that does not support transactions you may lose files if a
transaction will rollback at the right instance. This outcome is mitigated by our use of
post_save and post_delete signals, and by following the recommended configuration in this README.
This outcome will still occur if there are signals registered after app initialization and there are
exceptions when those signals are handled. In this case, the old file will be lost and the new file
will not be referenced in a model, though the new file will likely still exist on disk. If you are
concerned about this behavior you will need another solution for old file deletion in your project.File referenced by multiple model instancesThis app is designed with the assumption that each file is referenced only once. If you are sharing
a file over two or more model instances you will not have the desired functionality. Be cautious of
copying model instances, as this will cause a file to be shared by more than one instance. If you
want to reference a file from multiple models add a level of indirection. That is, use a separate
file model that is referenced from other models through a foreign key. There are many file
management apps already available in the django ecosystem that fulfill this behavior.AdvancedThis section contains additional functionality that can be used to interact with django-cleanup for
special cases.SignalsTo facilitate interactions with other django apps django-cleanup sends the following signals which
can be imported fromdjango_cleanup.signals:cleanup_pre_delete: just before a file is deleted. Passes afilekeyword argument.cleanup_post_delete: just after a file is deleted. Passes afilekeyword argument.Signals example for sorl.thumbnail:fromdjango_cleanup.signalsimportcleanup_pre_deletefromsorl.thumbnailimportdeletedefsorl_delete(**kwargs):delete(kwargs['file'])cleanup_pre_delete.connect(sorl_delete)Refresh the cacheThere have been rare cases where the cache would need to be refreshed. To do so thedjango_cleanup.cleanup.refreshmethod can be used:fromdjango_cleanupimportcleanupcleanup.refresh(model_instance)Ignore cleanup for a specific modelTo ignore a model and not have cleanup performed when the model is deleted or its files change, use
theignoredecorator to mark that model:fromdjango_cleanupimportcleanup@cleanup.ignoreclassMyModel(models.Model):image=models.FileField()Only cleanup selected modelsIf you have many models to ignore, or if you prefer to be explicit about what models are selected,
you can change the mode of django-cleanup to “select mode” by using the select mode app config. In
yourINSTALLED_APPSsetting you will replace ‘django_cleanup.apps.CleanupConfig’
with ‘django_cleanup.apps.CleanupSelectedConfig’. Then use theselectdecorator to
mark a model for cleanup:fromdjango_cleanupimportcleanup@cleanup.selectclassMyModel(models.Model):image=models.FileField()How to run testsInstall, setup and usepyenvto install all the required versions of cPython
(see thetox.ini).Setuppyenvto have all versions of python activated within your local django-cleanup repository.
Ensuring that the python 3.12 that was installed is first priority.Installtoxon python 3.12 and run thetoxcommand from your local django-cleanup
repository.How to write testsThis app requires the use ofdjango.test.TransactionTestCasewhen writing tests.For details on why this is required seehere:Django’sTestCaseclass wraps each test in a transaction and rolls back that transaction
after each test, in order to provide test isolation. This means that no transaction is ever
actually committed, thus youron_commit()callbacks will never be run. If you need to
test the results of anon_commit()callback, use aTransactionTestCaseinstead.Licensedjango-cleanup is free software under terms of the:MIT LicenseCopyright (C) 2012 by Ilya Shalyapin,ishalyapin@gmail.comPermission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the “Software”), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.