searx.preferences.SetSetting Class Reference

Inheritance diagram for searx.preferences.SetSetting:

Collaboration diagram for searx.preferences.SetSetting:

Public Member Functions
	__init__ (self, *args, **kwargs)
	get_value (self)
	parse (self, str data)
	parse_form (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)

Public Attributes
set[str]	values = set()
Public Attributes inherited from searx.preferences.Setting
t.Any	value = default_value
bool	locked = locked

Detailed Description

Setting of values of type ``set`` (comma separated string)

Definition at line 139 of file preferences.py.

Constructor & Destructor Documentation

__init__()

searx.preferences.SetSetting.__init__	(		self,
		*	args,
		**	kwargs )

Definition at line 142 of file preferences.py.

    def __init__(self, *args, **kwargs):  # type: ignore
        super().__init__(*args, **kwargs)  # type: ignore
        self.values: set[str] = set()
 

References __init__().

Referenced by __init__().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Function Documentation

get_value()

searx.preferences.SetSetting.get_value

(

self

)

Returns a string with comma separated values.

Reimplemented from searx.preferences.Setting.

Definition at line 146 of file preferences.py.

    def get_value(self):
        """Returns a string with comma separated values."""
        return ','.join(self.values)
 

References values.

parse()

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

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

Reimplemented from searx.preferences.Setting.

Definition at line 150 of file preferences.py.

    def parse(self, data: str):
        """Parse and validate ``data`` and store the result at ``self.value``"""
        if data == '':
            self.values = set()
            return
 
        elements = data.split(',')
        for element in elements:
            self.values.add(element)
 

References values.

parse_form()

searx.preferences.SetSetting.parse_form	(		self,
		str	data )

Definition at line 160 of file preferences.py.

    def parse_form(self, data: str):
        if self.locked:
            return
 
        elements = data.split(',')
        self.values = set(elements)
 

save()

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

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

Reimplemented from searx.preferences.Setting.

Definition at line 167 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.values), max_age=COOKIE_MAX_AGE)
 
 

References values.

Member Data Documentation

values

searx.preferences.SetSetting.values = set()

Definition at line 144 of file preferences.py.

Referenced by get_value(), parse(), and save().

---

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

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