Fix for -PyTube can't download or iterete over playlist it it contains a "subMenuItems" #915 (#918)

pytube/contrib/playlist.py

@@ -131,21 +131,20 @@ class Playlist(Sequence):
         try:
             # this is the json tree structure, if the json was extracted from
             # html
-            important_content = initial_data["contents"][
-                "twoColumnBrowseResultsRenderer"
-            ]["tabs"][0]["tabRenderer"]["content"]["sectionListRenderer"][
-                "contents"
-            ][
-                0
-            ][
-                "itemSectionRenderer"
-            ][
-                "contents"
-            ][
-                0
-            ][
-                "playlistVideoListRenderer"
-            ]
+            section_contents = initial_data["contents"][
+                "twoColumnBrowseResultsRenderer"][
+                "tabs"][0]["tabRenderer"]["content"][
+                "sectionListRenderer"]["contents"]
+            try:
+                # Playlist without submenus
+                important_content = section_contents[
+                    0]["itemSectionRenderer"][
+                    "contents"][0]["playlistVideoListRenderer"]
+            except (KeyError, IndexError, TypeError):
+                # Playlist with submenus
+                important_content = section_contents[
+                    1]["itemSectionRenderer"][
+                    "contents"][0]["playlistVideoListRenderer"]
             videos = important_content["contents"]
         except (KeyError, IndexError, TypeError):
             try:

tests/conftest.py

@@ -105,6 +105,19 @@ def playlist_long_html():
         return f.read().decode("utf-8")
 
 
+@pytest.fixture
+def playlist_submenu_html():
+    """Youtube playlist HTML loaded on 2020-01-24 from
+    https://www.youtube.com/playlist?list=PLZHQObOWTQDMsr9K-rj53DwVRMYO3t5Yr"""
+    file_path = os.path.join(
+        os.path.dirname(os.path.realpath(__file__)),
+        "mocks",
+        "playlist_submenu.html.gz",
+    )
+    with gzip.open(file_path, "rb") as f:
+        return f.read().decode("utf-8")
+
+
 @pytest.fixture
 def stream_dict():
     """Youtube instance initialized with video id WXxV9g7lsFE."""

tests/contrib/test_playlist.py

@@ -238,3 +238,20 @@ def test_trimmed_pagination_not_found(
     playlist = Playlist(url) # noqa
     # assert len(list(playlist.trimmed("wont-be-found"))) == 101 # noqa
     assert True
+
+
+# test case for playlist with submenus
+@mock.patch("pytube.contrib.playlist.request.get")
+def test_playlist_submenu(
+        request_get, playlist_submenu_html):
+    url = "https://www.fakeurl.com/playlist?list=whatever"
+    request_get.side_effect = [
+        playlist_submenu_html,
+        '{"content_html":"<a '
+        'href=\\"/watch?v=BcWz41-4cDk&amp;feature=plpp_video&amp;ved'
+        '=CCYQxjQYACITCO33n5-pn-cCFUG3xAodLogN2yj6LA\\">}", '
+        '"load_more_widget_html":""}',
+        "{}",
+    ]
+    playlist = Playlist(url)
+    assert len(playlist.video_urls) == 12