Merge branch 'main' into async

Author: OmLanke

.github/workflows/lint.yml

@@ -14,8 +14,11 @@ jobs:
     steps:
       - uses: actions/checkout@v4
       - uses: chartboost/ruff-action@v1
+        with:
+          version: 0.4.3
       - uses: chartboost/ruff-action@v1
         with:
+          version: 0.4.3
           args: format --check
   mypy:
     runs-on: ubuntu-latest
@@ -24,5 +27,5 @@ jobs:
       - uses: actions/setup-python@v5
         with:
           python-version: "3.8"
-      - run: pip install mypy==1.8.0
+      - run: pip install mypy==1.10.0
       - run:  mypy --install-types --non-interactive

.gitignore

@@ -1,6 +1,7 @@
 .idea
 .vscode
-**.json
+tests/*.json
+tests/setup/*.json
 docs/build
 test.cfg
 **.mp3

.pre-commit-config.yaml

@@ -1,15 +1,15 @@
 repos:
 - repo: https://github.com/astral-sh/ruff-pre-commit
   # Ruff version.
-  rev: v0.3.0
+  rev: v0.4.3
   hooks:
     # Run the linter.
     - id: ruff
     # Run the formatter.
     - id: ruff-format
 
 - repo: https://github.com/pre-commit/mirrors-mypy
-  rev: v1.8.0
+  rev: v1.10.0
   hooks:
   -   id: mypy
       verbose: true

README.rst

@@ -1,27 +1,29 @@
 ytmusicapi: Unofficial API for YouTube Music
 ############################################
 
-.. image:: https://img.shields.io/pypi/dm/ytmusicapi?style=flat-square
+.. |pypi-downloads| image:: https://img.shields.io/pypi/dm/ytmusicapi?style=flat-square
     :alt: PyPI Downloads
     :target: https://pypi.org/project/ytmusicapi/
 
-.. image:: https://badges.gitter.im/sigma67/ytmusicapi.svg
+.. |gitter| image:: https://badges.gitter.im/sigma67/ytmusicapi.svg
    :alt: Ask questions at https://gitter.im/sigma67/ytmusicapi
    :target: https://gitter.im/sigma67/ytmusicapi
 
-.. image:: https://img.shields.io/codecov/c/github/sigma67/ytmusicapi?style=flat-square
+.. |code-coverage| image:: https://img.shields.io/codecov/c/github/sigma67/ytmusicapi?style=flat-square
     :alt: Code coverage
     :target: https://codecov.io/gh/sigma67/ytmusicapi
 
-.. image:: https://img.shields.io/github/v/release/sigma67/ytmusicapi?style=flat-square
+.. |latest-release| image:: https://img.shields.io/github/v/release/sigma67/ytmusicapi?style=flat-square
     :alt: Latest release
     :target: https://github.com/sigma67/ytmusicapi/releases/latest
 
-.. image:: https://img.shields.io/github/commits-since/sigma67/ytmusicapi/latest?style=flat-square
+.. |commits-since-latest| image:: https://img.shields.io/github/commits-since/sigma67/ytmusicapi/latest?style=flat-square
     :alt: Commits since latest release
     :target: https://github.com/sigma67/ytmusicapi/commits
 
 
+|pypi-downloads| |gitter| |code-coverage| |latest-release| |commits-since-latest|
+
 ytmusicapi is a Python 3 library to send requests to the YouTube Music API.
 It emulates YouTube Music web client requests using the user's cookie data for authentication.
 

pdm.lock

@@ -1,4 +1,7 @@
+import json
 import warnings
+from pathlib import Path
+from unittest import mock
 
 import pytest
 
@@ -23,6 +26,14 @@ def test_get_artist(self, yt):
         results = yt.get_artist("UCLZ7tlKC06ResyDmEStSrOw")  # no album year
         assert len(results) >= 11
 
+    def test_get_artist_shows(self, yt_oauth):
+        # with audiobooks - only with authentication
+        results = yt_oauth.get_artist("UCyiY-0Af0O6emoI3YvCEDaA")
+        assert len(results["shows"]["results"]) == 10
+
+        results = yt_oauth.get_artist_albums(results["shows"]["browseId"], results["shows"]["params"])
+        assert len(results) == 100
+
     def test_get_artist_albums(self, yt):
         artist = yt.get_artist("UCAeLFBCQS7FvI8PvBrWvSBg")
         results = yt.get_artist_albums(artist["albums"]["browseId"], artist["albums"]["params"])
@@ -66,6 +77,15 @@ def test_get_album_browse_id_issue_470(self, yt):
         escaped_browse_id = yt.get_album_browse_id("OLAK5uy_nbMYyrfeg5ZgknoOsOGBL268hGxtcbnDM")
         assert escaped_browse_id == "MPREb_scJdtUCpPE2"
 
+    def test_get_album_2024(self, yt):
+        with open(Path(__file__).parent.parent / "data" / "2024_03_get_album.json", encoding="utf8") as f:
+            mock_response = json.load(f)
+        with mock.patch("ytmusicapi.YTMusic._send_request", return_value=mock_response):
+            album = yt.get_album("MPREabc")
+            assert len(album["tracks"]) == 19
+            assert len(album["artists"]) == 1
+            assert len(album) == 13
+
     def test_get_album(self, yt, yt_auth, sample_album):
         album = yt_auth.get_album(sample_album)
         assert len(album) >= 9

tests/data/2024_03_get_album.json

@@ -1,9 +1,30 @@
+import json
 import time
+from pathlib import Path
+from unittest import mock
 
 import pytest
 
 
 class TestPlaylists:
+    @pytest.mark.parametrize(
+        ("test_file", "owned"),
+        [
+            ("2024_03_get_playlist.json", True),
+            ("2024_03_get_playlist_public.json", False),
+        ],
+    )
+    def test_get_playlist_2024(self, yt, test_file, owned):
+        with open(Path(__file__).parent.parent / "data" / test_file, encoding="utf8") as f:
+            mock_response = json.load(f)
+        with mock.patch("ytmusicapi.YTMusic._send_request", return_value=mock_response):
+            playlist = yt.get_playlist("MPREabc")
+            assert playlist["year"] == "2024"
+            assert playlist["owned"] == owned
+            assert "hours" in playlist["duration"]
+            assert playlist["id"]
+            assert isinstance(playlist["description"], str)
+
     def test_get_playlist_foreign(self, yt, yt_auth, yt_oauth):
         with pytest.raises(Exception):
             yt.get_playlist("PLABC")
@@ -20,6 +41,22 @@ def test_get_playlist_foreign(self, yt, yt_auth, yt_oauth):
         assert len(playlist["tracks"]) > 200
         assert len(playlist["related"]) == 0
 
+    def test_get_playlist_foreign_new_format(self, yt_empty):
+        with pytest.raises(Exception):
+            yt_empty.get_playlist("PLABC")
+        playlist = yt_empty.get_playlist("PLk5BdzXBUiUe8Q5I13ZSCD8HbxMqJUUQA", limit=300, suggestions_limit=7)
+        assert len(playlist["duration"]) > 5
+        assert len(playlist["tracks"]) > 200
+        assert "suggestions" not in playlist
+        assert playlist["owned"] is False
+
+        playlist = yt_empty.get_playlist("RDATgXd-")
+        assert len(playlist["tracks"]) >= 100
+
+        playlist = yt_empty.get_playlist("PLj4BSJLnVpNyIjbCWXWNAmybc97FXLlTk", limit=None, related=True)
+        assert len(playlist["tracks"]) > 200
+        assert len(playlist["related"]) == 0
+
     def test_get_playlist_owned(self, config, yt_brand):
         playlist = yt_brand.get_playlist(config["playlists"]["own"], related=True, suggestions_limit=21)
         assert len(playlist["tracks"]) < 100
@@ -52,7 +89,7 @@ def test_edit_playlist(self, config, yt_brand):
         )
         assert response == "STATUS_SUCCEEDED", "Playlist edit failed"
 
-    def test_end2end(self, config, yt_brand, sample_video):
+    def test_end2end(self, yt_brand, sample_video):
         playlist_id = yt_brand.create_playlist(
             "test",
             "test description",
@@ -70,6 +107,7 @@ def test_end2end(self, config, yt_brand, sample_video):
         assert len(response["playlistEditResults"]) > 0, "Adding playlist item failed"
         time.sleep(3)
         yt_brand.edit_playlist(playlist_id, addToTop=False)
+        time.sleep(3)
         playlist = yt_brand.get_playlist(playlist_id, related=True)
         assert len(playlist["tracks"]) == 46, "Getting playlist items failed"
         response = yt_brand.remove_playlist_items(playlist_id, playlist["tracks"])