आवश्यक फ़ील्ड का उपयोग करने के लाभ
पाइडेंटिक में आवश्यक फ़ील्ड का उपयोग करने के कई लाभ हैं।
- डेटा पूर्णता सुनिश्चित करना: आवश्यक फ़ील्ड हमें यह सुनिश्चित करने में मदद करते हैं कि हमारे डेटा मॉडल पूर्ण और वैध हैं। यह आपके कोड और डेटा प्रोसेसिंग में त्रुटियों को रोकने में मदद कर सकता है।
- दुर्भावनापूर्ण इनपुट को रोकना: आवश्यक फ़ील्ड का उपयोग दुर्भावनापूर्ण उपयोगकर्ताओं को आपके सिस्टम में अमान्य डेटा डालने से रोकने के लिए भी किया जा सकता है।
- कोड को अधिक पठनीय बनाना: आप आवश्यक फ़ील्ड का उपयोग करके अपने कोड की पठनीयता के साथ-साथ उसकी समझ में भी सुधार कर सकते हैं।
पाइडेंटिक में आवश्यक फ़ील्ड्स को कैसे परिभाषित करें
पाइडेंटिक में, किसी फ़ील्ड को आवश्यक फ़ील्ड के रूप में परिभाषित करने की तीन विधियाँ हैं। आइए उनमें से प्रत्येक के बारे में विस्तार से जानें।
एनोटेशन का उपयोग करना
पाइडेंटिक में आवश्यक फ़ील्ड को परिभाषित करने का सबसे सरल तरीका एनोटेशन का उपयोग करना है। एनोटेशन, एक प्रकार का वाक्यात्मक मेटाडेटा, का उपयोग करके, आप कक्षाओं के चर और विशेषताओं के बारे में अधिक विवरण जोड़ सकते हैं। पाइडेंटिक में, एनोटेशन का उपयोग किसी फ़ील्ड के अपेक्षित डेटा प्रकार को इंगित करने के लिए किया जाता है, और डिफ़ॉल्ट रूप से, सभी एनोटेटेड फ़ील्ड को तब तक आवश्यक माना जाता है जब तक आप किसी फ़ील्ड या फ़ील्ड को वैकल्पिक नहीं बनाते।
से pydantic आयात बेसमॉडल
कक्षा व्यक्ति ( बेसमॉडल ) :
पूरा नाम: एसटीआर
ऊंचाई: तैरना
ईमेल : एसटीआर
इस उदाहरण में, पूरा नाम, ऊंचाई और ईमेल सभी आवश्यक फ़ील्ड हैं। यदि आप इन क्षेत्रों के लिए मान प्रदान किए बिना व्यक्ति वर्ग का एक उदाहरण बनाते हैं, तो पाइडेंटिक एक वैलिडेशन एरर उठाएगा जो दर्शाता है कि आवश्यक फ़ील्ड गायब हैं।
कोशिश :
व्यक्ति_डेटा = {
'ऊंचाई' : 5.8 ,
}
व्यक्ति = व्यक्ति ( **व्यक्ति_डेटा )
के अलावा मूल्य त्रुटि जैसा यह है:
छपाई ( यह है )
इस उदाहरण में, पूर्ण_नाम फ़ील्ड गायब है, और ऊंचाई फ़ील्ड भी गायब है। ये दोनों फ़ील्ड आवश्यक हैं, और ValidationError गुम फ़ील्ड के बारे में स्पष्ट जानकारी प्रदान करता है।
इलिप्सिस का उपयोग करना (...)
पाइडेंटिक में आवश्यक फ़ील्ड को घोषित करने का दूसरा तरीका इलिप्सिस का उपयोग करना है ( … ). किसी फ़ील्ड को आवश्यकतानुसार चिह्नित करने के लिए, यह पाइडेंटिक द्वारा प्रदान किया गया एक स्पष्ट दृष्टिकोण है।
से pydantic आयात बेसमॉडल
कक्षा उत्पाद ( बेसमॉडल ) :
नाम: एसटीआर = ...
कीमत : तैरना = ...
विवरण : एसटीआर = ...
इस उदाहरण में, फ़ील्ड का नाम, मूल्य और विवरण सभी को एलिप्सिस का उपयोग करके आवश्यकतानुसार परिभाषित किया गया है। यह विधि यह स्पष्ट और दृश्यमान बनाती है कि उत्पाद वर्ग का उदाहरण बनाते समय विशेष फ़ील्ड को छोड़ा नहीं जा सकता है।
कोशिश :उत्पाद तथ्य = {
'नाम' : 'चल दूरभाष' ,
'विवरण' : '16जीबी रैम वाला स्मार्ट फोन' ,
}
उत्पाद = उत्पाद ( **उत्पाद तथ्य )
के अलावा मूल्य त्रुटि जैसा यह है:
छपाई ( यह है )
इस उदाहरण में, मूल्य फ़ील्ड गायब है, और ValidationError स्पष्ट रूप से लापता आवश्यक फ़ील्ड को इंगित करता है।
फ़ील्ड फ़ंक्शन का उपयोग करना
पाइडेंटिक मॉड्यूल से फ़ील्ड फ़ंक्शन फ़ील्ड सत्यापन और मेटाडेटा को अनुकूलित करने के लिए अतिरिक्त क्षमताएं प्रदान करता है। आप आवश्यक फ़ील्ड घोषित करने और अतिरिक्त सत्यापन नियम लागू करने के लिए फ़ील्ड फ़ंक्शन का उपयोग कर सकते हैं।
यहां बताया गया है कि आप फ़ील्ड फ़ंक्शन का उपयोग करके आवश्यक फ़ील्ड को कैसे परिभाषित कर सकते हैं:
से pydantic आयात बेसमॉडल , मैदानकक्षा पता ( बेसमॉडल ) :
गली: एसटीआर = मैदान ( ... , विवरण = 'गली का पता' )
शहर: एसटीआर = मैदान ( ... )
ज़िप कोड: एसटीआर = मैदान ( ... )
इस उदाहरण में, हम अतिरिक्त सत्यापन नियमों और विवरणों के साथ आवश्यक फ़ील्ड स्ट्रीट, शहर और ज़िप_कोड को परिभाषित करने के लिए फ़ील्ड फ़ंक्शन का उपयोग करते हैं। दीर्घवृत्त '...' इंगित करता है कि इन फ़ील्ड को आवश्यक फ़ील्ड के रूप में परिभाषित किया जाना चाहिए।
कोशिश :पता_डेटा = {
'गली' : '111 मुख्य सड़क' ,
'ज़िप कोड' : '123456'
}
पता = पता ( **पता_डेटा )
के अलावा मूल्य त्रुटि जैसा यह है:
छपाई ( यह है )
इस उदाहरण में, शहर फ़ील्ड गायब है, और ValidationError लापता आवश्यक फ़ील्ड के बारे में जानकारी प्रदान करता है।
आवश्यक फ़ील्ड को अन्य पाइडेंटिक सुविधाओं, जैसे बाधाओं और प्रकारों का उपयोग करके मान्य किया जा सकता है। उदाहरण के लिए, आप यह निर्दिष्ट कर सकते हैं कि नाम फ़ील्ड में कम से कम 5 वर्णों की एक स्ट्रिंग होनी चाहिए। आप आवश्यक फ़ील्ड के व्यवहार को अनुकूलित करने के लिए फ़ील्ड डेकोरेटर का उपयोग कर सकते हैं। उदाहरण के लिए, आप फ़ील्ड के लिए एक डिफ़ॉल्ट मान निर्दिष्ट कर सकते हैं या यदि फ़ील्ड को कोई मान नहीं दिया गया है तो प्रदर्शित होने वाला संदेश निर्दिष्ट कर सकते हैं।
एकल पाइडेंटिक मॉडल में आवश्यक फ़ील्ड को परिभाषित करने के लिए एकाधिक विधियों का उपयोग करना
आप एक ही पाइडेंटिक मॉडल के भीतर आवश्यक फ़ील्ड को परिभाषित करने के लिए कई तरीकों का उपयोग कर सकते हैं। उदाहरण के लिए, आप कुछ फ़ील्ड के लिए एनोटेशन का उपयोग कर सकते हैं, इलिप्सिस ( … ) दूसरों के लिए, और अतिरिक्त अनुकूलन के लिए फ़ील्ड फ़ंक्शन। पाइडेंटिक आपको अपने कोड संगठन और पठनीयता प्राथमिकताओं के लिए सर्वोत्तम दृष्टिकोण चुनने की अनुमति देता है। निम्नलिखित उदाहरण पर विचार करें:
से pydantic आयात बेसमॉडल , मैदानकक्षा कर्मचारी ( बेसमॉडल ) :
नाम: एसटीआर
विभाग: एसटीआर = …
वेतन: तैरना = मैदान ( … )
इस उदाहरण में, सभी फ़ील्ड का उपयोग करना आवश्यक है। हमने आवश्यक फ़ील्ड को परिभाषित करने के लिए तीन अलग-अलग तरीकों का उपयोग किया है। नाम फ़ील्ड एनोटेशन का उपयोग करता है, विभाग इलिप्सिस का उपयोग करता है, और वेतन फ़ील्ड फ़ंक्शन का उपयोग करता है।
आवश्यक फ़ील्ड का उपयोग करने के लिए युक्तियाँ
पाइडेंटिक में आवश्यक फ़ील्ड को परिभाषित करते समय कुछ अच्छी प्रथाओं का पालन करना सुचारू और रखरखाव योग्य कोड बनाने के लिए आवश्यक है। निम्नलिखित युक्तियाँ आपको पाइडेंटिक में आवश्यक फ़ील्ड को परिभाषित करने में मदद करेंगी:
- स्पष्ट और वर्णनात्मक फ़ील्ड नामों का उपयोग करें : अपने क्षेत्रों के लिए सार्थक नाम चुनें जो उनके उद्देश्य को स्पष्ट रूप से दर्शाते हों। इससे अन्य डेवलपर्स को यह जानने में मदद मिलती है कि किस डेटा की आवश्यकता है और आवश्यक फ़ील्ड गुम होने की संभावना कम हो जाती है।
- जानकारीपूर्ण फ़ील्ड विवरण प्रदान करें : आवश्यक फ़ील्ड को परिभाषित करने के लिए फ़ील्ड फ़ंक्शन का उपयोग करते समय, वर्णनात्मक विवरण प्रदान करें जो डेटा के उद्देश्य और अपेक्षित प्रारूप को समझाते हैं।
- समूह संबंधित क्षेत्र : यदि आपके डेटा मॉडल में बड़ी संख्या में फ़ील्ड हैं, तो संबंधित फ़ील्ड को नेस्टेड संरचनाओं में समूहीकृत करने पर विचार करें। यह आपके कोड को अधिक पठनीय बनाने में मदद कर सकता है और आवश्यक फ़ील्ड को प्रबंधित करना आसान बना सकता है।
- आवश्यक फ़ील्ड के लिए कस्टम संदेशों का उपयोग करें: डिफ़ॉल्ट रूप से, यदि आवश्यक फ़ील्ड को कोई मान नहीं दिया गया है, तो पाइडेंटिक एक वैल्यूएरर अपवाद उठाएगा। आप फ़ील्ड डेकोरेटर को संदेश तर्क निर्दिष्ट करके त्रुटि संदेश को अनुकूलित कर सकते हैं।
निष्कर्ष
पाइडेंटिक, डिफ़ॉल्ट रूप से, आवश्यकतानुसार फ़ील्ड बनाता है। हालाँकि, आप फ़ील्ड को आवश्यक फ़ील्ड के रूप में स्पष्ट रूप से परिभाषित कर सकते हैं। फ़ील्ड को आवश्यकतानुसार घोषित करके, आप सुनिश्चित करते हैं कि आपके डेटा मॉडल सटीक, पूर्ण और आपकी आवश्यकताओं के अनुरूप हैं। इस पोस्ट में, हमने पाइडेंटिक में आवश्यक फ़ील्ड को परिभाषित करने के लिए तीन अलग-अलग तरीकों को शामिल किया है, यानी, एनोटेशन, इलिप्सिस (...), और फ़ील्ड फ़ंक्शन। इसके अतिरिक्त, हमने आवश्यक फ़ील्ड का उपयोग करने के लिए कुछ अनुशंसित प्रथाओं पर ध्यान दिया ताकि आप अपने डेटा मॉडल में फ़ील्ड को प्रभावी ढंग से निर्दिष्ट कर सकें।