zaclys/searxng
1
0
Fork 1
mirror of https://github.com/searxng/searxng synced 2024-01-01 19:24:07 +01:00
Code Issues Projects Releases Packages Wiki Activity

[enh] introduce Engine class

Browse source 
Previously engines were defined in modules, which where then
stapled with logger, supported_languages & language_aliases
via monkey patching in searx/engines/__init__.py.

Monkey patching is obviously a bad practice since it confuses
humans as well as static type checkers. But there were more problems:

* there were no type hints for the method input and output types

* the request method did not even make a clear distinction between input
  and output (abusing a single "params" dictionary for both)

This commit introduces a new class-based architecture for engines,
in a backwards-compatiable manner: allowing old-style module engines
to be used along witn new-style class-based engines.
This commit is contained in:
Martin Fischer 2022-01-28 10:38:37 +01:00
parent 73e71508e4
commit 5dd28ff04b
5 changed files with 147 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

17
searx/engines/__init__.py
View file

@ -20,6 +20,11 @@ from searx import logger, settings
from searx.data import ENGINES_LANGUAGES
from searx.network import get
from searx.utils import load_module, gen_useragent, find_language_aliases
from searx.engine import Engine
_NEXTGEN_ENGINES = {
}
"""maps module names to class names for engines that are implemented using the new class-based approach"""
logger = logger.getChild('engines')
@ -121,6 +126,11 @@ def load_engine(engine_data: dict) -> Optional[ConfiguredEngine]:
logger.exception('Cannot load engine "{}"'.format(engine_module))
return None
if engine_data['engine'] in _NEXTGEN_ENGINES:
engine = getattr(engine, _NEXTGEN_ENGINES[engine_data['engine']])(
logger=logger.getChild(engine_name),
)
update_engine_attributes(engine, engine_data)
set_language_attributes(engine)
update_attributes_for_tor(engine)
@ -204,10 +214,11 @@ def _get_supported_languages(engine: ConfiguredEngine) -> Collection[str]:
def set_language_attributes(engine: ConfiguredEngine):
engine.supported_languages = _get_supported_languages(engine)
if not isinstance(engine, Engine):
engine.supported_languages = _get_supported_languages(engine)
# find custom aliases for non standard language codes
engine.language_aliases.update(find_language_aliases(engine.supported_languages))
# find custom aliases for non standard language codes
engine.language_aliases.update(find_language_aliases(engine.supported_languages))
# language_support
engine.language_support = len(engine.supported_languages) > 0