Flask-Reuploaded provides file uploads for Flask.
This is an independently maintained version of Flask-Uploads based on the 0.2.1 version of the original, but also including four years of unreleased changes, at least not released to PyPI.
Noteworthy is the fix for the Werkzeug API change.
- provide a stable drop-in replacement for Flask-Uploads
- regain momentum for this widely used package
- provide working PyPI packages
As already mentioned, staying compatible with Flask-Uploads is one of this project's goals.
Nevertheless, there are the following known incompatibilities:
- the patch_request_class helper function has been removed; the function was only necessary for Flask 0.6 and earlier. Since then you can use Flask's own MAX_CONTENT_LENGTH environment variable, so you don’t read more than this many bytes from the incoming request data.
- autoserve of uploaded images now has been deactivated; this was a poorly documented "feature", which even could have lead to unwanted data disclosure; if you want to activate the feature again, you need to set UPLOADS_AUTOSERVE=True
If you have used Flask-Uploads and want to migrate to Flask-Reuploaded, you only have to install Flask-Reuploaded instead of Flask-Uploads.
That's all!
So, if you use pip to install your packages, instead of ...
$ pip install `Flask-Uploads` # don't do this! package is broken... just do ...
$ pip install `Flask-Reuploaded`Flask-Reuploaded is a drop-in replacement.
This means you do not have to change a single line of code.
$ pip install Flask-Reuploadedcreate an UploadSet
from flask_uploads import IMAGES
photos = UploadSet("photos", IMAGES)configure your Flask app and this extension
app.config["UPLOADED_PHOTOS_DEST"] = "static/img"
app.config["SECRET_KEY"] = os.urandom(24)
configure_uploads(app, photos)use photos in your view function
photos.save(request.files['photo'])See below for a complete example.
You can find the documentation at:
https://flask-reuploaded.readthedocs.io/en/latest/
You can generate the documentation locally:
tox -e docsYou can update the dependencies for documentation generation:
tox -e upgradedocsimport os
from flask import Flask, flash, render_template, request
# please note the import from `flask_uploads` - not `flask_reuploaded`!!
# this is done on purpose to stay compatible with `Flask-Uploads`
from flask_uploads import IMAGES, UploadSet, configure_uploads
app = Flask(__name__)
photos = UploadSet("photos", IMAGES)
app.config["UPLOADED_PHOTOS_DEST"] = "static/img"
app.config["SECRET_KEY"] = os.urandom(24)
configure_uploads(app, photos)
@app.route("/", methods=['GET', 'POST'])
def upload():
if request.method == 'POST' and 'photo' in request.files:
photos.save(request.files['photo'])
flash("Photo saved successfully.")
return render_template('upload.html')
return render_template('upload.html')<!doctype html>
<html lang=en>
<head>
<meta charset=utf-8>
<title>Flask-Reuploaded Example</title>
</head>
<body>
{% with messages = get_flashed_messages() %}
{% if messages %}
<ul class=flashes>
{% for message in messages %}
<li>{{ message }}</li>
{% endfor %}
</ul>
{% endif %}
{% endwith %}
<form method=POST enctype=multipart/form-data action="{{ url_for('upload') }}">
<input type=file name=photo>
<button type="submit">Submit</button>
</form>
</body>
</html>The project structure would look as following...
❯ tree -I "__*|h*"
.
├── main.py
├── static
│ └── img
└── templates
└── upload.htmlIn order to run the application, you have to enter the following commands...
❯ export FLASK_APP=main.py
❯ flask runThen point your browser to http://127.0.0.1:5000/.
Contributions are more than welcome.
Please have a look at the open issues.
There is also a short contributing guide.