update callback documentation

README.md

@@ -7,7 +7,7 @@
 	  <a href='https://pytube3.readthedocs.io/en/latest/?badge=latest'><img src='https://readthedocs.org/projects/pytube3/badge/?version=latest' alt='Documentation Status' /></a>
 	  <a href="https://codecov.io/gh/hbmartin/pytube3"><img src="https://codecov.io/gh/hbmartin/pytube3/branch/master/graph/badge.svg" /></a>
 	  <a href="https://www.codefactor.io/repository/github/hbmartin/pytube3/overview/master"><img src="https://www.codefactor.io/repository/github/hbmartin/pytube3/badge/master" alt="CodeFactor" /></a>
-	  <a href="https://gitter.im/pytube3/community"><img src="https://badges.gitter.im/pytube3.png" /></a>
+	  <a href="https://gitter.im/pytube3/community"><img src="https://img.shields.io/badge/chat-gitter-lightgrey" /></a>
   </p>
 </div>
 
@@ -207,7 +207,7 @@ Note: Using ``order_by`` on a given attribute will filter out all streams missin
 If your application requires post-processing logic, pytube allows you to specify an "on download complete" callback function:
 
 ```python
- >>> def convert_to_aac(stream, file_handler):
+ >>> def convert_to_aac(stream: Stream, file_path: str):
          return  # do work
 
  >>> yt.register_on_complete_callback(convert_to_aac)
@@ -216,7 +216,7 @@ If your application requires post-processing logic, pytube allows you to specify
 Similarly, if your application requires on-download progress logic, pytube exposes a callback for this as well:
 
 ```python
- >>> def show_progress_bar(stream, chunk, file_handler, bytes_remaining):
+ >>> def show_progress_bar(stream: Stream, chunk: bytes, bytes_remaining: int):
          return  # do work
 
  >>> yt.register_on_progress_callback(show_progress_bar)

pytube/__main__.py

@@ -317,7 +317,7 @@ class YouTube:
 
         :param callable func:
             A callback function that takes ``stream``, ``chunk``,
-            ``file_handle``, ``bytes_remaining`` as parameters.
+             and ``bytes_remaining`` as parameters.
 
         :rtype: None
 
@@ -328,7 +328,7 @@ class YouTube:
         """Register a download complete callback function post initialization.
 
         :param callable func:
-            A callback function that takes ``stream`` and  ``file_handle``.
+            A callback function that takes ``stream`` and  ``file_path``.
 
         :rtype: None
 

pytube/cipher.py

@@ -77,7 +77,7 @@ class Cipher:
 
         **Example**:
 
-        >>> parse_function('DE.AJ(a,15)')
+        parse_function('DE.AJ(a,15)')
         ('AJ', 15)
 
         """

pytube/cli.py

@@ -11,7 +11,7 @@ import os
 import shutil
 import sys
 import subprocess  # nosec
-from typing import Any, Optional, List
+from typing import List, Optional
 
 from pytube import __version__, CaptionQuery, Stream, Playlist
 from pytube import YouTube
@@ -210,7 +210,7 @@ def display_progress_bar(
 
 # noinspection PyUnusedLocal
 def on_progress(
-    stream: Any, chunk: bytes, bytes_remaining: int
+    stream: Stream, chunk: bytes, bytes_remaining: int
 ) -> None:  # pylint: disable=W0613
     filesize = stream.filesize
     bytes_received = filesize - bytes_remaining

pytube/monostate.py

@@ -12,7 +12,7 @@ class OnProgress(Protocol):
             An instance of :class:`Stream <Stream>` being downloaded.
         :type stream:
             :py:class:`pytube.Stream`
-        :param str chunk:
+        :param bytes chunk:
             Segment of media file binary data, not yet written to disk.
         :param int bytes_remaining:
             How many bytes have been downloaded.