diff options
author | Victor Stinner <victor.stinner@gmail.com> | 2014-07-24 10:42:45 (GMT) |
---|---|---|
committer | Victor Stinner <victor.stinner@gmail.com> | 2014-07-24 10:42:45 (GMT) |
commit | 992019c0061d62ccb5e0715675ddf3aa2d1b6478 (patch) | |
tree | 69a999da17b811396483f124fc222622091196e8 | |
parent | 6d4f4feca2313bf626346b8a5b8a45fca7263038 (diff) | |
download | cpython-992019c0061d62ccb5e0715675ddf3aa2d1b6478.zip cpython-992019c0061d62ccb5e0715675ddf3aa2d1b6478.tar.gz cpython-992019c0061d62ccb5e0715675ddf3aa2d1b6478.tar.bz2 |
Backport os.rst documentation from Python 3.5.
-rw-r--r-- | Doc/library/os.rst | 31 |
1 files changed, 28 insertions, 3 deletions
diff --git a/Doc/library/os.rst b/Doc/library/os.rst index cf704e8..bb751f4 100644 --- a/Doc/library/os.rst +++ b/Doc/library/os.rst @@ -1094,8 +1094,16 @@ or `the MSDN <http://msdn.microsoft.com/en-us/library/z0kc8e3z.aspx>`_ on Window All platforms support sockets as *out* file descriptor, and some platforms allow other types (e.g. regular file, pipe) as well. + Cross-platform applications should not use *headers*, *trailers* and *flags* + arguments. + Availability: Unix. + .. note:: + + For a higher-level wrapper of :func:`sendfile`, see + :mod:`socket.socket.sendfile`. + .. versionadded:: 3.3 @@ -2836,10 +2844,27 @@ written in Python, such as a mail server's external command delivery program. Availability: Unix. -.. function:: popen(...) +.. function:: popen(command, mode='r', buffering=-1) + + Open a pipe to or from *command*. The return value is an open file object + connected to the pipe, which can be read or written depending on whether *mode* + is ``'r'`` (default) or ``'w'``. The *buffering* argument has the same meaning as + the corresponding argument to the built-in :func:`open` function. The + returned file object reads or writes text strings rather than bytes. + + The ``close`` method returns :const:`None` if the subprocess exited + successfully, or the subprocess's return code if there was an + error. On POSIX systems, if the return code is positive it + represents the return value of the process left-shifted by one + byte. If the return code is negative, the process was terminated + by the signal given by the negated value of the return code. (For + example, the return value might be ``- signal.SIGKILL`` if the + subprocess was killed.) On Windows systems, the return value + contains the signed integer return code from the child process. - Run child processes, returning opened pipes for communications. These functions - are described in section :ref:`os-newstreams`. + This is implemented using :class:`subprocess.Popen`; see that class's + documentation for more powerful ways to manage and communicate with + subprocesses. .. function:: spawnl(mode, path, ...) |