mirror of
https://github.com/searxng/searxng
synced 2024-01-01 19:24:07 +01:00
86b4d2f2d0
We have been using a static type checker (pyright) for a long time, but its check was not yet a prerequisite for passing the quality gate. It was checked in the CI, but the error messages were only logged. As is always the case in life, with checks that you have to do but which have no consequences; you neglect them :-) We didn't activate the checks back then because we (even today) have too much monkey patching in our code (not only in the engines, httpx and others objects are also affected). We want to replace monkey patching with clear interfaces for a long time, the basis for this is increased typing and we can only achieve this if we make type checking an integral part of the quality gate. This PR activates the type check; in order to pass the check, a few typings were corrected in the code, but most type inconsistencies were deactivated via inline comments. This was particularly necessary in places where the code uses properties that stick to the objects (monkey patching). The sticking of properties only happens in a few places, but the access to these properties extends over the entire code, which is why there are many `# type: ignore` markers in the code ... which we will hopefully be able to remove again successively in the future. Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
104 lines
2.3 KiB
Python
104 lines
2.3 KiB
Python
# SPDX-License-Identifier: AGPL-3.0-or-later
|
|
"""Redis is an open source (BSD licensed), in-memory data structure (key value
|
|
based) store. Before configuring the ``redis_server`` engine, you must install
|
|
the dependency redis_.
|
|
|
|
Configuration
|
|
=============
|
|
|
|
Select a database to search in and set its index in the option ``db``. You can
|
|
either look for exact matches or use partial keywords to find what you are
|
|
looking for by configuring ``exact_match_only``.
|
|
|
|
Example
|
|
=======
|
|
|
|
Below is an example configuration:
|
|
|
|
.. code:: yaml
|
|
|
|
# Required dependency: redis
|
|
|
|
- name: myredis
|
|
shortcut : rds
|
|
engine: redis_server
|
|
exact_match_only: false
|
|
host: '127.0.0.1'
|
|
port: 6379
|
|
enable_http: true
|
|
password: ''
|
|
db: 0
|
|
|
|
Implementations
|
|
===============
|
|
|
|
"""
|
|
|
|
import redis # pylint: disable=import-error
|
|
|
|
engine_type = 'offline'
|
|
|
|
# redis connection variables
|
|
host = '127.0.0.1'
|
|
port = 6379
|
|
password = ''
|
|
db = 0
|
|
|
|
# engine specific variables
|
|
paging = False
|
|
result_template = 'key-value.html'
|
|
exact_match_only = True
|
|
|
|
_redis_client = None
|
|
|
|
|
|
def init(_engine_settings):
|
|
global _redis_client # pylint: disable=global-statement
|
|
_redis_client = redis.StrictRedis(
|
|
host=host,
|
|
port=port,
|
|
db=db,
|
|
password=password or None,
|
|
decode_responses=True,
|
|
)
|
|
|
|
|
|
def search(query, _params):
|
|
if not exact_match_only:
|
|
return search_keys(query)
|
|
|
|
ret = _redis_client.hgetall(query)
|
|
if ret:
|
|
ret['template'] = result_template # type: ignore
|
|
return [ret]
|
|
|
|
if ' ' in query:
|
|
qset, rest = query.split(' ', 1)
|
|
ret = []
|
|
for res in _redis_client.hscan_iter(qset, match='*{}*'.format(rest)):
|
|
ret.append(
|
|
{
|
|
res[0]: res[1],
|
|
'template': result_template,
|
|
}
|
|
)
|
|
return ret
|
|
return []
|
|
|
|
|
|
def search_keys(query):
|
|
ret = []
|
|
for key in _redis_client.scan_iter(match='*{}*'.format(query)):
|
|
key_type = _redis_client.type(key)
|
|
res = None
|
|
|
|
if key_type == 'hash':
|
|
res = _redis_client.hgetall(key)
|
|
elif key_type == 'list':
|
|
res = dict(enumerate(_redis_client.lrange(key, 0, -1)))
|
|
|
|
if res:
|
|
res['template'] = result_template # type: ignore
|
|
res['redis_key'] = key # type: ignore
|
|
ret.append(res)
|
|
return ret
|