فوائد استخدام الحقول المطلوبة
هناك العديد من الفوائد لاستخدام الحقول المطلوبة في Pydantic.
- التأكد من اكتمال البيانات: تساعدنا الحقول المطلوبة على التأكد من أن نماذج البيانات لدينا كاملة وصالحة. يمكن أن يساعد هذا في منع حدوث أخطاء في التعليمات البرمجية ومعالجة البيانات.
- منع المدخلات الضارة: يمكن أيضًا استخدام الحقول المطلوبة لمنع المستخدمين الضارين من إدخال بيانات غير صالحة في نظامك.
- جعل التعليمات البرمجية أكثر قابلية للقراءة: يمكنك تحسين سهولة قراءة وفهم شفرتك باستخدام الحقول المطلوبة.
كيفية تحديد الحقول المطلوبة في Pydantic
في Pydantic، هناك ثلاث طرق لتحديد الحقل كحقل مطلوب. دعونا نستكشف كل واحد منهم بالتفصيل.
استخدام التعليقات التوضيحية
إن أبسط طريقة لتحديد الحقل المطلوب في Pydantic هي استخدام التعليقات التوضيحية. باستخدام التعليقات التوضيحية، وهي نوع من البيانات الوصفية النحوية، يمكنك إضافة المزيد من التفاصيل حول المتغيرات وسمات الفئات. في Pydantic، تُستخدم التعليقات التوضيحية للإشارة إلى نوع البيانات المتوقعة للحقل، وبشكل افتراضي، تعتبر جميع الحقول المشروحة مطلوبة حتى تجعل الحقل أو الحقول اختيارية.
من متحذلق يستورد نموذج القاعدة
فصل شخص ( نموذج القاعدة ) :
الاسم الكامل: شارع
ارتفاع: يطفو
بريد إلكتروني : شارع
في هذا المثال، الاسم الكامل والارتفاع والبريد الإلكتروني كلها حقول مطلوبة. إذا قمت بإنشاء مثيل لفئة الشخص دون توفير قيم لهذه الحقول، فسيقوم Pydantic برفع خطأ التحقق من الصحة مما يشير إلى أن الحقول المطلوبة مفقودة.
يحاول :
person_data = {
'ارتفاع' : 5.8 ,
}
شخص = شخص ( **person_data )
يستثني خطأ القيمة مثل إنها:
مطبعة ( إنها )
في هذا المثال، حقل الاسم الكامل مفقود، كما أن حقل الارتفاع مفقود أيضًا. كلا هذين الحقلين مطلوبان، ويوفر ValidationError معلومات واضحة حول الحقول المفقودة.
باستخدام علامات الحذف (...)
هناك طريقة أخرى للإعلان عن حقل كما هو مطلوب في Pydantic وهي استخدام علامة الحذف ( … ). هذا هو النهج الواضح الذي تقدمه Pydantic لتحديد الحقل كما هو مطلوب.
من متحذلق يستورد نموذج القاعدة
فصل منتج ( نموذج القاعدة ) :
اسم: شارع = ...
سعر : يطفو = ...
وصف : شارع = ...
في هذا المثال، يتم تعريف كل من اسم الحقول والسعر والوصف كما هو مطلوب باستخدام علامة الحذف. تجعل هذه الطريقة من الواضح والمرئي أنه لا يمكن تخطي حقول معينة عند إنشاء مثيل لفئة المنتج.
يحاول :بيانات المنتج = {
'اسم' : 'تليفون محمول' ,
'وصف' : 'هاتف ذكي مزود بذاكرة وصول عشوائي (RAM) سعة 16 جيجابايت' ,
}
منتج = منتج ( **بيانات المنتج )
يستثني خطأ القيمة مثل إنها:
مطبعة ( إنها )
في هذا المثال، حقل السعر مفقود، ويشير ValidationError بوضوح إلى الحقل المطلوب المفقود.
استخدام الدالة الميدانية
توفر الوظيفة الميدانية من وحدة Pydantic إمكانات إضافية لتخصيص التحقق من صحة الحقل والبيانات الوصفية. يمكنك استخدام وظيفة الحقل للإعلان عن الحقول المطلوبة وتطبيق قواعد التحقق الإضافية.
إليك كيفية تحديد الحقول المطلوبة باستخدام وظيفة الحقل:
من متحذلق يستورد نموذج القاعدة , مجالفصل عنوان ( نموذج القاعدة ) :
شارع: شارع = مجال ( ... , وصف = 'عنوان الشارع' )
مدينة: شارع = مجال ( ... )
الرمز البريدي: شارع = مجال ( ... )
في هذا المثال، نستخدم وظيفة الحقل لتحديد الحقول المطلوبة: الشارع، والمدينة، والرمز البريدي، بالإضافة إلى قواعد وأوصاف التحقق الإضافية. تشير علامة الحذف '...' إلى أنه يجب تعريف هذه الحقول كحقول مطلوبة.
يحاول :Address_data = {
'شارع' : '111 الشارع الرئيسي' ,
'الرمز البريدي' : '123456'
}
عنوان = عنوان ( **address_data )
يستثني خطأ القيمة مثل إنها:
مطبعة ( إنها )
في هذا المثال، حقل المدينة مفقود، ويوفر ValidationError معلومات حول الحقل المطلوب المفقود.
يمكن التحقق من صحة الحقول المطلوبة باستخدام ميزات Pydantic الأخرى، مثل القيود والأنواع. على سبيل المثال، يمكنك تحديد أن حقل الاسم يجب أن يتكون من سلسلة مكونة من 5 أحرف على الأقل. يمكنك استخدام مصمم الحقول لتخصيص سلوك الحقول المطلوبة. على سبيل المثال، يمكنك تحديد قيمة افتراضية للحقل أو رسالة ليتم عرضها إذا لم يتم إعطاء الحقل قيمة.
استخدام طرق متعددة لتحديد الحقول المطلوبة في نموذج Pydantic واحد
يمكنك استخدام طرق متعددة لتحديد الحقول المطلوبة ضمن نموذج Pydantic واحد. على سبيل المثال، يمكنك استخدام التعليقات التوضيحية لبعض الحقول وعلامات الحذف ( … ) للآخرين، والوظيفة الميدانية للتخصيص الإضافي. يتيح لك Pydantic اختيار أفضل نهج لتنظيم التعليمات البرمجية وتفضيلات سهولة القراءة. خذ بعين الاعتبار المثال التالي:
من متحذلقي يستورد نموذج القاعدة , مجالفصل موظف ( نموذج القاعدة ) :
اسم: شارع
قسم: شارع = …
مرتب: يطفو = مجال ( … )
في هذا المثال، جميع الحقول مطلوبة لاستخدامها. لقد استخدمنا ثلاث طرق مختلفة لتحديد الحقول المطلوبة. يستخدم حقل الاسم التعليق التوضيحي، ويستخدم القسم علامة القطع، ويستخدم الراتب وظيفة الحقل.
نصائح لاستخدام الحقول المطلوبة
يعد اتباع بعض الممارسات الجيدة عند تحديد الحقول المطلوبة في Pydantic أمرًا ضروريًا لإنشاء تعليمات برمجية سلسة وقابلة للصيانة. ستساعدك النصائح التالية في تحديد الحقول المطلوبة في Pydantic:
- استخدم أسماء الحقول الواضحة والوصفية : اختر أسماء ذات معنى لحقولك تشير بوضوح إلى الغرض منها. يساعد هذا المطورين الآخرين على معرفة البيانات المطلوبة ويقلل من فرص فقدان الحقول المطلوبة.
- تقديم أوصاف ميدانية إعلامية : عند استخدام وظيفة الحقل لتحديد الحقول المطلوبة، قم بتوفير أوصاف وصفية تشرح الغرض من البيانات وتنسيقها المتوقع.
- الحقول ذات الصلة بالمجموعة : إذا كان نموذج البيانات الخاص بك يحتوي على عدد كبير من الحقول، ففكر في تجميع الحقول ذات الصلة في بنيات متداخلة. يمكن أن يساعد ذلك في جعل التعليمات البرمجية الخاصة بك أكثر قابلية للقراءة ويجعل إدارة الحقول المطلوبة أسهل.
- استخدم الرسائل المخصصة للحقول المطلوبة: افتراضيًا، سيطلق Pydantic استثناء ValueError إذا لم يتم إعطاء قيمة للحقل المطلوب. يمكنك تخصيص رسالة الخطأ عن طريق تحديد وسيطة الرسالة لمصمم الحقل.
خاتمة
يقوم Pydantic افتراضيًا بإنشاء الحقول كما هو مطلوب. ومع ذلك، يمكنك تحديد الحقل بشكل صريح كحقول مطلوبة. من خلال الإعلان عن الحقول كما هو مطلوب، فإنك تضمن أن نماذج البيانات الخاصة بك دقيقة وكاملة ومتوافقة مع متطلباتك. في هذا المنشور، قمنا بتغطية ثلاث طرق متميزة لتحديد الحقول المطلوبة في Pydantic، أي التعليقات التوضيحية وعلامة الحذف (...) والدالة الميدانية. بالإضافة إلى ذلك، قمنا بمراجعة بعض الممارسات الموصى بها لاستخدام الحقول المطلوبة حتى تتمكن من تحديد الحقول بشكل فعال في نموذج البيانات الخاص بك.