"""Library specific exception definitions."""
from typing import Pattern, Union
import logging
logger = logging.getLogger(__name__)
[docs]
class PytubeFixError(Exception):
"""Base pytubefix exception that all others inherit.
This is done to not pollute the built-in exceptions, which *could* result
in unintended errors being unexpectedly and incorrectly handled within
implementers code.
"""
### MISC Errors ###
[docs]
class MaxRetriesExceeded(PytubeFixError):
"""Maximum number of retries exceeded."""
def __init__(self):
super().__init__("Maximum number of retries exceeded")
[docs]
class HTMLParseError(PytubeFixError):
"""HTML could not be parsed"""
[docs]
class SABRError(PytubeFixError):
def __init__(self, msg: str):
self.msg = msg
super().__init__(self.msg)
@property
def error_string(self):
return self.msg
[docs]
class RegexMatchError(ExtractError):
"""Regex pattern did not return any matches."""
def __init__(self, caller: str, pattern: Union[str, Pattern]):
"""
:param str caller:
Calling function
:param str pattern:
Pattern that failed to match
"""
super().__init__(
f"{caller}: could not find match for {pattern}")
self.caller = caller
self.pattern = pattern
[docs]
class InterpretationError(PytubeFixError):
def __init__(self, js_url: str, reason=None):
self.js_url = js_url
self.reason = reason
super().__init__(self.error_string)
@property
def error_string(self):
return f'Error interpreting player js: {self.js_url}' + f' reason: {self.reason}' if self.reason else ''
### Video Unavailable Errors ###
# There are really 3 types of errors thrown
# 1. VideoUnavailable - This is the base error type for all video errors.
# Or a catchall if neither the user or developer cares about the specific error.
# 2. Known Error Type, Extra info useful for user
# 3. Unknown Error Type, Important to Developer
## 1. VideoUnavailable ##
[docs]
class VideoUnavailable(PytubeFixError):
"""
Base video error.
This is the base error type for all video errors.
Call this if you can't group the error by known error type and it is not important to the developer.
"""
def __init__(self, video_id: str):
"""
:param str video_id:
A YouTube video identifier.
"""
self.video_id = video_id
super().__init__(self.error_string)
@property
def error_string(self):
return f'{self.video_id} is unavailable'
## 2. Known Error Type, Extra info useful for user ##
[docs]
class VideoRemovedByYouTubeForViolatingTOS(VideoUnavailable):
"""Raised when a video has been removed for violating YouTube's Community Guidelines or Terms of Service."""
def __init__(self, video_id: str, reason: str = None):
"""
:param str video_id:
A YouTube video identifier.
:param str reason:
Optional reason text from YouTube.
"""
self.video_id = video_id
self.reason = reason or "This video has been removed for violating YouTube's Community Guidelines."
super().__init__(self.video_id)
@property
def error_string(self):
return f"{self.video_id} {self.reason}"
[docs]
class LiveStreamEnded(VideoUnavailable):
"""Raised when the live event has already ended."""
def __init__(self, video_id: str, reason: str = None):
"""
:param str video_id:
A YouTube video identifier.
:param str reason:
Reason for the error, defaults to a standard message.
"""
self.video_id = video_id
self.reason = reason or "This live event has ended."
super().__init__(self.video_id)
@property
def error_string(self):
return f'{self.video_id} {self.reason}'
[docs]
class VideoBlockedByCopyright(VideoUnavailable):
"""Raised when a video is blocked in the user's country on copyright grounds."""
def __init__(self, video_id: str, reason: str = None):
"""
:param str video_id:
A YouTube video identifier.
:param str reason:
The reason for the error (optional).
"""
self.video_id = video_id
self.reason = reason or "This video contains content that is blocked in your country on copyright grounds."
super().__init__(self.video_id)
@property
def error_string(self):
return f'{self.video_id} {self.reason}'
[docs]
class VideoRemovedByUploader(VideoUnavailable):
"""Raised when a video has been removed by the uploader."""
def __init__(self, video_id: str, reason: str = None):
"""
:param str video_id:
A YouTube video identifier.
:param str reason:
The reason for the error (optional).
"""
self.video_id = video_id
self.reason = reason or "This video has been removed by the uploader"
super().__init__(self.video_id)
@property
def error_string(self):
return f'{self.video_id} {self.reason}'
[docs]
class AccountTerminated(VideoUnavailable):
"""Raised when the YouTube account associated with a video has been terminated."""
def __init__(self, video_id: str, reason: str = None):
"""
:param str video_id:
A YouTube video identifier.
:param str reason:
The reason for the error (optional).
"""
self.video_id = video_id
self.reason = reason or (
"This video is no longer available because the YouTube account "
"associated with this video has been terminated."
)
super().__init__(self.video_id)
@property
def error_string(self):
return f'{self.video_id} {self.reason}'
[docs]
class VideoPrivate(VideoUnavailable):
def __init__(self, video_id: str):
"""
:param str video_id:
A YouTube video identifier.
"""
self.video_id = video_id
super().__init__(self.video_id)
@property
def error_string(self):
return f'{self.video_id} is a private video'
[docs]
class MembersOnly(VideoUnavailable):
"""Video is members-only.
YouTube has special videos that are only viewable to users who have
subscribed to a content creator.
ref: https://support.google.com/youtube/answer/7544492?hl=en
"""
def __init__(self, video_id: str):
"""
:param str video_id:
A YouTube video identifier.
"""
self.video_id = video_id
super().__init__(self.video_id)
@property
def error_string(self):
return f'{self.video_id} is a members-only video'
[docs]
class VideoRegionBlocked(VideoUnavailable):
def __init__(self, video_id: str):
"""
:param str video_id:
A YouTube video identifier.
"""
self.video_id = video_id
super().__init__(self.video_id)
@property
def error_string(self):
return f'{self.video_id} is not available in your region'
[docs]
class BotDetection(VideoUnavailable):
def __init__(self, video_id: str):
"""
:param str video_id:
A YouTube video identifier.
"""
self.video_id = video_id
super().__init__(self.video_id)
@property
def error_string(self):
return (
f'{self.video_id} This request was detected as a bot.'
f' DO NOT OPEN AN ISSUE! '
f'See more details at https://pytubefix.readthedocs.io/en/latest/user/po_token.html')
[docs]
class PoTokenRequired(VideoUnavailable):
def __init__(self, video_id: str, client_name: str):
"""
:param str video_id:
A YouTube video identifier.
:param str client_name:
A YouTube client identifier.
"""
self.video_id = video_id
self.client_name = client_name
super().__init__(self.video_id)
@property
def error_string(self):
return (
f'{self.video_id} The {self.client_name} client requires PoToken to obtain functional streams, '
f'See more details at https://pytubefix.readthedocs.io/en/latest/user/po_token.html')
[docs]
class LoginRequired(VideoUnavailable):
def __init__(self, video_id: str, reason: str):
"""
:param str video_id:
A YouTube video identifier.
"""
self.video_id = video_id
self.reason = reason
super().__init__(self.video_id)
@property
def error_string(self):
return (
f'{self.video_id} requires login to view, YouTube reason: {self.reason}')
# legacy livestream error types still supported
[docs]
class RecordingUnavailable(VideoUnavailable):
def __init__(self, video_id: str):
"""
:param str video_id:
A YouTube video identifier.
"""
self.video_id = video_id
super().__init__(self.video_id)
@property
def error_string(self):
return f'{self.video_id} does not have a live stream recording available'
[docs]
class LiveStreamError(VideoUnavailable):
"""Video is a live stream."""
def __init__(self, video_id: str):
"""
:param str video_id:
A YouTube video identifier.
"""
self.video_id = video_id
super().__init__(self.video_id)
@property
def error_string(self):
return f'{self.video_id} is streaming live and cannot be loaded'
[docs]
class LiveStreamOffline(VideoUnavailable):
"""The live will start soon"""
def __init__(self, video_id: str, reason: str):
"""
:param str video_id:
A YouTube video identifier.
:param str reason:
reason for the error
"""
self.video_id = video_id
self.reason = reason
super().__init__(self.video_id)
@property
def error_string(self):
return f'{self.video_id} {self.reason}'
# legacy age restricted error types still supported
[docs]
class AgeRestrictedError(VideoUnavailable):
"""Video is age restricted, and cannot be accessed without OAuth."""
def __init__(self, video_id: str):
"""
:param str video_id:
A YouTube video identifier.
"""
self.video_id = video_id
super().__init__(self.video_id)
@property
def error_string(self):
return f"{self.video_id} is age restricted, and can't be accessed without logging in."
[docs]
class AgeCheckRequiredError(VideoUnavailable):
def __init__(self, video_id: str):
"""
:param str video_id:
A YouTube video identifier.
"""
self.video_id = video_id
super().__init__(self.video_id)
@property
def error_string(self):
return f"{self.video_id} has age restrictions and cannot be accessed without confirmation."
[docs]
class AgeCheckRequiredAccountError(VideoUnavailable):
def __init__(self, video_id: str):
"""
:param str video_id:
A YouTube video identifier.
"""
self.video_id = video_id
super().__init__(self.video_id)
@property
def error_string(self):
return (
f"{self.video_id} may be inappropriate for "
f"some users. Sign in to your primary account to confirm your age.")
[docs]
class InnerTubeResponseError(VideoUnavailable):
def __init__(self, video_id: str, client: str):
"""
:param str video_id:
A YouTube video identifier.
"""
self.video_id = video_id
self.client = client
super().__init__(self.video_id)
@property
def error_string(self):
return (
f"{self.video_id} : {self.client} client did not receive a response from YouTube")
## 3. Unknown Error Type, Important to Developer ##
[docs]
class UnknownVideoError(VideoUnavailable):
"""Unknown video error."""
def __init__(self, video_id: str, status: str = None, reason: str = None, developer_message: str = None):
"""
:param str video_id:
A YouTube video identifier.
:param str status:
The status code of the response.
:param str reason:
The reason for the error.
:param str developer_message:
The message from the developer.
"""
self.video_id = video_id
self.status = status
self.reason = reason
self.developer_message = developer_message
logger.warning('Unknown Video Error')
logger.warning(f'Video ID: {self.video_id}')
logger.warning(f'Status: {self.status}')
logger.warning(f'Reason: {self.reason}')
logger.warning(f'Developer Message: {self.developer_message}')
logger.warning(
'Please open an issue at '
'https://github.com/JuanBindez/pytubefix/issues '
'and provide the above log output.'
)
super().__init__(self.video_id)
@property
def error_string(self):
return f'{self.video_id} has an unknown error, check logs for more info [Status: {self.status}] [Reason: {self.reason}]'