searx.plugins.unit_converter.SXNGPlugin Class Reference

Inheritance diagram for searx.plugins.unit_converter.SXNGPlugin:

Collaboration diagram for searx.plugins.unit_converter.SXNGPlugin:

Public Member Functions
None	__init__ (self, "PluginCfg" plg_cfg)
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

Convert between units.  The result is displayed in area for the
"answers".

Definition at line 36 of file unit_converter.py.

Constructor & Destructor Documentation

__init__()

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

Definition at line 43 of file unit_converter.py.

    def __init__(self, plg_cfg: "PluginCfg") -> None:
        super().__init__(plg_cfg)
 
        self.info = PluginInfo(
            id=self.id,
            name=gettext("Unit converter plugin"),
            description=gettext("Convert between units"),
            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.unit_converter.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 53 of file unit_converter.py.

    def post_search(self, request: "SXNG_Request", search: "SearchWithPlugins") -> EngineResults:
        results = EngineResults()
 
        # only convert between units on the first page
        if search.search_query.pageno > 1:
            return results
 
        query = search.search_query.query
        query_parts = query.split(" ")
 
        if len(query_parts) < 3:
            return results
 
        for query_part in query_parts:
            for keyword in CONVERT_KEYWORDS:
                if query_part == keyword:
                    from_query, to_query = query.split(keyword, 1)
                    target_val = _parse_text_and_convert(from_query.strip(), to_query.strip())
                    if target_val:
                        results.add(results.types.Answer(answer=target_val))
 
        return results
 
 
# inspired from https://stackoverflow.com/a/42475086

References searx.plugins.unit_converter._parse_text_and_convert().

Here is the call graph for this function:

Member Data Documentation

info

searx.plugins.unit_converter.SXNGPlugin.info

Initial value:

=  PluginInfo(
            id=self.id,
            name=gettext("Unit converter plugin"),
            description=gettext("Convert between units"),
            preference_section="general",
        )

Definition at line 46 of file unit_converter.py.

---

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

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