عرض مصدر Python/string/Formatter/format

<noinclude>{{DISPLAYTITLE:التابع <code>Formatter.format()‎</code> في بايثون}}</noinclude>
هذا هو تابع الواجهة البرمجية العام، ويأخذ سلسلة تنسيق نصية وعددًا من المعاملات الموقعية والمفتاحية. ويعدّ تابع تغليف wrapper يستدعي التابع [[Python/string/Formatter/vformat|<code>vformat()‎</code>]].

== البنية العامة ==
<syntaxhighlight lang="python3">
format(format_string, *args, **kwargs)
</syntaxhighlight>

== المعاملات ==
=== <code>format_string</code> ===
سلسلة التنسيق النصية التي يعالجها التابع.

== القيمة المعادة ==
يعيد التابع سلسلة نصية هي نتيجة معالجة سلسلة التنسيق النصية المعطاة.

'''ملاحظة:''' أصبح تمرير سلسلة تنسيق نصية كمعامل <code>format_string</code> مفتاحي مهملًا في الإصدار 3.5 من اللغة.

== أمثلة ==

يبين المثال التالي طريقة استخدام التابع:

<syntaxhighlight lang="python3">
>>> import string
>>> formatter = string.Formatter()
>>> formatter.format("From {} to {}", 1, 5)
'From 1 to 5'
>>> coord = {'latitude': '37.24N', 'longitude': '-115.81W'}
>>> formatter.format('Coordinates: {latitude}, {longitude}', **coord)
'Coordinates: 37.24N, -115.81W'
</syntaxhighlight>

== انظر أيضًا ==
* الدالة <code>[[Python/string/Formatter/vformat|Formatter.vformat()‎]]</code> :  هذه الدالة هي المسؤولة الحقيقية عن جميع عمليات التنسيق، حيث تؤدي مهمّة تقسيم سلسلة التنسيق النصية إلى بيانات حرفية وحقول استبدال.
* [[Python/string/format string syntax|صيغة سلاسل التنسيق النصية في بايثون.]]

== مصادر ==

* [https://docs.python.org/3/library/string.html#string.Formatter.format قسم format في صفحة Custom string operations في توثيق بايثون الرسمي].
[[تصنيف:Python]]
[[تصنيف:Python Method]]
[[تصنيف:Python string]]
[[تصنيف:Python Formatter]]