Cheatsheet

Basic App

from quart import Quart, render_template
from quart_uploads import UploadSet, configure_uploads, IMAGES

app = Quart(__name__)

photos = UploadSet('photos', IMAGES)
configure_uploads(app, photos)

@app.route("/hello")
async def upload():
    if request.method == 'POST' and 'photo' in (await request.files):
        filename = await photos.save((await request.files)['photo'])
        # Save filename to your database of choice here.
        flash("Photo saved.")
        return redirect(url_for('show', id=rec.id))
    return await render_template('upload.html')

Large Applications

yourapplication/photos.py

from quart import Blueprint
from quart_uploads import UploadSet, IMAGES

bp = Blueprint('photos', __name__, url_prefix='/photos')

photos = UploadSet('photos', IMAGES)

# Routes & additional code here.

youapplication/audio.py

from quart import Blueprint
from quart_uploads import UploadSet, AUDIO

bp = Blueprint('audio', __name__, url_prefix='/audio')

audio = UploadSet('audio', AUDIO)

# Routes & additional code here.

youapplication/app.py

from quart import Quart
from quart_uploads import configure_uploads

def create_app() -> Quart:
    app = Quart(__name__)


    from .photos import bp as photo_bp
    app.register_blueprint(photo_bp)

    from .audio import bp as audio_bp
    app.register_blueprint(audio_bp)

    from .phtoto import photos
    from .audio import audio
    usets = (photos, audio)
    configure_uploads(app, usets)

    # Other app registration here.

    return app

Upload Set

from quart_uploads import UploadSet, IMAGES

photos = UploadSet('photos', IMAGES)photos = UploadSet('photos', IMAGES)

@app.route('/upload', methods=['GET', 'POST'])
async def some_route():
    photos.config # Current configuration for the upload set.
    photos.url('name.jpg') # Gets the url of file using extension route.
    photos.path('name.jpg') # Absolute path of uploaded file.
    photos.file_allowed('name.jpg') # If the file is allowed
    photos.extension_allowed('.jpg') # IF the file extension is allowed.
    photos.get_basename('name.jpg') # File basename.
    file_name = await photos.save('photo.jpg') # Save a FileStorage file.
    await photos.resolve_conflict('/uploads', 'photo.jpg') # Resolves filename conflict.

General Utilities

from quart_uploads import extension, lowercase_ext, addslash

ext = extension('foo.jpg') # Returns the file extension.
lower_ext = lowercase_ext('foo.JPG') # Returns the file extension as lowercase.
url = addslash('http://localhost:5000') # Returns url with slash at the end.

FileStorage Testing

from quart_uploads import UploadSet, TestingFileSorage

uset = UploadSet('photos') # Upload Set to use for testing
tfs = TestingFileSorage(filename='photo.jpg') # File Storage Testing Object
file_name = await uset.save(tfs) # Mock saving the file.