mirror of
https://github.com/flyingrub/scdl.git
synced 2026-11-02 16:11:07 +01:00
gavin
e4dec65065
### Added - `--yt-dlp-args <argstring>` to allow passing of yt-dlp args as a string (using yt-dlp CLI format) ### Fixed - Make `--sync` method work as intended ### Changed - Use [yt-dlp](https://github.com/yt-dlp/yt-dlp/) to download and process tracks - Store description in "comment" tag instead of "description" tag for Ogg/FLAC files - Change default track format string to include track artist and ID - Drop `termcolor`, `requests`, `tqdm`, `pathvalidate`, `filelock` dependencies - Switch to `pyproject.toml` instead of `setup.py` - **Breaking:** Change `--sync` file format to include downloaded filenames ### Removed - **Breaking:** Remove `--remove` - **Breaking:** Remove `-n` - **Breaking:** Drop support for Python 3.7 and 3.8 - **Breaking:** When writing to stdout, files no longer contain metadata
405 lines
11 KiB
Python
405 lines
11 KiB
Python
import os
|
|
from pathlib import Path
|
|
|
|
import pytest
|
|
|
|
from tests.utils import assert_track, call_scdl_with_auth
|
|
|
|
|
|
@pytest.mark.skipif(not os.getenv("AUTH_TOKEN"), reason="No auth token specified")
|
|
def test_original_download(tmp_path: Path) -> None:
|
|
os.chdir(tmp_path)
|
|
r = call_scdl_with_auth(
|
|
"-l",
|
|
"https://soundcloud.com/violinbutterflynet/original", # thanks saves for hosting
|
|
"--name-format",
|
|
"track",
|
|
)
|
|
assert r.returncode == 0
|
|
assert_track(tmp_path, "track.wav", "copy", "saves", None)
|
|
|
|
|
|
def test_original_to_stdout(tmp_path: Path) -> None:
|
|
os.chdir(tmp_path)
|
|
r = call_scdl_with_auth(
|
|
"-l",
|
|
"https://soundcloud.com/violinbutterflynet/original",
|
|
"--name-format",
|
|
"-",
|
|
encoding=None,
|
|
)
|
|
assert r.returncode == 0
|
|
with open("track.wav", "wb") as f:
|
|
assert isinstance(r.stdout, bytes)
|
|
f.write(r.stdout)
|
|
# https://github.com/yt-dlp/yt-dlp/issues/8815
|
|
assert_track(tmp_path, "track.wav", "copy", "saves", None, check_metadata=False)
|
|
|
|
|
|
def test_mp3_to_stdout(tmp_path: Path) -> None:
|
|
os.chdir(tmp_path)
|
|
r = call_scdl_with_auth(
|
|
"-l",
|
|
"https://soundcloud.com/one-thousand-and-one/test-track",
|
|
"--onlymp3",
|
|
"--name-format",
|
|
"-",
|
|
encoding=None,
|
|
)
|
|
assert r.returncode == 0
|
|
|
|
with open("track.mp3", "wb") as f:
|
|
assert isinstance(r.stdout, bytes)
|
|
f.write(r.stdout)
|
|
|
|
# https://github.com/yt-dlp/yt-dlp/issues/8815
|
|
assert_track(tmp_path, "track.mp3", check_metadata=False)
|
|
|
|
|
|
@pytest.mark.skipif(not os.getenv("AUTH_TOKEN"), reason="No auth token specified")
|
|
def test_flac_to_stdout(tmp_path: Path) -> None:
|
|
os.chdir(tmp_path)
|
|
r = call_scdl_with_auth(
|
|
"-l",
|
|
"https://soundcloud.com/violinbutterflynet/original",
|
|
"--name-format",
|
|
"-",
|
|
"--flac",
|
|
encoding=None,
|
|
)
|
|
|
|
with open("track.flac", "wb") as f:
|
|
assert isinstance(r.stdout, bytes)
|
|
f.write(r.stdout)
|
|
|
|
assert r.returncode == 0
|
|
# https://github.com/yt-dlp/yt-dlp/issues/8815
|
|
assert_track(tmp_path, "track.flac", "copy", "saves", None, check_metadata=False)
|
|
|
|
|
|
@pytest.mark.skipif(not os.getenv("AUTH_TOKEN"), reason="No auth token specified")
|
|
def test_flac(tmp_path: Path) -> None:
|
|
os.chdir(tmp_path)
|
|
r = call_scdl_with_auth(
|
|
"-l",
|
|
"https://soundcloud.com/violinbutterflynet/original",
|
|
"--name-format",
|
|
"track",
|
|
"--flac",
|
|
)
|
|
assert r.returncode == 0
|
|
assert_track(tmp_path, "track.flac", "copy", "saves", None)
|
|
|
|
|
|
@pytest.mark.skipif(not os.getenv("AUTH_TOKEN"), reason="No auth token specified")
|
|
def test_m4a(tmp_path: Path) -> None:
|
|
os.chdir(tmp_path)
|
|
r = call_scdl_with_auth(
|
|
"-l",
|
|
"https://soundcloud.com/7x11x13/wan-bushi-eurodance-vibes-part-123",
|
|
"--name-format",
|
|
"track",
|
|
"--no-original",
|
|
"--opus",
|
|
)
|
|
assert r.returncode == 0
|
|
if (tmp_path / "track.opus").exists():
|
|
pytest.skip("No go+ subscription")
|
|
assert_track(
|
|
tmp_path,
|
|
"track.m4a",
|
|
"Wan Bushi - Eurodance Vibes (part 1+2+3)",
|
|
"Wan Bushi",
|
|
"Electronic",
|
|
None,
|
|
)
|
|
|
|
|
|
def test_opus(tmp_path: Path) -> None:
|
|
os.chdir(tmp_path)
|
|
r = call_scdl_with_auth(
|
|
"-l",
|
|
"https://soundcloud.com/one-thousand-and-one/test-track",
|
|
"--name-format",
|
|
"track",
|
|
"--no-original",
|
|
"--opus",
|
|
)
|
|
assert r.returncode == 0
|
|
assert_track(tmp_path, "track.opus")
|
|
|
|
|
|
def test_mp3(tmp_path: Path) -> None:
|
|
os.chdir(tmp_path)
|
|
r = call_scdl_with_auth(
|
|
"-l",
|
|
"https://soundcloud.com/one-thousand-and-one/test-track",
|
|
"--name-format",
|
|
"track",
|
|
"--onlymp3",
|
|
)
|
|
assert r.returncode == 0
|
|
assert_track(tmp_path, "track.mp3")
|
|
|
|
|
|
def test_unlisted_track(tmp_path: Path) -> None:
|
|
os.chdir(tmp_path)
|
|
r = call_scdl_with_auth(
|
|
"-l",
|
|
"https://soundcloud.com/one-thousand-and-one/test-track-2/s-fgLQFAzNIMP",
|
|
"--name-format",
|
|
"track",
|
|
"--onlymp3",
|
|
)
|
|
assert r.returncode == 0
|
|
assert_track(tmp_path, "track.mp3", "test track 2")
|
|
|
|
|
|
def test_original_art(tmp_path: Path) -> None:
|
|
os.chdir(tmp_path)
|
|
r = call_scdl_with_auth(
|
|
"-l",
|
|
"https://soundcloud.com/one-thousand-and-one/test-track",
|
|
"--name-format",
|
|
"track",
|
|
"--onlymp3",
|
|
"--original-art",
|
|
)
|
|
assert r.returncode == 0
|
|
assert_track(tmp_path, "track.mp3", expected_artwork_len=3409)
|
|
|
|
|
|
@pytest.mark.skipif(not os.getenv("AUTH_TOKEN"), reason="No auth token specified")
|
|
def test_original_name(tmp_path: Path) -> None:
|
|
os.chdir(tmp_path)
|
|
r = call_scdl_with_auth(
|
|
"-l",
|
|
"https://soundcloud.com/violinbutterflynet/original",
|
|
"--name-format",
|
|
"track",
|
|
"--original-name",
|
|
)
|
|
assert r.returncode == 0
|
|
assert_track(tmp_path, "original.wav", check_metadata=False)
|
|
|
|
|
|
@pytest.mark.skipif(not os.getenv("AUTH_TOKEN"), reason="No auth token specified")
|
|
def test_original_metadata(tmp_path: Path) -> None:
|
|
os.chdir(tmp_path)
|
|
r = call_scdl_with_auth(
|
|
"-l",
|
|
"https://soundcloud.com/violinbutterflynet/original",
|
|
"--name-format",
|
|
"track",
|
|
"--original-metadata",
|
|
)
|
|
assert r.returncode == 0
|
|
assert_track(tmp_path, "track.wav", "og title", "og artist", "og genre", 0)
|
|
|
|
|
|
@pytest.mark.skipif(not os.getenv("AUTH_TOKEN"), reason="No auth token specified")
|
|
def test_force_metadata(tmp_path: Path) -> None:
|
|
os.chdir(tmp_path)
|
|
r = call_scdl_with_auth(
|
|
"-l",
|
|
"https://soundcloud.com/violinbutterflynet/original",
|
|
"--name-format",
|
|
"track",
|
|
"--original-metadata",
|
|
)
|
|
assert r.returncode == 0
|
|
assert_track(tmp_path, "track.wav", "og title", "og artist", "og genre", 0)
|
|
|
|
r = call_scdl_with_auth(
|
|
"-l",
|
|
"https://soundcloud.com/violinbutterflynet/original",
|
|
"--name-format",
|
|
"track",
|
|
)
|
|
assert_track(tmp_path, "track.wav", "og title", "og artist", "og genre", 0)
|
|
|
|
r = call_scdl_with_auth(
|
|
"-l",
|
|
"https://soundcloud.com/violinbutterflynet/original",
|
|
"--name-format",
|
|
"track",
|
|
"--force-metadata",
|
|
)
|
|
assert r.returncode == 0
|
|
assert_track(tmp_path, "track.wav", "copy", "saves", None)
|
|
|
|
|
|
def test_addtimestamp(tmp_path: Path) -> None:
|
|
os.chdir(tmp_path)
|
|
r = call_scdl_with_auth(
|
|
"-l",
|
|
"https://soundcloud.com/one-thousand-and-one/test-track",
|
|
"--onlymp3",
|
|
"--addtimestamp",
|
|
)
|
|
assert r.returncode == 0
|
|
assert_track(tmp_path, "1719169486_testing - test track.mp3", check_metadata=False)
|
|
|
|
|
|
def test_addtofile(tmp_path: Path) -> None:
|
|
os.chdir(tmp_path)
|
|
r = call_scdl_with_auth(
|
|
"-l",
|
|
"https://soundcloud.com/one-thousand-and-one/test-track-2/s-fgLQFAzNIMP",
|
|
"--onlymp3",
|
|
"--addtofile",
|
|
)
|
|
assert r.returncode == 0
|
|
assert_track(tmp_path, "7x11x13-testing - test track 2.mp3", check_metadata=False)
|
|
|
|
|
|
def test_extract_artist(tmp_path: Path) -> None:
|
|
os.chdir(tmp_path)
|
|
r = call_scdl_with_auth(
|
|
"-l",
|
|
"https://soundcloud.com/one-thousand-and-one/test-track",
|
|
"--onlymp3",
|
|
"--name-format",
|
|
"track",
|
|
"--extract-artist",
|
|
)
|
|
assert r.returncode == 0
|
|
assert_track(tmp_path, "track.mp3", "test track", "testing")
|
|
|
|
|
|
def test_maxsize(tmp_path: Path) -> None:
|
|
os.chdir(tmp_path)
|
|
r = call_scdl_with_auth(
|
|
"-l",
|
|
"https://soundcloud.com/one-thousand-and-one/test-track",
|
|
"--onlymp3",
|
|
"--max-size=10k",
|
|
)
|
|
assert r.returncode == 0
|
|
assert "format is not available" in r.stderr
|
|
|
|
|
|
def test_minsize(tmp_path: Path) -> None:
|
|
os.chdir(tmp_path)
|
|
r = call_scdl_with_auth(
|
|
"-l",
|
|
"https://soundcloud.com/one-thousand-and-one/test-track",
|
|
"--onlymp3",
|
|
"--min-size=1m",
|
|
)
|
|
assert r.returncode == 0
|
|
assert "format is not available" in r.stderr
|
|
|
|
|
|
def test_only_original(tmp_path: Path) -> None:
|
|
os.chdir(tmp_path)
|
|
r = call_scdl_with_auth(
|
|
"-l",
|
|
"https://soundcloud.com/one-thousand-and-one/test-track-2/s-fgLQFAzNIMP",
|
|
"--only-original",
|
|
)
|
|
assert r.returncode == 0
|
|
assert "Requested format is not available" in r.stderr
|
|
|
|
|
|
def test_overwrite(tmp_path: Path) -> None:
|
|
os.chdir(tmp_path)
|
|
r = call_scdl_with_auth(
|
|
"-l",
|
|
"https://soundcloud.com/one-thousand-and-one/test-track",
|
|
"--name-format",
|
|
"track",
|
|
"--onlymp3",
|
|
)
|
|
assert r.returncode == 0
|
|
|
|
r = call_scdl_with_auth(
|
|
"-l",
|
|
"https://soundcloud.com/one-thousand-and-one/test-track",
|
|
"--name-format",
|
|
"track",
|
|
"--onlymp3",
|
|
)
|
|
assert r.returncode == 0
|
|
assert "has already been downloaded" in r.stderr
|
|
|
|
r = call_scdl_with_auth(
|
|
"-l",
|
|
"https://soundcloud.com/one-thousand-and-one/test-track",
|
|
"--name-format",
|
|
"track",
|
|
"--onlymp3",
|
|
"--overwrite",
|
|
)
|
|
assert r.returncode == 0
|
|
assert "Deleting existing file" in r.stderr
|
|
|
|
|
|
def test_path(tmp_path: Path) -> None:
|
|
r = call_scdl_with_auth(
|
|
"-l",
|
|
"https://soundcloud.com/one-thousand-and-one/test-track",
|
|
"--name-format",
|
|
"track",
|
|
"--onlymp3",
|
|
"--path",
|
|
str(tmp_path),
|
|
)
|
|
assert r.returncode == 0
|
|
assert_track(tmp_path, "track.mp3", check_metadata=False)
|
|
|
|
|
|
def test_download_archive(tmp_path: Path) -> None:
|
|
os.chdir(tmp_path)
|
|
r = call_scdl_with_auth(
|
|
"-l",
|
|
"https://soundcloud.com/one-thousand-and-one/test-track",
|
|
"--name-format",
|
|
"track",
|
|
"--onlymp3",
|
|
"--download-archive=archive.txt",
|
|
)
|
|
assert r.returncode == 0
|
|
os.remove("track.mp3")
|
|
assert not os.path.exists("track.mp3")
|
|
r = call_scdl_with_auth(
|
|
"-l",
|
|
"https://soundcloud.com/one-thousand-and-one/test-track",
|
|
"--name-format",
|
|
"track",
|
|
"--onlymp3",
|
|
"--download-archive=archive.txt",
|
|
)
|
|
assert r.returncode == 0
|
|
assert "already been recorded in the archive" in r.stderr
|
|
|
|
|
|
def test_description_file(tmp_path: Path) -> None:
|
|
os.chdir(tmp_path)
|
|
r = call_scdl_with_auth(
|
|
"-l",
|
|
"https://soundcloud.com/one-thousand-and-one/test-track",
|
|
"--name-format",
|
|
"track",
|
|
"--onlymp3",
|
|
"--add-description",
|
|
)
|
|
assert r.returncode == 0
|
|
desc_file = Path("./track.txt")
|
|
assert desc_file.exists()
|
|
with open(desc_file, encoding="utf-8") as f:
|
|
assert f.read().splitlines() == ["test description:", "9439290883"]
|
|
|
|
|
|
def test_trim_filenames(tmp_path: Path) -> None:
|
|
os.chdir(tmp_path)
|
|
r = call_scdl_with_auth(
|
|
"-l",
|
|
"https://soundcloud.com/one-thousand-and-one/test-track",
|
|
"--name-format",
|
|
"a" * 500,
|
|
"--onlymp3",
|
|
)
|
|
assert r.returncode == 0
|
|
assert_track(tmp_path, "a" * 240 + ".mp3")
|