From 5bd9270954f5f6bbf46fd32eec1ad9e81aa8eb79 Mon Sep 17 00:00:00 2001 From: =?utf8?q?=C3=89ric=20Araujo?= Date: Thu, 22 Nov 2012 00:13:49 -0500 Subject: [PATCH] =?utf8?q?Address=20reviews=20for=20open=E2=80=99s=20opene?= =?utf8?q?r=20argument=20doc=20patch=20(#13424).?= MIME-Version: 1.0 Content-Type: text/plain; charset=utf8 Content-Transfer-Encoding: 8bit * Remove example deemed not helpful. * Simplify the other one. * Add missing target to ref. --- Doc/library/functions.rst | 26 ++++---------------------- 1 file changed, 4 insertions(+), 22 deletions(-) diff --git a/Doc/library/functions.rst b/Doc/library/functions.rst index f027bac710..a92c378c66 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 ` 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) ... -- 2.40.0