mirror of
https://github.com/ocrmypdf/OCRmyPDF.git
synced 2026-05-08 06:36:20 -04:00
130 lines
3.8 KiB
Python
130 lines
3.8 KiB
Python
# SPDX-FileCopyrightText: 2022 James R. Barlow
|
|
# SPDX-License-Identifier: MPL-2.0
|
|
|
|
"""Plugin manager using pluggy."""
|
|
|
|
from __future__ import annotations
|
|
|
|
import argparse
|
|
import importlib
|
|
import importlib.util
|
|
import pkgutil
|
|
import sys
|
|
from collections.abc import Sequence
|
|
from pathlib import Path
|
|
|
|
import pluggy
|
|
|
|
import ocrmypdf.builtin_plugins
|
|
from ocrmypdf import pluginspec
|
|
from ocrmypdf.cli import get_parser, plugins_only_parser
|
|
|
|
|
|
class OcrmypdfPluginManager(pluggy.PluginManager):
|
|
"""pluggy.PluginManager that can fork.
|
|
|
|
Capable of reconstructing itself in child workers.
|
|
|
|
Arguments:
|
|
setup_func: callback that initializes the plugin manager with all
|
|
standard plugins
|
|
"""
|
|
|
|
def __init__(
|
|
self,
|
|
*args,
|
|
plugins: Sequence[str | Path],
|
|
builtins: bool = True,
|
|
**kwargs,
|
|
):
|
|
self.__init_args = args
|
|
self.__init_kwargs = kwargs
|
|
self.__plugins = plugins
|
|
self.__builtins = builtins
|
|
super().__init__(*args, **kwargs)
|
|
self.setup_plugins()
|
|
|
|
def __getstate__(self):
|
|
state = dict(
|
|
init_args=self.__init_args,
|
|
plugins=self.__plugins,
|
|
builtins=self.__builtins,
|
|
init_kwargs=self.__init_kwargs,
|
|
)
|
|
return state
|
|
|
|
def __setstate__(self, state):
|
|
self.__init__(
|
|
*state['init_args'],
|
|
plugins=state['plugins'],
|
|
builtins=state['builtins'],
|
|
**state['init_kwargs'],
|
|
)
|
|
|
|
def setup_plugins(self):
|
|
self.add_hookspecs(pluginspec)
|
|
|
|
# 1. Register builtins
|
|
if self.__builtins:
|
|
for module in sorted(
|
|
pkgutil.iter_modules(ocrmypdf.builtin_plugins.__path__)
|
|
):
|
|
name = f'ocrmypdf.builtin_plugins.{module.name}'
|
|
module = importlib.import_module(name)
|
|
self.register(module)
|
|
|
|
# 2. Install semfree if needed
|
|
try:
|
|
# pylint: disable=import-outside-toplevel
|
|
from multiprocessing.synchronize import SemLock
|
|
|
|
del SemLock
|
|
except ImportError:
|
|
self.register(importlib.import_module('ocrmypdf.extra_plugins.semfree'))
|
|
|
|
# 3. Register setuptools plugins
|
|
self.load_setuptools_entrypoints('ocrmypdf')
|
|
|
|
# 4. Register plugins specified on command line
|
|
for name in self.__plugins:
|
|
if isinstance(name, Path) or name.endswith('.py'):
|
|
# Import by filename
|
|
module_name = Path(name).stem
|
|
spec = importlib.util.spec_from_file_location(module_name, name)
|
|
module = importlib.util.module_from_spec(spec)
|
|
sys.modules[module_name] = module
|
|
spec.loader.exec_module(module)
|
|
else:
|
|
# Import by dotted module name
|
|
module = importlib.import_module(name)
|
|
self.register(module)
|
|
|
|
|
|
def get_plugin_manager(
|
|
plugins: Sequence[str | Path] | None = None, builtins=True
|
|
) -> OcrmypdfPluginManager:
|
|
return OcrmypdfPluginManager(
|
|
project_name='ocrmypdf',
|
|
plugins=plugins if plugins is not None else [],
|
|
builtins=builtins,
|
|
)
|
|
|
|
|
|
def get_parser_options_plugins(
|
|
args: Sequence[str],
|
|
) -> tuple[argparse.ArgumentParser, argparse.Namespace, pluggy.PluginManager]:
|
|
pre_options, _unused = plugins_only_parser.parse_known_args(args=args)
|
|
plugin_manager = get_plugin_manager(pre_options.plugins)
|
|
|
|
parser = get_parser()
|
|
plugin_manager.hook.initialize( # pylint: disable=no-member
|
|
plugin_manager=plugin_manager
|
|
)
|
|
plugin_manager.hook.add_options(parser=parser) # pylint: disable=no-member
|
|
|
|
options = parser.parse_args(args=args)
|
|
return parser, options, plugin_manager
|
|
|
|
|
|
__all__ = ['OcrmypdfPluginManager', 'get_plugin_manager', 'get_parser_options_plugins']
|