djblets.avatars.services.file_upload¶
An avatar service for providing uploaded images.
- class FileUploadServiceForm(*args, **kwargs)[source]¶
The FileUploadService configuration form.
- clean_file()[source]¶
Ensure the uploaded file is an image of an appropriate size.
- Returns
The uploaded file, if it is valid.
- Return type
django.core.files.UploadedFile
- Raises
django.core.exceptions.ValidationError – Raised if the file is too large or the incorrect MIME type.
- class FileUploadService(settings_manager_class)[source]¶
An avatar service for uploaded images.
- config_form_class[source]¶
alias of
djblets.avatars.services.file_upload.FileUploadServiceForm
- property file_path_prefix[source]¶
The storage location for uploaded avatars.
This will be prepended to the path of all uploaded files. By default, it is controlled by the
UPLOADED_AVATARS_PATHsetting.
- get_unique_filename(filename)[source]¶
Create a unique filename.
The unique filename will be the original filename suffixed with a generated UUID.
- Parameters
filename (unicode) – The filename, excluding the extension.
- Returns
The unique filename.
- Return type
unicode
- get_avatar_urls_uncached(user, size)[source]¶
Return the avatar URLs for the requested user.
- Parameters
user (django.contrib.auth.models.User) – The user whose avatar URLs are to be fetched.
size (int) – The size (in pixels) the avatar is to be rendered at.
- Returns
dict: A dictionary containing the URLs of the user’s avatars at normal- and high-DPI.
- cleanup(user)[source]¶
Clean up the uploaded file.
This will delete the uploaded file from the storage.
- Parameters
user (django.contrib.auth.models.User) – The user.
- get_etag_data(user)[source]¶
Return the ETag data for the user’s avatar.
- Parameters
user (django.contrib.auth.models.User) – The user.
- Returns
The uniquely identifying information for the user’s avatar.
- Return type
list of unicode