searx.settings_defaults.SettingsValue Class Reference

Inheritance diagram for searx.settings_defaults.SettingsValue:

Public Member Functions
	__init__ (self, TypeDefinitionArg type_definition_arg, t.Any default=None, str|None environ_name=None)
	type_definition_repr (self)
None	check_type_definition (self, t.Any value)
t.Any	__call__ (self, t.Any value)

Public Attributes
tuple	type_definition
t.Any	default = default
str|None	environ_name = environ_name
	type_definition_repr

Detailed Description

Check and update a setting value

Definition at line 62 of file settings_defaults.py.

Constructor & Destructor Documentation

__init__()

searx.settings_defaults.SettingsValue.__init__	(		self,
		TypeDefinitionArg	type_definition_arg,
		t.Any	default = None,
		str | None	environ_name = None )

Definition at line 65 of file settings_defaults.py.

    ):
        self.type_definition: TypeDefinition = (
            type_definition_arg if isinstance(type_definition_arg, tuple) else (type_definition_arg,)
        )
        self.default: t.Any = default
        self.environ_name: str | None = environ_name
 

Member Function Documentation

__call__()

t.Any searx.settings_defaults.SettingsValue.__call__	(		self,
		t.Any	value )

Definition at line 89 of file settings_defaults.py.

    def __call__(self, value: t.Any) -> t.Any:
        if value == _UNDEFINED:
            value = self.default
        # override existing value with environ
        if self.environ_name and self.environ_name in os.environ:
            value = os.environ[self.environ_name]
            if self.type_definition == (bool,):
                value = STR_TO_BOOL[value.lower()]
 
        self.check_type_definition(value)
        return value
 
 

References check_type_definition(), default, environ_name, and type_definition.

Here is the call graph for this function:

check_type_definition()

None searx.settings_defaults.SettingsValue.check_type_definition	(		self,
		t.Any	value )

Reimplemented in searx.settings_defaults.SettingsDirectoryValue, and searx.settings_defaults.SettingSublistValue.

Definition at line 82 of file settings_defaults.py.

    def check_type_definition(self, value: t.Any) -> None:
        if value in self.type_definition:
            return
        type_list = tuple(t for t in self.type_definition if isinstance(t, type))
        if not isinstance(value, type_list):
            raise ValueError('The value has to be one of these types/values: {}'.format(self.type_definition_repr))
 

References type_definition.

Referenced by __call__().

Here is the caller graph for this function:

type_definition_repr()

searx.settings_defaults.SettingsValue.type_definition_repr

(

self

)

Definition at line 78 of file settings_defaults.py.

    def type_definition_repr(self):
        types_str = [td.__name__ if isinstance(td, type) else repr(td) for td in self.type_definition]
        return ', '.join(types_str)
 

References type_definition.

Member Data Documentation

default

t.Any searx.settings_defaults.SettingsValue.default = default

Definition at line 74 of file settings_defaults.py.

Referenced by searx.settings_defaults.SettingsDirectoryValue.__call__(), and __call__().

environ_name

str | None searx.settings_defaults.SettingsValue.environ_name = environ_name

Definition at line 75 of file settings_defaults.py.

Referenced by __call__().

type_definition

tuple searx.settings_defaults.SettingsValue.type_definition

Initial value:

=  (
            type_definition_arg if isinstance(type_definition_arg, tuple) else (type_definition_arg,)
        )

Definition at line 71 of file settings_defaults.py.

Referenced by __call__(), searx.settings_defaults.SettingSublistValue.check_type_definition(), check_type_definition(), and type_definition_repr().

type_definition_repr

searx.settings_defaults.SettingsValue.type_definition_repr

Definition at line 87 of file settings_defaults.py.

---

The documentation for this class was generated from the following file:

• /home/andrew/Documents/code/public/searxng/searx/settings_defaults.py