عرض مصدر Python/lzma/open

<noinclude>{{DISPLAYTITLE:الدالة <code>bz2.open()‎</code> في بايثون}}</noinclude>

تفتح هذه الدالة ملفًّا مضغوطًا بخوارزمية LZMA في الوضع الثنائي أو النصي، وتعيد كائن ملف.

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

<syntaxhighlight lang="python3">
lzma.open(filename, mode="rb", *, format=None, check=-1, preset=None, filters=None, encoding=None, errors=None, newline=None)
</syntaxhighlight>

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

=== ‎<code>filename</code> ===
يمكن أن يكون اسم ملفٍّ موجود فعلًا ([[Python/str|سلسلة نصية]] أو [[Python/bytes|كائن <code>bytes</code>]] أو كائن شبيه بالمسار)، أو يمكن أن يكون كائن ملفٍّ موجود فعلًا يمكن القراءة منه والكتابة فيه.

=== <code>mode</code> ===

يمكن يأخذ المعامل <code>mode</code> إحدى القيم التالية: <code>‎'r'</code>، <code>'rb'</code>، <code>'w'</code>، <code>'wb'</code>، <code>'x'</code>، <code>'xb'</code>، <code>'a'</code>، <code>'ab'‎</code> للنمط الثنائي، والقيم ‎<code>'rt'</code>، <code>'wt'</code>، <code>'xt'</code>، <code>'at'‎</code> للنمط النصي، والقيمة الافتراضية لهذا المعامل هي <code>'rb'</code>.

عند فتح الملف للقراءة يؤدي المعاملان <code>format</code> و <code>filters</code> الوظيفة ذاتها في الدالة وفي كائن <code>LZMADecompressor</code>، ويجب عدم استخدام المعاملين <code>check</code> و <code>preset</code> عند استخدام الكائن.

عند فتح المف للكتابة، تؤدي المعاملات <code>format</code>، <code>check</code>، <code>preset</code>، <code>filters</code> الوظيفة ذاتها في كائن <code>LZMACompressor</code>.

تكافئ هذه الدالة -في النمط الثنائي- الدالة البانية للصنف LZMAFile:<syntaxhighlight lang="python3">
LZMAFile(filename, mode, ...)
</syntaxhighlight>وفي هذه الحالة يجب عدم تزويد الدالة بالمعاملات <code>encoding</code> و <code>errors</code> و <code>newline</code>.

أما في النمط النصي، فيجري إنشاء الكائن <code>LZMAFile</code> وتغليفه بنسخة من الصنف <code>io.TextIOWrapper</code> مع المعاملات المحدّدة للترميز، والتعامل مع الأخطاء ونهايات الأسطر.

'''ملاحظات:'''
* أضيف دعم الأوضاع <code>'x'</code> و <code>'xb'</code> و <code>'xt'</code> في الإصدار 3.4 من بايثون.
* أصبح بالإمكان استخدام الكائنات الشبيهة بالمسارات path-like objects في الإصدار 3.6 من بايثون.

== القيمة المعادة ==
تعيد الدالة كائن ملف.

== أمثلة ==

يبين المثال التالي طريقة قراءة ملف مضغوط:

<syntaxhighlight lang="python3">
import lzma
with lzma.open("file.xz") as f:
    file_content = f.read()

</syntaxhighlight>

يبين المثال التالي طريقة إنشاء ملف مضغوط: 

<syntaxhighlight lang="python3">
import lzma
data = b"Insert Data Here"
with lzma.open("file.xz", "w") as f:
    f.write(data)

</syntaxhighlight>
== مصادر ==
* [https://docs.python.org/3/library/bz2.html#lzma.open صفحة Compression using the LZMA algorithm في توثيق بايثون الرسمي.]
[[تصنيف:Python]]
[[تصنيف:Python Modules]]