[PATCH] stream.hls: turn url_master into property(streamlink#4643)

with backwards compatibility for the deprecated url_master parameter,
and read the value from the parsed multivariant playlist instead, if it
exists.

See 7cb0ebe

docs/deprecations.rst

@@ -1,6 +1,26 @@
 Deprecations
 ============
 
+streamlink 2.27.4.0
+-------------------
+
+Deprecation of url_master in HLSStream
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+The ``url_master`` parameter and attribute of the :py:class:`streamlink.stream.HLSStream`
+and :py:class:`streamlink.stream.MuxedHLSStream` classes have been deprecated in favor of the ``multivariant`` parameter
+and attribute. ``multivariant`` is an :py:class:`M3U8` reference of the parsed HLS multivariant playlist.
+
+
+Removal of streamlink.plugin.api.utils
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+The ``streamlink.plugin.api.utils`` module including the ``itertags`` function and export aliases for ``streamlink.utils.parse``
+has been removed. Import the parse functions directly and find data in XML/HTML by parsing it via ``parse_{xml,html}`` and
+applying XPath queries to the parsed result via the available methods provided by the ``lxml.etree`` API. The
+``streamlink.plugin.api.validate`` module also has the necessary validation schema functions for this.
+
+
 streamlink 2.27.0.0
 -------------------
 

src/streamlink/stream/hls.py

@@ -373,9 +373,14 @@ def __init__(
         ffmpeg_options = ffmpeg_options or {}
 
         super(MuxedHLSStream, self).__init__(session, *substreams, format="mpegts", maps=maps, **ffmpeg_options)
-        self.url_master = url_master
+        self._url_master = url_master
         self.multivariant = multivariant if multivariant and multivariant.is_master else None
 
+    @property
+    def url_master(self):
+        """Deprecated"""
+        return self.multivariant.uri if self.multivariant and self.multivariant.uri else self._url_master
+
     def to_manifest_url(self):
         url = self.multivariant.uri if self.multivariant and self.multivariant.uri else self.url_master
 
@@ -421,7 +426,7 @@ def __init__(
         :param args: Additional keyword arguments passed to :meth:`requests.Session.request`
         """
         super(HLSStream, self).__init__(session_, url, **args)
-        self.url_master = url_master
+        self._url_master = url_master
         self.multivariant = multivariant if multivariant and multivariant.is_master else None
         self.force_restart = force_restart
         self.start_offset = start_offset
@@ -440,6 +445,11 @@ def __json__(self):
 
         return json
 
+    @property
+    def url_master(self):
+        """Deprecated"""
+        return self.multivariant.uri if self.multivariant and self.multivariant.uri else self._url_master
+
     def to_manifest_url(self):
         url = self.multivariant.uri if self.multivariant and self.multivariant.uri else self.url_master
 

tests/stream/test_hls.py

@@ -99,6 +99,18 @@ def test_variant_playlist(self):
         stream = next(iter(streams.values()))
         assert repr(stream) == "<HLSStream ['hls', '{0}/720p.m3u8', '{0}/master.m3u8']>".format(base)
 
+        assert stream.multivariant is not None
+        assert stream.multivariant.uri == "{0}/master.m3u8".format(base)
+        assert stream.url_master == "{0}/master.m3u8".format(base)
+
+    def test_url_master(self):
+        session = Streamlink()
+        stream = HLSStream(session, "http://mocked/foo", url_master="http://mocked/master.m3u8")
+
+        assert stream.multivariant is None
+        assert stream.url == "http://mocked/foo"
+        assert stream.url_master == "http://mocked/master.m3u8"
+
 
 class EventedHLSReader(HLSStreamReader):
     __writer__ = EventedHLSStreamWriter