cpython: 372abcca25fc (original) (raw)

--- a/Doc/library/fcntl.rst +++ b/Doc/library/fcntl.rst @@ -1,6 +1,5 @@ - -:mod:fcntl --- The :func:fcntl and :func:ioctl system calls -================================================================= +:mod:fcntl --- The fcntl and ioctl system calls +========================================================= .. module:: fcntl :platform: Unix @@ -18,7 +17,7 @@ interface to the :c:func:fcntl and :c: All functions in this module take a file descriptor fd as their first argument. This can be an integer file descriptor, such as returned by sys.stdin.fileno(), or a file object, such as sys.stdin itself, which -provides a :meth:fileno which returns a genuine file descriptor. +provides a :meth:~io.IOBase.fileno which returns a genuine file descriptor. The module defines the following functions: @@ -26,7 +25,8 @@ The module defines the following functio .. function:: fcntl(fd, op[, arg]) Perform the requested operation on file descriptor fd (file objects providing

• a :meth:fileno method are accepted as well). The operation is defined by op

• a :meth:~io.IOBase.fileno method are accepted as well). The operation is
• defined by op and is operating system dependent. These codes are also found in the :mod:fcntl module. The argument arg is optional, and defaults to the integer value 0. When present, it can either be an integer value, or a string. @@ -46,7 +46,7 @@ The module defines the following functio

.. function:: ioctl(fd, op[, arg[, mutate_flag]])

• This function is identical to the :func:fcntl function, except that the

• This function is identical to the :func:~fcntl.fcntl function, except that the operations are typically defined in the library module :mod:termios and the argument handling is even more complicated.

@@ -56,7 +56,8 @@ The module defines the following functio integer 0), an object supporting the read-only buffer interface (most likely a plain Python string) or an object supporting the read-write buffer interface.

• In all but the last case, behaviour is as for the :func:fcntl function.

• In all but the last case, behaviour is as for the :func:~fcntl.fcntl
• function. If a mutable buffer is passed, then the behaviour is determined by the value of the mutate_flag parameter. @@ -95,16 +96,16 @@ The module defines the following functio .. function:: flock(fd, op) Perform the lock operation op on file descriptor fd (file objects providing

• a :meth:fileno method are accepted as well). See the Unix manual

• a :meth:~io.IOBase.fileno method are accepted as well). See the Unix manual :manpage:flock(2) for details. (On some systems, this function is emulated using :c:func:fcntl.)

.. function:: lockf(fd, operation, [length, [start, [whence]]])

• This is essentially a wrapper around the :func:fcntl locking calls. fd is
• the file descriptor of the file to lock or unlock, and operation is one of the
• following values:

• This is essentially a wrapper around the :func:~fcntl.fcntl locking calls.
• fd is the file descriptor of the file to lock or unlock, and operation
• is one of the following values:
  • :const:LOCK_UN -- unlock
  • :const:LOCK_SH -- acquire a shared lock @@ -119,13 +120,13 @@ The module defines the following functio systems, :const:LOCK_EX can only be used if the file descriptor refers to a file opened for writing.

• length is the number of bytes to lock, start is the byte offset at which the
• lock starts, relative to whence, and whence is as with :func:fileobj.seek,
• specifically:

• length is the number of bytes to lock, start is the byte offset at
• which the lock starts, relative to whence, and whence is as with
• :func:io.IOBase.seek, specifically:

• • :const:0 -- relative to the start of the file (:const:SEEK_SET)
• • :const:1 -- relative to the current buffer position (:const:SEEK_CUR)
• • :const:2 -- relative to the end of the file (:const:SEEK_END)

• • :const:0 -- relative to the start of the file (:data:os.SEEK_SET)
• • :const:1 -- relative to the current buffer position (:data:os.SEEK_CUR)
• • :const:2 -- relative to the end of the file (:data:os.SEEK_END) The default for start is 0, which means to start at the beginning of the file. The default for length is 0 which means to lock to the end of the file. The @@ -150,7 +151,8 @@ lay-out for the lockdata variable is s .. seealso:: Module :mod:os

•  If the locking flags :const:`O_SHLOCK` and :const:`O_EXLOCK` are present[](#l1.95)

•  in the :mod:`os` module (on BSD only), the :func:`os.open` function[](#l1.96)

•  provides an alternative to the :func:`lockf` and :func:`flock` functions.[](#l1.97)

•  If the locking flags :data:`~os.O_SHLOCK` and :data:`~os.O_EXLOCK` are[](#l1.98)

•  present in the :mod:`os` module (on BSD only), the :func:`os.open`[](#l1.99)

•  function provides an alternative to the :func:`lockf` and :func:`flock`[](#l1.100)

•  functions.[](#l1.101)