Home » Django » What is the best django model field to use to represent a US dollar amount?

What is the best django model field to use to represent a US dollar amount?

Posted by: admin November 30, 2017 Leave a comment

Questions:

I need to store a U.S. $ dollar amount in a field of a Django model. What is the best model field type to use? I need to be able to have the user enter this value (with error checking, only want a number accurate to cents), format it for output to users in different places, and use it to calculate other numbers.

Answers:

A decimal field is the right choice for the
currency value.

It will look something like:

credit = models.DecimalField(max_digits=6, decimal_places=2)

Questions:
Answers:
field = models.DecimalField(max_digits=8, decimal_places=2)

Note that max_digits should be >= decimal_places. This example setting would allow a value up to: 999,999.99

Docs: https://docs.djangoproject.com/en/1.10/ref/models/fields/#decimalfield

Questions:
Answers:

The other answers are 100% right but aren’t very practical as you’ll still have to manually manage output, formatting etc.

I would suggest using django-money:

from djmoney.models.fields import MoneyField
from django.db import models


def SomeModel(models.Model):
    some_currency = MoneyField(
        decimal_places=2,
        default=0,
        default_currency='USD',
        max_digits=11,
    )

Works automatically from templates:

{{ somemodel.some_currency }}

Output:

$123.00

It has a powerful backend via python-money and it’s essentially a drop-in replacement for standard decimal fields.

Questions:
Answers:

Define a decimal and return a $ sign in front of the value.

    price = models.DecimalField(max_digits=8, decimal_places=2)

    @property
    def price(self):
        return "$%s" % self.price

Questions:
Answers:
field = models.DecimalField(max_digits=8, decimal_places=2)

Should create a field for PostgreSQL like:

 "field" numeric(8, 2) NOT NULL

Which is the best way for PostGreSQL stored US dollar amount.

If you need a PostgreSQL field type “double precision”, then you need do in django model:

field = models.FloatField()