docstrings

pytube/__main__.py

@@ -83,7 +83,7 @@ class YouTube(object):
     def prefetch_init(self):
         """Download data, descramble it, and build Stream instances.
 
-        :rtype: ``None``
+        :rtype: None
 
         """
         self.prefetch()
@@ -97,7 +97,7 @@ class YouTube(object):
         be applied in-place, instead of holding references to mutations at each
         interstitial step.
 
-        :rtype: ``None``
+        :rtype: None
 
         """
         logger.info('init started')
@@ -136,7 +136,7 @@ class YouTube(object):
         operations don't does need to make calls outside of the interpreter
         which blocks for long periods of time.
 
-        :rtype: ``None``
+        :rtype: None
 
         """
         self.watch_html = request.get(url=self.watch_url)
@@ -162,7 +162,7 @@ class YouTube(object):
             download or adaptive streams (e.g.: ``url_encoded_fmt_stream_map``
             or ``adaptive_fmts``).
 
-        :rtype: ``None``
+        :rtype: None
 
         """
         stream_manifest = self.player_config['args'][fmt]
@@ -180,7 +180,7 @@ class YouTube(object):
         Take the unscrambled player response data, and use it to initialize
         instances of :class:`Caption <Caption>`.
 
-        :rtype: ``None``
+        :rtype: None
 
         """
         if 'captions' not in self.player_config['args']['player_response']:
@@ -237,7 +237,7 @@ class YouTube(object):
             A callback function that takes ``stream``, ``chunk``,
             ``file_handle``, ``bytes_remaining`` as parameters.
 
-        :rtype: ``None``
+        :rtype: None
 
         """
         self.stream_monostate['on_progress'] = func
@@ -248,7 +248,7 @@ class YouTube(object):
         :param callable func:
             A callback function that takes ``stream`` and  ``file_handle``.
 
-        :rtype: ``None``
+        :rtype: None
 
         """
         self.stream_monostate['on_complete'] = func

pytube/helpers.py

@@ -70,7 +70,7 @@ def apply_mixin(dct, key, func, *args, **kwargs):
     :param \*\*kwargs:
         (optional) keyword arguments that ``func`` takes.
     :rtype:
-        ``None``
+        None
     """
     dct[key] = func(dct[key], *args, **kwargs)
 

pytube/query.py

@@ -27,59 +27,59 @@ class StreamQuery:
         :param fps:
             (optional) The frames per second.
         :type fps:
-            int or ``None``
+            int or None
 
         :param resolution:
             (optional) Alias to ``res``.
         :type res:
-            str or ``None``
+            str or None
 
         :param res:
             (optional) The video resolution.
         :type resolution:
-            str or ``None``
+            str or None
 
         :param mime_type:
             (optional) Two-part identifier for file formats and format contents
             composed of a "type", a "subtype".
         :type mime_type:
-            str or ``None``
+            str or None
 
         :param type:
             (optional) Type part of the ``mime_type`` (e.g.: audio, video).
         :type type:
-            str or ``None``
+            str or None
 
         :param subtype:
             (optional) Sub-type part of the ``mime_type`` (e.g.: mp4, mov).
         :type subtype:
-            str or ``None``
+            str or None
 
         :param file_extension:
             (optional) Alias to ``sub_type``.
         :type file_extension:
-            str or ``None``
+            str or None
 
         :param abr:
             (optional) Average bitrate (ABR) refers to the average amount of
             data transferred per unit of time (e.g.: 64kbps, 192kbps).
         :type abr:
-            str or ``None``
+            str or None
 
         :param bitrate:
             (optional) Alias to ``abr``.
         :type bitrate:
-            str or ``None``
+            str or None
 
         :param video_codec:
             (optional) Video compression format.
         :type video_codec:
-            str or ``None``
+            str or None
 
         :param audio_codec:
             (optional) Audio compression format.
         :type audio_codec:
-            str or ``None``
+            str or None
 
         :param bool progressive:
             Excludes adaptive streams (one file contains both audio and video
@@ -99,7 +99,7 @@ class StreamQuery:
             (optional) Interface for defining complex filters without
             subclassing.
         :type custom_filter_functions:
-            list or ``None``
+            list or None
 
         """
         filters = []
@@ -189,9 +189,9 @@ class StreamQuery:
 
         :param str itag:
             YouTube format identifier code.
-        :rtype: :class:`Stream <Stream>` or ``None``
+        :rtype: :class:`Stream <Stream>` or None
         :returns:
-            The :class:`Stream <Stream>` matching the given itag or ``None`` if
+            The :class:`Stream <Stream>` matching the given itag or None if
             not found.
 
         """
@@ -203,9 +203,9 @@ class StreamQuery:
     def first(self):
         """Get the first :class:`Stream <Stream>` in the results.
 
-        :rtype: :class:`Stream <Stream>` or ``None``
+        :rtype: :class:`Stream <Stream>` or None
         :returns:
-            the first result of this query or ``None`` if the result doesn't
+            the first result of this query or None if the result doesn't
             contain any streams.
 
         """
@@ -217,9 +217,9 @@ class StreamQuery:
     def last(self):
         """Get the last :class:`Stream <Stream>` in the results.
 
-        :rtype: :class:`Stream <Stream>` or ``None``
+        :rtype: :class:`Stream <Stream>` or None
         :returns:
-            Return the last result of this query or ``None`` if the result
+            Return the last result of this query or None if the result
             doesn't contain any streams.
 
         """
@@ -263,10 +263,10 @@ class CaptionQuery:
 
         :param str lang_code:
             The code that identifies the caption language.
-        :rtype: :class:`Caption <Caption>` or ``None``
+        :rtype: :class:`Caption <Caption>` or None
         :returns:
             The :class:`Caption <Caption>` matching the given ``lang_code`` or
-            ``None`` if it does not exist.
+            None if it does not exist.
         """
         return self.lang_code_index.get(lang_code)
 

pytube/streams.py

@@ -132,7 +132,7 @@ class Stream(object):
 
         Parse a variable length sized list of codecs and returns a
         consitant two element tuple, with the video codec as the first element
-        and audio as the second. Returns ``None`` if one is not available
+        and audio as the second. Returns None if one is not available
         (adaptive only).
 
         :rtype: tuple
@@ -180,7 +180,7 @@ class Stream(object):
             (optional) Output path for writing media file. If one is not
             specified, defaults to the current working directory.
         :type output_path: str or None
-        :rtype: ``None``
+        :rtype: None
 
         """
         # TODO(nficano): allow a filename to specified.
@@ -219,7 +219,7 @@ class Stream(object):
             The delta between the total file size in bytes and amount already
             downloaded.
 
-        :rtype: ``None``
+        :rtype: None
 
         """
         file_handler.write(chunk)
@@ -245,7 +245,7 @@ class Stream(object):
         :type file_handle:
             :py:class:`io.BufferedWriter`
 
-        :rtype: ``None``
+        :rtype: None
 
         """
         logger.debug('download finished')

tests/test_query.py

@@ -40,7 +40,7 @@ def test_filters(test_input, expected, cipher_signature):
 @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
+    :meth:`~pytube.StreamQuery.first` return None if the resultset is
     empty.
     """
     query = cipher_signature.streams.filter(video_codec='vp20')