مطلوبہ فیلڈز کے استعمال کے فوائد
Pydantic میں مطلوبہ فیلڈز استعمال کرنے کے کئی فوائد ہیں۔
- ڈیٹا کی تکمیل کو یقینی بنانا: مطلوبہ فیلڈز اس بات کو یقینی بنانے میں ہماری مدد کرتے ہیں کہ ہمارے ڈیٹا ماڈل مکمل اور درست ہیں۔ اس سے آپ کے کوڈ اور ڈیٹا پروسیسنگ میں خرابیوں کو روکنے میں مدد مل سکتی ہے۔
- بدنیتی پر مبنی ان پٹ کو روکنا: مطلوبہ فیلڈز کو نقصان دہ صارفین کو آپ کے سسٹم میں غلط ڈیٹا داخل کرنے سے روکنے کے لیے بھی استعمال کیا جا سکتا ہے۔
- کوڈ کو مزید پڑھنے کے قابل بنانا: آپ مطلوبہ فیلڈز کا استعمال کر کے پڑھنے کی اہلیت کے ساتھ ساتھ اپنے کوڈ کی سمجھ کو بھی بہتر بنا سکتے ہیں۔
پیڈینٹک میں مطلوبہ فیلڈز کی وضاحت کیسے کریں۔
Pydantic میں، ایک فیلڈ کو مطلوبہ فیلڈ کے طور پر بیان کرنے کے تین طریقے ہیں۔ آئیے ان میں سے ہر ایک کو تفصیل سے دیکھیں۔
تشریحات کا استعمال
Pydantic میں مطلوبہ فیلڈ کی وضاحت کرنے کا سب سے آسان طریقہ تشریحات کا استعمال کرنا ہے۔ تشریحات کا استعمال کرتے ہوئے، ایک قسم کا نحوی میٹا ڈیٹا، آپ متغیرات اور کلاسز کے اوصاف کے بارے میں مزید تفصیلات شامل کر سکتے ہیں۔ Pydantic میں، تشریحات کا استعمال کسی فیلڈ کے متوقع ڈیٹا کی قسم کی نشاندہی کرنے کے لیے کیا جاتا ہے، اور بطور ڈیفالٹ، تمام تشریح شدہ فیلڈز کو اس وقت تک ضروری سمجھا جاتا ہے جب تک کہ آپ کسی فیلڈ یا فیلڈز کو اختیاری نہیں بناتے ہیں۔
سے پیڈینٹک درآمد بیس ماڈل
کلاس شخص ( بیس ماڈل ) :
پورا نام: str
اونچائی: تیرنا
ای میل : str
اس مثال میں، full_name، height، اور email سبھی مطلوبہ فیلڈز ہیں۔ اگر آپ ان فیلڈز کے لیے قدریں فراہم کیے بغیر پرسن کلاس کی مثال بناتے ہیں، تو Pydantic ایک Validation Error اٹھائے گا جس سے ظاہر ہوتا ہے کہ مطلوبہ فیلڈز غائب ہیں۔
کوشش کریں :
شخص_ڈیٹا = {
'اونچائی' : 5.8 ,
}
شخص = شخص ( **شخص_ڈیٹا )
سوائے ویلیو ایرر کے طور پر یہ ہے:
پرنٹ کریں ( یہ ہے )
اس مثال میں، full_name فیلڈ غائب ہے، اور height فیلڈ بھی غائب ہے۔ یہ دونوں فیلڈز درکار ہیں، اور Validation Error گمشدہ فیلڈز کے بارے میں واضح معلومات فراہم کرتا ہے۔
Ellipsis کا استعمال کرتے ہوئے (…)
Pydantic میں ضرورت کے مطابق فیلڈ کا اعلان کرنے کا دوسرا طریقہ ellipsis ( … )۔ یہ ایک واضح نقطہ نظر ہے جو Pydantic کی طرف سے فراہم کیا گیا ہے، ضرورت کے مطابق فیلڈ کو نشان زد کرنے کے لیے۔
سے پیڈینٹک درآمد بیس ماڈل
کلاس پروڈکٹ ( بیس ماڈل ) :
نام: str = ...
قیمت : تیرنا = ...
تفصیل : str = ...
اس مثال میں، فیلڈز کا نام، قیمت، اور تفصیل سبھی کو بیضوی کا استعمال کرتے ہوئے ضرورت کے مطابق بیان کیا گیا ہے۔ یہ طریقہ اسے واضح اور مرئی بناتا ہے کہ پروڈکٹ کلاس کی مثال بناتے وقت مخصوص فیلڈز کو نہیں چھوڑا جا سکتا۔
کوشش کریں :پروڈکٹ_ڈیٹا = {
'نام' : 'موبائل فون' ,
'تفصیل' : '16 جی بی ریم والا سمارٹ فون' ,
}
مصنوعات = پروڈکٹ ( **پروڈکٹ_ڈیٹا )
سوائے ویلیو ایرر کے طور پر یہ ہے:
پرنٹ کریں ( یہ ہے )
اس مثال میں، قیمت کا فیلڈ غائب ہے، اور ValidationError واضح طور پر غائب مطلوبہ فیلڈ کی نشاندہی کرتا ہے۔
فیلڈ فنکشن کا استعمال
Pydantic ماڈیول سے فیلڈ فنکشن فیلڈ کی توثیق اور میٹا ڈیٹا کو حسب ضرورت بنانے کے لیے اضافی صلاحیتیں فراہم کرتا ہے۔ آپ مطلوبہ فیلڈز کا اعلان کرنے اور اضافی توثیق کے قواعد لاگو کرنے کے لیے فیلڈ فنکشن استعمال کر سکتے ہیں۔
یہاں یہ ہے کہ آپ فیلڈ فنکشن کا استعمال کرتے ہوئے مطلوبہ فیلڈز کی وضاحت کیسے کرسکتے ہیں:
سے پیڈینٹک درآمد بیس ماڈل , میدانکلاس پتہ ( بیس ماڈل ) :
گلی: str = میدان ( ... , تفصیل = 'گلی کا پتہ' )
شہر: str = میدان ( ... )
زپ کوڈ: str = میدان ( ... )
اس مثال میں، ہم اضافی توثیق کے اصولوں اور وضاحتوں کے ساتھ مطلوبہ فیلڈز گلی، شہر، اور زپ_کوڈ کی وضاحت کے لیے فیلڈ فنکشن کا استعمال کرتے ہیں۔ بیضوی '…' اشارہ کرتا ہے کہ ان فیلڈز کو مطلوبہ فیلڈز کے طور پر بیان کیا جانا چاہیے۔
کوشش کریں :ایڈریس_ڈیٹا = {
'گلی' : '111 مین اسٹریٹ' ,
'زپ کوڈ' : '123456'
}
پتہ = پتہ ( **ایڈریس_ڈیٹا )
سوائے ویلیو ایرر کے طور پر یہ ہے:
پرنٹ کریں ( یہ ہے )
اس مثال میں، سٹی فیلڈ غائب ہے، اور ValidationError غائب مطلوبہ فیلڈ کے بارے میں معلومات فراہم کرتا ہے۔
دیگر Pydantic خصوصیات، جیسے کہ رکاوٹیں اور اقسام کا استعمال کرتے ہوئے مطلوبہ فیلڈز کی توثیق کی جا سکتی ہے۔ مثال کے طور پر، آپ یہ بتا سکتے ہیں کہ نام کی فیلڈ میں کم از کم 5 حروف کی تار ہونی چاہیے۔ آپ مطلوبہ فیلڈز کے رویے کو اپنی مرضی کے مطابق کرنے کے لیے فیلڈ ڈیکوریٹر کا استعمال کر سکتے ہیں۔ مثال کے طور پر، آپ فیلڈ کے لیے ایک ڈیفالٹ ویلیو بتا سکتے ہیں یا اگر فیلڈ کو کوئی ویلیو نہیں دی گئی ہے تو ڈسپلے کیے جانے والے پیغام کو۔
سنگل پیڈینٹک ماڈل میں مطلوبہ فیلڈز کی وضاحت کرنے کے لیے متعدد طریقوں کا استعمال
آپ ایک Pydantic ماڈل کے اندر مطلوبہ فیلڈز کی وضاحت کے متعدد طریقے استعمال کر سکتے ہیں۔ مثال کے طور پر، آپ کچھ فیلڈز کے لیے تشریحات استعمال کر سکتے ہیں، ellipsis ( … ) دوسروں کے لیے، اور اضافی حسب ضرورت کے لیے فیلڈ فنکشن۔ Pydantic آپ کو اپنے کوڈ کی تنظیم اور پڑھنے کی اہلیت کی ترجیحات کے لیے بہترین طریقہ منتخب کرنے کی اجازت دیتا ہے۔ مندرجہ ذیل مثال پر غور کریں:
سے پیڈینٹک درآمد بیس ماڈل , میدانکلاس ملازم ( بیس ماڈل ) :
نام: str
شعبہ: str = …
تنخواہ: تیرنا = میدان ( … )
اس مثال میں، تمام فیلڈز کو استعمال کرنے کی ضرورت ہے۔ ہم نے مطلوبہ فیلڈز کی وضاحت کے لیے تین مختلف طریقے استعمال کیے ہیں۔ نام کا فیلڈ تشریح کا استعمال کرتا ہے، شعبہ بیضوی کا استعمال کرتا ہے، اور تنخواہ فیلڈ فنکشن کا استعمال کرتی ہے۔
مطلوبہ فیلڈز استعمال کرنے کے لیے نکات
Pydantic میں مطلوبہ فیلڈز کی وضاحت کرتے وقت کچھ اچھے طریقوں پر عمل کرنا ہموار اور برقرار رکھنے کے قابل کوڈ بنانے کے لیے ضروری ہے۔ مندرجہ ذیل تجاویز آپ کو Pydantic میں مطلوبہ فیلڈز کی وضاحت کرنے میں مدد کریں گی۔
- واضح اور وضاحتی فیلڈ کے نام استعمال کریں۔ : اپنے شعبوں کے لیے ایسے بامعنی ناموں کا انتخاب کریں جو واضح طور پر اپنے مقصد کی نشاندہی کریں۔ اس سے دوسرے ڈویلپرز کو یہ جاننے میں مدد ملتی ہے کہ کس ڈیٹا کی ضرورت ہے اور مطلوبہ فیلڈز کے غائب ہونے کے امکانات کم ہو جاتے ہیں۔
- معلوماتی فیلڈ کی تفصیلات فراہم کریں۔ : مطلوبہ فیلڈز کی وضاحت کے لیے فیلڈ فنکشن کا استعمال کرتے وقت، وضاحتی وضاحتیں فراہم کریں جو ڈیٹا کے مقصد اور متوقع فارمیٹ کی وضاحت کریں۔
- گروپ سے متعلقہ فیلڈز : اگر آپ کے ڈیٹا ماڈل میں فیلڈز کی ایک بڑی تعداد ہے تو، متعلقہ فیلڈز کو نیسٹڈ ڈھانچے میں گروپ کرنے پر غور کریں۔ اس سے آپ کے کوڈ کو مزید پڑھنے کے قابل بنانے اور مطلوبہ فیلڈز کا نظم و نسق آسان بنانے میں مدد مل سکتی ہے۔
- مطلوبہ فیلڈز کے لیے حسب ضرورت پیغامات استعمال کریں: پہلے سے طے شدہ طور پر، Pydantic ایک ValueError استثناء کو بڑھا دے گا اگر مطلوبہ فیلڈ کو قدر نہیں دی جاتی ہے۔ آپ فیلڈ ڈیکوریٹر کو میسج آرگیومنٹ بتا کر غلطی کے پیغام کو اپنی مرضی کے مطابق بنا سکتے ہیں۔
نتیجہ
Pydantic، بطور ڈیفالٹ، ضرورت کے مطابق فیلڈز بناتا ہے۔ تاہم، آپ واضح طور پر فیلڈ کو مطلوبہ فیلڈز کے طور پر بیان کر سکتے ہیں۔ فیلڈز کو ضرورت کے مطابق قرار دے کر، آپ اس بات کو یقینی بناتے ہیں کہ آپ کے ڈیٹا ماڈلز درست، مکمل اور آپ کی ضروریات کے مطابق ہیں۔ اس پوسٹ میں، ہم نے Pydantic میں مطلوبہ فیلڈز کی وضاحت کے لیے تین الگ الگ طریقوں کا احاطہ کیا، یعنی تشریحات، بیضوی (…)، اور فیلڈ فنکشن۔ مزید برآں، ہم نے مطلوبہ فیلڈز استعمال کرنے کے لیے کچھ تجویز کردہ طریقوں کو دیکھا تاکہ آپ اپنے ڈیٹا ماڈل میں فیلڈز کو مؤثر طریقے سے بیان کر سکیں۔