برمجة

repr=False لا يستبعد الحقل من dataclasses.asdict

فريق فايندو جروب2 دقائق قراءة0 مشاهدة0 تعليقات
مشاركة:
محرر Python يقارن تمثيل سجل مختصر باستجابة JSON تحتوي حقل ملاحظة داخلية، وبجانبها استجابة عامة بحقل واحد.

يخفي المطور حقل الملاحظة الداخلية من تمثيل كائن Python باستخدام repr=False، ثم يحول الكائن إلى قاموس ويرسله إلى الواجهة. قد يظهر الحقل في الاستجابة رغم غيابه من الطباعة المختصرة. عند إعداد استجابات API، يجب فحص مفاتيح البيانات المرسلة فعلًا، وعدم الاكتفاء بما يظهر في repr.

ابنِ سجلًا مصطنعًا

نستخدم في عينة تعليمية اسم حساب Demo وملاحظة inside-only. لا تحتوي العينة بيانات مستخدمين حقيقية. ننشئ فئة بيانات فيها الحقل الداخلي مستبعدًا من repr، ثم نقارن التمثيل والقاموس الناتج.

from dataclasses import make_dataclass, field, asdict
Account = make_dataclass(
'Account',
[('name', str), ('internal_note', str, field(repr=False))]
)
account = Account('Demo', 'inside-only')
print(repr(account))
print(asdict(account))
public_data = {'name': account.name}
assert set(public_data) == {'name'}

قارن ما يراه السجل وما تستقبله الواجهة

يعرض repr الاسم دون الملاحظة. بينما يحتوي asdict على name وinternal_note، لأن تحويل حقول dataclass إلى قاموس له وظيفة مختلفة عن إعداد تمثيل الكائن. الإعداد repr=False يتعلق بالتمثيل الذي تولده الفئة، ولا يعرّف سياسة تصدير عامة.

راجع نقطة بناء الاستجابة في النظام الفعلي. قد لا تكون المشكلة في dataclass نفسها، بل في تمرير كل حقولها مباشرة إلى JSON. حدد قائمة البيانات المسموح بها عند حدود الاستجابة، ثم اختبر المفاتيح والقيم الناتجة لنوع المستخدم الذي يطلبها.

راجع الكائنات المتداخلة أيضًا

تتعامل asdict بصورة متكررة مع فئات البيانات والحاويات المتداخلة. إذا وضعت سجلًا داخليًا في قائمة داخل كائن آخر، فقد تنتقل حقوله كذلك إلى الناتج. جهّز عينة تحتوي كائنًا متداخلًا، ثم تحقق من حدود كل جزء مطلوب في الاستجابة العامة.

إزالة internal_note بعد التحويل قد تعالج العينة الصغيرة، لكن إضافة حقل داخلي جديد في المستقبل تستحق اختبارًا. قائمة مفاتيح الاستجابة المتوقعة تساعد الفريق على ملاحظة تغير العقد بدل اكتشاف الحقل من واجهة العميل بعد النشر. راجع أيضًا مسارات التصدير والتنزيل التي تستخدم نفس الكائن.

ضع اختبارات على حدود الإرسال

  • اختبر repr منفصلًا عن asdict.
  • راجع القاموس قبل تحويله إلى JSON.
  • اختبر الحقول داخل القوائم والكائنات المتداخلة.
  • أضف حقلًا داخليًا إلى عينة الاختبار وتحقق من قائمة الاستجابة.
  • نفذ حالات الصلاحيات من واجهة API الفعلية عند دمج المكون.

لا يعني استخدام قائمة مفاتيح في المثال اكتمال نظام الصلاحيات؛ المطلوب أن يرتبط بناء الاستجابة بسياسة النظام التي تُختبر عند الطلب. احتفظ بعينة مصطنعة لكل دور، وافحص البيانات التي تصل إليه بعد أي تعديل على نموذج البيانات.

تفيد هذه المراجعة في سجلات CRM وأثناء تصميم عقود API التي تفصل معلومات العرض عن بيانات التشغيل الداخلية.

مراجع التنفيذ

التصنيفات:برمجة
شارك:

التعليقات

لا توجد تعليقات بعد

أضف تعليقك

كن أول من يعلق على هذا المقال

02 · تابع القراءة

مقالات ذات صلة