diff options
| author | Nadeem Vawda <nadeem.vawda@gmail.com> | 2013-12-08 18:47:22 (GMT) |
|---|---|---|
| committer | Nadeem Vawda <nadeem.vawda@gmail.com> | 2013-12-08 18:47:22 (GMT) |
| commit | 6976104a36aa426bcf23b2e4b7e7a706f25beeeb (patch) | |
| tree | aff404b718a6a9fef4d205bf076862d5eee3c20e /Doc/library/gzip.rst | |
| parent | 3e60a9d602c85b738dc74a3c8a196650822e8619 (diff) | |
| download | cpython-6976104a36aa426bcf23b2e4b7e7a706f25beeeb.zip cpython-6976104a36aa426bcf23b2e4b7e7a706f25beeeb.tar.gz cpython-6976104a36aa426bcf23b2e4b7e7a706f25beeeb.tar.bz2 | |
#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 ec16f6a..354deed 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 |