عرض مصدر Python/BZ2Decompressor/decompress

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

يفكّ التابع الضغط عن البيانات المعطاة (كائن شبيه بالبايتات bytes-like) ويعيد البيانات الناتجة عن عملية فك الضغط على هيئة بايتات.

==البنية العامة==
<syntaxhighlight lang="python3">
decompress(data, max_length=-1)
</syntaxhighlight>

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

===<code>data</code>===
البيانات المراد فك ضغطها.

===<code>max_length</code>===

ن كانت قيمة المعامل <code>max_length</code> عددًا لا يحمل الإشارة السالبة فإنّ التابع سيعيد على الأكثر العدد المحدّد في هذا المعامل من البايتات من البيانات التي جرى فك الضغط عنها.

إن وصل التابع إلى القيمة المحدّدة في هذا المعامل وكان هناك المزيد من المخرجات التي يمكن إنتاجها، تُسند القيمة <code>False</code> إلى الخاصية <code>[[Python/BZ2Decompressor#needs input|needs_input]]</code>. وفي هذه الحالة، يمكن أن يقدّم الاستدعاء اللاحق للدالة [[Python/bz2/decompress|<code>decompress()‎</code>]] البيانات على هيئة <code><nowiki>''</nowiki>b''‎''</code> للحصول على المزيد من المخرجات.

إن فكّ التابع الضغط عن جميع البيانات المعطاة وأعادها (إما بسبب كون حجم البيانات المعطاة أقلّ من العدد المحدّد كقيمة للمعامل <code>max_length</code>، أو لكون قيمة المعامل <code>max_length</code> سالبة)، تُسند القيمة <code>True</code> إلى الخاصية <code>[[Python/BZ2Decompressor#needs input|needs_input]]</code>.

تؤدي محاولة فك الضغط عن البيانات بعد الوصول إلى نهاية تدفق البيانات إلى إطلاق الاستثناء <code>EOFError</code>. يتجاهل التابع جميع البيانات التي تأتي بعد نهاية تدفق البيانات وتُحفظ في الخاصية <code>[[Python/BZ2Decompressor#unused data|unused_data]]</code>.

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

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

يعيد التابع البيانات الناتجة عن عملية فك الضغط على هيئة بايتات. يمكن أن يخزّن جزء من البيانات داخليًا buffered internally وذلك لاستخدامها في الاستدعاءات اللاحقة للدالة <code>[[Python/bz2/decompress|decompress()‎]]</code>. يجب أن تُربط البيانات المعادة مع المخرجات الناتجة عن الاستدعاءات السابقة للدالة <code>[[Python/bz2/decompress|decompress()‎]]</code>.

==مصادر==
* [https://docs.python.org/3/library/bz2.html#bz2.BZ2Decompressor.decompress صفحة Support for bzip2 compression في توثيق بايثون الرسمي.]
[[تصنيف:Python]]
[[تصنيف:Python Modules]]
[[تصنيف:Python Methods]]