التابع ConfigParser.get()
في بايثون
يجلب التابع الخيار المحدّد من القسم المعطى.
البنية العامة
get(section, option, *, raw=False, vars=None[, fallback])
المعاملات
section
اسم القسم الذي سيجلب التابع الخيار منه.
option
قيمة الخيار المراد جلبه.
يبحث التابع عن قيمة المعامل option
في vars
(إن كان متوفّرًا) ثم في section
ثم في DEFAULTSECT
.
raw
يوسّع التابع جميع عمليات الاستيفاء التي تستخدم الرمز '%'
في القيمة المعادة إلا إذا كان إذا أخذ المعامل raw
القيمة True
.
vars
معامل اختياري، يجب أن تكون قيمته قاموسًا.
fallback
في حال عدم عثور التابع على المفتاح المطلوب فإنّه يستخدم قيمة المعامل fallback
كقيمة تراجعية في حال توفّرها. يمكن تقديم القيمة None
كقيمة تراجعية.
ملاحظة: تحوّلت المعاملات raw
و vars
و fallback
إلى معاملات مفتاحية وذلك لمنع المستخدم من محاول استخدام المعامل الثالث كقيمة تراجعية للمعامل fallback
(خاصة عند استعمال بروتوكول الربط mapping protocol).
القيمة المعادة
يعيد التابع القيمة التي يجلبها من ملف الإعدادات بعد تحويلها إلى سلسلة نصية.
أمثلة
يبين المثال التالي طريقة عمل التابع:
>>> import configparser
>>> config = configparser.ConfigParser()
>>> config.read('config.cfg')
['config.cfg']
>>> config.get('topsecret.server.com', 'Port')
'50022'
>>> config.get('topsecret.server.com', 'ForwardX11')
'no'
انظر أيضًا
- التابع
getint()
: تابع مساعد وظيفته تحويل الخيار المعطى في القسم المحدّد إلى عدد صحيح. - التابع
getfloat()
: تابع مساعد وظيفته تحويل الخيار المعطى في القسم المحدّد إلى عدد عشري ذي فاصلة عائمةfloat
. - التابع
getboolean()
: تابع مساعد وظيفته تحويل الخيار المعطى في القسم المحدّد إلى قيمة منطقية (بوليانية).