FM / library

/usr/share/doc/python3-docs/html/_sources/library/

/usr/share/doc/python3-docs/html/_sources/library

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

Edit: /usr/share/doc/python3-docs/html/_sources/library/lzma.rst.txt (17361B)

:mod:`lzma` --- Compression using the LZMA algorithm
====================================================

.. module:: lzma
   :synopsis: A Python wrapper for the liblzma compression library.

.. moduleauthor:: Nadeem Vawda <nadeem.vawda@gmail.com>
.. sectionauthor:: Nadeem Vawda <nadeem.vawda@gmail.com>

.. versionadded:: 3.3

**Source code:** :source:`Lib/lzma.py`

--------------

This module provides classes and convenience functions for compressing and
decompressing data using the LZMA compression algorithm. Also included is a file
interface supporting the ``.xz`` and legacy ``.lzma`` file formats used by the
:program:`xz` utility, as well as raw compressed streams.

The interface provided by this module is very similar to that of the :mod:`bz2`
module. However, note that :class:`LZMAFile` is *not* thread-safe, unlike
:class:`bz2.BZ2File`, so if you need to use a single :class:`LZMAFile` instance
from multiple threads, it is necessary to protect it with a lock.

.. exception:: LZMAError

This exception is raised when an error occurs during compression or
   decompression, or while initializing the compressor/decompressor state.

Reading and writing compressed files
------------------------------------

.. function:: open(filename, mode="rb", \*, format=None, check=-1, preset=None, filters=None, encoding=None, errors=None, newline=None)

Open an LZMA-compressed file in binary or text mode, returning a :term:`file
   object`.

The *filename* argument can be either an actual file name (given as a
   :class:`str`, :class:`bytes` or :term:`path-like <path-like object>` object), in
   which case the named file is opened, or it can be 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"``.

When opening a file for reading, the *format* and *filters* arguments have
   the same meanings as for :class:`LZMADecompressor`. In this case, the *check*
   and *preset* arguments should not be used.

When opening a file for writing, the *format*, *check*, *preset* and
   *filters* arguments have the same meanings as for :class:`LZMACompressor`.

For binary mode, this function is equivalent to the :class:`LZMAFile`
   constructor: ``LZMAFile(filename, mode, ...)``. In this case, the *encoding*,
   *errors* and *newline* arguments must not be provided.

For text mode, a :class:`LZMAFile` object is created, and wrapped in an
   :class:`io.TextIOWrapper` instance with the specified encoding, error
   handling behavior, and line ending(s).

.. versionchanged:: 3.4
      Added support for the ``"x"``, ``"xb"`` and ``"xt"`` modes.

.. versionchanged:: 3.6
      Accepts a :term:`path-like object`.

.. class:: LZMAFile(filename=None, mode="r", \*, format=None, check=-1, preset=None, filters=None)

Open an LZMA-compressed file in binary mode.

An :class:`LZMAFile` can wrap an already-open :term:`file object`, or operate
   directly on a named file. The *filename* argument specifies either the file
   object to wrap, or the name of the file to open (as a :class:`str`,
   :class:`bytes` or :term:`path-like <path-like object>` object). When wrapping an
   existing file object, the wrapped file will not be closed when the
   :class:`LZMAFile` is closed.

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"``.

When opening a file for reading, the input file may be the concatenation of
   multiple separate compressed streams. These are transparently decoded as a
   single logical stream.

When opening a file for writing, the *format*, *check*, *preset* and
   *filters* arguments have the same meanings as for :class:`LZMACompressor`.

:class:`LZMAFile` supports all the members specified by
   :class:`io.BufferedIOBase`, except for :meth:`detach` and :meth:`truncate`.
   Iteration and the :keyword:`with` statement are supported.

The following method is also provided:

.. method:: peek(size=-1)

Return buffered data without advancing the file position. At least one
      byte of data will be returned, unless EOF has been reached. The exact
      number of bytes returned is unspecified (the *size* argument is ignored).

