diff --git a/Doc/library/sunau.rst b/Doc/library/sunau.rst index c8357e4fcc8..2064fd7e20b 100644 --- a/Doc/library/sunau.rst +++ b/Doc/library/sunau.rst @@ -63,6 +63,8 @@ The :mod:`sunau` module defines the following functions: A synonym for :func:`.open`, maintained for backwards compatibility. + .. deprecated-removed:: 3.7 3.9 + The :mod:`sunau` module defines the following exception: diff --git a/Doc/library/wave.rst b/Doc/library/wave.rst index a9b3205322d..5c315c51617 100644 --- a/Doc/library/wave.rst +++ b/Doc/library/wave.rst @@ -51,6 +51,8 @@ The :mod:`wave` module defines the following function and exception: A synonym for :func:`.open`, maintained for backwards compatibility. + .. deprecated-removed:: 3.7 3.9 + .. exception:: Error diff --git a/Lib/aifc.py b/Lib/aifc.py index 49a456a893f..e51e8f8e484 100644 --- a/Lib/aifc.py +++ b/Lib/aifc.py @@ -915,7 +915,10 @@ def open(f, mode=None): else: raise Error("mode must be 'r', 'rb', 'w', or 'wb'") -openfp = open # B/W compatibility +def openfp(f, mode=None): + warnings.warn("aifc.openfp is deprecated since Python 3.7. " + "Use aifc.open instead.", DeprecationWarning, stacklevel=2) + return open(f, mode=mode) if __name__ == '__main__': import sys diff --git a/Lib/sndhdr.py b/Lib/sndhdr.py index 7ecafb40e82..594353136f5 100644 --- a/Lib/sndhdr.py +++ b/Lib/sndhdr.py @@ -160,7 +160,7 @@ def test_wav(h, f): return None f.seek(0) try: - w = wave.openfp(f, 'r') + w = wave.open(f, 'r') except (EOFError, wave.Error): return None return ('wav', w.getframerate(), w.getnchannels(), diff --git a/Lib/sunau.py b/Lib/sunau.py index 0473e9e4ca1..dbad3db8392 100644 --- a/Lib/sunau.py +++ b/Lib/sunau.py @@ -104,6 +104,7 @@ is destroyed. """ from collections import namedtuple +import warnings _sunau_params = namedtuple('_sunau_params', 'nchannels sampwidth framerate nframes comptype compname') @@ -522,4 +523,7 @@ def open(f, mode=None): else: raise Error("mode must be 'r', 'rb', 'w', or 'wb'") -openfp = open +def openfp(f, mode=None): + warnings.warn("sunau.openfp is deprecated since Python 3.7. " + "Use sunau.open instead.", DeprecationWarning, stacklevel=2) + return open(f, mode=mode) diff --git a/Lib/test/audiotests.py b/Lib/test/audiotests.py index d3e8e9ee44a..0dad0172292 100644 --- a/Lib/test/audiotests.py +++ b/Lib/test/audiotests.py @@ -1,6 +1,7 @@ from test.support import findfile, TESTFN, unlink import array import io +from unittest import mock import pickle @@ -49,6 +50,17 @@ class AudioTests: self.assertEqual(pickle.loads(dump), params) +class AudioMiscTests(AudioTests): + + def test_openfp_deprecated(self): + arg = "arg" + mode = "mode" + with mock.patch(f"{self.module.__name__}.open") as mock_open, \ + self.assertWarns(DeprecationWarning): + self.module.openfp(arg, mode=mode) + mock_open.assert_called_with(arg, mode=mode) + + class AudioWriteTests(AudioTests): def create_file(self, testfile): diff --git a/Lib/test/test_aifc.py b/Lib/test/test_aifc.py index a731a5136ba..a064a324705 100644 --- a/Lib/test/test_aifc.py +++ b/Lib/test/test_aifc.py @@ -7,6 +7,7 @@ import io import sys import struct import aifc +import warnings class AifcTest(audiotests.AudioWriteTests, @@ -144,7 +145,9 @@ class AifcALAWTest(AifcTest, unittest.TestCase): frames = byteswap(frames, 2) -class AifcMiscTest(audiotests.AudioTests, unittest.TestCase): +class AifcMiscTest(audiotests.AudioMiscTests, unittest.TestCase): + module = aifc + def test_skipunknown(self): #Issue 2245 #This file contains chunk types aifc doesn't recognize. diff --git a/Lib/test/test_pyclbr.py b/Lib/test/test_pyclbr.py index 238eb71cd87..eaab591f74e 100644 --- a/Lib/test/test_pyclbr.py +++ b/Lib/test/test_pyclbr.py @@ -223,6 +223,8 @@ class PyclbrTest(TestCase): cm('random', ignore=('Random',)) # from _random import Random as CoreGenerator cm('cgi', ignore=('log',)) # set with = in module cm('pickle', ignore=('partial',)) + # TODO(briancurtin): openfp is deprecated as of 3.7. + # Update this once it has been removed. cm('aifc', ignore=('openfp', '_aifc_params')) # set with = in module cm('sre_parse', ignore=('dump', 'groups', 'pos')) # from sre_constants import *; property cm('pdb') diff --git a/Lib/test/test_sunau.py b/Lib/test/test_sunau.py index bc1f46c0ebd..966224b1df5 100644 --- a/Lib/test/test_sunau.py +++ b/Lib/test/test_sunau.py @@ -117,5 +117,9 @@ class SunauULAWTest(SunauTest, unittest.TestCase): frames = byteswap(frames, 2) +class SunauMiscTests(audiotests.AudioMiscTests, unittest.TestCase): + module = sunau + + if __name__ == "__main__": unittest.main() diff --git a/Lib/test/test_wave.py b/Lib/test/test_wave.py index 8666f7269cb..c5d2e02450e 100644 --- a/Lib/test/test_wave.py +++ b/Lib/test/test_wave.py @@ -103,7 +103,9 @@ class WavePCM32Test(WaveTest, unittest.TestCase): frames = byteswap(frames, 4) -class MiscTestCase(unittest.TestCase): +class MiscTestCase(audiotests.AudioMiscTests, unittest.TestCase): + module = wave + def test__all__(self): blacklist = {'WAVE_FORMAT_PCM'} support.check__all__(self, wave, blacklist=blacklist) diff --git a/Lib/wave.py b/Lib/wave.py index f71f7e5bf94..cf94d5af72b 100644 --- a/Lib/wave.py +++ b/Lib/wave.py @@ -87,6 +87,7 @@ import struct import sys from chunk import Chunk from collections import namedtuple +import warnings _wave_params = namedtuple('_wave_params', 'nchannels sampwidth framerate nframes comptype compname') @@ -502,4 +503,7 @@ def open(f, mode=None): else: raise Error("mode must be 'r', 'rb', 'w', or 'wb'") -openfp = open # B/W compatibility +def openfp(f, mode=None): + warnings.warn("wave.openfp is deprecated since Python 3.7. " + "Use wave.open instead.", DeprecationWarning, stacklevel=2) + return open(f, mode=mode) diff --git a/Misc/NEWS.d/next/Library/2017-11-08-16-51-52.bpo-31985.dE_fOB.rst b/Misc/NEWS.d/next/Library/2017-11-08-16-51-52.bpo-31985.dE_fOB.rst new file mode 100644 index 00000000000..9f55ef5d9ce --- /dev/null +++ b/Misc/NEWS.d/next/Library/2017-11-08-16-51-52.bpo-31985.dE_fOB.rst @@ -0,0 +1,4 @@ +Formally deprecated aifc.openfp, sunau.openfp, and wave.openfp. Since change +7bc817d5ba917528e8bd07ec461c635291e7b06a in 1993, openfp in each of the three +modules had been pointing to that module's open funciton as a matter of +backwards compatibility, though it had been both untested and undocumented.