diff options
| author | Nadeem Vawda <nadeem.vawda@gmail.com> | 2012-02-04 11:08:11 (GMT) |
|---|---|---|
| committer | Nadeem Vawda <nadeem.vawda@gmail.com> | 2012-02-04 11:08:11 (GMT) |
| commit | cac8909d0cfe0f52fd0a0409ca58d46b34e58962 (patch) | |
| tree | d41c102cb5f1600839a717c89e096ac90d575eb2 /Lib/bz2.py | |
| parent | ff962c5f1f197dacf831431898370b7425cae2a1 (diff) | |
| download | cpython-cac8909d0cfe0f52fd0a0409ca58d46b34e58962.zip cpython-cac8909d0cfe0f52fd0a0409ca58d46b34e58962.tar.gz cpython-cac8909d0cfe0f52fd0a0409ca58d46b34e58962.tar.bz2 | |
Update docstring for BZ2File.__init__().
Diffstat (limited to 'Lib/bz2.py')
| -rw-r--r-- | Lib/bz2.py | 10 |
1 files changed, 7 insertions, 3 deletions
@@ -47,13 +47,17 @@ class BZ2File(io.BufferedIOBase): the file object given by fileobj. Exactly one of these two parameters should be provided. - mode can be 'r' for reading (default), or 'w' for writing. + mode can be 'r' for reading (default), 'w' for (over)writing, or + 'a' for appending. buffering is ignored. Its use is deprecated. - If mode is 'w', compresslevel can be a number between 1 and 9 - specifying the level of compression: 1 produces the least + 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. """ # This lock must be recursive, so that BufferedIOBase's # readline(), readlines() and writelines() don't deadlock. |