Inheritance diagram for searx.preferences.BooleanSetting:

Collaboration diagram for searx.preferences.BooleanSetting:

Public Member Functions
str	normalized_str (self, t.Any val)
	parse (self, 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
str	key = self.normalized_str(self.value)
Public Attributes inherited from searx.preferences.Setting
t.Any	value = default_value
bool	locked = locked

Detailed Description

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

Definition at line 227 of file preferences.py.

Member Function Documentation

◆ normalized_str()

str searx.preferences.BooleanSetting.normalized_str	(		self,
		t.Any	val )

Definition at line 233 of file preferences.py.

    def normalized_str(self, val: t.Any) -> str:
        for v_str, v_obj in MAP_STR2BOOL.items():
            if val == v_obj:
                return v_str
        raise ValueError("Invalid value: %s (%s) is not a boolean!" % (repr(val), type(val)))
 

◆ parse()

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

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

Reimplemented from searx.preferences.Setting.

Definition at line 239 of file preferences.py.

    def parse(self, data: str):
        """Parse and validate ``data`` and store the result at ``self.value``"""
        self.value = MAP_STR2BOOL[data]
        self.key = self.normalized_str(self.value)  # pylint: disable=attribute-defined-outside-init
 

◆ save()

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

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

Reimplemented from searx.preferences.Setting.

Definition at line 244 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, key, and searx.preferences.MapSetting.key.

Member Data Documentation

◆ key

searx.preferences.BooleanSetting.key = self.normalized_str(self.value)

Definition at line 242 of file preferences.py.

Referenced by save().

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

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

Public Member Functions