docstrings and linting

.idea/dictionaries/haroldmartin.xml

@@ -28,6 +28,7 @@
       <w>nosec</w>
       <w>ntfs</w>
       <w>prog</w>
+      <w>pylint</w>
       <w>pytube</w>
       <w>recompiles</w>
       <w>samp</w>

pytube/cli.py

@@ -209,7 +209,9 @@ def display_progress_bar(
 
 
 # noinspection PyUnusedLocal
-def on_progress(stream: Any, chunk: bytes, bytes_remaining: int) -> None:
+def on_progress(
+    stream: Any, chunk: bytes, bytes_remaining: int
+) -> None:  # pylint: disable=W0613
     filesize = stream.filesize
     bytes_received = filesize - bytes_remaining
     display_progress_bar(bytes_received, filesize)

pytube/request.py

@@ -46,18 +46,23 @@ def stream(
     while downloaded < file_size:
         stop_pos = min(downloaded + range_size, file_size) - 1
         range_header = f"bytes={downloaded}-{stop_pos}"
-        r = _execute_request(url, method="GET", headers={"Range": range_header})
+        response = _execute_request(url, method="GET", headers={"Range": range_header})
         while True:
-            chunk = r.read(chunk_size)
+            chunk = response.read(chunk_size)
             if not chunk:
                 break
             downloaded += len(chunk)
             yield chunk
-    return
+    return  # pylint: disable=R1711
 
 
 @lru_cache(maxsize=None)
 def filesize(url: str) -> int:
+    """Fetch size in bytes of file at given URL
+
+    :param str url: The URL to get the size of
+    :returns: int: size in bytes of remote file
+    """
     return int(head(url)["content-length"])
 
 

tests/test_streams.py

@@ -15,6 +15,8 @@ def test_filesize(cipher_signature, mocker):
 
 
 def test_filesize_approx(cipher_signature, mocker):
+    mocker.patch.object(request, "head")
+    request.head.return_value = {"content-length": "6796391"}
     stream = cipher_signature.streams[0]
 
     assert stream.filesize_approx == 22350604