Класс InMemoryUploadedFile

Класс InMemoryUploadedFile используется в Django для представления файлов, загруженных через HTTP-запросы и полностью помещенных в оперативную память сервера. Этот класс наследуется от UploadedFile и реализует интерфейс файлоподобного объекта, позволяя читать, записывать и манипулировать содержимым файла как с обычным файлом в памяти. Основное преимущество такого подхода - высокая скорость доступа к данным, но он подходит только для небольших файлов, размер которых не превышает установленный лимит в настройках FILE_UPLOAD_MAX_MEMORY_SIZE (по умолчанию 2.5 МБ). Если загружаемый файл превышает этот лимит, Django автоматически использует класс TemporaryUploadedFile, сохраняя файл во временное хранилище на диске.

Объекты InMemoryUploadedFile автоматически создаются Django при обработке входящих запросов, содержащих файлы, и доступны через атрибут request.FILES. Каждый загруженный файл представлен как экземпляр этого класса, предоставляющий удобные методы для чтения содержимого, получения информации о файле и его сохранения. Класс также поддерживает все стандартные методы работы с файлами, такие как read, write, seek и tell.

Синтаксис

from django.core.files.uploadedfile import InMemoryUploadedFile

# Обычно объект получается из request.FILES
uploaded_file = request.FILES['field_name']
# uploaded_file является экземпляром InMemoryUploadedFile

Основные атрибуты и методы

Класс InMemoryUploadedFile предоставляет следующие основные атрибуты и методы для работы с загруженным файлом:

name - имя загруженного файла (строка).
size - размер файла в байтах (целое число).
content_type - MIME-тип содержимого файла.
charset - кодировка файла (если указана).
read - чтение содержимого файла.
chunks - итерация по блокам данных файла.
multiple_chunks - проверка, разбит ли файл на чанки.
save - метод для сохранения файла через хранилище.

Пример

Рассмотрим простой пример получения загруженного файла из запроса и вывода его основных свойств:

from django.http import HttpResponse
from django.views.decorators.csrf import csrf_exempt

@csrf_exempt
def upload_view(request):
	if request.method == 'POST' and request.FILES.get('file'):
		uploaded_file = request.FILES['file']
		
		# Вывод информации о файле
		print(f"File name: {uploaded_file.name}")
		print(f"File size: {uploaded_file.size} bytes")
		print(f"Content type: {uploaded_file.content_type}")
		
		# Чтение содержимого
		content = uploaded_file.read()
		print(f"First 50 bytes: {content[:50]}")
		
		return HttpResponse("File uploaded successfully")
	return HttpResponse("No file uploaded")

Результат выполнения кода:

"File name: image.jpg"
"File size: 1024 bytes"
"Content type: image/jpeg"
"First 50 bytes: b'\xff\xd8\xff\xe0\x00\x10JFIF...'"

Пример

Продемонстрируем сохранение загруженного файла в модель Django с использованием поля FileField:

from django.db import models
from django.core.files.storage import default_storage

class Document(models.Model):
	title = models.CharField(max_length=100)
	file = models.FileField(upload_to='documents/')
	uploaded_at = models.DateTimeField(auto_now_add=True)

# В представлении
@csrf_exempt
def upload_document(request):
	if request.method == 'POST' and request.FILES.get('file'):
		uploaded_file = request.FILES['file']
		
		# Сохранение файла через модель
		document = Document.objects.create(
			title=uploaded_file.name,
			file=uploaded_file
		)
		
		# Проверка сохранения
		print(f"Document saved: {document.file.name}")
		print(f"File exists: {default_storage.exists(document.file.name)}")
		
		return HttpResponse("Document saved successfully")

Результат выполнения кода:

"Document saved: documents/image.jpg"
"File exists: True"

Пример

Используем метод chunks для построчного чтения большого текстового файла из памяти:

from django.shortcuts import render

def process_text_file(request):
	if request.method == 'POST' and request.FILES.get('text_file'):
		uploaded_file = request.FILES['text_file']
		
		# Чтение файла по частям
		content = b''
		for chunk in uploaded_file.chunks():
			content += chunk
		
		# Декодирование и разбивка на строки
		lines = content.decode('utf-8').split('\n')
		line_count = len(lines)
		
		print(f"Total lines: {line_count}")
		for i, line in enumerate(lines[:3]):
			print(f"Line {i+1}: {line[:30]}...")
		
		return render(request, 'result.html', {'line_count': line_count})

Результат выполнения кода:

"Total lines: 150"
"Line 1: First line of the document..."
"Line 2: Second line of the document..."
"Line 3: Third line of the document..."

Пример

Создадим собственный экземпляр InMemoryUploadedFile для тестирования функционала загрузки файлов:

from django.core.files.uploadedfile import InMemoryUploadedFile
from io import BytesIO

# Создание тестового файла в памяти
test_content = b'This is a test file content for testing purposes.'
test_file = BytesIO(test_content)

# Создание объекта InMemoryUploadedFile
uploaded_file = InMemoryUploadedFile(
	file=test_file,
	field_name='file_field',
	name='test.txt',
	content_type='text/plain',
	size=len(test_content),
	charset='utf-8'
)

# Проверка созданного объекта
print(f"Name: {uploaded_file.name}")
print(f"Size: {uploaded_file.size}")
print(f"Content type: {uploaded_file.content_type}")
print(f"Content: {uploaded_file.read()}")

Результат выполнения кода:

"Name: test.txt"
"Size: 48"
"Content type: text/plain"
"Content: b'This is a test file content for testing purposes.'"

Особенности работы

При работе с InMemoryUploadedFile важно учитывать следующие моменты:

Файлы хранятся в памяти только до конца обработки запроса. После завершения запроса память освобождается.
Для больших файлов Django автоматически переключается на TemporaryUploadedFile, сохраняя файл на диск.
Метод read читает весь файл в память, поэтому для больших файлов предпочтительнее использовать chunks.
При сохранении через модель с FileField файл автоматически копируется в нужное хранилище.
Класс поддерживает протокол контекстного менеджера, что позволяет использовать конструкцию with.

Смотрите также

класс TemporaryUploadedFile,
который представляет загруженный файл, сохраненный на диске
класс UploadedFile,
базовый класс для всех загруженных файлов
атрибут UploadedFile.name,
который содержит имя загруженного файла
атрибут UploadedFile.content_type,
который содержит MIME-тип загруженного файла