orbit-oss/flask
4
5
Fork 2
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Documented MAX_CONTENT_LENGTH in the file upload docs and linked to Flask-Uploads

Browse source
This commit is contained in:
Armin Ronacher 2010-07-15 14:39:49 +02:00
parent 4aeb44567a
commit 54ebd88f45
1 changed files with 20 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

27
docs/patterns/fileuploads.rst
View file

@ -125,27 +125,29 @@ If you now run the application everything should work as expected.
Improving Uploads Improving Uploads
----------------- -----------------
.. versionadded:: 0.6
So how exactly does Flask handle uploads? Well it will store them in the So how exactly does Flask handle uploads? Well it will store them in the
webserver's memory if the files are reasonable small otherwise in a webserver's memory if the files are reasonable small otherwise in a
temporary location (as returned by :func:`tempfile.gettempdir`). But how temporary location (as returned by :func:`tempfile.gettempdir`). But how
do you specify the maximum file size after which an upload is aborted? By do you specify the maximum file size after which an upload is aborted? By
default Flask will happily accept file uploads to an unlimited amount of default Flask will happily accept file uploads to an unlimited amount of
memory, but you can limit that by subclassing the request and overriding memory, but you can limit that by setting the `MAX_CONTENT_LENGTH`
the Werkzeug provided :attr:`~werkzeug.BaseRequest.max_form_memory_size` config key::
attribute::
from flask import Flask, Request from flask import Flask, Request
class LimitedRequest(Request):
max_form_memory_size = 16 * 1024 * 1024
app = Flask(__name__) app = Flask(__name__)
app.request_class = LimitedRequest app.config['MAX_CONTENT_LENGTH'] = 16 * 1024 * 1024
The code above will limited the maximum allowed payload to 16 megabytes. The code above will limited the maximum allowed payload to 16 megabytes.
If a larger file is transmitted, Flask will raise an If a larger file is transmitted, Flask will raise an
:exc:`~werkzeug.exceptions.RequestEntityTooLarge` exception. :exc:`~werkzeug.exceptions.RequestEntityTooLarge` exception.
This feature was added in Flask 0.6 but can be achieved in older versions
as well by subclassing the request object. For more information on that
consult the Werkzeug documentation on file handling.
Upload Progress Bars Upload Progress Bars
-------------------- --------------------
@ -165,3 +167,14 @@ following libraries for some nice examples how to do that:
- `Plupload <http://www.plupload.com/>`_ - HTML5, Java, Flash - `Plupload <http://www.plupload.com/>`_ - HTML5, Java, Flash
- `SWFUpload <http://www.swfupload.org/>`_ - Flash - `SWFUpload <http://www.swfupload.org/>`_ - Flash
- `JumpLoader <http://jumploader.com/>`_ - Java - `JumpLoader <http://jumploader.com/>`_ - Java
An Easier Solution
------------------
Because the common pattern for file uploads exists almost unchanged in all
applications dealing with uploads, there is a Flask extension called
`Flask-Uploads`_ that implements a full fledged upload mechanism with
white and blacklisting of extensions and more.
.. _Flask-Uploads: http://packages.python.org/Flask-Uploads/