عرض مصدر Python/functools/wraps

<noinclude>{{DISPLAYTITLE:الدالة <code>functools.wraps()‎</code> في بايثون}}</noinclude>
تُستعمل الدّالة <code>functools.wraps()‎</code> كمُزخرف لاستعمال الدّالة <code>[[Python/functools/update wrapper|functools.update_wrapper()‎]]</code>  عند تعريف دالّة مُحيطة.

الدّالة مُكافئة للدالة الجزئية النّاتجة عن الاستدعاء التالي (انظر الدّالة <code>[[Python/functools/partial|functools.partial()]]‎</code>):
<syntaxhighlight lang="python3">
partial(update_wrapper, wrapped=wrapped, assigned=assigned, updated=updated)
</syntaxhighlight>

== البنية العامة ==
<syntaxhighlight lang="python3">
@functools.wraps(wrapped, assigned=WRAPPER_ASSIGNMENTS, updated=WRAPPER_UPDATES)
</syntaxhighlight>

== المعاملات ==
=== <code>wrapped</code> ===
الدّالة المُحاطة.

=== <code>assigned</code> ===
الخاصيّات التي ستُعيّن.

=== <code>updated</code> ===
الخاصيّات التي ستُحدّث.

== القيمة المعادة ==
تُحدّث دالّة مُحيطةً لتبدوَ مثل الدّالة المُحاطة.

== أمثلة ==
المثال التّالي يوضّح كيفيّة عمل هذه الدّالة:
<syntaxhighlight lang="python3">
>>> from functools import wraps
>>> def my_decorator(f):
...     @wraps(f)
...     def wrapper(*args, **kwds):
...         print('استدعاء الدالة الدّالة المُزخرَفة')
...         return f(*args, **kwds)
...     return wrapper
...
>>> @my_decorator
... def example():
...     """Docstring"""
...     print('مثال على دالّة مُزخرَفة')
...
>>> example()
استدعاء الدالة الدّالة المُزخرَفة
مثال على دالّة مُزخرَفة
>>> example.__name__ # اسم الدّالة
'example'
>>> example.__doc__ # سلسلة التوثيق النصية
'Docstring'
</syntaxhighlight>

لو لم نستعمل الدّالة <code>functools.wraps()‎</code> لكان اسم الدّالة هو <code>‎'wrapper'‎</code> عوضًا عن <code>‎'example'‎‎</code> ولفقدنا سلسلة التوثيق النصيّة.

== انظر أيضًا ==
* [[Python/documentation_strings|سلاسل التوثيق النصية في بايثون]].
* [[Python/defining-functions|تعريف الدوال في بايثون]].

== مصادر ==
* [https://docs.python.org/3/library/functools.html#functools.wraps قسم الدالة functools.wraps في توثيق Python الرسمي].
[[تصنيف:Python]]
[[تصنيف:Python Function]]
[[تصنيف:Python functools]]