django-upload-to

It generates dynamically a directory path and a secure file name for Django FileField.

Main options:

• Ready to use generators.
• Generate secure file name without especial characters.
• Generate file name using a uuid value.
• Dynamically generate paths from the model instance.
• Generate paths using Python datetime formats.

Get started

Install the django-upload-to in your virtual environment

$ pip install django-upload-to

Import it in your models file and add it as a upload_to argument in the FileField

# my_app/models.py
from upload_to import UploadTo
from django.db import models


class MyModel(models.Model):
    attachment = models.FileField(upload_to=UploadTo("attachments"))

The path and file name generated will be like this:

"attachments/the-file-name-uploaded.pdf"

How to use the ready-to-use classes

Consider the scenario below:

import upload_to
from django.db import models


class MyUser(models.Model):
    username = models.CharField(...)
    avatar = models.FileField(upload_to=<generator>)

instance = MyUser(username='[email protected]')

Replace the <generator> fragment by the generators as showed below:

File in root folder

>>> generator = upload_to.UploadTo()
>>> generator(instance, "file.pdf")
"file.pdf"

Define a folder structure

>>> generator = upload_to.UploadTo(prefix=["files", "documents"])
>>> generator(instance, "file.pdf")
"files/documents/file.pdf"

Generate a folder name using datetime formats from Python

>>> generator = upload_to.UploadTo(prefix=["pictures", "%Y"])
>>> generator(instance, "file.png")
"pictures/2023/file.png"

Replace the file name by an hexadecimal uuid value

# 4. replace file name by a uuid value
>>> generator = upload_to.UuidUploadTo()
>>> generator(instance, "file.pdf")
"b189dfdf25e640b2ba5c497472c20962.pdf"

Generate the folder path using the instance's attributes

>>> generator = upload_to.AttrUploadTo(attrs=["username"])
>>> generator(instance, "file.pdf")
"useremailcom/file.pdf"

Generate the folder path using the app_label and the model_name from the instance's meta options

>>> generator = upload_to.ModelUploadTo()
>>> generator(instance, "file.pdf")
"my_app/user/file.pdf"

Customize your upload paths

# my_app/models.py
import upload_to
from django.db import models


def my_upload_generator(instance, filename):
    filename = upload_to.uuid_filename(filename)
    path = upload_to.options_from_instance(instance)
    return upload_to.upload_to(path, filename)

class MyProfile(models.Model):
    user = models.OneToOneField(...)
    avatar = models.FileField(upload_to=my_upload_generator)

File size validators

The library also provides file size validators to restrict upload file sizes.

MaxSizeValidator

Validates that the file size is less than the specified limit.

# my_app/models.py
from upload_to import UploadTo, MaxSizeValidator, MB
from django.db import models


class MyModel(models.Model):
    attachment = models.FileField(
        upload_to=UploadTo("attachments"),
        validators=[MaxSizeValidator(5 * MB)]  # Max 5MB
    )

MinSizeValidator

Validates that the file size is greater than the specified limit.

# my_app/models.py
from upload_to import UploadTo, MinSizeValidator, KB
from django.db import models


class MyModel(models.Model):
    attachment = models.FileField(
        upload_to=UploadTo("attachments"),
        validators=[MinSizeValidator(1 * KB)]  # Min 1KB
    )

Using both validators together

# my_app/models.py
from upload_to import UploadTo, MaxSizeValidator, MinSizeValidator, KB, MB
from django.db import models


class MyModel(models.Model):
    attachment = models.FileField(
        upload_to=UploadTo("attachments"),
        validators=[
            MinSizeValidator(1 * KB),  # Min 1KB
            MaxSizeValidator(5 * MB),   # Max 5MB
        ]
    )

Available size units

The library provides convenient size unit constants:

• KB = 1,024 bytes
• MB = 1,048,576 bytes
• GB = 1,073,741,824 bytes
• TB = 1,099,511,627,776 bytes
• PB = 1,125,899,906,842,624 bytes

Useful links

1. Documentation
2. Changelog
3. PyPi Page