Mirror
/
cpython
mirror of https://github.com/python/cpython
4
1
Fork 0
Code Issues Releases Wiki Activity

Issue #12760: Add some mising documentation about the new `x` exclusive 

creation flag to open().
This commit is contained in:
Charles-François Natali 2012-05-20 11:41:53 +02:00
parent 185f401308
commit b93f9fa700
1 changed files with 10 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
Doc/library/functions.rst
View File

@ -797,17 +797,19 @@ are always available. They are listed here in alphabetical order.
*mode* is an optional string that specifies the mode in which the file is *mode* is an optional string that specifies the mode in which the file is
opened. It defaults to ``'r'`` which means open for reading in text mode. opened. It defaults to ``'r'`` which means open for reading in text mode.
Other common values are ``'w'`` for writing (truncating the file if it Other common values are ``'w'`` for writing (truncating the file if it
already exists), and ``'a'`` for appending (which on *some* Unix systems, already exists), ``'x'`` for exclusive creation and ``'a'`` for appending
means that *all* writes append to the end of the file regardless of the (which on *some* Unix systems, means that *all* writes append to the end of
current seek position). In text mode, if *encoding* is not specified the the file regardless of the current seek position). In text mode, if
encoding used is platform dependent. (For reading and writing raw bytes use *encoding* is not specified the encoding used is platform dependent. (For
binary mode and leave *encoding* unspecified.) The available modes are: reading and writing raw bytes use binary mode and leave *encoding*
unspecified.) The available modes are:
========= =============================================================== ========= ===============================================================
Character Meaning Character Meaning
--------- --------------------------------------------------------------- --------- ---------------------------------------------------------------
``'r'`` open for reading (default) ``'r'`` open for reading (default)
``'w'`` open for writing, truncating the file first ``'w'`` open for writing, truncating the file first
``'x'`` open for exclusive creation, failing if the file already exists
``'a'`` open for writing, appending to the end of the file if it exists ``'a'`` open for writing, appending to the end of the file if it exists
``'b'`` binary mode ``'b'`` binary mode
``'t'`` text mode (default) ``'t'`` text mode (default)
@ -898,6 +900,7 @@ are always available. They are listed here in alphabetical order.
.. versionchanged:: 3.3 .. versionchanged:: 3.3
The *opener* parameter was added. The *opener* parameter was added.
The ``'x'`` mode was added.
The type of file object returned by the :func:`open` function depends on the The type of file object returned by the :func:`open` function depends on the
mode. When :func:`open` is used to open a file in a text mode (``'w'``, mode. When :func:`open` is used to open a file in a text mode (``'w'``,
@ -926,6 +929,8 @@ are always available. They are listed here in alphabetical order.
.. versionchanged:: 3.3 .. versionchanged:: 3.3
:exc:`IOError` used to be raised, it is now an alias of :exc:`OSError`. :exc:`IOError` used to be raised, it is now an alias of :exc:`OSError`.
:exc:`FileExistsError` is now raised if the file opened in exclusive
creation mode (``'x'``) already exists.
.. XXX works for bytes too, but should it? .. XXX works for bytes too, but should it?