[3.11] gh-107801: Improve the accuracy of io.IOBase.seek docs (#108268) by erlend-aasland · Pull Request #108656 · python/cpython

Expand Up @@ -403,20 +403,19 @@ I/O Base Classes Note that it's already possible to iterate on file objects using ``for line in file: ...`` without calling :meth:`!file.readlines`.
.. method:: seek(offset, whence=SEEK_SET, /) .. method:: seek(offset, whence=os.SEEK_SET, /)
Change the stream position to the given byte *offset*. *offset* is interpreted relative to the position indicated by *whence*. The default value for *whence* is :data:`!SEEK_SET`. Values for *whence* are: Change the stream position to the given byte *offset*, interpreted relative to the position indicated by *whence*, and return the new absolute position. Values for *whence* are:
* :data:`!SEEK_SET` or ``0`` -- start of the stream (the default); * :data:`os.SEEK_SET` or ``0`` -- start of the stream (the default); *offset* should be zero or positive * :data:`!SEEK_CUR` or ``1`` -- current stream position; *offset* may be negative * :data:`!SEEK_END` or ``2`` -- end of the stream; *offset* is usually negative
Return the new absolute position. * :data:`os.SEEK_CUR` or ``1`` -- current stream position; *offset* may be negative * :data:`os.SEEK_END` or ``2`` -- end of the stream; *offset* is usually negative
.. versionadded:: 3.1 The :data:`!SEEK_*` constants. Expand Down Expand Up @@ -1061,14 +1060,17 @@ Text I/O Any other argument combinations are invalid, and may raise exceptions.
.. seealso::
:data:`os.SEEK_SET`, :data:`os.SEEK_CUR`, and :data:`os.SEEK_END`.
.. method:: tell()
Return the stream position as an opaque number. The return value of :meth:`!tell` can be given as input to :meth:`seek`, to restore a previous stream position.


.. class:: StringIO(initial_value='', newline='\n')
A text stream using an in-memory text buffer. It inherits Expand Down