Django में ऑटो-मल्टीपल मल्टीपल च्वाइस फील्ड

हाय, हैब्र।
अपने आखिरी लेख में, मैंने Django में टैग दर्ज करने के लिए कस्टम फ़ील्ड बनाने की तकनीक का वर्णन किया। अब मैं एक तैयार और अधिक या कम सार्वभौमिक समाधान साझा करना चाहूंगा जो कि AJAX के अनुसार ऑटो-पूर्ति के साथ कई विकल्प क्षेत्र को लागू करता है। इस फ़ील्ड और पिछले आलेख में वर्णित अंतर यह है कि यह आपको केवल निर्देशिका से आइटम का चयन करने की अनुमति देता है, लेकिन नए नहीं बनाता है। अद्भुत jQuery प्लगइन Select2 सामने के अंत भाग के लिए जिम्मेदार होगा। समाधान एक अलग Django आवेदन के रूप में जारी किया जाएगा।

विजेट

from django.forms.widgets import Widget from django.conf import settings from django.utils.safestring import mark_safe from django.template.loader import render_to_string class InfiniteChoiceWidget(Widget): '''Infinite choice widget, based on Select2 jQuery-plugin (http://ivaynberg.imtqy.com/select2/)''' class Media: js = ( settings.STATIC_URL + "select2/select2.js", ) css = { 'all': (settings.STATIC_URL + 'select2/select2.css',) } def __init__(self, data_model, multiple=False, disabled=False, attrs=None): super(InfiniteChoiceWidget, self).__init__(attrs) self.data_model = data_model self.multiple = multiple self.disabled = disabled def render(self, name, value, attrs=None): return mark_safe(render_to_string("infinite_choice_widget.html", {"disabled": self.disabled, "multiple": self.multiple, "attrs": attrs, "app_name": self.data_model._meta.app_label, "model_name": self.data_model.__name__, "input_name": name, "current_value": value if value else "", }) ) 

