Generating file to download with Django

PythonDjango

Python Problem Overview


Is it possible to make a zip archive and offer it to download, but still not save a file to the hard drive?

Python Solutions


Solution 1 - Python

To trigger a download you need to set Content-Disposition header:

from django.http import HttpResponse
from wsgiref.util import FileWrapper

# generate the file
response = HttpResponse(FileWrapper(myfile.getvalue()), content_type='application/zip')
response['Content-Disposition'] = 'attachment; filename=myfile.zip'
return response

If you don't want the file on disk you need to use StringIO

import cStringIO as StringIO

myfile = StringIO.StringIO()
while not_finished:
    # generate chunk
    myfile.write(chunk)

Optionally you can set Content-Length header as well:

response['Content-Length'] = myfile.tell()

Solution 2 - Python

You'll be happier creating a temporary file. This saves a lot of memory. When you have more than one or two users concurrently, you'll find the memory saving is very, very important.

You can, however, write to a StringIO object.

>>> import zipfile
>>> import StringIO
>>> buffer= StringIO.StringIO()
>>> z= zipfile.ZipFile( buffer, "w" )
>>> z.write( "idletest" )
>>> z.close()
>>> len(buffer.getvalue())
778

The "buffer" object is file-like with a 778 byte ZIP archive.

Solution 3 - Python

Why not make a tar file instead? Like so:

def downloadLogs(req, dir):
	response = HttpResponse(content_type='application/x-gzip')
	response['Content-Disposition'] = 'attachment; filename=download.tar.gz'
	tarred = tarfile.open(fileobj=response, mode='w:gz')
	tarred.add(dir)
	tarred.close()
	
	return response

Solution 4 - Python

Yes, you can use the zipfile module, zlib module or other compression modules to create a zip archive in memory. You can make your view write the zip archive to the HttpResponse object that the Django view returns instead of sending a context to a template. Lastly, you'll need to set the mimetype to the appropriate format to tell the browser to treat the response as a file.

Solution 5 - Python

models.py
from django.db import models

class PageHeader(models.Model):
    image = models.ImageField(upload_to='uploads')
views.py
from django.http import HttpResponse
from StringIO import StringIO
from models import *
import os, mimetypes, urllib

def random_header_image(request):
    header = PageHeader.objects.order_by('?')[0]
    image = StringIO(file(header.image.path, "rb").read())
    mimetype = mimetypes.guess_type(os.path.basename(header.image.name))[0]

    return HttpResponse(image.read(), mimetype=mimetype)

Solution 6 - Python

def download_zip(request,file_name):
    filePath = '<path>/'+file_name
    fsock = open(file_name_with_path,"rb")
    response = HttpResponse(fsock, content_type='application/zip')
    response['Content-Disposition'] = 'attachment; filename=myfile.zip'
    return response

You can replace zip and content type as per your requirement.

Solution 7 - Python

Same with in memory tgz archive:

import tarfile
from io import BytesIO


def serve_file(request):
    out = BytesIO()
    tar = tarfile.open(mode = "w:gz", fileobj = out)
    data = 'lala'.encode('utf-8')
    file = BytesIO(data)
    info = tarfile.TarInfo(name="1.txt")
    info.size = len(data)
    tar.addfile(tarinfo=info, fileobj=file)
    tar.close()

    response = HttpResponse(out.getvalue(), content_type='application/tgz')
    response['Content-Disposition'] = 'attachment; filename=myfile.tgz'
    return response

Attributions

All content for this solution is sourced from the original question on Stackoverflow.

The content on this page is licensed under the Attribution-ShareAlike 4.0 International (CC BY-SA 4.0) license.

Content TypeOriginal AuthorOriginal Content on Stackoverflow
QuestionJosh HuntView Question on Stackoverflow
Solution 1 - PythonmuhukView Answer on Stackoverflow
Solution 2 - PythonS.LottView Answer on Stackoverflow
Solution 3 - PythonRoshanView Answer on Stackoverflow
Solution 4 - PythonSoviutView Answer on Stackoverflow
Solution 5 - PythonRyan AnguianoView Answer on Stackoverflow
Solution 6 - PythonKamesh JungiView Answer on Stackoverflow
Solution 7 - PythonscythargonView Answer on Stackoverflow