.. note:: While calling :meth:`peek` does not change the file position of
         the :class:`LZMAFile`, it may change the position of the underlying
         file object (e.g. if the :class:`LZMAFile` was constructed by passing a
         file object for *filename*).

.. versionchanged:: 3.4
      Added support for the ``"x"`` and ``"xb"`` modes.

.. versionchanged:: 3.5
      The :meth:`~io.BufferedIOBase.read` method now accepts an argument of
      ``None``.

.. versionchanged:: 3.6
      Accepts a :term:`path-like object`.

Compressing and decompressing data in memory
--------------------------------------------

.. class:: LZMACompressor(format=FORMAT_XZ, check=-1, preset=None, filters=None)

Create a compressor object, which can be used to compress data incrementally.

For a more convenient way of compressing a single chunk of data, see
   :func:`compress`.

The *format* argument specifies what container format should be used.
   Possible values are:

* :const:`FORMAT_XZ`: The ``.xz`` container format.
      This is the default format.

* :const:`FORMAT_ALONE`: The legacy ``.lzma`` container format.
      This format is more limited than ``.xz`` -- it does not support integrity
      checks or multiple filters.

* :const:`FORMAT_RAW`: A raw data stream, not using any container format.
      This format specifier does not support integrity checks, and requires that
      you always specify a custom filter chain (for both compression and
      decompression). Additionally, data compressed in this manner cannot be
      decompressed using :const:`FORMAT_AUTO` (see :class:`LZMADecompressor`).

The *check* argument specifies the type of integrity check to include in the
   compressed data. This check is used when decompressing, to ensure that the
   data has not been corrupted. Possible values are:

* :const:`CHECK_NONE`: No integrity check.
     This is the default (and the only acceptable value) for
     :const:`FORMAT_ALONE` and :const:`FORMAT_RAW`.

* :const:`CHECK_CRC32`: 32-bit Cyclic Redundancy Check.

* :const:`CHECK_CRC64`: 64-bit Cyclic Redundancy Check.
     This is the default for :const:`FORMAT_XZ`.

* :const:`CHECK_SHA256`: 256-bit Secure Hash Algorithm.

If the specified check is not supported, an :class:`LZMAError` is raised.

The compression settings can be specified either as a preset compression
   level (with the *preset* argument), or in detail as a custom filter chain
   (with the *filters* argument).

The *preset* argument (if provided) should be an integer between ``0`` and
   ``9`` (inclusive), optionally OR-ed with the constant
   :const:`PRESET_EXTREME`. If neither *preset* nor *filters* are given, the
   default behavior is to use :const:`PRESET_DEFAULT` (preset level ``6``).
   Higher presets produce smaller output, but make the compression process
   slower.

.. note::

In addition to being more CPU-intensive, compression with higher presets
      also requires much more memory (and produces output that needs more memory
      to decompress). With preset ``9`` for example, the overhead for an
      :class:`LZMACompressor` object can be as high as 800 MiB. For this reason,
      it is generally best to stick with the default preset.

The *filters* argument (if provided) should be a filter chain specifier.
   See :ref:`filter-chain-specs` for details.

.. method:: compress(data)

Compress *data* (a :class:`bytes` object), returning a :class:`bytes`
      object containing compressed data for at least part of the input. Some of
      *data* may be buffered internally, for use in later calls to
      :meth:`compress` and :meth:`flush`. The returned data should be
      concatenated with the output of any previous calls to :meth:`compress`.

.. method:: flush()

Finish the compression process, returning a :class:`bytes` object
      containing any data stored in the compressor's internal buffers.

The compressor cannot be used after this method has been called.

.. class:: LZMADecompressor(format=FORMAT_AUTO, memlimit=None, filters=None)

Create a decompressor object, which can be used to decompress data
   incrementally.

For a more convenient way of decompressing an entire compressed stream at
   once, see :func:`decompress`.

