Merge pull request #24 from feeluown/codex/enrich-model-fields

refine song/watch mapping and model fixtures

Author: cosven

fuo_ytmusic/models.py

@@ -132,6 +132,23 @@ def duration_ms(self) -> int:
         return int(timeparse(self.duration) * 1000)
 
 
+def _parse_album_type(raw_type) -> AlbumType:
+    text = str(raw_type or "").strip().lower()
+    if not text:
+        return AlbumType.standard
+    if "single" in text or "单曲" in text:
+        return AlbumType.single
+    if text == "ep" or re.search(r"\bep\b", text):
+        return AlbumType.ep
+    if "live" in text:
+        return AlbumType.live
+    if "compilation" in text:
+        return AlbumType.compilation
+    if "retrospective" in text:
+        return AlbumType.retrospective
+    return AlbumType.standard
+
+
 class YtmusicAlbumSong(BaseModel, YtmusicArtistsMixin, YtmusicDurationMixin):
     title: str
     album: str
@@ -144,7 +161,7 @@ def v2_brief_model(self) -> BriefSongModel:
             title=self.title,
             artists_name=self.artists_name,
             album_name=self.album,
-            duration_ms=self.duration,
+            duration_ms=self.duration or "",
         )
 
     def v2_model_with_brief_album(self, album: BriefAlbumModel) -> SongModelV2:
@@ -192,7 +209,7 @@ def v2_brief_model(self) -> BriefSongModel:
             title=self.title,
             artists_name=self.artists_name,
             album_name=self.album.name if self.album else "",
-            duration_ms=self.duration,
+            duration_ms=self.duration or "",
         )
         if not song.identifier:
             song.state = ModelState.not_exists
@@ -219,9 +236,17 @@ def v2_model(self) -> SongModelV2:
 
 class YtmusicWatchPlaylistSong(YtmusicSearchSong):
     year: str  # This field exists in get_watch_playlist API.
+    length: str  # watch playlist uses `length` instead of `duration`.
+    watch_thumbnail: List[SearchNestedThumbnail] = Field(
+        default_factory=list, alias="thumbnail"
+    )  # watch playlist uses singular key.
 
     def v2_model(self) -> SongModelV2:
         song = super().v2_model()
+        if song.duration <= 0 and self.length:
+            song.duration = int(timeparse(self.length) * 1000)
+        if not song.pic_url and self.watch_thumbnail:
+            song.pic_url = self.watch_thumbnail[-1].url or ""
         song.date = self.year or ""
         return song
 
@@ -261,7 +286,7 @@ def v2_brief_model(self) -> BriefSongModel:
             title=self.title,
             artists_name=self.artists_name,
             album_name=self.album.name if self.album else "",
-            duration_ms=self.duration,
+            duration_ms=self.duration or "",
         )
         if not song.identifier:
             song.state = ModelState.not_exists
@@ -277,9 +302,7 @@ class YtmusicSearchAlbum(YtmusicSearchBase, YtmusicCoverMixin, YtmusicArtistsMix
 
     @property
     def album_type(self) -> AlbumType:
-        if self.type == "Single":
-            return AlbumType.single
-        return AlbumType.standard
+        return _parse_album_type(self.type)
 
     def v2_brief_model(self) -> BriefAlbumModel:
         return BriefAlbumModel(
@@ -334,9 +357,12 @@ def v2_model(self) -> VideoModel:
             identifier=self.videoId,
             source=self.source,
             title=self.title,
-            cover=self.cover,
+            cover=self.cover or "",
             artists=self.v2_brief_artist_models(),
             duration=self.duration_ms,
+            # YTMusic list APIs expose localized text views (e.g. 2.8B/28亿次观看),
+            # which is not stable enough for reliable numeric parsing.
+            play_count=-1,
         )
 
 
@@ -406,8 +432,14 @@ def v2_model(self, identifier) -> ArtistModelV2:
             name=self.name,
             pic_url=(self.thumbnails[0].url if self.thumbnails else ""),
             aliases=[],
-            hot_songs=[],
+            hot_songs=[
+                song.v2_brief_model()
+                for song in (self.songs.results if self.songs else []) or []
+            ],
             description=self.description or "",
+            song_count=-1,
+            album_count=-1,
+            mv_count=-1,
         )
 
 
