get_album: rename track_number to trackNumber

lucasmrthomaz · Jan 21, 2024 · 650bc24 · 650bc24
1 parent 9170197
commit 650bc24
Show file tree

Hide file tree

Showing 4 changed files with 8 additions and 7 deletions.
diff --git a/tests/mixins/test_browsing.py b/tests/mixins/test_browsing.py
@@ -72,7 +72,7 @@ def test_get_album(self, yt, yt_auth, sample_album):
         assert results["tracks"][0]["isExplicit"]
         assert all(item["views"] is not None for item in results["tracks"])
         assert all(item["album"] is not None for item in results["tracks"])
-        assert results["tracks"][0]["track_number"] == 1
+        assert results["tracks"][0]["trackNumber"] == 1
         assert "feedbackTokens" in results["tracks"][0]
         assert len(results["other_versions"]) >= 1  # appears to be regional
         results = yt.get_album("MPREb_BQZvl3BFGay")
@@ -81,10 +81,10 @@ def test_get_album(self, yt, yt_auth, sample_album):
         results = yt.get_album("MPREb_rqH94Zr3NN0")
         assert len(results["tracks"][0]["artists"]) == 2
         results = yt.get_album("MPREb_TPH4WqN5pUo")  # album with tracks completely removed/missing
-        assert results["tracks"][0]["track_number"] == 3
-        assert results["tracks"][13]["track_number"] == 18
+        assert results["tracks"][0]["trackNumber"] == 3
+        assert results["tracks"][13]["trackNumber"] == 18
         results = yt.get_album("MPREb_YuigcYm2erf")  # album with track (#8) disabled/greyed out
-        assert results["tracks"][7]["track_number"] is None
+        assert results["tracks"][7]["trackNumber"] is None
 
     def test_get_song(self, config, yt, yt_oauth, sample_video):
         song = yt_oauth.get_song(config["uploads"]["private_upload_id"])  # private upload

diff --git a/ytmusicapi/mixins/browsing.py b/ytmusicapi/mixins/browsing.py
@@ -437,7 +437,7 @@ def get_album(self, browseId: str) -> Dict:
             returned by :py:func:`search`
         :return: Dictionary with album and track metadata.
 
-        Each track is in the following format::
+        The result is in the following format::
 
             {
               "title": "Revival",
@@ -471,6 +471,7 @@ def get_album(self, browseId: str) -> Dict:
                   "isExplicit": true,
                   "duration": "5:03",
                   "duration_seconds": 303,
+                  "trackNumber": 0,
                   "feedbackTokens": {
                     "add": "AB9zfpK...",
                     "remove": "AB9zfpK..."

diff --git a/ytmusicapi/mixins/playlists.py b/ytmusicapi/mixins/playlists.py
@@ -26,7 +26,7 @@ def get_playlist(
         :return: Dictionary with information about the playlist.
             The key ``tracks`` contains a List of playlistItem dictionaries
 
-        Each item is in the following format::
+        The result is in the following format::
 
             {
               "id": "PLQwVIlKxHM6qv-o99iX9R85og7IzF9YS_",

diff --git a/ytmusicapi/parsers/playlists.py b/ytmusicapi/parsers/playlists.py
@@ -94,7 +94,7 @@ def parse_playlist_items(results, menu_entries: Optional[List[List]] = None, is_
         }
 
         if is_album:
-            song["track_number"] = int(nav(data, ["index", "runs", 0, "text"])) if isAvailable else None
+            song["trackNumber"] = int(nav(data, ["index", "runs", 0, "text"])) if isAvailable else None
 
         if duration:
             song["duration"] = duration