diff options
Diffstat (limited to 'Doc')
| -rw-r--r-- | Doc/library/aifc.rst | 3 | ||||
| -rw-r--r-- | Doc/library/difflib.rst | 2 | ||||
| -rw-r--r-- | Doc/library/email.iterators.rst | 2 | ||||
| -rw-r--r-- | Doc/library/email.policy.rst | 2 | ||||
| -rw-r--r-- | Doc/library/enum.rst | 10 | ||||
| -rw-r--r-- | Doc/library/unittest.rst | 6 | ||||
| -rw-r--r-- | Doc/library/wave.rst | 5 | ||||
| -rw-r--r-- | Doc/tutorial/inputoutput.rst | 13 | ||||
| -rw-r--r-- | Doc/whatsnew/3.4.rst | 5 |
9 files changed, 31 insertions, 17 deletions
diff --git a/Doc/library/aifc.rst b/Doc/library/aifc.rst index c1cd215c3f..44a0a24ff5 100644 --- a/Doc/library/aifc.rst +++ b/Doc/library/aifc.rst @@ -51,7 +51,8 @@ Module :mod:`aifc` defines the following function: used for writing, the file object should be seekable, unless you know ahead of time how many samples you are going to write in total and use :meth:`writeframesraw` and :meth:`setnframes`. - Objects returned by :func:`.open` also supports the :keyword:`with` statement. + The :func:`.open` function may be used in a :keyword:`with` statement. When + the :keyword:`with` block completes, the :meth:`~aifc.close` method is called. .. versionchanged:: 3.4 Support for the :keyword:`with` statement was added. diff --git a/Doc/library/difflib.rst b/Doc/library/difflib.rst index 836e240b83..ad1466efaa 100644 --- a/Doc/library/difflib.rst +++ b/Doc/library/difflib.rst @@ -752,7 +752,7 @@ It is also contained in the Python source distribution, as # we're passing these as arguments to the diff function fromdate = time.ctime(os.stat(fromfile).st_mtime) todate = time.ctime(os.stat(tofile).st_mtime) - with open(fromlines) as fromf, open(tofile) as tof: + with open(fromfile) as fromf, open(tofile) as tof: fromlines, tolines = list(fromf), list(tof) if options.u: diff --git a/Doc/library/email.iterators.rst b/Doc/library/email.iterators.rst index 6c7200f98a..7882718695 100644 --- a/Doc/library/email.iterators.rst +++ b/Doc/library/email.iterators.rst @@ -68,7 +68,7 @@ The following function has been added as a useful debugging tool. It should text/plain text/plain - .. testcleanup:: + .. testsetup:: >>> somefile.close() diff --git a/Doc/library/email.policy.rst b/Doc/library/email.policy.rst index d85054ac83..54ebb1cf11 100644 --- a/Doc/library/email.policy.rst +++ b/Doc/library/email.policy.rst @@ -85,7 +85,7 @@ file on disk and pass it to the system ``sendmail`` program on a Unix system: >>> p.stdin.close() >>> rc = p.wait() -.. testcleanup:: +.. testsetup:: >>> mymsg.close() >>> mocker.stop() diff --git a/Doc/library/enum.rst b/Doc/library/enum.rst index 1e464d7361..686470534d 100644 --- a/Doc/library/enum.rst +++ b/Doc/library/enum.rst @@ -483,7 +483,7 @@ Avoids having to specify the value for each enumeration member:: ... def __new__(cls): ... value = len(cls.__members__) + 1 ... obj = object.__new__(cls) - ... obj._value = value + ... obj._value_ = value ... return obj ... >>> class Color(AutoNumber): @@ -505,19 +505,19 @@ enumerations):: >>> class OrderedEnum(Enum): ... def __ge__(self, other): ... if self.__class__ is other.__class__: - ... return self._value >= other._value + ... return self.value >= other.value ... return NotImplemented ... def __gt__(self, other): ... if self.__class__ is other.__class__: - ... return self._value > other._value + ... return self.value > other.value ... return NotImplemented ... def __le__(self, other): ... if self.__class__ is other.__class__: - ... return self._value <= other._value + ... return self.value <= other.value ... return NotImplemented ... def __lt__(self, other): ... if self.__class__ is other.__class__: - ... return self._value < other._value + ... return self.value < other.value ... return NotImplemented ... >>> class Grade(OrderedEnum): diff --git a/Doc/library/unittest.rst b/Doc/library/unittest.rst index a5c4783682..6c9f2f1868 100644 --- a/Doc/library/unittest.rst +++ b/Doc/library/unittest.rst @@ -974,12 +974,12 @@ Test cases Test that a warning is triggered when *callable* is called with any positional or keyword arguments that are also passed to :meth:`assertWarns`. The test passes if *warning* is triggered and - fails if it isn't. Also, any unexpected exception is an error. + fails if it isn't. Any exception is an error. To catch any of a group of warnings, a tuple containing the warning classes may be passed as *warnings*. If only the *warning* and possibly the *msg* arguments are given, - returns a context manager so that the code under test can be written + return a context manager so that the code under test can be written inline rather than as a function:: with self.assertWarns(SomeWarning): @@ -992,7 +992,7 @@ Test cases :attr:`warning` attribute, and the source line which triggered the warnings in the :attr:`filename` and :attr:`lineno` attributes. This can be useful if the intention is to perform additional checks - on the exception raised:: + on the warning caught:: with self.assertWarns(SomeWarning) as cm: do_something() diff --git a/Doc/library/wave.rst b/Doc/library/wave.rst index 2e64d00305..c52af89774 100644 --- a/Doc/library/wave.rst +++ b/Doc/library/wave.rst @@ -39,6 +39,11 @@ The :mod:`wave` module defines the following function and exception: :meth:`close` method is called; it is the caller's responsibility to close the file object. + The :func:`.open` function may be used in a :keyword:`with` statement. When + the :keyword:`with` block completes, the :meth:`Wave_read.close() + <wave.Wave_read.close>` or :meth:`Wave_write.close() + <wave.Wave_write.close()>` method is called. + .. function:: openfp(file, mode) diff --git a/Doc/tutorial/inputoutput.rst b/Doc/tutorial/inputoutput.rst index 744abab988..7daf89b79b 100644 --- a/Doc/tutorial/inputoutput.rst +++ b/Doc/tutorial/inputoutput.rst @@ -322,9 +322,11 @@ first:: >>> f.write(s) 18 -``f.tell()`` returns an integer giving the file object's current position in the -file, measured in bytes from the beginning of the file. To change the file -object's position, use ``f.seek(offset, from_what)``. The position is computed +``f.tell()`` returns an integer giving the file object's current position in the file +represented as number of bytes from the beginning of the file when in `binary mode` and +an opaque number when in `text mode`. + +To change the file object's position, use ``f.seek(offset, from_what)``. The position is computed from adding *offset* to a reference point; the reference point is selected by the *from_what* argument. A *from_what* value of 0 measures from the beginning of the file, 1 uses the current file position, and 2 uses the end of the file as @@ -345,7 +347,10 @@ beginning of the file as the reference point. :: In text files (those opened without a ``b`` in the mode string), only seeks relative to the beginning of the file are allowed (the exception being seeking -to the very file end with ``seek(0, 2)``). +to the very file end with ``seek(0, 2)``) and the only valid *offset* values are +those returned from the ``f.tell()``, or zero. Any other *offset* value produces +undefined behaviour. + When you're done with a file, call ``f.close()`` to close it and free up any system resources taken up by the open file. After calling ``f.close()``, diff --git a/Doc/whatsnew/3.4.rst b/Doc/whatsnew/3.4.rst index 17cec3f2ad..2575170f44 100644 --- a/Doc/whatsnew/3.4.rst +++ b/Doc/whatsnew/3.4.rst @@ -239,8 +239,11 @@ wave The :meth:`~wave.getparams` method now returns a namedtuple rather than a plain tuple. (Contributed by Claudiu Popa in :issue:`17487`.) +:meth:`wave.open` now supports the context manager protocol. (Contributed +by Claudiu Popa in :issue:`17616`.) + stat ---- +---- The stat module is now backed by a C implementation in :mod:`_stat`. A C implementation is required as most of the values aren't standardized and |