searx.preferences.Setting Class Reference

Inheritance diagram for searx.preferences.Setting:

Public Member Functions
	__init__ (self, default_value, bool locked=False)
	parse (self, str data)
	get_value (self)
	save (self, str name, flask.Response resp)

Public Attributes
	value
	locked

Detailed Description

Base class of user settings

Definition at line 44 of file preferences.py.

Constructor & Destructor Documentation

__init__()

searx.preferences.Setting.__init__	(		self,
			default_value,
		bool	locked = False )

Reimplemented in searx.preferences.SetSetting, searx.preferences.MapSetting, searx.preferences.MultipleChoiceSetting, and searx.preferences.EnumStringSetting.

Definition at line 47 of file preferences.py.

    def __init__(self, default_value, locked: bool = False):
        super().__init__()
        self.value = default_value
        self.locked = locked
 

References searx.preferences.Setting.__init__().

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

Here is the call graph for this function:

Here is the caller graph for this function:

Member Function Documentation

get_value()

searx.preferences.Setting.get_value

(

self

)

Returns the value of the setting

If needed, its overwritten in the inheritance.

Reimplemented in searx.preferences.SetSetting.

Definition at line 59 of file preferences.py.

    def get_value(self):
        """Returns the value of the setting
 
        If needed, its overwritten in the inheritance.
        """
        return self.value
 

References searx.preferences.Setting.value, searx.preferences.EnumStringSetting.value, searx.preferences.MultipleChoiceSetting.value, searx.preferences.SearchLanguageSetting.value, searx.preferences.MapSetting.value, and searx.preferences.BooleanSetting.value.

parse()

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

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

If needed, its overwritten in the inheritance.

Reimplemented in searx.preferences.EnumStringSetting, searx.preferences.MultipleChoiceSetting, searx.preferences.SetSetting, searx.preferences.SearchLanguageSetting, searx.preferences.MapSetting, and searx.preferences.BooleanSetting.

Definition at line 52 of file preferences.py.

    def parse(self, data: str):
        """Parse ``data`` and store the result at ``self.value``
 
        If needed, its overwritten in the inheritance.
        """
        self.value = data
 

References searx.preferences.Setting.value, searx.preferences.EnumStringSetting.value, searx.preferences.MultipleChoiceSetting.value, searx.preferences.SearchLanguageSetting.value, searx.preferences.MapSetting.value, and searx.preferences.BooleanSetting.value.

save()

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

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

If needed, its overwritten in the inheritance.

Reimplemented in searx.preferences.MultipleChoiceSetting, searx.preferences.SetSetting, searx.preferences.MapSetting, and searx.preferences.BooleanSetting.

Definition at line 66 of file preferences.py.

    def save(self, name: str, resp: flask.Response):
        """Save cookie ``name`` in the HTTP response object
 
        If needed, its overwritten in the inheritance."""
        resp.set_cookie(name, self.value, max_age=COOKIE_MAX_AGE)
 
 

References searx.preferences.Setting.value, searx.preferences.EnumStringSetting.value, searx.preferences.MultipleChoiceSetting.value, searx.preferences.SearchLanguageSetting.value, searx.preferences.MapSetting.value, and searx.preferences.BooleanSetting.value.

Member Data Documentation

locked

searx.preferences.Setting.locked

Definition at line 50 of file preferences.py.

Referenced by searx.preferences.MultipleChoiceSetting.parse_form(), searx.preferences.BooleanChoices.parse_form(), and searx.preferences.SetSetting.parse_form().

value

searx.preferences.Setting.value

Definition at line 49 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