library: add protocol SupportsDiscoveryTopList

feeluown/library/provider_protocol.py

@@ -5,7 +5,7 @@
 from .models import (
  BriefCommentModel, SongModel, VideoModel, AlbumModel, ArtistModel,
  PlaylistModel, UserModel, ModelType, BriefArtistModel, BriefSongModel,
- LyricModel, BriefVideoModel,
+ LyricModel, BriefVideoModel, BriefPlaylistModel,
 )
 from .collection import Collection
 
@@ -375,6 +375,22 @@ def current_user_fav_create_videos_rd(self):
  pass
 
 
+@runtime_checkable
+class SupportsDiscoveryToplist(Protocol):
+ @abstractmethod
+ def discovery_list_toplist(self) -> List[BriefPlaylistModel]:
+ """List all toplist(排行榜)."""
+
+ @abstractmethod
+ def discovery_get_toplist(self, toplist_id) -> PlaylistModel:
+ """Get toplist details.
+
+ For some providers, the toplist model(schema) may be different from the
+ PlaylistModel. They should think about a way to solve this. For example,
+ turn the identifier into `toplist_{id}` and do some hack in playlist_get API.
+ """
+
+
 #
 # Protocols for recommendation.
 #