searx.search.processors.online_currency.OnlineCurrencyProcessor Class Reference

Inheritance diagram for searx.search.processors.online_currency.OnlineCurrencyProcessor:

Collaboration diagram for searx.search.processors.online_currency.OnlineCurrencyProcessor:

Public Member Functions
	initialize (self, t.Callable[["EngineProcessor", bool], bool] callback)
OnlineCurrenciesParams|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)
	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_currency`` engines.

Definition at line 50 of file online_currency.py.

Member Function Documentation

get_params()

OnlineCurrenciesParams | None searx.search.processors.online_currency.OnlineCurrencyProcessor.get_params	(		self,
		"SearchQuery"	search_query,
		str	engine_category )

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

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

Definition at line 59 of file online_currency.py.

    def get_params(self, search_query: "SearchQuery", engine_category: str) -> OnlineCurrenciesParams | None:
        """Returns a dictionary with the :ref:`request params <engine request
        online_currency>` (:py:obj:`OnlineCurrenciesParams`).  ``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
        m = search_syntax.match(search_query.query)
        if not m:
            return None
 
        amount_str, from_currency, to_currency = m.groups()
        try:
            amount = float(amount_str)
        except ValueError:
            return None
 
        # most often $ stands for USD
        if from_currency == "$":
            from_currency = "$ us"
 
        if to_currency == "$":
            to_currency = "$ us"
 
        from_iso4217 = from_currency
        if not CURRENCIES.is_iso4217(from_iso4217):
            from_iso4217 = CURRENCIES.name_to_iso4217(_normalize_name(from_currency))
 
        to_iso4217 = to_currency
        if not CURRENCIES.is_iso4217(to_iso4217):
            to_iso4217 = CURRENCIES.name_to_iso4217(_normalize_name(to_currency))
 
        if from_iso4217 is None or to_iso4217 is None:
            return None
 
        ui_locale = flask_babel.get_locale() or babel.Locale.parse("en")
        from_name: str = CURRENCIES.iso4217_to_name(
            from_iso4217, ui_locale.language
        )  # pyright: ignore[reportAssignmentType]
        to_name: str = CURRENCIES.iso4217_to_name(
            to_iso4217, ui_locale.language
        )  # pyright: ignore[reportAssignmentType]
 
        params: OnlineCurrenciesParams = {
            **online_params,
            "amount": amount,
            "from_iso4217": from_iso4217,
            "to_iso4217": to_iso4217,
            "from_name": from_name,
            "to_name": to_name,
        }
 
        return params
 
 

References searx.search.processors.online_currency._normalize_name(), and get_params().

Referenced by get_params().

Here is the call graph for this function:

Here is the caller graph for this function:

initialize()

searx.search.processors.online_currency.OnlineCurrencyProcessor.initialize	(		self,
		t.Callable[["EngineProcessor", bool], bool]	callback )

Initialization of *this* :py:obj:`EngineProcessor`.

If processor's engine has an ``init`` method, it is called first.
Engine's ``init`` method is executed in a thread, meaning that the
*registration* (the ``callback``) may occur later and is not already
established by the return from this registration method.

Registration only takes place if the ``init`` method is not available or
is successfully run through.

Reimplemented from searx.search.processors.abstract.EngineProcessor.

Definition at line 55 of file online_currency.py.

    def initialize(self, callback: t.Callable[["EngineProcessor", bool], bool]):
        CURRENCIES.init()
        super().initialize(callback)
 

References initialize().

Referenced by initialize().

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_currency.py