Name	Size	Mode	Actions
2to3.rst.txt	15898	0644	editdlrm
abc.rst.txt	11805	0644	editdlrm
aifc.rst.txt	7503	0644	editdlrm
allos.rst.txt	678	0644	editdlrm
archiving.rst.txt	440	0644	editdlrm
argparse.rst.txt	77480	0644	editdlrm
array.rst.txt	10812	0644	editdlrm
ast.rst.txt	10159	0644	editdlrm
asynchat.rst.txt	8528	0644	editdlrm
asyncio-dev.rst.txt	13398	0644	editdlrm
asyncio-eventloop.rst.txt	33701	0644	editdlrm
asyncio-eventloops.rst.txt	7660	0644	editdlrm
asyncio-protocol.rst.txt	25170	0644	editdlrm
asyncio-queue.rst.txt	4328	0644	editdlrm
asyncio-stream.rst.txt	14363	0644	editdlrm
asyncio-subprocess.rst.txt	15544	0644	editdlrm
asyncio-sync.rst.txt	9078	0644	editdlrm
asyncio-task.rst.txt	25406	0644	editdlrm
asyncio.rst.txt	2272	0644	editdlrm
asyncore.rst.txt	13624	0644	editdlrm
atexit.rst.txt	3669	0644	editdlrm
audioop.rst.txt	10712	0644	editdlrm
base64.rst.txt	10371	0644	editdlrm
bdb.rst.txt	12985	0644	editdlrm
binary.rst.txt	654	0644	editdlrm
binascii.rst.txt	6539	0644	editdlrm
binhex.rst.txt	1709	0644	editdlrm
bisect.rst.txt	5398	0644	editdlrm
builtins.rst.txt	1465	0644	editdlrm
bz2.rst.txt	8825	0644	editdlrm
calendar.rst.txt	10988	0644	editdlrm
cgi.rst.txt	22650	0644	editdlrm
cgitb.rst.txt	2918	0644	editdlrm
chunk.rst.txt	5094	0644	editdlrm
cmath.rst.txt	9326	0644	editdlrm
cmd.rst.txt	13795	0644	editdlrm
code.rst.txt	7817	0644	editdlrm
codecs.rst.txt	75564	0644	editdlrm
codeop.rst.txt	3021	0644	editdlrm
collections.abc.rst.txt	12861	0644	editdlrm
collections.rst.txt	46063	0644	editdlrm
colorsys.rst.txt	1820	0644	editdlrm
compileall.rst.txt	8975	0644	editdlrm
concurrency.rst.txt	673	0644	editdlrm
concurrent.futures.rst.txt	16910	0644	editdlrm
concurrent.rst.txt	171	0644	editdlrm
configparser.rst.txt	48756	0644	editdlrm
constants.rst.txt	3331	0644	editdlrm
contextlib.rst.txt	28175	0644	editdlrm
copy.rst.txt	3378	0644	editdlrm
copyreg.rst.txt	2182	0644	editdlrm
crypt.rst.txt	5122	0644	editdlrm
crypto.rst.txt	411	0644	editdlrm
csv.rst.txt	19902	0644	editdlrm
ctypes.rst.txt	88613	0644	editdlrm
curses.ascii.rst.txt	8920	0644	editdlrm
curses.panel.rst.txt	2764	0644	editdlrm
curses.rst.txt	76397	0644	editdlrm
custominterp.rst.txt	569	0644	editdlrm
datatypes.rst.txt	751	0644	editdlrm
datetime.rst.txt	90524	0644	editdlrm
dbm.rst.txt	14293	0644	editdlrm
debug.rst.txt	471	0644	editdlrm
decimal.rst.txt	74869	0644	editdlrm
development.rst.txt	704	0644	editdlrm
difflib.rst.txt	29861	0644	editdlrm
dis.rst.txt	32567	0644	editdlrm
distribution.rst.txt	452	0644	editdlrm
distutils.rst.txt	1974	0644	editdlrm
doctest.rst.txt	71743	0644	editdlrm
dummy_threading.rst.txt	784	0644	editdlrm
email.charset.rst.txt	9293	0644	editdlrm
email.compat32-message.rst.txt	33493	0644	editdlrm
email.contentmanager.rst.txt	9112	0644	editdlrm
email.encoders.rst.txt	2715	0644	editdlrm
email.errors.rst.txt	4792	0644	editdlrm
email.examples.rst.txt	1915	0644	editdlrm
email.generator.rst.txt	13637	0644	editdlrm
email.header.rst.txt	9188	0644	editdlrm
email.headerregistry.rst.txt	17957	0644	editdlrm
email.iterators.rst.txt	2795	0644	editdlrm
email.message.rst.txt	33008	0644	editdlrm
email.mime.rst.txt	11721	0644	editdlrm
email.parser.rst.txt	14092	0644	editdlrm
email.policy.rst.txt	27022	0644	editdlrm
email.rst.txt	6785	0644	editdlrm
email.util.rst.txt	9214	0644	editdlrm
ensurepip.rst.txt	4987	0644	editdlrm
enum.rst.txt	32751	0644	editdlrm
errno.rst.txt	6811	0644	editdlrm
exceptions.rst.txt	25570	0644	editdlrm
faulthandler.rst.txt	6136	0644	editdlrm
fcntl.rst.txt	7152	0644	editdlrm
filecmp.rst.txt	5623	0644	editdlrm
fileformats.rst.txt	287	0644	editdlrm
fileinput.rst.txt	8051	0644	editdlrm
filesys.rst.txt	961	0644	editdlrm
fnmatch.rst.txt	3103	0644	editdlrm
formatter.rst.txt	13242	0644	editdlrm
fpectl.rst.txt	4180	0644	editdlrm
fractions.rst.txt	6364	0644	editdlrm
frameworks.rst.txt	391	0644	editdlrm
ftplib.rst.txt	17552	0644	editdlrm
functional.rst.txt	365	0644	editdlrm
functions.rst.txt	71621	0644	editdlrm
functools.rst.txt	18503	0644	editdlrm
gc.rst.txt	9694	0644	editdlrm
getopt.rst.txt	6557	0644	editdlrm
getpass.rst.txt	1882	0644	editdlrm
gettext.rst.txt	25588	0644	editdlrm
glob.rst.txt	3508	0644	editdlrm
grp.rst.txt	2417	0644	editdlrm
gzip.rst.txt	8301	0644	editdlrm
hashlib.rst.txt	26523	0644	editdlrm
heapq.rst.txt	13402	0644	editdlrm
hmac.rst.txt	4020	0644	editdlrm
html.entities.rst.txt	1319	0644	editdlrm
html.parser.rst.txt	11275	0644	editdlrm
html.rst.txt	1304	0644	editdlrm
http.client.rst.txt	18870	0644	editdlrm
http.cookiejar.rst.txt	27832	0644	editdlrm
http.cookies.rst.txt	8645	0644	editdlrm
http.rst.txt	7096	0644	editdlrm
http.server.rst.txt	17639	0644	editdlrm
i18n.rst.txt	408	0644	editdlrm
idle.rst.txt	25834	0644	editdlrm
imaplib.rst.txt	20367	0644	editdlrm
imghdr.rst.txt	2938	0644	editdlrm
imp.rst.txt	15548	0644	editdlrm
importlib.rst.txt	53563	0644	editdlrm
index.rst.txt	2258	0644	editdlrm
inspect.rst.txt	53928	0644	editdlrm
internet.rst.txt	992	0644	editdlrm
intro.rst.txt	2645	0644	editdlrm
io.rst.txt	40328	0644	editdlrm
ipaddress.rst.txt	32340	0644	editdlrm
ipc.rst.txt	649	0644	editdlrm
itertools.rst.txt	38459	0644	editdlrm
json.rst.txt	27876	0644	editdlrm
keyword.rst.txt	617	0644	editdlrm
language.rst.txt	522	0644	editdlrm
linecache.rst.txt	2408	0644	editdlrm
locale.rst.txt	25470	0644	editdlrm
logging.config.rst.txt	33886	0644	editdlrm
logging.handlers.rst.txt	42497	0644	editdlrm
logging.rst.txt	60479	0644	editdlrm
lzma.rst.txt	17361	0644	editdlrm
macpath.rst.txt	707	0644	editdlrm
mailbox.rst.txt	63055	0644	editdlrm
mailcap.rst.txt	3691	0644	editdlrm
markup.rst.txt	679	0644	editdlrm
marshal.rst.txt	4855	0644	editdlrm
math.rst.txt	14375	0644	editdlrm
mimetypes.rst.txt	9839	0644	editdlrm
misc.rst.txt	247	0644	editdlrm
mm.rst.txt	431	0644	editdlrm
mmap.rst.txt	11232	0644	editdlrm
modulefinder.rst.txt	3240	0644	editdlrm
modules.rst.txt	355	0644	editdlrm
msilib.rst.txt	18612	0644	editdlrm
msvcrt.rst.txt	4392	0644	editdlrm
multiprocessing.rst.txt	104494	0644	editdlrm
netdata.rst.txt	339	0644	editdlrm
netrc.rst.txt	3007	0644	editdlrm
nis.rst.txt	1993	0644	editdlrm
nntplib.rst.txt	21821	0644	editdlrm
numbers.rst.txt	8089	0644	editdlrm
numeric.rst.txt	696	0644	editdlrm
operator.rst.txt	18989	0644	editdlrm
optparse.rst.txt	76996	0644	editdlrm
os.path.rst.txt	16419	0644	editdlrm
os.rst.txt	137534	0644	editdlrm
ossaudiodev.rst.txt	17845	0644	editdlrm
othergui.rst.txt	2822	0644	editdlrm
parser.rst.txt	15148	0644	editdlrm
pathlib.rst.txt	30045	0644	editdlrm
pdb.rst.txt	19454	0644	editdlrm
persistence.rst.txt	591	0644	editdlrm
pickle.rst.txt	37440	0644	editdlrm
pickletools.rst.txt	3729	0644	editdlrm
pipes.rst.txt	2557	0644	editdlrm
pkgutil.rst.txt	8730	0644	editdlrm
platform.rst.txt	9624	0644	editdlrm
plistlib.rst.txt	7398	0644	editdlrm
poplib.rst.txt	8197	0644	editdlrm
posix.rst.txt	3694	0644	editdlrm
pprint.rst.txt	14274	0644	editdlrm
profile.rst.txt	27969	0644	editdlrm
pty.rst.txt	3123	0644	editdlrm
pwd.rst.txt	2739	0644	editdlrm
pyclbr.rst.txt	3297	0644	editdlrm
pydoc.rst.txt	4688	0644	editdlrm
pyexpat.rst.txt	28620	0644	editdlrm
python.rst.txt	475	0644	editdlrm
py_compile.rst.txt	3851	0644	editdlrm
queue.rst.txt	7268	0644	editdlrm
quopri.rst.txt	2571	0644	editdlrm
random.rst.txt	18503	0644	editdlrm
re.rst.txt	64936	0644	editdlrm
readline.rst.txt	11943	0644	editdlrm
reprlib.rst.txt	5162	0644	editdlrm
resource.rst.txt	12291	0644	editdlrm
rlcompleter.rst.txt	2294	0644	editdlrm
runpy.rst.txt	8285	0644	editdlrm
sched.rst.txt	4842	0644	editdlrm
secrets.rst.txt	5930	0644	editdlrm
select.rst.txt	28175	0644	editdlrm
selectors.rst.txt	8925	0644	editdlrm
shelve.rst.txt	8390	0644	editdlrm
shlex.rst.txt	16441	0644	editdlrm
shutil.rst.txt	26014	0644	editdlrm
signal.rst.txt	17218	0644	editdlrm
site.rst.txt	9628	0644	editdlrm
smtpd.rst.txt	10806	0644	editdlrm
smtplib.rst.txt	23439	0644	editdlrm
sndhdr.rst.txt	1994	0644	editdlrm
socket.rst.txt	68202	0644	editdlrm
socketserver.rst.txt	23712	0644	editdlrm
spwd.rst.txt	2958	0644	editdlrm
sqlite3.rst.txt	39215	0644	editdlrm
ssl.rst.txt	96021	0644	editdlrm
stat.rst.txt	9805	0644	editdlrm
statistics.rst.txt	15301	0644	editdlrm
stdtypes.rst.txt	179240	0644	editdlrm
string.rst.txt	35374	0644	editdlrm
stringprep.rst.txt	4279	0644	editdlrm
struct.rst.txt	19581	0644	editdlrm
subprocess.rst.txt	45793	0644	editdlrm
sunau.rst.txt	7390	0644	editdlrm
superseded.rst.txt	258	0644	editdlrm
symbol.rst.txt	975	0644	editdlrm
symtable.rst.txt	4964	0644	editdlrm
sys.rst.txt	58273	0644	editdlrm
sysconfig.rst.txt	8749	0644	editdlrm
syslog.rst.txt	4302	0644	editdlrm
tabnanny.rst.txt	2007	0644	editdlrm
tarfile.rst.txt	31749	0644	editdlrm
telnetlib.rst.txt	7899	0644	editdlrm
tempfile.rst.txt	13857	0644	editdlrm
termios.rst.txt	3751	0644	editdlrm
test.rst.txt	25764	0644	editdlrm
text.rst.txt	584	0644	editdlrm
textwrap.rst.txt	10519	0644	editdlrm
threading.rst.txt	39257	0644	editdlrm
time.rst.txt	32967	0644	editdlrm
timeit.rst.txt	13000	0644	editdlrm
tk.rst.txt	1639	0644	editdlrm
tkinter.rst.txt	33027	0644	editdlrm
tkinter.scrolledtext.rst.txt	1255	0644	editdlrm
tkinter.tix.rst.txt	22653	0644	editdlrm
tkinter.ttk.rst.txt	58489	0644	editdlrm
token.rst.txt	2607	0644	editdlrm
tokenize.rst.txt	10002	0644	editdlrm
trace.rst.txt	6914	0644	editdlrm
traceback.rst.txt	17854	0644	editdlrm
tracemalloc.rst.txt	22089	0644	editdlrm
tty.rst.txt	1097	0644	editdlrm
turtle.rst.txt	71221	0644	editdlrm
types.rst.txt	9999	0644	editdlrm
typing.rst.txt	34332	0644	editdlrm
undoc.rst.txt	780	0644	editdlrm
unicodedata.rst.txt	5762	0644	editdlrm
unittest.mock-examples.rst.txt	46206	0644	editdlrm
unittest.mock.rst.txt	85991	0644	editdlrm
unittest.rst.txt	93304	0644	editdlrm
unix.rst.txt	446	0644	editdlrm
urllib.error.rst.txt	2199	0644	editdlrm
urllib.parse.rst.txt	27332	0644	editdlrm
urllib.request.rst.txt	59360	0644	editdlrm
urllib.robotparser.rst.txt	2969	0644	editdlrm
urllib.rst.txt	466	0644	editdlrm
uu.rst.txt	2387	0644	editdlrm
uuid.rst.txt	8760	0644	editdlrm
venv.rst.txt	20621	0644	editdlrm
warnings.rst.txt	20152	0644	editdlrm
wave.rst.txt	6870	0644	editdlrm
weakref.rst.txt	21328	0644	editdlrm
webbrowser.rst.txt	9783	0644	editdlrm
windows.rst.txt	272	0644	editdlrm
winreg.rst.txt	24073	0644	editdlrm
winsound.rst.txt	5134	0644	editdlrm
wsgiref.rst.txt	33047	0644	editdlrm
xdrlib.rst.txt	8078	0644	editdlrm
xml.dom.minidom.rst.txt	10198	0644	editdlrm
xml.dom.pulldom.rst.txt	5186	0644	editdlrm
xml.dom.rst.txt	39507	0644	editdlrm
xml.etree.elementtree.rst.txt	43871	0644	editdlrm
xml.rst.txt	6071	0644	editdlrm
xml.sax.handler.rst.txt	15399	0644	editdlrm
xml.sax.reader.rst.txt	12133	0644	editdlrm
xml.sax.rst.txt	7159	0644	editdlrm
xml.sax.utils.rst.txt	3901	0644	editdlrm
xmlrpc.client.rst.txt	23071	0644	editdlrm
xmlrpc.rst.txt	475	0644	editdlrm
xmlrpc.server.rst.txt	14990	0644	editdlrm
zipapp.rst.txt	17392	0644	editdlrm
zipfile.rst.txt	24005	0644	editdlrm
zipimport.rst.txt	5805	0644	editdlrm
zlib.rst.txt	13912	0644	editdlrm
_dummy_thread.rst.txt	762	0644	editdlrm
_thread.rst.txt	6886	0644	editdlrm
__future__.rst.txt	5245	0644	editdlrm
__main__.rst.txt	904	0644	editdlrm

