traverseda
/
cpython
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Update docstring for BZ2File.__init__().

This commit is contained in:
Nadeem Vawda 2012-02-04 13:08:11 +02:00
parent ff962c5f1f
commit cac8909d0c
1 changed files with 7 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
Lib/bz2.py
View File

@ -47,13 +47,17 @@ class BZ2File(io.BufferedIOBase):
the file object given by fileobj. Exactly one of these two the file object given by fileobj. Exactly one of these two
parameters should be provided. 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. buffering is ignored. Its use is deprecated.
If mode is 'w', compresslevel can be a number between 1 and 9 If mode is 'w' or 'a', compresslevel can be a number between 1
specifying the level of compression: 1 produces the least and 9 specifying the level of compression: 1 produces the least
compression, and 9 (default) produces the most compression. 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 # This lock must be recursive, so that BufferedIOBase's
# readline(), readlines() and writelines() don't deadlock. # readline(), readlines() and writelines() don't deadlock.