<!DOCTYPE html PUBLIC
"-//W3C//DTD HTML 4.0 Transitional//EN">
<link rel=
"STYLESHEET" href=
"lib.css" type='text/css'
/>
<link rel=
"SHORTCUT ICON" href=
"../icons/pyfav.png" type=
"image/png" />
<link rel='start' href='../index.html' title='Python Documentation Index'
/>
<link rel=
"first" href=
"lib.html" title='Python Library Reference'
/>
<link rel='contents' href='contents.html'
title=
"Contents" />
<link rel='index' href='genindex.html' title='Index'
/>
<link rel='last' href='about.html' title='About this document...'
/>
<link rel='help' href='about.html' title='About this document...'
/>
<link rel=
"next" href=
"node408.html" />
<link rel=
"prev" href=
"node406.html" />
<link rel=
"parent" href=
"module-bz2.html" />
<link rel=
"next" href=
"node408.html" />
<meta name='aesop' content='information'
/>
<title>7.17.2 Sequential (de)compression
</title>
<div id='top-navigation-panel' xml:id='top-navigation-panel'
>
<table align=
"center" width=
"100%" cellpadding=
"0" cellspacing=
"2">
<td class='online-navigation'
><a rel=
"prev" title=
"7.17.1 (De)compression of files"
href=
"node406.html"><img src='../icons/previous.png'
border='
0' height='
32' alt='Previous Page' width='
32'
/></A></td>
<td class='online-navigation'
><a rel=
"parent" title=
"7.17 bz2 "
href=
"module-bz2.html"><img src='../icons/up.png'
border='
0' height='
32' alt='Up One Level' width='
32'
/></A></td>
<td class='online-navigation'
><a rel=
"next" title=
"7.17.3 One-shot (de)compression"
href=
"node408.html"><img src='../icons/next.png'
border='
0' height='
32' alt='Next Page' width='
32'
/></A></td>
<td align=
"center" width=
"100%">Python Library Reference
</td>
<td class='online-navigation'
><a rel=
"contents" title=
"Table of Contents"
href=
"contents.html"><img src='../icons/contents.png'
border='
0' height='
32' alt='Contents' width='
32'
/></A></td>
<td class='online-navigation'
><a href=
"modindex.html" title=
"Module Index"><img src='../icons/modules.png'
border='
0' height='
32' alt='Module Index' width='
32'
/></a></td>
<td class='online-navigation'
><a rel=
"index" title=
"Index"
href=
"genindex.html"><img src='../icons/index.png'
border='
0' height='
32' alt='Index' width='
32'
/></A></td>
<div class='online-navigation'
>
<b class=
"navlabel">Previous:
</b>
<a class=
"sectref" rel=
"prev" href=
"node406.html">7.17.1 (De)compression of files
</A>
<b class=
"navlabel">Up:
</b>
<a class=
"sectref" rel=
"parent" href=
"module-bz2.html">7.17 bz2
</A>
<b class=
"navlabel">Next:
</b>
<a class=
"sectref" rel=
"next" href=
"node408.html">7.17.3 One-shot (de)compression
</A>
<!--End of Navigation Panel-->
<H2><A NAME=
"SECTION0091720000000000000000">
7.17.2 Sequential (de)compression
</A>
Sequential compression and decompression is done using the classes
<tt class=
"class">BZ2Compressor
</tt> and
<tt class=
"class">BZ2Decompressor
</tt>.
<dl><dt><table cellpadding=
"0" cellspacing=
"0"><tr valign=
"baseline">
<td><nobr><b><span class=
"typelabel">class
</span> <tt id='l2h-
2843' xml:id='l2h-
2843'
class=
"class">BZ2Compressor
</tt></b>(
</nobr></td>
<td><var></var><big>[
</big><var>compresslevel
</var><big>]
</big><var></var>)
</td></tr></table></dt>
Create a new compressor object. This object may be used to compress
data sequentially. If you want to compress data in one shot, use the
<tt class=
"function">compress()
</tt> function instead. The
<var>compresslevel
</var> parameter,
if given, must be a number between
<code>1</code> and
<code>9</code>; the default
<dl><dt><table cellpadding=
"0" cellspacing=
"0"><tr valign=
"baseline">
<td><nobr><b><tt id='l2h-
2844' xml:id='l2h-
2844'
class=
"method">compress
</tt></b>(
</nobr></td>
<td><var>data
</var>)
</td></tr></table></dt>
Provide more data to the compressor object. It will return chunks of compressed
data whenever possible. When you've finished providing data to compress, call
the
<tt class=
"method">flush()
</tt> method to finish the compression process, and return what
is left in internal buffers.
<dl><dt><table cellpadding=
"0" cellspacing=
"0"><tr valign=
"baseline">
<td><nobr><b><tt id='l2h-
2845' xml:id='l2h-
2845'
class=
"method">flush
</tt></b>(
</nobr></td>
<td><var></var>)
</td></tr></table></dt>
Finish the compression process and return what is left in internal buffers. You
must not use the compressor object after calling this method.
<dl><dt><table cellpadding=
"0" cellspacing=
"0"><tr valign=
"baseline">
<td><nobr><b><span class=
"typelabel">class
</span> <tt id='l2h-
2846' xml:id='l2h-
2846'
class=
"class">BZ2Decompressor
</tt></b>(
</nobr></td>
<td><var></var>)
</td></tr></table></dt>
Create a new decompressor object. This object may be used to decompress
data sequentially. If you want to decompress data in one shot, use the
<tt class=
"function">decompress()
</tt> function instead.
<dl><dt><table cellpadding=
"0" cellspacing=
"0"><tr valign=
"baseline">
<td><nobr><b><tt id='l2h-
2847' xml:id='l2h-
2847'
class=
"method">decompress
</tt></b>(
</nobr></td>
<td><var>data
</var>)
</td></tr></table></dt>
Provide more data to the decompressor object. It will return chunks of
decompressed data whenever possible. If you try to decompress data after the
end of stream is found,
<tt class=
"exception">EOFError
</tt> will be raised. If any data was
found after the end of stream, it'll be ignored and saved in
<tt class=
"member">unused_data
</tt> attribute.
<div class='online-navigation'
>
<table align=
"center" width=
"100%" cellpadding=
"0" cellspacing=
"2">
<td class='online-navigation'
><a rel=
"prev" title=
"7.17.1 (De)compression of files"
href=
"node406.html"><img src='../icons/previous.png'
border='
0' height='
32' alt='Previous Page' width='
32'
/></A></td>
<td class='online-navigation'
><a rel=
"parent" title=
"7.17 bz2 "
href=
"module-bz2.html"><img src='../icons/up.png'
border='
0' height='
32' alt='Up One Level' width='
32'
/></A></td>
<td class='online-navigation'
><a rel=
"next" title=
"7.17.3 One-shot (de)compression"
href=
"node408.html"><img src='../icons/next.png'
border='
0' height='
32' alt='Next Page' width='
32'
/></A></td>
<td align=
"center" width=
"100%">Python Library Reference
</td>
<td class='online-navigation'
><a rel=
"contents" title=
"Table of Contents"
href=
"contents.html"><img src='../icons/contents.png'
border='
0' height='
32' alt='Contents' width='
32'
/></A></td>
<td class='online-navigation'
><a href=
"modindex.html" title=
"Module Index"><img src='../icons/modules.png'
border='
0' height='
32' alt='Module Index' width='
32'
/></a></td>
<td class='online-navigation'
><a rel=
"index" title=
"Index"
href=
"genindex.html"><img src='../icons/index.png'
border='
0' height='
32' alt='Index' width='
32'
/></A></td>
<div class='online-navigation'
>
<b class=
"navlabel">Previous:
</b>
<a class=
"sectref" rel=
"prev" href=
"node406.html">7.17.1 (De)compression of files
</A>
<b class=
"navlabel">Up:
</b>
<a class=
"sectref" rel=
"parent" href=
"module-bz2.html">7.17 bz2
</A>
<b class=
"navlabel">Next:
</b>
<a class=
"sectref" rel=
"next" href=
"node408.html">7.17.3 One-shot (de)compression
</A>
<span class=
"release-info">Release
2.4.2, documentation updated on
28 September
2005.
</span>
<!--End of Navigation Panel-->
See
<i><a href=
"about.html">About this document...
</a></i> for information on suggesting changes.