الفرق بين المراجعتين لصفحة: «Python/ConfigParser/get»
< Python | ConfigParser
أنشأ الصفحة ب'<noinclude>{{DISPLAYTITLE:التابع <code>ConfigParser.get()</code> في بايثون}}</noinclude> يجلب التابع الخيار المحدّد من ال...' |
لا ملخص تعديل |
||
| سطر 8: | سطر 8: | ||
get(section, option, *, raw=False, vars=None[, fallback]) | get(section, option, *, raw=False, vars=None[, fallback]) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
== | == المعاملات == | ||
=== section === | === <code>section</code> === | ||
اسم القسم الذي سيجلب التابع الخيار منه. | اسم القسم الذي سيجلب التابع الخيار منه. | ||
=== option === | === <code>option</code> === | ||
قيمة الخيار المراد جلبه. | قيمة الخيار المراد جلبه. | ||
يبحث التابع عن قيمة المعامل option في vars (إن كان متوفّرًا) ثم في section ثم في DEFAULTSECT. | |||
يبحث التابع عن قيمة المعامل <code>option</code> في <code>vars</code> (إن كان متوفّرًا) ثم في <code>section</code> ثم في <code>DEFAULTSECT</code>. | |||
=== raw === | === <code>raw</code> === | ||
يوسّع التابع جميع عمليات الاستيفاء التي تستخدم الرمز '%' في القيمة المعادة إلا إذا كان إذا أخذ المعامل raw القيمة True. | يوسّع التابع جميع عمليات الاستيفاء التي تستخدم الرمز <code>'%'</code> في القيمة المعادة إلا إذا كان إذا أخذ المعامل <code>raw</code> القيمة <code>True</code>. | ||
=== vars === | === <code>vars</code> === | ||
معامل اختياري، يجب أن تكون قيمته قاموسًا. | معامل اختياري، يجب أن تكون قيمته قاموسًا. | ||
=== fallback === | === <code>fallback</code> === | ||
في حال عدم عثور التابع على المفتاح المطلوب فإنّه يستخدم قيمة المعامل fallback كقيمة تراجعية في حال توفّرها. يمكن تقديم القيمة None كقيمة تراجعية. | في حال عدم عثور التابع على المفتاح المطلوب فإنّه يستخدم قيمة المعامل <code>fallback</code> كقيمة تراجعية في حال توفّرها. يمكن تقديم القيمة <code>None</code> كقيمة تراجعية. | ||
'''ملاحظة:''' تحوّلت المعاملات raw و vars و fallback إلى معاملات مفتاحية وذلك لمنع المستخدم من محاول استخدام المعامل الثالث كقيمة تراجعية للمعامل fallback (خاصة عند استعمال بروتوكول الربط mapping protocol). | '''ملاحظة:''' تحوّلت المعاملات <code>raw</code> و <code>vars</code> و <code>fallback</code> إلى معاملات مفتاحية وذلك لمنع المستخدم من محاول استخدام المعامل الثالث كقيمة تراجعية للمعامل <code>fallback</code> (خاصة عند استعمال بروتوكول الربط mapping protocol). | ||
== القيمة المعادة == | == القيمة المعادة == | ||
يعيد التابع القيمة التي يجلبها من ملف الإعدادات بعد تحويلها إلى [[Python/str|سلسلة نصية]]. | |||
== أمثلة == | == أمثلة == | ||
| سطر 35: | سطر 37: | ||
<syntaxhighlight lang="python3"> | <syntaxhighlight lang="python3"> | ||
>>> 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' | |||
</syntaxhighlight> | </syntaxhighlight> | ||
== انظر أيضًا == | == انظر أيضًا == | ||
* التابع <code>[[Python/ConfigParser/getint|getint()]]</code>: تابع مساعد وظيفته تحويل الخيار المعطى في القسم المحدّد إلى [[PHP|عدد صحيح]]. | |||
* التابع <code>[[Python/ConfigParser/getint|getint()]]</code>: تابع مساعد وظيفته تحويل الخيار المعطى في القسم المحدّد إلى عدد صحيح. | * التابع <code>[[Python/ConfigParser/getfloat|getfloat()]]</code>: تابع مساعد وظيفته تحويل الخيار المعطى في القسم المحدّد إلى عدد عشري ذي فاصلة عائمة [[PHP|<code>float</code>]]. | ||
* التابع <code>[[Python/ConfigParser/getfloat|getfloat()]]</code>: تابع مساعد وظيفته تحويل الخيار المعطى في القسم المحدّد إلى عدد عشري ذي فاصلة عائمة float. | * التابع <code>[[Python/ConfigParser/getboolean|getboolean()]]</code>: تابع مساعد وظيفته تحويل الخيار المعطى في القسم المحدّد إلى [[Python/boolean|قيمة منطقية]] (بوليانية). | ||
* التابع <code>[[Python/ConfigParser/getboolean|getboolean()]]</code>: تابع مساعد وظيفته تحويل الخيار المعطى في القسم المحدّد إلى قيمة منطقية (بوليانية). | |||
== مصادر == | == مصادر == | ||
* [https://docs.python.org/3/library/configparser.html#configparser.ConfigParser.get صفحة Configuration file parser في توثيق بايثون الرسمي.] | * [https://docs.python.org/3/library/configparser.html#configparser.ConfigParser.get صفحة Configuration file parser في توثيق بايثون الرسمي.] | ||
المراجعة الحالية بتاريخ 18:50، 30 نوفمبر 2018
يجلب التابع الخيار المحدّد من القسم المعطى.
البنية العامة
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(): تابع مساعد وظيفته تحويل الخيار المعطى في القسم المحدّد إلى قيمة منطقية (بوليانية).