searx.plugins.calculator.SXNGPlugin Class Reference

Inheritance diagram for searx.plugins.calculator.SXNGPlugin:

Collaboration diagram for searx.plugins.calculator.SXNGPlugin:

Public Member Functions
None	__init__ (self, "PluginCfg" plg_cfg)
	timeout_func (self, timeout, func, *args, **kwargs)
EngineResults	post_search (self, "SXNG_Request" request, "SearchWithPlugins" search)
Public Member Functions inherited from searx.plugins._core.Plugin
None	__init__ (self, "PluginCfg" plg_cfg)
int	__hash__ (self)
	__eq__ (self, typing.Any other)
bool	init (self, "flask.Flask" app)
bool	pre_search (self, SXNG_Request request, "SearchWithPlugins" search)
bool	on_result (self, SXNG_Request request, "SearchWithPlugins" search, Result result)

Public Attributes
	info

Additional Inherited Members
Static Public Attributes inherited from searx.plugins._core.Plugin
str	id = ""
typing	active .ClassVar[bool]
list	keywords = []
logging	log .Logger
str	fqn = ""

Detailed Description

Plugin converts strings to different hash digests.  The results are
displayed in area for the "answers".

Definition at line 25 of file calculator.py.

Constructor & Destructor Documentation

__init__()

None searx.plugins.calculator.SXNGPlugin.__init__	(		self,
		"PluginCfg"	plg_cfg )

Definition at line 32 of file calculator.py.

    def __init__(self, plg_cfg: "PluginCfg") -> None:
        super().__init__(plg_cfg)
 
        self.info = PluginInfo(
            id=self.id,
            name=gettext("Basic Calculator"),
            description=gettext("Calculate mathematical expressions via the search bar"),
            preference_section="general",
        )
 

References __init__().

Referenced by __init__().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Function Documentation

post_search()

EngineResults searx.plugins.calculator.SXNGPlugin.post_search	(		self,
		"SXNG_Request"	request,
		"SearchWithPlugins"	search )

Runs AFTER the search request.  Can return a list of
:py:obj:`Result <searx.result_types._base.Result>` objects to be added to the
final result list.

Reimplemented from searx.plugins._core.Plugin.

Definition at line 58 of file calculator.py.

    def post_search(self, request: "SXNG_Request", search: "SearchWithPlugins") -> EngineResults:
        results = EngineResults()
 
        # only show the result of the expression on the first page
        if search.search_query.pageno > 1:
            return results
 
        query = search.search_query.query
        # in order to avoid DoS attacks with long expressions, ignore long expressions
        if len(query) > 100:
            return results
 
        # replace commonly used math operators with their proper Python operator
        query = query.replace("x", "*").replace(":", "/")
 
        # Is this a term that can be calculated?
        word, constants = "", set()
        for x in query:
            # Alphabetic characters are defined as "Letters" in the Unicode
            # character database and are the constants in an equation.
            if x.isalpha():
                word += x.strip()
            elif word:
                constants.add(word)
                word = ""
 
        # In the term of an arithmetic operation there should be no other
        # alphabetic characters besides the constants
        if constants - set(math_constants):
            return results
 
        # use UI language
        ui_locale = babel.Locale.parse(request.preferences.get_value("locale"), sep="-")
 
        # parse the number system in a localized way
        def _decimal(match: re.Match) -> str:
            val = match.string[match.start() : match.end()]
            val = babel.numbers.parse_decimal(val, ui_locale, numbering_system="latn")
            return str(val)
 
        decimal = ui_locale.number_symbols["latn"]["decimal"]
        group = ui_locale.number_symbols["latn"]["group"]
        query = re.sub(f"[0-9]+[{decimal}|{group}][0-9]+[{decimal}|{group}]?[0-9]?", _decimal, query)
 
        # in python, powers are calculated via **
        query_py_formatted = query.replace("^", "**")
 
        # Prevent the runtime from being longer than 50 ms
        res = self.timeout_func(0.05, _eval_expr, query_py_formatted)
        if res is None or res[0] == "":
            return results
 
        res, is_boolean = res
        if is_boolean:
            res = "True" if res != 0 else "False"
        else:
            res = babel.numbers.format_decimal(res, locale=ui_locale)
        results.add(results.types.Answer(answer=f"{search.search_query.query} = {res}"))
 
        return results
 
 

References timeout_func().

Here is the call graph for this function:

timeout_func()

searx.plugins.calculator.SXNGPlugin.timeout_func	(		self,
			timeout,
			func,
		*	args,
		**	kwargs )

Definition at line 42 of file calculator.py.

    def timeout_func(self, timeout, func, *args, **kwargs):
        que = mp_fork.Queue()
        p = mp_fork.Process(target=handler, args=(que, func, args), kwargs=kwargs)
        p.start()
        p.join(timeout=timeout)
        ret_val = None
        # pylint: disable=used-before-assignment,undefined-variable
        if not p.is_alive():
            ret_val = que.get()
        else:
            self.log.debug("terminate function (%s: %s // %s) after timeout is exceeded", func.__name__, args, kwargs)
            p.terminate()
        p.join()
        p.close()
        return ret_val
 

References searx.plugins._core.Plugin.log.

Referenced by post_search().

Here is the caller graph for this function:

Member Data Documentation

info

searx.plugins.calculator.SXNGPlugin.info

Initial value:

=  PluginInfo(
            id=self.id,
            name=gettext("Basic Calculator"),
            description=gettext("Calculate mathematical expressions via the search bar"),
            preference_section="general",
        )

Definition at line 35 of file calculator.py.

---

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

• /home/andrew/Documents/code/public/searxng/searx/plugins/calculator.py