Upload Set

class quart_uploads.UploadSet(name: str = 'files', extensions: Tuple[str] | All = FE.Defaults, default_dest: str | Callable[[Quart], str] | None = None)

This represents a single set of uploaded files. Each upload set is independent of the others. This can be reused across multiple application instances, as all configuration is stored on the application object itself and found with quart.current_app.

Parameters:

• name – The name of this upload set. It defaults to files, but you can pick any alphanumeric name you want. (For simplicity, it’s best to use a plural noun.)

• extensions – The extensions to allow uploading in this set. The easiest way to do this is to add together the extension presets (for example, TEXT + DOCUMENTS + IMAGES). It can be overridden by the configuration with the UPLOADED_X_ALLOW and UPLOADED_X_DENY configuration parameters. The default is DEFAULTS.

• default_dest – If given, this should be a callable. If you call it with the app, it should return the default upload destination path for that app.

property config: UploadConfig

This gets the current configuration. By default, it looks up the current application and gets the configuration from there. But if you don’t want to go to the full effort of setting an application, or it’s otherwise outside of a request context, set the _config attribute to an UploadConfiguration instance, then set it back to None when you’re done.

url(filename: str) → str

This function gets the URL a file uploaded to this set would be accessed at. It doesn’t check whether said file exists.

Parameters:

filename – The filename to return the URL for.

path(filename: str, folder: str | None = None) → str

This returns the absolute path of a file uploaded to this set. It doesn’t actually check whether said file exists.

Parameters:

• filename – The filename to return the path for.

• folder – The subfolder within the upload set previously used to save to.

file_allowed(basename: str) → bool

This tells whether a file is allowed. It should return True if the given werkzeug.FileStorage object can be saved with the given basename, and False if it can’t. The default implementation just checks the extension, so you can override this if you want.

Parameters:

• storage – The werkzeug.FileStorage to check.

• basename – The basename it will be saved under.

extension_allowed(ext: str) → bool

This determines whether a specific extension is allowed. It is called by file_allowed, so if you override that but still want to check extensions, call back into this.

Parameters:

ext – The extension to check, without the dot.

get_basename(filename: str) → str

Returns the file basename.

async save(storage: FileStorage, folder: str | None = None, name: str | None = None) → str

This coroutine saves a werkzeug.FileStorage into this upload set. If the upload is not allowed, an UploadNotAllowed error will be raised. Otherwise, the file will be saved and its name (including the folder) will be returned.

Parameters:

• storage – The uploaded file to save.

• folder – The subfolder within the upload set to save to.

• name – The name to save the file as. If it ends with a dot, the file’s extension will be appended to the end. (If you are using name, you can include the folder in the name instead of explicitly using folder, i.e. uset.save(file, name="someguy/photo_123.")

async resolve_conflict(target_folder: str, basename: str) → str

If a file with the selected name already exists in the target folder, this method is called to resolve the conflict. It should return a new basename for the file.

The default implementation splits the name and extension and adds a suffix to the name consisting of an underscore and a number, and tries that until it finds one that doesn’t exist.

Parameters:

• target_folder – The absolute path to the target.

• basename – The file’s original basename.