more docs + tests

docs/conf.py

@@ -1,8 +1,8 @@
 #!/usr/bin/env python3
 # -*- coding: utf-8 -*-
+"""pytube documentation build configuration file."""
+#
 #
-# pytube documentation build configuration file, created by
-# sphinx-quickstart on Mon Oct  9 02:11:41 2017.
 #
 # This file is execfile()d with the current directory set to its
 # containing dir.

pytube/__main__.py

@@ -74,7 +74,7 @@ class YouTube(object):
             'on_complete': on_complete_callback,
         }
 
-        if url and not defer_prefetch_init:
+        if not defer_prefetch_init:
             self.prefetch_init()
 
     def prefetch_init(self):

pytube/compat.py

@@ -15,6 +15,7 @@ if python_version == 2:
     from urlparse import parse_qsl
 
     def unicode(s):
+        """Encode a string to utf-8."""
         return s.encode('utf-8')
 
 elif python_version == 3:
@@ -26,4 +27,5 @@ elif python_version == 3:
     from urllib.request import urlopen
 
     def unicode(s):
-        return str(s)
+        """No-op."""
+        return s

setup.py

@@ -1,5 +1,6 @@
 #!/usr/bin/env python
 # -*- coding: utf-8 -*-
+"""This module contains setup instructions for pytube."""
 try:
     from setuptools import setup
 except ImportError:
@@ -34,7 +35,6 @@ setup(
         'Operating System :: Microsoft',
         'Operating System :: POSIX',
         'Operating System :: Unix',
-        'Programming Language :: Python :: 2.6',
         'Programming Language :: Python :: 2.7',
         'Programming Language :: Python :: 3.3',
         'Programming Language :: Python :: 3.4',
@@ -47,8 +47,7 @@ setup(
         'Topic :: Terminals',
         'Topic :: Utilities',
     ],
-    description=('A Python library for downloading YouTube videos.'),
+    description=('A pythonic library for downloading YouTube Videos.'),
     long_description=readme,
     zip_safe=True,
-
 )

tests/conftest.py

@@ -12,6 +12,7 @@ from pytube import YouTube
 
 
 def load_playback_file(filename):
+    """Load a gzip json playback file."""
     cur_fp = os.path.realpath(__file__)
     cur_dir = os.path.dirname(cur_fp)
     fp = os.path.join(cur_dir, 'mocks', filename)
@@ -21,6 +22,7 @@ def load_playback_file(filename):
 
 
 def load_and_init_from_playback_file(filename):
+    """Load a gzip json playback file and create YouTube instance."""
     pb = load_playback_file(filename)
     yt = YouTube(pb['url'], defer_prefetch_init=True)
     yt.watch_html = pb['watch_html']

tests/test_main.py

@@ -0,0 +1,12 @@
+# -*- coding: utf-8 -*-
+import mock
+
+from pytube import YouTube
+
+
+@mock.patch('pytube.__main__.YouTube')
+def test_prefetch_deferred(MockYouTube):
+    instance = MockYouTube.return_value
+    instance.prefetch_init.return_value = None
+    YouTube('https://www.youtube.com/watch?v=9bZkp7q19f0', True)
+    assert not instance.prefetch_init.called

tests/test_query.py

@@ -4,6 +4,7 @@ import pytest
 
 
 def test_count(cipher_signature):
+    """Ensure :meth:`~pytube.StreamQuery.count` returns an accurate amount."""
     assert cipher_signature.streams.count() == 22
 
 
@@ -28,28 +29,43 @@ def test_count(cipher_signature):
     ],
 )
 def test_filters(test_input, expected, cipher_signature):
-    result = [s.itag for s in cipher_signature.streams.filter(
-        **test_input
-    ).all()]
+    """Ensure filters produce the expected results."""
+    result = [
+        s.itag for s
+        in cipher_signature.streams.filter(**test_input).all()
+    ]
     assert result == expected
 
 
 @pytest.mark.parametrize('test_input', ['first', 'last'])
 def test_empty(test_input, cipher_signature):
+    """Ensure :meth:`~pytube.StreamQuery.last` and
+    :meth:`~pytube.StreamQuery.first` return ``None`` if the resultset is
+    empty.
+    """
     query = cipher_signature.streams.filter(video_codec='vp20')
     fn = getattr(query, test_input)
     assert fn() is None
 
 
 def test_get_last(cipher_signature):
+    """Ensure :meth:`~pytube.StreamQuery.last` returns the expected
+    :class:`Stream <Stream>`.
+    """
     assert cipher_signature.streams.last().itag == '251'
 
 
 def test_get_first(cipher_signature):
+    """Ensure :meth:`~pytube.StreamQuery.first` returns the expected
+    :class:`Stream <Stream>`.
+    """
     assert cipher_signature.streams.first().itag == '22'
 
 
 def test_order_by(cipher_signature):
+    """Ensure :meth:`~pytube.StreamQuery.order_by` sorts the list of
+    :class:`Stream <Stream>` instances in the expected order.
+    """
     itags = [
         s.itag for s in cipher_signature.streams
         .filter(progressive=True)
@@ -61,6 +77,9 @@ def test_order_by(cipher_signature):
 
 
 def test_order_by_descending(cipher_signature):
+    """Ensure :meth:`~pytube.StreamQuery.desc` sorts the list of
+    :class:`Stream <Stream>` instances in the reverse order.
+    """
     itags = [
         s.itag for s in cipher_signature.streams
         .filter(progressive=True)
@@ -73,6 +92,9 @@ def test_order_by_descending(cipher_signature):
 
 
 def test_order_by_ascending(cipher_signature):
+    """Ensure :meth:`~pytube.StreamQuery.desc` sorts the list of
+    :class:`Stream <Stream>` instances in ascending order.
+    """
     itags = [
         s.itag for s in cipher_signature.streams
         .filter(progressive=True)
@@ -85,6 +107,9 @@ def test_order_by_ascending(cipher_signature):
 
 
 def test_get_by_itag(cipher_signature):
+    """Ensure :meth:`~pytube.StreamQuery.get_by_itag` returns the expected
+    :class:`Stream <Stream>`.
+    """
     assert cipher_signature.streams.get_by_itag(22).itag == '22'