Source code for dal_select2.views

"""Select2 view implementation."""

import json

from dal.views import BaseQuerySetView, ViewMixin

from django import http
from django.core.exceptions import ImproperlyConfigured
from django.utils.translation import ugettext as _
from django.views.generic.list import View


[docs]class Select2ViewMixin(object): """View mixin to render a JSON response for Select2."""
[docs] def get_results(self, context): """Return data for the 'results' key of the response.""" return [ { 'id': self.get_result_value(result), 'text': self.get_result_label(result), } for result in context['object_list'] ]
[docs] def get_create_option(self, context, q): """Form the correct create_option to append to results.""" create_option = [] display_create_option = False if self.create_field and q: page_obj = context.get('page_obj', None) if page_obj is None or page_obj.number == 1: display_create_option = True if display_create_option and self.has_add_permission(self.request): create_option = [{ 'id': q, 'text': _('Create "%(new_value)s"') % {'new_value': q}, 'create_id': True, }] return create_option
[docs] def render_to_response(self, context): """Return a JSON response in Select2 format.""" q = self.request.GET.get('q', None) create_option = self.get_create_option(context, q) return http.HttpResponse( json.dumps({ 'results': self.get_results(context) + create_option, 'pagination': { 'more': self.has_more(context) } }), content_type='application/json', )
[docs]class Select2QuerySetView(Select2ViewMixin, BaseQuerySetView): """List options for a Select2 widget."""
[docs]class Select2ListView(ViewMixin, View): """Autocomplete from a list of items rather than a QuerySet."""
[docs] def get_list(self): """"Return the list strings from which to autocomplete.""" return []
[docs] def get(self, request, *args, **kwargs): """"Return option list json response.""" results = self.get_list() create_option = [] if self.q: results = [x for x in results if self.q.lower() in x.lower()] if hasattr(self, 'create'): create_option = [{ 'id': self.q, 'text': 'Create "%s"' % self.q, 'create_id': True }] return http.HttpResponse(json.dumps({ 'results': [dict(id=x, text=x) for x in results] + create_option }))
[docs] def post(self, request): """"Add an option to the autocomplete list. If 'text' is not defined in POST or self.create(text) fails, raises bad request. Raises ImproperlyConfigured if self.create if not defined. """ if not hasattr(self, 'create'): raise ImproperlyConfigured('Missing "create()"') text = request.POST.get('text', None) if text is None: return http.HttpResponseBadRequest() text = self.create(text) if text is None: return http.HttpResponseBadRequest() return http.HttpResponse(json.dumps({ 'id': text, 'text': text, }))