searx.preferences.MultipleChoiceSetting Class Reference

Inheritance diagram for searx.preferences.MultipleChoiceSetting:

Collaboration diagram for searx.preferences.MultipleChoiceSetting:

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

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_selections (self, list[str] selections)

Detailed Description

Setting of values which can only come from the given choices

Definition at line 102 of file preferences.py.

Constructor & Destructor Documentation

__init__()

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

Definition at line 105 of file preferences.py.

    def __init__(self, default_value: list[str], choices: Iterable[str], locked: bool = False):
        super().__init__(default_value, locked)
        self.choices: Iterable[str] = choices
        self._validate_selections(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_selections()

searx.preferences.MultipleChoiceSetting._validate_selections ( self, list[str] selections )

protected

Definition at line 110 of file preferences.py.

    def _validate_selections(self, selections: list[str]):
        for item in selections:
            if item not in self.choices:
                raise ValidationException('Invalid value: "{0}"'.format(selections))
 

References searx.preferences.EnumStringSetting.choices, and choices.

Referenced by parse().

Here is the caller graph for this function:

parse()

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

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

Reimplemented from searx.preferences.Setting.

Definition at line 115 of file preferences.py.

    def parse(self, data: str):
        """Parse and validate ``data`` and store the result at ``self.value``"""
        if data == '':
            self.value: list[str] = []
            return
 
        elements = data.split(',')
        self._validate_selections(elements)
        self.value = elements
 

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

Here is the call graph for this function:

parse_form()

searx.preferences.MultipleChoiceSetting.parse_form	(		self,
		list[str]	data )

Definition at line 125 of file preferences.py.

    def parse_form(self, data: list[str]):
        if self.locked:
            return
 
        self.value = []
        for choice in data:
            if choice in self.choices and choice not in self.value:
                self.value.append(choice)
 

save()

searx.preferences.MultipleChoiceSetting.save	(		self,
		str	name,
		flask.Response	resp )

Save cookie ``name`` in the HTTP response object

Reimplemented from searx.preferences.Setting.

Definition at line 134 of file preferences.py.

    def save(self, name: str, resp: flask.Response):
        """Save cookie ``name`` in the HTTP response object"""
        resp.set_cookie(name, ','.join(self.value), max_age=COOKIE_MAX_AGE)
 
 

References searx.preferences.Setting.value.

Member Data Documentation

choices

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

Definition at line 107 of file preferences.py.

Referenced by _validate_selections(), searx.preferences.BooleanChoices.disabled(), searx.preferences.BooleanChoices.enabled(), 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