mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-08-01 23:53:15 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 8

#14863: Update the documentation of os.fdopen()

Browse source 
There's no bufsize argument anymore, and os.fdopen() is only a very
thin wrapper around open() anymore. Change the documentation to
reflect that.
This commit is contained in:
Petri Lehtinen 2012-05-24 21:44:07 +03:00
parent 2fc5a50809
commit 1a01ebc41c
2 changed files with 8 additions and 15 deletions
Download patch file Download diff file Expand all files Collapse all files

20
Doc/library/os.rst
View file

@ -545,22 +545,12 @@ File Object Creation
These functions create new :term:`file objects <file object>`. (See also :func:`open`.)
.. function:: fdopen(fd[, mode[, bufsize]])
.. function:: fdopen(fd, *args, **kwargs)
.. index:: single: I/O control; buffering
Return an open file object connected to the file descriptor *fd*. The *mode*
and *bufsize* arguments have the same meaning as the corresponding arguments to
the built-in :func:`open` function.
When specified, the *mode* argument must start with one of the letters
``'r'``, ``'w'``, or ``'a'``, otherwise a :exc:`ValueError` is raised.
On Unix, when the *mode* argument starts with ``'a'``, the *O_APPEND* flag is
set on the file descriptor (which the :c:func:`fdopen` implementation already
does on most platforms).
Availability: Unix, Windows.
Return an open file object connected to the file descriptor *fd*.
This is an alias of :func:`open` and accepts the same arguments.
The only difference is that the first argument of :func:`fdopen`
must always be an integer.
.. _os-fd-ops: