evlli/hass-core
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Improve typing of Spotify (#66109)

Browse source 
Co-authored-by: Martin Hjelmare <marhje52@gmail.com>
This commit is contained in:
Franck Nijhof 2022-02-08 23:07:13 +01:00 • committed by GitHub
parent b012b79167
commit b9f21d4e07
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
7 changed files with 253 additions and 189 deletions
Download patch file Download diff file Expand all files Collapse all files

22
homeassistant/components/spotify/__init__.py
View file

@ -4,7 +4,7 @@ import aiohttp
from spotipy import Spotify, SpotifyException from spotipy import Spotify, SpotifyException
import voluptuous as vol import voluptuous as vol
from homeassistant.components.media_player import BrowseError from homeassistant.components.media_player import BrowseError, BrowseMedia
from homeassistant.config_entries import ConfigEntry from homeassistant.config_entries import ConfigEntry
from homeassistant.const import ( from homeassistant.const import (
ATTR_CREDENTIALS, ATTR_CREDENTIALS,
@ -47,19 +47,23 @@ CONFIG_SCHEMA = vol.Schema(
PLATFORMS = [Platform.MEDIA_PLAYER] PLATFORMS = [Platform.MEDIA_PLAYER]
def is_spotify_media_type(media_content_type): def is_spotify_media_type(media_content_type: str) -> bool:
"""Return whether the media_content_type is a valid Spotify media_id.""" """Return whether the media_content_type is a valid Spotify media_id."""
return media_content_type.startswith(MEDIA_PLAYER_PREFIX) return media_content_type.startswith(MEDIA_PLAYER_PREFIX)
def resolve_spotify_media_type(media_content_type): def resolve_spotify_media_type(media_content_type: str) -> str:
"""Return actual spotify media_content_type.""" """Return actual spotify media_content_type."""
return media_content_type[len(MEDIA_PLAYER_PREFIX) :] return media_content_type[len(MEDIA_PLAYER_PREFIX) :]
async def async_browse_media( async def async_browse_media(
hass, media_content_type, media_content_id, *, can_play_artist=True hass: HomeAssistant,
): media_content_type: str,
media_content_id: str,
*,
can_play_artist: bool = True,
) -> BrowseMedia:
"""Browse Spotify media.""" """Browse Spotify media."""
if not (info := next(iter(hass.data[DOMAIN].values()), None)): if not (info := next(iter(hass.data[DOMAIN].values()), None)):
raise BrowseError("No Spotify accounts available") raise BrowseError("No Spotify accounts available")
@ -128,12 +132,6 @@ async def async_setup_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool:
async def async_unload_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool: async def async_unload_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool:
"""Unload Spotify config entry.""" """Unload Spotify config entry."""
# Unload entities for this entry/device. if unload_ok := await hass.config_entries.async_unload_platforms(entry, PLATFORMS):
unload_ok = await hass.config_entries.async_unload_platforms(entry, PLATFORMS)
# Cleanup
del hass.data[DOMAIN][entry.entry_id] del hass.data[DOMAIN][entry.entry_id]
if not hass.data[DOMAIN]:
del hass.data[DOMAIN]
return unload_ok return unload_ok

23
homeassistant/components/spotify/config_flow.py
View file

@ -8,6 +8,7 @@ from spotipy import Spotify
import voluptuous as vol import voluptuous as vol
from homeassistant.components import persistent_notification from homeassistant.components import persistent_notification
from homeassistant.config_entries import ConfigEntry
from homeassistant.data_entry_flow import FlowResult from homeassistant.data_entry_flow import FlowResult
from homeassistant.helpers import config_entry_oauth2_flow from homeassistant.helpers import config_entry_oauth2_flow
@ -22,10 +23,7 @@ class SpotifyFlowHandler(
DOMAIN = DOMAIN DOMAIN = DOMAIN
VERSION = 1 VERSION = 1
def __init__(self) -> None: reauth_entry: ConfigEntry | None = None
"""Instantiate config flow."""
super().__init__()
self.entry: dict[str, Any] | None = None
@property @property
def logger(self) -> logging.Logger: def logger(self) -> logging.Logger:
@ -48,7 +46,7 @@ class SpotifyFlowHandler(
name = data["id"] = current_user["id"] name = data["id"] = current_user["id"]
if self.entry and self.entry["id"] != current_user["id"]: if self.reauth_entry and self.reauth_entry.data["id"] != current_user["id"]:
return self.async_abort(reason="reauth_account_mismatch") return self.async_abort(reason="reauth_account_mismatch")
if current_user.get("display_name"): if current_user.get("display_name"):
@ -61,8 +59,9 @@ class SpotifyFlowHandler(
async def async_step_reauth(self, entry: dict[str, Any]) -> FlowResult: async def async_step_reauth(self, entry: dict[str, Any]) -> FlowResult:
"""Perform reauth upon migration of old entries.""" """Perform reauth upon migration of old entries."""
if entry: self.reauth_entry = self.hass.config_entries.async_get_entry(
self.entry = entry self.context["entry_id"]
)
persistent_notification.async_create( persistent_notification.async_create(
self.hass, self.hass,
@ -77,16 +76,18 @@ class SpotifyFlowHandler(
self, user_input: dict[str, Any] | None = None self, user_input: dict[str, Any] | None = None
) -> FlowResult: ) -> FlowResult:
"""Confirm reauth dialog.""" """Confirm reauth dialog."""
if user_input is None: if self.reauth_entry is None:
return self.async_abort(reason="reauth_account_mismatch")
if user_input is None and self.reauth_entry:
return self.async_show_form( return self.async_show_form(
step_id="reauth_confirm", step_id="reauth_confirm",
description_placeholders={"account": self.entry["id"]}, description_placeholders={"account": self.reauth_entry.data["id"]},
data_schema=vol.Schema({}), data_schema=vol.Schema({}),
errors={}, errors={},
) )
persistent_notification.async_dismiss(self.hass, "spotify_reauth") persistent_notification.async_dismiss(self.hass, "spotify_reauth")
return await self.async_step_pick_implementation( return await self.async_step_pick_implementation(
user_input={"implementation": self.entry["auth_implementation"]} user_input={"implementation": self.reauth_entry.data["auth_implementation"]}
) )

305
homeassistant/components/spotify/media_player.py
View file

@ -6,6 +6,7 @@ import datetime as dt
from datetime import timedelta from datetime import timedelta
from functools import partial from functools import partial
import logging import logging
from typing import Any
import requests import requests
from spotipy import Spotify, SpotifyException from spotipy import Spotify, SpotifyException
@ -128,57 +129,57 @@ class BrowsableMedia(StrEnum):
LIBRARY_MAP = { LIBRARY_MAP = {
BrowsableMedia.CURRENT_USER_PLAYLISTS: "Playlists", BrowsableMedia.CURRENT_USER_PLAYLISTS.value: "Playlists",
BrowsableMedia.CURRENT_USER_FOLLOWED_ARTISTS: "Artists", BrowsableMedia.CURRENT_USER_FOLLOWED_ARTISTS.value: "Artists",
BrowsableMedia.CURRENT_USER_SAVED_ALBUMS: "Albums", BrowsableMedia.CURRENT_USER_SAVED_ALBUMS.value: "Albums",
BrowsableMedia.CURRENT_USER_SAVED_TRACKS: "Tracks", BrowsableMedia.CURRENT_USER_SAVED_TRACKS.value: "Tracks",
BrowsableMedia.CURRENT_USER_SAVED_SHOWS: "Podcasts", BrowsableMedia.CURRENT_USER_SAVED_SHOWS.value: "Podcasts",
BrowsableMedia.CURRENT_USER_RECENTLY_PLAYED: "Recently played", BrowsableMedia.CURRENT_USER_RECENTLY_PLAYED.value: "Recently played",
BrowsableMedia.CURRENT_USER_TOP_ARTISTS: "Top Artists", BrowsableMedia.CURRENT_USER_TOP_ARTISTS.value: "Top Artists",
BrowsableMedia.CURRENT_USER_TOP_TRACKS: "Top Tracks", BrowsableMedia.CURRENT_USER_TOP_TRACKS.value: "Top Tracks",
BrowsableMedia.CATEGORIES: "Categories", BrowsableMedia.CATEGORIES.value: "Categories",
BrowsableMedia.FEATURED_PLAYLISTS: "Featured Playlists", BrowsableMedia.FEATURED_PLAYLISTS.value: "Featured Playlists",
BrowsableMedia.NEW_RELEASES: "New Releases", BrowsableMedia.NEW_RELEASES.value: "New Releases",
} }
CONTENT_TYPE_MEDIA_CLASS = { CONTENT_TYPE_MEDIA_CLASS: dict[str, Any] = {
BrowsableMedia.CURRENT_USER_PLAYLISTS: { BrowsableMedia.CURRENT_USER_PLAYLISTS.value: {
"parent": MEDIA_CLASS_DIRECTORY, "parent": MEDIA_CLASS_DIRECTORY,
"children": MEDIA_CLASS_PLAYLIST, "children": MEDIA_CLASS_PLAYLIST,
}, },
BrowsableMedia.CURRENT_USER_FOLLOWED_ARTISTS: { BrowsableMedia.CURRENT_USER_FOLLOWED_ARTISTS.value: {
"parent": MEDIA_CLASS_DIRECTORY, "parent": MEDIA_CLASS_DIRECTORY,
"children": MEDIA_CLASS_ARTIST, "children": MEDIA_CLASS_ARTIST,
}, },
BrowsableMedia.CURRENT_USER_SAVED_ALBUMS: { BrowsableMedia.CURRENT_USER_SAVED_ALBUMS.value: {
"parent": MEDIA_CLASS_DIRECTORY, "parent": MEDIA_CLASS_DIRECTORY,
"children": MEDIA_CLASS_ALBUM, "children": MEDIA_CLASS_ALBUM,
}, },
BrowsableMedia.CURRENT_USER_SAVED_TRACKS: { BrowsableMedia.CURRENT_USER_SAVED_TRACKS.value: {
"parent": MEDIA_CLASS_DIRECTORY, "parent": MEDIA_CLASS_DIRECTORY,
"children": MEDIA_CLASS_TRACK, "children": MEDIA_CLASS_TRACK,
}, },
BrowsableMedia.CURRENT_USER_SAVED_SHOWS: { BrowsableMedia.CURRENT_USER_SAVED_SHOWS.value: {
"parent": MEDIA_CLASS_DIRECTORY, "parent": MEDIA_CLASS_DIRECTORY,
"children": MEDIA_CLASS_PODCAST, "children": MEDIA_CLASS_PODCAST,
}, },
BrowsableMedia.CURRENT_USER_RECENTLY_PLAYED: { BrowsableMedia.CURRENT_USER_RECENTLY_PLAYED.value: {
"parent": MEDIA_CLASS_DIRECTORY, "parent": MEDIA_CLASS_DIRECTORY,
"children": MEDIA_CLASS_TRACK, "children": MEDIA_CLASS_TRACK,
}, },
BrowsableMedia.CURRENT_USER_TOP_ARTISTS: { BrowsableMedia.CURRENT_USER_TOP_ARTISTS.value: {
"parent": MEDIA_CLASS_DIRECTORY, "parent": MEDIA_CLASS_DIRECTORY,
"children": MEDIA_CLASS_ARTIST, "children": MEDIA_CLASS_ARTIST,
}, },
BrowsableMedia.CURRENT_USER_TOP_TRACKS: { BrowsableMedia.CURRENT_USER_TOP_TRACKS.value: {
"parent": MEDIA_CLASS_DIRECTORY, "parent": MEDIA_CLASS_DIRECTORY,
"children": MEDIA_CLASS_TRACK, "children": MEDIA_CLASS_TRACK,
}, },
BrowsableMedia.FEATURED_PLAYLISTS: { BrowsableMedia.FEATURED_PLAYLISTS.value: {
"parent": MEDIA_CLASS_DIRECTORY, "parent": MEDIA_CLASS_DIRECTORY,
"children": MEDIA_CLASS_PLAYLIST, "children": MEDIA_CLASS_PLAYLIST,
}, },
BrowsableMedia.CATEGORIES: { BrowsableMedia.CATEGORIES.value: {
"parent": MEDIA_CLASS_DIRECTORY, "parent": MEDIA_CLASS_DIRECTORY,
"children": MEDIA_CLASS_GENRE, "children": MEDIA_CLASS_GENRE,
}, },
@ -186,7 +187,7 @@ CONTENT_TYPE_MEDIA_CLASS = {
"parent": MEDIA_CLASS_DIRECTORY, "parent": MEDIA_CLASS_DIRECTORY,
"children": MEDIA_CLASS_PLAYLIST, "children": MEDIA_CLASS_PLAYLIST,
}, },
BrowsableMedia.NEW_RELEASES: { BrowsableMedia.NEW_RELEASES.value: {
"parent": MEDIA_CLASS_DIRECTORY, "parent": MEDIA_CLASS_DIRECTORY,
"children": MEDIA_CLASS_ALBUM, "children": MEDIA_CLASS_ALBUM,
}, },
@ -276,7 +277,7 @@ class SpotifyMediaPlayer(MediaPlayerEntity):
self._attr_unique_id = user_id self._attr_unique_id = user_id
@property @property
def _me(self) -> dict: def _me(self) -> dict[str, Any]:
"""Return spotify user info.""" """Return spotify user info."""
return self._spotify_data[DATA_SPOTIFY_ME] return self._spotify_data[DATA_SPOTIFY_ME]
@ -319,23 +320,30 @@ class SpotifyMediaPlayer(MediaPlayerEntity):
@property @property
def volume_level(self) -> float | None: def volume_level(self) -> float | None:
"""Return the device volume.""" """Return the device volume."""
if not self._currently_playing:
return None
return self._currently_playing.get("device", {}).get("volume_percent", 0) / 100 return self._currently_playing.get("device", {}).get("volume_percent", 0) / 100
@property @property
def media_content_id(self) -> str | None: def media_content_id(self) -> str | None:
"""Return the media URL.""" """Return the media URL."""
if not self._currently_playing:
return None
item = self._currently_playing.get("item") or {} item = self._currently_playing.get("item") or {}
return item.get("uri") return item.get("uri")
@property @property
def media_duration(self) -> int | None: def media_duration(self) -> int | None:
"""Duration of current playing media in seconds.""" """Duration of current playing media in seconds."""
if self._currently_playing.get("item") is None: if (
self._currently_playing is None
or self._currently_playing.get("item") is None
):
return None return None
return self._currently_playing["item"]["duration_ms"] / 1000 return self._currently_playing["item"]["duration_ms"] / 1000
@property @property
def media_position(self) -> str | None: def media_position(self) -> int | None:
"""Position of current playing media in seconds.""" """Position of current playing media in seconds."""
if not self._currently_playing: if not self._currently_playing:
return None return None
@ -352,7 +360,8 @@ class SpotifyMediaPlayer(MediaPlayerEntity):
def media_image_url(self) -> str | None: def media_image_url(self) -> str | None:
"""Return the media image URL.""" """Return the media image URL."""
if ( if (
self._currently_playing.get("item") is None not self._currently_playing
or self._currently_playing.get("item") is None
or not self._currently_playing["item"]["album"]["images"] or not self._currently_playing["item"]["album"]["images"]
): ):
return None return None
@ -361,13 +370,15 @@ class SpotifyMediaPlayer(MediaPlayerEntity):
@property @property
def media_title(self) -> str | None: def media_title(self) -> str | None:
"""Return the media title.""" """Return the media title."""
if not self._currently_playing:
return None
item = self._currently_playing.get("item") or {} item = self._currently_playing.get("item") or {}
return item.get("name") return item.get("name")
@property @property
def media_artist(self) -> str | None: def media_artist(self) -> str | None:
"""Return the media artist.""" """Return the media artist."""
if self._currently_playing.get("item") is None: if not self._currently_playing or self._currently_playing.get("item") is None:
return None return None
return ", ".join( return ", ".join(
artist["name"] for artist in self._currently_playing["item"]["artists"] artist["name"] for artist in self._currently_playing["item"]["artists"]
@ -376,13 +387,15 @@ class SpotifyMediaPlayer(MediaPlayerEntity):
@property @property
def media_album_name(self) -> str | None: def media_album_name(self) -> str | None:
"""Return the media album.""" """Return the media album."""
if self._currently_playing.get("item") is None: if not self._currently_playing or self._currently_playing.get("item") is None:
return None return None
return self._currently_playing["item"]["album"]["name"] return self._currently_playing["item"]["album"]["name"]
@property @property
def media_track(self) -> int | None: def media_track(self) -> int | None:
"""Track number of current playing media, music track only.""" """Track number of current playing media, music track only."""
if not self._currently_playing:
return None
item = self._currently_playing.get("item") or {} item = self._currently_playing.get("item") or {}
return item.get("track_number") return item.get("track_number")
@ -396,6 +409,8 @@ class SpotifyMediaPlayer(MediaPlayerEntity):
@property @property
def source(self) -> str | None: def source(self) -> str | None:
"""Return the current playback device.""" """Return the current playback device."""
if not self._currently_playing:
return None
return self._currently_playing.get("device", {}).get("name") return self._currently_playing.get("device", {}).get("name")
@property @property
@ -406,14 +421,20 @@ class SpotifyMediaPlayer(MediaPlayerEntity):
return [device["name"] for device in self._devices] return [device["name"] for device in self._devices]
@property @property
def shuffle(self) -> bool: def shuffle(self) -> bool | None:
"""Shuffling state.""" """Shuffling state."""
return bool(self._currently_playing.get("shuffle_state")) if not self._currently_playing:
return None
return self._currently_playing.get("shuffle_state")
@property @property
def repeat(self) -> str | None: def repeat(self) -> str | None:
"""Return current repeat mode.""" """Return current repeat mode."""
repeat_state = self._currently_playing.get("repeat_state") if (
not self._currently_playing
or (repeat_state := self._currently_playing.get("repeat_state")) is None
):
return None
return REPEAT_MODE_MAPPING_TO_HA.get(repeat_state) return REPEAT_MODE_MAPPING_TO_HA.get(repeat_state)
@property @property
@ -473,7 +494,11 @@ class SpotifyMediaPlayer(MediaPlayerEntity):
_LOGGER.error("Media type %s is not supported", media_type) _LOGGER.error("Media type %s is not supported", media_type)
return return
if not self._currently_playing.get("device") and self._devices: if (
self._currently_playing
and not self._currently_playing.get("device")
and self._devices
):
kwargs["device_id"] = self._devices[0].get("id") kwargs["device_id"] = self._devices[0].get("id")
self._spotify.start_playback(**kwargs) self._spotify.start_playback(**kwargs)
@ -481,6 +506,9 @@ class SpotifyMediaPlayer(MediaPlayerEntity):
@spotify_exception_handler @spotify_exception_handler
def select_source(self, source: str) -> None: def select_source(self, source: str) -> None:
"""Select playback device.""" """Select playback device."""
if not self._devices:
return
for device in self._devices: for device in self._devices:
if device["name"] == source: if device["name"] == source:
self._spotify.transfer_playback( self._spotify.transfer_playback(
@ -525,7 +553,9 @@ class SpotifyMediaPlayer(MediaPlayerEntity):
devices = self._spotify.devices() or {} devices = self._spotify.devices() or {}
self._devices = devices.get("devices", []) self._devices = devices.get("devices", [])
async def async_browse_media(self, media_content_type=None, media_content_id=None): async def async_browse_media(
self, media_content_type: str | None = None, media_content_id: str | None = None
) -> BrowseMedia:
"""Implement the websocket media browsing helper.""" """Implement the websocket media browsing helper."""
if not self._scope_ok: if not self._scope_ok:
@ -545,15 +575,15 @@ class SpotifyMediaPlayer(MediaPlayerEntity):
async def async_browse_media_internal( async def async_browse_media_internal(
hass, hass: HomeAssistant,
spotify, spotify: Spotify,
session, session: OAuth2Session,
current_user, current_user: dict[str, Any],
media_content_type, media_content_type: str | None,
media_content_id, media_content_id: str | None,
*, *,
can_play_artist=True, can_play_artist: bool = True,
): ) -> BrowseMedia:
"""Browse spotify media.""" """Browse spotify media."""
if media_content_type in (None, f"{MEDIA_PLAYER_PREFIX}library"): if media_content_type in (None, f"{MEDIA_PLAYER_PREFIX}library"):
return await hass.async_add_executor_job( return await hass.async_add_executor_job(
@ -563,6 +593,7 @@ async def async_browse_media_internal(
await session.async_ensure_token_valid() await session.async_ensure_token_valid()
# Strip prefix # Strip prefix
if media_content_type:
media_content_type = media_content_type[len(MEDIA_PLAYER_PREFIX) :] media_content_type = media_content_type[len(MEDIA_PLAYER_PREFIX) :]
payload = { payload = {
@ -583,76 +614,91 @@ async def async_browse_media_internal(
return response return response
def build_item_response(spotify, user, payload, *, can_play_artist): # noqa: C901 def build_item_response( # noqa: C901
spotify: Spotify,
user: dict[str, Any],
payload: dict[str, str | None],
*,
can_play_artist: bool,
) -> BrowseMedia | None:
"""Create response payload for the provided media query.""" """Create response payload for the provided media query."""
media_content_type = payload["media_content_type"] media_content_type = payload["media_content_type"]
media_content_id = payload["media_content_id"] media_content_id = payload["media_content_id"]
if media_content_type is None or media_content_id is None:
return None
title = None title = None
image = None image = None
media: dict[str, Any] | None = None
items = []
if media_content_type == BrowsableMedia.CURRENT_USER_PLAYLISTS: if media_content_type == BrowsableMedia.CURRENT_USER_PLAYLISTS:
media = spotify.current_user_playlists(limit=BROWSE_LIMIT) if media := spotify.current_user_playlists(limit=BROWSE_LIMIT):
items = media.get("items", []) items = media.get("items", [])
elif media_content_type == BrowsableMedia.CURRENT_USER_FOLLOWED_ARTISTS: elif media_content_type == BrowsableMedia.CURRENT_USER_FOLLOWED_ARTISTS:
media = spotify.current_user_followed_artists(limit=BROWSE_LIMIT) if media := spotify.current_user_followed_artists(limit=BROWSE_LIMIT):
items = media.get("artists", {}).get("items", []) items = media.get("artists", {}).get("items", [])
elif media_content_type == BrowsableMedia.CURRENT_USER_SAVED_ALBUMS: elif media_content_type == BrowsableMedia.CURRENT_USER_SAVED_ALBUMS:
media = spotify.current_user_saved_albums(limit=BROWSE_LIMIT) if media := spotify.current_user_saved_albums(limit=BROWSE_LIMIT):
items = [item["album"] for item in media.get("items", [])] items = [item["album"] for item in media.get("items", [])]
elif media_content_type == BrowsableMedia.CURRENT_USER_SAVED_TRACKS: elif media_content_type == BrowsableMedia.CURRENT_USER_SAVED_TRACKS:
media = spotify.current_user_saved_tracks(limit=BROWSE_LIMIT) if media := spotify.current_user_saved_tracks(limit=BROWSE_LIMIT):
items = [item["track"] for item in media.get("items", [])] items = [item["track"] for item in media.get("items", [])]
elif media_content_type == BrowsableMedia.CURRENT_USER_SAVED_SHOWS: elif media_content_type == BrowsableMedia.CURRENT_USER_SAVED_SHOWS:
media = spotify.current_user_saved_shows(limit=BROWSE_LIMIT) if media := spotify.current_user_saved_shows(limit=BROWSE_LIMIT):
items = [item["show"] for item in media.get("items", [])] items = [item["show"] for item in media.get("items", [])]
elif media_content_type == BrowsableMedia.CURRENT_USER_RECENTLY_PLAYED: elif media_content_type == BrowsableMedia.CURRENT_USER_RECENTLY_PLAYED:
media = spotify.current_user_recently_played(limit=BROWSE_LIMIT) if media := spotify.current_user_recently_played(limit=BROWSE_LIMIT):
items = [item["track"] for item in media.get("items", [])] items = [item["track"] for item in media.get("items", [])]
elif media_content_type == BrowsableMedia.CURRENT_USER_TOP_ARTISTS: elif media_content_type == BrowsableMedia.CURRENT_USER_TOP_ARTISTS:
media = spotify.current_user_top_artists(limit=BROWSE_LIMIT) if media := spotify.current_user_top_artists(limit=BROWSE_LIMIT):
items = media.get("items", []) items = media.get("items", [])
elif media_content_type == BrowsableMedia.CURRENT_USER_TOP_TRACKS: elif media_content_type == BrowsableMedia.CURRENT_USER_TOP_TRACKS:
media = spotify.current_user_top_tracks(limit=BROWSE_LIMIT) if media := spotify.current_user_top_tracks(limit=BROWSE_LIMIT):
items = media.get("items", []) items = media.get("items", [])
elif media_content_type == BrowsableMedia.FEATURED_PLAYLISTS: elif media_content_type == BrowsableMedia.FEATURED_PLAYLISTS:
media = spotify.featured_playlists(country=user["country"], limit=BROWSE_LIMIT) if media := spotify.featured_playlists(
country=user["country"], limit=BROWSE_LIMIT
):
items = media.get("playlists", {}).get("items", []) items = media.get("playlists", {}).get("items", [])
elif media_content_type == BrowsableMedia.CATEGORIES: elif media_content_type == BrowsableMedia.CATEGORIES:
media = spotify.categories(country=user["country"], limit=BROWSE_LIMIT) if media := spotify.categories(country=user["country"], limit=BROWSE_LIMIT):
items = media.get("categories", {}).get("items", []) items = media.get("categories", {}).get("items", [])
elif media_content_type == "category_playlists": elif media_content_type == "category_playlists":
media = spotify.category_playlists( if (
media := spotify.category_playlists(
category_id=media_content_id, category_id=media_content_id,
country=user["country"], country=user["country"],
limit=BROWSE_LIMIT, limit=BROWSE_LIMIT,
) )
category = spotify.category(media_content_id, country=user["country"]) ) and (category := spotify.category(media_content_id, country=user["country"])):
title = category.get("name") title = category.get("name")
image = fetch_image_url(category, key="icons") image = fetch_image_url(category, key="icons")
items = media.get("playlists", {}).get("items", []) items = media.get("playlists", {}).get("items", [])
elif media_content_type == BrowsableMedia.NEW_RELEASES: elif media_content_type == BrowsableMedia.NEW_RELEASES:
media = spotify.new_releases(country=user["country"], limit=BROWSE_LIMIT) if media := spotify.new_releases(country=user["country"], limit=BROWSE_LIMIT):
items = media.get("albums", {}).get("items", []) items = media.get("albums", {}).get("items", [])
elif media_content_type == MEDIA_TYPE_PLAYLIST: elif media_content_type == MEDIA_TYPE_PLAYLIST:
media = spotify.playlist(media_content_id) if media := spotify.playlist(media_content_id):
items = [item["track"] for item in media.get("tracks", {}).get("items", [])] items = [item["track"] for item in media.get("tracks", {}).get("items", [])]
elif media_content_type == MEDIA_TYPE_ALBUM: elif media_content_type == MEDIA_TYPE_ALBUM:
media = spotify.album(media_content_id) if media := spotify.album(media_content_id):
items = media.get("tracks", {}).get("items", []) items = media.get("tracks", {}).get("items", [])
elif media_content_type == MEDIA_TYPE_ARTIST: elif media_content_type == MEDIA_TYPE_ARTIST:
media = spotify.artist_albums(media_content_id, limit=BROWSE_LIMIT) if (media := spotify.artist_albums(media_content_id, limit=BROWSE_LIMIT)) and (
artist = spotify.artist(media_content_id) artist := spotify.artist(media_content_id)
):
title = artist.get("name") title = artist.get("name")
image = fetch_image_url(artist) image = fetch_image_url(artist)
items = media.get("items", []) items = media.get("items", [])
elif media_content_type == MEDIA_TYPE_SHOW: elif media_content_type == MEDIA_TYPE_SHOW:
media = spotify.show_episodes(media_content_id, limit=BROWSE_LIMIT) if (media := spotify.show_episodes(media_content_id, limit=BROWSE_LIMIT)) and (
show = spotify.show(media_content_id) show := spotify.show(media_content_id)
):
title = show.get("name") title = show.get("name")
image = fetch_image_url(show) image = fetch_image_url(show)
items = media.get("items", []) items = media.get("items", [])
else:
media = None
items = []
if media is None: if media is None:
return None return None
@ -665,15 +711,16 @@ def build_item_response(spotify, user, payload, *, can_play_artist): # noqa: C9
if media_content_type == BrowsableMedia.CATEGORIES: if media_content_type == BrowsableMedia.CATEGORIES:
media_item = BrowseMedia( media_item = BrowseMedia(
title=LIBRARY_MAP.get(media_content_id),
media_class=media_class["parent"],
children_media_class=media_class["children"],
media_content_id=media_content_id,
media_content_type=MEDIA_PLAYER_PREFIX + media_content_type,
can_play=False,
can_expand=True, can_expand=True,
children=[], can_play=False,
children_media_class=media_class["children"],
media_class=media_class["parent"],
media_content_id=media_content_id,
media_content_type=f"{MEDIA_PLAYER_PREFIX}{media_content_type}",
title=LIBRARY_MAP.get(media_content_id, "Unknown"),
) )
media_item.children = []
for item in items: for item in items:
try: try:
item_id = item["id"] item_id = item["id"]
@ -682,52 +729,54 @@ def build_item_response(spotify, user, payload, *, can_play_artist): # noqa: C9
continue continue
media_item.children.append( media_item.children.append(
BrowseMedia( BrowseMedia(
title=item.get("name"),
media_class=MEDIA_CLASS_PLAYLIST,
children_media_class=MEDIA_CLASS_TRACK,
media_content_id=item_id,
media_content_type=MEDIA_PLAYER_PREFIX + "category_playlists",
thumbnail=fetch_image_url(item, key="icons"),
can_play=False,
can_expand=True, can_expand=True,
can_play=False,
children_media_class=MEDIA_CLASS_TRACK,
media_class=MEDIA_CLASS_PLAYLIST,
media_content_id=item_id,
media_content_type=f"{MEDIA_PLAYER_PREFIX}category_playlists",
thumbnail=fetch_image_url(item, key="icons"),
title=item.get("name"),
) )
) )
return media_item return media_item
if title is None: if title is None:
title = LIBRARY_MAP.get(media_content_id, "Unknown")
if "name" in media: if "name" in media:
title = media.get("name") title = media["name"]
else:
title = LIBRARY_MAP.get(payload["media_content_id"])
params = { can_play = media_content_type in PLAYABLE_MEDIA_TYPES and (
"title": title, media_content_type != MEDIA_TYPE_ARTIST or can_play_artist
"media_class": media_class["parent"], )
"children_media_class": media_class["children"],
"media_content_id": media_content_id, browse_media = BrowseMedia(
"media_content_type": MEDIA_PLAYER_PREFIX + media_content_type, can_expand=True,
"can_play": media_content_type in PLAYABLE_MEDIA_TYPES can_play=can_play,
and (media_content_type != MEDIA_TYPE_ARTIST or can_play_artist), children_media_class=media_class["children"],
"children": [], media_class=media_class["parent"],
"can_expand": True, media_content_id=media_content_id,
} media_content_type=f"{MEDIA_PLAYER_PREFIX}{media_content_type}",
thumbnail=image,
title=title,
)
browse_media.children = []
for item in items: for item in items:
try: try:
params["children"].append( browse_media.children.append(
item_payload(item, can_play_artist=can_play_artist) item_payload(item, can_play_artist=can_play_artist)
) )
except (MissingMediaInformation, UnknownMediaType): except (MissingMediaInformation, UnknownMediaType):
continue continue
if "images" in media: if "images" in media:
params["thumbnail"] = fetch_image_url(media) browse_media.thumbnail = fetch_image_url(media)
elif image:
params["thumbnail"] = image
return BrowseMedia(**params) return browse_media
def item_payload(item, *, can_play_artist): def item_payload(item: dict[str, Any], *, can_play_artist: bool) -> BrowseMedia:
""" """
Create response payload for a single media item. Create response payload for a single media item.
@ -751,54 +800,56 @@ def item_payload(item, *, can_play_artist):
MEDIA_TYPE_EPISODE, MEDIA_TYPE_EPISODE,
] ]
payload = { can_play = media_type in PLAYABLE_MEDIA_TYPES and (
"title": item.get("name"), media_type != MEDIA_TYPE_ARTIST or can_play_artist
"media_class": media_class["parent"], )
"children_media_class": media_class["children"],
"media_content_id": media_id, browse_media = BrowseMedia(
"media_content_type": MEDIA_PLAYER_PREFIX + media_type, can_expand=can_expand,
"can_play": media_type in PLAYABLE_MEDIA_TYPES can_play=can_play,
and (media_type != MEDIA_TYPE_ARTIST or can_play_artist), children_media_class=media_class["children"],
"can_expand": can_expand, media_class=media_class["parent"],
} media_content_id=media_id,
media_content_type=f"{MEDIA_PLAYER_PREFIX}{media_type}",
title=item.get("name", "Unknown"),
)
if "images" in item: if "images" in item:
payload["thumbnail"] = fetch_image_url(item) browse_media.thumbnail = fetch_image_url(item)
elif MEDIA_TYPE_ALBUM in item: elif MEDIA_TYPE_ALBUM in item:
payload["thumbnail"] = fetch_image_url(item[MEDIA_TYPE_ALBUM]) browse_media.thumbnail = fetch_image_url(item[MEDIA_TYPE_ALBUM])
return BrowseMedia(**payload) return browse_media
def library_payload(*, can_play_artist): def library_payload(*, can_play_artist: bool) -> BrowseMedia:
""" """
Create response payload to describe contents of a specific library. Create response payload to describe contents of a specific library.
Used by async_browse_media. Used by async_browse_media.
""" """
library_info = { browse_media = BrowseMedia(
"title": "Media Library", can_expand=True,
"media_class": MEDIA_CLASS_DIRECTORY, can_play=False,
"media_content_id": "library", children_media_class=MEDIA_CLASS_DIRECTORY,
"media_content_type": MEDIA_PLAYER_PREFIX + "library", media_class=MEDIA_CLASS_DIRECTORY,
"can_play": False, media_content_id="library",
"can_expand": True, media_content_type=f"{MEDIA_PLAYER_PREFIX}library",
"children": [], title="Media Library",
} )
browse_media.children = []
for item in [{"name": n, "type": t} for t, n in LIBRARY_MAP.items()]: for item in [{"name": n, "type": t} for t, n in LIBRARY_MAP.items()]:
library_info["children"].append( browse_media.children.append(
item_payload( item_payload(
{"name": item["name"], "type": item["type"], "uri": item["type"]}, {"name": item["name"], "type": item["type"], "uri": item["type"]},
can_play_artist=can_play_artist, can_play_artist=can_play_artist,
) )
) )
response = BrowseMedia(**library_info) return browse_media
response.children_media_class = MEDIA_CLASS_DIRECTORY
return response
def fetch_image_url(item, key="images"): def fetch_image_url(item: dict[str, Any], key="images") -> str | None:
"""Fetch image url.""" """Fetch image url."""
try: try:
return item.get(key, [])[0].get("url") return item.get(key, [])[0].get("url")

2
homeassistant/components/spotify/strings.json
View file

@ -11,8 +11,8 @@
}, },
"abort": { "abort": {
"authorize_url_timeout": "Timeout generating authorize URL.", "authorize_url_timeout": "Timeout generating authorize URL.",
"no_url_available": "[%key:common::config_flow::abort::oauth2_no_url_available%]",
"missing_configuration": "The Spotify integration is not configured. Please follow the documentation.", "missing_configuration": "The Spotify integration is not configured. Please follow the documentation.",
"no_url_available": "[%key:common::config_flow::abort::oauth2_no_url_available%]",
"reauth_account_mismatch": "The Spotify account authenticated with, does not match the account needed re-authentication." "reauth_account_mismatch": "The Spotify account authenticated with, does not match the account needed re-authentication."
}, },
"create_entry": { "default": "Successfully authenticated with Spotify." } "create_entry": { "default": "Successfully authenticated with Spotify." }

6
mypy.ini
View file

@ -2646,12 +2646,6 @@ ignore_errors = true
[mypy-homeassistant.components.sonos.statistics] [mypy-homeassistant.components.sonos.statistics]
ignore_errors = true ignore_errors = true
[mypy-homeassistant.components.spotify.config_flow]
ignore_errors = true
[mypy-homeassistant.components.spotify.media_player]
ignore_errors = true
[mypy-homeassistant.components.system_health] [mypy-homeassistant.components.system_health]
ignore_errors = true ignore_errors = true

2
script/hassfest/mypy_config.py
View file

@ -188,8 +188,6 @@ IGNORED_MODULES: Final[list[str]] = [
"homeassistant.components.sonos.sensor", "homeassistant.components.sonos.sensor",
"homeassistant.components.sonos.speaker", "homeassistant.components.sonos.speaker",
"homeassistant.components.sonos.statistics", "homeassistant.components.sonos.statistics",
"homeassistant.components.spotify.config_flow",
"homeassistant.components.spotify.media_player",
"homeassistant.components.system_health", "homeassistant.components.system_health",
"homeassistant.components.telegram_bot.polling", "homeassistant.components.telegram_bot.polling",
"homeassistant.components.template", "homeassistant.components.template",

26
tests/components/spotify/test_config_flow.py
View file

@ -194,7 +194,13 @@ async def test_reauthentication(
old_entry.add_to_hass(hass) old_entry.add_to_hass(hass)
result = await hass.config_entries.flow.async_init( result = await hass.config_entries.flow.async_init(
DOMAIN, context={"source": SOURCE_REAUTH}, data=old_entry.data DOMAIN,
context={
"source": SOURCE_REAUTH,
"unique_id": old_entry.unique_id,
"entry_id": old_entry.entry_id,
},
data=old_entry.data,
) )
flows = hass.config_entries.flow.async_progress() flows = hass.config_entries.flow.async_progress()
@ -261,7 +267,13 @@ async def test_reauth_account_mismatch(
old_entry.add_to_hass(hass) old_entry.add_to_hass(hass)
result = await hass.config_entries.flow.async_init( result = await hass.config_entries.flow.async_init(
DOMAIN, context={"source": SOURCE_REAUTH}, data=old_entry.data DOMAIN,
context={
"source": SOURCE_REAUTH,
"unique_id": old_entry.unique_id,
"entry_id": old_entry.entry_id,
},
data=old_entry.data,
) )
flows = hass.config_entries.flow.async_progress() flows = hass.config_entries.flow.async_progress()
@ -294,3 +306,13 @@ async def test_reauth_account_mismatch(
assert result["type"] == data_entry_flow.RESULT_TYPE_ABORT assert result["type"] == data_entry_flow.RESULT_TYPE_ABORT
assert result["reason"] == "reauth_account_mismatch" assert result["reason"] == "reauth_account_mismatch"
async def test_abort_if_no_reauth_entry(hass):
"""Check flow aborts when no entry is known when entring reauth confirmation."""
result = await hass.config_entries.flow.async_init(
DOMAIN, context={"source": "reauth_confirm"}
)
assert result.get("type") == data_entry_flow.RESULT_TYPE_ABORT
assert result.get("reason") == "reauth_account_mismatch"