विजेट निर्माता एक मॉडल वर्ग, एकाधिक और अक्षम झंडे, जो क्रमशः जिम्मेदार हैं, चयन और क्षेत्र की गतिविधि की बहुलता के लिए स्वीकार करता है। मीडिया उपवर्ग Select2 लिपियों और शैलियों को जोड़ता है। Select2 प्लगइन को इनिशियलाइज़ करने वाली स्क्रिप्ट को infinite_choice_widget.html टेम्पलेट में वर्णित किया जाएगा।

 {% load url from future %} {#    django 1.5 #} <input type="hidden" {% for key,value in attrs.iteritems %} {{key}}="{{value}}" {% endfor %} name="{{input_name}}" value="{{current_value}}" /> {# Settings for Select2 #} <script type="text/javascript"> $("#{{attrs.id}}").select2({ multiple: {{multiple|yesno:"true,false"}}, formatInputTooShort: function (input, min) { return ",  " + (min - input.length) + "   "; }, formatSearching: function () { return "..."; }, formatNoMatches: function () { return "  "; }, minimumInputLength: 3, initSelection : function (element, callback) { $.ajax({ url: "{% url 'infinite_choice_data' app_name model_name %}", type: 'GET', dataType: 'json', data: {ids: element.val()}, success: function(data, textStatus, xhr) { callback(data); }, error: function(xhr, textStatus, errorThrown) { callback({}); } }); }, ajax: { url: "{% url 'infinite_choice_data' app_name model_name %}", dataType: 'json', data: function (term, page) { return {term: term, // search term page_limit: 10 }; }, results: function (data, page) { return {results: data}; } } }); {% if disabled %} $("#{{attrs.id}}").select2("disable"); {% endif %} </script> 

यहां केंद्रीय वस्तु एक छिपा हुआ इनपुट है, जो चयनित विकल्पों के पहचानकर्ताओं को संग्रहीत करेगा। और पहले से ही #id पर इसके द्वारा Select2 प्लगइन इसके खिलाफ सेट है।
चलो प्लगइन मापदंडों पर चलते हैं।

• एकाधिक - कई विकल्प की संभावना को सक्षम / अक्षम करता है
• formatInputTooShort - स्वत: पूर्णता ट्रिगर होने से पहले कितने वर्णों को दर्ज करने के लिए छोड़ दिया जाता है एक स्ट्रिंग लौटाता है
• formatSearching - यह दर्शाता है कि खोज प्रक्रिया जारी है
• formatNoMatches - निराशाजनक से दिखाया गया एक स्ट्रिंग ...
• न्यूनतमइन्फ्लेमेट्री - स्वत: पूर्णता को ट्रिगर करने के लिए न्यूनतम वर्ण दर्ज किए गए
• initSelection - यदि पृष्ठ लोड करते समय छिपे हुए फ़ील्ड में कोई चयनित तत्व हैं, तो यह फ़ंक्शन सर्वर को इन तत्वों के लिए प्रदर्शित नामों को खोजने के लिए AJAX अनुरोध करता है।
• अजाक्स - दर्ज पाठ भेजता है और वस्तुओं की एक सूची प्राप्त करता है {आईडी: ..., शीर्षक: ...} जिसका शीर्षक दर्ज किए गए पाठ से शुरू होता है। शब्द - प्रविष्टियों के लिए खोज करने के लिए स्ट्रिंग में प्रवेश किया, पेज_लिमिट - प्रदर्शित विकल्पों की संख्या मिली।

कृपया ध्यान दें कि इस एप्लिकेशन से आवेदन का नाम और मॉडल का नाम उस URL में इंगित किया जाता है जहां डेटा का अनुरोध किया जाता है। यह प्रसंस्करण प्रतिनिधित्व को सार्वभौमिक बनाने के लिए किया जाता है: यह देखने के लिए स्पष्ट रूप से पता नहीं है कि डेटा किस मॉडल से लिया गया है, हम इसे हर बार बताएंगे।
अंत में, हम प्लगइन को निष्क्रिय होने के लिए कहते हैं यदि विजेट निष्क्रिय हो गया है = सही।

स्वतः पूर्ण होने वाले कार्य के लिए सबमिशन

जैसा कि मैंने कहा, दृश्य सार्वभौमिक होना चाहिए और यह जानने की आवश्यकता नहीं है कि किस मॉडल से डेटा लेना है। मॉडल क्लास को जाने-माने एप्लिकेशन नाम और मॉडल क्लास के नाम से प्राप्त करने का एक मानक तरीका है, हम इन पंक्तियों को दृश्य में पास करके इसका उपयोग करेंगे।

 from django.http import Http404, HttpResponse import json from django.db.models import get_model def infinite_choice_data(request, app_name, model_name): '''Returns data for infinite choice field''' data = [] if not request.is_ajax(): raise Http404 model = get_model(app_name, model_name) if 'term' in request.GET: term = request.GET['term'] page_limit = request.GET['page_limit'] data = model.objects.filter(title__startswith=term)[:int(page_limit)] json_data = json.dumps([{"id": item.id, "text": unicode(item.title)} for item in data]) if 'ids' in request.GET: id_list = request.GET['ids'].split(',') items = model.objects.filter(pk__in=id_list) json_data = json.dumps([{"id": item.id, "text": item.title} for item in items]) response = HttpResponse(json_data, content_type="application/json") response['Cache-Control'] = 'max-age=86400' return response 

Django.db.models.get_model फ़ंक्शन एक मॉडल वर्ग देता है। इसके अलावा, अनुरोध चर के आधार पर, या तो स्ट्रिंग या वेरिएंट के साथ शुरू होने वाले वेरिएंट, जो आईडी वेरिएबल में पारित किए गए आईडी के बराबर होते हैं, मॉडल से चुने जाते हैं। दूसरा मामला तब होता है जब प्लगइन पहले से दर्ज डेटा के साथ आरंभीकृत होता है।
मैंने कैश-कंट्रोल हेडर को एक दिन के कैशे डेटा जीवनकाल के साथ प्रतिक्रिया में जोड़ा। यह एक ही प्रकार के क्वेरी के डेटाबेस को खींचने के लिए नहीं है। KLADR / FIAS जैसी विशाल निर्देशिकाओं वाले फ़ील्ड का उपयोग करने पर यह बहुत मदद करता है।

और यह कैसे urls.py में प्रवेश हमारे विचार के लिए लग रहा है।

 from django.conf.urls import patterns, url from views import infinite_choice_data urlpatterns = patterns('', url(r'^(?P<app_name>[\w\d_]+)/(?P<model_name>[\w\d_]+)/$', view=infinite_choice_data, name='infinite_choice_data'), ) 

फॉर्म फील्ड

जैसा कि आप जानते हैं, django में प्रपत्र फ़ील्ड मुख्य रूप से इसमें दर्ज किए गए डेटा को मान्य करने के लिए कार्य करता है। हमारा क्षेत्र वर्ग ऐसा दिखेगा:

 from django.forms import fields as f_fields from django.core.exceptions import ValidationError from django.core import validators from django.utils.translation import ugettext_lazy as _ class InfiniteChoiceField(f_fields.Field): '''Infinite choice field''' default_error_messages = { 'invalid_choice': _(u'Select a valid choice. %(value)s is not one of the available choices.'), } def __init__(self, data_model, multiple=False, disabled=False, widget_attrs=None, **kwargs): self.data_model = data_model self.disabled = disabled self.multiple = multiple widget = InfiniteChoiceWidget(data_model, multiple, disabled, widget_attrs) super(InfiniteChoiceField, self).__init__(widget=widget, **kwargs) def to_python(self, value): if value in validators.EMPTY_VALUES: return None if self.multiple: values = value.split(',') qs = self.data_model.objects.filter(pk__in=values) pks = set([i.pk for i in qs]) for val in values: if not int(val) in pks: raise ValidationError(self.error_messages['invalid_choice'] % {'value': val}) return qs else: try: return self.data_model.objects.get(pk=value) except self.data_model.DoesNotExists: raise ValidationError(self.error_messages['invalid_choice'] % {'value': value}) def prepare_value(self, value): if value is not None and hasattr(value, '__iter__') and self.multiple: return u','.join(unicode(v.pk) for v in value) return unicode(value.pk) 

मुझे ModelMultipleChoiceField से विरासत में नहीं मिला, क्योंकि यह क्वेरीसेट के साथ काम करता है, और हमें मॉडल के साथ काम करने की आवश्यकता है।
कंस्ट्रक्टर विजेट को पारित मॉडल, कई और अक्षम झंडे, और विशिष्ट विशेषताओं के साथ आरंभीकृत करता है।
To_python पद्धति एक ही लाइन पर एक ही id या कई id के रूप में मान प्राप्त करती है, जिसे अल्पविराम द्वारा अलग किया जाता है, और इसे एकाधिक ध्वज के आधार पर संसाधित करता है। दोनों मामलों में, मॉडल में चयनित आईडी की उपस्थिति की जांच की जाती है।
तैयारी_वायु विधि प्रदर्शन के लिए इनिशियलाइज़ेशन डेटा तैयार करती है: यदि मॉडल का एक भी उदाहरण फ़ील्ड के प्रारंभिक पैरामीटर में पास हो जाता है, तो यह स्ट्रिंग के रूप में इस उदाहरण की आईडी लौटाता है; यदि उदाहरणों या क्वेरीसेट की सूची पास हो जाती है, तो आईडी के साथ एक पंक्ति को अल्पविराम द्वारा अलग कर देता है।

निष्कर्ष

मैदान खाने के लिए तैयार है। आवेदन यहां से डाउनलोड किया जा सकता है । क्षेत्र का उपयोग करना बहुत आसान है:

 from django import forms from infinite_choice_field import InfiniteChoiceField from models import ChoiceModel class TestForm(forms.Form): choice = InfiniteChoiceField(ChoiceModel, multiple=True, disabled=False, required=False, initial=ChoiceModel.objects.filter(id__in=(7, 8, 12))) 

च्वाइसमॉडल एक मनमाना दृश्य मॉडल है

 class ChoiceModel(models.Model): title = models.CharField(max_length=100, verbose_name="Choice title") class Meta: verbose_name = 'ChoiceModel' verbose_name_plural = 'ChoiceModels' def __unicode__(self): return self.title 

यह सेटिंग्स में एप्लिकेशन को कनेक्ट करने के लिए याद रखना बाकी है,

 INSTALLED_APPS = ( 'django.contrib.auth', 'django.contrib.contenttypes', 'django.contrib.sessions', 'django.contrib.sites', 'django.contrib.messages', 'django.contrib.staticfiles', 'infinite_choice_field', ... } 

आयात यूआरएल

 urlpatterns = patterns('', # Examples: # url(r'^$', 'habr_test.views.home', name='home'), url(r'^', include('core.urls')), url(r'^infinite_choice_data/', include('infinite_choice_field.urls')), # Uncomment the next line to enable the admin: url(r'^admin/', include(admin.site.urls)), ) 

और टेम्प्लेट फॉर्म के स्टैटिक्स को टेम्प्लेट में प्रदर्शित करते हैं

 <!doctype html> <html> <head> <title>Test InfiniteChoiceField</title> {{test_form.media}} </head> <body> <form action=""> {{test_form}} </form> </body> </html>