الفرق بين المراجعتين لصفحة: «Python/tarfile/open»

من موسوعة حسوب
أنشأ الصفحة ب'<noinclude>{{DISPLAYTITLE:الدالة <code>tarfile‎.open()‎</code> في بايثون}}</noinclude> تعيد الدالة كائن TarFile للمسار المعطى...'
 
لا ملخص تعديل
سطر 1: سطر 1:
<noinclude>{{DISPLAYTITLE:الدالة <code>tarfile‎.open()‎</code> في بايثون}}</noinclude>
<noinclude>{{DISPLAYTITLE:الدالة <code>tarfile‎.open()‎</code> في بايثون}}</noinclude>
تعيد الدالة كائن TarFile للمسار المعطى. راجع قسم كائنات TarFile للاطلاع على المزيد من المعلومات حول هذه الكائنات والمعاملات المفتاحية المتاحة للاستخدام.
تفتح الدالة ملف tar المعطى وتعيد الدالة كائن <code>[[Python/TarFile|TarFile]]</code> للمسار المعطى. راجع قسم كائنات <code>[[Python/TarFile|TarFile]]</code> للاطلاع على المزيد من المعلومات حول هذه الكائنات والمعاملات المفتاحية المتاحة للاستخدام.


== البنية العامة ==
== البنية العامة ==
سطر 7: سطر 7:
tarfile.open(name=None, mode='r', fileobj=None, bufsize=10240, **kwargs)
tarfile.open(name=None, mode='r', fileobj=None, bufsize=10240, **kwargs)
</syntaxhighlight>
</syntaxhighlight>
== المعاملات ==
== المعاملات ==


سطر 14: سطر 13:
مسار ملف الأرشيف tar المراد فتحه.
مسار ملف الأرشيف tar المراد فتحه.


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


=== <code>mode</code> ===
=== <code>mode</code> ===
يجب أن يكون هذا المعامل سلسلة نصية بالصيغة ‎'filemode[:compression]'‎، ويأخذ القيمة الافتراضية 'r'. يعرض الجدول التالي قائمة كامل بالقيم المتاحة للاستخدام مع هذا المعامل:
يجب أن يكون هذا المعامل [[Python/str|سلسلة نصية]] بالصيغة ‎<code>'filemode[:compression]'</code>‎، ويأخذ القيمة الافتراضية <code>'r'</code>. يعرض الجدول التالي قائمة كامل بالقيم المتاحة للاستخدام مع هذا المعامل:


'''ملاحظة:''' في الإصدار 3.5 من بايثون أضيف الوضع <code>'x'</code> (الإنشاء الخاص exclusive creation).


'''ملاحظة:''' في الإصدار 3.5 من بايثون أضيف الوضع 'x' (الإنشاء الخاص exclusive creation).
لاحظ أنّه ليس بالإمكان استخدام <code>'a:gz'</code> أو <code>'a:bz2'</code> أو <code>'a:xz'</code>. إن كان الوضع <code>mode</code> غير مناسب لفتح ملف (مضغوط) معين للقراءة، تطلق الدالة الاستثناء <code>ReadError</code>، ويمكن تجنب ذلك باستخدام الوضع <code>'r'</code>. أما إذا كانت طريقة الضغط غير مدعومة، فستطلق الدالة الاستثناء <code>CompressionError</code>.
 
لاحظ أنّه ليس بالإمكان استخدام 'a:gz' أو 'a:bz2' أو 'a:xz'. إن كان الوضع mode غير مناسب لفتح ملف (مضغوط) معين للقراءة، تطلق الدالة الاستثناء ReadError، ويمكن تجنب ذلك باستخدام الوضع 'r'. أما إذا كانت طريقة الضغط غير مدعومة، فستطلق الدالة الاستثناء CompressionError.
 
 
 
 
هناك صيغة أخرى للمعامل mode وتستخدم لأغراض خاصة، وهذه الصيغة هي: ‎'filemode|[compression]'‎. ستعيد الدالة tarfile.open()‎ كائن TarFile يعالج بدوره بياناته كتدفق من الكتل stream of blocks، ولن تُجرى عمليات بحث عشوائية على الملف.
 


هناك صيغة أخرى للمعامل <code>mode</code> وتستخدم لأغراض خاصة، وهذه الصيغة هي: <code>‎'filemode|[compression]'‎</code>. ستعيد الدالة <code>tarfile.open()</code>‎ كائن <code>[[Python/TarFile|TarFile]]</code> يعالج بدوره بياناته كتدفق من الكتل stream of blocks، ولن تُجرى عمليات بحث عشوائية على الملف.
=== <code>fileobj</code> ===
=== <code>fileobj</code> ===


إن جرى تحديد قيمة للمعامل fileobj فإنها ستستخدم كبديل عن كائن الملف المفتوح في النمط الثنائي للمعامل name، ويفترض أن يكون في الموقع 0.
إن جرى تحديد قيمة للمعامل <code>fileobj</code> فإنها ستستخدم كبديل عن كائن الملف المفتوح في النمط الثنائي للمعامل <code>name</code>، ويفترض أن يكون في الموقع <code>0</code>.


