CaptionQuery and StreamQuery implement Sequence

pytube/cli.py

@@ -413,12 +413,12 @@ def display_streams(youtube: YouTube) -> None:
         A valid YouTube watch URL.
 
     """
-    for stream in youtube.streams.all():
+    for stream in youtube.streams:
         print(stream)
 
 
 def _print_available_captions(captions: CaptionQuery) -> None:
-    print(f"Available caption codes are: {', '.join(c.code for c in captions.all())}")
+    print(f"Available caption codes are: {', '.join(c.code for c in captions)}")
 
 
 def download_caption(

pytube/contrib/playlist.py

@@ -143,7 +143,7 @@ class Playlist(Sequence):
         """
         yield from (YouTube(url) for url in self.video_urls)
 
-    def __getitem__(self, i: Union[slice, int]):
+    def __getitem__(self, i: Union[slice, int]) -> Union[str, List[str]]:
         return self.video_urls[i]
 
     def __len__(self) -> int:

pytube/query.py

@@ -1,12 +1,14 @@
 # -*- coding: utf-8 -*-
 
 """This module provides a query interface for media streams and captions."""
-from typing import List, Optional
+from typing import List, Optional, Union
+from collections.abc import Sequence
 
 from pytube import Stream, Caption
+from pytube.helpers import deprecated
 
 
-class StreamQuery:
+class StreamQuery(Sequence):
     """Interface for querying the available media streams."""
 
     def __init__(self, fmt_streams):
@@ -313,14 +315,16 @@ class StreamQuery:
         except IndexError:
             pass
 
+    @deprecated("Get the size of this list directly using len()")
     def count(self) -> int:
         """Get the count the query would return.
 
         :rtype: int
 
         """
-        return len(self.fmt_streams)
+        return len(self)
 
+    @deprecated("This object can be treated as a list, all() is useless")
     def all(self) -> List[Stream]:
         """Get all the results represented by this query as a list.
 
@@ -329,8 +333,14 @@ class StreamQuery:
         """
         return self.fmt_streams
 
+    def __getitem__(self, i: Union[slice, int]):
+        return self.fmt_streams[i]
+
+    def __len__(self) -> int:
+        return len(self.fmt_streams)
+
 
-class CaptionQuery:
+class CaptionQuery(Sequence):
     """Interface for querying the available captions."""
 
     def __init__(self, captions: List[Caption]):
@@ -355,6 +365,7 @@ class CaptionQuery:
         """
         return self.lang_code_index.get(lang_code)
 
+    @deprecated("This object can be treated as a list, all() is useless")
     def all(self) -> List[Caption]:
         """Get all the results represented by this query as a list.
 
@@ -362,3 +373,9 @@ class CaptionQuery:
 
         """
         return self.captions
+
+    def __getitem__(self, i: Union[slice, int]):
+        return self.captions[i]
+
+    def __len__(self) -> int:
+        return len(self.captions)

tests/contrib/test_playlist.py

@@ -90,6 +90,7 @@ def test_sequence(request_get, playlist_html):
     assert playlist[0] == "https://www.youtube.com/watch?v=ujTCoH21GlA"
     assert len(playlist) == 12
 
+
 @mock.patch("pytube.contrib.playlist.request.get")
 @mock.patch("pytube.cli.YouTube.__init__", return_value=None)
 def test_videos(youtube, request_get, playlist_html):

tests/test_captions.py

@@ -12,7 +12,7 @@ def test_float_to_srt_time_format():
     assert caption1.float_to_srt_time_format(3.89) == "00:00:03,890"
 
 
-def test_caption_query_all():
+def test_caption_query_sequence():
     caption1 = Caption(
         {"url": "url1", "name": {"simpleText": "name1"}, "languageCode": "en"}
     )
@@ -21,6 +21,8 @@ def test_caption_query_all():
     )
     caption_query = CaptionQuery(captions=[caption1, caption2])
     assert caption_query.captions == [caption1, caption2]
+    assert len(caption_query) == 2
+    assert caption_query[0] == caption1
 
 
 def test_caption_query_get_by_language_code_when_exists():

tests/test_query.py

@@ -3,11 +3,6 @@
 import pytest
 
 
-def test_count(cipher_signature):
-    """Ensure :meth:`~pytube.StreamQuery.count` returns an accurate amount."""
-    assert cipher_signature.streams.count() == 22
-
-
 @pytest.mark.parametrize(
     ("test_input", "expected"),
     [
@@ -30,7 +25,7 @@ def test_count(cipher_signature):
 )
 def test_filters(test_input, expected, cipher_signature):
     """Ensure filters produce the expected results."""
-    result = [s.itag for s in cipher_signature.streams.filter(**test_input).all()]
+    result = [s.itag for s in cipher_signature.streams.filter(**test_input)]
     assert result == expected
 
 
@@ -64,8 +59,7 @@ def test_order_by(cipher_signature):
     :class:`Stream <Stream>` instances in the expected order.
     """
     itags = [
-        s.itag
-        for s in cipher_signature.streams.filter(type="audio").order_by("itag").all()
+        s.itag for s in cipher_signature.streams.filter(type="audio").order_by("itag")
     ]
     assert itags == [140, 249, 250, 251]
 
