[ie] Add `_BROKEN_ISSUE`

This commit is contained in:
pukkandan 2024-04-01 07:31:22 +05:30
parent 8463fb510a
commit 93efacd098
No known key found for this signature in database
GPG Key ID: 7EEE9E1E817D0A39
7 changed files with 27 additions and 11 deletions

View File

@ -15,7 +15,7 @@ from devscripts.utils import get_filename_args, read_file, write_file
NO_ATTR = object()
STATIC_CLASS_PROPERTIES = [
'IE_NAME', '_ENABLED', '_VALID_URL', # Used for URL matching
'_WORKING', 'IE_DESC', '_NETRC_MACHINE', 'SEARCH_KEY', # Used for --extractor-descriptions
'_BROKEN_ISSUE', 'IE_DESC', '_NETRC_MACHINE', 'SEARCH_KEY', # Used for --extractor-descriptions
'age_limit', # Used for --age-limit (evaluated)
'_RETURN_TYPE', # Accessed in CLI only with instance (evaluated)
]

View File

@ -98,7 +98,7 @@ def generator(test_case, tname):
self.skipTest(reason)
if not ie.working():
print_skipping('IE marked as not _WORKING')
print_skipping('IE marked with _BROKEN_ISSUE')
for tc in test_cases:
if tc.get('expected_exception'):
@ -117,7 +117,7 @@ def generator(test_case, tname):
for other_ie in other_ies:
if not other_ie.working():
print_skipping('test depends on %sIE, marked as not WORKING' % other_ie.ie_key())
print_skipping('test depends on %sIE, marked with _BROKEN_ISSUE' % other_ie.ie_key())
params = get_params(test_case.get('params', {}))
params['outtmpl'] = tname + '_' + params['outtmpl']

View File

@ -40,8 +40,8 @@ class BaseTestSubtitles(unittest.TestCase):
self.ie = self.IE()
self.DL.add_info_extractor(self.ie)
if not self.IE.working():
print('Skipping: %s marked as not _WORKING' % self.IE.ie_key())
self.skipTest('IE marked as not _WORKING')
print('Skipping: %s marked with _BROKEN_ISSUE' % self.IE.ie_key())
self.skipTest('IE marked with _BROKEN_ISSUE')
def getInfoDict(self):
info_dict = self.DL.extract_info(self.url, download=False)

View File

@ -1570,8 +1570,13 @@ class YoutubeDL:
continue
if not ie.working():
self.report_warning('The program functionality for this site has been marked as broken, '
'and will probably not work.')
self.report_warning(join_nonempty(
f'[{ie.IE_NAME}] The program\'s functionality for this site has been marked as '
f'{self._format_err("BROKEN", self.Styles.ERROR)}, and will probably not work.',
format_field(ie._BROKEN_ISSUE, None, f'See {self._format_err("%s", self.Styles.EMPHASIS)}'
' for more information. Do NOT open a new issue for this.'),
delim='\n '))
temp_id = ie.get_temp_id(url)
if temp_id is not None and self.in_download_archive({'id': temp_id, 'ie_key': key}):

View File

@ -544,8 +544,9 @@ class InfoExtractor:
The _ENABLED attribute should be set to False for IEs that
are disabled by default and must be explicitly enabled.
The _WORKING attribute should be set to False for broken IEs
For broken extractors, the _BROKEN_ISSUE attribute can be set to the issue URL
in order to warn the users and skip the tests.
[Deprecated] If there is no open issue, set _WORKING = False instead.
"""
_ready = False
@ -611,10 +612,13 @@ class InfoExtractor:
except (IndexError, AttributeError):
return None
@classproperty(cache=True)
def _BROKEN_ISSUE(cls):
return not cls._WORKING and ''
@classmethod
def working(cls):
"""Getter method for _WORKING."""
return cls._WORKING
return cls._BROKEN_ISSUE is False
@classmethod
def supports_login(cls):
@ -3629,7 +3633,12 @@ class InfoExtractor:
_COUNTS = ('', '5', '10', 'all')
desc += f' (e.g. "{cls.SEARCH_KEY}{random.choice(_COUNTS)}:{random.choice(search_examples)}")'
if not cls.working():
desc += ' (**Currently broken**)' if markdown else ' (Currently broken)'
msg = 'Currently broken'
if markdown:
msg = f'**{msg}**'
if cls._BROKEN_ISSUE:
msg = f'[{msg}]({cls._BROKEN_ISSUE})'
desc += f' ({msg})'
# Escape emojis. Ref: https://github.com/github/markup/issues/1153
name = (' - **%s**' % re.sub(r':(\w+:)', ':\u200B\\g<1>', cls.IE_NAME)) if markdown else cls.IE_NAME

View File

@ -21,6 +21,7 @@ from ..utils import (
class CrunchyrollBaseIE(InfoExtractor):
_BROKEN_ISSUE = 'https://github.com/yt-dlp/yt-dlp/issues/9453'
_BASE_URL = 'https://www.crunchyroll.com'
_API_BASE = 'https://api.crunchyroll.com'
_NETRC_MACHINE = 'crunchyroll'

View File

@ -9,6 +9,7 @@ from ..utils import (
class HiDiveIE(InfoExtractor):
_BROKEN_ISSUE = 'https://github.com/yt-dlp/yt-dlp/issues/9385'
_VALID_URL = r'https?://(?:www\.)?hidive\.com/stream/(?P<id>(?P<title>[^/]+)/(?P<key>[^/?#&]+))'
# Using X-Forwarded-For results in 403 HTTP error for HLS fragments,
# so disabling geo bypass completely