عرض مصدر Python/TarFile/add

<noinclude>{{DISPLAYTITLE:التابع <code>TarFile.add()‎‎</code> في بايثون}}</noinclude>

يضيف التابع الملف المعطى إلى ملف الأرشيف.

== البنية العامة ==

<syntaxhighlight lang="python3">
TarFile.add(name, arcname=None, recursive=True, *, filter=None)
</syntaxhighlight>

== ‎المعاملات ==

=== <code>‎name</code> ===
يمكن لهذا المعامل أن يكون أي نوع من الملفات (مجلد، fifo، وصلة رمزية، الخ). 

=== <code>arcname</code> ===
يحدّد هذا المعامل اسمًا بديلًا للملف المضاف إلى الأرشيف.

=== <code>recursive</code> ===

تضاف المجلّدات بصورة تعاودية recursively افتراضيًا، ويمكن تجنّب ذلك بتعيين القيمة False للمعامل recursive. يؤدي التعاود Recursion إلى إضافة المدخلات بالترتيب.

'''ملاحظة:''' يؤدي التعاود Recursion إلى إضافة المدخلات بالترتيب في الإصدار 3.7 من بايثون.

=== <code>filter</code> ===

في حال تحديد قيمة لهذا المعامل فيجب أن تكون دالة تأخذ كائن <code>[[Python/TarInfo|TarInfo]]</code> كوسيط وتعيد كائن <code>[[Python/TarInfo|TarInfo]]</code> المعدّل. وإن أعادت الدالة القيمة <code>None</code> عوضًا عن ذلك، فإنّ كائن [[Python/TarInfo|TarInfo]] سيُستبعد من الأرشيف.

'''ملاحظة:''' أضيف المعامل <code>filter</code> في ا لإصدار 3.2 من بايثون.

== القيمة المعادة ==
يعيد التابع القيمة <code>None</code>.

== أمثلة ==

يبين المثال التالي آلية عمل التابع:

<syntaxhighlight lang="python3">
>>> import tarfile
>>> tar = tarfile.open('files.tar', 'w')
>>> tar.add('file4.css')

</syntaxhighlight>

== انظر أيضًا ==
* التابع <code>[[Python/TarFile/addfile|TarFile.addfile()‎]]</code>: يضيف التابع كائن <code>[[Python/TarInfo|TarInfo]]</code> المعطى إلى ملف الأرشيف.

== مصادر ==
[https://docs.python.org/3/library/tarfile.html#tarfile.TarFile.add صفحة Read and write tar archive files في توثيق بايثون الرسمي.]

[[تصنيف:Python]]
[[تصنيف:Python Modules]]
[[تصنيف:Python Methods]]