The *format* argument specifies the container format that should be used. The
   default is :const:`FORMAT_AUTO`, which can decompress both ``.xz`` and
   ``.lzma`` files. Other possible values are :const:`FORMAT_XZ`,
   :const:`FORMAT_ALONE`, and :const:`FORMAT_RAW`.

The *memlimit* argument specifies a limit (in bytes) on the amount of memory
   that the decompressor can use. When this argument is used, decompression will
   fail with an :class:`LZMAError` if it is not possible to decompress the input
   within the given memory limit.

The *filters* argument specifies the filter chain that was used to create
   the stream being decompressed. This argument is required if *format* is
   :const:`FORMAT_RAW`, but should not be used for other formats.
   See :ref:`filter-chain-specs` for more information about filter chains.

.. note::
      This class does not transparently handle inputs containing multiple
      compressed streams, unlike :func:`decompress` and :class:`LZMAFile`. To
      decompress a multi-stream input with :class:`LZMADecompressor`, you must
      create 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:: check

The ID of the integrity check used by the input stream. This may be
      :const:`CHECK_UNKNOWN` until enough of the input has been decoded to
      determine what integrity check it uses.

.. attribute:: eof

``True`` if the end-of-stream marker has been reached.

.. attribute:: unused_data

Data found after the end of the compressed stream.

Before the end of the stream is reached, this 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

.. function:: compress(data, format=FORMAT_XZ, check=-1, preset=None, filters=None)

Compress *data* (a :class:`bytes` object), returning the compressed data as a
   :class:`bytes` object.

See :class:`LZMACompressor` above for a description of the *format*, *check*,
   *preset* and *filters* arguments.

.. function:: decompress(data, format=FORMAT_AUTO, memlimit=None, filters=None)

Decompress *data* (a :class:`bytes` object), returning the uncompressed data
   as a :class:`bytes` object.

If *data* is the concatenation of multiple distinct compressed streams,
   decompress all of these streams, and return the concatenation of the results.

See :class:`LZMADecompressor` above for a description of the *format*,
   *memlimit* and *filters* arguments.

Miscellaneous
-------------

.. function:: is_check_supported(check)

Returns true if the given integrity check is supported on this system.

:const:`CHECK_NONE` and :const:`CHECK_CRC32` are always supported.
   :const:`CHECK_CRC64` and :const:`CHECK_SHA256` may be unavailable if you are
   using a version of :program:`liblzma` that was compiled with a limited
   feature set.

.. _filter-chain-specs:

Specifying custom filter chains
-------------------------------

A filter chain specifier is a sequence of dictionaries, where each dictionary
contains the ID and options for a single filter. Each dictionary must contain
the key ``"id"``, and may contain additional keys to specify filter-dependent
options. Valid filter IDs are as follows:

* Compression filters:
   * :const:`FILTER_LZMA1` (for use with :const:`FORMAT_ALONE`)
   * :const:`FILTER_LZMA2` (for use with :const:`FORMAT_XZ` and :const:`FORMAT_RAW`)

* Delta filter:
   * :const:`FILTER_DELTA`

* Branch-Call-Jump (BCJ) filters:
   * :const:`FILTER_X86`
   * :const:`FILTER_IA64`
   * :const:`FILTER_ARM`
   * :const:`FILTER_ARMTHUMB`
   * :const:`FILTER_POWERPC`
   * :const:`FILTER_SPARC`

A filter chain can consist of up to 4 filters, and cannot be empty. The last
filter in the chain must be a compression filter, and any other filters must be
delta or BCJ filters.

Compression filters support the following options (specified as additional
entries in the dictionary representing the filter):

