التابع TarFile.add()‎‎ في بايثون

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

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

TarFile.add(name, arcname=None, recursive=True, *, filter=None)

‎المعاملات

‎name

يمكن لهذا المعامل أن يكون أي نوع من الملفات (مجلد، fifo، وصلة رمزية، الخ).

arcname

يحدّد هذا المعامل اسمًا بديلًا للملف المضاف إلى الأرشيف.

recursive

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

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

filter

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

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

القيمة المعادة

يعيد التابع القيمة None.

أمثلة

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

>>> import tarfile
>>> tar = tarfile.open('files.tar', 'w')
>>> tar.add('file4.css')

انظر أيضًا

• التابع TarFile.addfile()‎: يضيف التابع كائن TarInfo المعطى إلى ملف الأرشيف.

مصادر

صفحة Read and write tar archive files في توثيق بايثون الرسمي.