searx.settings_defaults Namespace Reference

Classes
class	SettingsBytesValue
class	SettingsDirectoryValue
class	SettingSublistValue
class	SettingsValue

Functions
	apply_schema (dict[str, t.Any] settings, dict[str, t.Any] schema, list[str] path_list)

Variables
	searx_dir = abspath(dirname(__file__))
	logger = logging.getLogger('searx')
list	OUTPUT_FORMATS = ['html', 'csv', 'json', 'rss']
list	SXNG_LOCALE_TAGS = ['all', 'auto'] + list(l[0] for l in sxng_locales)
tuple	SIMPLE_STYLE = ('auto', 'light', 'dark', 'black')
dict	CATEGORIES_AS_TABS
dict	STR_TO_BOOL
	_UNDEFINED = object()
tuple	TypeDefinition
t	TypeDefinitionArg = type | TypeDefinition
dict	SCHEMA

Detailed Description

Implementation of the default settings.

Function Documentation

apply_schema()

searx.settings_defaults.apply_schema	(	dict[str, t.Any]	settings,
		dict[str, t.Any]	schema,
		list[str]	path_list )

Definition at line 140 of file settings_defaults.py.

def apply_schema(settings: dict[str, t.Any], schema: dict[str, t.Any], path_list: list[str]):
    error = False
    for key, value in schema.items():
        if isinstance(value, SettingsValue):
            try:
                settings[key] = value(settings.get(key, _UNDEFINED))
            except Exception as e:  # pylint: disable=broad-except
                # don't stop now: check other values
                logger.error('%s: %s', '.'.join([*path_list, key]), e)
                error = True
        elif isinstance(value, dict):
            error = error or apply_schema(settings.setdefault(key, {}), schema[key], [*path_list, key])
        else:
            settings.setdefault(key, value)
    if len(path_list) == 0 and error:
        raise ValueError('Invalid settings.yml')
    return error
 
 

References apply_schema().

Referenced by apply_schema().

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

_UNDEFINED

searx.settings_defaults._UNDEFINED = object()

protected

Definition at line 44 of file settings_defaults.py.

CATEGORIES_AS_TABS

dict searx.settings_defaults.CATEGORIES_AS_TABS

Initial value:

=  {
    'general': {},
    'images': {},
    'videos': {},
    'news': {},
    'map': {},
    'music': {},
    'it': {},
    'science': {},
    'files': {},
    'social media': {},
}

Definition at line 24 of file settings_defaults.py.

logger

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

Definition at line 20 of file settings_defaults.py.

OUTPUT_FORMATS

list searx.settings_defaults.OUTPUT_FORMATS = ['html', 'csv', 'json', 'rss']

Definition at line 21 of file settings_defaults.py.

SCHEMA

dict searx.settings_defaults.SCHEMA

Definition at line 159 of file settings_defaults.py.

searx_dir

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

Definition at line 18 of file settings_defaults.py.

SIMPLE_STYLE

tuple searx.settings_defaults.SIMPLE_STYLE = ('auto', 'light', 'dark', 'black')

Definition at line 23 of file settings_defaults.py.

STR_TO_BOOL

dict searx.settings_defaults.STR_TO_BOOL

Initial value:

=  {
    '0': False,
    'false': False,
    'off': False,
    '1': True,
    'true': True,
    'on': True,
}

Definition at line 36 of file settings_defaults.py.

SXNG_LOCALE_TAGS

list searx.settings_defaults.SXNG_LOCALE_TAGS = ['all', 'auto'] + list(l[0] for l in sxng_locales)

Definition at line 22 of file settings_defaults.py.

TypeDefinition

tuple searx.settings_defaults.TypeDefinition

Initial value:

=  (  # pylint: disable=invalid-name
    tuple[None, bool, type]
    | tuple[None, type, type]
    | tuple[None, type]
    | tuple[bool, type]
    | tuple[type, type]
    | tuple[type]
    | tuple[str | int, ...]
)

Definition at line 49 of file settings_defaults.py.

TypeDefinitionArg

t searx.settings_defaults.TypeDefinitionArg = type | TypeDefinition

Definition at line 59 of file settings_defaults.py.