mirror of
https://github.com/searxng/searxng.git
synced 2025-09-10 20:28:25 +02:00
[mod] typification of SearXNG: add new result type KeyValue
This patch adds a new result type: KeyValue - Python class: searx/result_types/keyvalue.py - Jinja template: searx/templates/simple/result_templates/keyvalue.html - CSS (less) client/simple/src/less/result_types/keyvalue.less Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
This commit is contained in:
parent
8769b7c6d6
commit
af5dbdf768
8 changed files with 127 additions and 1 deletions
|
@ -13,7 +13,7 @@
|
|||
|
||||
from __future__ import annotations
|
||||
|
||||
__all__ = ["Result", "MainResult", "EngineResults", "AnswerSet", "Answer", "Translations"]
|
||||
__all__ = ["Result", "MainResult", "KeyValue", "EngineResults", "AnswerSet", "Answer", "Translations"]
|
||||
|
||||
import abc
|
||||
|
||||
|
@ -21,6 +21,7 @@ from searx import enginelib
|
|||
|
||||
from ._base import Result, MainResult, LegacyResult
|
||||
from .answer import AnswerSet, Answer, Translations
|
||||
from .keyvalue import KeyValue
|
||||
|
||||
|
||||
class ResultList(list, abc.ABC):
|
||||
|
@ -30,6 +31,7 @@ class ResultList(list, abc.ABC):
|
|||
"""The collection of result types (which have already been implemented)."""
|
||||
|
||||
Answer = Answer
|
||||
KeyValue = KeyValue
|
||||
MainResult = MainResult
|
||||
Result = Result
|
||||
Translations = Translations
|
||||
|
|
49
searx/result_types/keyvalue.py
Normal file
49
searx/result_types/keyvalue.py
Normal file
|
@ -0,0 +1,49 @@
|
|||
# SPDX-License-Identifier: AGPL-3.0-or-later
|
||||
"""
|
||||
Typification of the *keyvalue* results. Results of this type are rendered in
|
||||
the :origin:`keyvalue.html <searx/templates/simple/result_templates/keyvalue.html>`
|
||||
template.
|
||||
|
||||
----
|
||||
|
||||
.. autoclass:: KeyValue
|
||||
:members:
|
||||
:show-inheritance:
|
||||
|
||||
"""
|
||||
# pylint: disable=too-few-public-methods
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
__all__ = ["KeyValue"]
|
||||
|
||||
import typing
|
||||
from collections import OrderedDict
|
||||
|
||||
from ._base import MainResult
|
||||
|
||||
|
||||
class KeyValue(MainResult, kw_only=True):
|
||||
"""Simple table view which maps *key* names (first col) to *values*
|
||||
(second col)."""
|
||||
|
||||
template: str = "keyvalue.html"
|
||||
|
||||
kvmap: dict[str, typing.Any] | OrderedDict[str, typing.Any]
|
||||
"""Dictionary with keys and values. To sort keys, use :py:obj:`OrderedDict`."""
|
||||
|
||||
caption: str = ""
|
||||
"""Optional caption for this result."""
|
||||
|
||||
key_title: str = ""
|
||||
"""Optional title for the *key column*."""
|
||||
|
||||
value_title: str = ""
|
||||
"""Optional title for the *value column*."""
|
||||
|
||||
def __hash__(self) -> int:
|
||||
"""The KeyValues objects are checked for object identity, even if all
|
||||
fields of two results have the same values, they are different from each
|
||||
other.
|
||||
"""
|
||||
return id(self)
|
Loading…
Add table
Add a link
Reference in a new issue