summaryrefslogtreecommitdiffstats
path: root/Modules
diff options
context:
space:
mode:
Diffstat (limited to 'Modules')
-rw-r--r--Modules/clinic/posixmodule.c.h17
-rw-r--r--Modules/posixmodule.c13
2 files changed, 22 insertions, 8 deletions
diff --git a/Modules/clinic/posixmodule.c.h b/Modules/clinic/posixmodule.c.h
index 3312bd6..5924c4a 100644
--- a/Modules/clinic/posixmodule.c.h
+++ b/Modules/clinic/posixmodule.c.h
@@ -6496,13 +6496,22 @@ exit:
#endif /* defined(HAVE_LOCKF) */
PyDoc_STRVAR(os_lseek__doc__,
-"lseek($module, fd, position, how, /)\n"
+"lseek($module, fd, position, whence, /)\n"
"--\n"
"\n"
"Set the position of a file descriptor. Return the new position.\n"
"\n"
-"Return the new cursor position in number of bytes\n"
-"relative to the beginning of the file.");
+" fd\n"
+" An open file descriptor, as returned by os.open().\n"
+" position\n"
+" Position, interpreted relative to \'whence\'.\n"
+" whence\n"
+" The relative position to seek from. Valid values are:\n"
+" - SEEK_SET: seek from the start of the file.\n"
+" - SEEK_CUR: seek from the current file position.\n"
+" - SEEK_END: seek from the end of the file.\n"
+"\n"
+"The return value is the number of bytes relative to the beginning of the file.");
#define OS_LSEEK_METHODDEF \
{"lseek", _PyCFunction_CAST(os_lseek), METH_FASTCALL, os_lseek__doc__},
@@ -11990,4 +11999,4 @@ exit:
#ifndef OS_WAITSTATUS_TO_EXITCODE_METHODDEF
#define OS_WAITSTATUS_TO_EXITCODE_METHODDEF
#endif /* !defined(OS_WAITSTATUS_TO_EXITCODE_METHODDEF) */
-/*[clinic end generated code: output=9d8b0d6717c9af54 input=a9049054013a1b77]*/
+/*[clinic end generated code: output=6646be70849f971f input=a9049054013a1b77]*/
diff --git a/Modules/posixmodule.c b/Modules/posixmodule.c
index b9f45c0..44cc31b 100644
--- a/Modules/posixmodule.c
+++ b/Modules/posixmodule.c
@@ -10421,19 +10421,24 @@ os_lockf_impl(PyObject *module, int fd, int command, Py_off_t length)
os.lseek -> Py_off_t
fd: int
+ An open file descriptor, as returned by os.open().
position: Py_off_t
- how: int
+ Position, interpreted relative to 'whence'.
+ whence as how: int
+ The relative position to seek from. Valid values are:
+ - SEEK_SET: seek from the start of the file.
+ - SEEK_CUR: seek from the current file position.
+ - SEEK_END: seek from the end of the file.
/
Set the position of a file descriptor. Return the new position.
-Return the new cursor position in number of bytes
-relative to the beginning of the file.
+The return value is the number of bytes relative to the beginning of the file.
[clinic start generated code]*/
static Py_off_t
os_lseek_impl(PyObject *module, int fd, Py_off_t position, int how)
-/*[clinic end generated code: output=971e1efb6b30bd2f input=902654ad3f96a6d3]*/
+/*[clinic end generated code: output=971e1efb6b30bd2f input=f096e754c5367504]*/
{
Py_off_t result;