الدالة help() في بايثون
< Python
اذهب إلى التنقل
اذهب إلى البحث
تُطلق الدّالة help() نظام المُساعدة المُضمّن، الذي يُستعمل في الوضع التّفاعلي للحصول على معلومات حول الكائنات والوحدات المبنيّة في اللغة.
البنية العامة
help([object])
المعاملات
object
مُعامل اختياريّ، وهو الكائن المراد الحصول على مُساعدة حوله.
القيمة المعادة
إن لم تُمرّر مُعاملات للدّالة، فسيُطلَق نظام المُساعدة التّفاعلي على المُفسّر. إن كان المُعامل سلسلة نصيّة، فسيُبحث عن القيمة على أنّها اسم وحدة، أو دالّة، أو صنف، أو كلمة مفتاحيّة، أو موضوع توثيق، وستُطبع صفحة مُساعدة (باللغة الانجليزيّة) على الشّاشة.
إن كان المُعامل أي نوع آخر من الكائنات، فستُولّد صفحة مُساعدة للكائن وستُعرض على الشّاشة.
أمثلة
المثال التّالي يوضّح كيفيّة عمل هذه الدّالة:
>>> help() # الوصول إلى صفحة المُساعدة التّفاعليّة
>>> help(int) # صفحة مُساعدة حول صنف الأعداد الصّحيحة
>>> help(str) # صفحة مُساعدة حول صنف السّلاسل النّصيّة
>>> help('json') # عرض صفحة مساعدة حول وحدةٍ قياسيّة
المثال الأخير له نفس تأثير كتابة json داخل المُساعد التّفاعليّ.
ملاحظات
أضيفت الدّالة إلى مجال الأسماء المُضمّن (built-in namespace) عبر الوحدة site.