searx.plugins.hostnames.SXNGPlugin Class Reference

Inheritance diagram for searx.plugins.hostnames.SXNGPlugin:

Collaboration diagram for searx.plugins.hostnames.SXNGPlugin:

Public Member Functions
None	__init__ (self, "PluginCfg" plg_cfg)
bool	on_result (self, "SXNG_Request" request, "SearchWithPlugins" search, "Result" result)
bool	init (self, "flask.Flask" app)
Public Member Functions inherited from searx.plugins._core.Plugin
None	__init__ (self, "PluginCfg" plg_cfg)
int	__hash__ (self)
	__eq__ (self, typing.Any other)
bool	pre_search (self, SXNG_Request request, "SearchWithPlugins" search)
None|Sequence[Result]	post_search (self, SXNG_Request request, "SearchWithPlugins" search)

Public Attributes
	info

Protected Member Functions
dict[re.Pattern, str]|set|None	_load_regular_expressions (self, settings_key)

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

Rewrite hostnames, remove results or prioritize them.

Definition at line 110 of file hostnames.py.

Constructor & Destructor Documentation

__init__()

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

Definition at line 115 of file hostnames.py.

    def __init__(self, plg_cfg: "PluginCfg") -> None:
        super().__init__(plg_cfg)
        self.info = PluginInfo(
            id=self.id,
            name=gettext("Hostnames plugin"),
            description=gettext("Rewrite hostnames and remove or prioritize results based on the hostname"),
            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

_load_regular_expressions()

dict[re.Pattern, str] | set | None searx.plugins.hostnames.SXNGPlugin._load_regular_expressions ( self, settings_key )

protected

Definition at line 161 of file hostnames.py.

    def _load_regular_expressions(self, settings_key) -> dict[re.Pattern, str] | set | None:
        setting_value = settings.get(self.id, {}).get(settings_key)
 
        if not setting_value:
            return None
 
        # load external file with configuration
        if isinstance(setting_value, str):
            setting_value = get_yaml_cfg(setting_value)
 
        if isinstance(setting_value, list):
            return {re.compile(r) for r in setting_value}
 
        if isinstance(setting_value, dict):
            return {re.compile(p): r for (p, r) in setting_value.items()}
 
        return None
 
 

References searx.plugins._core.Plugin.id.

Referenced by init().

Here is the caller graph for this function:

init()

bool searx.plugins.hostnames.SXNGPlugin.init	(		self,
		"flask.Flask"	app )

Initialization of the plugin, the return value decides whether this
plugin is active or not.  Initialization only takes place once, at the
time the WEB application is set up.  The base method always returns
``True``, the method can be overwritten in the inheritances,

- ``True`` plugin is active
- ``False`` plugin is inactive

Reimplemented from searx.plugins._core.Plugin.

Definition at line 147 of file hostnames.py.

    def init(self, app: "flask.Flask") -> bool:  # pylint: disable=unused-argument
        global REPLACE, REMOVE, HIGH, LOW  # pylint: disable=global-statement
 
        if not settings.get(self.id):
            # Remove plugin, if there isn't a "hostnames:" setting
            return False
 
        REPLACE = self._load_regular_expressions("replace") or {}  # type: ignore
        REMOVE = self._load_regular_expressions("remove") or set()  # type: ignore
        HIGH = self._load_regular_expressions("high_priority") or set()  # type: ignore
        LOW = self._load_regular_expressions("low_priority") or set()  # type: ignore
 
        return True
 

References _load_regular_expressions(), and searx.plugins._core.Plugin.id.

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

Here is the call graph for this function:

Here is the caller graph for this function:

on_result()

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

Runs for each result of each engine and returns a boolean:

- ``True`` to keep the result
- ``False`` to remove the result from the result list

The ``result`` can be modified to the needs.

.. hint::

   If :py:obj:`Result.url <searx.result_types._base.Result.url>` is modified,
   :py:obj:`Result.parsed_url <searx.result_types._base.Result.parsed_url>` must
   be changed accordingly:

   .. code:: python

      result["parsed_url"] = urlparse(result["url"])

Reimplemented from searx.plugins._core.Plugin.

Definition at line 124 of file hostnames.py.

    def on_result(self, request: "SXNG_Request", search: "SearchWithPlugins", result: "Result") -> bool:
 
        for pattern in REMOVE:
            if result.parsed_url and pattern.search(result.parsed_url.netloc):
                # if the link (parsed_url) of the result match, then remove the
                # result from the result list, in any other case, the result
                # remains in the list / see final "return True" below.
                # log.debug("FIXME: remove [url/parsed_url] %s %s", pattern.pattern, result.url)
                return False
 
        result.filter_urls(filter_url_field)
 
        if isinstance(result, (MainResult, LegacyResult)):
            for pattern in LOW:
                if result.parsed_url and pattern.search(result.parsed_url.netloc):
                    result.priority = "low"
 
            for pattern in HIGH:
                if result.parsed_url and pattern.search(result.parsed_url.netloc):
                    result.priority = "high"
 
        return True
 

Member Data Documentation

info

searx.plugins.hostnames.SXNGPlugin.info

Initial value:

=  PluginInfo(
            id=self.id,
            name=gettext("Hostnames plugin"),
            description=gettext("Rewrite hostnames and remove or prioritize results based on the hostname"),
            preference_section="general",
        )

Definition at line 117 of file hostnames.py.

---

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

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