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/gzip.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/gzip.rst')
| -rw-r--r-- | Doc/library/gzip.rst | 5 |
1 files changed, 5 insertions, 0 deletions
diff --git a/Doc/library/gzip.rst b/Doc/library/gzip.rst index ec16f6ae88..354deed921 100644 --- a/Doc/library/gzip.rst +++ b/Doc/library/gzip.rst @@ -113,6 +113,11 @@ The module defines the following items: the call. The number of bytes returned may be more or less than requested. + .. note:: While calling :meth:`peek` does not change the file position of + the :class:`GzipFile`, it may change the position of the underlying + file object (e.g. if the :class:`GzipFile` was constructed with the + *fileobj* parameter). + .. versionadded:: 3.2 .. versionchanged:: 3.1 |