diff options
| author | Nadeem Vawda <nadeem.vawda@gmail.com> | 2013-12-08 19:47:22 +0100 |
|---|---|---|
| committer | Nadeem Vawda <nadeem.vawda@gmail.com> | 2013-12-08 19:47:22 +0100 |
| commit | 84a466934ffef9c813aa0df2214c3907692c9533 (patch) | |
| tree | c9cc70dddb5739931a529632a312014c081bf6da /Doc/library/bz2.rst | |
| parent | 23a45a46902515a466c23c541b0ebb5c7308c3c4 (diff) | |
| download | cpython-84a466934ffef9c813aa0df2214c3907692c9533.tar.gz | |
#18430: Document that peek() may change the position of the underlying file for
the BZ2File, GzipFile and LZMAFile classes.
Diffstat (limited to 'Doc/library/bz2.rst')
| -rw-r--r-- | Doc/library/bz2.rst | 5 |
1 files changed, 5 insertions, 0 deletions
diff --git a/Doc/library/bz2.rst b/Doc/library/bz2.rst index 95a5abb75d..b79bccdb31 100644 --- a/Doc/library/bz2.rst +++ b/Doc/library/bz2.rst @@ -91,6 +91,11 @@ All of the classes in this module may safely be accessed from multiple threads. byte of data will be returned (unless at EOF). The exact number of bytes returned is unspecified. + .. note:: While calling :meth:`peek` does not change the file position of + the :class:`BZ2File`, it may change the position of the underlying file + object (e.g. if the :class:`BZ2File` was constructed by passing a file + object for *filename*). + .. versionadded:: 3.3 .. versionchanged:: 3.1 |