searx.answerers._core.AnswerStorage Class Reference

Inheritance diagram for searx.answerers._core.AnswerStorage:

Collaboration diagram for searx.answerers._core.AnswerStorage:

Public Member Functions
	__init__ (self)
	load_builtins (self)
	register_by_fqn (self, str fqn)
	register (self, Answerer answerer)
list[BaseAnswer]	ask (self, str query)
list[AnswererInfo]	info (self)

Static Public Attributes
set	answerer_list [Answerer]

Detailed Description

A storage for managing the *answerers* of SearXNG.  With the
:py:obj:`AnswerStorage.ask`” method, a caller can ask questions to all
*answerers* and receives a list of the results.

Definition at line 88 of file _core.py.

Constructor & Destructor Documentation

__init__()

searx.answerers._core.AnswerStorage.__init__

(

self

)

Definition at line 96 of file _core.py.

    def __init__(self):
        super().__init__()
        self.answerer_list = set()
 

References __init__(), and answerer_list.

Referenced by __init__().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Function Documentation

ask()

list[BaseAnswer] searx.answerers._core.AnswerStorage.ask	(		self,
		str	query )

An answerer is identified via keywords, if there is a keyword at the
first position in the ``query`` for which there is one or more
answerers, then these are called, whereby the entire ``query`` is passed
as argument to the answerer function.

Definition at line 144 of file _core.py.

    def ask(self, query: str) -> list[BaseAnswer]:
        """An answerer is identified via keywords, if there is a keyword at the
        first position in the ``query`` for which there is one or more
        answerers, then these are called, whereby the entire ``query`` is passed
        as argument to the answerer function."""
 
        results = []
        keyword = None
        for keyword in query.split():
            if keyword:
                break
 
        if not keyword or keyword not in self:
            return results
 
        for answerer in self[keyword]:
            for answer in answerer.answer(query):
                # In case of *answers* prefix ``answerer:`` is set, see searx.result_types.Result
                answer.engine = f"answerer: {keyword}"
                results.append(answer)
 
        return results
 

info()

list[AnswererInfo] searx.answerers._core.AnswerStorage.info

(

self

)

Definition at line 168 of file _core.py.

    def info(self) -> list[AnswererInfo]:
        return [a.info() for a in self.answerer_list]

References answerer_list.

load_builtins()

searx.answerers._core.AnswerStorage.load_builtins

(

self

)

Loads ``answerer.py`` modules from the python packages in
:origin:`searx/answerers`.  The python modules are wrapped by
:py:obj:`ModuleAnswerer`.

Definition at line 100 of file _core.py.

    def load_builtins(self):
        """Loads ``answerer.py`` modules from the python packages in
        :origin:`searx/answerers`.  The python modules are wrapped by
        :py:obj:`ModuleAnswerer`."""
 
        for f in _default.iterdir():
            if f.name.startswith("_"):
                continue
 
            if f.is_file() and f.suffix == ".py":
                self.register_by_fqn(f"searx.answerers.{f.stem}.SXNGAnswerer")
                continue
 
            # for backward compatibility (if a fork has additional answerers)
 
            if f.is_dir() and (f / "answerer.py").exists():
                warnings.warn(
                    f"answerer module {f} is deprecated / migrate to searx.answerers.Answerer", DeprecationWarning
                )
                mod = load_module("answerer.py", str(f))
                self.register(ModuleAnswerer(mod))
 

References register(), and register_by_fqn().

Here is the call graph for this function:

register()

searx.answerers._core.AnswerStorage.register	(		self,
		Answerer	answerer )

Register a :py:obj:`Answerer`.

Definition at line 136 of file _core.py.

    def register(self, answerer: Answerer):
        """Register a :py:obj:`Answerer`."""
 
        self.answerer_list.add(answerer)
        for _kw in answerer.keywords:
            self[_kw] = self.get(_kw, [])
            self[_kw].append(answerer)
 

References answerer_list, searx.botdetection.config.Config.get(), searx.metrics.models.CounterStorage.get(), searx.metrics.models.HistogramStorage.get(), and searx.network.Request.get().

Referenced by load_builtins(), searx.plugins._core.PluginStorage.load_builtins(), register_by_fqn(), and searx.plugins._core.PluginStorage.register_by_fqn().

Here is the call graph for this function:

Here is the caller graph for this function:

register_by_fqn()

searx.answerers._core.AnswerStorage.register_by_fqn	(		self,
		str	fqn )

Register a :py:obj:`Answerer` via its fully qualified class namen(FQN).

Definition at line 122 of file _core.py.

    def register_by_fqn(self, fqn: str):
        """Register a :py:obj:`Answerer` via its fully qualified class namen(FQN)."""
 
        mod_name, _, obj_name = fqn.rpartition('.')
        mod = importlib.import_module(mod_name)
        code_obj = getattr(mod, obj_name, None)
 
        if code_obj is None:
            msg = f"answerer {fqn} is not implemented"
            log.critical(msg)
            raise ValueError(msg)
 
        self.register(code_obj())
 

References register().

Referenced by load_builtins(), and searx.plugins._core.PluginStorage.load_builtins().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

answerer_list

set searx.answerers._core.AnswerStorage.answerer_list [Answerer]

static

Definition at line 93 of file _core.py.

Referenced by __init__(), info(), and register().

---

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

• /home/andrew/Documents/code/public/searxng/searx/answerers/_core.py