Skip to content

Commit

Permalink
Fix backward compatibility layer in backend module
Browse files Browse the repository at this point in the history
The PR pytorch#3549 re-organized the backend implementations and deprecated
the direct access to torchaudio.backend.

The change was supposed to be BC-compatible while issuing a warning
to users, but the implementation of module-level `__getattr__` was
not quite right.

See an issue pyannote/pyannote-audio#1456.

This commit fixes it so that the following imports work;

```python
from torchaudio.backend.common import AudioMetaData

from torchaudio.backend import sox_io_backend
from torchaudio.backend.sox_io_backend import save, load, info

from torchaudio.backend import no_backend
from torchaudio.backend.no_backend import save, load, info

from torchaudio.backend import soundfile_backend
from torchaudio.backend.soundfile_backend import save, load, info
```
  • Loading branch information
mthrok committed Sep 4, 2023
1 parent 454418d commit 271719d
Show file tree
Hide file tree
Showing 7 changed files with 61 additions and 39 deletions.
18 changes: 13 additions & 5 deletions torchaudio/__init__.py
Original file line number Diff line number Diff line change
@@ -1,10 +1,16 @@
# Initialize extension and backend first
from . import ( # noqa # usort: skip
_extension,
_backend,
from . import _extension # noqa # usort: skip
from ._backend import ( # noqa # usort: skip
AudioMetaData,
get_audio_backend,
info,
list_audio_backends,
load,
save,
set_audio_backend,
)

from . import ( # noqa: F401
backend, # For BC
compliance,
datasets,
functional,
Expand All @@ -16,7 +22,9 @@
transforms,
utils,
)
from ._backend import AudioMetaData, get_audio_backend, info, list_audio_backends, load, save, set_audio_backend

# For BC
from . import backend # noqa # usort: skip

try:
from .version import __version__, git_version # noqa: F401
Expand Down
33 changes: 2 additions & 31 deletions torchaudio/backend/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,35 +3,6 @@
# New things should be added to `torchaudio._backend`.
# Only things related to backward compatibility should be placed here.

from . import common, no_backend, soundfile_backend, sox_io_backend # noqa

def __getattr__(name: str):
if name == "common":
from . import _common

return _common

if name in ["no_backend", "sox_io_backend", "soundfile_backend"]:
import warnings

warnings.warn(
"Torchaudio's I/O functions now support par-call bakcend dispatch. "
"Importing backend implementation directly is no longer guaranteed to work. "
"Please use `backend` keyword with load/save/info function, instead of "
"calling the udnerlying implementation directly.",
stacklevel=2,
)

if name == "sox_io_backend":
from . import _sox_io_backend

return _sox_io_backend
if name == "soundfile_backend":
from torchaudio._backend import soundfile_backend

return soundfile_backend

if name == "no_backend":
from . import _no_backend

return _no_backend
raise AttributeError(f"module {__name__!r} has no attribute {name!r}")
__all__ = []
3 changes: 2 additions & 1 deletion torchaudio/backend/_no_backend.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
from typing import Callable, Optional, Tuple, Union

from torch import Tensor
from torchaudio import AudioMetaData


def load(
Expand All @@ -20,5 +21,5 @@ def save(filepath: str, src: Tensor, sample_rate: int, precision: int = 16, chan
raise RuntimeError("No audio I/O backend is available.")


def info(filepath: str) -> None:
def info(filepath: str) -> AudioMetaData:
raise RuntimeError("No audio I/O backend is available.")
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
def __getattr__(name: str):
import warnings

if name == "AudioMetaData":
import warnings

warnings.warn(
"`torchaudio.backend.common.AudioMetaData` has been moved to "
"`torchaudio.AudioMetaData`. Please update the import path.",
Expand Down
14 changes: 14 additions & 0 deletions torchaudio/backend/no_backend.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
def __getattr__(name: str):
import warnings

warnings.warn(
"Torchaudio's I/O functions now support par-call bakcend dispatch. "
"Importing backend implementation directly is no longer guaranteed to work. "
"Please use `backend` keyword with load/save/info function, instead of "
"calling the udnerlying implementation directly.",
stacklevel=2,
)

from . import _no_backend

return getattr(_no_backend, name)
14 changes: 14 additions & 0 deletions torchaudio/backend/soundfile_backend.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
def __getattr__(name: str):
import warnings

warnings.warn(
"Torchaudio's I/O functions now support par-call bakcend dispatch. "
"Importing backend implementation directly is no longer guaranteed to work. "
"Please use `backend` keyword with load/save/info function, instead of "
"calling the udnerlying implementation directly.",
stacklevel=2,
)

from torchaudio._backend import soundfile_backend

return getattr(soundfile_backend, name)
14 changes: 14 additions & 0 deletions torchaudio/backend/sox_io_backend.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
def __getattr__(name: str):
import warnings

warnings.warn(
"Torchaudio's I/O functions now support par-call bakcend dispatch. "
"Importing backend implementation directly is no longer guaranteed to work. "
"Please use `backend` keyword with load/save/info function, instead of "
"calling the udnerlying implementation directly.",
stacklevel=2,
)

from . import _sox_io_backend

return getattr(_sox_io_backend, name)

0 comments on commit 271719d

Please sign in to comment.