diff options
author | Éric Araujo <merwok@netwok.org> | 2012-11-22 05:13:49 (GMT) |
---|---|---|
committer | Éric Araujo <merwok@netwok.org> | 2012-11-22 05:13:49 (GMT) |
commit | 5bd9270954f5f6bbf46fd32eec1ad9e81aa8eb79 (patch) | |
tree | 7830c398385919bc80a892e182963e5da7f124b2 /Doc/library/functions.rst | |
parent | f81a84df9a379adb5bbbc18e8455699b7e898962 (diff) | |
download | cpython-5bd9270954f5f6bbf46fd32eec1ad9e81aa8eb79.zip cpython-5bd9270954f5f6bbf46fd32eec1ad9e81aa8eb79.tar.gz cpython-5bd9270954f5f6bbf46fd32eec1ad9e81aa8eb79.tar.bz2 |
Address reviews for open’s opener argument doc patch (#13424).
* Remove example deemed not helpful.
* Simplify the other one.
* Add missing target to ref.
Diffstat (limited to 'Doc/library/functions.rst')
-rw-r--r-- | Doc/library/functions.rst | 26 |
1 files changed, 4 insertions, 22 deletions
diff --git a/Doc/library/functions.rst b/Doc/library/functions.rst index f027bac..a92c378 100644 --- a/Doc/library/functions.rst +++ b/Doc/library/functions.rst @@ -937,32 +937,14 @@ are always available. They are listed here in alphabetical order. :mod:`os.open` as *opener* results in functionality similar to passing ``None``). - The following example is an alternative implementation for opening files - for exclusive writing. If we did not have support for the ``'x'`` mode, - we could implement it with this opener:: - - >>> import os - >>> def open_exclusive(path, mode): - ... return os.open(path, mode | os.O_CREAT | os.O_EXCL) - ... - >>> filename = 'spam.txt' - >>> fp = open(filename, 'w', opener=open_exclusive) - >>> fp2 = open(filename, 'w', opener=open_exclusive) - Traceback (most recent call last): - ... - FileExistsError: [Errno 17] File exists: 'spam.txt' - - This other example uses the :ref:`dir_fd` parameter of the + The following example uses the :ref:`dir_fd <dir_fd>` parameter of the :func:`os.open` function to open a file relative to a given directory:: >>> import os - >>> def open_relative(dirname): - ... dir_fd = os.open(dirname, os.O_RDONLY) - ... def opener(path, flags): - ... return os.open(path, flags, dir_fd=dir_fd) - ... return opener, dir_fd + >>> dir_fd = os.open('somedir', os.O_RDONLY) + >>> def opener(path, flags): + ... return os.open(path, flags, dir_fd=dir_fd) ... - >>> opener, dir_fd = open_relative('somedir') >>> with open('spamspam.txt', 'w', opener=opener) as f: ... print('This will be written to somedir/spamspam.txt', file=f) ... |