summaryrefslogtreecommitdiff
path: root/searx/webutils.py
diff options
context:
space:
mode:
authorMarkus Heiser <markus.heiser@darmarit.de>2025-08-22 17:17:51 +0200
committerMarkus Heiser <markus.heiser@darmarIT.de>2025-09-03 13:37:36 +0200
commit57b9673efb1b4fd18a3ac15e26da642201e2cd33 (patch)
tree79d3ecd365a1669a1109aa7e5dd3636bc1041d96 /searx/webutils.py
parent09500459feffa414dc7a0601bdb164464a8b0454 (diff)
[mod] addition of various type hints / tbc
- pyright configuration [1]_ - stub files: types-lxml [2]_ - addition of various type hints - enable use of new type system features on older Python versions [3]_ - ``.tool-versions`` - set python to lowest version we support (3.10.18) [4]_: Older versions typically lack some typing features found in newer Python versions. Therefore, for local type checking (before commit), it is necessary to use the older Python interpreter. .. [1] https://docs.basedpyright.com/v1.20.0/configuration/config-files/ .. [2] https://pypi.org/project/types-lxml/ .. [3] https://typing-extensions.readthedocs.io/en/latest/# .. [4] https://mise.jdx.dev/configuration.html#tool-versions Signed-off-by: Markus Heiser <markus.heiser@darmarit.de> Format: reST
Diffstat (limited to 'searx/webutils.py')
-rw-r--r--searx/webutils.py8
1 files changed, 4 insertions, 4 deletions
diff --git a/searx/webutils.py b/searx/webutils.py
index d32038482..8e5ac847c 100644
--- a/searx/webutils.py
+++ b/searx/webutils.py
@@ -67,7 +67,7 @@ exception_classname_to_text = {
}
-def get_translated_errors(unresponsive_engines: Iterable[UnresponsiveEngine]):
+def get_translated_errors(unresponsive_engines: "Iterable[UnresponsiveEngine]"):
translated_errors = []
for unresponsive_engine in unresponsive_engines:
@@ -110,7 +110,7 @@ class CSVWriter:
self.writerow(row)
-def write_csv_response(csv: CSVWriter, rc: ResultContainer) -> None: # pylint: disable=redefined-outer-name
+def write_csv_response(csv: CSVWriter, rc: "ResultContainer") -> None: # pylint: disable=redefined-outer-name
"""Write rows of the results to a query (``application/csv``) into a CSV
table (:py:obj:`CSVWriter`). First line in the table contain the column
names. The column "type" specifies the type, the following types are
@@ -157,7 +157,7 @@ class JSONEncoder(json.JSONEncoder): # pylint: disable=missing-class-docstring
return super().default(o)
-def get_json_response(sq: SearchQuery, rc: ResultContainer) -> str:
+def get_json_response(sq: "SearchQuery", rc: "ResultContainer") -> str:
"""Returns the JSON string of the results to a query (``application/json``)"""
data = {
'query': sq.query,
@@ -311,7 +311,7 @@ def searxng_l10n_timespan(dt: datetime) -> str: # pylint: disable=invalid-name
NO_SUBGROUPING = 'without further subgrouping'
-def group_engines_in_tab(engines: Iterable[Engine]) -> List[Tuple[str, Iterable[Engine]]]:
+def group_engines_in_tab(engines: "Iterable[Engine]") -> List[Tuple[str, "Iterable[Engine]"]]:
"""Groups an Iterable of engines by their first non tab category (first subgroup)"""
def get_subgroup(eng):