Deprecate more APIs (#3949)

Author: NicolasHug

src/torchaudio/__init__.py

@@ -4,16 +4,21 @@
 from . import _extension  # noqa  # usort: skip
 from ._backend import (  # noqa  # usort: skip
     AudioMetaData,
-    get_audio_backend,
-    info,
-    list_audio_backends,
+    get_audio_backend as _get_audio_backend,
+    info as _info,
+    list_audio_backends as _list_audio_backends,
     load as _load,
     save as _save,
-    set_audio_backend,
+    set_audio_backend as _set_audio_backend,
 )
 
+AudioMetaData.__init__ = dropping_support(AudioMetaData.__init__)
+get_audio_backend = dropping_support(_get_audio_backend)
+info = dropping_support(_info)
+list_audio_backends = dropping_support(_list_audio_backends)
 load = dropping_support(_load)
 save = dropping_support(_save)
+set_audio_backend = dropping_support(_set_audio_backend)
 
 from . import (  # noqa: F401
     compliance,

src/torchaudio/utils/download.py

@@ -30,7 +30,9 @@ def _get_hash(path, hash, chunk_size=1028):
             data = file.read(chunk_size)
     return m.hexdigest()
 
+from torchaudio._internal.module_utils import dropping_support
 
+@dropping_support
 def download_asset(
     key: str,
     hash: str = "",

src/torchaudio/utils/sox_utils.py

@@ -8,7 +8,9 @@
 
 sox_ext = torchaudio._extension.lazy_import_sox_ext()
 
+from torchaudio._internal.module_utils import dropping_support
 
+@dropping_support
 def set_seed(seed: int):
     """Set libsox's PRNG
 
@@ -21,6 +23,7 @@ def set_seed(seed: int):
     sox_ext.set_seed(seed)
 
 
+@dropping_support
 def set_verbosity(verbosity: int):
     """Set libsox's verbosity
 
@@ -38,6 +41,7 @@ def set_verbosity(verbosity: int):
     sox_ext.set_verbosity(verbosity)
 
 
+@dropping_support
 def set_buffer_size(buffer_size: int):
     """Set buffer size for sox effect chain
 
@@ -50,6 +54,7 @@ def set_buffer_size(buffer_size: int):
     sox_ext.set_buffer_size(buffer_size)
 
 
+@dropping_support
 def set_use_threads(use_threads: bool):
     """Set multithread option for sox effect chain
 
@@ -63,6 +68,7 @@ def set_use_threads(use_threads: bool):
     sox_ext.set_use_threads(use_threads)
 
 
+@dropping_support
 def list_effects() -> Dict[str, str]:
     """List the available sox effect names
 
@@ -72,6 +78,7 @@ def list_effects() -> Dict[str, str]:
     return dict(sox_ext.list_effects())
 
 
+@dropping_support
 def list_read_formats() -> List[str]:
     """List the supported audio formats for read
 
@@ -81,6 +88,7 @@ def list_read_formats() -> List[str]:
     return sox_ext.list_read_formats()
 
 
+@dropping_support
 def list_write_formats() -> List[str]:
     """List the supported audio formats for write
 
@@ -90,6 +98,7 @@ def list_write_formats() -> List[str]:
     return sox_ext.list_write_formats()
 
 
+@dropping_support
 def get_buffer_size() -> int:
     """Get buffer size for sox effect chain
 

src/torio/io/_streaming_media_decoder.py

@@ -437,7 +437,6 @@ def decorator(obj):
 InputStreamTypes = TypeVar("InputStream", bound=SourceStream)
 OutputStreamTypes = TypeVar("OutputStream", bound=OutputStream)
 
-
 class StreamingMediaDecoder:
     """Fetch and decode audio/video streams chunk by chunk.
 

src/torio/utils/ffmpeg_utils.py

@@ -9,6 +9,10 @@
 ffmpeg_ext = torio._extension.lazy_import_ffmpeg_ext()
 
 
+from torchaudio._internal.module_utils import dropping_support
+
+
+@dropping_support
 def get_versions() -> Dict[str, Tuple[int]]:
     """Get the versions of FFmpeg libraries
 
@@ -19,6 +23,7 @@ def get_versions() -> Dict[str, Tuple[int]]:
     return ffmpeg_ext.get_versions()
 
 
+@dropping_support
 def get_log_level() -> int:
     """Get the log level of FFmpeg.
 
@@ -27,6 +32,7 @@ def get_log_level() -> int:
     return ffmpeg_ext.get_log_level()
 
 
+@dropping_support
 def set_log_level(level: int):
     """Set the log level of FFmpeg (libavformat etc)
 
@@ -63,6 +69,7 @@ def set_log_level(level: int):
     ffmpeg_ext.set_log_level(level)
 
 
+@dropping_support
 def get_demuxers() -> Dict[str, str]:
     """Get the available demuxers.
 
@@ -80,6 +87,7 @@ def get_demuxers() -> Dict[str, str]:
     return ffmpeg_ext.get_demuxers()
 
 
+@dropping_support
 def get_muxers() -> Dict[str, str]:
     """Get the available muxers.
 
@@ -98,6 +106,7 @@ def get_muxers() -> Dict[str, str]:
     return ffmpeg_ext.get_muxers()
 
 
+@dropping_support
 def get_audio_decoders() -> Dict[str, str]:
     """Get the available audio decoders.
 
@@ -116,6 +125,7 @@ def get_audio_decoders() -> Dict[str, str]:
     return ffmpeg_ext.get_audio_decoders()
 
 
+@dropping_support
 def get_audio_encoders() -> Dict[str, str]:
     """Get the available audio encoders.
 
@@ -135,6 +145,7 @@ def get_audio_encoders() -> Dict[str, str]:
     return ffmpeg_ext.get_audio_encoders()
 
 
+@dropping_support
 def get_video_decoders() -> Dict[str, str]:
     """Get the available video decoders.
 
@@ -154,6 +165,7 @@ def get_video_decoders() -> Dict[str, str]:
     return ffmpeg_ext.get_video_decoders()
 
 
+@dropping_support
 def get_video_encoders() -> Dict[str, str]:
     """Get the available video encoders.
 
@@ -174,6 +186,7 @@ def get_video_encoders() -> Dict[str, str]:
     return ffmpeg_ext.get_video_encoders()
 
 
+@dropping_support
 def get_input_devices() -> Dict[str, str]:
     """Get the available input devices.
 
@@ -189,6 +202,7 @@ def get_input_devices() -> Dict[str, str]:
     return ffmpeg_ext.get_input_devices()
 
 
+@dropping_support
 def get_output_devices() -> Dict[str, str]:
     """Get the available output devices.
 
@@ -203,6 +217,7 @@ def get_output_devices() -> Dict[str, str]:
     return ffmpeg_ext.get_output_devices()
 
 
+@dropping_support
 def get_input_protocols() -> List[str]:
     """Get the supported input protocols.
 
@@ -216,6 +231,7 @@ def get_input_protocols() -> List[str]:
     return ffmpeg_ext.get_input_protocols()
 
 
+@dropping_support
 def get_output_protocols() -> List[str]:
     """Get the supported output protocols.
 
@@ -229,6 +245,7 @@ def get_output_protocols() -> List[str]:
     return ffmpeg_ext.get_output_protocols()
 
 
+@dropping_support
 def get_build_config() -> str:
     """Get the FFmpeg build configuration
 
@@ -242,6 +259,7 @@ def get_build_config() -> str:
     return ffmpeg_ext.get_build_config()
 
 
+@dropping_support
 def clear_cuda_context_cache():
     """Clear the CUDA context used by CUDA Hardware accelerated video decoding"""
     ffmpeg_ext.clear_cuda_context_cache()

test/torchaudio_unittest/deprecation_test.py

@@ -1,14 +1,34 @@
 import pytest
 
+import torch
+
 from torchaudio._internal.module_utils import UNSUPPORTED
+from torchaudio.sox_effects import apply_effects_tensor
+
+# Importing prototype modules is needed to trigger the registration of the
+# corresponding APIs in the UNSUPPORTED register.
+from torchaudio.prototype import datasets, functional, models, pipelines, transforms
+
 
 @pytest.mark.parametrize("func", UNSUPPORTED)
 def test_deprecations(func):
     with pytest.warns(UserWarning, match="deprecated"):
         try:
             func()
         except Exception as e:
-	     # Type or Runtime error because we call func() without proper parameters.
-             # The deprecation warning is still properly raised, since it is emitted before
-             # the underlying (deprecated) function is called.
-            assert isinstance(e, (TypeError, RuntimeError))
+            assert isinstance(e, (TypeError, RuntimeError, ValueError, ImportError))
+
+
+# It's not great, but the deprecation decorator we're using breaks torchscript
+# This test just illustrates this behavior. Ideally, we wouldn't break
+# torchscript users. But oh well, torchscript is supposed to have been
+# deprecated for years.
+@pytest.mark.parametrize("scripted", (True, False))
+def test_torchscript_fails(scripted):
+    f = apply_effects_tensor
+    if scripted:
+        pytest.xfail("Deprecation decorator breaks torchscript")
+        f = torch.jit.script(f)
+    _, out_sample_rate = f(torch.rand(2, 1000), sample_rate=16_000, effects=[["rate", "8000"]])
+    assert out_sample_rate == 8000
+