Skip to content

gh-144975: Fix wave.Wave_write.setframerate() validation order #144976

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
mbeijen wants to merge 2 commits into
base: main
Choose a base branch
from
+38 −1
Open

gh-144975: Fix wave.Wave_write.setframerate() validation order #144976

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0273641
gh-144975: Fix wave.Wave_write.setframerate() validation order
mbeijen Feb 18, 2026
40a8fea
Merge branch 'main' into wave-setframerate
mbeijen Feb 18, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 33 additions & 0 deletions Lib/test/test_wave.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -207,6 +207,39 @@ def test_open_in_write_raises(self):
support.gc_collect()
self.assertIsNone(cm.unraisable)

def test_setframerate_rounds_then_validates(self):
"""Test that setframerate rounds before validation"""
# Test that framerates that round to 0 or negative are rejected
with wave.open(io.BytesIO(), 'wb') as f:
f.setnchannels(1)
f.setsampwidth(2)
# 0.5 rounds to 0, should raise
with self.assertRaises(wave.Error):
f.setframerate(0.5)
# 0.4 rounds to 0, should raise
with self.assertRaises(wave.Error):
f.setframerate(0.4)
# Negative values should still raise
with self.assertRaises(wave.Error):
f.setframerate(-1)
with self.assertRaises(wave.Error):
f.setframerate(-0.5)
# 0 should raise
with self.assertRaises(wave.Error):
f.setframerate(0)

# Valid values that round to positive integers should work
f.setframerate(1.4) # rounds to 1
self.assertEqual(f.getframerate(), 1)
f.setframerate(1.5) # rounds to 2
self.assertEqual(f.getframerate(), 2)
f.setframerate(1.6) # rounds to 2
self.assertEqual(f.getframerate(), 2)
f.setframerate(44100.4) # rounds to 44100
self.assertEqual(f.getframerate(), 44100)
f.setframerate(44100.5) # rounds to 44100
self.assertEqual(f.getframerate(), 44100)


class WaveOpen(unittest.TestCase):
def test_open_pathlike(self):
Expand Down
3 changes: 2 additions & 1 deletion Lib/wave.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -493,9 +493,10 @@ def getsampwidth(self):
def setframerate(self, framerate):
if self._datawritten:
raise Error('cannot change parameters after starting to write')
framerate = int(round(framerate))
if framerate <= 0:
raise Error('bad frame rate')
self._framerate = int(round(framerate))
self._framerate = framerate

def getframerate(self):
if not self._framerate:
Expand Down
3 changes: 3 additions & 0 deletions Misc/NEWS.d/next/Library/2026-02-18-21-45-00.gh-issue-144975.Ab3XyZ.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
:meth:`wave.Wave_write.setframerate` now validates the frame rate after
rounding to an integer, preventing values like ``0.5`` from being accepted
and causing confusing errors later. Patch by Michiel Beijen.
Loading