diff options
| author | Nadeem Vawda <nadeem.vawda@gmail.com> | 2013-12-08 18:50:05 (GMT) |
|---|---|---|
| committer | Nadeem Vawda <nadeem.vawda@gmail.com> | 2013-12-08 18:50:05 (GMT) |
| commit | bd6932a576e643c8aad8c0b4a044655882ebb27d (patch) | |
| tree | 54fcabea19827b6b54785e45d5ee15e85dc12894 /Doc/library/lzma.rst | |
| parent | b12cb6a5509dbaafa05706dd64861bfef9fa42d7 (diff) | |
| parent | 6976104a36aa426bcf23b2e4b7e7a706f25beeeb (diff) | |
| download | cpython-bd6932a576e643c8aad8c0b4a044655882ebb27d.zip cpython-bd6932a576e643c8aad8c0b4a044655882ebb27d.tar.gz cpython-bd6932a576e643c8aad8c0b4a044655882ebb27d.tar.bz2 | |
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/lzma.rst')
| -rw-r--r-- | Doc/library/lzma.rst | 5 |
1 files changed, 5 insertions, 0 deletions
diff --git a/Doc/library/lzma.rst b/Doc/library/lzma.rst index 53fba89..b71051d 100644 --- a/Doc/library/lzma.rst +++ b/Doc/library/lzma.rst @@ -102,6 +102,11 @@ Reading and writing compressed files byte of data will be returned, unless EOF has been reached. The exact number of bytes returned is unspecified (the *size* argument is ignored). + .. note:: While calling :meth:`peek` does not change the file position of + the :class:`LZMAFile`, it may change the position of the underlying + file object (e.g. if the :class:`LZMAFile` was constructed by passing a + file object for *filename*). + .. versionchanged:: 3.4 Added support for the ``"x"`` and ``"xb"`` modes. |