डेजैंगो-डबसेटिंग्स में इमेजवैल्यू

शुभ दोपहर

अक्सर उपयोगकर्ता (प्रशासनिक) साइट सेटिंग्स रखने की आवश्यकता होती है जो दो साधारण कारणों से settings.py में परिभाषित नहीं किया जा सकता है: settings.py से सेटिंग्स को सर्वर को पुनरारंभ किए बिना नहीं बदला जा सकता है; और - सबसे महत्वपूर्ण बात - वे केवल प्रोग्रामर द्वारा बदल सकते हैं।

Django-dbsettings मॉड्यूल (पूर्व में django-values) को इन प्रतिबंधों से बचाने के लिए डिज़ाइन किया गया है: यह डेटाबेस में उपयोगकर्ता सेटिंग्स को संग्रहीत करने के लिए एक तंत्र प्रदान करता है, साथ ही उन्हें संपादित करने के लिए सुविधाजनक विचार भी प्रदान करता है।

और सब कुछ ठीक होने लगता है ... लेकिन! यदि आपको सेटिंग के रूप में चित्र की आवश्यकता है तो क्या करें: उदाहरण के लिए, साइट लोगो? जैसा कि यह निकला, django-dbsettings इस प्रकार के मूल्य का समर्थन नहीं करता है ।

मैंने django-dbsettings में ImageValue समर्थन कैसे जोड़ा, इसके बारे में मैं बताने जा रहा हूं।

प्रागितिहास

जब मुझे सेटिंग करने के कार्य का सामना करना पड़ा, तो मुझे django-values ​​परियोजना मिली, जो निष्क्रिय हो गई। उसके साथ पीड़ित होने के बाद, मुझे पता चला कि उसका नाम बदलकर django-dbsettings रखा गया था और github चला गया।
गीताब पर 20 कांटे थे। उनमें से कई की कोशिश करने के बाद, मैं पिछले अद्यतन किए गए एक पर रुक गया। वह एक कार्यकर्ता बन गया और पहली बार जादू के बिना घायल हो गया। एकमात्र समस्या सेटिंग्स में "पिक्चर" प्रकार की कमी थी।

दो विकल्प थे: या तो चित्रों को सेटिंग्स के रूप में जोड़ने के लिए अपनी परियोजना में बैसाखी बनाएं, या परियोजना को कांटा करें और सब कुछ खूबसूरती से करें। चुनाव स्पष्ट था।

लक्ष्यों

इस लेख के उद्देश्य कई थे:

• सबसे पहले, मैं दिखाना चाहता था कि django-dbsettings कैसे काम करता है ताकि आप में से जिनको अपने _settings_ प्रकार को जोड़ने की आवश्यकता है वे इस मॉड्यूल के कोड को पढ़ने के लिए एक अतिरिक्त दिन खर्च न करें;
• दूसरी बात, मैं अपने पाठकों (बल्कि, "कोड लेखकों" के लिए भी) अपनी इच्छा व्यक्त करना चाहता था: जब कुछ काम करता है तो रुकना नहीं चाहिए! जब तक आप अपने "दिमाग की उपज" के लिए गर्व और सौंदर्य संतुष्टि की भावना महसूस नहीं करते हैं, तब तक अपने कोड की समीक्षा और सुधार जारी रखें (लेकिन कट्टरता न लाएं: "इसे सरल रखें" ©);
• लेख एक ओपन सोर्स प्रोजेक्ट में बदलाव करने का एक उदाहरण है और विशेष रूप से, कैसे आपके काम को परियोजना में शैली और तर्क में अच्छी तरह से फिट होना चाहिए और अन्य सिस्टम मॉड्यूल के संचालन में हस्तक्षेप नहीं करना चाहिए। मेरा निर्णय तुरंत यहाँ प्रस्तुत नहीं किया गया था: पहले, अन्य फाइलें प्रभावित हुईं; कुछ अतिरिक्त ifs और विरासत आदि थे, लेकिन, पिछले बिंदु का अनुसरण करते हुए, कोड को कम से कम और स्थानीय बनाना संभव था।

परियोजना की संरचना

(बोल्ड फाइलें जिसमें आपको ImageValue को लागू करने के लिए बदलाव करने थे)

