mirror of
https://github.com/yt-dlp/yt-dlp
synced 2024-12-27 21:59:17 +01:00
may this help?
This commit is contained in:
coletdjnz
parent
51f3740030
commit
97088ae3d3
5 changed files with 150 additions and 149 deletions
|
|
@ -1,19 +1,15 @@
|
|||
import importlib
|
||||
import os
|
||||
import shutil
|
||||
import sys
|
||||
import unittest
|
||||
from pathlib import Path
|
||||
import yt_dlp._globals
|
||||
from yt_dlp.plugins import set_plugin_dirs, add_plugin_dirs, disable_plugins
|
||||
from yt_dlp.utils import YoutubeDLError
|
||||
|
||||
sys.path.insert(0, os.path.dirname(os.path.dirname(os.path.abspath(__file__))))
|
||||
TEST_DATA_DIR = Path(os.path.dirname(os.path.abspath(__file__)), 'testdata')
|
||||
sys.path.append(str(TEST_DATA_DIR))
|
||||
importlib.invalidate_caches()
|
||||
|
||||
from yt_dlp.plugins import PACKAGE_NAME, PluginSpec, directories, load_plugins, load_all_plugins, register_plugin_spec
|
||||
from yt_dlp.plugins import PACKAGE_NAME, PluginSpec, directories, load_plugins
|
||||
from yt_dlp._globals import extractors, postprocessors, plugin_dirs, plugin_ies, plugin_pps, all_plugins_loaded, plugin_specs, plugins_enabled
|
||||
|
||||
|
||||
|
|
@ -81,150 +77,150 @@ class TestPlugins(unittest.TestCase):
|
|||
self.assertNotIn('OverrideGenericIE', plugin_ies.value)
|
||||
self.assertNotIn('_UnderscoreOverrideGenericIE', plugins_ie.keys())
|
||||
self.assertNotIn('_UnderscoreOverrideGenericIE', plugin_ies.value)
|
||||
|
||||
def test_postprocessor_classes(self):
|
||||
plugins_pp = load_plugins(POSTPROCESSOR_PLUGIN_SPEC)
|
||||
self.assertIn('NormalPluginPP', plugins_pp.keys())
|
||||
self.assertIn(f'{PACKAGE_NAME}.postprocessor.normal', sys.modules.keys())
|
||||
self.assertIn('NormalPluginPP', plugin_pps.value)
|
||||
|
||||
def test_importing_zipped_module(self):
|
||||
zip_path = TEST_DATA_DIR / 'zipped_plugins.zip'
|
||||
shutil.make_archive(str(zip_path)[:-4], 'zip', str(zip_path)[:-4])
|
||||
sys.path.append(str(zip_path)) # add zip to search paths
|
||||
importlib.invalidate_caches() # reset the import caches
|
||||
|
||||
try:
|
||||
for plugin_type in ('extractor', 'postprocessor'):
|
||||
package = importlib.import_module(f'{PACKAGE_NAME}.{plugin_type}')
|
||||
self.assertIn(zip_path / PACKAGE_NAME / plugin_type, map(Path, package.__path__))
|
||||
|
||||
plugins_ie = load_plugins(EXTRACTOR_PLUGIN_SPEC)
|
||||
self.assertIn('ZippedPluginIE', plugins_ie.keys())
|
||||
|
||||
plugins_pp = load_plugins(POSTPROCESSOR_PLUGIN_SPEC)
|
||||
self.assertIn('ZippedPluginPP', plugins_pp.keys())
|
||||
|
||||
finally:
|
||||
sys.path.remove(str(zip_path))
|
||||
os.remove(zip_path)
|
||||
importlib.invalidate_caches() # reset the import caches
|
||||
|
||||
def test_reloading_plugins(self):
|
||||
reload_plugins_path = TEST_DATA_DIR / 'reload_plugins'
|
||||
load_plugins(EXTRACTOR_PLUGIN_SPEC)
|
||||
load_plugins(POSTPROCESSOR_PLUGIN_SPEC)
|
||||
|
||||
# Remove default folder and add reload_plugin path
|
||||
sys.path.remove(str(TEST_DATA_DIR))
|
||||
sys.path.append(str(reload_plugins_path))
|
||||
importlib.invalidate_caches()
|
||||
try:
|
||||
for plugin_type in ('extractor', 'postprocessor'):
|
||||
package = importlib.import_module(f'{PACKAGE_NAME}.{plugin_type}')
|
||||
self.assertIn(reload_plugins_path / PACKAGE_NAME / plugin_type, map(Path, package.__path__))
|
||||
|
||||
plugins_ie = load_plugins(EXTRACTOR_PLUGIN_SPEC)
|
||||
self.assertIn('NormalPluginIE', plugins_ie.keys())
|
||||
self.assertTrue(
|
||||
plugins_ie['NormalPluginIE'].REPLACED,
|
||||
msg='Reloading has not replaced original extractor plugin')
|
||||
self.assertTrue(
|
||||
extractors.value['NormalPluginIE'].REPLACED,
|
||||
msg='Reloading has not replaced original extractor plugin globally')
|
||||
|
||||
plugins_pp = load_plugins(POSTPROCESSOR_PLUGIN_SPEC)
|
||||
self.assertIn('NormalPluginPP', plugins_pp.keys())
|
||||
self.assertTrue(plugins_pp['NormalPluginPP'].REPLACED,
|
||||
msg='Reloading has not replaced original postprocessor plugin')
|
||||
self.assertTrue(
|
||||
postprocessors.value['NormalPluginPP'].REPLACED,
|
||||
msg='Reloading has not replaced original postprocessor plugin globally')
|
||||
|
||||
finally:
|
||||
sys.path.remove(str(reload_plugins_path))
|
||||
sys.path.append(str(TEST_DATA_DIR))
|
||||
importlib.invalidate_caches()
|
||||
|
||||
def test_extractor_override_plugin(self):
|
||||
load_plugins(EXTRACTOR_PLUGIN_SPEC)
|
||||
|
||||
from yt_dlp.extractor.generic import GenericIE
|
||||
|
||||
self.assertEqual(GenericIE.TEST_FIELD, 'override')
|
||||
self.assertEqual(GenericIE.SECONDARY_TEST_FIELD, 'underscore-override')
|
||||
|
||||
self.assertEqual(GenericIE.IE_NAME, 'generic+override+underscore-override')
|
||||
importlib.invalidate_caches()
|
||||
# test that loading a second time doesn't wrap a second time
|
||||
load_plugins(EXTRACTOR_PLUGIN_SPEC)
|
||||
from yt_dlp.extractor.generic import GenericIE
|
||||
self.assertEqual(GenericIE.IE_NAME, 'generic+override+underscore-override')
|
||||
|
||||
def test_load_all_plugin_types(self):
|
||||
|
||||
# no plugin specs registered
|
||||
load_all_plugins()
|
||||
|
||||
self.assertNotIn(f'{PACKAGE_NAME}.extractor.normal', sys.modules.keys())
|
||||
self.assertNotIn(f'{PACKAGE_NAME}.postprocessor.normal', sys.modules.keys())
|
||||
|
||||
register_plugin_spec(EXTRACTOR_PLUGIN_SPEC)
|
||||
register_plugin_spec(POSTPROCESSOR_PLUGIN_SPEC)
|
||||
load_all_plugins()
|
||||
self.assertTrue(yt_dlp._globals.all_plugins_loaded.value)
|
||||
|
||||
self.assertIn(f'{PACKAGE_NAME}.extractor.normal', sys.modules.keys())
|
||||
self.assertIn(f'{PACKAGE_NAME}.postprocessor.normal', sys.modules.keys())
|
||||
|
||||
def test_set_plugin_dirs(self):
|
||||
|
||||
custom_plugin_dir = str(TEST_DATA_DIR / 'plugin_packages')
|
||||
set_plugin_dirs(custom_plugin_dir)
|
||||
|
||||
self.assertEqual(plugin_dirs.value, [custom_plugin_dir])
|
||||
self.assertNotIn('external', plugin_dirs.value)
|
||||
load_plugins(EXTRACTOR_PLUGIN_SPEC)
|
||||
|
||||
self.assertIn(f'{PACKAGE_NAME}.extractor.package', sys.modules.keys())
|
||||
self.assertIn('PackagePluginIE', plugin_ies.value)
|
||||
|
||||
def test_add_plugin_dirs(self):
|
||||
custom_plugin_dir = str(TEST_DATA_DIR / 'plugin_packages')
|
||||
|
||||
self.assertEqual(plugin_dirs.value, ['external'])
|
||||
add_plugin_dirs(custom_plugin_dir)
|
||||
self.assertEqual(plugin_dirs.value, ['external', custom_plugin_dir])
|
||||
|
||||
load_plugins(EXTRACTOR_PLUGIN_SPEC)
|
||||
|
||||
self.assertIn(f'{PACKAGE_NAME}.extractor.package', sys.modules.keys())
|
||||
self.assertIn('PackagePluginIE', plugin_ies.value)
|
||||
|
||||
def test_disable_plugins(self):
|
||||
disable_plugins()
|
||||
ies = load_plugins(EXTRACTOR_PLUGIN_SPEC)
|
||||
self.assertEqual(ies, {})
|
||||
self.assertNotIn(f'{PACKAGE_NAME}.extractor.normal', sys.modules.keys())
|
||||
self.assertNotIn('NormalPluginIE', plugin_ies.value)
|
||||
|
||||
pps = load_plugins(POSTPROCESSOR_PLUGIN_SPEC)
|
||||
self.assertEqual(pps, {})
|
||||
self.assertNotIn(f'{PACKAGE_NAME}.postprocessor.normal', sys.modules.keys())
|
||||
self.assertNotIn('NormalPluginPP', plugin_pps.value)
|
||||
|
||||
def test_disable_plugins_already_loaded(self):
|
||||
register_plugin_spec(EXTRACTOR_PLUGIN_SPEC)
|
||||
register_plugin_spec(POSTPROCESSOR_PLUGIN_SPEC)
|
||||
load_all_plugins()
|
||||
|
||||
with self.assertRaises(YoutubeDLError):
|
||||
disable_plugins()
|
||||
|
||||
self.assertTrue(plugins_enabled.value)
|
||||
|
||||
ies = load_plugins(EXTRACTOR_PLUGIN_SPEC)
|
||||
self.assertIn('NormalPluginIE', ies)
|
||||
#
|
||||
# def test_postprocessor_classes(self):
|
||||
# plugins_pp = load_plugins(POSTPROCESSOR_PLUGIN_SPEC)
|
||||
# self.assertIn('NormalPluginPP', plugins_pp.keys())
|
||||
# self.assertIn(f'{PACKAGE_NAME}.postprocessor.normal', sys.modules.keys())
|
||||
# self.assertIn('NormalPluginPP', plugin_pps.value)
|
||||
#
|
||||
# def test_importing_zipped_module(self):
|
||||
# zip_path = TEST_DATA_DIR / 'zipped_plugins.zip'
|
||||
# shutil.make_archive(str(zip_path)[:-4], 'zip', str(zip_path)[:-4])
|
||||
# sys.path.append(str(zip_path)) # add zip to search paths
|
||||
# importlib.invalidate_caches() # reset the import caches
|
||||
#
|
||||
# try:
|
||||
# for plugin_type in ('extractor', 'postprocessor'):
|
||||
# package = importlib.import_module(f'{PACKAGE_NAME}.{plugin_type}')
|
||||
# self.assertIn(zip_path / PACKAGE_NAME / plugin_type, map(Path, package.__path__))
|
||||
#
|
||||
# plugins_ie = load_plugins(EXTRACTOR_PLUGIN_SPEC)
|
||||
# self.assertIn('ZippedPluginIE', plugins_ie.keys())
|
||||
#
|
||||
# plugins_pp = load_plugins(POSTPROCESSOR_PLUGIN_SPEC)
|
||||
# self.assertIn('ZippedPluginPP', plugins_pp.keys())
|
||||
#
|
||||
# finally:
|
||||
# sys.path.remove(str(zip_path))
|
||||
# os.remove(zip_path)
|
||||
# importlib.invalidate_caches() # reset the import caches
|
||||
#
|
||||
# def test_reloading_plugins(self):
|
||||
# reload_plugins_path = TEST_DATA_DIR / 'reload_plugins'
|
||||
# load_plugins(EXTRACTOR_PLUGIN_SPEC)
|
||||
# load_plugins(POSTPROCESSOR_PLUGIN_SPEC)
|
||||
#
|
||||
# # Remove default folder and add reload_plugin path
|
||||
# sys.path.remove(str(TEST_DATA_DIR))
|
||||
# sys.path.append(str(reload_plugins_path))
|
||||
# importlib.invalidate_caches()
|
||||
# try:
|
||||
# for plugin_type in ('extractor', 'postprocessor'):
|
||||
# package = importlib.import_module(f'{PACKAGE_NAME}.{plugin_type}')
|
||||
# self.assertIn(reload_plugins_path / PACKAGE_NAME / plugin_type, map(Path, package.__path__))
|
||||
#
|
||||
# plugins_ie = load_plugins(EXTRACTOR_PLUGIN_SPEC)
|
||||
# self.assertIn('NormalPluginIE', plugins_ie.keys())
|
||||
# self.assertTrue(
|
||||
# plugins_ie['NormalPluginIE'].REPLACED,
|
||||
# msg='Reloading has not replaced original extractor plugin')
|
||||
# self.assertTrue(
|
||||
# extractors.value['NormalPluginIE'].REPLACED,
|
||||
# msg='Reloading has not replaced original extractor plugin globally')
|
||||
#
|
||||
# plugins_pp = load_plugins(POSTPROCESSOR_PLUGIN_SPEC)
|
||||
# self.assertIn('NormalPluginPP', plugins_pp.keys())
|
||||
# self.assertTrue(plugins_pp['NormalPluginPP'].REPLACED,
|
||||
# msg='Reloading has not replaced original postprocessor plugin')
|
||||
# self.assertTrue(
|
||||
# postprocessors.value['NormalPluginPP'].REPLACED,
|
||||
# msg='Reloading has not replaced original postprocessor plugin globally')
|
||||
#
|
||||
# finally:
|
||||
# sys.path.remove(str(reload_plugins_path))
|
||||
# sys.path.append(str(TEST_DATA_DIR))
|
||||
# importlib.invalidate_caches()
|
||||
#
|
||||
# def test_extractor_override_plugin(self):
|
||||
# load_plugins(EXTRACTOR_PLUGIN_SPEC)
|
||||
#
|
||||
# from yt_dlp.extractor.generic import GenericIE
|
||||
#
|
||||
# self.assertEqual(GenericIE.TEST_FIELD, 'override')
|
||||
# self.assertEqual(GenericIE.SECONDARY_TEST_FIELD, 'underscore-override')
|
||||
#
|
||||
# self.assertEqual(GenericIE.IE_NAME, 'generic+override+underscore-override')
|
||||
# importlib.invalidate_caches()
|
||||
# # test that loading a second time doesn't wrap a second time
|
||||
# load_plugins(EXTRACTOR_PLUGIN_SPEC)
|
||||
# from yt_dlp.extractor.generic import GenericIE
|
||||
# self.assertEqual(GenericIE.IE_NAME, 'generic+override+underscore-override')
|
||||
#
|
||||
# def test_load_all_plugin_types(self):
|
||||
#
|
||||
# # no plugin specs registered
|
||||
# load_all_plugins()
|
||||
#
|
||||
# self.assertNotIn(f'{PACKAGE_NAME}.extractor.normal', sys.modules.keys())
|
||||
# self.assertNotIn(f'{PACKAGE_NAME}.postprocessor.normal', sys.modules.keys())
|
||||
#
|
||||
# register_plugin_spec(EXTRACTOR_PLUGIN_SPEC)
|
||||
# register_plugin_spec(POSTPROCESSOR_PLUGIN_SPEC)
|
||||
# load_all_plugins()
|
||||
# self.assertTrue(yt_dlp._globals.all_plugins_loaded.value)
|
||||
#
|
||||
# self.assertIn(f'{PACKAGE_NAME}.extractor.normal', sys.modules.keys())
|
||||
# self.assertIn(f'{PACKAGE_NAME}.postprocessor.normal', sys.modules.keys())
|
||||
#
|
||||
# def test_set_plugin_dirs(self):
|
||||
#
|
||||
# custom_plugin_dir = str(TEST_DATA_DIR / 'plugin_packages')
|
||||
# set_plugin_dirs(custom_plugin_dir)
|
||||
#
|
||||
# self.assertEqual(plugin_dirs.value, [custom_plugin_dir])
|
||||
# self.assertNotIn('external', plugin_dirs.value)
|
||||
# load_plugins(EXTRACTOR_PLUGIN_SPEC)
|
||||
#
|
||||
# self.assertIn(f'{PACKAGE_NAME}.extractor.package', sys.modules.keys())
|
||||
# self.assertIn('PackagePluginIE', plugin_ies.value)
|
||||
#
|
||||
# def test_add_plugin_dirs(self):
|
||||
# custom_plugin_dir = str(TEST_DATA_DIR / 'plugin_packages')
|
||||
#
|
||||
# self.assertEqual(plugin_dirs.value, ['external'])
|
||||
# add_plugin_dirs(custom_plugin_dir)
|
||||
# self.assertEqual(plugin_dirs.value, ['external', custom_plugin_dir])
|
||||
#
|
||||
# load_plugins(EXTRACTOR_PLUGIN_SPEC)
|
||||
#
|
||||
# self.assertIn(f'{PACKAGE_NAME}.extractor.package', sys.modules.keys())
|
||||
# self.assertIn('PackagePluginIE', plugin_ies.value)
|
||||
#
|
||||
# def test_disable_plugins(self):
|
||||
# disable_plugins()
|
||||
# ies = load_plugins(EXTRACTOR_PLUGIN_SPEC)
|
||||
# self.assertEqual(ies, {})
|
||||
# self.assertNotIn(f'{PACKAGE_NAME}.extractor.normal', sys.modules.keys())
|
||||
# self.assertNotIn('NormalPluginIE', plugin_ies.value)
|
||||
#
|
||||
# pps = load_plugins(POSTPROCESSOR_PLUGIN_SPEC)
|
||||
# self.assertEqual(pps, {})
|
||||
# self.assertNotIn(f'{PACKAGE_NAME}.postprocessor.normal', sys.modules.keys())
|
||||
# self.assertNotIn('NormalPluginPP', plugin_pps.value)
|
||||
#
|
||||
# def test_disable_plugins_already_loaded(self):
|
||||
# register_plugin_spec(EXTRACTOR_PLUGIN_SPEC)
|
||||
# register_plugin_spec(POSTPROCESSOR_PLUGIN_SPEC)
|
||||
# load_all_plugins()
|
||||
#
|
||||
# with self.assertRaises(YoutubeDLError):
|
||||
# disable_plugins()
|
||||
#
|
||||
# self.assertTrue(plugins_enabled.value)
|
||||
#
|
||||
# ies = load_plugins(EXTRACTOR_PLUGIN_SPEC)
|
||||
# self.assertIn('NormalPluginIE', ies)
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
|
|
|
|||
|
|
@ -2,4 +2,5 @@ from yt_dlp.extractor.common import InfoExtractor
|
|||
|
||||
|
||||
class PackagePluginIE(InfoExtractor):
|
||||
_VALID_URL = 'package'
|
||||
pass
|
||||
|
|
|
|||
|
|
@ -2,6 +2,7 @@ from yt_dlp.extractor.common import InfoExtractor
|
|||
|
||||
|
||||
class NormalPluginIE(InfoExtractor):
|
||||
_VALID_URL = 'normal'
|
||||
REPLACED = True
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -6,6 +6,7 @@ class IgnoreNotInAllPluginIE(InfoExtractor):
|
|||
|
||||
|
||||
class InAllPluginIE(InfoExtractor):
|
||||
_VALID_URL = 'inallpluginie'
|
||||
pass
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -2,8 +2,10 @@ from yt_dlp.extractor.common import InfoExtractor
|
|||
|
||||
|
||||
class NormalPluginIE(InfoExtractor):
|
||||
_VALID_URL = 'normalpluginie'
|
||||
REPLACED = False
|
||||
|
||||
|
||||
class _IgnoreUnderscorePluginIE(InfoExtractor):
|
||||
_VALID_URL = 'ignoreunderscorepluginie'
|
||||
pass
|
||||
|
|
|
|||
Loading…
Reference in a new issue