Public Member Functions
	__init__ (self)
	__iter__ (self)
	__len__ (self)
list[PluginInfo]	info (self)
	load_settings (self, dict[str, dict[str, typing.Any]] cfg)
	register (self, Plugin plugin)
None	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)
None	post_search (self, SXNG_Request request, "SearchWithPlugins" search)

Static Public Attributes
set	plugin_list [Plugin]

Detailed Description

A storage for managing the *plugins* of SearXNG.

Definition at line 190 of file _core.py.

Constructor & Destructor Documentation

◆ init()

searx.plugins._core.PluginStorage.__init__ ( self )

Definition at line 196 of file _core.py.

    def __init__(self):
        self.plugin_list = set()
 

References plugin_list.

Member Function Documentation

◆ iter()

searx.plugins._core.PluginStorage.__iter__ ( self )

Definition at line 199 of file _core.py.

    def __iter__(self):
        yield from self.plugin_list
 

References plugin_list.

◆ len()

searx.plugins._core.PluginStorage.__len__ ( self )

Definition at line 202 of file _core.py.

    def __len__(self):
        return len(self.plugin_list)
 

References plugin_list.

◆ info()

list[PluginInfo] searx.plugins._core.PluginStorage.info ( self )

Definition at line 206 of file _core.py.

    def info(self) -> list[PluginInfo]:
 
        return [p.info for p in self.plugin_list]

References plugin_list.

◆ init()

None searx.plugins._core.PluginStorage.init	(		self,
		"flask.Flask"	app )

Calls the method :py:obj:`Plugin.init` of each plugin in this
storage.  Depending on its return value, the plugin is removed from
*this* storage or not.

Definition at line 242 of file _core.py.

    def init(self, app: "flask.Flask") -> None:
        """Calls the method :py:obj:`Plugin.init` of each plugin in this
        storage.  Depending on its return value, the plugin is removed from
        *this* storage or not."""
 
        for plg in self.plugin_list.copy():
            if not plg.init(app):
                self.plugin_list.remove(plg)
 

References plugin_list.

Referenced by searx.sqlitedb.SQLiteAppl.connect(), and searx.sqlitedb.SQLiteAppl.DB().

Here is the caller graph for this function:

◆ load_settings()

searx.plugins._core.PluginStorage.load_settings	(		self,
		dict[str, dict[str, typing.Any]]	cfg )

Load plugins configured in SearXNG's settings :ref:`settings
plugins`.

Definition at line 210 of file _core.py.

    def load_settings(self, cfg: dict[str, dict[str, typing.Any]]):
        """Load plugins configured in SearXNG's settings :ref:`settings
        plugins`."""
 
        for fqn, plg_settings in cfg.items():
            cls = None
            mod_name, cls_name = fqn.rsplit('.', 1)
            try:
                mod = importlib.import_module(mod_name)
                cls = getattr(mod, cls_name, None)
            except Exception as exc:  # pylint: disable=broad-exception-caught
                log.exception(exc)
 
            if cls is None:
                msg = f"plugin {fqn} is not implemented"
                raise ValueError(msg)
            plg = cls(PluginCfg(**plg_settings))
            self.register(plg)
 

References searx.answerers._core.AnswerStorage.register(), and register().

Here is the call graph for this function:

◆ on_result()

bool searx.plugins._core.PluginStorage.on_result	(		self,
		SXNG_Request	request,
		"SearchWithPlugins"	search,
		Result	result )

Definition at line 265 of file _core.py.

    def on_result(self, request: SXNG_Request, search: "SearchWithPlugins", result: Result) -> bool:
 
        ret = True
        for plugin in [p for p in self.plugin_list if p.id in search.user_plugins]:
            try:
                ret = bool(plugin.on_result(request=request, search=search, result=result))
            except Exception:  # pylint: disable=broad-except
                plugin.log.exception("Exception while calling on_result")
                continue
            if not ret:
                # ignore this result item on the first False from a plugin
                break
 
        return ret
 

References plugin_list.

◆ post_search()

None searx.plugins._core.PluginStorage.post_search	(		self,
		SXNG_Request	request,
		"SearchWithPlugins"	search )

Extend :py:obj:`search.result_container
<searx.results.ResultContainer`> with result items from plugins listed
in :py:obj:`search.user_plugins <SearchWithPlugins.user_plugins>`.

Definition at line 280 of file _core.py.

    def post_search(self, request: SXNG_Request, search: "SearchWithPlugins") -> None:
        """Extend :py:obj:`search.result_container
        <searx.results.ResultContainer`> with result items from plugins listed
        in :py:obj:`search.user_plugins <SearchWithPlugins.user_plugins>`.
        """
 
        keyword = None
        for keyword in search.search_query.query.split():
            if keyword:
                break
 
        for plugin in [p for p in self.plugin_list if p.id in search.user_plugins]:
 
            if plugin.keywords:
                # plugin with keywords: skip plugin if no keyword match
                if keyword and keyword not in plugin.keywords:
                    continue
            try:
                results = plugin.post_search(request=request, search=search) or []
            except Exception:  # pylint: disable=broad-except
                plugin.log.exception("Exception while calling post_search")
                continue
 
            # In case of *plugins* prefix ``plugin:`` is set, see searx.result_types.Result
            search.result_container.extend(f"plugin: {plugin.id}", results)

References plugin_list.

◆ pre_search()

bool searx.plugins._core.PluginStorage.pre_search	(		self,
		SXNG_Request	request,
		"SearchWithPlugins"	search )

Definition at line 251 of file _core.py.

    def pre_search(self, request: SXNG_Request, search: "SearchWithPlugins") -> bool:
 
        ret = True
        for plugin in [p for p in self.plugin_list if p.id in search.user_plugins]:
            try:
                ret = bool(plugin.pre_search(request=request, search=search))
            except Exception:  # pylint: disable=broad-except
                plugin.log.exception("Exception while calling pre_search")
                continue
            if not ret:
                # skip this search on the first False from a plugin
                break
        return ret
 

References plugin_list.

◆ register()

searx.plugins._core.PluginStorage.register	(		self,
		Plugin	plugin )

Register a :py:obj:`Plugin`.  In case of name collision (if two
plugins have same ID) a :py:obj:`KeyError` exception is raised.

Definition at line 229 of file _core.py.

    def register(self, plugin: Plugin):
        """Register a :py:obj:`Plugin`.  In case of name collision (if two
        plugins have same ID) a :py:obj:`KeyError` exception is raised.
        """
 
        if plugin in [p.id for p in self.plugin_list]:
            msg = f"name collision '{plugin.id}'"
            plugin.log.critical(msg)
            raise KeyError(msg)
 
        self.plugin_list.add(plugin)
        plugin.log.debug("plugin has been loaded")
 

References plugin_list.

Referenced by load_settings().

Here is the caller graph for this function:

Member Data Documentation

◆ plugin_list

searx.plugins._core.PluginStorage.plugin_list [Plugin]

static

Definition at line 193 of file _core.py.

Referenced by __init__(), __iter__(), __len__(), info(), init(), on_result(), post_search(), pre_search(), and register().

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

/home/andrew/Documents/code/public/searxng/searx/plugins/_core.py

Public Member Functions

Static Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ __iter__()

◆ __len__()

◆ info()

◆ init()

◆ load_settings()

◆ on_result()

◆ post_search()

◆ pre_search()

◆ register()

Member Data Documentation

◆ plugin_list

◆ init()

◆ iter()

◆ len()