searx.preferences.EnumStringSetting Class Reference

Inheritance diagram for searx.preferences.EnumStringSetting:

Collaboration diagram for searx.preferences.EnumStringSetting:

Public Member Functions
	__init__ (self, str default_value, Iterable[str] choices, bool locked=False)
	parse (self, str data)
Public Member Functions inherited from searx.preferences.Setting
	__init__ (self, t.Any default_value, bool locked=False)
	get_value (self)
	save (self, str name, flask.Response resp)

Public Attributes
Iterable[str]	choices = choices
Public Attributes inherited from searx.preferences.Setting
t.Any	value = default_value
bool	locked = locked

Protected Member Functions
	_validate_selection (self, str selection)

Detailed Description

Setting of a value which can only come from the given choices

Definition at line 82 of file preferences.py.

Constructor & Destructor Documentation

__init__()

searx.preferences.EnumStringSetting.__init__	(		self,
		str	default_value,
		Iterable[str]	choices,
		bool	locked = False )

Definition at line 87 of file preferences.py.

    def __init__(self, default_value: str, choices: Iterable[str], locked: bool = False):
        super().__init__(default_value, locked)
        self.choices: Iterable[str] = choices
        self._validate_selection(self.value)
 

References __init__().

Referenced by __init__().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Function Documentation

_validate_selection()

searx.preferences.EnumStringSetting._validate_selection ( self, str selection )

protected

Reimplemented in searx.preferences.SearchLanguageSetting.

Definition at line 92 of file preferences.py.

    def _validate_selection(self, selection: str):
        if selection not in self.choices:
            raise ValidationException('Invalid value: "{0}"'.format(selection))
 

References choices.

Referenced by parse().

Here is the caller graph for this function:

parse()

searx.preferences.EnumStringSetting.parse	(		self,
		str	data )

Parse and validate ``data`` and store the result at ``self.value``

Reimplemented from searx.preferences.Setting.

Reimplemented in searx.preferences.SearchLanguageSetting.

Definition at line 96 of file preferences.py.

    def parse(self, data: str):
        """Parse and validate ``data`` and store the result at ``self.value``"""
        self._validate_selection(data)
        self.value = data
 
 

References _validate_selection(), and searx.preferences.Setting.value.

Here is the call graph for this function:

Member Data Documentation

choices

Iterable[str] searx.preferences.EnumStringSetting.choices = choices

Definition at line 89 of file preferences.py.

Referenced by _validate_selection(), searx.preferences.MultipleChoiceSetting._validate_selections(), searx.preferences.BooleanChoices.disabled(), searx.preferences.BooleanChoices.enabled(), searx.preferences.SearchLanguageSetting.parse(), searx.preferences.BooleanChoices.parse_cookie(), and searx.preferences.BooleanChoices.parse_form().

---

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

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