Объект файла

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

Класс File

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

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

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

name

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

size [source]

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

file

Базовый объект файла, который обертывается этим классом.

Будьте внимательны с этим атрибутом в подклассах.

Некоторые подклассы 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 [source]

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

height [source]

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

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

Любой 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() модели будет вызван после удаления файла.