searx.preferences.MapSetting Class Reference

Inheritance diagram for searx.preferences.MapSetting:

Collaboration diagram for searx.preferences.MapSetting:

Public Member Functions
	__init__ (self, default_value, Dict[str, object] map, locked=False)
	parse (self, str data)
	save (self, str name, flask.Response resp)
Public Member Functions inherited from searx.preferences.Setting
	get_value (self)

Public Attributes
	map
	value
	key
Public Attributes inherited from searx.preferences.Setting
	value
	locked

Detailed Description

Setting of a value that has to be translated in order to be storable

Definition at line 189 of file preferences.py.

Constructor & Destructor Documentation

__init__()

searx.preferences.MapSetting.__init__	(		self,
			default_value,
		Dict[str, object]	map,
			locked = False )

Reimplemented from searx.preferences.Setting.

Definition at line 192 of file preferences.py.

    def __init__(self, default_value, map: Dict[str, object], locked=False):  # pylint: disable=redefined-builtin
        super().__init__(default_value, locked)
        self.map = map
 
        if self.value not in self.map.values():
            raise ValidationException('Invalid default value')
 

References searx.preferences.MapSetting.__init__().

Referenced by searx.preferences.MapSetting.__init__().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Function Documentation

parse()

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

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

Reimplemented from searx.preferences.Setting.

Definition at line 199 of file preferences.py.

    def parse(self, data: str):
        """Parse and validate ``data`` and store the result at ``self.value``"""
 
        if data not in self.map:
            raise ValidationException('Invalid choice: {0}'.format(data))
        self.value = self.map[data]
        self.key = data  # pylint: disable=attribute-defined-outside-init
 

References searx.format, and searx.preferences.MapSetting.map.

save()

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

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

Reimplemented from searx.preferences.Setting.

Definition at line 207 of file preferences.py.

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

References searx.preferences.MapSetting.key, and searx.preferences.BooleanSetting.key.

Member Data Documentation

key

searx.preferences.MapSetting.key

Definition at line 205 of file preferences.py.

Referenced by searx.preferences.MapSetting.save(), and searx.preferences.BooleanSetting.save().

map

searx.preferences.MapSetting.map

Definition at line 194 of file preferences.py.

Referenced by searx.preferences.MapSetting.parse().

value

searx.preferences.MapSetting.value

Definition at line 204 of file preferences.py.

Referenced by searx.preferences.Setting.get_value(), searx.preferences.Setting.parse(), searx.preferences.EnumStringSetting.parse(), searx.preferences.MultipleChoiceSetting.parse(), searx.preferences.SearchLanguageSetting.parse(), searx.preferences.MultipleChoiceSetting.parse_form(), searx.preferences.Setting.save(), and searx.preferences.MultipleChoiceSetting.save().

---

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

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