Merge pull request #1569 from dalf/fix-pyright-reported-errors

Fix pyright errors

manage

@@ -698,7 +698,8 @@ test.pyright() {
         | grep -v '/engines/.*.py.* - warning: "logger" is not defined'\
         | grep -v '/plugins/.*.py.* - error: "logger" is not defined'\
         | grep -v '/engines/.*.py.* - warning: "supported_languages" is not defined' \
-        | grep -v '/engines/.*.py.* - warning: "language_aliases" is not defined'
+        | grep -v '/engines/.*.py.* - warning: "language_aliases" is not defined' \
+        | grep -v '/engines/.*.py.* - warning: "categories" is not defined'
     dump_return $?
 }
 

searx/compat.py

@@ -7,8 +7,11 @@
 # pylint: disable=C,R
 
 
+__all__ = ('cached_property',)
+
+
 try:
-    from functools import cached_property  # pylint: disable=unused-import
+    from functools import cached_property  # type: ignore
 
 except ImportError:
 

searx/engines/mongodb.py

@@ -5,7 +5,7 @@
 """
 
 import re
-from pymongo import MongoClient  # pylint: disable=import-error
+from pymongo import MongoClient  # pyright: ignore # pylint: disable=import-error
 
 engine_type = 'offline'
 

searx/engines/mysql_server.py

@@ -6,7 +6,7 @@
 
 # import error is ignored because the admin has to install mysql manually to use
 # the engine
-import mysql.connector  # pylint: disable=import-error
+import mysql.connector  # pyright: ignore # pylint: disable=import-error
 
 engine_type = 'offline'
 auth_plugin = 'caching_sha2_password'

searx/engines/postgresql.py

@@ -6,7 +6,7 @@
 
 # import error is ignored because the admin has to install mysql manually to use
 # the engine
-import psycopg2  # pylint: disable=import-error
+import psycopg2  # pyright: ignore # pylint: disable=import-error
 
 engine_type = 'offline'
 host = "127.0.0.1"

searx/search/__init__.py

@@ -2,11 +2,12 @@
 # lint: pylint
 # pylint: disable=missing-module-docstring, too-few-public-methods
 
-import typing
 import threading
 from timeit import default_timer
 from uuid import uuid4
 
+import flask
+
 from searx import settings
 from searx.answerers import ask
 from searx.external_bang import get_bang_url
@@ -181,7 +182,7 @@ class SearchWithPlugins(Search):
 
     __slots__ = 'ordered_plugin_list', 'request'
 
-    def __init__(self, search_query: SearchQuery, ordered_plugin_list, request: "flask.Request"):
+    def __init__(self, search_query: SearchQuery, ordered_plugin_list, request: flask.Request):
         super().__init__(search_query)
         self.ordered_plugin_list = ordered_plugin_list
         self.result_container.on_result = self._on_result

searx/search/checker/background.py

@@ -16,7 +16,7 @@ from searx import logger, settings, searx_debug
 from searx.exceptions import SearxSettingsException
 from searx.search.processors import PROCESSORS
 from searx.search.checker import Checker
-from searx.shared import schedule, storage
+from searx.shared import schedule, storage  # pyright: ignore
 
 
 CHECKER_RESULT = 'CHECKER_RESULT'

searx/shared/__init__.py

@@ -1,11 +1,14 @@
 # SPDX-License-Identifier: AGPL-3.0-or-later
 
 import logging
+import importlib
 
 logger = logging.getLogger('searx.shared')
 
+__all__ = ['SharedDict', 'schedule']
+
 try:
-    import uwsgi
+    uwsgi = importlib.import_module('uwsgi')
 except:
     # no uwsgi
     from .shared_simple import SimpleSharedDict as SharedDict, schedule

searx/shared/shared_uwsgi.py

@@ -2,7 +2,7 @@
 
 import time
 from typing import Optional
-import uwsgi  # pylint: disable=E0401
+import uwsgi  # pyright: ignore # pylint: disable=E0401
 from . import shared_abstract
 
 

searx/utils.py

@@ -66,7 +66,7 @@ def searx_useragent() -> str:
     ).strip()
 
 
-def gen_useragent(os_string: str = None) -> str:
+def gen_useragent(os_string: Optional[str] = None) -> str:
     """Return a random browser User Agent
 
     See searx/data/useragents.json
@@ -570,7 +570,7 @@ def eval_xpath(element: ElementBase, xpath_spec: XPathSpecType):
         raise SearxEngineXPathException(xpath_spec, arg) from e
 
 
-def eval_xpath_list(element: ElementBase, xpath_spec: XPathSpecType, min_len: int = None):
+def eval_xpath_list(element: ElementBase, xpath_spec: XPathSpecType, min_len: Optional[int] = None):
     """Same as eval_xpath, check if the result is a list
 
     Args:

searx/version.py

@@ -6,6 +6,7 @@ import os
 import shlex
 import subprocess
 import logging
+import importlib
 
 # fallback values
 # if there is searx.version_frozen module, and it is not possible to get the git tag
@@ -73,7 +74,8 @@ def get_git_version():
 
 
 try:
-    from searx.version_frozen import VERSION_STRING, VERSION_TAG, GIT_URL, GIT_BRANCH
+    vf = importlib.import_module('searx.version_frozen')
+    VERSION_STRING, VERSION_TAG, GIT_URL, GIT_BRANCH = vf.VERSION_STRING, vf.VERSION_TAG, vf.GIT_URL, vf.GIT_BRANCH
 except ImportError:
     try:
         try:

searx/webapp.py

@@ -1303,7 +1303,7 @@ def opensearch():
 def favicon():
     theme = request.preferences.get_value("theme")
     return send_from_directory(
-        os.path.join(app.root_path, settings['ui']['static_path'], 'themes', theme, 'img'),
+        os.path.join(app.root_path, settings['ui']['static_path'], 'themes', theme, 'img'),  # pyright: ignore
         'favicon.png',
         mimetype='image/vnd.microsoft.icon',
     )