Namespaces
namespace	answerers

namespace	autocomplete

namespace	babel_extract

namespace	botdetection

namespace	compat

namespace	data

namespace	enginelib

namespace	engines
	::1337x

namespace	exceptions

namespace	external_bang

namespace	external_urls

namespace	favicons

namespace	flaskfix

namespace	infopage

namespace	limiter

namespace	locales

namespace	metrics

namespace	network

namespace	plugins

namespace	preferences

namespace	query

namespace	redisdb

namespace	redislib

namespace	results

namespace	search

namespace	settings_defaults

namespace	settings_loader

namespace	sqlitedb

namespace	sxng_locales

namespace	unixthreadname

namespace	utils

namespace	version

namespace	webadapter

namespace	webapp

namespace	webutils

Functions
	get_setting (name, 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

	searx_dir = abspath(dirname(__file__))

	searx_parent_dir = abspath(dirname(dirname(__file__)))

	settings = settings_set_defaults(settings)

	settings_load_message

	_unset = object()

	searx_debug = settings['general']['debug']

	level

	format

	logger = logging.getLogger('searx')

	max_request_timeout = settings['outgoing']['max_request_timeout']

Function Documentation

◆ get_setting()

searx.get_setting	(		name,
			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 32 of file __init__.py.

def get_setting(name, 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.
 
    """
    value = settings
    for a in name.split('.'):
        if isinstance(value, dict):
            value = value.get(a, _unset)
        else:
            value = _unset
 
        if value is _unset:
            if default is _unset:
                raise KeyError(name)
            value = default
            break
 
    return value
 
 

◆ is_color_terminal()

searx.is_color_terminal ( )

Definition at line 53 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 ( )

Definition at line 59 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(level=log_level, level_styles=level_styles, field_styles=field_styles, fmt=LOG_FORMAT_DEBUG)
    else:
        logging.basicConfig(level=logging.getLevelName(log_level), format=LOG_FORMAT_DEBUG)
 
 

References is_color_terminal().

Here is the call graph for this function:

Variable Documentation

◆ _unset

searx._unset = object()

protected

Definition at line 29 of file __init__.py.

◆ format

searx.format

Definition at line 94 of file __init__.py.

◆ level

searx.level

Definition at line 94 of file __init__.py.

◆ LOG_FORMAT_DEBUG

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

Definition at line 16 of file __init__.py.

◆ LOG_FORMAT_PROD

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

Definition at line 19 of file __init__.py.

◆ LOG_LEVEL_PROD

searx.LOG_LEVEL_PROD = logging.WARNING

Definition at line 20 of file __init__.py.

◆ logger

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

Definition at line 97 of file __init__.py.

◆ max_request_timeout

searx.max_request_timeout = settings['outgoing']['max_request_timeout']

Definition at line 101 of file __init__.py.

◆ searx_debug

searx.searx_debug = settings['general']['debug']

Definition at line 90 of file __init__.py.

◆ searx_dir

searx.searx_dir = abspath(dirname(__file__))

Definition at line 22 of file __init__.py.

◆ searx_parent_dir

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

Definition at line 23 of file __init__.py.

◆ settings

searx.settings = settings_set_defaults(settings)

Definition at line 24 of file __init__.py.

◆ settings_load_message

searx.settings_load_message