From 5c6542ce69b3ad7acb08ae26d371273f15c72413 Mon Sep 17 00:00:00 2001 From: pukkandan Date: Wed, 9 Jun 2021 20:01:56 +0530 Subject: [PATCH] [test] More rigorous tests for `prepare_filename` All tests of `prepare_outtmpl` is now also run on `prepare_filename` --- test/test_YoutubeDL.py | 176 +++++++++++++++++++++-------------------- 1 file changed, 92 insertions(+), 84 deletions(-) diff --git a/test/test_YoutubeDL.py b/test/test_YoutubeDL.py index 0e1ab3a4a..e6508b889 100644 --- a/test/test_YoutubeDL.py +++ b/test/test_YoutubeDL.py @@ -17,7 +17,7 @@ from yt_dlp.compat import compat_str, compat_urllib_error from yt_dlp.extractor import YoutubeIE from yt_dlp.extractor.common import InfoExtractor from yt_dlp.postprocessor.common import PostProcessor -from yt_dlp.utils import ExtractorError, float_or_none, match_filter_func +from yt_dlp.utils import ExtractorError, int_or_none, match_filter_func TEST_URL = 'http://localhost/sample.mp4' @@ -664,97 +664,105 @@ class TestYoutubeDL(unittest.TestCase): 'formats': [{'id': 'id1'}, {'id': 'id2'}, {'id': 'id3'}] } - def test_prepare_outtmpl(self): - def out(tmpl, **params): + def test_prepare_outtmpl_and_filename(self): + def test(tmpl, expected, **params): params['outtmpl'] = tmpl ydl = YoutubeDL(params) ydl._num_downloads = 1 - err = ydl.validate_outtmpl(tmpl) - if err: - raise err - outtmpl, tmpl_dict = ydl.prepare_outtmpl(tmpl, self.outtmpl_info) - return outtmpl % tmpl_dict - - self.assertEqual(out('%(id)s.%(ext)s'), '1234.mp4') - self.assertEqual(out('%(duration_string)s'), '27:46:40') - self.assertTrue(float_or_none(out('%(epoch)d'))) - self.assertEqual(out('%(resolution)s'), '1080p') - self.assertEqual(out('%(playlist_index)s'), '001') - self.assertEqual(out('%(autonumber)s'), '00001') - self.assertEqual(out('%(autonumber+2)03d', autonumber_start=3), '005') - self.assertEqual(out('%(autonumber)s', autonumber_size=3), '001') - - self.assertEqual(out('%%'), '%') - self.assertEqual(out('%%%%'), '%%') - self.assertEqual(out('%(invalid@tmpl|def)s', outtmpl_na_placeholder='none'), 'none') - self.assertEqual(out('%()s'), 'NA') - self.assertEqual(out('%s'), '%s') - self.assertEqual(out('%d'), '%d') - self.assertRaises(ValueError, out, '%') - self.assertRaises(ValueError, out, '%(title)') + self.assertEqual(ydl.validate_outtmpl(tmpl), None) + outtmpl, tmpl_dict = ydl.prepare_outtmpl(tmpl, self.outtmpl_info) + out = outtmpl % tmpl_dict + fname = ydl.prepare_filename(self.outtmpl_info) + + if callable(expected): + self.assertTrue(expected(out)) + self.assertTrue(expected(fname)) + elif isinstance(expected, compat_str): + self.assertEqual((out, fname), (expected, expected)) + else: + self.assertEqual((out, fname), expected) + + # Auto-generated fields + test('%(id)s.%(ext)s', '1234.mp4') + test('%(duration_string)s', ('27:46:40', '27-46-40')) + test('%(epoch)d', int_or_none) + test('%(resolution)s', '1080p') + test('%(playlist_index)s', '001') + test('%(autonumber)s', '00001') + test('%(autonumber+2)03d', '005', autonumber_start=3) + test('%(autonumber)s', '001', autonumber_size=3) + + # Escaping % + test('%%', '%') + test('%%%%', '%%') + test('%%(width)06d.%(ext)s', '%(width)06d.mp4') + test('%(width)06d.%(ext)s', 'NA.mp4') + test('%(width)06d.%%(ext)s', 'NA.%(ext)s') + test('%%(width)06d.%(ext)s', '%(width)06d.mp4') + + # Invalid templates + self.assertTrue(isinstance(YoutubeDL.validate_outtmpl('%'), ValueError)) + self.assertTrue(isinstance(YoutubeDL.validate_outtmpl('%(title)'), ValueError)) + test('%(invalid@tmpl|def)s', 'none', outtmpl_na_placeholder='none') + test('%()s', 'NA') + test('%s', '%s') + test('%d', '%d') + + # NA placeholder NA_TEST_OUTTMPL = '%(uploader_date)s-%(width)d-%(x|def)s-%(id)s.%(ext)s' - self.assertEqual(out(NA_TEST_OUTTMPL), 'NA-NA-def-1234.mp4') - self.assertEqual(out(NA_TEST_OUTTMPL, outtmpl_na_placeholder='none'), 'none-none-def-1234.mp4') - self.assertEqual(out(NA_TEST_OUTTMPL, outtmpl_na_placeholder=''), '--def-1234.mp4') + test(NA_TEST_OUTTMPL, 'NA-NA-def-1234.mp4') + test(NA_TEST_OUTTMPL, 'none-none-def-1234.mp4', outtmpl_na_placeholder='none') + test(NA_TEST_OUTTMPL, '--def-1234.mp4', outtmpl_na_placeholder='') + # String formatting FMT_TEST_OUTTMPL = '%%(height)%s.%%(ext)s' - self.assertEqual(out(FMT_TEST_OUTTMPL % 's'), '1080.mp4') - self.assertEqual(out(FMT_TEST_OUTTMPL % 'd'), '1080.mp4') - self.assertEqual(out(FMT_TEST_OUTTMPL % '6d'), ' 1080.mp4') - self.assertEqual(out(FMT_TEST_OUTTMPL % '-6d'), '1080 .mp4') - self.assertEqual(out(FMT_TEST_OUTTMPL % '06d'), '001080.mp4') - self.assertEqual(out(FMT_TEST_OUTTMPL % ' 06d'), ' 01080.mp4') - self.assertEqual(out(FMT_TEST_OUTTMPL % ' 06d'), ' 01080.mp4') - self.assertEqual(out(FMT_TEST_OUTTMPL % '0 6d'), ' 01080.mp4') - self.assertEqual(out(FMT_TEST_OUTTMPL % '0 6d'), ' 01080.mp4') - self.assertEqual(out(FMT_TEST_OUTTMPL % ' 0 6d'), ' 01080.mp4') - - self.assertEqual(out('%(id)d'), '1234') - self.assertEqual(out('%(height)c'), '1') - self.assertEqual(out('%(ext)c'), 'm') - self.assertEqual(out('%(id)d %(id)r'), "1234 '1234'") - self.assertEqual(out('%(ext)s-%(ext|def)d'), 'mp4-def') - self.assertEqual(out('%(width|0)04d'), '0000') - self.assertEqual(out('%(width|)d', outtmpl_na_placeholder='none'), '') - + test(FMT_TEST_OUTTMPL % 's', '1080.mp4') + test(FMT_TEST_OUTTMPL % 'd', '1080.mp4') + test(FMT_TEST_OUTTMPL % '6d', ' 1080.mp4') + test(FMT_TEST_OUTTMPL % '-6d', '1080 .mp4') + test(FMT_TEST_OUTTMPL % '06d', '001080.mp4') + test(FMT_TEST_OUTTMPL % ' 06d', ' 01080.mp4') + test(FMT_TEST_OUTTMPL % ' 06d', ' 01080.mp4') + test(FMT_TEST_OUTTMPL % '0 6d', ' 01080.mp4') + test(FMT_TEST_OUTTMPL % '0 6d', ' 01080.mp4') + test(FMT_TEST_OUTTMPL % ' 0 6d', ' 01080.mp4') + + # Type casting + test('%(id)d', '1234') + test('%(height)c', '1') + test('%(ext)c', 'm') + test('%(id)d %(id)r', "1234 '1234'") + test('%(id)r %(height)r', "'1234' 1080") + test('%(ext)s-%(ext|def)d', 'mp4-def') + test('%(width|0)04d', '0000') + test('a%(width|)d', 'a', outtmpl_na_placeholder='none') + + # Internal formatting FORMATS = self.outtmpl_info['formats'] - self.assertEqual(out('%(timestamp+-1000>%H-%M-%S)s'), '11-43-20') - self.assertEqual(out('%(id+1-height+3)05d'), '00158') - self.assertEqual(out('%(width+100)05d'), 'NA') - self.assertEqual(out('%(formats.0)s'), str(FORMATS[0])) - self.assertEqual(out('%(height.0)03d'), '001') - self.assertEqual(out('%(formats.-1.id)s'), str(FORMATS[-1]['id'])) - self.assertEqual(out('%(formats.3)s'), 'NA') - self.assertEqual(out('%(formats.:2:-1)r'), repr(FORMATS[:2:-1])) - self.assertEqual(out('%(formats.0.id.-1+id)f'), '1235.000000') - - def test_prepare_filename(self): - def fname(templ): - params = {'outtmpl': templ} - ydl = YoutubeDL(params) - return ydl.prepare_filename(self.outtmpl_info) - - self.assertEqual(fname('%(height)06d.%(ext)s'), '001080.mp4') - self.assertEqual(fname('%(foo|)s-%(bar|)s.%(ext)s'), '-.mp4') - # self.assertEqual(fname('%(foo|)s.%(ext)s'), '_.mp4') # fixme - # self.assertEqual(fname('%(foo|)s'), '_') # fixme - - self.assertEqual(fname('%%'), '%') - self.assertEqual(fname('%%%%'), '%%') - self.assertEqual(fname('%%(width)06d.%(ext)s'), '%(width)06d.mp4') - self.assertEqual(fname('%(width)06d.%(ext)s'), 'NA.mp4') - self.assertEqual(fname('%(width)06d.%%(ext)s'), 'NA.%(ext)s') - self.assertEqual(fname('%%(width)06d.%(ext)s'), '%(width)06d.mp4') - - self.assertEqual(fname('Hello %(title1)s'), 'Hello $PATH') - self.assertEqual(fname('Hello %(title2)s'), 'Hello %PATH%') - - self.assertEqual(fname('%(title3)s'), 'foo_bar_test') - self.assertEqual(fname('%(formats.0) 15s'), " {'id' - 'id1'}") - - self.assertEqual(fname('%(id)r %(height)r'), "'1234' 1080") - self.assertEqual(fname('%(formats.0)r'), "{'id' - 'id1'}") + test('%(timestamp-1000>%H-%M-%S)s', '11-43-20') + test('%(id+1-height+3)05d', '00158') + test('%(width+100)05d', 'NA') + test('%(formats.0) 15s', ('% 15s' % FORMATS[0], '% 15s' % str(FORMATS[0]).replace(':', ' -'))) + test('%(formats.0)r', (repr(FORMATS[0]), repr(FORMATS[0]).replace(':', ' -'))) + test('%(height.0)03d', '001') + test('%(-height.0)04d', '-001') + test('%(formats.-1.id)s', FORMATS[-1]['id']) + test('%(formats.0.id.-1)d', FORMATS[0]['id'][-1]) + test('%(formats.3)s', 'NA') + test('%(formats.:2:-1)r', repr(FORMATS[:2:-1])) + test('%(formats.0.id.-1+id)f', '1235.000000') + + # Empty filename + test('%(foo|)s-%(bar|)s.%(ext)s', '-.mp4') + # test('%(foo|)s.%(ext)s', ('.mp4', '_.mp4')) # fixme + # test('%(foo|)s', ('', '_')) # fixme + + # Path expansion and escaping + test('Hello %(title1)s', 'Hello $PATH') + test('Hello %(title2)s', 'Hello %PATH%') + test('%(title3)s', ('foo/bar\\test', 'foo_bar_test')) + test('folder/%(title3)s', ('folder/foo/bar\\test', 'folder%sfoo_bar_test' % os.path.sep)) def test_format_note(self): ydl = YoutubeDL()