* ``preset``: A compression preset to use as a source of default values for
     options that are not specified explicitly.
   * ``dict_size``: Dictionary size in bytes. This should be between 4 KiB and
     1.5 GiB (inclusive).
   * ``lc``: Number of literal context bits.
   * ``lp``: Number of literal position bits. The sum ``lc + lp`` must be at
     most 4.
   * ``pb``: Number of position bits; must be at most 4.
   * ``mode``: :const:`MODE_FAST` or :const:`MODE_NORMAL`.
   * ``nice_len``: What should be considered a "nice length" for a match.
     This should be 273 or less.
   * ``mf``: What match finder to use -- :const:`MF_HC3`, :const:`MF_HC4`,
     :const:`MF_BT2`, :const:`MF_BT3`, or :const:`MF_BT4`.
   * ``depth``: Maximum search depth used by match finder. 0 (default) means to
     select automatically based on other filter options.

The delta filter stores the differences between bytes, producing more repetitive
input for the compressor in certain circumstances. It supports one option,
``dist``. This indicates the distance between bytes to be subtracted. The
default is 1, i.e. take the differences between adjacent bytes.

The BCJ filters are intended to be applied to machine code. They convert
relative branches, calls and jumps in the code to use absolute addressing, with
the aim of increasing the redundancy that can be exploited by the compressor.
These filters support one option, ``start_offset``. This specifies the address
that should be mapped to the beginning of the input data. The default is 0.

Examples
--------

Reading in a compressed file::

import lzma
   with lzma.open("file.xz") as f:
       file_content = f.read()

Creating a compressed file::

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

Compressing data in memory::

import lzma
   data_in = b"Insert Data Here"
   data_out = lzma.compress(data_in)

Incremental compression::

import lzma
   lzc = lzma.LZMACompressor()
   out1 = lzc.compress(b"Some data\n")
   out2 = lzc.compress(b"Another piece of data\n")
   out3 = lzc.compress(b"Even more data\n")
   out4 = lzc.flush()
   # Concatenate all the partial results:
   result = b"".join([out1, out2, out3, out4])

Writing compressed data to an already-open file::

import lzma
   with open("file.xz", "wb") as f:
       f.write(b"This data will not be compressed\n")
       with lzma.open(f, "w") as lzf:
           lzf.write(b"This *will* be compressed\n")
       f.write(b"Not compressed\n")

Creating a compressed file using a custom filter chain::

import lzma
   my_filters = [
       {"id": lzma.FILTER_DELTA, "dist": 5},
       {"id": lzma.FILTER_LZMA2, "preset": 7 | lzma.PRESET_EXTREME},
   ]
   with lzma.open("file.xz", "w", filters=my_filters) as f:
       f.write(b"blah blah blah")

