Add method to search (#490)

Author: joostlek

.pre-commit-config.yaml

@@ -73,7 +73,7 @@ repos:
         exclude: ^poetry\.lock$
         entry: poetry run codespell
         args:
-          - --ignore-words-list=doen,te,ons,Racoon,Crate,Ede,succes,alle
+          - --ignore-words-list=doen,te,ons,Racoon,Crate,Ede,succes,alle,Theis,serie,wel,somme,affraid,programm,earnin,couldnt,beter,als,bord,wil,hart,thuis,voight
       - id: detect-private-key
         name: 🕵️  Detect Private Keys
         language: system

src/spotifyaio/models.py

@@ -812,3 +812,68 @@ def __pre_deserialize__(cls, d: dict[str, Any]) -> dict[str, Any]:
         """Pre deserialize hook."""
         items = [item for item in d["audiobooks"] if item is not None]
         return {"audiobooks": items}
+
+
+class SearchType(StrEnum):
+    """Search types."""
+
+    ALBUM = "album"
+    ARTIST = "artist"
+    AUDIOBOOK = "audiobook"
+    EPISODE = "episode"
+    PLAYLIST = "playlist"
+    SHOW = "show"
+    TRACK = "track"
+
+
+@dataclass
+class SearchResult(DataClassORJSONMixin):
+    """Search result model."""
+
+    albums: list[SimplifiedAlbum] | None = field(default=None)
+    artists: list[SimplifiedArtist] | None = field(default=None)
+    audiobooks: list[SimplifiedAudiobook] | None = field(default=None)
+    episodes: list[SimplifiedEpisode] | None = field(default=None)
+    playlists: list[BasePlaylist] | None = field(default=None)
+    shows: list[SimplifiedShow] | None = field(default=None)
+    tracks: list[SimplifiedTrack] | None = field(default=None)
+
+    @classmethod
+    def __pre_deserialize__(cls, d: dict[str, Any]) -> dict[str, Any]:
+        """Pre deserialize hook."""
+        return {
+            **d,
+            "albums": [
+                item
+                for item in d.get("albums", {}).get("items", [])
+                if item is not None
+            ],
+            "artists": [
+                item
+                for item in d.get("artists", {}).get("items", [])
+                if item is not None
+            ],
+            "audiobooks": [
+                item
+                for item in d.get("audiobooks", {}).get("items", [])
+                if item is not None
+            ],
+            "episodes": [
+                item
+                for item in d.get("episodes", {}).get("items", [])
+                if item is not None
+            ],
+            "playlists": [
+                item
+                for item in d.get("playlists", {}).get("items", [])
+                if item is not None
+            ],
+            "shows": [
+                item for item in d.get("shows", {}).get("items", []) if item is not None
+            ],
+            "tracks": [
+                item
+                for item in d.get("tracks", {}).get("items", [])
+                if item is not None
+            ],
+        }

src/spotifyaio/spotify.py

@@ -60,6 +60,8 @@
     SavedShowResponse,
     SavedTrack,
     SavedTrackResponse,
+    SearchResult,
+    SearchType,
     Show,
     ShowEpisodesResponse,
     SimplifiedAudiobook,
@@ -715,7 +717,13 @@ async def get_playlist_cover_image(self, playlist_id: str) -> list[Image]:
 
     # Upload a custom playlist cover image
 
-    # Search for an item
+    async def search(
+        self, query: str, types: list[SearchType], *, limit: int = 48
+    ) -> SearchResult:
+        """Search."""
+        params: dict[str, Any] = {"q": query, "limit": limit, "type": ",".join(types)}
+        response = await self._get("v1/search", params=params)
+        return SearchResult.from_json(response)
 
     async def get_show(self, show_id: str) -> Show:
         """Get show."""