README.rst

Installation

1. pip install django-modeltools

Included Tools

Enum

The Enum class lets you quickly define enumeration types for model field values. The constructor accepts kwargs where the key is the name of the "constant" and the value is a two-tuple containing the value of the constant (which will be stored in the database) and a label.

Usage

In models.py:

from modeltools import Enum

class MyModel(models.Model):

    Color = Enum(
        RED=('r', 'Red'),
        GREEN=('g', 'Green'),
        BLUE=('b', 'Blue'),
    )

    color = models.CharField(max_length=1, choices=Color.choices())

Elsewhere:

m = MyModel.objects.filter(color=MyModel.Color.RED)

format_filename

The format_filename function provides an easy way to name user media (uploaded files) based on properties of the model that stores them.

Usage

In models.py:

from modeltools import format_filename as _ff

class Person(models.Model):
        first_name = models.CharField(max_length=50)
        last_name = models.CharField(max_length=50)
        middle_name = models.CharField(max_length=50)
        avatar = models.ImageField(upload_to=_ff('avatars/{last_name}_{first_name}'))

In the above example, {first_name} and {last_name} will be replaced with the corresponding values from the Person instance. The uploaded file will automatically retain its original extension.

upload_to=_ff('avatars/{last_name}_{first_name}/{__filename}.thumbnail{__ext}')

{__filename} and {__ext} allows access to the name and extension the file was uploaded with.

By default, the properties used in the formatting pattern will be converted to lowercase, stripped of non-word characters, and have their spaces replaced with underscores. (This behavior can be changed by providing extra arguments to the format_filename function.) The rest of the formatting string will be unaffected.