mirror of
https://github.com/ArchiveBox/ArchiveBox
synced 2024-11-23 04:33:11 +00:00
81 lines
2.9 KiB
Python
81 lines
2.9 KiB
Python
__package__ = 'abx'
|
|
|
|
import importlib
|
|
from pathlib import Path
|
|
from typing import Dict
|
|
|
|
from . import hookspec as base_spec
|
|
from .hookspec import hookimpl, hookspec # noqa
|
|
from .manager import pm, PluginManager # noqa
|
|
|
|
|
|
pm.add_hookspecs(base_spec)
|
|
|
|
|
|
###### PLUGIN DISCOVERY AND LOADING ########################################################
|
|
|
|
def register_hookspecs(hookspecs):
|
|
for hookspec_import_path in hookspecs:
|
|
hookspec_module = importlib.import_module(hookspec_import_path)
|
|
pm.add_hookspecs(hookspec_module)
|
|
|
|
|
|
def find_plugins_in_dir(plugins_dir: Path, prefix: str) -> Dict[str, Path]:
|
|
return {
|
|
f"{prefix}.{plugin_entrypoint.parent.name}": plugin_entrypoint.parent
|
|
for plugin_entrypoint in sorted(plugins_dir.glob("*/apps.py")) # key=get_plugin_order # Someday enforcing plugin import order may be required, but right now it's not needed
|
|
} # "plugins_pkg.pip": "/app/archivebox/plugins_pkg/pip"
|
|
|
|
|
|
def get_pip_installed_plugins(group='abx'):
|
|
"""replaces pm.load_setuptools_entrypoints("abx")"""
|
|
import importlib.metadata
|
|
|
|
DETECTED_PLUGINS = {} # module_name: module_dir_path
|
|
for dist in list(importlib.metadata.distributions()):
|
|
for entrypoint in dist.entry_points:
|
|
if entrypoint.group != group or pm.is_blocked(entrypoint.name):
|
|
continue
|
|
DETECTED_PLUGINS[entrypoint.name] = Path(entrypoint.load().__file__).parent
|
|
# pm.register(plugin, name=ep.name)
|
|
# pm._plugin_distinfo.append((plugin, DistFacade(dist)))
|
|
return DETECTED_PLUGINS
|
|
|
|
|
|
def get_plugins_in_dirs(plugin_dirs: Dict[str, Path]):
|
|
DETECTED_PLUGINS = {}
|
|
for plugin_prefix, plugin_dir in plugin_dirs.items():
|
|
DETECTED_PLUGINS.update(find_plugins_in_dir(plugin_dir, prefix=plugin_prefix))
|
|
return DETECTED_PLUGINS
|
|
|
|
|
|
# Load all plugins from pip packages, archivebox built-ins, and user plugins
|
|
|
|
def load_plugins(plugins_dict: Dict[str, Path]):
|
|
LOADED_PLUGINS = {}
|
|
for plugin_module, plugin_dir in plugins_dict.items():
|
|
# print(f'Loading plugin: {plugin_module} from {plugin_dir}')
|
|
plugin_module_loaded = importlib.import_module(plugin_module)
|
|
pm.register(plugin_module_loaded)
|
|
LOADED_PLUGINS[plugin_module] = plugin_module_loaded.PLUGIN
|
|
# print(f' √ Loaded plugin: {plugin_module}')
|
|
return LOADED_PLUGINS
|
|
|
|
def get_registered_plugins():
|
|
plugins = {}
|
|
plugin_to_distinfo = dict(pm.list_plugin_distinfo())
|
|
for plugin in pm.get_plugins():
|
|
plugin_info = {
|
|
"name": plugin.__name__,
|
|
"hooks": [h.name for h in pm.get_hookcallers(plugin) or ()],
|
|
}
|
|
distinfo = plugin_to_distinfo.get(plugin)
|
|
if distinfo:
|
|
plugin_info["version"] = distinfo.version
|
|
plugin_info["name"] = (
|
|
getattr(distinfo, "name", None) or distinfo.project_name
|
|
)
|
|
plugins[plugin_info["name"]] = plugin_info
|
|
return plugins
|
|
|
|
|