django-pint-field 2024.11.5

Unit Conversion fields for Django and Postgres

django-pint-field

Store, validate, and convert physical quantities in Django using Pint.

Why Django Pint Field?

Django Pint Field enables you to:

• Store quantities (like 1 gram, 3 miles, 8.120391 angstroms) in your Django models
• Edit quantities in forms with automatic unit conversion
• Compare quantities in different units (e.g., compare weights in pounds vs. kilograms)
• Display quantities in user-preferred units while maintaining accurate comparisons
• Perform aggregations and lookups across different units of measurement

The package uses a Postgres composite field to store both the magnitude and units, along with a base unit value for accurate comparisons. This approach ensures that users can work with their preferred units while maintaining data integrity and comparability. For this reason, the project only works with Postgresql databases.

Requirements

• Python 3.10+
• Django 4.2+
• PostgreSQL database
• Pint 0.23+

Installation

pip install django-pint-field

Add to your INSTALLED_APPS:

INSTALLED_APPS = [
    ...
    'django_pint_field',
    ...
]

Run migrations:

python manage.py migrate django_pint_field

Failure to run django-pint-field migrations before running migrations for models using PintFields will result in errors. The migration creates a required composite type in your PostgreSQL database.

Previous versions of the package added three compsite types to the database. The newest migration modifies the columns with these types to use a single composite type.

Tips for Upgrading from Legacy django-pint-field

If using [django-pgtrigger](https://django-pgtrigger.readthedocs.io/en/latest/commands/) or other packages that depend on it (e.g.: django-pghistory), we highly recommend that you temporarily uninstall all triggers before running the django-pint-field migrations. It is also a good practice to make a backup of your database before running the migration. Users freshly installing `django-pint-field` do not need to worry about this warning.

python manage.py pgtrigger uninstall

Then run the migrations:

python manage.py migrate django_pint_field

Reinstall the triggers after the migrations are complete:

python manage.py pgtrigger install

Quick Start

1. Define your model:

from django.db import models
from django_pint_field.models import DecimalPintField

class Product(models.Model):
    name = models.CharField(max_length=100)
    weight = DecimalPintField(
        default_unit="gram",
        max_digits=10,
        decimal_places=2,
        unit_choices=["gram", "kilogram", "pound", "ounce"]
    )

2. Use it in your code:

from django_pint_field.units import ureg

# Create objects
product = Product.objects.create(
    name="Coffee Bag",
    weight=ureg.Quantity(340, "gram")
)

# Query using different units
products = Product.objects.filter(
    weight__gte=ureg.Quantity(0.5, "kilogram")
)

# Access values
print(product.weight)  # 340 gram
print(product.weight.to("kilogram"))  # 0.34 kilogram

Features

Field Types

• IntegerPintField: For whole number quantities
• DecimalPintField: For precise decimal quantities
• BigIntegerPintField: For large whole number quantities

Form Fields and Widgets

• Built-in form fields with unit conversion
• TabledPintFieldWidget for displaying unit conversion tables
• Customizable validation and unit choices

Form Fields

• IntegerPintFormField: Used in forms with IntegerPintField and BigIntegerPintField.
• DecimalPintFormField: Used in forms with DecimalPintField.

Widgets

• PintFieldWidget: Default widget for all django pint field types.
• TabledPintFieldWidget: Provides a table showing conversion to each of the unit_choices.

Django REST Framework Integration

from django_pint_field.rest import DecimalPintRestField

class ProductSerializer(serializers.ModelSerializer):
    weight = DecimalPintRestField()

    class Meta:
        model = Product
        fields = ['name', 'weight']

Supported Lookups

• exact
• gt, gte
• lt, lte
• range
• isnull

Aggregation Support

from django_pint_field.aggregates import PintAvg, PintSum

Product.objects.aggregate(
    avg_weight=PintAvg('weight'),
    total_weight=PintSum('weight')
)

Advanced Usage

Custom Units

Create your own unit registry:

from pint import UnitRegistry

custom_ureg = UnitRegistry()
custom_ureg.define("custom_unit = [custom]")

# In settings.py
DJANGO_PINT_FIELD_UNIT_REGISTER = custom_ureg

Indexing

Django Pint Field supports creating indexes on the comparator components of Pint fields. Indexes can improve query performance when filtering, ordering, or joining on Pint field values.

Single Field Index

from django_pint_field.indexes import PintFieldComparatorIndex

class Package(models.Model):
    weight = DecimalPintField("gram", max_digits=10, decimal_places=2)

    class Meta:
        indexes = [
            PintFieldComparatorIndex(fields=['weight'])
        ]

Multi-Field Index

from django_pint_field.indexes import PintFieldComparatorIndex

class Package(models.Model):
    weight = DecimalPintField("gram", max_digits=10, decimal_places=2)
    volume = DecimalPintField("liter", max_digits=10, decimal_places=2)

    class Meta:
        indexes = [
            PintFieldComparatorIndex(fields=['weight', 'volume'])
        ]

You can also use additional index options, as usual. e.g.:

• name: Custom index name
• condition: Partial index condition
• include: Additional columns to include in the index
• db_tablespace: Custom tablespace for the index

Settings

# settings.py

# Set decimal precision for the entire project
DJANGO_PINT_FIELD_DECIMAL_PRECISION = 40

# Configure custom unit registry
DJANGO_PINT_FIELD_UNIT_REGISTER = custom_ureg

Credits

Modified from django-pint with a focus on composite field storage and enhanced comparison capabilities.