Source code for pytube.__main__

"""
This module implements the core developer interface for pytube.

The problem domain of the :class:`YouTube <YouTube> class focuses almost
exclusively on the developer interface. Pytube offloads the heavy lifting to
smaller peripheral modules and functions.

"""
import json
import logging
from typing import Any, Callable, Dict, List, Optional
from urllib.parse import parse_qsl

import pytube
import pytube.exceptions as exceptions
from pytube import extract, request
from pytube import Stream, StreamQuery
from pytube.helpers import install_proxy
from pytube.metadata import YouTubeMetadata
from pytube.monostate import Monostate

logger = logging.getLogger(__name__)


[docs]class YouTube: """Core developer interface for pytube.""" def __init__( self, url: str, on_progress_callback: Optional[Callable[[Any, bytes, int], None]] = None, on_complete_callback: Optional[Callable[[Any, Optional[str]], None]] = None, proxies: Dict[str, str] = None, ): """Construct a :class:`YouTube <YouTube>`. :param str url: A valid YouTube watch URL. :param func on_progress_callback: (Optional) User defined callback function for stream download progress events. :param func on_complete_callback: (Optional) User defined callback function for stream download complete events. """ self._js: Optional[str] = None # js fetched by js_url self._js_url: Optional[str] = None # the url to the js, parsed from watch html # note: vid_info may eventually be removed. It sounds like it once had # additional formats, but that doesn't appear to still be the case. # the url to vid info, parsed from watch html self._vid_info_url: Optional[str] = None self._vid_info_raw: Optional[str] = None # content fetched by vid_info_url self._vid_info: Optional[Dict] = None # parsed content of vid_info_raw self._watch_html: Optional[str] = None # the html of /watch?v=<video_id> self._embed_html: Optional[str] = None self._player_config_args: Optional[Dict] = None # inline js in the html containing self._player_response: Optional[Dict] = None # streams self._age_restricted: Optional[bool] = None self._fmt_streams: Optional[List[Stream]] = None self._initial_data = None self._metadata: Optional[YouTubeMetadata] = None # video_id part of /watch?v=<video_id> self.video_id = extract.video_id(url) self.watch_url = f"https://youtube.com/watch?v={self.video_id}" self.embed_url = f"https://www.youtube.com/embed/{self.video_id}" # Shared between all instances of `Stream` (Borg pattern). self.stream_monostate = Monostate( on_progress=on_progress_callback, on_complete=on_complete_callback ) if proxies: install_proxy(proxies) self._author = None self._title = None self._publish_date = None @property def watch_html(self): if self._watch_html: return self._watch_html self._watch_html = request.get(url=self.watch_url) return self._watch_html @property def embed_html(self): if self._embed_html: return self._embed_html self._embed_html = request.get(url=self.embed_url) return self._embed_html @property def vid_info_raw(self): if self._vid_info_raw: return self._vid_info_raw self._vid_info_raw = request.get(self.vid_info_url) return self._vid_info_raw @property def age_restricted(self): if self._age_restricted: return self._age_restricted self._age_restricted = extract.is_age_restricted(self.watch_html) return self._age_restricted @property def vid_info_url(self): if self._vid_info_url: return self._vid_info_url if self.age_restricted: self._vid_info_url = extract.video_info_url_age_restricted( self.video_id, self.watch_url ) else: self._vid_info_url = extract.video_info_url( video_id=self.video_id, watch_url=self.watch_url ) return self._vid_info_url @property def js_url(self): if self._js_url: return self._js_url if self.age_restricted: self._js_url = extract.js_url(self.embed_html) else: self._js_url = extract.js_url(self.watch_html) return self._js_url @property def js(self): if self._js: return self._js # If the js_url doesn't match the cached url, fetch the new js and update # the cache; otherwise, load the cache. if pytube.__js_url__ != self.js_url: self._js = request.get(self.js_url) pytube.__js__ = self._js pytube.__js_url__ = self.js_url else: self._js = pytube.__js__ return self._js @property def player_response(self): """The player response contains subtitle information and video details.""" if self._player_response: return self._player_response if isinstance(self.player_config_args["player_response"], str): self._player_response = json.loads( self.player_config_args["player_response"] ) else: self._player_response = self.player_config_args["player_response"] return self._player_response @property def initial_data(self): if self._initial_data: return self._initial_data self._initial_data = extract.initial_data(self.watch_html) return self._initial_data @property def player_config_args(self): if self._player_config_args: return self._player_config_args self._player_config_args = self.vid_info # On pre-signed videos, we need to use get_ytplayer_config to fix # the player_response item if 'streamingData' not in self.player_config_args['player_response']: config_response = extract.get_ytplayer_config(self.watch_html) if 'args' in config_response: self.player_config_args['player_response'] = config_response['args']['player_response'] # noqa: E501 else: self.player_config_args['player_response'] = config_response return self._player_config_args @property def fmt_streams(self): """Returns a list of streams if they have been initialized. If the streams have not been initialized, finds all relevant streams and initializes them. """ self.check_availability() if self._fmt_streams: return self._fmt_streams self._fmt_streams = [] # https://github.com/pytube/pytube/issues/165 stream_maps = ["url_encoded_fmt_stream_map"] if "adaptive_fmts" in self.player_config_args: stream_maps.append("adaptive_fmts") # unscramble the progressive and adaptive stream manifests. for fmt in stream_maps: if not self.age_restricted and fmt in self.vid_info: extract.apply_descrambler(self.vid_info, fmt) extract.apply_descrambler(self.player_config_args, fmt) extract.apply_signature(self.player_config_args, fmt, self.js) # build instances of :class:`Stream <Stream>` # Initialize stream objects stream_manifest = self.player_config_args[fmt] for stream in stream_manifest: video = Stream( stream=stream, player_config_args=self.player_config_args, monostate=self.stream_monostate, ) self._fmt_streams.append(video) self.stream_monostate.title = self.title self.stream_monostate.duration = self.length return self._fmt_streams
[docs] def check_availability(self): """Check whether the video is available. Raises different exceptions based on why the video is unavailable, otherwise does nothing. """ status, messages = extract.playability_status(self.watch_html) for reason in messages: if status == 'UNPLAYABLE': if reason == ( 'Join this channel to get access to members-only content ' 'like this video, and other exclusive perks.' ): raise exceptions.MembersOnly(video_id=self.video_id) elif reason == 'This live stream recording is not available.': raise exceptions.RecordingUnavailable(video_id=self.video_id) else: if reason == 'Video unavailable': if extract.is_region_blocked(self.watch_html): raise exceptions.VideoRegionBlocked(video_id=self.video_id) raise exceptions.VideoUnavailable(video_id=self.video_id) elif status == 'LOGIN_REQUIRED': if reason == ( 'This is a private video. ' 'Please sign in to verify that you may see it.' ): raise exceptions.VideoPrivate(video_id=self.video_id) elif status == 'ERROR': if reason == 'Video unavailable': raise exceptions.VideoUnavailable(video_id=self.video_id) elif status == 'LIVE_STREAM': raise exceptions.LiveStreamError(video_id=self.video_id)
@property def vid_info(self): """Parse the raw vid info and return the parsed result. :rtype: Dict[Any, Any] """ return dict(parse_qsl(self.vid_info_raw)) @property def caption_tracks(self) -> List[pytube.Caption]: """Get a list of :class:`Caption <Caption>`. :rtype: List[Caption] """ raw_tracks = ( self.player_response.get("captions", {}) .get("playerCaptionsTracklistRenderer", {}) .get("captionTracks", []) ) return [pytube.Caption(track) for track in raw_tracks] @property def captions(self) -> pytube.CaptionQuery: """Interface to query caption tracks. :rtype: :class:`CaptionQuery <CaptionQuery>`. """ return pytube.CaptionQuery(self.caption_tracks) @property def streams(self) -> StreamQuery: """Interface to query both adaptive (DASH) and progressive streams. :rtype: :class:`StreamQuery <StreamQuery>`. """ self.check_availability() return StreamQuery(self.fmt_streams) @property def thumbnail_url(self) -> str: """Get the thumbnail url image. :rtype: str """ thumbnail_details = ( self.player_response.get("videoDetails", {}) .get("thumbnail", {}) .get("thumbnails") ) if thumbnail_details: thumbnail_details = thumbnail_details[-1] # last item has max size return thumbnail_details["url"] return f"https://img.youtube.com/vi/{self.video_id}/maxresdefault.jpg" @property def publish_date(self): """Get the publish date. :rtype: datetime """ if self._publish_date: return self._publish_date self._publish_date = extract.publish_date(self.watch_html) return self._publish_date @publish_date.setter def publish_date(self, value): """Sets the publish date.""" self._publish_date = value @property def title(self) -> str: """Get the video title. :rtype: str """ if self._title: return self._title self._title = self.player_response['videoDetails']['title'] return self._title @title.setter def title(self, value): """Sets the title value.""" self._title = value @property def description(self) -> str: """Get the video description. :rtype: str """ return self.player_response.get("videoDetails", {}).get("shortDescription") @property def rating(self) -> float: """Get the video average rating. :rtype: float """ return self.player_response.get("videoDetails", {}).get("averageRating") @property def length(self) -> int: """Get the video length in seconds. :rtype: int """ return int( self.player_config_args.get("length_seconds") or ( self.player_response.get("videoDetails", {}).get( "lengthSeconds" ) ) ) @property def views(self) -> int: """Get the number of the times the video has been viewed. :rtype: int """ return int( self.player_response.get("videoDetails", {}).get("viewCount") ) @property def author(self) -> str: """Get the video author. :rtype: str """ if self._author: return self._author self._author = self.player_response.get("videoDetails", {}).get( "author", "unknown" ) return self._author @author.setter def author(self, value): """Set the video author.""" self._author = value @property def keywords(self) -> List[str]: """Get the video keywords. :rtype: List[str] """ return self.player_response.get('videoDetails', {}).get('keywords', []) @property def channel_id(self) -> str: """Get the video poster's channel id. :rtype: str """ return self.player_response.get('videoDetails', {}).get('channelId', None) @property def channel_url(self) -> str: """Construct the channel url for the video's poster from the channel id. :rtype: str """ return f'https://www.youtube.com/channel/{self.channel_id}' @property def metadata(self) -> Optional[YouTubeMetadata]: """Get the metadata for the video. :rtype: YouTubeMetadata """ if self._metadata: return self._metadata else: self._metadata = extract.metadata(self.initial_data) return self._metadata
[docs] def register_on_progress_callback(self, func: Callable[[Any, bytes, int], None]): """Register a download progress callback function post initialization. :param callable func: A callback function that takes ``stream``, ``chunk``, and ``bytes_remaining`` as parameters. :rtype: None """ self.stream_monostate.on_progress = func
[docs] def register_on_complete_callback(self, func: Callable[[Any, Optional[str]], None]): """Register a download complete callback function post initialization. :param callable func: A callback function that takes ``stream`` and ``file_path``. :rtype: None """ self.stream_monostate.on_complete = func