Django删除FileField

时间:2013-04-16 15:37:26

标签: django django-models

我正在Django中构建一个Web应用程序。我有一个上传文件的模型,但我无法删除它。这是我的代码:

class Song(models.Model):
    name = models.CharField(blank=True, max_length=100)
    author = models.ForeignKey(User, to_field='id', related_name="id_user2")
    song = models.FileField(upload_to='/songs/')
    image = models.ImageField(upload_to='/pictures/', blank=True)
    date_upload = models.DateField(auto_now_add=True)

    def delete(self, *args, **kwargs):
        # You have to prepare what you need before delete the model
        storage, path = self.song.storage, self.song.path
        # Delete the model before the file
        super(Song, self).delete(*args, **kwargs)
        # Delete the file after the model
        storage.delete(path)

然后,在“python manage.py shell”中我这样做:

song = Song.objects.get(pk=1)
song.delete()

它从数据库中删除,但不从服务器上的文件中删除。 我还能尝试什么?

谢谢!

9 个答案:

答案 0 :(得分:109)

在Django 1.3之前,当您删除相应的模型实例时,文件会自动从文件系统中删除。您可能正在使用较新的Django版本,因此您必须自己从文件系统中删除该文件。

您可以通过几种方式实现这一目标,其中一种方式是使用pre_deletepost_delete信号。

实施例

我的选择方法目前是post_deletepre_save信号的混合,这使得只要删除相应的模型或更改其文件,就会删除过时的文件。

基于假设的MediaFile模型:

import os
import uuid

from django.db import models
from django.dispatch import receiver
from django.utils.translation import ugettext_lazy as _


class MediaFile(models.Model):
    file = models.FileField(_("file"),
        upload_to=lambda instance, filename: str(uuid.uuid4()))


# These two auto-delete files from filesystem when they are unneeded:

@receiver(models.signals.post_delete, sender=MediaFile)
def auto_delete_file_on_delete(sender, instance, **kwargs):
    """
    Deletes file from filesystem
    when corresponding `MediaFile` object is deleted.
    """
    if instance.file:
        if os.path.isfile(instance.file.path):
            os.remove(instance.file.path)

@receiver(models.signals.pre_save, sender=MediaFile)
def auto_delete_file_on_change(sender, instance, **kwargs):
    """
    Deletes old file from filesystem
    when corresponding `MediaFile` object is updated
    with new file.
    """
    if not instance.pk:
        return False

    try:
        old_file = MediaFile.objects.get(pk=instance.pk).file
    except MediaFile.DoesNotExist:
        return False

    new_file = instance.file
    if not old_file == new_file:
        if os.path.isfile(old_file.path):
            os.remove(old_file.path)
  • 边缘情况:如果您的应用上传新文件并将模型实例指向新文件而未调用save()(例如,通过批量更新QuerySet),则旧文件将继续存在,因为信号不会运行。如果使用传统的文件处理方法,则不会发生这种情况。
  • 我认为我制作的其中一个应用程序已将此代码投入生产,但使用后仍然需要您自担风险。
  • 编码样式:此示例使用file作为字段名称,这不是一个好的样式,因为它与内置的file对象标识符冲突。

