searx Namespace Reference

Namespaces
namespace	answerers
namespace	autocomplete
namespace	babel_extract
namespace	botdetection
namespace	cache
namespace	compat
namespace	data
namespace	enginelib
namespace	engines
	::1337x
namespace	exceptions
namespace	extended_types
namespace	external_bang
namespace	external_urls
namespace	favicons
namespace	flaskfix
namespace	infopage
namespace	limiter
namespace	locales
namespace	metrics
namespace	network
namespace	openmetrics
namespace	plugins
namespace	preferences
namespace	query
namespace	result_types
namespace	results
namespace	search
namespace	settings_defaults
namespace	settings_loader
namespace	sqlitedb
namespace	sxng_locales
namespace	unixthreadname
namespace	utils
namespace	valkeydb
namespace	valkeylib
namespace	version
namespace	weather
namespace	webadapter
namespace	webapp
namespace	webutils
namespace	wikidata_units

Functions
	init_settings ()
t.Any	get_setting (str name, t.Any default=_unset)
	_is_color_terminal ()
	_logging_config_debug ()

Variables
str	LOG_FORMAT_DEBUG = '%(levelname)-7s %(name)-30.30s: %(message)s'
str	LOG_FORMAT_PROD = '%(asctime)-15s %(levelname)s:%(name)s: %(message)s'
	LOG_LEVEL_PROD = logging.WARNING
str	searx_dir = abspath(dirname(__file__))
str	searx_parent_dir = abspath(dirname(dirname(__file__)))
dict	settings = {}
bool	sxng_debug = False
	logger = logging.getLogger('searx')
	_unset = object()

Function Documentation

_is_color_terminal()

searx._is_color_terminal ( )

protected

Definition at line 95 of file __init__.py.

def _is_color_terminal():
    if os.getenv('TERM') in ('dumb', 'unknown'):
        return False
    return sys.stdout.isatty()
 
 

Referenced by _logging_config_debug().

Here is the caller graph for this function:

_logging_config_debug()

searx._logging_config_debug ( )

protected

Definition at line 101 of file __init__.py.

def _logging_config_debug():
    try:
        import coloredlogs  # pylint: disable=import-outside-toplevel
    except ImportError:
        coloredlogs = None
 
    log_level = os.environ.get('SEARXNG_DEBUG_LOG_LEVEL', 'DEBUG')
    if coloredlogs and _is_color_terminal():
        level_styles = {
            'spam': {'color': 'green', 'faint': True},
            'debug': {},
            'notice': {'color': 'magenta'},
            'success': {'bold': True, 'color': 'green'},
            'info': {'bold': True, 'color': 'cyan'},
            'warning': {'color': 'yellow'},
            'error': {'color': 'red'},
            'critical': {'bold': True, 'color': 'red'},
        }
        field_styles = {
            'asctime': {'color': 'green'},
            'hostname': {'color': 'magenta'},
            'levelname': {'color': 8},
            'name': {'color': 8},
            'programname': {'color': 'cyan'},
            'username': {'color': 'yellow'},
        }
        coloredlogs.install(  # type: ignore
            level=log_level,
            level_styles=level_styles,
            field_styles=field_styles,
            fmt=LOG_FORMAT_DEBUG,
        )
    else:
        logging.basicConfig(level=getattr(logging, log_level, "ERROR"), format=LOG_FORMAT_DEBUG)
 
 

References _is_color_terminal(), and init_settings().

Referenced by init_settings().

Here is the call graph for this function:

Here is the caller graph for this function:

get_setting()

t.Any searx.get_setting	(	str	name,
		t.Any	default = _unset )

Returns the value to which ``name`` point.  If there is no such name in the
settings and the ``default`` is unset, a :py:obj:`KeyError` is raised.

Definition at line 74 of file __init__.py.

def get_setting(name: str, default: t.Any = _unset) -> t.Any:
    """Returns the value to which ``name`` point.  If there is no such name in the
    settings and the ``default`` is unset, a :py:obj:`KeyError` is raised.
 
    """
    value: dict[str, t.Any] = settings
    for a in name.split('.'):
        if isinstance(value, dict):
            value = value.get(a, _unset)
        else:
            value = _unset  # type: ignore
 
        if value is _unset:
            if default is _unset:
                raise KeyError(name)
            value = default  # type: ignore
            break
 
    return value
 
 

