Skip to content
Custom field for Django to separate multiple values in database with a separator and retrieve them as list
Branch: master
Clone or download
thoas Merge pull request #13 from jnoortheen/master
fix: support django2.1 and handle removal of _get_val_from_obj
Latest commit 6e400ec Sep 19, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
separatedvaluesfield
.gitignore Ignore virtualenv folders. Mar 25, 2015
.travis.yml chore: bump Jul 27, 2018
LICENSE Initial commit Dec 5, 2013
MANIFEST.in Initial commit Dec 5, 2013
Makefile Add make dev. Mar 25, 2015
README.rst Remove compatibility section in README Dec 18, 2015
manage.py
requirements.dev.pip Add requirements for development. Mar 25, 2015
setup.py
tox.ini

README.rst

django-separatedvaluesfield

Build Status

Alternative to CommaSeparatedIntegerField built-in field that supports MultipleChoiceField, custom separator and returns values as list.

Installation

Install package from PyPi:

pip install django-separatedvaluesfield

Or download the archive from GitHub and proceed to a manual installation:

curl -L https://github.com/thoas/django-separatedvaluesfield/tarball/master | tar zx
cd thoas-django-separatedvaluesfield
python setup.py install

Add SeparatedValuesField to your Django model:

# models.py
from django.db import models

from separatedvaluesfield.models import SeparatedValuesField

class Project(models.Model):
    name = models.CharField(max_length=150)
    languages = SeparatedValuesField(
        max_length=150,
        token=',',
        choices=(
            ('en', 'English'),
            ('fr', 'French')))

If your choices values are not strings, add the cast option with the type you want to apply on values (defaults to django.utils.six.text_type):

# models.py
from django.db import models

from separatedvaluesfield.models import SeparatedValuesField

class Project(models.Model):
    name = models.CharField(max_length=150)
    languages = SeparatedValuesField(
        max_length=150,
        cast=int,
        token=',',
        choices=(
            (1, 'English'),
            (2, 'French')))

If you are running Django <= 1.6, synchronize your database using syncdb:

python manage.py syncdb

If you are running Django >= 1.7, synchronize your database using migrate:

python manage.py migrate

The SeparatedValuesField behaves like a CharField which separates values with a token (default is ,).

This field is transformed as a MultipleChoiceField when you are creating a forms.ModelForm with your model.

Usage

>>> from myapp.models import Project
>>> project = Project(name='Project with strings', languages=['fr', 'en'])
>>> project.save() # save 'fr,en' in database for the column "languages"
>>> project.pk
1

>>> project = Project.objects.get(pk=1)
>>> project.languages
['fr', 'en']

# If you added "cast" option to the field to cast to 'int'
>>> project = Project(name='Project with integers', languages=[u'1', u'2'])
>>> project.save() # save '1,2' in database for the column "languages"
>>> project = Project.objects.get(pk=1)
>>> project.languages
[1, 2]

Contribute

  1. Fork the repository
  2. Clone your fork
  3. Create a dedicated branch (never ever work in master)
  4. Create your development environment with make dev
  5. Activate your environment with source .venv/bin/activate
  6. Make modifications
  7. Write tests and execute them with make test
  8. Be sure all test pass with tox
  9. If all tests pass, submit a pull request
You can’t perform that action at this time.