Move pychromecast.play_youtube_video and pychromecast.play_youtube_playlist

[home-assistant-libs]

Move pychromecast.play_youtube_video and pychromecast.play_youtube_playlist

[balloob]

A whole submodule would be too much and would create a lot of different modules when it grows. A better place would be a new util package.

Even after moving them to the util package I prefer to keep them being imported into pychromecast root so that you can do something like this:

import pychromecast pychromecast.play_youtube_video("VIDEO_ID")

[jaapz]

But I don't think that's a really nice API. If in the future there might be gmusc specific stuff, that helper (in this API scheme) would look like `pychromecast.play_gmusic_song("SONG_ID"). I personally just don't like having all these different helpers in one module.

Encapsulating helpers for one app into one module feels cleaner and more organised, and seems a bit more logical API too.

Moving them from util into something else and still importing them directly into pychromecast isn't really fixing anything, the API will still be the same.

pychromecast.youtube.play_video()
pychromecast.gmusic.play_song()

This API scheme makes it clear that everything in the pychromecast.youtube or pychromecast.gmusic namespace will only work on their respective apps.

[balloob]

Pushing everything into submodules is not making life easier for the user. Currently the most used use cases are imported into the init so people don't have to look too far how to use it.

If a cleaner API would be our goal it would mean we end up in a Java-like landscape requiring users write code like pychromecast.config.APP_ID["HOME"], cast.get_protocol(pychromecast.websocket.PROTOCOL_RAMP) or catch the error pychromecast.error.NoChromecastFoundError. It's not very pythonic.

Next to that, Google has moved away from using DIAL when they released the official SDK of the Chromecast at the beginning of this year. This means that except for the initial batch of apps we are unable to retrieve the current running app. All communication happens now by a yet unknown protocol. Because of this I consider the chance of getting more of these methods very slim.

[jaapz]

Actually you would then not do import pychromecast but instead from pychromecast.error import NoChromecastFoundError, which IMHO is nicer. But this is largely my preferred coding style so if you think that's not the way to go, it's your call 👍