././@PaxHeader0000000000000000000000000000003400000000000010212 xustar0028 mtime=1618765485.2001565 django-cleanup-5.2.0/0000755000076500000240000000000000000000000014165 5ustar00MarioRosastaff././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1618765179.0 django-cleanup-5.2.0/CHANGELOG.md0000644000076500000240000001067700000000000016011 0ustar00MarioRosastaff# Changelog All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). ## [Unreleased] ## [5.2.0] - 2021-04-18 ### Added - New test to ensure cache is reset on create. PR [#81] from [@Flauschbaellchen](https://github.com/Flauschbaellchen). ### Changed - Update to run tests for django 3.2. - Update to document support for django 3.2. - Update to run tests for python 3.9. PR [#80] from [@D3X](https://github.com/D3X). - Reset cache for created instances in the post_save handler. PR [#81] from [@Flauschbaellchen](https://github.com/Flauschbaellchen). ## [5.1.0] - 2020-09-15 ### Added - This change log. Resolves issue [#73] for [@DmytroLitvinov](https://github.com/DmytroLitvinov). ### Changed - Update to run tests for django 3.1. PR [#76] from [@johnthagen](https://github.com/johnthagen). - Update to document support for django 3.1. PR [#76] from [@johnthagen](https://github.com/johnthagen). ### Removed - Removed providing_args kwarg from Signal construction. PR [#74] from [@coredumperror](https://github.com/coredumperror). ## [5.0.0] - 2020-06-07 ## [4.0.1] - 2020-06-06 ## [4.0.0] - 2019-07-13 ## [3.2.0] - 2019-02-17 ## [3.1.0] - 2019-02-05 ## [3.0.1] - 2018-11-18 ## [3.0.0] - 2018-11-18 ## [2.1.0] - 2017-12-30 ## [2.0.0] - 2017-12-27 ## [1.1.0] - 2017-12-27 ## [1.0.1] - 2017-07-14 ## [1.0.0] - 2017-06-30 ## [0.4.2] - 2015-12-17 ## [0.4.1] - 2015-12-02 ## [0.4.0] - 2015-10-06 ## [0.3.1] - 2015-06-25 ## [0.3.0] - 2015-05-12 ## [0.2.1] - 2015-03-07 ## [0.2.0] - 2015-03-06 ## [0.1.13] - 2015-02-21 ## [0.1.12] - 2015-02-08 ## [0.1.11] - 2015-02-01 ## [0.1.10] - 2014-04-29 ## [0.1.9] - 2014-04-29 ## [0.1.8] - 2013-04-07 ## [0.1.7] - 2013-04-03 ## [0.1.6] - 2013-02-12 ## [0.1.5] - 2012-08-17 ## [0.1.4] - 2012-08-16 ## [0.1.0] - 2012-08-14 [Unreleased]: https://github.com/un1t/django-cleanup/compare/5.1.0...HEAD [5.2.0]: https://github.com/un1t/django-cleanup/compare/5.1.0...5.2.0 [5.1.0]: https://github.com/un1t/django-cleanup/compare/5.0.0...5.1.0 [5.0.0]: https://github.com/un1t/django-cleanup/compare/4.0.1...5.0.0 [4.0.1]: https://github.com/un1t/django-cleanup/compare/4.0.0...4.0.1 [4.0.0]: https://github.com/un1t/django-cleanup/compare/3.2.0...4.0.0 [3.2.0]: https://github.com/un1t/django-cleanup/compare/3.1.0...3.2.0 [3.1.0]: https://github.com/un1t/django-cleanup/compare/3.0.1...3.1.0 [3.0.1]: https://github.com/un1t/django-cleanup/compare/3.0.0...3.0.1 [3.0.0]: https://github.com/un1t/django-cleanup/compare/2.1.0...3.0.0 [2.1.0]: https://github.com/un1t/django-cleanup/compare/2.0.0...2.1.0 [2.0.0]: https://github.com/un1t/django-cleanup/compare/1.1.0...2.0.0 [1.1.0]: https://github.com/un1t/django-cleanup/compare/1.0.1...1.1.0 [1.0.1]: https://github.com/un1t/django-cleanup/compare/1.0.0...1.0.1 [1.0.0]: https://github.com/un1t/django-cleanup/compare/0.4.2...1.0.0 [0.4.2]: https://github.com/un1t/django-cleanup/compare/0.4.1...0.4.2 [0.4.1]: https://github.com/un1t/django-cleanup/compare/0.4.0...0.4.1 [0.4.0]: https://github.com/un1t/django-cleanup/compare/0.3.1...0.4.0 [0.3.1]: https://github.com/un1t/django-cleanup/compare/0.3.0...0.3.1 [0.3.0]: https://github.com/un1t/django-cleanup/compare/0.2.1...0.3.0 [0.2.1]: https://github.com/un1t/django-cleanup/compare/0.2.0...0.2.1 [0.2.0]: https://github.com/un1t/django-cleanup/compare/0.1.13...0.2.0 [0.1.13]: https://github.com/un1t/django-cleanup/compare/0.1.12...0.1.13 [0.1.12]: https://github.com/un1t/django-cleanup/compare/0.1.11...0.1.12 [0.1.11]: https://github.com/un1t/django-cleanup/compare/0.1.10...0.1.11 [0.1.10]: https://github.com/un1t/django-cleanup/compare/0.1.9...0.1.10 [0.1.9]: https://github.com/un1t/django-cleanup/compare/0.1.8...0.1.9 [0.1.8]: https://github.com/un1t/django-cleanup/compare/0.1.7...0.1.8 [0.1.7]: https://github.com/un1t/django-cleanup/compare/0.1.6...0.1.7 [0.1.6]: https://github.com/un1t/django-cleanup/compare/0.1.5...0.1.6 [0.1.5]: https://github.com/un1t/django-cleanup/compare/0.1.4...0.1.5 [0.1.4]: https://github.com/un1t/django-cleanup/compare/0.1.0...0.1.4 [0.1.0]: https://github.com/un1t/django-cleanup/releases/tag/0.1.0 [#81]: https://github.com/un1t/django-cleanup/pull/81 [#80]: https://github.com/un1t/django-cleanup/pull/80 [#76]: https://github.com/un1t/django-cleanup/pull/76 [#74]: https://github.com/un1t/django-cleanup/pull/74 [#73]: https://github.com/un1t/django-cleanup/issues/73 ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1591530991.0 django-cleanup-5.2.0/LICENSE0000644000076500000240000000211000000000000015164 0ustar00MarioRosastaffMIT License Copyright (C) 2012 by Ilya Shalyapin, ishalyapin@gmail.com Permission 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. ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1600202711.0 django-cleanup-5.2.0/MANIFEST.in0000644000076500000240000000007000000000000015720 0ustar00MarioRosastaffinclude README.rst include LICENSE include CHANGELOG.md ././@PaxHeader0000000000000000000000000000003400000000000010212 xustar0028 mtime=1618765485.2003827 django-cleanup-5.2.0/PKG-INFO0000644000076500000240000002447200000000000015273 0ustar00MarioRosastaffMetadata-Version: 2.1 Name: django-cleanup Version: 5.2.0 Summary: Deletes old files. Home-page: https://github.com/un1t/django-cleanup Author: Ilya Shalyapin Author-email: ishalyapin@gmail.com License: MIT License Download-URL: https://github.com/un1t/django-cleanup/tarball/master Description: Django Cleanup ************** |Version| |Status| |License| Features ======== The django-cleanup app automatically deletes files for :code:`FileField`, :code:`ImageField` and subclasses. When a :code:`FileField`'s value is changed and the model is saved, the old file is deleted. When a model that has a :code:`FileField` is deleted, the file is also deleted. A file that is set as the :code:`FileField`'s default value will not be deleted. Compatibility ------------- - Django 2.2, 3.0, 3.1, 3.2 (`See Django Supported Versions `_) - Python 3.5+ - Compatible with `sorl-thumbnail `_ - Compatible with `easy-thumbnail `_ How does it work? ================= In order to track changes of a :code:`FileField` and facilitate file deletions, django-cleanup connects :code:`post_init`, :code:`pre_save`, :code:`post_save` and :code:`post_delete` signals to signal handlers for each :code:`INSTALLED_APPS` model that has a :code:`FileField`. In order to tell whether or not a :code:`FileField`'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! If 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 below. 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.** Installation ============ :: pip install django-cleanup Configuration ============= Add ``django_cleanup`` to the bottom of ``INSTALLED_APPS`` in ``settings.py`` .. code-block:: py INSTALLED_APPS = ( ..., 'django_cleanup.apps.CleanupConfig', ) That is all, no other configuration is necessary. Note: Order of ``INSTALLED_APPS`` is important. To ensure that exceptions inside other apps' signal handlers do not affect the integrity of file deletions within transactions, ``django_cleanup`` should be placed last in ``INSTALLED_APPS``. Troubleshooting =============== If you notice that ``django-cleanup`` is not removing files when expected, check that your models are being properly `loaded `_: 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-cleanup`` will not be able to discover their ``FileField``'s. You can check if your ``Model`` is loaded by using .. code-block:: py from django.apps import apps apps.get_models() Advanced ======== This section contains additional functionality that can be used to interact with django-cleanup for special cases. Signals ------- To facilitate interactions with other django apps django-cleanup sends the following signals which can be imported from :code:`django_cleanup.signals`: - :code:`cleanup_pre_delete`: just before a file is deleted. Passes a :code:`file` keyword argument. - :code:`cleanup_post_delete`: just after a file is deleted. Passes a :code:`file` keyword argument. Signals example for sorl.thumbnail: .. code-block:: py from django_cleanup.signals import cleanup_pre_delete from sorl.thumbnail import delete def sorl_delete(**kwargs): delete(kwargs['file']) cleanup_pre_delete.connect(sorl_delete) Refresh the cache ----------------- There have been rare cases where the cache would need to be refreshed. To do so the :code:`django_cleanup.cleanup.refresh` method can be used: .. code-block:: py from django_cleanup import cleanup cleanup.refresh(model_instance) Ignore cleanup for a specific model ----------------------------------- Ignore a model and do not perform cleanup when the model is deleted or its files change. .. code-block:: py from django_cleanup import cleanup @cleanup.ignore class MyModel(models.Model): image = models.FileField() How to run tests ================ Install, setup and use pyenv_ to install all the required versions of cPython (see the `tox.ini `_). Setup pyenv_ to have all versions of python activated within your local django-cleanup repository. Ensuring that the python 3.8 that was installed is first priority. Install tox_ on python 3.8 and run the :code:`tox` command from your local django-cleanup repository. How to write tests ================== This app requires the use of django.test.TransactionTestCase_ when writing tests. For details on why this is required see `here `_: Django's :code:`TestCase` class 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 your :code:`on_commit()` callbacks will never be run. If you need to test the results of an :code:`on_commit()` callback, use a :code:`TransactionTestCase` instead. License ======= django-cleanup is free software under terms of the: MIT License Copyright (C) 2012 by Ilya Shalyapin, ishalyapin@gmail.com Permission 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. .. _django.test.TransactionTestCase: https://docs.djangoproject.com/en/stable/topics/testing/tools/#django.test.TransactionTestCase .. _pyenv: https://github.com/pyenv/pyenv .. _tox: https://tox.readthedocs.io/en/latest/ .. |Version| image:: https://img.shields.io/pypi/v/django-cleanup.svg :target: https://pypi.python.org/pypi/django-cleanup/ :alt: PyPI Package .. |Status| image:: https://travis-ci.org/un1t/django-cleanup.svg?branch=master :target: https://travis-ci.org/un1t/django-cleanup :alt: Build Status .. |License| image:: https://img.shields.io/badge/license-MIT-maroon :target: https://github.com/un1t/django-cleanup/blob/master/LICENSE :alt: MIT License Keywords: django Platform: UNKNOWN Classifier: Development Status :: 5 - Production/Stable Classifier: Environment :: Web Environment Classifier: Framework :: Django Classifier: Framework :: Django :: 2.2 Classifier: Framework :: Django :: 3.0 Classifier: Framework :: Django :: 3.1 Classifier: Framework :: Django :: 3.2 Classifier: Intended Audience :: Developers Classifier: License :: OSI Approved :: MIT License Classifier: Operating System :: OS Independent Classifier: Programming Language :: Python Classifier: Programming Language :: Python :: 3 Classifier: Programming Language :: Python :: 3.5 Classifier: Programming Language :: Python :: 3.6 Classifier: Programming Language :: Python :: 3.7 Classifier: Programming Language :: Python :: 3.8 Classifier: Programming Language :: Python :: 3.9 Classifier: Programming Language :: Python :: Implementation :: CPython Classifier: Programming Language :: Python :: Implementation :: PyPy Classifier: Topic :: Utilities Requires: python (>=3.5) Requires: django (>=2.2) Description-Content-Type: text/x-rst ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1618765179.0 django-cleanup-5.2.0/README.rst0000644000076500000240000001677100000000000015670 0ustar00MarioRosastaffDjango Cleanup ************** |Version| |Status| |License| Features ======== The django-cleanup app automatically deletes files for :code:`FileField`, :code:`ImageField` and subclasses. When a :code:`FileField`'s value is changed and the model is saved, the old file is deleted. When a model that has a :code:`FileField` is deleted, the file is also deleted. A file that is set as the :code:`FileField`'s default value will not be deleted. Compatibility ------------- - Django 2.2, 3.0, 3.1, 3.2 (`See Django Supported Versions `_) - Python 3.5+ - Compatible with `sorl-thumbnail `_ - Compatible with `easy-thumbnail `_ How does it work? ================= In order to track changes of a :code:`FileField` and facilitate file deletions, django-cleanup connects :code:`post_init`, :code:`pre_save`, :code:`post_save` and :code:`post_delete` signals to signal handlers for each :code:`INSTALLED_APPS` model that has a :code:`FileField`. In order to tell whether or not a :code:`FileField`'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! If 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 below. 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.** Installation ============ :: pip install django-cleanup Configuration ============= Add ``django_cleanup`` to the bottom of ``INSTALLED_APPS`` in ``settings.py`` .. code-block:: py INSTALLED_APPS = ( ..., 'django_cleanup.apps.CleanupConfig', ) That is all, no other configuration is necessary. Note: Order of ``INSTALLED_APPS`` is important. To ensure that exceptions inside other apps' signal handlers do not affect the integrity of file deletions within transactions, ``django_cleanup`` should be placed last in ``INSTALLED_APPS``. Troubleshooting =============== If you notice that ``django-cleanup`` is not removing files when expected, check that your models are being properly `loaded `_: 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-cleanup`` will not be able to discover their ``FileField``'s. You can check if your ``Model`` is loaded by using .. code-block:: py from django.apps import apps apps.get_models() Advanced ======== This section contains additional functionality that can be used to interact with django-cleanup for special cases. Signals ------- To facilitate interactions with other django apps django-cleanup sends the following signals which can be imported from :code:`django_cleanup.signals`: - :code:`cleanup_pre_delete`: just before a file is deleted. Passes a :code:`file` keyword argument. - :code:`cleanup_post_delete`: just after a file is deleted. Passes a :code:`file` keyword argument. Signals example for sorl.thumbnail: .. code-block:: py from django_cleanup.signals import cleanup_pre_delete from sorl.thumbnail import delete def sorl_delete(**kwargs): delete(kwargs['file']) cleanup_pre_delete.connect(sorl_delete) Refresh the cache ----------------- There have been rare cases where the cache would need to be refreshed. To do so the :code:`django_cleanup.cleanup.refresh` method can be used: .. code-block:: py from django_cleanup import cleanup cleanup.refresh(model_instance) Ignore cleanup for a specific model ----------------------------------- Ignore a model and do not perform cleanup when the model is deleted or its files change. .. code-block:: py from django_cleanup import cleanup @cleanup.ignore class MyModel(models.Model): image = models.FileField() How to run tests ================ Install, setup and use pyenv_ to install all the required versions of cPython (see the `tox.ini `_). Setup pyenv_ to have all versions of python activated within your local django-cleanup repository. Ensuring that the python 3.8 that was installed is first priority. Install tox_ on python 3.8 and run the :code:`tox` command from your local django-cleanup repository. How to write tests ================== This app requires the use of django.test.TransactionTestCase_ when writing tests. For details on why this is required see `here `_: Django's :code:`TestCase` class 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 your :code:`on_commit()` callbacks will never be run. If you need to test the results of an :code:`on_commit()` callback, use a :code:`TransactionTestCase` instead. License ======= django-cleanup is free software under terms of the: MIT License Copyright (C) 2012 by Ilya Shalyapin, ishalyapin@gmail.com Permission 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. .. _django.test.TransactionTestCase: https://docs.djangoproject.com/en/stable/topics/testing/tools/#django.test.TransactionTestCase .. _pyenv: https://github.com/pyenv/pyenv .. _tox: https://tox.readthedocs.io/en/latest/ .. |Version| image:: https://img.shields.io/pypi/v/django-cleanup.svg :target: https://pypi.python.org/pypi/django-cleanup/ :alt: PyPI Package .. |Status| image:: https://travis-ci.org/un1t/django-cleanup.svg?branch=master :target: https://travis-ci.org/un1t/django-cleanup :alt: Build Status .. |License| image:: https://img.shields.io/badge/license-MIT-maroon :target: https://github.com/un1t/django-cleanup/blob/master/LICENSE :alt: MIT License ././@PaxHeader0000000000000000000000000000003400000000000010212 xustar0028 mtime=1618765485.1983001 django-cleanup-5.2.0/django_cleanup/0000755000076500000240000000000000000000000017136 5ustar00MarioRosastaff././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1618765179.0 django-cleanup-5.2.0/django_cleanup/__init__.py0000644000076500000240000000044500000000000021252 0ustar00MarioRosastaff''' django-cleanup automatically deletes files for FileField, ImageField, and subclasses. It will delete old files when a new file is being save and it will delete files on model instance deletion. ''' __version__ = '5.2.0' default_app_config = 'django_cleanup.apps.CleanupConfig' ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1591532199.0 django-cleanup-5.2.0/django_cleanup/apps.py0000644000076500000240000000050400000000000020452 0ustar00MarioRosastaff''' AppConfig for django-cleanup, prepare the cache and connect signal handlers ''' from django.apps import AppConfig from . import cache, handlers class CleanupConfig(AppConfig): name = 'django_cleanup' verbose_name = 'Django Cleanup' def ready(self): cache.prepare() handlers.connect() ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1591532199.0 django-cleanup-5.2.0/django_cleanup/cache.py0000644000076500000240000001115300000000000020554 0ustar00MarioRosastaff''' Our local cache of filefields, everything is private to this package.''' from collections import defaultdict from django.apps import apps from django.db import models from django.utils.module_loading import import_string CACHE_NAME = '_django_cleanup_original_cache' def fields_default(): return set() FIELDS = defaultdict(fields_default) def fields_dict_default(): return {} FIELDS_FIELDS = defaultdict(fields_dict_default) FIELDS_STORAGE = defaultdict(fields_dict_default) DOTTED_PATH = '{klass.__module__}.{klass.__qualname__}' # cache init ## def prepare(): '''Prepare the cache for all models, non-reentrant''' if FIELDS: # pragma: no cover return for model in apps.get_models(): if ignore_model(model): continue name = get_model_name(model) if model_has_filefields(name): # pragma: no cover continue opts = model._meta for field in opts.get_fields(): if isinstance(field, models.FileField): add_field_for_model(name, field.name, field) def add_field_for_model(model_name, field_name, field): '''Centralized function to make all our local caches.''' # store models that have filefields and the field names FIELDS[model_name].add(field_name) # store the dotted path of the field class for each field # in case we need to restore it later on FIELDS_FIELDS[model_name][field_name] = get_dotted_path(field) # also store the dotted path of the storage for the same reason FIELDS_STORAGE[model_name][field_name] = get_dotted_path(field.storage) # generators ## def get_fields_for_model(model_name, exclude=None): '''Get the filefields for a model if it has them''' if model_has_filefields(model_name): fields = FIELDS[model_name] if exclude is not None: assert isinstance(exclude, set) fields = fields.difference(exclude) for field_name in fields: yield field_name def fields_for_model_instance(instance, using=None): ''' Yields (name, descriptor) for each file field given an instance Can use the `using` kwarg to change the instance that the `FieldFile` will receive. ''' if using is None: using = instance model_name = get_model_name(instance) deferred_fields = instance.get_deferred_fields() for field_name in get_fields_for_model(model_name, exclude=deferred_fields): fieldfile = getattr(instance, field_name, None) yield field_name, fieldfile.__class__(using, fieldfile.field, fieldfile.name) # restore ## def get_field(model_name, field_name): '''Restore a field from its dotted path''' return import_string(FIELDS_FIELDS[model_name][field_name]) def get_field_storage(model_name, field_name): '''Restore a storage from its dotted path''' return import_string(FIELDS_STORAGE[model_name][field_name]) # utilities ## def get_dotted_path(object_): '''get the dotted path for an object''' return DOTTED_PATH.format(klass=object_.__class__) def get_model_name(model): '''returns a unique model name''' return '{opt.app_label}.{opt.model_name}'.format(opt=model._meta) def get_mangled_ignore(model): '''returns a mangled attribute name specific to the model''' return '_{opt.model_name}__{opt.app_label}_cleanup_ignore'.format(opt=model._meta) # booleans ## def model_has_filefields(model_name): '''Check if a model has filefields''' return model_name in FIELDS def ignore_model(model): '''Check if a model should be ignored''' return hasattr(model, get_mangled_ignore(model)) # instance functions ## def remove_instance_cache(instance): '''Remove the cache from an instance''' if has_cache(instance): delattr(instance, CACHE_NAME) def make_cleanup_cache(instance, source=None): ''' Make the cleanup cache for an instance. Can also change the source of the data with the `source` kwarg. ''' if source is None: source = instance setattr(instance, CACHE_NAME, dict( fields_for_model_instance(source, using=instance))) def has_cache(instance): '''Check if an instance has a cache on it''' return hasattr(instance, CACHE_NAME) def get_field_attr(instance, field_name): '''Get a value from the cache on an instance''' return getattr(instance, CACHE_NAME)[field_name] # data sharing ## def cleanup_models(): '''Get all the models we have in the FIELDS cache''' for model_name in FIELDS: yield apps.get_model(model_name) def cleanup_fields(): '''Get a copy of the FIELDS cache''' return FIELDS.copy() ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1591532199.0 django-cleanup-5.2.0/django_cleanup/cleanup.py0000644000076500000240000000066600000000000021147 0ustar00MarioRosastaff'''Public utilities''' from .cache import ( get_mangled_ignore as _get_mangled_ignore, make_cleanup_cache as _make_cleanup_cache) __all__ = ['refresh', 'cleanup_ignore'] def refresh(instance): '''Refresh the cache for an instance''' return _make_cleanup_cache(instance) def ignore(cls): '''Mark a model to ignore for cleanup''' setattr(cls, _get_mangled_ignore(cls), None) return cls cleanup_ignore = ignore ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1618765179.0 django-cleanup-5.2.0/django_cleanup/handlers.py0000644000076500000240000001021700000000000021311 0ustar00MarioRosastaff''' Signal handlers to manage FileField files. ''' import logging from django.db.models.signals import post_delete, post_init, post_save, pre_save from django.db.transaction import on_commit from . import cache from .signals import cleanup_post_delete, cleanup_pre_delete logger = logging.getLogger(__name__) class FakeInstance: '''A Fake model instance to ensure an instance is not modified''' def cache_original_post_init(sender, instance, **kwargs): '''Post_init on all models with file fields, saves original values''' cache.make_cleanup_cache(instance) def fallback_pre_save(sender, instance, raw, update_fields, using, **kwargs): '''Fallback to the database to remake the cleanup cache if there is none''' if raw: # pragma: no cover return if instance.pk and not cache.has_cache(instance): try: db_instance = sender.objects.get(pk=instance.pk) except sender.DoesNotExist: # pragma: no cover return cache.make_cleanup_cache(instance, source=db_instance) def delete_old_post_save(sender, instance, raw, created, update_fields, using, **kwargs): '''Post_save on all models with file fields, deletes old files''' if raw: return if not created: for field_name, new_file in cache.fields_for_model_instance(instance): if update_fields is None or field_name in update_fields: old_file = cache.get_field_attr(instance, field_name) if old_file != new_file: delete_file(instance, field_name, old_file, using) # reset cache cache.make_cleanup_cache(instance) def delete_all_post_delete(sender, instance, using, **kwargs): '''Post_delete on all models with file fields, deletes all files''' for field_name, file_ in cache.fields_for_model_instance(instance): delete_file(instance, field_name, file_, using) def delete_file(instance, field_name, file_, using): '''Deletes a file''' if not file_.name: return # add a fake instance to the file being deleted to avoid # any changes to the real instance. file_.instance = FakeInstance() # pickled filefields lose lots of data, and contrary to how it is # documented, the file descriptor does not recover them model_name = cache.get_model_name(instance) # recover the 'field' if necessary if not hasattr(file_, 'field'): file_.field = cache.get_field(model_name, field_name)() file_.field.name = field_name # if our file name is default don't delete default = file_.field.default if not callable(file_.field.default) else file_.field.default() if file_.name == default: return # recover the 'storage' if necessary if not hasattr(file_, 'storage'): file_.storage = cache.get_field_storage(model_name, field_name)() # this will run after a successful commit # assuming you are in a transaction and on a database that supports # transactions, otherwise it will run immediately def run_on_commit(): cleanup_pre_delete.send(sender=None, file=file_) try: file_.delete(save=False) except Exception: opts = instance._meta logger.exception( 'There was an exception deleting the file `%s` on field `%s.%s.%s`', file_, opts.app_label, opts.model_name, field_name) cleanup_post_delete.send(sender=None, file=file_) on_commit(run_on_commit, using) def connect(): '''Connect signals to the cleanup models''' for model in cache.cleanup_models(): key = '{{}}_django_cleanup_{}'.format(cache.get_model_name(model)) post_init.connect(cache_original_post_init, sender=model, dispatch_uid=key.format('post_init')) pre_save.connect(fallback_pre_save, sender=model, dispatch_uid=key.format('pre_save')) post_save.connect(delete_old_post_save, sender=model, dispatch_uid=key.format('post_save')) post_delete.connect(delete_all_post_delete, sender=model, dispatch_uid=key.format('post_delete')) ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1600202711.0 django-cleanup-5.2.0/django_cleanup/signals.py0000644000076500000240000000056000000000000021151 0ustar00MarioRosastaff''' django-cleanup sends the following signals ''' from django.dispatch import Signal __all__ = ['cleanup_pre_delete', 'cleanup_post_delete'] cleanup_pre_delete = Signal() '''Called just before a file is deleted. Passes a `file` keyword argument.''' cleanup_post_delete = Signal() '''Called just after a file is deleted. Passes a `file` keyword argument.''' ././@PaxHeader0000000000000000000000000000003400000000000010212 xustar0028 mtime=1618765485.1998398 django-cleanup-5.2.0/django_cleanup.egg-info/0000755000076500000240000000000000000000000020630 5ustar00MarioRosastaff././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1618765485.0 django-cleanup-5.2.0/django_cleanup.egg-info/PKG-INFO0000644000076500000240000002447200000000000021736 0ustar00MarioRosastaffMetadata-Version: 2.1 Name: django-cleanup Version: 5.2.0 Summary: Deletes old files. Home-page: https://github.com/un1t/django-cleanup Author: Ilya Shalyapin Author-email: ishalyapin@gmail.com License: MIT License Download-URL: https://github.com/un1t/django-cleanup/tarball/master Description: Django Cleanup ************** |Version| |Status| |License| Features ======== The django-cleanup app automatically deletes files for :code:`FileField`, :code:`ImageField` and subclasses. When a :code:`FileField`'s value is changed and the model is saved, the old file is deleted. When a model that has a :code:`FileField` is deleted, the file is also deleted. A file that is set as the :code:`FileField`'s default value will not be deleted. Compatibility ------------- - Django 2.2, 3.0, 3.1, 3.2 (`See Django Supported Versions `_) - Python 3.5+ - Compatible with `sorl-thumbnail `_ - Compatible with `easy-thumbnail `_ How does it work? ================= In order to track changes of a :code:`FileField` and facilitate file deletions, django-cleanup connects :code:`post_init`, :code:`pre_save`, :code:`post_save` and :code:`post_delete` signals to signal handlers for each :code:`INSTALLED_APPS` model that has a :code:`FileField`. In order to tell whether or not a :code:`FileField`'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! If 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 below. 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.** Installation ============ :: pip install django-cleanup Configuration ============= Add ``django_cleanup`` to the bottom of ``INSTALLED_APPS`` in ``settings.py`` .. code-block:: py INSTALLED_APPS = ( ..., 'django_cleanup.apps.CleanupConfig', ) That is all, no other configuration is necessary. Note: Order of ``INSTALLED_APPS`` is important. To ensure that exceptions inside other apps' signal handlers do not affect the integrity of file deletions within transactions, ``django_cleanup`` should be placed last in ``INSTALLED_APPS``. Troubleshooting =============== If you notice that ``django-cleanup`` is not removing files when expected, check that your models are being properly `loaded `_: 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-cleanup`` will not be able to discover their ``FileField``'s. You can check if your ``Model`` is loaded by using .. code-block:: py from django.apps import apps apps.get_models() Advanced ======== This section contains additional functionality that can be used to interact with django-cleanup for special cases. Signals ------- To facilitate interactions with other django apps django-cleanup sends the following signals which can be imported from :code:`django_cleanup.signals`: - :code:`cleanup_pre_delete`: just before a file is deleted. Passes a :code:`file` keyword argument. - :code:`cleanup_post_delete`: just after a file is deleted. Passes a :code:`file` keyword argument. Signals example for sorl.thumbnail: .. code-block:: py from django_cleanup.signals import cleanup_pre_delete from sorl.thumbnail import delete def sorl_delete(**kwargs): delete(kwargs['file']) cleanup_pre_delete.connect(sorl_delete) Refresh the cache ----------------- There have been rare cases where the cache would need to be refreshed. To do so the :code:`django_cleanup.cleanup.refresh` method can be used: .. code-block:: py from django_cleanup import cleanup cleanup.refresh(model_instance) Ignore cleanup for a specific model ----------------------------------- Ignore a model and do not perform cleanup when the model is deleted or its files change. .. code-block:: py from django_cleanup import cleanup @cleanup.ignore class MyModel(models.Model): image = models.FileField() How to run tests ================ Install, setup and use pyenv_ to install all the required versions of cPython (see the `tox.ini `_). Setup pyenv_ to have all versions of python activated within your local django-cleanup repository. Ensuring that the python 3.8 that was installed is first priority. Install tox_ on python 3.8 and run the :code:`tox` command from your local django-cleanup repository. How to write tests ================== This app requires the use of django.test.TransactionTestCase_ when writing tests. For details on why this is required see `here `_: Django's :code:`TestCase` class 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 your :code:`on_commit()` callbacks will never be run. If you need to test the results of an :code:`on_commit()` callback, use a :code:`TransactionTestCase` instead. License ======= django-cleanup is free software under terms of the: MIT License Copyright (C) 2012 by Ilya Shalyapin, ishalyapin@gmail.com Permission 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. .. _django.test.TransactionTestCase: https://docs.djangoproject.com/en/stable/topics/testing/tools/#django.test.TransactionTestCase .. _pyenv: https://github.com/pyenv/pyenv .. _tox: https://tox.readthedocs.io/en/latest/ .. |Version| image:: https://img.shields.io/pypi/v/django-cleanup.svg :target: https://pypi.python.org/pypi/django-cleanup/ :alt: PyPI Package .. |Status| image:: https://travis-ci.org/un1t/django-cleanup.svg?branch=master :target: https://travis-ci.org/un1t/django-cleanup :alt: Build Status .. |License| image:: https://img.shields.io/badge/license-MIT-maroon :target: https://github.com/un1t/django-cleanup/blob/master/LICENSE :alt: MIT License Keywords: django Platform: UNKNOWN Classifier: Development Status :: 5 - Production/Stable Classifier: Environment :: Web Environment Classifier: Framework :: Django Classifier: Framework :: Django :: 2.2 Classifier: Framework :: Django :: 3.0 Classifier: Framework :: Django :: 3.1 Classifier: Framework :: Django :: 3.2 Classifier: Intended Audience :: Developers Classifier: License :: OSI Approved :: MIT License Classifier: Operating System :: OS Independent Classifier: Programming Language :: Python Classifier: Programming Language :: Python :: 3 Classifier: Programming Language :: Python :: 3.5 Classifier: Programming Language :: Python :: 3.6 Classifier: Programming Language :: Python :: 3.7 Classifier: Programming Language :: Python :: 3.8 Classifier: Programming Language :: Python :: 3.9 Classifier: Programming Language :: Python :: Implementation :: CPython Classifier: Programming Language :: Python :: Implementation :: PyPy Classifier: Topic :: Utilities Requires: python (>=3.5) Requires: django (>=2.2) Description-Content-Type: text/x-rst ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1618765485.0 django-cleanup-5.2.0/django_cleanup.egg-info/SOURCES.txt0000644000076500000240000000055700000000000022523 0ustar00MarioRosastaffCHANGELOG.md LICENSE MANIFEST.in README.rst setup.cfg setup.py django_cleanup/__init__.py django_cleanup/apps.py django_cleanup/cache.py django_cleanup/cleanup.py django_cleanup/handlers.py django_cleanup/signals.py django_cleanup.egg-info/PKG-INFO django_cleanup.egg-info/SOURCES.txt django_cleanup.egg-info/dependency_links.txt django_cleanup.egg-info/top_level.txt././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1618765485.0 django-cleanup-5.2.0/django_cleanup.egg-info/dependency_links.txt0000644000076500000240000000000100000000000024676 0ustar00MarioRosastaff ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1618765485.0 django-cleanup-5.2.0/django_cleanup.egg-info/top_level.txt0000644000076500000240000000001700000000000023360 0ustar00MarioRosastaffdjango_cleanup ././@PaxHeader0000000000000000000000000000003400000000000010212 xustar0028 mtime=1618765485.2011058 django-cleanup-5.2.0/setup.cfg0000644000076500000240000000010300000000000016000 0ustar00MarioRosastaff[bdist_wheel] universal = 1 [egg_info] tag_build = tag_date = 0 ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1618765179.0 django-cleanup-5.2.0/setup.py0000644000076500000240000000424700000000000015706 0ustar00MarioRosastaff#!/usr/bin/env python # -*- coding: utf-8 -*- # # Copyright (c) 2012 Ilya Shalyapin # # django-cleanup is free software under terms of the MIT License. # import os import re from codecs import open as codecs_open from setuptools import find_packages, setup def read(*parts): file_path = os.path.join(os.path.dirname(__file__), *parts) return codecs_open(file_path, encoding='utf-8').read() def find_version(*parts): version_file = read(*parts) version_match = re.search( r'''^__version__ = ['"]([^'"]*)['"]''', version_file, re.M) if version_match: return str(version_match.group(1)) raise RuntimeError('Unable to find version string.') setup( name='django-cleanup', version=find_version('django_cleanup', '__init__.py'), packages=['django_cleanup'], include_package_data=True, requires=['python (>=3.5)', 'django (>=2.2)'], description='Deletes old files.', long_description=read('README.rst'), long_description_content_type='text/x-rst', author='Ilya Shalyapin', author_email='ishalyapin@gmail.com', url='https://github.com/un1t/django-cleanup', download_url='https://github.com/un1t/django-cleanup/tarball/master', license='MIT License', keywords='django', classifiers=[ 'Development Status :: 5 - Production/Stable', 'Environment :: Web Environment', 'Framework :: Django', 'Framework :: Django :: 2.2', 'Framework :: Django :: 3.0', 'Framework :: Django :: 3.1', 'Framework :: Django :: 3.2', 'Intended Audience :: Developers', 'License :: OSI Approved :: MIT License', 'Operating System :: OS Independent', 'Programming Language :: Python', 'Programming Language :: Python :: 3', 'Programming Language :: Python :: 3.5', 'Programming Language :: Python :: 3.6', 'Programming Language :: Python :: 3.7', 'Programming Language :: Python :: 3.8', 'Programming Language :: Python :: 3.9', 'Programming Language :: Python :: Implementation :: CPython', 'Programming Language :: Python :: Implementation :: PyPy', 'Topic :: Utilities', ], )