• टेम्प्लेट / - में दो टेम्प्लेट होते हैं: संपूर्ण साइट की सेटिंग्स और व्यक्तिगत एप्लिकेशन की सेटिंग्स को देखने और संपादित करने के लिए
• परीक्षण / - में परीक्षण शामिल हैं
• __init__.py
• dbsettings.txt - मॉड्यूल का उपयोग करने में मदद करें (यह विस्तार से वर्णन करता है कि इसका उपयोग कैसे किया जाए)
• form.py - संपादन सेटिंग्स के लिए फार्म निर्माता
• group.py - सेटिंग समूह के वर्ग को परिभाषित करता है, एक्सेस अधिकारों को नियंत्रित करता है
• loading.py - इसमें डेटाबेस के साथ काम करने के लिए फंक्शन हैं (ऐड, सेव, रीड सेटिंग्स)
• model.py - सेटिंग को संग्रहीत करने के लिए अपना स्वयं का मॉडल होता है
• urls.py - इसमें सेटिंग पृष्ठ देखने और संपादित करने के लिए यूआरएल हैं
• utils.py - इसमें syncdb निष्पादित करते समय डिफ़ॉल्ट मान सेट करने का कार्य होता है
• values.py - इसमें सेटिंग्स के प्रकारों का विवरण होता है
• view.py - इसमें दृश्य / संपादन का विवरण होता है

हम क्या याद कर रहे हैं?

मैं पैच रूप में किए गए परिवर्तनों को दिखाऊंगा: " - " - हटाई गई रेखा, " + " - जोड़ी गई रेखा।

टेम्पलेट्स

-<form method="post"> +<form enctype="multipart/form-data" method="post"> ... </form> 

Django-dbsettings टेम्प्लेट में फ़ॉर्म विवरण में फ़ाइलों को स्वीकार करने के लिए फ़ॉर्म आवश्यक नहीं है, और दृश्य उन्हें अनुरोध में प्राप्त होगा।

प्रकार

 ... if request.method == 'POST': # Populate the form with user-submitted data - form = editor(request.POST.copy()) + form = editor(request.POST.copy(), request.FILES) ... 

मान्यता प्राप्त करने के लिए डाउनलोड की गई फ़ाइलों के लिए और दर्ज किए गए अन्य डेटा के साथ form.cleaned_data में गिरने के लिए, आपको फॉर्म बनाते समय अनुरोधों से प्राप्त फ़ाइलों को इसे पास करने की आवश्यकता होती है।

सेटिंग्स के प्रकार

हम इस पर अधिक विस्तार से ध्यान देंगे।
मानों की फ़ाइल में सेटिंग्स के लिए आधार वर्ग का विवरण होता है। बाकी सभी चीज़ों के अलावा, इसमें तीन विधियाँ हैं, जिन्हें सभी बाल वर्गों में ओवरराइड किया जाना चाहिए:

 ... class Value(object): ... def to_python(self, value): """ native-python ,       """ return value def get_db_prep_save(self, value): """  pre-save    ,     CharField   """ return unicode(value) def to_editor(self, value): """     ,      """ return unicode(value) ... 

साथ ही, मान वर्ग में एक फ़ील्ड विशेषता होनी चाहिए जिसमें इसे बनाने के लिए प्रपत्र फ़ील्ड वर्ग (जैसे django.forms.FileInput) को संग्रहीत किया जाना चाहिए।

आपका मूल्य लेखन

 class ImageValue(Value): def __init__(self, *args, **kwargs): if 'upload_to' in kwargs: self._upload_to = kwargs['upload_to'] del kwargs['upload_to'] super(ImageValue, self).__init__(*args, **kwargs) ... 

हम बेस क्लास वैल्यू से इनहेरिट करेंगे, हमारे upload_to पैरामीटर को प्रोसेस करेंगे ताकि आप IMAGE_ROOT में सबफ़ोल्डर को नियंत्रित कर सकें जिसमें उपयोगकर्ता चित्र अपलोड किए जाएंगे।

हम _setting_ के उपयोग के विभिन्न चरणों में मूल्य प्रदर्शित करने के लिए जिम्मेदार तरीकों को फिर से परिभाषित करते हैं।
आइए इमेज को लोड करके और डेटाबेस में सेव करके शुरू करें।

 from os.path import join as pjoin class ImageValue(Value): ... def get_db_prep_save(self, value): if not value: return None hashed_name = md5(unicode(time.time())).hexdigest() + value.name[-4:] image_path = pjoin(self._upload_to, hashed_name) dest_name = pjoin(settings.MEDIA_ROOT, image_path) with open(dest_name, 'wb+') as dest_file: for chunk in value.chunks(): dest_file.write(chunk) return unicode(image_path) ... 