Referenced by searx.favicons.proxy._initial_resolver_map(), searx.webapp.config(), searx.webapp.get_client_settings(), searx.plugins.oa_doi_rewrite.get_doi_resolver(), searx.webutils.get_static_file_list(), searx.webutils.group_engines_in_tab(), searx.plugins.ahmia_filter.SXNGPlugin.init(), searx.webapp.init(), init_settings(), searx.plugins.initialize(), searx.valkeydb.initialize(), searx.favicons.is_active(), searx.webapp.preferences(), searx.network.raise_for_httperror.raise_for_cloudflare_captcha(), searx.network.raise_for_httperror.raise_for_recaptcha(), searx.webapp.render(), searx.webapp.run(), and searx.valkeylib.secret_hash().

Here is the caller graph for this function:

init_settings()

searx.init_settings

(

)

Initialize global ``settings`` and ``sxng_debug`` variables and
``logger`` from ``SEARXNG_SETTINGS_PATH``.

Definition at line 32 of file __init__.py.

def init_settings():
    """Initialize global ``settings`` and ``sxng_debug`` variables and
    ``logger`` from ``SEARXNG_SETTINGS_PATH``.
    """
 
    # pylint: disable=import-outside-toplevel
    from searx import settings_loader
    from searx.settings_defaults import SCHEMA, apply_schema
 
    global settings, sxng_debug  # pylint: disable=global-variable-not-assigned
 
    cfg, msg = settings_loader.load_settings(load_user_settings=True)
    cfg = cfg or {}
    apply_schema(cfg, SCHEMA, [])
 
    settings.clear()
    settings.update(cfg)
 
    sxng_debug = get_setting("general.debug")
    if sxng_debug:
        _logging_config_debug()
    else:
        logging.basicConfig(level=LOG_LEVEL_PROD, format=LOG_FORMAT_PROD)
        logging.root.setLevel(level=LOG_LEVEL_PROD)
        logging.getLogger('werkzeug').setLevel(level=LOG_LEVEL_PROD)
        logger.info(msg)
 
    # log max_request_timeout
    max_request_timeout: int | None = settings['outgoing']['max_request_timeout']
    if max_request_timeout is None:
        logger.info('max_request_timeout=%s', repr(max_request_timeout))
    else:
        logger.info('max_request_timeout=%i second(s)', max_request_timeout)
 
    if settings['server']['public_instance']:
        logger.warning(
            "Be aware you have activated features intended only for public instances. "
            "This force the usage of the limiter and link_token / "
            "see https://docs.searxng.org/admin/searx.limiter.html"
        )
 
 

References _logging_config_debug(), and get_setting().

Referenced by _logging_config_debug().

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

_unset

searx._unset = object()

protected

Definition at line 29 of file __init__.py.

LOG_FORMAT_DEBUG

str searx.LOG_FORMAT_DEBUG = '%(levelname)-7s %(name)-30.30s: %(message)s'

Definition at line 15 of file __init__.py.

LOG_FORMAT_PROD

str searx.LOG_FORMAT_PROD = '%(asctime)-15s %(levelname)s:%(name)s: %(message)s'

Definition at line 18 of file __init__.py.

LOG_LEVEL_PROD

searx.LOG_LEVEL_PROD = logging.WARNING

Definition at line 19 of file __init__.py.

logger

searx.logger = logging.getLogger('searx')

Definition at line 27 of file __init__.py.

searx_dir

str searx.searx_dir = abspath(dirname(__file__))

Definition at line 21 of file __init__.py.

searx_parent_dir

str searx.searx_parent_dir = abspath(dirname(dirname(__file__)))

Definition at line 22 of file __init__.py.

settings

dict searx.settings = {}

Definition at line 24 of file __init__.py.

sxng_debug

bool searx.sxng_debug = False

Definition at line 26 of file __init__.py.