Skip to content

gh-133873: remove mark interface for wave.Wave_{read,write} objects #133874

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.

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

Merged
merged 6 commits into from
May 15, 2025
Merged
Changes from all commits
Commits
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
3 changes: 1 addition & 2 deletions Doc/deprecations/pending-removal-in-3.15.rst
Original file line number Diff line number Diff line change
@@ -99,8 +99,7 @@ Pending removal in Python 3.15

* :mod:`wave`:

* The :meth:`~wave.Wave_read.getmark`, :meth:`!setmark`,
and :meth:`~wave.Wave_read.getmarkers` methods of
* The ``getmark()``, ``setmark()`` and ``getmarkers()`` methods of
the :class:`~wave.Wave_read` and :class:`~wave.Wave_write` classes
have been deprecated since Python 3.13.

20 changes: 0 additions & 20 deletions Doc/library/wave.rst
Original file line number Diff line number Diff line change
@@ -123,26 +123,6 @@ Wave_read Objects

Rewind the file pointer to the beginning of the audio stream.

The following two methods are defined for compatibility with the old :mod:`!aifc`
module, and don't do anything interesting.


.. method:: getmarkers()

Returns ``None``.

.. deprecated-removed:: 3.13 3.15
The method only existed for compatibility with the :mod:`!aifc` module
which has been removed in Python 3.13.


.. method:: getmark(id)

Raise an error.

.. deprecated-removed:: 3.13 3.15
The method only existed for compatibility with the :mod:`!aifc` module
which has been removed in Python 3.13.

The following two methods define a term "position" which is compatible between
them, and is otherwise implementation dependent.
3 changes: 1 addition & 2 deletions Doc/whatsnew/3.13.rst
Original file line number Diff line number Diff line change
@@ -1995,8 +1995,7 @@ New Deprecations

* :mod:`wave`:

* Deprecate the :meth:`~wave.Wave_read.getmark`, :meth:`!setmark`,
and :meth:`~wave.Wave_read.getmarkers` methods of
* Deprecate the ``getmark()``, ``setmark()`` and ``getmarkers()`` methods of
the :class:`~wave.Wave_read` and :class:`~wave.Wave_write` classes,
to be removed in Python 3.15.
(Contributed by Victor Stinner in :gh:`105096`.)
9 changes: 9 additions & 0 deletions Doc/whatsnew/3.15.rst
Original file line number Diff line number Diff line change
@@ -144,6 +144,15 @@ typing
(Contributed by Bénédikt Tran in :gh:`133823`.)


wave
----

* Removed the ``getmark()``, ``setmark()`` and ``getmarkers()`` methods
of the :class:`~wave.Wave_read` and :class:`~wave.Wave_write` classes,
which were deprecated since Python 3.13.
(Contributed by Bénédikt Tran in :gh:`133873`.)


Porting to Python 3.15
======================

26 changes: 0 additions & 26 deletions Lib/test/test_wave.py
Original file line number Diff line number Diff line change
@@ -136,32 +136,6 @@ def test__all__(self):
not_exported = {'WAVE_FORMAT_PCM', 'WAVE_FORMAT_EXTENSIBLE', 'KSDATAFORMAT_SUBTYPE_PCM'}
support.check__all__(self, wave, not_exported=not_exported)

def test_read_deprecations(self):
filename = support.findfile('pluck-pcm8.wav', subdir='audiodata')
with wave.open(filename) as reader:
with self.assertWarns(DeprecationWarning):
with self.assertRaises(wave.Error):
reader.getmark('mark')
with self.assertWarns(DeprecationWarning):
self.assertIsNone(reader.getmarkers())

def test_write_deprecations(self):
with io.BytesIO(b'') as tmpfile:
with wave.open(tmpfile, 'wb') as writer:
writer.setnchannels(1)
writer.setsampwidth(1)
writer.setframerate(1)
writer.setcomptype('NONE', 'not compressed')

with self.assertWarns(DeprecationWarning):
with self.assertRaises(wave.Error):
writer.setmark(0, 0, 'mark')
with self.assertWarns(DeprecationWarning):
with self.assertRaises(wave.Error):
writer.getmark('mark')
with self.assertWarns(DeprecationWarning):
self.assertIsNone(writer.getmarkers())


class WaveLowLevelTest(unittest.TestCase):

29 changes: 0 additions & 29 deletions Lib/wave.py
Original file line number Diff line number Diff line change
@@ -20,10 +20,6 @@
compression type ('not compressed' linear samples)
getparams() -- returns a namedtuple consisting of all of the
above in the above order
getmarkers() -- returns None (for compatibility with the
old aifc module)
getmark(id) -- raises an error since the mark does not
exist (for compatibility with the old aifc module)
readframes(n) -- returns at most n frames of audio
rewind() -- rewind to the beginning of the audio stream
setpos(pos) -- seek to the specified position
@@ -341,16 +337,6 @@ def getparams(self):
self.getframerate(), self.getnframes(),
self.getcomptype(), self.getcompname())

def getmarkers(self):
import warnings
warnings._deprecated("Wave_read.getmarkers", remove=(3, 15))
return None

def getmark(self, id):
import warnings
warnings._deprecated("Wave_read.getmark", remove=(3, 15))
raise Error('no marks')

def setpos(self, pos):
if pos < 0 or pos > self._nframes:
raise Error('position not in range')
@@ -551,21 +537,6 @@ def getparams(self):
return _wave_params(self._nchannels, self._sampwidth, self._framerate,
self._nframes, self._comptype, self._compname)

def setmark(self, id, pos, name):
import warnings
warnings._deprecated("Wave_write.setmark", remove=(3, 15))
raise Error('setmark() not supported')

def getmark(self, id):
import warnings
warnings._deprecated("Wave_write.getmark", remove=(3, 15))
raise Error('no marks')

def getmarkers(self):
import warnings
warnings._deprecated("Wave_write.getmarkers", remove=(3, 15))
return None

def tell(self):
return self._nframeswritten

Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
Remove the deprecated ``getmark()``, ``setmark()`` and ``getmarkers()``
methods of the :class:`~wave.Wave_read` and :class:`~wave.Wave_write`
classes, which were deprecated since Python 3.13. Patch by Bénédikt Tran.
Loading
Oops, something went wrong.

Follow Lee on X/Twitter - Father, Husband, Serial builder creating AI, crypto, games & web tools. We are friends :) AI Will Come To Life!

Check out: eBank.nz (Art Generator) | Netwrck.com (AI Tools) | Text-Generator.io (AI API) | BitBank.nz (Crypto AI) | ReadingTime (Kids Reading) | RewordGame | BigMultiplayerChess | WebFiddle | How.nz | Helix AI Assistant