Loading...
Searching...
No Matches
searx.plugins._core.Plugin Class Reference
Inheritance diagram for searx.plugins._core.Plugin: Collaboration diagram for searx.plugins._core.Plugin:Public Member Functions | |
| None | __init__ (self, PluginCfg plg_cfg) |
| int | __hash__ (self) |
| __eq__ (self, 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) |
| None|typing.Sequence[Result] | post_search (self, SXNG_Request request, "SearchWithPlugins" search) |
Static Public Attributes | |
| str | id = "" |
| typing | active .ClassVar[bool] |
| list | keywords = [] |
| logging | log .Logger |
| str | fqn = "" |
Detailed Description
Constructor & Destructor Documentation
◆ __init__()
| None searx.plugins._core.Plugin.__init__ | ( | self, | |
| PluginCfg | plg_cfg ) |
Definition at line 92 of file _core.py.
92 def __init__(self, plg_cfg: PluginCfg) -> None:
93 super().__init__()
94 if not self.fqn:
95 self.fqn = self.__class__.__mro__[0].__module__
96
97 # names from the configuration
98 for n, v in plg_cfg.__dict__.items():
99 setattr(self, n, v)
100
101 # names that must be set by the plugin implementation
102 for attr in [
103 "id",
104 ]:
105 if getattr(self, attr, None) is None:
106 raise NotImplementedError(f"plugin {self} is missing attribute {attr}")
107
108 if not ID_REGXP.match(self.id):
109 raise ValueError(f"plugin ID {self.id} contains invalid character (use lowercase ASCII)")
110
111 if not getattr(self, "log", None):
112 pkg_name = inspect.getmodule(self.__class__).__package__ # type: ignore
113 self.log = logging.getLogger(f"{pkg_name}.{self.id}")
114
References searx.favicons.cache.FaviconCacheStats.__class__, __init__(), fqn, id, and log.
Referenced by __init__().
Here is the call graph for this function: Here is the caller graph for this function:Member Function Documentation
◆ __eq__()
| searx.plugins._core.Plugin.__eq__ | ( | self, | |
| other ) |
◆ __hash__()
| int searx.plugins._core.Plugin.__hash__ | ( | self | ) |
The hash value is used in :py:obj:`set`, for example, when an object is added to the set. The hash value is also used in other contexts, e.g. when checking for equality to identify identical plugins from different sources (name collisions).
Definition at line 115 of file _core.py.
115 def __hash__(self) -> int:
116 """The hash value is used in :py:obj:`set`, for example, when an object
117 is added to the set. The hash value is also used in other contexts,
118 e.g. when checking for equality to identify identical plugins from
119 different sources (name collisions)."""
120
121 return id(self)
122
References id.
◆ init()
| bool searx.plugins._core.Plugin.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 methode always returns ``True``, the methode can be overwritten in the inheritances, - ``True`` plugin is active - ``False`` plugin is inactive
Reimplemented in searx.plugins.ahmia_filter.SXNGPlugin, and searx.plugins.hostnames.SXNGPlugin.
Definition at line 129 of file _core.py.
129 def init(self, app: "flask.Flask") -> bool: # pylint: disable=unused-argument
130 """Initialization of the plugin, the return value decides whether this
131 plugin is active or not. Initialization only takes place once, at the
132 time the WEB application is set up. The base methode always returns
133 ``True``, the methode can be overwritten in the inheritances,
134
135 - ``True`` plugin is active
136 - ``False`` plugin is inactive
137 """
138 return True
139
Referenced by searx.sqlitedb.SQLiteAppl.connect().
Here is the caller graph for this function:◆ on_result()
| bool searx.plugins._core.Plugin.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 in searx.plugins.ahmia_filter.SXNGPlugin, searx.plugins.hostnames.SXNGPlugin, searx.plugins.oa_doi_rewrite.SXNGPlugin, and searx.plugins.tracker_url_remover.SXNGPlugin.
Definition at line 149 of file _core.py.
149 def on_result(self, request: SXNG_Request, search: "SearchWithPlugins", result: Result) -> bool:
150 """Runs for each result of each engine and returns a boolean:
151
152 - ``True`` to keep the result
153 - ``False`` to remove the result from the result list
154
155 The ``result`` can be modified to the needs.
156
157 .. hint::
158
159 If :py:obj:`Result.url <searx.result_types._base.Result.url>` is modified,
160 :py:obj:`Result.parsed_url <searx.result_types._base.Result.parsed_url>` must
161 be changed accordingly:
162
163 .. code:: python
164
165 result["parsed_url"] = urlparse(result["url"])
166 """
167 return True
168
◆ post_search()
| None | typing.Sequence[Result] searx.plugins._core.Plugin.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 in searx.plugins.calculator.SXNGPlugin, searx.plugins.hash_plugin.SXNGPlugin, searx.plugins.self_info.SXNGPlugin, searx.plugins.tor_check.SXNGPlugin, and searx.plugins.unit_converter.SXNGPlugin.
Definition at line 169 of file _core.py.
169 def post_search(self, request: SXNG_Request, search: "SearchWithPlugins") -> None | typing.Sequence[Result]:
170 """Runs AFTER the search request. Can return a list of
171 :py:obj:`Result <searx.result_types._base.Result>` objects to be added to the
172 final result list."""
173 return
174
175
176@dataclass
◆ pre_search()
| bool searx.plugins._core.Plugin.pre_search | ( | self, | |
| SXNG_Request | request, | ||
| "SearchWithPlugins" | search ) |
Runs BEFORE the search request and returns a boolean: - ``True`` to continue the search - ``False`` to stop the search
Definition at line 141 of file _core.py.
141 def pre_search(self, request: SXNG_Request, search: "SearchWithPlugins") -> bool:
142 """Runs BEFORE the search request and returns a boolean:
143
144 - ``True`` to continue the search
145 - ``False`` to stop the search
146 """
147 return True
148
Member Data Documentation
◆ active
|
static |
◆ fqn
|
static |
Definition at line 90 of file _core.py.
Referenced by __init__().
◆ id
|
static |
Definition at line 71 of file _core.py.
Referenced by __hash__(), __init__(), searx.plugins.hostnames.SXNGPlugin._load_regular_expressions(), and searx.plugins.hostnames.SXNGPlugin.init().
◆ keywords
◆ log
|
static |
Definition at line 83 of file _core.py.
Referenced by __init__().
The documentation for this class was generated from the following file:
- /home/andrew/Documents/code/public/searxng/searx/plugins/_core.py