يمكن أن يكون المعامل fileobj أي نوع من الكائنات التي تمتلك أحد التابعين read()‎ أو write()‎ (بالاعتماد على قيمة المعامل mode المستخدمة).
يمكن أن يكون المعامل <code>fileobj</code> أي نوع من الكائنات التي تمتلك أحد التابعين <code>read()‎</code> أو <code>write()‎</code> (بالاعتماد على قيمة المعامل <code>mode</code> المستخدمة).
=== <code>bufsize</code> ===
=== <code>bufsize</code> ===


 
يحدّد المعامل <code>bufsize</code> حجم الكتلة <code>blocksize</code> ويأخذ القيمة الافتراضية <code>‎20 *512‎</code> بايت. استخدم الصيغ المختلفة هذه مع <code>sys.stdin</code> مثلًا، أو مع كائن ملف منفذ socket file object أو مع مشغّل أشرطة tape device. ولكن تكون كائنات <code>[[Python/TarFile|TarFile]]</code> محدودة ولا تسمح بالوصول العشوائي. يوضّح الجدول التالي الأوضاع المتاحة في الوقت الحاضر:
يحدّد المعامل bufsize حجم الكتلة blocksize ويأخذ القيمة الافتراضية ‎20 *512‎ بايت. استخدم الصيغ المختلفة هذه مع sys.stdin مثلًا، أو مع كائن ملف منفذ socket file object أو مع مشغّل أشرطة tape device. ولكن تكون كائنات TarFile محدودة ولا تسمح بالوصول العشوائي (راجع الأمثلة). يوضّح الجدول التالي الأوضاع المتاحة في الوقت الحاضر:




=== معاملات مفتاحية ‎**kwargs ===
=== معاملات مفتاحية ‎**kwargs ===


عند استخدام الأوضاع 'w:gz'، 'r:gz'، 'w:bz2'، 'r:bz2'، 'x:gz'، 'x:bz2'، تستقبل الدالة tarfile.open()‎ المعامل المفتاحي compresslevel (قيمته الافتراضية 9) وذلك لتحديد مستوى الضغط للملف الحالي.
عند استخدام الأوضاع ‎<code>'w:gz'</code>، <code>'r:gz'</code>، <code>'w:bz2'</code>، <code>'r:bz2'</code>، <code>'x:gz'</code>، <code>'x:bz2'</code>‎، تستقبل الدالة <code>tarfile.open()</code>‎ المعامل المفتاحي <code>compresslevel</code> (قيمته الافتراضية <code>9</code>) وذلك لتحديد مستوى الضغط للملف الحالي.
 
ملاحظات:
 
 
== القيمة المعادة ==
== القيمة المعادة ==
تعيد الدالة كائن <code>[[Python/TarFile|TarFile]]</code> للمسار المعطى.


== أمثلة ==
== أمثلة ==

مراجعة 06:11، 13 نوفمبر 2018

تفتح الدالة ملف tar المعطى وتعيد الدالة كائن TarFile للمسار المعطى. راجع قسم كائنات TarFile للاطلاع على المزيد من المعلومات حول هذه الكائنات والمعاملات المفتاحية المتاحة للاستخدام.

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

tarfile.open(name=None, mode='r', fileobj=None, bufsize=10240, **kwargs)

المعاملات

name

مسار ملف الأرشيف tar المراد فتحه.

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

mode

يجب أن يكون هذا المعامل سلسلة نصية بالصيغة ‎'filemode[:compression]'‎، ويأخذ القيمة الافتراضية 'r'. يعرض الجدول التالي قائمة كامل بالقيم المتاحة للاستخدام مع هذا المعامل:

ملاحظة: في الإصدار 3.5 من بايثون أضيف الوضع 'x' (الإنشاء الخاص exclusive creation).

لاحظ أنّه ليس بالإمكان استخدام 'a:gz' أو 'a:bz2' أو 'a:xz'. إن كان الوضع mode غير مناسب لفتح ملف (مضغوط) معين للقراءة، تطلق الدالة الاستثناء ReadError، ويمكن تجنب ذلك باستخدام الوضع 'r'. أما إذا كانت طريقة الضغط غير مدعومة، فستطلق الدالة الاستثناء CompressionError.

هناك صيغة أخرى للمعامل mode وتستخدم لأغراض خاصة، وهذه الصيغة هي: ‎'filemode|[compression]'‎. ستعيد الدالة tarfile.open()‎ كائن TarFile يعالج بدوره بياناته كتدفق من الكتل stream of blocks، ولن تُجرى عمليات بحث عشوائية على الملف.

fileobj

إن جرى تحديد قيمة للمعامل fileobj فإنها ستستخدم كبديل عن كائن الملف المفتوح في النمط الثنائي للمعامل name، ويفترض أن يكون في الموقع 0.

يمكن أن يكون المعامل fileobj أي نوع من الكائنات التي تمتلك أحد التابعين read()‎ أو write()‎ (بالاعتماد على قيمة المعامل mode المستخدمة).

bufsize

يحدّد المعامل bufsize حجم الكتلة blocksize ويأخذ القيمة الافتراضية ‎20 *512‎ بايت. استخدم الصيغ المختلفة هذه مع sys.stdin مثلًا، أو مع كائن ملف منفذ socket file object أو مع مشغّل أشرطة tape device. ولكن تكون كائنات TarFile محدودة ولا تسمح بالوصول العشوائي. يوضّح الجدول التالي الأوضاع المتاحة في الوقت الحاضر:


معاملات مفتاحية ‎**kwargs

عند استخدام الأوضاع ‎'w:gz'، 'r:gz'، 'w:bz2'، 'r:bz2'، 'x:gz'، 'x:bz2'‎، تستقبل الدالة tarfile.open()‎ المعامل المفتاحي compresslevel (قيمته الافتراضية 9) وذلك لتحديد مستوى الضغط للملف الحالي.

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

تعيد الدالة كائن TarFile للمسار المعطى.

أمثلة

يبين المثال التالي طريقة استخراج جميع الملفات الموجودة في أرشيف tar إلى المجلّد الحالي:

import tarfile
tar = tarfile.open("sample.tar.gz")
tar.extractall()
tar.close()

مصادر

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