mirrors
/
cpython
mirror of https://github.com/python/cpython.git
2
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Fixup reST syntax errors and streamline docs of PEP 446.

This commit is contained in:
Georg Brandl 2013-09-15 10:37:57 +02:00
parent c76aa4832b
commit 5642ff9d8e
2 changed files with 16 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
Doc/library/os.rst
View File

@ -1206,41 +1206,40 @@ Querying the size of a terminal
Inheritance of File Descriptors
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
A file descriptor has a inheritable flag which indicates if the file descriptor
can be inherited or not in child processes. Since Python 3.4, file descriptors
.. versionadded:: 3.4
A file descriptor has an "inheritable" flag which indicates if the file descriptor
can be inherited by child processes. Since Python 3.4, file descriptors
created by Python are non-inheritable by default.
On UNIX, non-inheritable file descriptors are closed in child processes at the
execution of a new program, other file descriptors are inherited.
On Windows, non-inheritable handles and file descriptors are closed in child
processes, except standard streams (file descriptors 0, 1 and 2: stdin, stdout
and stderr) which are always inherited. Using :func:`os.spawn*` functions,
processes, except for standard streams (file descriptors 0, 1 and 2: stdin, stdout
and stderr), which are always inherited. Using :func:`os.spawn*` functions,
all inheritable handles and all inheritable file descriptors are inherited.
Using the :mod:`subprocess` module, all file descriptors except standard
streams are closed, inheritable handles are only inherited if the *close_fds*
parameter is ``False``.
.. versionadded:: 3.4
streams are closed, and inheritable handles are only inherited if the
*close_fds* parameter is ``False``.
.. function:: get_inheritable(fd)
Get the `inheritable flag <fd_inheritance>`_ of the specified file
descriptor. Return a :class:`bool`.
Get the "inheritable" flag of the specified file descriptor (a boolean).
.. function:: set_inheritable(fd, inheritable)
Set the `inheritable flag <fd_inheritance>`_ of the specified file descriptor.
Set the "inheritable" flag of the specified file descriptor.
.. function:: get_handle_inheritable(handle)
Get the `inheritable flag <fd_inheritance>`_ of the specified handle. Return a :class:`bool`.
Get the "inheritable" flag of the specified handle (a boolean).
Availability: Windows.
.. function:: set_handle_inheritable(handle, inheritable)
Set the `inheritable flag <fd_inheritance>`_ of the specified handle.
Set the "inheritable" flag of the specified handle.
Availability: Windows.

8
Doc/whatsnew/3.4.rst
View File

@ -126,8 +126,8 @@ Please read on for a comprehensive list of user-facing changes.
PEP 446: Make newly created file descriptors non-inheritable
============================================================
The :pep:`446` makes newly created file descriptors `non-inheritable
<fd_inheritance>`_. New functions and methods:
The :pep:`446` makes newly created file descriptors :ref:`non-inheritable
<fd_inheritance>`. New functions and methods:
* :func:`os.get_inheritable`, :func:`os.set_inheritable`
* :func:`os.get_handle_inheritable`, :func:`os.set_handle_inheritable`
@ -318,8 +318,8 @@ try/except statement by code that only cares whether or not an error occurred.
socket
------
Socket objects have new methods to get or set their `inheritable flag
<fd_inheritance>`_:
Socket objects have new methods to get or set their :ref:`inheritable flag
<fd_inheritance>`:
* :meth:`socket.socket.get_inheritable`, :meth:`socket.socket.set_inheritable`