@@ -77,10 +71,7 @@ def test_order_by_descending(cipher_signature):
     # numerical values
     itags = [
         s.itag
-        for s in cipher_signature.streams.filter(type="audio")
-        .order_by("itag")
-        .desc()
-        .all()
+        for s in cipher_signature.streams.filter(type="audio").order_by("itag").desc()
     ]
     assert itags == [251, 250, 249, 140]
 
@@ -91,7 +82,6 @@ def test_order_by_non_numerical(cipher_signature):
         for s in cipher_signature.streams.filter(res="360p")
         .order_by("mime_type")
         .desc()
-        .all()
     ]
     assert mime_types == ["video/webm", "video/mp4", "video/mp4"]
 
@@ -103,10 +93,7 @@ def test_order_by_ascending(cipher_signature):
     # numerical values
     itags = [
         s.itag
-        for s in cipher_signature.streams.filter(type="audio")
-        .order_by("itag")
-        .asc()
-        .all()
+        for s in cipher_signature.streams.filter(type="audio").order_by("itag").asc()
     ]
     assert itags == [140, 249, 250, 251]
 
@@ -114,16 +101,13 @@ def test_order_by_ascending(cipher_signature):
 def test_order_by_non_numerical_ascending(cipher_signature):
     mime_types = [
         s.mime_type
-        for s in cipher_signature.streams.filter(res="360p")
-        .order_by("mime_type")
-        .asc()
-        .all()
+        for s in cipher_signature.streams.filter(res="360p").order_by("mime_type").asc()
     ]
     assert mime_types == ["video/mp4", "video/mp4", "video/webm"]
 
 
 def test_order_by_with_none_values(cipher_signature):
-    abrs = [s.abr for s in cipher_signature.streams.order_by("abr").asc().all()]
+    abrs = [s.abr for s in cipher_signature.streams.order_by("abr").asc()]
     assert abrs == ["50kbps", "70kbps", "96kbps", "128kbps", "160kbps"]
 
 
@@ -151,7 +135,7 @@ def test_get_highest_resolution(cipher_signature):
 
 
 def test_filter_is_dash(cipher_signature):
-    streams = cipher_signature.streams.filter(is_dash=False).all()
+    streams = cipher_signature.streams.filter(is_dash=False)
     itags = [s.itag for s in streams]
     assert itags == [18, 398, 397, 396, 395, 394]
 
@@ -162,3 +146,8 @@ def test_get_audio_only(cipher_signature):
 
 def test_get_audio_only_with_subtype(cipher_signature):
     assert cipher_signature.streams.get_audio_only(subtype="webm").itag == 251
+
+
+def test_sequence(cipher_signature):
+    assert len(cipher_signature.streams) == 22
+    assert cipher_signature.streams[0] is not None

tests/test_streams.py

@@ -41,7 +41,7 @@ def test_caption_tracks(presigned_video):
 
 
 def test_captions(presigned_video):
-    assert len(presigned_video.captions.all()) == 13
+    assert len(presigned_video.captions) == 13
 
 
 def test_description(cipher_signature):