Merge pull request #56 from hbmartin/logging

pytube/__init__.py

@@ -10,13 +10,9 @@ __license__ = "MIT License"
 __copyright__ = "Copyright 2019 Nick Ficano"
 
 from pytube.version import __version__
-from pytube.helpers import create_logger
 from pytube.streams import Stream
 from pytube.captions import Caption
 from pytube.query import CaptionQuery
 from pytube.query import StreamQuery
 from pytube.__main__ import YouTube
 from pytube.contrib.playlist import Playlist
-
-logger = create_logger()
-logger.info("%s v%s", __title__, __version__)

pytube/cipher.py

@@ -14,15 +14,15 @@ functions" (2) maps them to Python equivalents and (3) taking the ciphered
 signature and decoding it.
 
 """
-
+import logging
 import re
 from itertools import chain
 from typing import List, Tuple, Dict, Callable, Any, Optional
 
 from pytube.exceptions import RegexMatchError
-from pytube.helpers import regex_search, create_logger, cache
+from pytube.helpers import regex_search, cache
 
-logger = create_logger()
+logger = logging.getLogger(__name__)
 
 
 class Cipher:

pytube/cli.py

@@ -17,9 +17,7 @@ from typing import Any, Optional, List
 from pytube import __version__, CaptionQuery, Stream, Playlist
 from pytube import YouTube
 from pytube.exceptions import PytubeError
-from pytube.helpers import safe_filename
-
-logger = logging.getLogger(__name__)
+from pytube.helpers import safe_filename, setup_logger
 
 
 def main():
@@ -27,7 +25,9 @@ def main():
     # noinspection PyTypeChecker
     parser = argparse.ArgumentParser(description=main.__doc__)
     args = _parse_args(parser)
-    logging.getLogger().setLevel(max(3 - args.verbosity, 0) * 10)
+    if args.verbosity:
+        log_level = min(args.verbosity, 4) * 10
+        setup_logger(logging.FATAL - log_level)
 
     if not args.url or "youtu" not in args.url:
         parser.print_help()
@@ -99,7 +99,7 @@ def _parse_args(
         action="count",
         default=0,
         dest="verbosity",
-        help="Verbosity level",
+        help="Verbosity level, use up to 4 to increase logging -vvvv",
     )
     parser.add_argument(
         "--build-playback-report",

pytube/extract.py

@@ -1,6 +1,7 @@
 # -*- coding: utf-8 -*-
 """This module contains all non-cipher related data extraction logic."""
 import json
+import logging
 import re
 from collections import OrderedDict
 from html.parser import HTMLParser
@@ -10,7 +11,9 @@ from urllib.parse import urlencode
 
 from pytube.cipher import Cipher
 from pytube.exceptions import RegexMatchError, HTMLParseError, LiveStreamError
-from pytube.helpers import regex_search, logger
+from pytube.helpers import regex_search
+
+logger = logging.getLogger(__name__)
 
 
 class PytubeHTMLParser(HTMLParser):

pytube/helpers.py

@@ -86,7 +86,7 @@ def safe_filename(s: str, max_length: int = 255) -> str:
     return filename[:max_length].rsplit(" ", 0)[0]
 
 
-def create_logger(level: int = logging.ERROR) -> logging.Logger:
+def setup_logger(level: int = logging.ERROR):
     """Create a configured instance of logger.
 
     :param int level:
@@ -103,7 +103,6 @@ def create_logger(level: int = logging.ERROR) -> logging.Logger:
     logger = logging.getLogger("pytube")
     logger.addHandler(handler)
     logger.setLevel(level)
-    return logger
 
 
 GenericType = TypeVar("GenericType")

tests/test_cli.py

@@ -154,12 +154,27 @@ def test_parse_args_truthy():
             "en",
             "-l",
             "--itag=10",
+            "-vvv",
         ],
     )
     assert args.url == "http://youtube.com/watch?v=9bZkp7q19f0"
     assert args.build_playback_report is True
     assert args.itag == 10
     assert args.list is True
+    assert args.verbosity == 3
+
+
+@mock.patch("pytube.cli.setup_logger", return_value=None)
+def test_main_logging_setup(setup_logger):
+    # Given
+    parser = argparse.ArgumentParser()
+    args = parse_args(parser, ["http://fakeurl", "-v"])
+    cli._parse_args = MagicMock(return_value=args)
+    # When
+    with pytest.raises(SystemExit):
+        cli.main()
+    # Then
+    setup_logger.assert_called_with(40)
 
 
 @mock.patch("pytube.cli.YouTube", return_value=None)

tests/test_helpers.py

@@ -5,7 +5,7 @@ import pytest
 
 from pytube import helpers
 from pytube.exceptions import RegexMatchError
-from pytube.helpers import deprecated, cache, target_directory
+from pytube.helpers import deprecated, cache, target_directory, setup_logger
 
 
 def test_regex_search_no_match():
@@ -74,3 +74,15 @@ def test_target_directory_with_absolute_path(_, makedirs):
 def test_target_directory_with_no_path(_, makedirs):
     assert target_directory() == "/cwd"
     makedirs.assert_called()
+
+
+@mock.patch("pytube.helpers.logging")
+def test_setup_logger(logging):
+    # Given
+    logger = logging.getLogger.return_value
+    # When
+    setup_logger(20)
+    # Then
+    logging.getLogger.assert_called_with("pytube")
+    logger.addHandler.assert_called()
+    logger.setLevel.assert_called_with(20)