Stowage/cpython
2
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2026-01-04 06:22:20 +00:00
Code Issues Projects Releases Packages Wiki Activity

[3.12] gh-107801: Document io.TextIOWrapper.tell (#108265) (#108547)

Browse source 
(cherry picked from commit 38afa4af9b)
This commit is contained in:
Erlend E. Aasland 2023-08-28 01:59:48 +02:00 • committed by GitHub
parent 311fd96dae
commit f90099c3bd
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 21 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

10
Doc/library/io.rst
View file

@ -1054,13 +1054,21 @@ Text I/O
* ``seek(0, SEEK_SET)``: Rewind to the start of the stream.
* ``seek(cookie, SEEK_SET)``: Restore a previous position;
*cookie* **must be** a number returned by :meth:`!tell`.
*cookie* **must be** a number returned by :meth:`tell`.
* ``seek(0, SEEK_END)``: Fast-forward to the end of the stream.
* ``seek(0, SEEK_CUR)``: Leave the current stream position unchanged.
Any other argument combinations are invalid,
and may raise exceptions.
.. 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

8
Modules/_io/clinic/textio.c.h generated
View file

@ -815,7 +815,11 @@ exit:
PyDoc_STRVAR(_io_TextIOWrapper_tell__doc__,
"tell($self, /)\n"
"--\n"
"\n");
"\n"
"Return the stream position as an opaque number.\n"
"\n"
"The return value of tell() can be given as input to seek(), to restore a\n"
"previous stream position.");
#define _IO_TEXTIOWRAPPER_TELL_METHODDEF \
{"tell", (PyCFunction)_io_TextIOWrapper_tell, METH_NOARGS, _io_TextIOWrapper_tell__doc__},
@ -978,4 +982,4 @@ _io_TextIOWrapper_close(textio *self, PyObject *Py_UNUSED(ignored))
{
return _io_TextIOWrapper_close_impl(self);
}
/*[clinic end generated code: output=fc02f9e59bfa9956 input=a9049054013a1b77]*/
/*[clinic end generated code: output=a3614e1c64747ff5 input=a9049054013a1b77]*/

7
Modules/_io/textio.c
View file

@ -2650,11 +2650,16 @@ _io_TextIOWrapper_seek_impl(textio *self, PyObject *cookieObj, int whence)
/*[clinic input]
_io.TextIOWrapper.tell
Return the stream position as an opaque number.
The return value of tell() can be given as input to seek(), to restore a
previous stream position.
[clinic start generated code]*/
static PyObject *
_io_TextIOWrapper_tell_impl(textio *self)
/*[clinic end generated code: output=4f168c08bf34ad5f input=9a2caf88c24f9ddf]*/
/*[clinic end generated code: output=4f168c08bf34ad5f input=0852d627d76fb520]*/
{
PyObject *res;
PyObject *posobj = NULL;