@@ -422,6 +454,10 @@ class AlbumInfo(BaseModel, YtmusicArtistsMixin, YtmusicCoverMixin):
     # ytmusicapi.get_album has this field. Not sure if other api has this field.
     description: str = ""
 
+    @property
+    def album_type(self) -> AlbumType:
+        return _parse_album_type(self.type)
+
     def v2_model_with_identifier(self, identifier) -> AlbumModelV2:
         brief_album = BriefAlbumModel(
             identifier=identifier,
@@ -434,7 +470,9 @@ def v2_model_with_identifier(self, identifier) -> AlbumModelV2:
             source=self.source,
             name=self.title,
             cover=self.cover,
+            type_=self.album_type,
             songs=[t.v2_model_with_brief_album(brief_album) for t in self.tracks],
+            song_count=self.trackCount if self.trackCount is not None else -1,
             artists=self.v2_brief_artist_models(),
             description=self.description or "",  # description may be None
             released=self.year or "",  # year may be None

fuo_ytmusic/provider.py

@@ -431,12 +431,7 @@ def _song_get_media_from_ytdlp(self, song: SongModel) -> Optional[Media]:
         if cookiefile_path:
             ytdl_opts["cookiefile"] = cookiefile_path
 
-        debug_opts = dict(ytdl_opts)
-        debug_opts.pop("logger", None)
-        print(f"song_get_media yt-dlp options for {song.identifier}: {debug_opts}")
-
         url = self.song_get_web_url(song)
-        print(f"song_get_media source url for {song.identifier}: {url}")
         with _NoCookieSaveYoutubeDL(ytdl_opts) as inner:
             info = inner.extract_info(url, download=False)
         media_url = info.get("url")
@@ -477,9 +472,7 @@ def song_get(self, identifier):
         # hack(cosven): we use get_watch_playlist to try to get song detail.
         # It works for song like '如愿-王菲'.
         result = self.service.api.get_watch_playlist(identifier)
-        songs = [
-            YtmusicWatchPlaylistSong(**track).v2_model() for track in result["tracks"]
-        ]
+        songs = [YtmusicWatchPlaylistSong(**track).v2_model() for track in result["tracks"]]
         for song in songs:
             if song.identifier == identifier:
                 return song

manual_tests/capture_model_field_fixtures.py

@@ -0,0 +1,78 @@
+"""Capture real YTMusic payloads and export raw test fixtures.
+
+Usage:
+  YTMUSIC_MANUAL_PROXY=http://127.0.0.1:7890 \
+    uv run python manual_tests/capture_model_field_fixtures.py
+"""
+
+from __future__ import annotations
+
+import json
+import os
+from pathlib import Path
+
+from fuo_ytmusic.consts import HEADER_FILE
+from fuo_ytmusic.service import YtmusicService
+
+FIXTURES_DIR = Path(__file__).resolve().parent.parent / "tests" / "fixtures"
+
+# Use stable objects so fixtures can be refreshed predictably.
+SINGLE_ALBUM_ID = "MPREb_lUTbpM4Z2C7"  # Adele - Hello (single)
+EP_ALBUM_ID = "MPREb_Ag93Bmsdecj"  # Shape of You (EP)
+ARTIST_ID = "UCRw0x9_EfawqmgDI2IgQLLg"  # Adele
+
+
+def _write_fixture(filename: str, payload: dict):
+    FIXTURES_DIR.mkdir(parents=True, exist_ok=True)
+    path = FIXTURES_DIR / filename
+    path.write_text(
+        json.dumps(payload, ensure_ascii=True, indent=2) + "\n",
+        encoding="utf-8",
+    )
+    print(f"wrote fixture: {path}")
+
+
+def main():
+    if not HEADER_FILE.exists():
+        raise SystemExit(f"header file not found: {HEADER_FILE}")
+
+    service = YtmusicService()
+    proxy = os.getenv("YTMUSIC_MANUAL_PROXY", "").strip()
+    if proxy:
+        service.setup_http_proxy(proxy)
+    service.setup_timeout(12)
+    service.setup_language("en")
+    service.reinitialize_by_headerfile(HEADER_FILE)
+
+    album = service.api.get_album(SINGLE_ALBUM_ID)
+    album_ep = service.api.get_album(EP_ALBUM_ID)
+    artist = service.api.get_artist(ARTIST_ID)
+    tracks = album.get("tracks") or []
+    if not tracks:
+        raise SystemExit("album payload has no tracks; cannot build song fixture")
+    song_id = tracks[0].get("videoId")
+    if not song_id:
+        raise SystemExit("album first track has no videoId; cannot build song fixture")
+    song = service.api.get_song(song_id)
+
+    videos = (artist.get("videos") or {}).get("results") or []
+    if not videos:
+        raise SystemExit("artist payload has no videos; cannot build video fixture")
+
+    _write_fixture("model_fields_get_album_single.json", album)
+    _write_fixture("model_fields_get_album_ep.json", album_ep)
+    _write_fixture("model_fields_get_artist.json", artist)
+    _write_fixture("model_fields_artist_video_item.json", videos[0])
+    _write_fixture("model_fields_get_song.json", song)
+
+    # Capture one zh-CN video entry to keep count parser tests grounded.
+    service.setup_language("zh_CN")
+    service.reinitialize_by_headerfile(HEADER_FILE)
+    artist_zh = service.api.get_artist(ARTIST_ID)
+    videos_zh = (artist_zh.get("videos") or {}).get("results") or []
+    if videos_zh:
+        _write_fixture("model_fields_artist_video_item_zh.json", videos_zh[0])
+
+
+if __name__ == "__main__":
+    main()

tests/fixtures/model_fields_artist_video_item.json

@@ -0,0 +1,24 @@
+{
+  "title": "Rolling in the Deep (Official Music Video)",
+  "videoId": "rYEDA3JcQqw",
+  "artists": [
+    {
+      "name": "Adele",
+      "id": "UCRw0x9_EfawqmgDI2IgQLLg"
+    }
+  ],
+  "playlistId": "OLAK5uy_lbAdfElcZUXWuAGUNbL1xNzVmJSI5898o",
+  "thumbnails": [
+    {
+      "url": "https://i.ytimg.com/vi/rYEDA3JcQqw/sddefault.jpg?sqp=-oaymwEWCJADEOEBIAQqCghqEJQEGHgg6AJIWg&rs=AMzJL3mgOqWKJVMW-e2LnY0NvLtF4jLQtA",
+      "width": 400,
+      "height": 225
+    },
+    {
+      "url": "https://i.ytimg.com/vi/rYEDA3JcQqw/hq720.jpg?sqp=-oaymwEXCKAGEMIDIAQqCwjVARCqCBh4INgESFo&rs=AMzJL3k--WyP6E9zfCW4iCPvgUbng86Z2A",
+      "width": 800,
+      "height": 450
+    }
+  ],
+  "views": "2.8B"
+}

tests/fixtures/model_fields_artist_video_item_zh.json

@@ -0,0 +1,24 @@
+{
+  "title": "Rolling in the Deep (Official Music Video)",
+  "videoId": "rYEDA3JcQqw",
+  "artists": [
+    {
+      "name": "Adele",
+      "id": "UCRw0x9_EfawqmgDI2IgQLLg"
+    }
+  ],
+  "playlistId": "OLAK5uy_lbAdfElcZUXWuAGUNbL1xNzVmJSI5898o",
+  "thumbnails": [
+    {
+      "url": "https://i.ytimg.com/vi/rYEDA3JcQqw/sddefault.jpg?sqp=-oaymwEWCJADEOEBIAQqCghqEJQEGHgg6AJIWg&rs=AMzJL3mgOqWKJVMW-e2LnY0NvLtF4jLQtA",
+      "width": 400,
+      "height": 225
+    },
+    {
+      "url": "https://i.ytimg.com/vi/rYEDA3JcQqw/hq720.jpg?sqp=-oaymwEXCKAGEMIDIAQqCwjVARCqCBh4INgESFo&rs=AMzJL3k--WyP6E9zfCW4iCPvgUbng86Z2A",
+      "width": 800,
+      "height": 450
+    }
+  ],
+  "views": "28\u4ebf\u6b21\u89c2\u770b"
+}