Inheritance diagram for searx.search.processors.online_url_search.OnlineUrlSearchProcessor:

Collaboration diagram for searx.search.processors.online_url_search.OnlineUrlSearchProcessor:

Public Member Functions
OnlineUrlSearchParams\|None	get_params (self, "SearchQuery" search_query, str engine_category)
Public Member Functions inherited from searx.search.processors.online.OnlineProcessor
bool	init_engine (self)
	init_network_in_thread (self, float start_time, float timeout_limit)
	search (self, str query, OnlineParams params, "ResultContainer" result_container, float start_time, float timeout_limit)
Public Member Functions inherited from searx.search.processors.abstract.EngineProcessor
	__init__ (self, "Engine\|types.ModuleType" engine)
	initialize (self, t.Callable[["EngineProcessor", bool], bool] callback)
	handle_exception (self, "ResultContainer" result_container, BaseException\|str exception_or_message, bool suspend=False)
	extend_container (self, "ResultContainer" result_container, float start_time, "list[Result \| LegacyResult]\|None" search_results)
bool	extend_container_if_suspended (self, "ResultContainer" result_container)
	get_tests (self)
	get_default_tests (self)

Additional Inherited Members
Public Attributes inherited from searx.search.processors.abstract.EngineProcessor
	engine = engine
logging.Logger	logger = engines[engine.name].logger
SuspendedStatus	suspended_status = SUSPENDED_STATUS.setdefault(key, SuspendedStatus())
Static Public Attributes inherited from searx.search.processors.online.OnlineProcessor
str	engine_type = "online"
Protected Member Functions inherited from searx.search.processors.online.OnlineProcessor
	_send_http_request (self, OnlineParams params)
"EngineResults\|None"	_search_basic (self, str query, OnlineParams params)
Protected Member Functions inherited from searx.search.processors.abstract.EngineProcessor
	_extend_container_basic (self, "ResultContainer" result_container, float start_time, "list[Result \| LegacyResult]" search_results)

Detailed Description

Processor class used by ``online_url_search`` engines.

Definition at line 32 of file online_url_search.py.

Member Function Documentation

◆ get_params()

OnlineUrlSearchParams \| None searx.search.processors.online_url_search.OnlineUrlSearchProcessor.get_params	(		self,
		"SearchQuery"	search_query,
		str	engine_category )

Returns a dictionary with the :ref:`request params <engine request
online_currency>` (:py:obj:`OnlineUrlSearchParams`).  ``None`` is
returned if the search query does not match :py:obj:`search_syntax`.

Reimplemented from searx.search.processors.online.OnlineProcessor.

Definition at line 37 of file online_url_search.py.

    def get_params(self, search_query: "SearchQuery", engine_category: str) -> OnlineUrlSearchParams | None:
        """Returns a dictionary with the :ref:`request params <engine request
        online_currency>` (:py:obj:`OnlineUrlSearchParams`).  ``None`` is
        returned if the search query does not match :py:obj:`search_syntax`."""
 
        online_params: OnlineParams | None = super().get_params(search_query, engine_category)
        if online_params is None:
            return None
 
        search_urls: dict[str, str | None] = {}
        has_match: bool = False
 
        for url_schema, url_re in search_syntax.items():
            search_urls[url_schema] = None
            m = url_re.search(search_query.query)
            if m:
                has_match = True
                search_urls[url_schema] = m[0]
 
        if not has_match:
            return None
 
        params: OnlineUrlSearchParams = {
            **online_params,
            "search_urls": search_urls,
        }
 
        return params

References get_params().

Referenced by get_params().

Here is the call graph for this function:

Here is the caller graph for this function:

The documentation for this class was generated from the following file:

/home/andrew/Documents/code/public/searxng/searx/search/processors/online_url_search.py

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ get_params()