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

bz2 module: Rewrap docstrings at 72 columns, as per PEP 8.

This commit is contained in:
Nadeem Vawda 2012-10-08 20:31:34 +02:00
parent 3b4a4f5199
commit 4907b0a2e0
1 changed files with 16 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
Lib/bz2.py
View File

@ -44,12 +44,13 @@ class BZ2File(io.BufferedIOBase):
def __init__(self, filename, mode="r", buffering=None, compresslevel=9): def __init__(self, filename, mode="r", buffering=None, compresslevel=9):
"""Open a bzip2-compressed file. """Open a bzip2-compressed file.
If filename is a str or bytes object, is gives the name of the file to If filename is a str or bytes object, it gives the name
be opened. Otherwise, it should be a file object, which will be used to of the file to be opened. Otherwise, it should be a file object,
read or write the compressed data. which will be used to read or write the compressed data.
mode can be 'r' for reading (default), 'w' for (over)writing, or 'a' for mode can be 'r' for reading (default), 'w' for (over)writing,
appending. These can equivalently be given as 'rb', 'wb', and 'ab'. or 'a' for appending. These can equivalently be given as 'rb',
'wb', and 'ab'.
buffering is ignored. Its use is deprecated. buffering is ignored. Its use is deprecated.
@ -439,20 +440,20 @@ def open(filename, mode="rb", compresslevel=9,
encoding=None, errors=None, newline=None): encoding=None, errors=None, newline=None):
"""Open a bzip2-compressed file in binary or text mode. """Open a bzip2-compressed file in binary or text mode.
The filename argument can be an actual filename (a str or bytes object), or The filename argument can be an actual filename (a str or bytes
an existing file object to read from or write to. object), or an existing file object to read from or write to.
The mode argument can be "r", "rb", "w", "wb", "a" or "ab" for binary mode, The mode argument can be "r", "rb", "w", "wb", "a" or "ab" for
or "rt", "wt" or "at" for text mode. The default mode is "rb", and the binary mode, or "rt", "wt" or "at" for text mode. The default mode
default compresslevel is 9. is "rb", and the default compresslevel is 9.
For binary mode, this function is equivalent to the BZ2File constructor: For binary mode, this function is equivalent to the BZ2File
BZ2File(filename, mode, compresslevel). In this case, the encoding, errors constructor: BZ2File(filename, mode, compresslevel). In this case,
and newline arguments must not be provided. the encoding, errors and newline arguments must not be provided.
For text mode, a BZ2File object is created, and wrapped in an For text mode, a BZ2File object is created, and wrapped in an
io.TextIOWrapper instance with the specified encoding, error handling io.TextIOWrapper instance with the specified encoding, error
behavior, and line ending(s). handling behavior, and line ending(s).
""" """
if "t" in mode: if "t" in mode: