عرض مصدر Python/regex/match

<noinclude>{{DISPLAYTITLE:التابع <code>regex.match()‎</code> في بايثون‎}}</noinclude>
يفحص هذا التابع بداية السلسلة النصية المعطاة بحثًا عن حالة تطابق مع التعبير النمطي المصرّف، ويعيد كائن التطابق المقابل.

== البنية العامة ==
<syntaxhighlight lang="python3">
regex.match(string[, pos[, endpos]])
</syntaxhighlight>

== المعاملات ==
<code>string</code>

السلسلة النصية التي ستبحث فيها الدالة عن حالات التطابق.

<code>pos</code>

يحدّد هذا المعامل الاختياري الموقع الذي يبدأ منه التابع البحث في السلسلة النصية، ويأخذ القيمة الافتراضية <code>0</code>. إن تحديد موقع بدء عملية البحث ليس مطابقًا تمامًا لعملية تقطيع السلسلة النصية، فالمحرف <code>'^'</code> يطابق في بداية السلسلة النصية وفي المواقع التي تأتي بعد محرف السطر الجديد، ولكن ليس بالضرورة في الموقع الذي يبدأ التابع منه عملية البحث. 

<code>endpos</code>

يحدّد هذا المعامل الاختياري الموقع الذي ينتهي عنده التابع من البحث في السلسة النصية، وهذا يعني أنّ عملية البحث عن التطابقات ستجري على المحارف التي تقع ضمن النطاق الذي يبدأ بالموقع <code>pos</code> وينتهي بالموقع <code>endpos - 1</code>. إن كانت قيمة <code>endpos</code> أقل من قيمة <code>pos</code> فلن يكون هناك أي حالة تطابق، وفيما عدا ذلك من الحالات، إن كان <code>rx</code> كائن تعبير نمطي مصرّف، فإنّ الدالة <code>rx.search(string, 0, 50)</code>‎ تكافئ الدالة <code>rx.search(string[:50], 0)‎</code>.

== القيمة المعادة ==
يعيد التابع كائن <code>match</code> المقابل إن عثر على صفر أو أكثر من المحارف في بداية السلسلة النصية تطابق التعبير النمطي المعطى، ويعيد القيمة <code>None</code> إن لم تتطابق السلسلة النصية مع التعبير النمطي، ويجب الانتباه إلى أنّ هذه الحالة تختلف عن الحالة التي يجد التابع فيها تطابقًا طوله <code>0</code>.

== ملاحظة ==

إن كان المطلوب العثور على حالات التطابق في أي مكان ضمن السلسلة النصية، استخدم التابع <code>[[Python/regex/search|regex.search()‎]]</code> عوضًا عن هذا التابع. (انظر أيضًا الفرق بين <code>search()‎</code> و <code>match()</code>‎).

== أمثلة ==
في المثال التالي لا وجود لحالة تطابق عند تطبيق التابع <code>match()‎</code> دون استخدام المعاملات الأخرى؛ وذلك لأنّ الحرف <code>"o"</code> لم يرد في بداية الكلمة <code>"dog"</code>. ولكن عند تمرير القيمة <code>1</code> للمعامل <code>pos</code> تظهر حالة تطابق لأنّ الحرف <code>"o"</code> هو الحرف الثاني في الكلمة.

<syntaxhighlight lang="python3">
>>> pattern = re.compile("o")
>>> pattern.match("dog")
>>> pattern.match("dog", 1)
<_sre.SRE_Match object; span=(1, 2), match='o'>
</syntaxhighlight>

== انظر أيضًا ==
* الدالة <code>[[Python/re/search|re.match()]]‎</code> في بايثون.

== مصادر ==
* [https://docs.python.org/3/library/re.html#re.regex.match قسم Module Contents في صفحة Regular Expression Objects في توثيق بايثون الرسمي.]
[[تصنيف:Python]]
[[تصنيف:Python Regular Expressions]]