summaryrefslogtreecommitdiff
path: root/Doc/library/lzma.rst
diff options
context:
space:
mode:
authorNadeem Vawda <nadeem.vawda@gmail.com>2012-06-04 23:36:24 +0200
committerNadeem Vawda <nadeem.vawda@gmail.com>2012-06-04 23:36:24 +0200
commit487e5f7d7671285505ff4e943ca5f668b1eabed6 (patch)
tree1ddcad7c1954d33875464b25714830ae16897c4b /Doc/library/lzma.rst
parent96cd32784862504e0173c4db2ab9f3e65bbc0dc1 (diff)
downloadcpython-487e5f7d7671285505ff4e943ca5f668b1eabed6.tar.gz
Allow LZMAFile to accept modes with a "b" suffix.
Diffstat (limited to 'Doc/library/lzma.rst')
-rw-r--r--Doc/library/lzma.rst8
1 files changed, 5 insertions, 3 deletions
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