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

ينشئ التابع كائن TarInfo من نتيجة استدعاء الدالة os.stat()‎ أو ما يكافئها على ملف موجود فعلًا.

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

TarFile.gettarinfo(name=None, arcname=None, fileobj=None)

المعاملات

‎name

يمكن تسمية الملف عن طريق تمرير الاسم في المعامل name أو باستخدام كائن fileobj مع واصف للملف. ويمكن للمعامل name أن يكون كائنًا شبيهًا بالمسارات.

arcname

معامل اختياري يعيّن اسمًا بديلًا للملف في الأرشيف، وفي حال عدم تحديد قيمة لهذا المعامل يأخذ الملف اسمه من خاصية name في كائن الملف fileobj، أو من المعامل name. يجدر التنبيه إلى وجوب أن يكون الاسم سلسلة نصية.

يمكن تعديل بعض الخصائص في كائنات TarInfo قبل إضافته باستخدامه التابع addfile. إن لم يكن كائن الملف عاديًّا وموجودًا في بداية الملف، فإنّ بعض الخصائص مثل size قد تحتاج إلى تعديل، وهذه هي الحال مع كائنات مثل GzipFile. كذلك يمكن تعديل الاسم وفي هذه الحال يجب أن يكون المعامل arcname سلسلة نصية وهمية.

ملاحظة: أصبح بالإمكان استخدام كائنات شبيهة بالمسارات path-like objects مع المعامل name في الإصدار 3.6 من بايثون.

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

يعيد التابع كائن TarInfo.

أمثلة

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

>>> import tarfile
>>> tar = tarfile.open('files.tar', 'w')
>>> tar_info = tar.gettarinfo('file5.js')

مصادر

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