mirror of https://github.com/yt-dlp/yt-dlp
[cleanup] Deprecate various options (#13821)
Closes #14198, Closes #12909 Authored by: seproDevpull/5724/merge
sepro
5 days ago
committed by
GitHub
parent
98b6b0d339
commit
08d7899683
@ -1,77 +0,0 @@
|
|||||||
#!/usr/bin/env python3
|
|
||||||
|
|
||||||
# Allow direct execution
|
|
||||||
import os
|
|
||||||
import sys
|
|
||||||
import unittest
|
|
||||||
|
|
||||||
sys.path.insert(0, os.path.dirname(os.path.dirname(os.path.abspath(__file__))))
|
|
||||||
|
|
||||||
|
|
||||||
import xml.etree.ElementTree
|
|
||||||
|
|
||||||
import yt_dlp.extractor
|
|
||||||
import yt_dlp.YoutubeDL
|
|
||||||
from test.helper import get_params, is_download_test, try_rm
|
|
||||||
|
|
||||||
|
|
||||||
class YoutubeDL(yt_dlp.YoutubeDL):
|
|
||||||
def __init__(self, *args, **kwargs):
|
|
||||||
super().__init__(*args, **kwargs)
|
|
||||||
self.to_stderr = self.to_screen
|
|
||||||
|
|
||||||
|
|
||||||
params = get_params({
|
|
||||||
'writeannotations': True,
|
|
||||||
'skip_download': True,
|
|
||||||
'writeinfojson': False,
|
|
||||||
'format': 'flv',
|
|
||||||
})
|
|
||||||
|
|
||||||
|
|
||||||
TEST_ID = 'gr51aVj-mLg'
|
|
||||||
ANNOTATIONS_FILE = TEST_ID + '.annotations.xml'
|
|
||||||
EXPECTED_ANNOTATIONS = ['Speech bubble', 'Note', 'Title', 'Spotlight', 'Label']
|
|
||||||
|
|
||||||
|
|
||||||
@is_download_test
|
|
||||||
class TestAnnotations(unittest.TestCase):
|
|
||||||
def setUp(self):
|
|
||||||
# Clear old files
|
|
||||||
self.tearDown()
|
|
||||||
|
|
||||||
def test_info_json(self):
|
|
||||||
expected = list(EXPECTED_ANNOTATIONS) # Two annotations could have the same text.
|
|
||||||
ie = yt_dlp.extractor.YoutubeIE()
|
|
||||||
ydl = YoutubeDL(params)
|
|
||||||
ydl.add_info_extractor(ie)
|
|
||||||
ydl.download([TEST_ID])
|
|
||||||
self.assertTrue(os.path.exists(ANNOTATIONS_FILE))
|
|
||||||
annoxml = None
|
|
||||||
with open(ANNOTATIONS_FILE, encoding='utf-8') as annof:
|
|
||||||
annoxml = xml.etree.ElementTree.parse(annof)
|
|
||||||
self.assertTrue(annoxml is not None, 'Failed to parse annotations XML')
|
|
||||||
root = annoxml.getroot()
|
|
||||||
self.assertEqual(root.tag, 'document')
|
|
||||||
annotationsTag = root.find('annotations')
|
|
||||||
self.assertEqual(annotationsTag.tag, 'annotations')
|
|
||||||
annotations = annotationsTag.findall('annotation')
|
|
||||||
|
|
||||||
# Not all the annotations have TEXT children and the annotations are returned unsorted.
|
|
||||||
for a in annotations:
|
|
||||||
self.assertEqual(a.tag, 'annotation')
|
|
||||||
if a.get('type') == 'text':
|
|
||||||
textTag = a.find('TEXT')
|
|
||||||
text = textTag.text
|
|
||||||
self.assertTrue(text in expected) # assertIn only added in python 2.7
|
|
||||||
# remove the first occurrence, there could be more than one annotation with the same text
|
|
||||||
expected.remove(text)
|
|
||||||
# We should have seen (and removed) all the expected annotation texts.
|
|
||||||
self.assertEqual(len(expected), 0, 'Not all expected annotations were found.')
|
|
||||||
|
|
||||||
def tearDown(self):
|
|
||||||
try_rm(ANNOTATIONS_FILE)
|
|
||||||
|
|
||||||
|
|
||||||
if __name__ == '__main__':
|
|
||||||
unittest.main()
|
|
||||||
@ -1,97 +0,0 @@
|
|||||||
import os
|
|
||||||
import shlex
|
|
||||||
import subprocess
|
|
||||||
|
|
||||||
from .common import PostProcessor
|
|
||||||
from ..utils import (
|
|
||||||
Popen,
|
|
||||||
PostProcessingError,
|
|
||||||
check_executable,
|
|
||||||
cli_option,
|
|
||||||
encodeArgument,
|
|
||||||
prepend_extension,
|
|
||||||
shell_quote,
|
|
||||||
str_or_none,
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
# Deprecated in favor of the native implementation
|
|
||||||
class SponSkrubPP(PostProcessor):
|
|
||||||
_temp_ext = 'spons'
|
|
||||||
_exe_name = 'sponskrub'
|
|
||||||
|
|
||||||
def __init__(self, downloader, path='', args=None, ignoreerror=False, cut=False, force=False, _from_cli=False):
|
|
||||||
PostProcessor.__init__(self, downloader)
|
|
||||||
self.force = force
|
|
||||||
self.cutout = cut
|
|
||||||
self.args = str_or_none(args) or '' # For backward compatibility
|
|
||||||
self.path = self.get_exe(path)
|
|
||||||
|
|
||||||
if not _from_cli:
|
|
||||||
self.deprecation_warning(
|
|
||||||
'yt_dlp.postprocessor.SponSkrubPP support is deprecated and may be removed in a future version. '
|
|
||||||
'Use yt_dlp.postprocessor.SponsorBlock and yt_dlp.postprocessor.ModifyChaptersPP instead')
|
|
||||||
|
|
||||||
if not ignoreerror and self.path is None:
|
|
||||||
if path:
|
|
||||||
raise PostProcessingError(f'sponskrub not found in "{path}"')
|
|
||||||
else:
|
|
||||||
raise PostProcessingError('sponskrub not found. Please install or provide the path using --sponskrub-path')
|
|
||||||
|
|
||||||
def get_exe(self, path=''):
|
|
||||||
if not path or not check_executable(path, ['-h']):
|
|
||||||
path = os.path.join(path, self._exe_name)
|
|
||||||
if not check_executable(path, ['-h']):
|
|
||||||
return None
|
|
||||||
return path
|
|
||||||
|
|
||||||
@PostProcessor._restrict_to(images=False)
|
|
||||||
def run(self, information):
|
|
||||||
if self.path is None:
|
|
||||||
return [], information
|
|
||||||
|
|
||||||
filename = information['filepath']
|
|
||||||
if not os.path.exists(filename): # no download
|
|
||||||
return [], information
|
|
||||||
|
|
||||||
if information['extractor_key'].lower() != 'youtube':
|
|
||||||
self.to_screen('Skipping sponskrub since it is not a YouTube video')
|
|
||||||
return [], information
|
|
||||||
if self.cutout and not self.force and not information.get('__real_download', False):
|
|
||||||
self.report_warning(
|
|
||||||
'Skipping sponskrub since the video was already downloaded. '
|
|
||||||
'Use --sponskrub-force to run sponskrub anyway')
|
|
||||||
return [], information
|
|
||||||
|
|
||||||
self.to_screen('Trying to %s sponsor sections' % ('remove' if self.cutout else 'mark'))
|
|
||||||
if self.cutout:
|
|
||||||
self.report_warning('Cutting out sponsor segments will cause the subtitles to go out of sync.')
|
|
||||||
if not information.get('__real_download', False):
|
|
||||||
self.report_warning('If sponskrub is run multiple times, unintended parts of the video could be cut out.')
|
|
||||||
|
|
||||||
temp_filename = prepend_extension(filename, self._temp_ext)
|
|
||||||
if os.path.exists(temp_filename):
|
|
||||||
os.remove(temp_filename)
|
|
||||||
|
|
||||||
cmd = [self.path]
|
|
||||||
if not self.cutout:
|
|
||||||
cmd += ['-chapter']
|
|
||||||
cmd += cli_option(self._downloader.params, '-proxy', 'proxy')
|
|
||||||
cmd += shlex.split(self.args) # For backward compatibility
|
|
||||||
cmd += self._configuration_args(self._exe_name, use_compat=False)
|
|
||||||
cmd += ['--', information['id'], filename, temp_filename]
|
|
||||||
cmd = [encodeArgument(i) for i in cmd]
|
|
||||||
|
|
||||||
self.write_debug(f'sponskrub command line: {shell_quote(cmd)}')
|
|
||||||
stdout, _, returncode = Popen.run(cmd, text=True, stdout=None if self.get_param('verbose') else subprocess.PIPE)
|
|
||||||
|
|
||||||
if not returncode:
|
|
||||||
os.replace(temp_filename, filename)
|
|
||||||
self.to_screen('Sponsor sections have been %s' % ('removed' if self.cutout else 'marked'))
|
|
||||||
elif returncode == 3:
|
|
||||||
self.to_screen('No segments in the SponsorBlock database')
|
|
||||||
else:
|
|
||||||
raise PostProcessingError(
|
|
||||||
stdout.strip().splitlines()[0 if stdout.strip().lower().startswith('unrecognised') else -1]
|
|
||||||
or f'sponskrub failed with error code {returncode}')
|
|
||||||
return [], information
|
|
||||||
Loading…
Reference in New Issue