Issue #1512791: In setframerate method of Wave_write, round non-integral

mdickinson · mdickinson · commit 64a38c0eb5b7 · 2010-08-28T17:22:16.000Z
inputs to the nearest integer.  Thanks Neil Tallim for the patch.
diff --git a/Doc/library/wave.rst b/Doc/library/wave.rst
@@ -157,6 +157,10 @@ Wave_write objects, as returned by :func:`.open`, have the following methods:
 
    Set the frame rate to *n*.
 
+   .. versionchanged:: 3.2
+      A non-integral input to this method is rounded to the nearest
+      integer.
+
 
 .. method:: Wave_write.setnframes(n)
 
diff --git a/Lib/test/test_wave.py b/Lib/test/test_wave.py
@@ -22,11 +22,14 @@ def tearDown(self):
         except OSError:
             pass
 
-    def test_it(self):
+    def test_it(self, test_rounding=False):
         self.f = wave.open(TESTFN, 'wb')
         self.f.setnchannels(nchannels)
         self.f.setsampwidth(sampwidth)
-        self.f.setframerate(framerate)
+        if test_rounding:
+            self.f.setframerate(framerate - 0.1)
+        else:
+            self.f.setframerate(framerate)
         self.f.setnframes(nframes)
         output = b'\0' * nframes * nchannels * sampwidth
         self.f.writeframes(output)
@@ -39,6 +42,13 @@ def test_it(self):
         self.assertEqual(nframes, self.f.getnframes())
         self.assertEqual(self.f.readframes(nframes), output)
 
+    def test_fractional_framerate(self):
+        """
+        Addresses [ 1512791 ] module wave does no rounding
+        Floating point framerates should be rounded, rather than truncated.
+        """
+        self.test_it(test_rounding=True)
+
     def test_issue7681(self):
         self.f = wave.open(TESTFN, 'wb')
         self.f.setnchannels(nchannels)
diff --git a/Lib/wave.py b/Lib/wave.py
@@ -355,7 +355,7 @@ def setframerate(self, framerate):
             raise Error('cannot change parameters after starting to write')
         if framerate <= 0:
             raise Error('bad frame rate')
-        self._framerate = framerate
+        self._framerate = int(round(framerate))
 
     def getframerate(self):
         if not self._framerate:
diff --git a/Misc/ACKS b/Misc/ACKS
@@ -792,6 +792,7 @@ Paul Swartz
 Thenault Sylvain
 Péter Szabó
 Arfrever Frehtes Taifersar Arahesis
+Neil Tallim
 Geoff Talvola
 Musashi Tamura
 William Tanksley
diff --git a/Misc/NEWS b/Misc/NEWS
@@ -132,6 +132,9 @@ Extensions
 Library
 -------
 
+- Issue #1512791: In setframerate() in the wave module, non-integral
+  frame rates are rounded to the nearest integer.
+
 - Issue #8797: urllib2 does a retry for Basic Authentication failure instead of
   falling into recursion.
 