:mod:`lzma` --- Compression using the LZMA algorithm ==================================================== .. module:: lzma :synopsis: A Python wrapper for the liblzma compression library. .. moduleauthor:: Nadeem Vawda .. sectionauthor:: Nadeem Vawda .. versionadded:: 3.3 **Source code:** :source:`Lib/lzma.py` -------------- This module provides classes and convenience functions for compressing and decompressing data using the LZMA compression algorithm. Also included is a file interface supporting the ``.xz`` and legacy ``.lzma`` file formats used by the :program:`xz` utility, as well as raw compressed streams. The interface provided by this module is very similar to that of the :mod:`bz2` module. However, note that :class:`LZMAFile` is *not* thread-safe, unlike :class:`bz2.BZ2File`, so if you need to use a single :class:`LZMAFile` instance from multiple threads, it is necessary to protect it with a lock. .. exception:: LZMAError This exception is raised when an error occurs during compression or decompression, or while initializing the compressor/decompressor state. Reading and writing compressed files ------------------------------------ .. function:: open(filename, mode="rb", \*, format=None, check=-1, preset=None, filters=None, encoding=None, errors=None, newline=None) Open an LZMA-compressed file in binary or text mode, returning a :term:`file object`. The *filename* argument can be either an actual file name (given as a :class:`str`, :class:`bytes` or :term:`path-like ` object), in which case the named file is opened, or it can be 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"``. When opening a file for reading, the *format* and *filters* arguments have the same meanings as for :class:`LZMADecompressor`. In this case, the *check* and *preset* arguments should not be used. When opening a file for writing, the *format*, *check*, *preset* and *filters* arguments have the same meanings as for :class:`LZMACompressor`. For binary mode, this function is equivalent to the :class:`LZMAFile` constructor: ``LZMAFile(filename, mode, ...)``. In this case, the *encoding*, *errors* and *newline* arguments must not be provided. For text mode, a :class:`LZMAFile` object is created, and wrapped in an :class:`io.TextIOWrapper` instance with the specified encoding, error handling behavior, and line ending(s). .. versionchanged:: 3.4 Added support for the ``"x"``, ``"xb"`` and ``"xt"`` modes. .. versionchanged:: 3.6 Accepts a :term:`path-like object`. .. class:: LZMAFile(filename=None, mode="r", \*, format=None, check=-1, preset=None, filters=None) Open an LZMA-compressed file in binary mode. An :class:`LZMAFile` can wrap an already-open :term:`file object`, or operate directly on a named file. The *filename* argument specifies either the file object to wrap, or the name of the file to open (as a :class:`str`, :class:`bytes` or :term:`path-like ` object). When wrapping an existing file object, the wrapped file will not be closed when the :class:`LZMAFile` is closed. 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"``. When opening a file for reading, the input file may be the concatenation of multiple separate compressed streams. These are transparently decoded as a single logical stream. When opening a file for reading, the *format* and *filters* arguments have the same meanings as for :class:`LZMADecompressor`. In this case, the *check* and *preset* arguments should not be used. When opening a file for writing, the *format*, *check*, *preset* and *filters* arguments have the same meanings as for :class:`LZMACompressor`. :class:`LZMAFile` supports all the members specified by :class:`io.BufferedIOBase`, except for :meth:`detach` and :meth:`truncate`. Iteration and the :keyword:`with` statement are supported. The following method is also provided: .. method:: peek(size=-1) Return buffered data without advancing the file position. At least one byte of data will be returned, unless EOF has been reached. The exact number of bytes returned is unspecified (the *size* argument is ignored). .. note:: While calling :meth:`peek` does not change the file position of the :class:`LZMAFile`, it may change the position of the underlying file object (e.g. if the :class:`LZMAFile` was constructed by passing a file object for *filename*). .. versionchanged:: 3.4 Added support for the ``"x"`` and ``"xb"`` modes. .. versionchanged:: 3.5 The :meth:`~io.BufferedIOBase.read` method now accepts an argument of ``None``. .. versionchanged:: 3.6 Accepts a :term:`path-like object`. Compressing and decompressing data in memory -------------------------------------------- .. class:: LZMACompressor(format=FORMAT_XZ, check=-1, preset=None, filters=None) Create a compressor object, which can be used to compress data incrementally. For a more convenient way of compressing a single chunk of data, see :func:`compress`. The *format* argument specifies what container format should be used. Possible values are: * :const:`FORMAT_XZ`: The ``.xz`` container format. This is the default format. * :const:`FORMAT_ALONE`: The legacy ``.lzma`` container format. This format is more limited than ``.xz`` -- it does not support integrity checks or multiple filters. * :const:`FORMAT_RAW`: A raw data stream, not using any container format. This format specifier does not support integrity checks, and requires that you always specify a custom filter chain (for both compression and decompression). Additionally, data compressed in this manner cannot be decompressed using :const:`FORMAT_AUTO` (see :class:`LZMADecompressor`). The *check* argument specifies the type of integrity check to include in the compressed data. This check is used when decompressing, to ensure that the data has not been corrupted. Possible values are: * :const:`CHECK_NONE`: No integrity check. This is the default (and the only acceptable value) for :const:`FORMAT_ALONE` and :const:`FORMAT_RAW`. * :const:`CHECK_CRC32`: 32-bit Cyclic Redundancy Check. * :const:`CHECK_CRC64`: 64-bit Cyclic Redundancy Check. This is the default for :const:`FORMAT_XZ`. * :const:`CHECK_SHA256`: 256-bit Secure Hash Algorithm. If the specified check is not supported, an :class:`LZMAError` is raised. The compression settings can be specified either as a preset compression level (with the *preset* argument), or in detail as a custom filter chain (with the *filters* argument). The *preset* argument (if provided) should be an integer between ``0`` and ``9`` (inclusive), optionally OR-ed with the constant :const:`PRESET_EXTREME`. If neither *preset* nor *filters* are given, the default behavior is to use :const:`PRESET_DEFAULT` (preset level ``6``). Higher presets produce smaller output, but make the compression process slower. .. note:: In addition to being more CPU-intensive, compression with higher presets also requires much more memory (and produces output that needs more memory to decompress). With preset ``9`` for example, the overhead for an :class:`LZMACompressor` object can be as high as 800 MiB. For this reason, it is generally best to stick with the default preset. The *filters* argument (if provided) should be a filter chain specifier. See :ref:`filter-chain-specs` for details. .. method:: compress(data) Compress *data* (a :class:`bytes` object), returning a :class:`bytes` object containing compressed data for at least part of the input. Some of *data* may be buffered internally, for use in later calls to :meth:`compress` and :meth:`flush`. The returned data should be concatenated with the output of any previous calls to :meth:`compress`. .. method:: flush() Finish the compression process, returning a :class:`bytes` object containing any data stored in the compressor's internal buffers. The compressor cannot be used after this method has been called. .. class:: LZMADecompressor(format=FORMAT_AUTO, memlimit=None, filters=None) Create a decompressor object, which can be used to decompress data incrementally. For a more convenient way of decompressing an entire compressed stream at once, see :func:`decompress`. The *format* argument specifies the container format that should be used. The default is :const:`FORMAT_AUTO`, which can decompress both ``.xz`` and ``.lzma`` files. Other possible values are :const:`FORMAT_XZ`, :const:`FORMAT_ALONE`, and :const:`FORMAT_RAW`. The *memlimit* argument specifies a limit (in bytes) on the amount of memory that the decompressor can use. When this argument is used, decompression will fail with an :class:`LZMAError` if it is not possible to decompress the input within the given memory limit. The *filters* argument specifies the filter chain that was used to create the stream being decompressed. This argument is required if *format* is :const:`FORMAT_RAW`, but should not be used for other formats. See :ref:`filter-chain-specs` for more information about filter chains. .. note:: This class does not transparently handle inputs containing multiple compressed streams, unlike :func:`decompress` and :class:`LZMAFile`. To decompress a multi-stream input with :class:`LZMADecompressor`, you must create 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:: check The ID of the integrity check used by the input stream. This may be :const:`CHECK_UNKNOWN` until enough of the input has been decoded to determine what integrity check it uses. .. attribute:: eof ``True`` if the end-of-stream marker has been reached. .. attribute:: unused_data Data found after the end of the compressed stream. Before the end of the stream is reached, this 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 .. function:: compress(data, format=FORMAT_XZ, check=-1, preset=None, filters=None) Compress *data* (a :class:`bytes` object), returning the compressed data as a :class:`bytes` object. See :class:`LZMACompressor` above for a description of the *format*, *check*, *preset* and *filters* arguments. .. function:: decompress(data, format=FORMAT_AUTO, memlimit=None, filters=None) Decompress *data* (a :class:`bytes` object), returning the uncompressed data as a :class:`bytes` object. If *data* is the concatenation of multiple distinct compressed streams, decompress all of these streams, and return the concatenation of the results. See :class:`LZMADecompressor` above for a description of the *format*, *memlimit* and *filters* arguments. Miscellaneous ------------- .. function:: is_check_supported(check) Returns true if the given integrity check is supported on this system. :const:`CHECK_NONE` and :const:`CHECK_CRC32` are always supported. :const:`CHECK_CRC64` and :const:`CHECK_SHA256` may be unavailable if you are using a version of :program:`liblzma` that was compiled with a limited feature set. .. _filter-chain-specs: Specifying custom filter chains ------------------------------- A filter chain specifier is a sequence of dictionaries, where each dictionary contains the ID and options for a single filter. Each dictionary must contain the key ``"id"``, and may contain additional keys to specify filter-dependent options. Valid filter IDs are as follows: * Compression filters: * :const:`FILTER_LZMA1` (for use with :const:`FORMAT_ALONE`) * :const:`FILTER_LZMA2` (for use with :const:`FORMAT_XZ` and :const:`FORMAT_RAW`) * Delta filter: * :const:`FILTER_DELTA` * Branch-Call-Jump (BCJ) filters: * :const:`FILTER_X86` * :const:`FILTER_IA64` * :const:`FILTER_ARM` * :const:`FILTER_ARMTHUMB` * :const:`FILTER_POWERPC` * :const:`FILTER_SPARC` A filter chain can consist of up to 4 filters, and cannot be empty. The last filter in the chain must be a compression filter, and any other filters must be delta or BCJ filters. Compression filters support the following options (specified as additional entries in the dictionary representing the filter): * ``preset``: A compression preset to use as a source of default values for options that are not specified explicitly. * ``dict_size``: Dictionary size in bytes. This should be between 4 KiB and 1.5 GiB (inclusive). * ``lc``: Number of literal context bits. * ``lp``: Number of literal position bits. The sum ``lc + lp`` must be at most 4. * ``pb``: Number of position bits; must be at most 4. * ``mode``: :const:`MODE_FAST` or :const:`MODE_NORMAL`. * ``nice_len``: What should be considered a "nice length" for a match. This should be 273 or less. * ``mf``: What match finder to use -- :const:`MF_HC3`, :const:`MF_HC4`, :const:`MF_BT2`, :const:`MF_BT3`, or :const:`MF_BT4`. * ``depth``: Maximum search depth used by match finder. 0 (default) means to select automatically based on other filter options. The delta filter stores the differences between bytes, producing more repetitive input for the compressor in certain circumstances. It supports one option, ``dist``. This indicates the distance between bytes to be subtracted. The default is 1, i.e. take the differences between adjacent bytes. The BCJ filters are intended to be applied to machine code. They convert relative branches, calls and jumps in the code to use absolute addressing, with the aim of increasing the redundancy that can be exploited by the compressor. These filters support one option, ``start_offset``. This specifies the address that should be mapped to the beginning of the input data. The default is 0. Examples -------- Reading in a compressed file:: import lzma with lzma.open("file.xz") as f: file_content = f.read() Creating a compressed file:: import lzma data = b"Insert Data Here" with lzma.open("file.xz", "w") as f: f.write(data) Compressing data in memory:: import lzma data_in = b"Insert Data Here" data_out = lzma.compress(data_in) Incremental compression:: import lzma lzc = lzma.LZMACompressor() out1 = lzc.compress(b"Some data\n") out2 = lzc.compress(b"Another piece of data\n") out3 = lzc.compress(b"Even more data\n") out4 = lzc.flush() # Concatenate all the partial results: result = b"".join([out1, out2, out3, out4]) Writing compressed data to an already-open file:: import lzma with open("file.xz", "wb") as f: f.write(b"This data will not be compressed\n") with lzma.open(f, "w") as lzf: lzf.write(b"This *will* be compressed\n") f.write(b"Not compressed\n") Creating a compressed file using a custom filter chain:: import lzma my_filters = [ {"id": lzma.FILTER_DELTA, "dist": 5}, {"id": lzma.FILTER_LZMA2, "preset": 7 | lzma.PRESET_EXTREME}, ] with lzma.open("file.xz", "w", filters=my_filters) as f: f.write(b"blah blah blah")