另见

    Django 1.11模型字段引用中的
  • FieldFile.delete()(请注意,它描述了FieldFile类,但您直接在字段上调用.delete()FileField实例代理到相应的FieldFile实例,并且您可以像访问字段一样访问其方法。

      

    请注意,删除模型时,不会删除相关文件。如果您需要清理孤立文件,您需要自己处理它(例如,使用可以手动运行或计划通过例如cron定期运行的自定义管理命令)。

  • 为什么Django不会自动删除文件:entry in release notes for Django 1.3

      

    在早期的Django版本中,当删除包含FileField的模型实例时,FileField自行删除了后端存储中的文件。这为几个数据丢失场景打开了大门,包括回滚事务和引用同一文件的不同模型上的字段。在Django 1.3中,当删除模型时,将不会调用FileField的{​​{1}}方法。如果您需要清除孤立文件,您需要自己处理它(例如,使用可以手动运行或计划通过例如cron定期运行的自定义管理命令)。

  • Example of using a pre_delete signal only

答案 1 :(得分:38)

尝试django-cleanup,当您删除模型时,它会自动调用FileField上的delete方法。

pip install django-cleanup

settings.py

INSTALLED_APPS = (
     ...
    'django_cleanup', # should go after your apps
)

答案 2 :(得分:13)

你也可以简单地覆盖模型的删除功能来检查文件是否存在,并在调用超级函数之前将其删除。

import os

class Excel(models.Model):
    upload_file = models.FileField(upload_to='/excels/', blank =True)   
    uploaded_on = models.DateTimeField(editable=False)


    def delete(self,*args,**kwargs):
        if os.path.isfile(self.upload_file.path):
            os.remove(self.upload_file.path)

        super(Excel, self).delete(*args,**kwargs)

答案 3 :(得分:10)

您可以使用Django> = 1.10来调用文件字段的.delete方法,从文件系统中删除文件:

obj = Song.objects.get(pk=1)
obj.song.delete()

答案 4 :(得分:5)

Django 2.x解决方案:

Django 2 中非常容易处理。我已经尝试过使用Django 2和SFTP存储的以下解决方案(但是我认为它可以与任何存储一起使用)

在删除模型实例之前,只需删除FileFields:

class Song(models.Model):
    name = models.CharField(blank=True, max_length=100)
    author = models.ForeignKey(User, to_field='id', related_name="id_user2")
    song = models.FileField(upload_to='/songs/')
    image = models.ImageField(upload_to='/pictures/', blank=True)
    date_upload = models.DateField(auto_now_add=True)

    def delete(self, using=None, keep_parents=False):
        self.song.storage.delete(self.song.name)
        self.image.storage.delete(self.song.name)
        super().delete()

这对我来说很容易。 如果要在删除之前检查文件是否存在,可以使用storage.exists。例如self.song.storage.exists(self.song.name)将返回表示歌曲是否存在的boolean

编辑(另外):

@HeyMan所述,此解决方案调用Song.objects.all().delete()不会删除文件!发生这种情况是因为Song.objects.all().delete()正在运行Default Manager的删除查询。因此,如果您希望能够使用objects方法删除模型文件,则必须编写并使用Custom Manager(仅用于覆盖其删除查询):

class CustomManager(models.Manager):
    def delete(self):
        for obj in self.get_queryset():
            obj.delete()

并且要为模型分配CustomManager,必须在模型内部初始化objects

class Song(models.Model):
    name = models.CharField(blank=True, max_length=100)
    author = models.ForeignKey(User, to_field='id', related_name="id_user2")
    song = models.FileField(upload_to='/songs/')
    image = models.ImageField(upload_to='/pictures/', blank=True)
    date_upload = models.DateField(auto_now_add=True)

    objects = CustomManager() # just add this line of code inside of your model

    def delete(self, using=None, keep_parents=False):
        self.song.storage.delete(self.song.name)
        self.image.storage.delete(self.song.name)
        super().delete()

现在,您可以在任何.delete()子查询的末尾使用objects。我写了最简单的CustomManager,但可以通过返回有关已删除对象或所需内容的信息来做得更好。

答案 5 :(得分:3)

@Anton Strogonoff

当文件发生变化时,我在代码中遗漏了一些东西,如果你创建一个新文件会产生错误,因为新文件没有找到路径。我修改了函数代码并添加了一个try / except语句,效果很好。

@receiver(models.signals.pre_save, sender=MediaFile)
def auto_delete_file_on_change(sender, instance, **kwargs):
    """Deletes file from filesystem
    when corresponding `MediaFile` object is changed.
    """
    if not instance.pk:
        return False

    try:
        old_file = MediaFile.objects.get(pk=instance.pk).file
    except MediaFile.DoesNotExist:
        return False

    new_file = instance.file
    if not old_file == new_file:
        try:
            if os.path.isfile(old_file.path):
                os.remove(old_file.path)
        except Exception:
            return False

答案 6 :(得分:3)

这是一个应用程序,只要删除模型或上传新文件,它就会删除旧文件:django-smartfields

from django.db import models
from smartfields import fields

class Song(models.Model):
    song = fields.FileField(upload_to='/songs/')
    image = fields.ImageField(upload_to='/pictures/', blank=True)

答案 7 :(得分:1)

对于那些在较新版本的 Django(目前为 3.1)中寻找答案的人。

我发现了这个 website 并且它对我有用,没有任何改变,只需将它添加到您的 models.py 中:

from django.db.models.signals import post_delete
from django.dispatch import receiver
from django.db import models
 
""" Only delete the file if no other instances of that model are using it"""    
def delete_file_if_unused(model,instance,field,instance_file_field):
    dynamic_field = {}
    dynamic_field[field.name] = instance_file_field.name
    other_refs_exist = model.objects.filter(**dynamic_field).exclude(pk=instance.pk).exists()
    if not other_refs_exist:
        instance_file_field.delete(False)
""" Whenever ANY model is deleted, if it has a file field on it, delete the associated file too"""
@receiver(post_delete)
def delete_files_when_row_deleted_from_db(sender, instance, **kwargs):
    for field in sender._meta.concrete_fields:
        if isinstance(field,models.FileField):
            instance_file_field = getattr(instance,field.name)
            delete_file_if_unused(sender,instance,field,instance_file_field)
            
""" Delete the file if something else get uploaded in its place"""
@receiver(pre_save)
def delete_files_when_file_changed(sender,instance, **kwargs):
    # Don't run on initial save
    if not instance.pk:
        return
    for field in sender._meta.concrete_fields:
        if isinstance(field,models.FileField):
            #its got a file field. Let's see if it changed
            try:
                instance_in_db = sender.objects.get(pk=instance.pk)
            except sender.DoesNotExist:
                # We are probably in a transaction and the PK is just temporary
                # Don't worry about deleting attachments if they aren't actually saved yet.
                return
            instance_in_db_file_field = getattr(instance_in_db,field.name)
            instance_file_field = getattr(instance,field.name)
            if instance_in_db_file_field.name != instance_file_field.name:
                delete_file_if_unused(sender,instance,field,instance_in_db_file_field)

答案 8 :(得分:0)

每次上传新图像(徽标字段)时都会运行此代码,如果是,则检查徽标是否已存在,关闭它并将其从磁盘中删除。当然可以在接收器功能中进行相同的过程。希望这会有所帮助。

 #  Returns the file path with a folder named by the company under /media/uploads
    def logo_file_path(instance, filename):
        company_instance = Company.objects.get(pk=instance.pk)
        if company_instance.logo:
            logo = company_instance.logo
            if logo.file:
                if os.path.isfile(logo.path):
                    logo.file.close()
                    os.remove(logo.path)

        return 'uploads/{0}/{1}'.format(instance.name.lower(), filename)


    class Company(models.Model):
        name = models.CharField(_("Company"), null=False, blank=False, unique=True, max_length=100) 
        logo = models.ImageField(upload_to=logo_file_path, default='')