Как очистить временный файл, используемый с send_file?

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

import shutil
import tempfile
import weakref

class FileRemover(object):
    def __init__(self):
        self.weak_references = dict()  # weak_ref -> filepath to remove

    def cleanup_once_done(self, response, filepath):
        wr = weakref.ref(response, self._do_cleanup)
        self.weak_references[wr] = filepath

    def _do_cleanup(self, wr):
        filepath = self.weak_references[wr]
        print('Deleting %s' % filepath)
        shutil.rmtree(filepath, ignore_errors=True)

file_remover = FileRemover()

И в вызове фляги у меня было:

@app.route('/method')
def get_some_data_as_a_file():
    tempdir = tempfile.mkdtemp()
    filepath = make_the_data(dir_to_put_file_in=tempdir)
    resp = send_file(filepath)
    file_remover.cleanup_once_done(resp, tempdir)
    return resp

Это довольно общий подход, и этот подход работал в трех разных веб-фреймворках Python, которые я использовал.

Если вы используете Flask 0.9 или выше, вы можете использовать декоратор after_this_request:

@app.route("/method",methods=['POST'])
def api_entry():
    tempcreator = ObjectThatCreatesTemporaryFiles():
    tempcreator.createTemporaryFiles()

    @after_this_request
    def cleanup(response):
        tempcreator.__exit__()
        return response

    return send_file(tempcreator.somePath)

ИЗМЕНИТЬ

Поскольку это не работает, вы можете попробовать вместо этого использовать cStringIO. (это предполагает, что ваши файлы достаточно малы, чтобы поместиться в памяти):

@app.route("/method", methods=["POST"])
def api_entry():
    file_data = dataObject.createFileData()
    # Simplest `createFileData` method:  
    # return cStringIO.StringIO("some\ndata")
    return send_file(file_data,
                        as_attachment=True,
                        mimetype="text/plain",
                        attachment_filename="somefile.txt")

В качестве альтернативы вы можете создать временные файлы, как делаете сейчас, но не удалять их приложением. Вместо этого настройте задание cron (или запланированное задание, если вы работаете в Windows), чтобы оно запускалось каждый час или около того и удаляло файлы во временном каталоге, которые были созданы более получаса назад.

У меня есть два решения.

Первое решение — удалить файл в методе __exit__, но не закрывать его. Таким образом, файл-объект по-прежнему доступен, и вы можете передать его send_file.

Это будет работать только в том случае, если вы не используете X-Sendfile, потому что оно использует имя файла.

Второе решение — полагаться на сборщик мусора. Вы можете передать send_file файл-объект, который будет очищать файл при удалении (метод __del__). Таким образом, файл удаляется только тогда, когда файл-объект удаляется из python. Для этого вы можете использовать TemporaryFile, если вы еще этого не сделали. .

Это немного поздно, но это то, что я сделал, используя предложения madjar (на случай, если кто-то еще столкнется с этим). Это небольшая вспомогательная функция, которую я использую (в качестве параметра она принимает объект PyExcelerate Workbook), которую вы можете адаптировать к своему случаю. Просто измените способ создания/сборки вашего tempfile.TemporaryFile, и все готово! Протестировано на Windows 8.1 и Ubuntu 12.04.

def xlsx_to_response(wb, filename):
    f = tempfile.TemporaryFile()
    wb._save(f)
    f.seek(0)
    response = send_file(f, as_attachment=True, attachment_filename=filename,
                         add_etags=False)

    f.seek(0, os.SEEK_END)
    size = f.tell()
    f.seek(0)
    response.headers.extend({
        'Content-Length': size,
        'Cache-Control': 'no-cache'
    })
    return response

Совместимое с Windows/Linux/Mac решение

Я пробовал слабые ссылки, встроенные декораторы фляги, и ничего не получалось.

Единственное, что работало в каждой системе, — это создать временный файл в памяти с помощью io.BytesIO.

import os
import io
import tempfile
from multiprocessing import Process

import flask


def background_job(callback):
    task = Process(target=callback())
    task.start()

def send_temp_file(file_path: str, temp_dir: tempfile.TemporaryDirectory, remove_dir_after_send=True):
    with open(file_path, "rb") as f:
        content = io.BytesIO(f.read())
    response = flask.send_file(content,
                               as_attachment=True,
                               attachment_filename=os.path.split(file_path)[0])
    if remove_dir_after_send:
        background_job(temp_dir.cleanup)
    return response



app = flask.Flask(__name__)


@app.route("/serve_file/", methods=["GET"])
def serve_file():
    temp_dir = tempfile.TemporaryDirectory()
    file_path = os.path.join(temp_dir.name, "test.txt")
    with open(file_path, "w") as f:
        f.write("Hello World!")

    return send_temp_file(file_path, temp_dir)


if __name__ == "__main__":
    app.run(port=1337)