wave: restore getparams() backward compatibility

Author: mbeijen

Doc/library/wave.rst

@@ -125,7 +125,7 @@ Wave_read Objects
    .. method:: getparams()
 
       Returns a :func:`~collections.namedtuple` ``(nchannels, sampwidth,
-      framerate, nframes, comptype, compname, format)``, equivalent to output
+      framerate, nframes, comptype, compname)``, equivalent to output
       of the ``get*()`` methods.
 
 
@@ -277,7 +277,7 @@ Wave_write Objects
    .. method:: getparams()
 
       Return a :func:`~collections.namedtuple`
-      ``(nchannels, sampwidth, framerate, nframes, comptype, compname, format)``
+      ``(nchannels, sampwidth, framerate, nframes, comptype, compname)``
       containing the current output parameters.
 
 

Doc/whatsnew/3.15.rst

@@ -1499,9 +1499,7 @@ wave
 * Added :meth:`wave.Wave_read.getformat`, :meth:`wave.Wave_write.getformat`,
   and :meth:`wave.Wave_write.setformat` for explicit frame format handling.
 
-* :meth:`wave.Wave_read.getparams` and :meth:`wave.Wave_write.getparams` now
-  include ``format`` as the seventh field in the returned named tuple.
-  :meth:`wave.Wave_write.setparams` accepts both 7-item tuples including
+* :meth:`wave.Wave_write.setparams` accepts both 7-item tuples including
   ``format`` and 6-item tuples for backwards compatibility (defaulting to
   ``WAVE_FORMAT_PCM``).
 

Lib/test/audiotests.py

@@ -38,14 +38,13 @@ def check_params(self, f, nchannels, sampwidth, framerate, nframes,
 
         params = f.getparams()
         self.assertEqual(params,
-                (nchannels, sampwidth, framerate, nframes, comptype, compname, format))
+            (nchannels, sampwidth, framerate, nframes, comptype, compname))
         self.assertEqual(params.nchannels, nchannels)
         self.assertEqual(params.sampwidth, sampwidth)
         self.assertEqual(params.framerate, framerate)
         self.assertEqual(params.nframes, nframes)
         self.assertEqual(params.comptype, comptype)
         self.assertEqual(params.compname, compname)
-        self.assertEqual(params.format, format)
 
         for proto in range(pickle.HIGHEST_PROTOCOL + 1):
             dump = pickle.dumps(params, proto)

Lib/test/test_wave.py

@@ -193,7 +193,7 @@ def test_setparams_7_tuple_uses_format(self):
                          wave.WAVE_FORMAT_IEEE_FLOAT))
             self.assertEqual(w.getformat(), wave.WAVE_FORMAT_IEEE_FLOAT)
 
-    def test_getparams_has_format_field(self):
+    def test_getparams_backward_compatible_shape(self):
         with tempfile.NamedTemporaryFile(delete_on_close=False) as fp:
             filename = fp.name
         self.addCleanup(unlink, filename)
@@ -202,8 +202,7 @@ def test_getparams_has_format_field(self):
             w.setparams((1, 2, 22050, 0, 'NONE', 'not compressed',
                          wave.WAVE_FORMAT_IEEE_FLOAT))
             params = w.getparams()
-            self.assertEqual(params.format, wave.WAVE_FORMAT_IEEE_FLOAT)
-            self.assertEqual(params[:6], (1, 2, 22050, 0, 'NONE', 'not compressed'))
+            self.assertEqual(params, (1, 2, 22050, 0, 'NONE', 'not compressed'))
 
     def test_getformat_setformat(self):
         with tempfile.NamedTemporaryFile(delete_on_close=False) as fp:

Lib/wave.py

@@ -93,8 +93,7 @@ class Error(Exception):
 _array_fmts = None, 'b', 'h', None, 'i'
 
 _wave_params = namedtuple('_wave_params',
-                     'nchannels sampwidth framerate nframes comptype compname format',
-                     defaults=(WAVE_FORMAT_PCM,))
+                     'nchannels sampwidth framerate nframes comptype compname')
 
 
 def _byteswap(data, width):
@@ -350,8 +349,7 @@ def getcompname(self):
     def getparams(self):
         return _wave_params(self.getnchannels(), self.getsampwidth(),
                        self.getframerate(), self.getnframes(),
-                       self.getcomptype(), self.getcompname(),
-                       self.getformat())
+                       self.getcomptype(), self.getcompname())
 
     def setpos(self, pos):
         if pos < 0 or pos > self._nframes:
@@ -572,7 +570,7 @@ def getparams(self):
         if not self._nchannels or not self._sampwidth or not self._framerate:
             raise Error('not all parameters set')
         return _wave_params(self._nchannels, self._sampwidth, self._framerate,
-              self._nframes, self._comptype, self._compname, self._format)
+              self._nframes, self._comptype, self._compname)
 
     def tell(self):
         return self._nframeswritten