]> granicus.if.org Git - python/commitdiff
Issue #12922: fix the TextIOBase documentation to include a description of seek(...
authorAntoine Pitrou <solipsis@pitrou.net>
Sat, 21 Jan 2012 19:27:59 +0000 (20:27 +0100)
committerAntoine Pitrou <solipsis@pitrou.net>
Sat, 21 Jan 2012 19:27:59 +0000 (20:27 +0100)
Doc/library/io.rst

index d50e66501b46cc395d59a2253ccbf9fc24fd1b62..1d1f490c3383c819e30619a053e81655f61f0ab7 100644 (file)
@@ -701,6 +701,32 @@ Text I/O
       Read until newline or EOF and return a single ``unicode``.  If the
       stream is already at EOF, an empty string is returned.
 
+   .. method:: seek(offset, whence=SEEK_SET)
+
+      Change the stream position to the given *offset*.  Behaviour depends
+      on the *whence* parameter:
+
+      * :data:`SEEK_SET` or ``0``: seek from the start of the stream
+        (the default); *offset* must either be a number returned by
+        :meth:`TextIOBase.tell`, or zero.  Any other *offset* value
+        produces undefined behaviour.
+      * :data:`SEEK_CUR` or ``1``: "seek" to the current position;
+        *offset* must be zero, which is a no-operation (all other values
+        are unsupported).
+      * :data:`SEEK_END` or ``2``: seek to the end of the stream;
+        *offset* must be zero (all other values are unsupported).
+
+      Return the new absolute position as an opaque number.
+
+      .. versionadded:: 2.7
+         The ``SEEK_*`` constants.
+
+   .. method:: tell()
+
+      Return the current stream position as an opaque number.  The number
+      does not usually represent a number of bytes in the underlying
+      binary storage.
+
    .. method:: write(s)
 
       Write the :class:`unicode` string *s* to the stream and return the