added logging

pytube/__init__.py

@@ -15,6 +15,9 @@ __author__ = 'Nick Ficano'
 __license__ = 'MIT License'
 __copyright__ = 'Copyright 2017 Nick Ficano'
 
+from pytube.logging import create_logger
 from pytube.query import StreamQuery
 from pytube.streams import Stream
 from pytube.__main__ import YouTube
+
+logger = create_logger()

pytube/__main__.py

@@ -7,6 +7,7 @@ This module implements the core developer interface for pytube.
 
 """
 import json
+import logging
 
 from pytube import extract
 from pytube import mixins
@@ -17,6 +18,9 @@ from pytube.helpers import apply_mixin
 from pytube.helpers import memoize
 
 
+logger = logging.getLogger(__name__)
+
+
 class YouTube(object):
 
     def __init__(
@@ -122,6 +126,7 @@ class YouTube(object):
         instances of :class:`Stream <Stream>` for each media stream.
 
         """
+        logger.info('building Stream instances')
         streams = self.player_config['args'][fmt]
         for stream in streams:
             video = Stream(

pytube/cipher.py

@@ -4,12 +4,16 @@ pytube.cipher
 ~~~~~~~~~~~~~
 
 """
+import logging
 import re
 from itertools import chain
 
 from pytube.helpers import memoize
 
 
+logger = logging.getLogger(__name__)
+
+
 def get_initial_function_name(js):
     """Extracts the name of the function responsible for computing the signature.
     """

pytube/logging.py

@@ -0,0 +1,90 @@
+# -*- coding: utf-8 -*-
+import datetime as dt
+import json
+import logging
+from collections import OrderedDict
+
+from pytube import __version__
+
+
+KEPT_ATTRS = ('funcName', 'module',)
+RESERVED_ATTRS = (
+    'args',
+    'created',
+    'exc_info',
+    'exc_text',
+    'filename',
+    'levelno',
+    'lineno',
+    'msecs',
+    'msg',
+    'name',
+    'pathname',
+    'process',
+    'processName',
+    'relativeCreated',
+    'stack_info',
+    'thread',
+    'threadName',
+)
+
+
+class JsonFormatter(logging.Formatter):
+    def __init__(self, *args, **kwargs):
+        logging.Formatter.__init__(self, *args, **kwargs)
+        self.json_encoder = kwargs.get('json_encoder', self.json_encode)
+        self.kept_attrs = kwargs.get('kept_attrs', KEPT_ATTRS)
+        self.permanent_metadata = kwargs.get('metadata', {})
+        self.skipped_attrs = kwargs.get('skipped_attrs', RESERVED_ATTRS)
+
+    def extra_metadata(self):
+        return self.permanent_metadata
+
+    def get_timestamp(self):
+        return dt.datetime.utcnow().isoformat()
+
+    def json_encode(self, obj):
+        try:
+            if isinstance(obj, (bool, str, int, float, None,)):
+                return obj
+        except TypeError:
+            pass
+
+        return str(obj)
+
+    def jsonify(self, log):
+        return json.dumps(log, default=self.json_encoder, indent=2)
+
+    def format(self, record):
+        new_record = OrderedDict()
+
+        new_record['timestamp'] = self.get_timestamp()
+        new_record['message'] = record.getMessage()
+        new_record['levelname'] = record.__dict__.pop('levelname')
+        new_record['version'] = __version__
+
+        new_record.update(OrderedDict({'metadata': {'extra': {}}}))
+        # new_record['metadata'].update(self.extra_metadata())
+
+        for key, value in record.__dict__.items():
+            if key in self.kept_attrs:
+                new_record['metadata'][key] = value
+            elif key not in self.skipped_attrs:
+                new_record['metadata']['extra'][key] = value
+
+        if record.exc_info:
+            fmt_exception = self.formatException(record.exc_info)
+            new_record['metadata']['exception'] = fmt_exception
+
+        return '%s' % (self.jsonify(new_record))
+
+
+def create_logger():
+    logger = logging.getLogger()
+
+    handler = logging.StreamHandler()
+    handler.setFormatter(JsonFormatter())
+
+    logger.addHandler(handler)
+    logger.setLevel(logging.DEBUG)
+    return logger

pytube/mixins.py

@@ -4,11 +4,16 @@ pytube.mixins
 ~~~~~~~~~~~~~
 
 """
+import logging
+
 from pytube import cipher
 from pytube.compat import parse_qsl
 from pytube.compat import unquote
 
 
+logger = logging.getLogger(__name__)
+
+
 def apply_signature(video_info, fmt, js):
     stream_map = video_info[fmt]
     for i, stream in enumerate(stream_map):
@@ -16,6 +21,13 @@ def apply_signature(video_info, fmt, js):
         if 'signature=' in url:
             continue
         signature = cipher.get_signature(js, stream['s'])
+        logger.debug(
+            'descrambling url signature %s ', stream['s'], extra={
+                's': stream['s'],
+                'signature': signature,
+                'itag': stream['itag'],
+            },
+        )
         stream_map[i]['url'] = url + '&signature=' + signature