API хранилища файлов

Получение текущего класса хранилища

Django предоставляет два удобных способа доступа к текущему классу хранилища:

class DefaultStorage [source]

DefaultStorage обеспечивает ленивый доступ к текущей системе хранения по умолчанию, как определено в DEFAULT_FILE_STORAGE. DefaultStorage использует get_storage_class() внутри.

get_storage_class(import_path=None) [source]

Возвращает класс или модуль, реализующий API хранилища.

При вызове без параметра import_path get_storage_class вернёт текущую систему хранения по умолчанию, как определено в DEFAULT_FILE_STORAGE. Если параметр import_path указан, get_storage_class попытается импортировать класс или модуль из заданного пути и вернёт его, если это удастся. В противном случае будет возбуждено исключение.

Класс FileSystemStorage

class FileSystemStorage(location=None, base_url=None, file_permissions_mode=None, directory_permissions_mode=None) [source]

Класс FileSystemStorage реализует базовые функции хранения файлов на локальной файловой системе. Он наследуется от Storage и предоставляет реализации всех публичных методов.

location

Абсолютный путь к каталогу, в котором будут храниться файлы. По умолчанию соответствует значению вашего параметра MEDIA_ROOT.

base_url

URL, обслуживающий файлы, хранящиеся в этом каталоге. По умолчанию соответствует значению вашего параметра MEDIA_URL.

file_permissions_mode

Права доступа к файлам в файловой системе, которые будут установлены при сохранении файла. По умолчанию соответствует значению параметра FILE_UPLOAD_PERMISSIONS.

directory_permissions_mode

Права доступа к каталогам в файловой системе, которые будут установлены при сохранении каталога. По умолчанию соответствует значению параметра FILE_UPLOAD_DIRECTORY_PERMISSIONS.

Примечание

Метод FileSystemStorage.delete() не будет генерировать исключение, если заданный файл не существует.

get_created_time(name) [source]

Возвращает datetime времени изменения метаданных файла, т.е. os.path.getctime(). На некоторых системах (например, Unix) это время последнего изменения метаданных, а на других (например, Windows) — время создания файла.

Класс Storage

class Storage [source]

Класс Storage предоставляет стандартизированный API для хранения файлов, вместе с набором стандартных поведений, которые все остальные системы хранения могут унаследовать или переопределить по мере необходимости.

Примечание

Когда методы возвращают объекты datetime без учета часового пояса, используемый эффективный часовой пояс будет текущим значением os.environ['TZ']; обратите внимание, что это обычно устанавливается из TIME_ZONE Django.

delete(name) [source]

Удаляет файл, на который ссылается name. Если удаление не поддерживается целевой системой хранения, будет поднято исключение NotImplementedError

exists(name) [source]

Возвращает True если файл с указанным именем уже существует в системе хранения, или False если имя доступно для нового файла.

get_accessed_time(name) [source]

Возвращает datetime последнего времени доступа к файлу. Для систем хранения, которые не могут вернуть время последнего доступа, будет поднято исключение NotImplementedError.

Если USE_TZ равно True, возвращает объект datetime с учетом часового пояса, в противном случае возвращает объект datetime без учета часового пояса в локальном часовом поясе.

get_available_name(name, max_length=None) [source]

Возвращает имя файла, основанное на параметре name, которое свободно и доступно для записи нового содержимого в целевой системе хранения.

Длина имени файла не будет превышать max_length, если указано. Если уникальное свободное имя файла не может быть найдено, будет поднято исключение SuspiciousFileOperation.

Если файл с name уже существует, к имени файла перед расширением добавляется символ подчеркивания и случайная 7-символьная буквенно-цифровая строка.

get_created_time(name) [source]

Возвращает datetime времени создания файла. Для систем хранения, которые не могут вернуть время создания, будет поднято исключение NotImplementedError.

Если USE_TZ равно True, возвращает объект datetime с учетом часового пояса, в противном случае возвращает объект datetime без учета часового пояса в локальном часовом поясе.

get_modified_time(name) [source]

Возвращает datetime последнего времени изменения файла. Для систем хранения, которые не могут вернуть время последнего изменения, будет поднято исключение NotImplementedError.

Если USE_TZ равно True, возвращает объект datetime с учетом часового пояса, в противном случае возвращает объект datetime без учета часового пояса в локальном часовом поясе.

get_valid_name(name) [source]

Возвращает имя файла, основанное на параметре name, подходящее для использования в целевой системе хранения.

generate_filename(filename) [source]

Проверяет filename, вызывая get_valid_name(), и возвращает имя файла, которое будет передано методу save().

Аргумент filename может включать путь, возвращаемый FileField.upload_to. В этом случае путь не будет передан в get_valid_name(), но будет добавлен обратно к результативному имени.

В стандартной реализации используются операции из модуля os.path. Переопределите этот метод, если это не подходит для вашего хранения.

listdir(path) [source]

Перечисляет содержимое указанного пути, возвращая кортеж из двух списков: первый — каталоги, второй — файлы. Для систем хранения, которые не могут предоставить такой список, будет поднято исключение NotImplementedError.

open(name, mode='rb') [source]

Открывает файл, указанный name. Обратите внимание, что хотя возвращаемый файл гарантированно является объектом File, он может фактически быть каким-либо подклассом. В случае удаленного хранения файлов это означает, что чтение/запись может быть довольно медленным, поэтому будьте предупреждены.

path(name) [source]

Локальный путь к файлу, где его можно открыть с помощью стандартной функции Python open(). Для систем хранения, недоступных из локальной файловой системы, будет поднято исключение NotImplementedError.

save(name, content, max_length=None) [source]

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

Аргумент max_length передаётся в get_available_name().

Аргумент content должен быть экземпляром django.core.files.File или объектом, похожим на файл, который можно обернуть в File.

size(name) [source]

Возвращает общий размер файла, в байтах, на который ссылается name. Для систем хранения, которые не могут вернуть размер файла, будет поднято исключение NotImplementedError.

url(name) [source]

Возвращает URL, по которому можно получить доступ к содержимому файла, на который ссылается name. Для систем хранения, которые не поддерживают доступ по URL, будет поднято исключение NotImplementedError.