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
	__init__ (self, default_value, bool locked=False)

	get_value (self)

Public Attributes
	map = map

	key = data

Public Attributes inherited from searx.preferences.Setting
	value = default_value

	locked = locked

Detailed Description

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

Definition at line 192 of file preferences.py.

Constructor & Destructor Documentation

◆ init()

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

Definition at line 195 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 __init__().

Referenced by __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 202 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 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 210 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.openmetrics.OpenMetricsFamily.key, and key.

Member Data Documentation

◆ key

searx.preferences.MapSetting.key = data

Definition at line 208 of file preferences.py.

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

◆ map

searx.preferences.MapSetting.map = map

Definition at line 197 of file preferences.py.

Referenced by parse().

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

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

Public Member Functions

Public Attributes