(original) (raw)

changeset: 77079:ef406c4c6463 parent: 77076:ca2a793d6c7b user: Charles-François Natali neologix@free.fr date: Sun May 20 11:41:53 2012 +0200 files: Doc/library/functions.rst description: Issue #12760: Add some mising documentation about the new `x` exclusive creation flag to open(). diff -r ca2a793d6c7b -r ef406c4c6463 Doc/library/functions.rst --- a/Doc/library/functions.rst Sun May 20 16:58:59 2012 +0800 +++ b/Doc/library/functions.rst Sun May 20 11:41:53 2012 +0200 @@ -797,17 +797,19 @@ *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. Other common values are ``'w'`` for writing (truncating the file if it - already exists), and ``'a'`` for appending (which on *some* Unix systems, - means that *all* writes append to the end of the file regardless of the - current seek position). In text mode, if *encoding* is not specified the - encoding used is platform dependent. (For reading and writing raw bytes use - binary mode and leave *encoding* unspecified.) The available modes are: + already exists), ``'x'`` for exclusive creation and ``'a'`` for appending + (which on *some* Unix systems, means that *all* writes append to the end of + the file regardless of the current seek position). In text mode, if + *encoding* is not specified the encoding used is platform dependent. (For + reading and writing raw bytes use binary mode and leave *encoding* + unspecified.) The available modes are: ========= =============================================================== Character Meaning --------- --------------------------------------------------------------- ``'r'`` open for reading (default) ``'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 ``'b'`` binary mode ``'t'`` text mode (default) @@ -898,6 +900,7 @@ .. versionchanged:: 3.3 The *opener* parameter was added. + The ``'x'`` mode was added. 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'``, @@ -926,6 +929,8 @@ .. versionchanged:: 3.3 :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? /neologix@free.fr