playsound3 3.2.2__tar.gz → 3.2.4__tar.gz

{playsound3-3.2.2 → playsound3-3.2.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: playsound3
-Version: 3.2.2
+Version: 3.2.4
 Summary: Cross-platform library to play audio files
 Project-URL: Home, https://github.com/sjmikler/playsound3
 Project-URL: Issues, https://github.com/sjmikler/playsound3/issues
@@ -29,6 +29,10 @@ Classifier: Typing :: Typed
 Requires-Python: >=3.7
 Requires-Dist: pywin32; sys_platform == 'win32'
 Requires-Dist: typing-extensions; python_version < '3.8'
+Provides-Extra: dev
+Requires-Dist: pyright; extra == 'dev'
+Requires-Dist: pytest; extra == 'dev'
+Requires-Dist: ruff; extra == 'dev'
 Description-Content-Type: text/markdown
 
 > **Version 3.0.0**

{playsound3-3.2.2 → playsound3-3.2.4}/playsound3/__init__.py

@@ -1,5 +1,5 @@
 __license__ = "MIT"
-__version__ = "3.2.2"
+__version__ = "3.2.4"
 __author__ = "Szymon Mikler"
 
 from playsound3.playsound3 import (

{playsound3-3.2.2 → playsound3-3.2.4}/playsound3/playsound3.py

@@ -141,7 +141,10 @@ class Ffplay(SoundBackend):
             return False
 
     def play(self, sound: str) -> subprocess.Popen[bytes]:
-        return subprocess.Popen(["ffplay", "-nodisp", "-autoexit", "-loglevel", "quiet", sound])
+        return subprocess.Popen(
+            ["ffplay", "-nodisp", "-autoexit", "-loglevel", "quiet", sound],
+            stdout=subprocess.DEVNULL,
+        )
 
 
 class Wmplayer(SoundBackend):
@@ -342,16 +345,16 @@ AVAILABLE_BACKENDS: list[str] = [name for name in _BACKEND_PREFERENCE if _BACKEN
 DEFAULT_BACKEND: str | None = _auto_select_backend()
 
 
-# This funciton is defined here because:
+# This function is defined here at the bottom because of:
 # SyntaxError: annotated name 'DEFAULT_BACKEND' can't be global
 def prefer_backends(*backends: str) -> str | None:
     """Add backends to the top of the preference list.
 
-    This function sets a soft-preference.
-    Backend selected here are used only if available on the system.
-    Function can be used to update the preference for a specific system
-    without breaking the cross-platform functionality.
-    After updating the preferences, a new default backend will be selected.
+    This function overrides the default backend preference.
+    Backend selected here will be used ONLY if available on the system.
+    This means this function can be used to update the preference for a
+    specific platform without breaking the cross-platform functionality.
+    After updating the preferences, the new default backend is returned.
 
     Args:
         backends: Names of the backends to prefer.

{playsound3-3.2.2 → playsound3-3.2.4}/pyproject.toml

@@ -45,11 +45,18 @@ Home = "https://github.com/sjmikler/playsound3"
 Issues = "https://github.com/sjmikler/playsound3/issues"
 Documentation = "https://github.com/sjmikler/playsound3/blob/main/README.md#quick-start"
 
+[project.optional-dependencies]
+dev = [
+    "pyright",
+    "pytest",
+    "ruff",
+]
+
 [tool.hatch.version]
 path = "playsound3/__init__.py"
 
 [tool.hatch.build.targets.sdist]
-include = ["playsound3", "README.md"]
+include = ["playsound3", "README.md", "tests"]
 
 [tool.hatch.build.targets.wheel]
 packages = ["playsound3"]

playsound3-3.2.4/tests/test_functionality.py

@@ -0,0 +1,143 @@
+import os
+import time
+
+from playsound3 import AVAILABLE_BACKENDS, playsound
+from playsound3.playsound3 import _prepare_path
+
+loc_mp3_3s = "tests/sounds/sample3s.mp3"
+loc_flc_3s = "tests/sounds/sample3s.flac"
+web_wav_3s = "https://samplelib.com/lib/preview/wav/sample-3s.wav"
+
+# Download web files to the local cache
+for url in [web_wav_3s]:
+    _prepare_path(url)
+
+
+def get_supported_sounds(backend):
+    not_supporting_flac = ["alsa", "winmm"]
+
+    if backend in not_supporting_flac:
+        return [loc_mp3_3s, web_wav_3s]
+    else:
+        return [loc_mp3_3s, loc_flc_3s, web_wav_3s]
+
+
+CI = os.environ.get("CI", False)
+
+
+def test_blocking_1():
+    for backend in AVAILABLE_BACKENDS:
+        for path in get_supported_sounds(backend):
+            t0 = time.perf_counter()
+            sound = playsound(path, block=True, backend=backend)
+
+            td = time.perf_counter() - t0
+            assert not sound.is_alive(), f"backend={backend}, path={path}"
+            assert td >= 3.0, f"backend={backend}, path={path}"
+            assert CI or td < 5.0, f"backend={backend}, path={path}"
+
+
+def test_waiting_1():
+    for backend in AVAILABLE_BACKENDS:
+        for path in get_supported_sounds(backend):
+            t0 = time.perf_counter()
+            sound = playsound(path, block=False, backend=backend)
+            assert sound.is_alive(), f"backend={backend}, path={path}"
+
+            sound.wait()
+            td = time.perf_counter() - t0
+            assert not sound.is_alive(), f"backend={backend}, path={path}"
+            assert td >= 3.0, f"backend={backend}, path={path}"
+            assert CI or td < 5.0, f"backend={backend}, path={path}"
+
+
+def test_waiting_2():
+    for backend in AVAILABLE_BACKENDS:
+        for path in get_supported_sounds(backend):
+            sound = playsound(path, block=False, backend=backend)
+            assert sound.is_alive(), f"backend={backend}, path={path}"
+
+            time.sleep(5)
+            assert not sound.is_alive(), f"backend={backend}, path={path}"
+
+
+def test_stopping_1():
+    for backend in AVAILABLE_BACKENDS:
+        for path in get_supported_sounds(backend):
+            t0 = time.perf_counter()
+            sound = playsound(path, block=False, backend=backend)
+            assert sound.is_alive(), f"backend={backend}, path={path}"
+
+            time.sleep(1)
+            sound.stop()
+            td = time.perf_counter() - t0
+
+            time.sleep(0.05)
+            assert not sound.is_alive(), f"backend={backend}, path={path}"
+            assert td >= 0.95 and td < 2.0, f"backend={backend}, path={path}"
+
+            # Stopping again should be a no-op
+            sound.stop()
+            assert not sound.is_alive(), f"backend={backend}, path={path}"
+
+
+def test_parallel_1():
+    for backend in AVAILABLE_BACKENDS:
+        for path in get_supported_sounds(backend):
+            t0 = time.perf_counter()
+            sounds = [playsound(path, block=False, backend=backend) for _ in range(3)]
+            time.sleep(0.05)
+            for sound in sounds:
+                assert sound.is_alive(), f"backend={backend}"
+            time.sleep(1)
+
+            sounds[1].stop()
+            time.sleep(0.05)
+            assert sounds[0].is_alive(), f"backend={backend}"
+            assert sounds[2].is_alive(), f"backend={backend}"
+            assert not sounds[1].is_alive(), f"backend={backend}"
+            time.sleep(1)
+
+            assert sounds[0].is_alive(), f"backend={backend}"
+            assert sounds[2].is_alive(), f"backend={backend}"
+            sounds[0].stop()
+            sounds[2].stop()
+            td = time.perf_counter() - t0
+
+            time.sleep(0.05)
+            for sound in sounds:
+                assert not sound.is_alive(), f"backend={backend}"
+            assert td >= 2.0 and td < 3.0, f"backend={backend}"
+
+
+def test_parallel_2():
+    N_PARALLEL = 10  # Careful - this might be loud!
+
+    for backend in AVAILABLE_BACKENDS:
+        for path in get_supported_sounds(backend):
+            sounds = [playsound(path, block=False, backend=backend) for _ in range(N_PARALLEL)]
+
+            time.sleep(1)
+            for sound in sounds:
+                assert sound.is_alive(), f"backend={backend}, path={path}"
+            for sound in sounds:
+                sound.stop()
+
+            time.sleep(0.05)
+            for sound in sounds:
+                assert not sound.is_alive(), f"backend={backend}, path={path}"
+
+
+def test_parallel_3():
+    for backend in AVAILABLE_BACKENDS:
+        sounds = [playsound(path, block=False, backend=backend) for path in get_supported_sounds(backend)]
+
+        time.sleep(1)
+        for sound in sounds:
+            assert sound.is_alive(), f"backend={backend}"
+        for sound in sounds:
+            sound.stop()
+
+        time.sleep(0.05)
+        for sound in sounds:
+            assert not sound.is_alive(), f"backend={backend}"

playsound3-3.2.4/tests/test_raising_errors.py

@@ -0,0 +1,29 @@
+import urllib.error
+
+import pytest
+
+from playsound3 import playsound
+from playsound3.playsound3 import PlaysoundException
+
+valid = "tests/sounds/sample3s.mp3"
+
+
+def test_invalid_sound_file():
+    with pytest.raises(PlaysoundException):
+        playsound("invalid.mp3")
+
+
+def test_non_existent_file():
+    with pytest.raises(PlaysoundException):
+        playsound("non_existent.mp3")
+
+
+def test_invalid_backend():
+    with pytest.raises(PlaysoundException):
+        playsound(valid, backend="invalid_backend")
+
+
+def test_playsound_from_url():
+    url = "https://wrong-url.com/wrong-audio.mp3"
+    with pytest.raises(urllib.error.URLError):
+        playsound(url)

playsound3-3.2.4/tests/test_special_characters.py

@@ -0,0 +1,25 @@
+import time
+
+from playsound3 import AVAILABLE_BACKENDS, playsound
+
+wav = "tests/sounds/звук 音 聲音.wav"
+
+
+def test_with_blocking():
+    for backend in AVAILABLE_BACKENDS:
+        print(f"Testing backend: {backend}")
+
+        sound = playsound(wav, block=True, backend=backend)
+        assert not sound.is_alive()
+
+
+def test_non_blocking():
+    for backend in AVAILABLE_BACKENDS:
+        print(f"Testing backend: {backend}")
+
+        sound = playsound(wav, block=False, backend=backend)
+        time.sleep(0.05)
+        assert sound.is_alive()
+
+        sound.wait()
+        assert not sound.is_alive()