管理文件

这个文档描述 Django 文件访问用于文件的 API，例如用户上传的文件。较底层的API足够通用，你可以为其他目的来使用它们。如果你想处理 “static files” (JS, CSS, etc.)，可以查看 How to manage static files (e.g. images, JavaScript, CSS) 。

默认情况下，Django 使用 MEDIA_ROOT 和 MEDIA_URL 设置本地存储。下面的例子假设你在使用这些默认设置。

不过，Django 提供编写自定义 file storage systems 的方法，允许你完全自定义 Django 存储文件的位置和方式。这篇文档的后半部分描述了存储系统的工作方式。

在模型中使用文件

当你使用 FileField 或 ImageField 时，Django 提供了一组处理文件的API。

考虑下面的模型，使用 ImageField 来存储照片：

  1. from django.db import models
  3. class Car(models.Model):
  4.     name = models.CharField(max_length=255)
  5.     price = models.DecimalField(max_digits=5, decimal_places=2)
  6.     photo = models.ImageField(upload_to='cars')
  7.     specs = models.FileField(upload_to='specs')

任何 Car 实例将拥有一个 photo 属性，你可以使用它来获取附加照片的详情：

  1. >>> car = Car.objects.get(name="57 Chevy")
  2. >>> car.photo
  3. <ImageFieldFile: cars/chevy.jpg>
  4. >>> car.photo.name
  5. 'cars/chevy.jpg'
  6. >>> car.photo.path
  7. '/media/cars/chevy.jpg'
  8. >>> car.photo.url
  9. 'http://media.example.com/cars/chevy.jpg'

car.photo 是一个 File 对象，这意味着它拥有下面所描述的所有方法和属性。

备注

文件在数据库中作为保存模型的一部分，因此在模型被保存之前，不能依赖磁盘上使用的实际文件名。

例如，您可以通过将文件名设置为相对于文件存储位置的路径来更改文件名（如果你正在使用默认的 FileSystemStorage ，则为 MEDIA_ROOT ）。

  1. >>> import os
  2. >>> from django.conf import settings
  3. >>> initial_path = car.photo.path
  4. >>> car.photo.name = 'cars/chevy_ii.jpg'
  5. >>> new_path = settings.MEDIA_ROOT + car.photo.name
  6. >>> # Move the file on the filesystem
  7. >>> os.rename(initial_path, new_path)
  8. >>> car.save()
  9. >>> car.photo.path
  10. '/media/cars/chevy_ii.jpg'
  11. >>> car.photo.path == new_path
  12. True

To save an existing file on disk to a FileField:

  1. >>> from pathlib import Path
  2. >>> from django.core.files import File
  3. >>> path = Path('/some/external/specs.pdf')
  4. >>> car = Car.objects.get(name='57 Chevy')
  5. >>> with path.open(mode='rb') as f:
  6. ...     car.specs = File(f, name=path.name)
  7. ...     car.save()

备注

While ImageField non-image data attributes, such as height, width, and size are available on the instance, the underlying image data cannot be used without reopening the image. For example:

  1. >>> from PIL import Image
  2. >>> car = Car.objects.get(name='57 Chevy')
  3. >>> car.photo.width
  4. 191
  5. >>> car.photo.height
  6. 287
  7. >>> image = Image.open(car.photo)
  8. # Raises ValueError: seek of closed file.
  9. >>> car.photo.open()
  10. <ImageFieldFile: cars/chevy.jpg>
  11. >>> image = Image.open(car.photo)
  12. >>> image
  13. <PIL.JpegImagePlugin.JpegImageFile image mode=RGB size=191x287 at 0x7F99A94E9048>

File 对象

在内部，Django 在任何需要表示文件的时候使用 django.core.files.File 。

大部分情况下你只需要使用 Django 提供的 File （即附加到上述模型的文件或已经上传的文件）。

如果你需要自己构建 File ，最简单的方法是使用 Python 内置的 file 对象创建一个：

  1. >>> from django.core.files import File
  3. # Create a Python file object using open()
  4. >>> f = open('/path/to/hello.world', 'w')
  5. >>> myfile = File(f)

现在你可以使用 File 类的任何属性和方法。

注意在这里创建的文件不会自动关闭。下面的方式可以用来自动关闭文件：

  1. >>> from django.core.files import File
  3. # Create a Python file object using open() and the with statement
  4. >>> with open('/path/to/hello.world', 'w') as f:
  5. ...     myfile = File(f)
  6. ...     myfile.write('Hello World')
  7. ...
  8. >>> myfile.closed
  9. True
  10. >>> f.closed
  11. True

在对大量对象进行循环访问文件字段时，关闭文件尤为重要。如果文件在访问后不能手动关闭，可能会出现文件描述符溢出的风险。

  1. OSError: [Errno 24] Too many open files

文件存储

在后台，Django将如何以及在哪里存储文件的决策委托给文件存储系统。这个对象实际上理解文件系统、打开和读取文件等。

Django 的默认文件存储通过 DEFAULT_FILE_STORAGE 配置；如果你不显式地提供存储系统，这里会使用默认配置。

参阅下面内置默认文件存储系统的细节，也可以查看 如何编写一个自定义的文件存储类 来了解编写自己的文件存储系统的信息。

存储对象

虽然大部分时间你可以使用 File 对象（将该文件委托给合适的存储），但你可以直接使用文件存储系统。你可以创建一些自定义文件存储类的示例，或使用通常更有用的全局默认存储系统：

  1. >>> from django.core.files.base import ContentFile
  2. >>> from django.core.files.storage import default_storage
  4. >>> path = default_storage.save('path/to/file', ContentFile(b'new content'))
  5. >>> path
  6. 'path/to/file'
  8. >>> default_storage.size(path)
  9. 11
  10. >>> default_storage.open(path).read()
  11. b'new content'
  13. >>> default_storage.delete(path)
  14. >>> default_storage.exists(path)
  15. False

查看 文件存储 API 来了解文件存储API。

内置文件存储类

Django 附带一个 django.core.files.storage.FileSystemStorage 类，这个类实现基础的本地文件系统文件存储。

例如，下面的代码将存储上传文件到 /media/photos 而会忽略你在 MEDIA_ROOT 的设置：

  1. from django.core.files.storage import FileSystemStorage
  2. from django.db import models
  4. fs = FileSystemStorage(location='/media/photos')
  6. class Car(models.Model):
  7.     ...
  8.     photo = models.ImageField(storage=fs)

自定义存储系统（ Custom storage systems ）的工作方式也一样：将它们作为 storage 参数传递给 FileField 。

使用callable

你可以使用callable作为 FileField 或 ImageField 的 storage 参数。它允许你在运行时修改存储参数，不同环境选择不同存储，例如。

当模型类被加载时，callable将进行判断，并返回 Storage 实例。

例如：

  1. from django.conf import settings
  2. from django.db import models
  3. from .storages import MyLocalStorage, MyRemoteStorage
  6. def select_storage():
  7.     return MyLocalStorage() if settings.DEBUG else MyRemoteStorage()
  10. class MyModel(models.Model):
  11.     my_file = models.FileField(storage=select_storage)