Add type annotations to quick_play.py (#817)

* Add type annotations to quick_play.py

* Fix lint error

mypy.ini

@@ -22,5 +22,4 @@ warn_unreachable = true
 exclude = (?x)(
     ^pychromecast/generated/ # The protobuf autogenerated files are not annotated
     | ^pychromecast/controllers/plex\.py$
-    | ^pychromecast/quick_play\.py$
   )

pychromecast/controllers/__init__.py

@@ -197,3 +197,11 @@ def tear_down(self) -> None:
         """Called when we are shutting down."""
         self._socket_client = None
         self._message_func = None
+
+
+class QuickPlayController(BaseController, abc.ABC):
+    """ABC for controller which supports quick play."""
+
+    @abc.abstractmethod
+    def quick_play(self, *, media_id: str, **kwargs: Any) -> None:
+        """Quick Play support for a controller."""

pychromecast/controllers/bbciplayer.py

@@ -26,7 +26,8 @@ def __init__(self) -> None:
     # pylint: disable-next=arguments-differ
     def quick_play(
         self,
-        media_id: str | None = None,
+        *,
+        media_id: str,
         is_live: bool = False,
         metadata: dict[str, Any] | None = None,
         **kwargs: Any
@@ -39,7 +40,7 @@ def quick_play(
         subtitle = metadata.pop("subtitle", "")
 
         super().quick_play(
-            media_id,
+            media_id=media_id,
             media_type=None,
             stream_type=stream_type,
             metadata=metadata,

pychromecast/controllers/bbcsounds.py

@@ -23,7 +23,8 @@ def __init__(self) -> None:
     # pylint: disable-next=arguments-differ
     def quick_play(
         self,
-        media_id: str | None = None,
+        *,
+        media_id: str,
         is_live: bool = False,
         metadata: dict[str, Any] | None = None,
         **kwargs: Any
@@ -34,7 +35,7 @@ def quick_play(
         if metadata is None:
             metadata = metadata_default
         super().quick_play(
-            media_id,
+            media_id=media_id,
             media_type=None,
             stream_type=stream_type,
             metadata=metadata,

pychromecast/controllers/media.py

@@ -16,7 +16,7 @@
     CastMessage,
 )
 from ..response_handler import WaitResponse
-from . import BaseController, CallbackType
+from . import CallbackType, QuickPlayController
 
 STREAM_TYPE_UNKNOWN = "UNKNOWN"
 STREAM_TYPE_BUFFERED = "BUFFERED"
@@ -371,7 +371,7 @@ def load_media_failed(self, item: int, error_code: int) -> None:
         """Called when load media failed."""
 
 
-class BaseMediaPlayer(BaseController):
+class BaseMediaPlayer(QuickPlayController):
     """Mixin class for apps which can play media using the default media namespace."""
 
     def __init__(self, supporting_app_id: str, app_must_match: bool = True) -> None:
@@ -541,14 +541,14 @@ def _send_start_play_media(  # pylint: disable=too-many-locals
 
         self.send_message(msg, inc_session_id=True, callback_function=callback_function)
 
-    def quick_play(self, media_id: str | None = None, **kwargs: Any) -> None:
+    def quick_play(self, *, media_id: str, **kwargs: Any) -> None:
         """Quick Play"""
 
         media_type = kwargs.pop("media_type", "video/mp4")
 
         response_handler = WaitResponse(30)
         self.play_media(
-            media_id, media_type, **kwargs, callback_function=response_handler.callback  # type: ignore[arg-type]
+            media_id, media_type, **kwargs, callback_function=response_handler.callback
         )
         request_completed = response_handler.wait_response()
 

pychromecast/controllers/supla.py

@@ -4,7 +4,7 @@
 import logging
 from typing import Any
 
-from . import BaseController, CallbackType
+from . import CallbackType, QuickPlayController
 from ..config import APP_SUPLA
 from ..error import PyChromecastError
 from ..response_handler import WaitResponse
@@ -13,7 +13,7 @@
 
 
 # pylint: disable=too-many-instance-attributes
-class SuplaController(BaseController):
+class SuplaController(QuickPlayController):
     """Controller to interact with Supla namespace."""
 
     def __init__(self) -> None:
@@ -56,11 +56,9 @@ def play_media(
         )
 
     def quick_play(
-        self, media_id: str | None = None, is_live: bool = False, **kwargs: Any
+        self, *, media_id: str, is_live: bool = False, **kwargs: Any
     ) -> None:
         """Quick Play"""
-        if media_id is None:
-            raise ValueError("media_id must be specified")
         response_handler = WaitResponse(10)
         self.play_media(
             media_id,

pychromecast/controllers/yleareena.py

@@ -60,14 +60,13 @@ def play_areena_media(  # pylint: disable=too-many-locals
     # pylint: disable-next=arguments-differ
     def quick_play(
         self,
-        media_id: str | None = None,
+        *,
+        media_id: str,
         audio_lang: str = "",
         text_lang: str = "off",
         **kwargs: Any,
     ) -> None:
         """Quick Play"""
-        if media_id is None:
-            raise ValueError("media_id must be specified")
         response_handler = WaitResponse(10)
         self.play_areena_media(
             media_id,

pychromecast/controllers/youtube.py

@@ -8,7 +8,7 @@
 
 from casttube import YouTubeSession  # type: ignore[import-untyped]
 
-from . import BaseController
+from . import QuickPlayController
 from ..const import MESSAGE_TYPE
 from ..generated.cast_channel_pb2 import (  # pylint: disable=no-name-in-module
     CastMessage,
@@ -22,7 +22,7 @@
 _LOGGER = logging.getLogger(__name__)
 
 
-class YouTubeController(BaseController):
+class YouTubeController(QuickPlayController):
     """Controller to interact with Youtube."""
 
     _session: YouTubeSession
@@ -110,14 +110,13 @@ def _process_status(self, status: dict) -> None:
 
     def quick_play(
         self,
-        media_id: str | None = None,
+        *,
+        media_id: str,
         playlist_id: str | None = None,
         enqueue: bool = False,
         **kwargs: Any
     ) -> None:
         """Quick Play"""
-        if media_id is None:
-            raise ValueError("media_id must be specified")
         if enqueue:
             self.add_to_queue(media_id, **kwargs)
         else:

pychromecast/quick_play.py

@@ -1,5 +1,9 @@
 """ Choose a controller and quick play """
 
+from typing import Any
+
+from . import Chromecast
+from .controllers import QuickPlayController
 from .controllers.bbciplayer import BbcIplayerController
 from .controllers.bbcsounds import BbcSoundsController
 from .controllers.bubbleupnp import BubbleUPNPController
@@ -13,7 +17,9 @@
 from .controllers.nrkradio import NrkRadioController
 
 
-def quick_play(cast, app_name, data):  # pylint:disable=too-many-branches
+def quick_play(  # pylint:disable=too-many-branches
+    cast: Chromecast, app_name: str, data: dict[str, Any]
+) -> None:
     """
     Given a Chromecast connection, launch the app `app_name` and start playing media
     based on parameters defined in `data`.
@@ -56,6 +62,7 @@ def quick_play(cast, app_name, data):  # pylint:disable=too-many-branches
             "BUFFERED" or "LIVE"
     """
 
+    controller: QuickPlayController
     if app_name == "bbciplayer":
         controller = BbcIplayerController()
     elif app_name == "bbcsounds":