1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388
|
from typing import Any, Optional, Union
from ytmusicapi.continuations import get_continuations
from ytmusicapi.exceptions import YTMusicUserError
from ytmusicapi.mixins._protocol import MixinProtocol
from ytmusicapi.parsers.search import *
class SearchMixin(MixinProtocol):
def search(
self,
query: str,
filter: Optional[str] = None,
scope: Optional[str] = None,
limit: int = 20,
ignore_spelling: bool = False,
) -> list[dict]:
"""
Search YouTube music
Returns results within the provided category.
:param query: Query string, i.e. 'Oasis Wonderwall'
:param filter: Filter for item types. Allowed values: ``songs``, ``videos``, ``albums``, ``artists``, ``playlists``, ``community_playlists``, ``featured_playlists``, ``uploads``.
Default: Default search, including all types of items.
:param scope: Search scope. Allowed values: ``library``, ``uploads``.
Default: Search the public YouTube Music catalogue.
Changing scope from the default will reduce the number of settable filters. Setting a filter that is not permitted will throw an exception.
For uploads, no filter can be set.
For library, community_playlists and featured_playlists filter cannot be set.
:param limit: Number of search results to return
Default: 20
:param ignore_spelling: Whether to ignore YTM spelling suggestions.
If True, the exact search term will be searched for, and will not be corrected.
This does not have any effect when the filter is set to ``uploads``.
Default: False, will use YTM's default behavior of autocorrecting the search.
:return: List of results depending on filter.
resultType specifies the type of item (important for default search).
albums, artists and playlists additionally contain a browseId, corresponding to
albumId, channelId and playlistId (browseId=`VL`+playlistId)
Example list for default search with one result per resultType for brevity. Normally
there are 3 results per resultType and an additional ``thumbnails`` key::
[
{
"category": "Top result",
"resultType": "video",
"videoId": "vU05Eksc_iM",
"title": "Wonderwall",
"artists": [
{
"name": "Oasis",
"id": "UCmMUZbaYdNH0bEd1PAlAqsA"
}
],
"views": "1.4M",
"videoType": "MUSIC_VIDEO_TYPE_OMV",
"duration": "4:38",
"duration_seconds": 278
},
{
"category": "Songs",
"resultType": "song",
"videoId": "ZrOKjDZOtkA",
"title": "Wonderwall",
"artists": [
{
"name": "Oasis",
"id": "UCmMUZbaYdNH0bEd1PAlAqsA"
}
],
"album": {
"name": "(What's The Story) Morning Glory? (Remastered)",
"id": "MPREb_9nqEki4ZDpp"
},
"duration": "4:19",
"duration_seconds": 259
"isExplicit": false,
"feedbackTokens": {
"add": null,
"remove": null
}
},
{
"category": "Albums",
"resultType": "album",
"browseId": "MPREb_IInSY5QXXrW",
"playlistId": "OLAK5uy_kunInnOpcKECWIBQGB0Qj6ZjquxDvfckg",
"title": "(What's The Story) Morning Glory?",
"type": "Album",
"artist": "Oasis",
"year": "1995",
"isExplicit": false
},
{
"category": "Community playlists",
"resultType": "playlist",
"browseId": "VLPLK1PkWQlWtnNfovRdGWpKffO1Wdi2kvDx",
"title": "Wonderwall - Oasis",
"author": "Tate Henderson",
"itemCount": "174"
},
{
"category": "Videos",
"resultType": "video",
"videoId": "bx1Bh8ZvH84",
"title": "Wonderwall",
"artists": [
{
"name": "Oasis",
"id": "UCmMUZbaYdNH0bEd1PAlAqsA"
}
],
"views": "386M",
"duration": "4:38",
"duration_seconds": 278
},
{
"category": "Artists",
"resultType": "artist",
"browseId": "UCmMUZbaYdNH0bEd1PAlAqsA",
"artist": "Oasis",
"shuffleId": "RDAOkjHYJjL1a3xspEyVkhHAsg",
"radioId": "RDEMkjHYJjL1a3xspEyVkhHAsg"
},
{
"category": "Profiles",
"resultType": "profile",
"title": "Taylor Swift Time",
"name": "@TaylorSwiftTime",
"browseId": "UCSCRK7XlVQ6fBdEl00kX6pQ",
"thumbnails": ...
}
]
"""
body = {"query": query}
endpoint = "search"
search_results: list[dict[str, Any]] = []
filters = [
"albums",
"artists",
"playlists",
"community_playlists",
"featured_playlists",
"songs",
"videos",
"profiles",
"podcasts",
"episodes",
]
if filter and filter not in filters:
raise YTMusicUserError(
"Invalid filter provided. Please use one of the following filters or leave out the parameter: "
+ ", ".join(filters)
)
scopes = ["library", "uploads"]
if scope and scope not in scopes:
raise YTMusicUserError(
"Invalid scope provided. Please use one of the following scopes or leave out the parameter: "
+ ", ".join(scopes)
)
if scope == scopes[1] and filter:
raise YTMusicUserError(
"No filter can be set when searching uploads. Please unset the filter parameter when scope is set to "
"uploads. "
)
if scope == scopes[0] and filter in filters[3:5]:
raise YTMusicUserError(
f"{filter} cannot be set when searching library. "
f"Please use one of the following filters or leave out the parameter: "
+ ", ".join(filters[0:3] + filters[5:])
)
params = get_search_params(filter, scope, ignore_spelling)
if params:
body["params"] = params
response = self._send_request(endpoint, body)
# no results
if "contents" not in response:
return search_results
if "tabbedSearchResultsRenderer" in response["contents"]:
tab_index = 0 if not scope or filter else scopes.index(scope) + 1
results = response["contents"]["tabbedSearchResultsRenderer"]["tabs"][tab_index]["tabRenderer"][
"content"
]
else:
results = response["contents"]
section_list = nav(results, SECTION_LIST)
# no results
if len(section_list) == 1 and "itemSectionRenderer" in section_list:
return search_results
# set filter for parser
if filter and "playlists" in filter:
filter = "playlists"
elif scope == scopes[1]:
filter = scopes[1]
for res in section_list:
result_type = category = None
if "musicCardShelfRenderer" in res:
top_result = parse_top_result(
res["musicCardShelfRenderer"], self.parser.get_search_result_types()
)
search_results.append(top_result)
if not (shelf_contents := nav(res, ["musicCardShelfRenderer", "contents"], True)):
continue
# if "more from youtube" is present, remove it - it's not parseable
if "messageRenderer" in shelf_contents[0]:
category = nav(shelf_contents.pop(0), ["messageRenderer", *TEXT_RUN_TEXT])
elif "musicShelfRenderer" in res:
shelf_contents = res["musicShelfRenderer"]["contents"]
category = nav(res, MUSIC_SHELF + TITLE_TEXT, True)
# if we know the filter it's easy to set the result type
# unfortunately uploads is modeled as a filter (historical reasons),
# so we take care to not set the result type for that scope
if filter and not scope == scopes[1]:
result_type = filter[:-1].lower()
else:
continue
api_search_result_types = self.parser.get_api_result_types()
search_results.extend(
parse_search_results(shelf_contents, api_search_result_types, result_type, category)
)
if filter: # if filter is set, there are continuations
def request_func(additionalParams):
return self._send_request(endpoint, body, additionalParams)
def parse_func(contents):
return parse_search_results(contents, api_search_result_types, result_type, category)
search_results.extend(
get_continuations(
res["musicShelfRenderer"],
"musicShelfContinuation",
limit - len(search_results),
request_func,
parse_func,
)
)
return search_results
def get_search_suggestions(self, query: str, detailed_runs=False) -> Union[list[str], list[dict]]:
"""
Get Search Suggestions
:param query: Query string, i.e. 'faded'
:param detailed_runs: Whether to return detailed runs of each suggestion.
If True, it returns the query that the user typed and the remaining
suggestion along with the complete text (like many search services
usually bold the text typed by the user).
Default: False, returns the list of search suggestions in plain text.
:return: A list of search suggestions. If ``detailed_runs`` is False, it returns plain text suggestions.
If ``detailed_runs`` is True, it returns a list of dictionaries with detailed information.
Example response when ``query`` is 'fade' and ``detailed_runs`` is set to ``False``::
[
"faded",
"faded alan walker lyrics",
"faded alan walker",
"faded remix",
"faded song",
"faded lyrics",
"faded instrumental"
]
Example response when ``detailed_runs`` is set to ``True``::
[
{
"text": "faded",
"runs": [
{
"text": "fade",
"bold": true
},
{
"text": "d"
}
],
"fromHistory": true,
"feedbackToken": "AEEJK..."
},
{
"text": "faded alan walker lyrics",
"runs": [
{
"text": "fade",
"bold": true
},
{
"text": "d alan walker lyrics"
}
],
"fromHistory": false,
"feedbackToken": None
},
{
"text": "faded alan walker",
"runs": [
{
"text": "fade",
"bold": true
},
{
"text": "d alan walker"
}
],
"fromHistory": false,
"feedbackToken": None
},
...
]
"""
body = {"input": query}
endpoint = "music/get_search_suggestions"
response = self._send_request(endpoint, body)
return parse_search_suggestions(response, detailed_runs)
def remove_search_suggestions(
self, suggestions: list[dict[str, Any]], indices: Optional[list[int]] = None
) -> bool:
"""
Remove search suggestion from the user search history.
:param suggestions: The dictionary obtained from the :py:func:`get_search_suggestions`
(with detailed_runs=True)`
:param indices: Optional. The indices of the suggestions to be removed. Default: remove all suggestions.
:return: True if the operation was successful, False otherwise.
Example usage::
# Removing suggestion number 0
suggestions = ytmusic.get_search_suggestions(query="fade", detailed_runs=True)
success = ytmusic.remove_search_suggestions(suggestions=suggestions, indices=[0])
if success:
print("Suggestion removed successfully")
else:
print("Failed to remove suggestion")
"""
if not any(run["fromHistory"] for run in suggestions):
raise YTMusicUserError(
"No search result from history provided. "
"Please run get_search_suggestions first to retrieve suggestions. "
"Ensure that you have searched a similar term before."
)
if indices is None:
indices = list(range(len(suggestions)))
if any(index >= len(suggestions) for index in indices):
raise YTMusicUserError("Index out of range. Index must be smaller than the length of suggestions")
feedback_tokens = [suggestions[index]["feedbackToken"] for index in indices]
if all(feedback_token is None for feedback_token in feedback_tokens):
return False
# filter None tokens
feedback_tokens = [token for token in feedback_tokens if token is not None]
body = {"feedbackTokens": feedback_tokens}
endpoint = "feedback"
response = self._send_request(endpoint, body)
return bool(nav(response, ["feedbackResponses", 0, "isProcessed"], none_if_absent=True))
|