Skip to main content

Implementation of localized model fields using PostgreSQL HStore fields.

Project description

django-localized-fields is an implementation of a field class for Django models that allows the field’s value to be set in multiple languages. It does this by utilizing the hstore type (PostgreSQL specific), which is available as models.HStoreField since Django 1.10.

This package requires Python 3.5 or newer, Django 1.11 or newer and PostgreSQL 9.6 or newer.

This README is for v5.x. Check out the master branch for v6.x and newer.



  1. Install the package from PyPi:

    $ pip install django-localized-fields==5.4.1
  2. Add localized_fields and django.contrib.postgres to your INSTALLED_APPS:

  3. Set the database engine to psqlextra.backend:

        'default': {
            'ENGINE': 'psqlextra.backend'
  1. Set LANGUAGES` and `LANGUAGE_CODE in your settings:

    LANGUAGE_CODE = 'en' # default language
        ('en', 'English'),
        ('nl', 'Dutch'),
        ('ro', 'Romanian')
  2. Apply migrations to enable the HStore extension:

    python migrate



Declare fields on your model as LocalizedField:

from localized_fields.fields import LocalizedField

class MyModel(models.Model):
    title = LocalizedField()

django-localized-fields integrates with Django’s i18n system, in order for certain languages to be available you have to correctly configure the LANGUAGES and LANGUAGE_CODE settings:

LANGUAGE_CODE = 'en' # default language
     ('en', 'English'),
     ('nl', 'Dutch'),
     ('ro', 'Romanian')

All the LocalizedField you define now will be available in the configured languages.

Basic usage

new = MyModel()
new.title.en = 'english title' = 'dutch title' = 'romanian title'

By changing the active language you can control which language is presented:

from django.utils import translation

print(new.title) # prints 'dutch title'

print(new.title) # prints 'english title'

Or get it in a specific language:

print(new.title.get('en')) # prints 'english title'
print(new.title.get('ro')) # prints 'romanian title'
print(new.title.get()) # whatever language is the primary one
print(new.title.get('ar', 'haha')) # prints 'haha' if there is no value in arabic

You can also explicitly set a value in a certain language:

new.title.set('en', 'other english title')
new.title.set('nl', 'other dutch title') = 'other romanian title'



Constraints are enforced on a database level.

  • Optional filling

    class MyModel(models.Model):
        title = LocalizedField(blank=True, null=True, required=False)
  • Make translation required for any language

    class MyModel(models.Model):
        title = LocalizedField(blank=False, null=False, required=False)
  • Make translation required for specific languages

    class MyModel(models.Model):
        title = LocalizedField(blank=False, null=False, required=['en', 'ro'])
  • Make translation required for all languages

    class MyModel(models.Model):
        title = LocalizedField(blank=False, null=False, required=True)
  • By default the primary language required and the others optional:

    class MyModel(models.Model):
        title = LocalizedField()


By default the values stored in a LocalizedField are not unique. You can enforce uniqueness for certain languages. This uniqueness constraint is enforced on a database level using a UNIQUE INDEX.

  • Enforce uniqueness for one or more languages:

    class MyModel(models.Model):
        title = LocalizedField(uniqueness=['en', 'ro'])
  • Enforce uniqueness for all languages:

    from localized_fields.util import get_language_codes
    class MyModel(models.Model):
        title = LocalizedField(uniqueness=get_language_codes())
  • Enforce uniqueness for one ore more languages together (similar to Django’s unique_together):

    class MyModel(models.Model):
        title = LocalizedField(uniqueness=[('en', 'ro')])
  • Enforce uniqueness for all languages together:

    from localized_fields.util import get_language_codes
    class MyModel(models.Model):
        title = LocalizedField(uniqueness=[(*get_language_codes())])

Other fields

Besides LocalizedField, there’s also:

  • LocalizedUniqueSlugField

    Successor of LocalizedAutoSlugField that fixes concurrency issues and enforces uniqueness of slugs on a database level. Usage is the exact same:

    from localized_fields.models import LocalizedModel
    from localized_fields.fields import LocalizedField, LocalizedUniqueSlugField
    class MyModel(LocalizedModel):
         title = LocalizedField()
         slug = LocalizedUniqueSlugField(populate_from='title')

    populate_from can be:

    • The name of a field.

      slug = LocalizedUniqueSlugField(populate_from='name', include_time=True)
    • A callable.

      def generate_slug(instance):
          return instance.title
      slug = LocalizedUniqueSlugField(populate_from=generate_slug, include_time=True)
    • A tuple of names of fields.

      slug = LocalizedUniqueSlugField(populate_from=('name', 'beer') include_time=True)

    By setting the option include_time=True

    slug = LocalizedUniqueSlugField(populate_from='title', include_time=True)

    You can instruct the field to include a part of the current time into the resulting slug. This is useful if you’re running into a lot of collisions.

  • LocalizedBleachField

    Automatically bleaches the content of the field.

    • django-bleach

    Example usage:

    from localized_fields.fields import LocalizedField, LocalizedBleachField
    class MyModel(models.Model):
         title = LocalizedField()
         description = LocalizedBleachField()
  • LocalizedIntegerField

    This is an experimental field type introduced in version 5.0 and is subject to change. It also has some pretty major downsides due to the fact that values are stored as strings and are converted back and forth.

    Allows storing integers in multiple languages. This works exactly like LocalizedField except that all values must be integers. Do note that values are stored as strings in your database because the backing field type is hstore, which only allows storing strings. The LocalizedIntegerField takes care of ensuring that all values are integers and converts the stored strings back to integers when retrieving them from the database. Do not expect to be able to do queries such as:

  • LocalizedCharField and LocalizedTextField

    These fields following the Django convention for string-based fields use the empty string as value for “no data”, not NULL. LocalizedCharField uses TextInput (<input type="text">) widget for render.

    Example usage:

    from localized_fields.fields import LocalizedCharField, LocalizedTextField
    class MyModel(models.Model):
         title = LocalizedCharField()
         description = LocalizedTextField()
  • LocalizedFileField

    A file-upload field

    Parameter upload_to supports lang parameter for string formatting or as function argument (in case if upload_to is callable).

    Example usage:

    from localized_fields.fields import LocalizedFileField
    def my_directory_path(instance, filename, lang):
      # file will be uploaded to MEDIA_ROOT/<lang>/<id>_<filename>
      return '{0}/{0}_{1}'.format(lang,, filename)
    class MyModel(models.Model):
         file1 = LocalizedFileField(upload_to='uploads/{lang}/')
         file2 = LocalizedFileField(upload_to=my_directory_path)

    In template you can access to file attributes:

    {# For current active language: #}
    {{ model.file.url }}  {# output file url #}
    {{ }} {# output file name #}
    {# Or get it in a specific language: #}
    {{ }}  {# output file url for romanian language #}
    {{ }} {# output file name for romanian language #}

    To get access to file instance for current active language use localized method:


Experimental feature

Enables the following experimental features:
  • LocalizedField will return None instead of an empty LocalizedValue if there is no database value.
  • LocalizedField lookups will lookup by currently active language instead of HStoreField

Django Admin Integration

To enable widgets in the admin, you need to inherit from LocalizedFieldsAdminMixin:

from django.contrib import admin
from myapp.models import MyLocalizedModel

from localized_fields.admin import LocalizedFieldsAdminMixin

class MyLocalizedModelAdmin(LocalizedFieldsAdminMixin, admin.ModelAdmin):
    """Any admin options you need go here""", MyLocalizedModelAdmin)
The appearance of admin widget

Frequently asked questions (FAQ)

  1. Does this package work with Python 2?

    No. Only Python 3.5 or newer is supported. We’re using type hints. These do not work well under older versions of Python.

  2. With what Django versions does this package work?

    Only Django 1.11 or newer is supported, this includes Django 2.X. This is because we rely on Django’s HStoreField and template-based widget rendering.

  3. Does this package come with support for Django Admin?

    Yes. Our custom fields come with a special form that will automatically be used in Django Admin if the field is of LocalizedField.

  4. Why should I pick this over any of the other translation packages out there?

    You should pick whatever you feel comfortable with. This package stores translations in your database without having to have translation tables. It however only works on PostgreSQL.

  5. I am using PostgreSQL <9.6, can I use this?

    No. The hstore data type was introduced in PostgreSQL 9.6.

  6. I am using this package. Can I give you some beer?

    Yes! If you’re ever in the area of Cluj-Napoca, Romania, swing by :)

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for django-localized-fields, version 5.4.2
Filename, size File type Python version Upload date Hashes
Filename, size django-localized-fields-5.4.2.tar.gz (21.1 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page