عرض مصدر Python/re/escape

<noinclude>{{DISPLAYTITLE:الدالة <code>re.escape()‎</code> في بايثون‎}}</noinclude>
تهرّب الدالة جميع المحارف الخاصّة في التعبير النمطي المعطى باستثناء حروف الترميز ASCII، والأعداد والشرطة السفلية.

== البنية العامة ==
<syntaxhighlight lang="python3">
re.escape(pattern)
</syntaxhighlight>

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

التعبير النمطي الذي تهرّب الدالة محارفه الخاصة.

== القيمة المعادة ==
تعيد الدالة النمط الأصلي بعد تهريب جميع المحارف الخاصّة فيه باستثناء حروف الترميز ASCII، والأعداد والشرطة السفلية. هذه الدالة مفيدة عند الحاجة إلى مطابقة سلسلة نصية يحتمل أن تتضمن بعض الحروف الخاصّة بالتعابير النمطية.
== أمثلة ==
تبيّن الأمثلة التالية طرق استخدام الدالة <code>re.escape()‎</code>:

<syntaxhighlight lang="python3">
>>> print(re.escape('python.exe'))
python\.exe

>>> legal_chars = string.ascii_lowercase + string.digits + "!#$%&'*+-.^_`|~:"
>>> print('[%s]+' % re.escape(legal_chars))
[abcdefghijklmnopqrstuvwxyz0123456789\!\#\$\%\&\'\*\+\-\.\^_\`\|\~\:]+

>>> operators = ['+', '-', '*', '/', '**']
>>> print('|'.join(map(re.escape, sorted(operators, reverse=True))))
\/|\-|\+|\*\*|\*
</syntaxhighlight>

لا يجوز استخدام هذه الدالة كسلسلة استبدال في الدالتين <code>[[Python/re/sub|re.sub()‎]]</code> و <code>[[Python/re/subn|re.subn()‎]]</code>، ويجب تهريب الخطوط المائلة العكسية فقط. فمثلًا:

<syntaxhighlight lang="python3">
>>> digits_re = r'\d+'
>>> sample = '/usr/sbin/sendmail - 0 errors, 12 warnings'
>>> print(re.sub(digits_re, digits_re.replace('\\', r'\\'), sample))
/usr/sbin/sendmail - \d+ errors, \d+ warnings
</syntaxhighlight>

'''ملاحظة:''' لن تهرّب الشرطة السفلية <code>'_'</code> في الإصدار 3.3 من اللغة وما بعده.

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

[[تصنيف:Python]]
[[تصنيف:Python Function]]
[[تصنيف:Python Regular Expressions]]
[[تصنيف:Python re]]