summaryrefslogtreecommitdiff
path: root/searx/shared
diff options
context:
space:
mode:
Diffstat (limited to 'searx/shared')
-rw-r--r--searx/shared/redisdb.py41
1 files changed, 41 insertions, 0 deletions
diff --git a/searx/shared/redisdb.py b/searx/shared/redisdb.py
new file mode 100644
index 000000000..613b82a38
--- /dev/null
+++ b/searx/shared/redisdb.py
@@ -0,0 +1,41 @@
+# SPDX-License-Identifier: AGPL-3.0-or-later
+# lint: pylint
+"""Implementation of the redis client (redis-py_).
+
+.. _redis-py: https://github.com/redis/redis-py
+
+This implementation uses the :ref:`settings redis` setup from ``settings.yml``.
+A redis DB connect can be tested by::
+
+ >>> from searx.shared import redisdb
+ >>> redisdb.init()
+ True
+ >>> db = redisdb.client()
+ >>> db.set("foo", "bar")
+ True
+ >>> db.get("foo")
+ b'bar'
+ >>>
+
+"""
+
+import logging
+import redis
+from searx import get_setting
+
+logger = logging.getLogger('searx.shared.redis')
+
+
+def client():
+ return redis.Redis.from_url(get_setting('redis.url'))
+
+
+def init():
+ try:
+ c = client()
+ logger.info("connected redis DB --> %s", c.acl_whoami())
+ return True
+ except redis.exceptions.ConnectionError as exc:
+ logger.error("can't connet redis DB ...")
+ logger.error(" %s", exc)
+ return False