diff options
| author | Nadeem Vawda <nadeem.vawda@gmail.com> | 2013-12-08 19:50:05 +0100 |
|---|---|---|
| committer | Nadeem Vawda <nadeem.vawda@gmail.com> | 2013-12-08 19:50:05 +0100 |
| commit | a40cd7685269a4aa8fa8414dd10b2785430ba972 (patch) | |
| tree | 59ff737939501d950df9fb2db1bfd35f2ea8c314 /Doc/library/gzip.rst | |
| parent | f04421b4a0cd3b0f375bc67ac0102a8b6b7edc6e (diff) | |
| parent | 84a466934ffef9c813aa0df2214c3907692c9533 (diff) | |
| download | cpython-a40cd7685269a4aa8fa8414dd10b2785430ba972.tar.gz | |
Closes #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 de5063a7c7..78536fab51 100644 --- a/Doc/library/gzip.rst +++ b/Doc/library/gzip.rst @@ -117,6 +117,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 |