searx.search.processors Namespace Reference

Namespaces
namespace	abstract
namespace	offline
namespace	online
namespace	online_currency
namespace	online_dictionary
namespace	online_url_search

Functions
type[EngineProcessor]|None	get_processor_class (str engine_type)
EngineProcessor|None	get_processor ("Engine | ModuleType" engine, str engine_name)
	initialize_processor (EngineProcessor processor)
	initialize (list[dict[str, t.Any]] engine_list)

Variables
list	__all__
	logger = logger.getChild('search.processors')
dict	PROCESSORS = {}

Detailed Description

Implement request processors used by engine-types.

Function Documentation

get_processor()

EngineProcessor | None searx.search.processors.get_processor	(	"Engine | ModuleType"	engine,
		str	engine_name )

Return processor instance that fits to ``engine.engine.type``

Definition at line 53 of file __init__.py.

def get_processor(engine: "Engine | ModuleType", engine_name: str) -> EngineProcessor | None:
    """Return processor instance that fits to ``engine.engine.type``"""
    engine_type = getattr(engine, 'engine_type', 'online')
    processor_class = get_processor_class(engine_type)
    if processor_class is not None:
        return processor_class(engine, engine_name)
    return None
 
 

References get_processor_class().

Referenced by initialize().

Here is the call graph for this function:

Here is the caller graph for this function:

get_processor_class()

type[EngineProcessor] | None searx.search.processors.get_processor_class

(

str

engine_type

)

Return processor class according to the ``engine_type``

Definition at line 39 of file __init__.py.

def get_processor_class(engine_type: str) -> type[EngineProcessor] | None:
    """Return processor class according to the ``engine_type``"""
    for c in [
        OnlineProcessor,
        OfflineProcessor,
        OnlineDictionaryProcessor,
        OnlineCurrencyProcessor,
        OnlineUrlSearchProcessor,
    ]:
        if c.engine_type == engine_type:
            return c
    return None
 
 

Referenced by get_processor().

Here is the caller graph for this function:

initialize()

searx.search.processors.initialize

(

list[dict[str, t.Any]]

engine_list

)

Initialize all engines and store a processor for each engine in
:py:obj:`PROCESSORS`.

Definition at line 72 of file __init__.py.

def initialize(engine_list: list[dict[str, t.Any]]):
    """Initialize all engines and store a processor for each engine in
    :py:obj:`PROCESSORS`."""
    for engine_data in engine_list:
        engine_name: str = engine_data['name']
        engine = engines.engines.get(engine_name)
        if engine:
            processor = get_processor(engine, engine_name)
            if processor is None:
                engine.logger.error('Error get processor for engine %s', engine_name)
            else:
                initialize_processor(processor)
                PROCESSORS[engine_name] = processor

References get_processor(), and initialize_processor().

Here is the call graph for this function:

initialize_processor()

searx.search.processors.initialize_processor

(

EngineProcessor

processor

)

Initialize one processor

Call the init function of the engine

Definition at line 62 of file __init__.py.

def initialize_processor(processor: EngineProcessor):
    """Initialize one processor
 
    Call the init function of the engine
    """
    if processor.has_initialize_function:
        _t = threading.Thread(target=processor.initialize, daemon=True)
        _t.start()
 
 

Referenced by initialize().

Here is the caller graph for this function:

Variable Documentation

__all__

list searx.search.processors.__all__

private

Initial value:

=  [
    'EngineProcessor',
    'OfflineProcessor',
    'OnlineProcessor',
    'OnlineDictionaryProcessor',
    'OnlineCurrencyProcessor',
    'OnlineUrlSearchProcessor',
    'PROCESSORS',
]

Definition at line 4 of file __init__.py.

logger

searx.search.processors.logger = logger.getChild('search.processors')

Definition at line 31 of file __init__.py.

PROCESSORS

dict searx.search.processors.PROCESSORS = {}

Definition at line 32 of file __init__.py.