:mod:`bz2` --- Support for :program:`bzip2` compression ======================================================= .. module:: bz2 :synopsis: Interfaces for bzip2 compression and decompression. .. moduleauthor:: Gustavo Niemeyer .. moduleauthor:: Nadeem Vawda .. sectionauthor:: Gustavo Niemeyer .. sectionauthor:: Nadeem Vawda **Source code:** :source:`Lib/bz2.py` -------------- This module provides a comprehensive interface for compressing and decompressing data using the bzip2 compression algorithm. The :mod:`bz2` module contains: * The :func:`.open` function and :class:`BZ2File` class for reading and writing compressed files. * The :class:`BZ2Compressor` and :class:`BZ2Decompressor` classes for incremental (de)compression. * The :func:`compress` and :func:`decompress` functions for one-shot (de)compression. All of the classes in this module may safely be accessed from multiple threads. (De)compression of files ------------------------ .. function:: open(filename, mode='r', compresslevel=9, encoding=None, errors=None, newline=None) Open a bzip2-compressed file in binary or text mode, returning a :term:`file object`. As with the constructor for :class:`BZ2File`, the *filename* argument can be an actual filename (a :class:`str` or :class:`bytes` object), or an existing file object to read from or write to. The *mode* argument can be any of ``'r'``, ``'rb'``, ``'w'``, ``'wb'``, ``'x'``, ``'xb'``, ``'a'`` or ``'ab'`` for binary mode, or ``'rt'``, ``'wt'``, ``'xt'``, or ``'at'`` for text mode. The default is ``'rb'``. The *compresslevel* argument is an integer from 1 to 9, as for the :class:`BZ2File` constructor. For binary mode, this function is equivalent to the :class:`BZ2File` constructor: ``BZ2File(filename, mode, compresslevel=compresslevel)``. In this case, the *encoding*, *errors* and *newline* arguments must not be provided. For text mode, a :class:`BZ2File` object is created, and wrapped in an :class:`io.TextIOWrapper` instance with the specified encoding, error handling behavior, and line ending(s). .. versionadded:: 3.3 .. versionchanged:: 3.4 The ``'x'`` (exclusive creation) mode was added. .. versionchanged:: 3.6 Accepts a :term:`path-like object`. .. class:: BZ2File(filename, mode='r', buffering=None, compresslevel=9) Open a bzip2-compressed file in binary mode. If *filename* is a :class:`str` or :class:`bytes` object, open the named file directly. Otherwise, *filename* should be a :term:`file object`, which will be used to read or write the compressed data. The *mode* argument can be either ``'r'`` for reading (default), ``'w'`` for overwriting, ``'x'`` for exclusive creation, or ``'a'`` for appending. These can equivalently be given as ``'rb'``, ``'wb'``, ``'xb'`` and ``'ab'`` respectively. If *filename* is a file object (rather than an actual file name), a mode of ``'w'`` does not truncate the file, and is instead equivalent to ``'a'``. The *buffering* argument is ignored. Its use is deprecated. If *mode* is ``'w'`` or ``'a'``, *compresslevel* can be a number between ``1`` and ``9`` specifying the level of compression: ``1`` produces the least compression, and ``9`` (default) produces the most compression. If *mode* is ``'r'``, the input file may be the concatenation of multiple compressed streams. :class:`BZ2File` provides all of the members specified by the :class:`io.BufferedIOBase`, except for :meth:`detach` and :meth:`truncate`. Iteration and the :keyword:`with` statement are supported. :class:`BZ2File` also provides the following method: .. method:: peek([n]) Return buffered data without advancing the file position. At least one byte of data will be returned (unless at EOF). The exact number of bytes returned is unspecified. .. note:: While calling :meth:`peek` does not change the file position of the :class:`BZ2File`, it may change the position of the underlying file object (e.g. if the :class:`BZ2File` was constructed by passing a file object for *filename*). .. versionadded:: 3.3 .. versionchanged:: 3.1 Support for the :keyword:`with` statement was added. .. versionchanged:: 3.3 The :meth:`fileno`, :meth:`readable`, :meth:`seekable`, :meth:`writable`, :meth:`read1` and :meth:`readinto` methods were added. .. versionchanged:: 3.3 Support was added for *filename* being a :term:`file object` instead of an actual filename. .. versionchanged:: 3.3 The ``'a'`` (append) mode was added, along with support for reading multi-stream files. .. versionchanged:: 3.4 The ``'x'`` (exclusive creation) mode was added. .. versionchanged:: 3.5 The :meth:`~io.BufferedIOBase.read` method now accepts an argument of ``None``. .. versionchanged:: 3.6 Accepts a :term:`path-like object`. Incremental (de)compression --------------------------- .. class:: BZ2Compressor(compresslevel=9) Create a new compressor object. This object may be used to compress data incrementally. For one-shot compression, use the :func:`compress` function instead. *compresslevel*, if given, must be a number between ``1`` and ``9``. The default is ``9``. .. method:: compress(data) Provide data to the compressor object. Returns a chunk of compressed data if possible, or an empty byte string otherwise. When you have finished providing data to the compressor, call the :meth:`flush` method to finish the compression process. .. method:: flush() Finish the compression process. Returns the compressed data left in internal buffers. The compressor object may not be used after this method has been called. .. class:: BZ2Decompressor() Create a new decompressor object. This object may be used to decompress data incrementally. For one-shot compression, use the :func:`decompress` function instead. .. note:: This class does not transparently handle inputs containing multiple compressed streams, unlike :func:`decompress` and :class:`BZ2File`. If you need to decompress a multi-stream input with :class:`BZ2Decompressor`, you must use a new decompressor for each stream. .. method:: decompress(data, max_length=-1) Decompress *data* (a :term:`bytes-like object`), returning uncompressed data as bytes. Some of *data* may be buffered internally, for use in later calls to :meth:`decompress`. The returned data should be concatenated with the output of any previous calls to :meth:`decompress`. If *max_length* is nonnegative, returns at most *max_length* bytes of decompressed data. If this limit is reached and further output can be produced, the :attr:`~.needs_input` attribute will be set to ``False``. In this case, the next call to :meth:`~.decompress` may provide *data* as ``b''`` to obtain more of the output. If all of the input data was decompressed and returned (either because this was less than *max_length* bytes, or because *max_length* was negative), the :attr:`~.needs_input` attribute will be set to ``True``. Attempting to decompress data after the end of stream is reached raises an `EOFError`. Any data found after the end of the stream is ignored and saved in the :attr:`~.unused_data` attribute. .. versionchanged:: 3.5 Added the *max_length* parameter. .. attribute:: eof ``True`` if the end-of-stream marker has been reached. .. versionadded:: 3.3 .. attribute:: unused_data Data found after the end of the compressed stream. If this attribute is accessed before the end of the stream has been reached, its value will be ``b''``. .. attribute:: needs_input ``False`` if the :meth:`.decompress` method can provide more decompressed data before requiring new uncompressed input. .. versionadded:: 3.5 One-shot (de)compression ------------------------ .. function:: compress(data, compresslevel=9) Compress *data*. *compresslevel*, if given, must be a number between ``1`` and ``9``. The default is ``9``. For incremental compression, use a :class:`BZ2Compressor` instead. .. function:: decompress(data) Decompress *data*. If *data* is the concatenation of multiple compressed streams, decompress all of the streams. For incremental decompression, use a :class:`BZ2Decompressor` instead. .. versionchanged:: 3.3 Support for multi-stream inputs was added.