#!/usr/bin/env python
# cardinal_pythonlib/django/files.py
"""
===============================================================================
Original code copyright (C) 2009-2022 Rudolf Cardinal (rudolf@pobox.com).
This file is part of cardinal_pythonlib.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
https://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
===============================================================================
**Helper functions for managing disk files via Django.**
"""
import os
from typing import Any, Iterable
# =============================================================================
# Making FileFields own their files (i.e. delete them afterwards)
# =============================================================================
# https://stackoverflow.com/questions/16041232/django-delete-filefield
# These two auto-delete files from filesystem when they are unneeded:
# ... with a bit of modification to make them generic (RNC)
# Attach them with signals; see e.g. Study model.
[docs]def auto_delete_files_on_instance_delete(
instance: Any, fieldnames: Iterable[str]
) -> None:
"""
Deletes files from filesystem when object is deleted.
"""
for fieldname in fieldnames:
filefield = getattr(instance, fieldname, None)
if filefield:
if os.path.isfile(filefield.path):
os.remove(filefield.path)
# BugfixCT = TypeVar('BugfixCT', covariant=True, bound=type)
# # ... as per typing.CT (Python 3.5) or typing.CT_co (Python 3.6)
#
#
# class BugfixType(Generic[BugfixCT], extra=type):
# """
# Type checker note: using Type[Model] results in the error:
# TypeError: descriptor '__subclasses__' of 'type' object needs an argument
# ... which is the bug https://github.com/python/typing/issues/266
#
# Using this fixes it.
# The difference is that BugfixType doesn't inherit from type.
#
# EXCEPT that the calling type checker from PyCharm doesn't know that it
# can map Type[X] to BugfixType[X], so this is entirely unhelpful.
# """
[docs]def auto_delete_files_on_instance_change(
instance: Any, fieldnames: Iterable[str], model_class
) -> None:
"""
Deletes files from filesystem when object is changed.
model_class: ``Type[Model]``
... only the type checker in Py3.5 is broken; v.s.
"""
if not instance.pk:
return # instance not yet saved in database
# noinspection PyUnresolvedReferences
try:
# noinspection PyUnresolvedReferences
old_instance = model_class.objects.get(pk=instance.pk)
except model_class.DoesNotExist:
return # old version gone from database entirely
for fieldname in fieldnames:
old_filefield = getattr(old_instance, fieldname, None)
if not old_filefield:
continue
new_filefield = getattr(instance, fieldname, None)
if old_filefield != new_filefield:
if os.path.isfile(old_filefield.path):
os.remove(old_filefield.path)