From 487e5f7d7671285505ff4e943ca5f668b1eabed6 Mon Sep 17 00:00:00 2001 From: Nadeem Vawda Date: Mon, 4 Jun 2012 23:36:24 +0200 Subject: Allow LZMAFile to accept modes with a "b" suffix. --- Doc/library/lzma.rst | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) (limited to 'Doc/library/lzma.rst') diff --git a/Doc/library/lzma.rst b/Doc/library/lzma.rst index 156d77aec0..67e425d3c8 100644 --- a/Doc/library/lzma.rst +++ b/Doc/library/lzma.rst @@ -40,9 +40,11 @@ Reading and writing compressed files file will not be closed when the :class:`LZMAFile` is closed. The *mode* argument can be either ``"r"`` for reading (default), ``"w"`` for - overwriting, or ``"a"`` for appending. If *filename* is an existing file - object, a mode of ``"w"`` does not truncate the file, and is instead - equivalent to ``"a"``. + overwriting, or ``"a"`` for appending. These can equivalently be given as + ``"rb"``, ``"wb"``, 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 -- cgit v1.2.1