Django multiple select field
A new model field and form field. With this you can get a multiple select from a choices. Stores to the database as a CharField of comma-separated values.
This egg is inspired by this snippet.
Supported Python versions: 2.6, 2.7, 3.3+
Supported Django versions: 1.4-1.10+
Install with pip
$ pip install django-multiselectfield
Configure your models.py
from multiselectfield import MultiSelectField # ... MY_CHOICES = (('item_key1', 'Item title 1.1'), ('item_key2', 'Item title 1.2'), ('item_key3', 'Item title 1.3'), ('item_key4', 'Item title 1.4'), ('item_key5', 'Item title 1.5')) MY_CHOICES2 = ((1, 'Item title 2.1'), (2, 'Item title 2.2'), (3, 'Item title 2.3'), (4, 'Item title 2.4'), (5, 'Item title 2.5')) class MyModel(models.Model): # ..... my_field = MultiSelectField(choices=MY_CHOICES) my_field2 = MultiSelectField(choices=MY_CHOICES2, max_choices=3, max_length=3)
In your settings.py
Only you need it, if you want the translation of django-multiselectfield
INSTALLED_APPS = ( 'django.contrib.auth', 'django.contrib.contenttypes', 'django.contrib.sessions', 'django.contrib.sites', 'django.contrib.admin', #.....................# 'multiselectfield', )
Known Bugs and Limitations
All tests pass on Django 1.4, 1.5, and 1.8+, so if you can, use a modern version of Django. However, if you must use Django 1.6 or 1.7 there are two known issues you will need to be aware of:
Named groups do not render properly in Django 1.6. The workaround is to manually render the field in your form or use a custom widget. If your workaround is suitably generic, please submit a pull request with it.
Only in Django 1.6 and 1.7, due to Django bug #9619, passing a MultiSelectField to values() or values_list() will return the database representation of the field (a string of comma-separated values). The workaround is to manually call .split(',') on the result.
The Django bug was introduced in Django 1.6 and is fixed in Django 1.8 and onward, so values() and values_list() return a vanilla Python list of values for Django <= 1.5 and Django >= 1.8.
See issue #40 for discussion about this bug.
You can get the last bleeding edge version of django-multiselectfield by doing a clone of its git repository:
git clone https://github.com/goinnn/django-multiselectfield
There is a fully configured example project in the example directory. You can run it as usual:
python manage.py migrate # or python manage.py syncdb --noinput python manage.py loaddata app_data python manage.py runserver
- Fixed warning about SubfieldBase
- Added support for Django 1.8+
- Added support for named groups
- We now play nice with django-dynamic-fixture
- More tests
- Move the multiselectfield app to parent folder
- Test/example project
- Now works if the first composant of the list of tuple is an integer
- Now max_length is not required, the Multiselect field calculate it automatically.
- The max_choices attr can be a attr in the model field
- Refactor the code
- Spanish translations
- Support to python2.6
- Thanks to:
- Python 3 compatible
- Fix an error, the snippet had another error when the choices were translatables
- Improvements in the README file
- Fix an error, the snippet had an error.
- Initial version from the next snippet