mypy typing for a few functions

pytube/__main__.py

@@ -32,7 +32,7 @@ class YouTube(object):
 
     def __init__(
         self,
-        url=None,
+        url,
         defer_prefetch_init=False,
         on_progress_callback=None,
         on_complete_callback=None,
@@ -185,7 +185,7 @@ class YouTube(object):
             self.js_url = extract.js_url(self.watch_html, self.age_restricted)
             self.js = request.get(self.js_url)
 
-    def initialize_stream_objects(self, fmt):
+    def initialize_stream_objects(self, fmt: str):
         """Convert manifest data to instances of :class:`Stream <Stream>`.
 
         Take the unscrambled stream data and uses it to initialize

pytube/cipher.py

@@ -240,7 +240,7 @@ def parse_function(js_func):
     return regex_search(r"\w+\.(\w+)\(\w,(\d+)\)", js_func, groups=True)
 
 
-def get_signature(js, ciphered_signature):
+def get_signature(js: str, ciphered_signature: str) -> str:
     """Decipher the signature.
 
     Taking the ciphered signature, applies the transform functions.

pytube/cli.py

@@ -66,7 +66,7 @@ def main():
         download(args.url, args.itag)
 
 
-def build_playback_report(url):
+def build_playback_report(url: str):
     """Serialize the request data to json for offline debugging.
 
     :param str url:
@@ -150,7 +150,7 @@ def on_progress(stream, chunk, file_handle, bytes_remaining):
     display_progress_bar(bytes_received, filesize)
 
 
-def download(url, itag):
+def download(url: str, itag: str):
     """Start downloading a YouTube video.
 
     :param str url:
@@ -171,7 +171,7 @@ def download(url, itag):
         sys.exit()
 
 
-def display_streams(url):
+def display_streams(url: str):
     """Probe YouTube video and lists its available formats.
 
     :param str url:

pytube/exceptions.py

@@ -15,7 +15,7 @@ class PytubeError(Exception):
 class ExtractError(PytubeError):
     """Data extraction based exception."""
 
-    def __init__(self, msg, video_id=None):
+    def __init__(self, msg: str, video_id: str = None):
         """Construct an instance of a :class:`ExtractError <ExtractError>`.
 
         :param str msg:

pytube/extract.py

@@ -37,7 +37,7 @@ class PytubeHTMLParser(HTMLParser):
             self.vid_descr += data
 
 
-def is_age_restricted(watch_html):
+def is_age_restricted(watch_html: str) -> bool:
     """Check if content is age restricted.
 
     :param str watch_html:
@@ -53,7 +53,7 @@ def is_age_restricted(watch_html):
     return True
 
 
-def video_id(url):
+def video_id(url: str) -> str:
     """Extract the ``video_id`` from a YouTube url.
 
     This function supports the following patterns:
@@ -71,7 +71,7 @@ def video_id(url):
     return regex_search(r"(?:v=|\/)([0-9A-Za-z_-]{11}).*", url, group=1)
 
 
-def watch_url(video_id):
+def watch_url(video_id: str) -> str:
     """Construct a sanitized YouTube watch url, given a video id.
 
     :param str video_id:
@@ -83,17 +83,21 @@ def watch_url(video_id):
     return "https://youtube.com/watch?v=" + video_id
 
 
-def embed_url(video_id):
+def embed_url(video_id: str) -> str:
     return "https://www.youtube.com/embed/{}".format(video_id)
 
 
-def eurl(video_id):
+def eurl(video_id: str) -> str:
     return "https://youtube.googleapis.com/v/{}".format(video_id)
 
 
 def video_info_url(
-    video_id, watch_url, watch_html, embed_html, age_restricted,
-):
+    video_id: str,
+    watch_url: str,
+    watch_html: str,
+    embed_html: str,
+    age_restricted: bool,
+) -> str:
     """Construct the video_info url.
 
     :param str video_id:
@@ -102,6 +106,7 @@ def video_info_url(
         A YouTube watch url.
     :param str watch_html:
         The html contents of the watch page.
+        TODO: unused
     :param str embed_html:
         The html contents of the embed page (for age restricted videos).
     :param bool age_restricted:
@@ -131,7 +136,7 @@ def video_info_url(
     return "https://youtube.com/get_video_info?" + urlencode(params)
 
 
-def js_url(html, age_restricted=False):
+def js_url(html: str, age_restricted: bool = False) -> str:
     """Get the base JavaScript url.
 
     Construct the base JavaScript url, which contains the decipher

pytube/helpers.py

@@ -91,7 +91,7 @@ def apply_mixin(dct, key, func, *args, **kwargs):
     dct[key] = func(dct[key], *args, **kwargs)
 
 
-def safe_filename(s, max_length=255):
+def safe_filename(s: str, max_length: int = 255) -> str:
     """Sanitize a string making it safe to use as a filename.
 
     This function was based off the limitations outlined here:

pytube/itags.py

@@ -98,7 +98,7 @@ LIVE = [91, 92, 93, 94, 95, 96, 132, 151]
 
 
 def get_format_profile(itag):
-    """Get dditional format information for a given itag.
+    """Get additional format information for a given itag.
 
     :param str itag:
         YouTube format identifier code.

pytube/mixins.py

@@ -4,6 +4,7 @@
 import json
 import logging
 import pprint
+from typing import Dict
 
 from pytube import cipher
 from urllib import request
@@ -16,7 +17,7 @@ from pytube.exceptions import LiveStreamError
 logger = logging.getLogger(__name__)
 
 
-def apply_signature(config_args, fmt, js):
+def apply_signature(config_args: Dict, fmt: str, js: str):
     """Apply the decrypted signature to the stream manifest.
 
     :param dict config_args:
@@ -66,14 +67,14 @@ def apply_signature(config_args, fmt, js):
         stream_manifest[i]["url"] = url + "&sig=" + signature
 
 
-def apply_descrambler(stream_data, key):
+def apply_descrambler(stream_data: Dict, key: str):
     """Apply various in-place transforms to YouTube's media stream data.
 
     Creates a ``list`` of dictionaries by string splitting on commas, then
     taking each list item, parsing it as a query string, converting it to a
     ``dict`` and unquoting the value.
 
-    :param dict dct:
+    :param dict stream_data:
         Dictionary containing query string encoded values.
     :param str key:
         Name of the key in dictionary.