मान पैरामीटर में django.core.files.uploadedfile से UploadedFile ऑब्जेक्ट है। यह एक मानक ऑब्जेक्ट है जो फ़ाइलों को डाउनलोड करते समय बनाया जाता है और अनुरोध में आता है।
विधि सरल ट्रिक्स का उत्पादन करती है: यह एक अद्वितीय फ़ाइल नाम बनाता है, और डाउनलोड की गई फ़ाइल को स्वनिर्धारित निर्देशिका में self._upload_to में निर्दिष्ट करता है। विधि सेटिंग्स के सापेक्ष चित्र के लिए पथ देता है। इस प्रकार, सेटिंग इस डेटाबेस में भी मिलती है।

अब उलटा परिवर्तन करते हैं: डेटाबेस में रिकॉर्ड से पिक्चर ऑब्जेक्ट प्राप्त करते हैं, इसके लिए निम्न विधि जिम्मेदार है:

 class ImageValue(Value): ... def to_editor(self, value): if not value: return None file_name = pjoin(settings.MEDIA_ROOT, value) try: with open(file_name, 'rb') as f: uploaded_file = SimpleUploadedFile(value, f.read(), 'image') #  ""      name uploaded_file.__dict__['_name'] = value return uploaded_file except IOError: return None ... 

यहां सब कुछ रिवर्स ऑर्डर में किया गया है: हम डेटाबेस से लिए गए मूल्य के साथ छवि के लिए पथ बनाते हैं, सिंपलऑउटलोडेडफ़ाइल ऑब्जेक्ट बनाते हैं और उसमें छवि फ़ाइल पढ़ते हैं।
मैं समझाऊंगा कि लाइन की आवश्यकता क्यों है:

 uploaded_file.__dict__['_name'] = value 

तथ्य यह है कि अपलोड की गई फ़ाइलों के लिए बेस क्लास UploadedFile में नाम विशेषता के लिए एक सेटर है, जो केवल पथ से केवल फ़ाइल नाम को काट देता है और इसे self._name में संग्रहीत करता है , और गेट्टर इस मान को लौटाता है। अपने हाथों से चित्र के लिए रास्ता लिखना सबसे आसान तरीका है इसे फ़ॉर्म के लिए अपने विजेट में स्थानांतरित करना।

और केवल एक विधि बनी हुई है जो तुलना के लिए एक वस्तु लौटाती है। डेटाबेस से वर्तमान मूल्य के साथ अनुरोध से प्राप्त मूल्य की तुलना करते समय इस ऑब्जेक्ट की आवश्यकता होती है, ताकि फाइल को फिर से लिखना न हो। यहाँ सब कुछ सरल है:

 class ImageValue(Value): ... def to_python(self, value): return unicode(value) ... 

एक अंतिम स्पर्श है: आपका विजेट, जो मानक फ़ाइल अपलोड बटन के बगल में डेटाबेस से वर्तमान चित्र प्रदर्शित करेगा।

 class ImageValue(Value): ... class field(forms.ImageField): class widget(forms.FileInput): "Widget with preview" def __init__(self, attrs={}): forms.FileInput.__init__(self, attrs) def render(self, name, value, attrs=None): output = [] try: if not value: raise IOError('No value') Image.open(value.file) file_name = pjoin(settings.MEDIA_URL, value.name) output.append(u'<p><img src="{}" width="100" /></p>'.format(file_name)) except IOError: pass output.append(forms.FileInput.render(self, name, value, attrs)) return mark_safe(''.join(output)) ... 

हम अपना स्वयं का फ़ील्ड क्लास बनाते हैं, और उसमें - मानक FileInput से विरासत में मिला एक विजेट । हम रेंडर विधि को ओवरराइड करते हैं , जो हमारे इनपुट को प्रदर्शित करने के लिए जिम्मेदार है, जो संबंधित html को लौटाता है।

 Image.open(value.file) 

यह लाइन एक साथ दो आवश्यक जांच करती है: क्या निर्दिष्ट फ़ाइल मौजूद है और क्या यह एक छवि है, दोनों मामलों में यह एक IOError अपवाद को फेंक सकता है।
Mark_safe () फ़ंक्शन HTML आउटपुट के लिए एक पंक्ति को सुरक्षित करता है (इसके बिना, हमारे विजेट का कोड केवल पृष्ठ पर एक पंक्ति के रूप में प्रदर्शित किया जाएगा)।

अंतिम परिणाम इस तरह दिखता है:

संदर्भ

django-dbsettings on github.com

आपका ध्यान देने के लिए धन्यवाद।

पुनश्च

मैं इस परियोजना का समर्थन करना जारी रखना चाहता हूं, इसलिए यह बहुत अच्छा होगा यदि व्यवसाय में परीक्षण करने वाले लोग अपनी इच्छाओं को व्यक्त करें या बग के बारे में शिकायत करें।