Объект File

Модуль django.core.files и его подмодули содержат встроенные классы для базовой работы с файлами в Django.

Класс File

class File(file_object, name=None) [source]

Класс File представляет собой тонкий обертка вокруг объекта файла Python объекта файла с некоторыми дополнениями, специфичными для Django. Внутренне Django использует этот класс при необходимости представления файла.

Объекты File имеют следующие атрибуты и методы:

name

Имя файла, включающее относительный путь от MEDIA_ROOT.

size

Размер файла в байтах.

file

Основной объект файла Python объект файла, который оборачивает этот класс.

Обращайте внимание на этот атрибут в подклассах.

Некоторые подклассы File, включая ContentFile и FieldFile, могут заменить этот атрибут на объект, отличный от объекта файла Python объекта файла. В этих случаях этот атрибут может сам быть подклассом File (и не обязательно того же подкласса). Всякий раз, когда это возможно, используйте атрибуты и методы самого подкласса, а не атрибут подкласса file.

mode

Режим чтения/записи файла.

open(mode=None, *args, **kwargs) [source]

Открывает или повторно открывает файл (что также выполняет File.seek(0)). Аргумент mode позволяет использовать те же значения, что и встроенная функция Python open(). *args и **kwargs передаются после mode во встроенную функцию Python open().

При повторном открытии файла mode переопределит любой режим, с которым файл был первоначально открыт; None означает повторное открытие в исходном режиме.

Он может быть использован как менеджер контекста, например with file.open() as f:.

Изменено в Django 5.0:

Добавлена поддержка передачи *args и **kwargs.

__iter__() [source]

Итерируется по файлу, возвращая по одной строке за раз.

chunks(chunk_size=None) [source]

Итерируется по файлу, возвращая «куски» заданного размера. chunk_size по умолчанию равен 64 КБ.

Это особенно полезно для очень больших файлов, так как это позволяет передавать их с диска, а не загружать весь файл в память.

multiple_chunks(chunk_size=None) [source]

Возвращает True если файл достаточно большой, чтобы потребовалось несколько кусков для доступа ко всему его содержимому с учётом chunk_size.

close() [source]

Закрывает файл.

В дополнение к перечисленным методам, File предоставляет следующие атрибуты и методы своего объекта file: encoding, fileno, flush, isatty, newlines, read, readinto, readline, readlines, seek, tell, truncate, write, writelines, readable(), writable(), и seekable().

Класс ContentFile

class ContentFile(content, name=None) [source]

Класс ContentFile наследуется от File, но в отличие от File, он работает со строковым содержимым (также поддерживаются байты), а не с фактическим файлом. Например:

from django.core.files.base import ContentFile

f1 = ContentFile("esta frase está en español")
f2 = ContentFile(b"these are bytes")

Класс ImageFile

class ImageFile(file_object, name=None) [source]

Django предоставляет встроенный класс специально для изображений. django.core.files.images.ImageFile наследует все атрибуты и методы File и дополнительно предоставляет следующие:

width

Ширина изображения в пикселях.

height

Высота изображения в пикселях.

Дополнительные методы для файлов, прикрепленных к объектам

Любой File, связанный с объектом (как в Car.photo, ниже), также будет иметь несколько дополнительных методов:

File.save(name, content, save=True)

Сохраняет новый файл с заданным именем файла и содержимым. Это не заменит существующий файл, а создаст новый файл и обновит объект, чтобы он указывал на него. Если save равно True, метод save() модели будет вызван после сохранения файла. То есть эти две строки:

>>> car.photo.save("myphoto.jpg", content, save=False)
>>> car.save()

эквивалентны:

>>> car.photo.save("myphoto.jpg", content, save=True)

Обратите внимание, что аргумент content должен быть экземпляром File или подкласса File, например ContentFile.

File.delete(save=True)

Удаляет файл из экземпляра модели и удаляет исходный файл. Если save равно True, метод save() модели будет вызван после удаления файла.