Inheritance diagram for searx.preferences.BooleanChoices:

Public Member Functions
	__init__ (self, str name, dict[str, bool] choices, bool locked=False)
	transform_form_items (self, items)
	transform_values (self, values)
	parse_cookie (self, str data_disabled, str data_enabled)
	parse_form (self, list[str] items)
	enabled (self)
	disabled (self)
	save (self, flask.Response resp)
	get_disabled (self)
	get_enabled (self)

Public Attributes
str	name = name
dict[str, bool]	choices = choices
bool	locked = locked
dict[str, bool]	default_choices = dict(choices)
	disabled
	enabled

Detailed Description

Maps strings to booleans that are either true or false.

Definition at line 250 of file preferences.py.

Constructor & Destructor Documentation

◆ init()

searx.preferences.BooleanChoices.__init__	(		self,
		str	name,
		dict[str, bool]	choices,
		bool	locked = False )

Definition at line 253 of file preferences.py.

    def __init__(self, name: str, choices: dict[str, bool], locked: bool = False):
        self.name: str = name
        self.choices: dict[str, bool] = choices
        self.locked: bool = locked
        self.default_choices: dict[str, bool] = dict(choices)
 

Member Function Documentation

◆ disabled()

searx.preferences.BooleanChoices.disabled ( self )

Definition at line 287 of file preferences.py.

    def disabled(self):
        return (k for k, v in self.choices.items() if not v)
 

References choices, searx.preferences.EnumStringSetting.choices, searx.preferences.MultipleChoiceSetting.choices, and searx.preferences.SearchLanguageSetting.choices.

◆ enabled()

searx.preferences.BooleanChoices.enabled ( self )

Definition at line 283 of file preferences.py.

    def enabled(self):
        return (k for k, v in self.choices.items() if v)
 

References choices, searx.preferences.EnumStringSetting.choices, searx.preferences.MultipleChoiceSetting.choices, and searx.preferences.SearchLanguageSetting.choices.

◆ get_disabled()

searx.preferences.BooleanChoices.get_disabled ( self )

Definition at line 297 of file preferences.py.

    def get_disabled(self):
        return self.transform_values(list(self.disabled))
 

◆ get_enabled()

searx.preferences.BooleanChoices.get_enabled ( self )

Definition at line 300 of file preferences.py.

    def get_enabled(self):
        return self.transform_values(list(self.enabled))

◆ parse_cookie()

searx.preferences.BooleanChoices.parse_cookie	(		self,
		str	data_disabled,
		str	data_enabled )

Definition at line 265 of file preferences.py.

    def parse_cookie(self, data_disabled: str, data_enabled: str):
        for disabled in data_disabled.split(','):
            if disabled in self.choices:
                self.choices[disabled] = False
 
        for enabled in data_enabled.split(','):
            if enabled in self.choices:
                self.choices[enabled] = True
 

References choices, searx.preferences.EnumStringSetting.choices, searx.preferences.MultipleChoiceSetting.choices, and searx.preferences.SearchLanguageSetting.choices.

◆ parse_form()

searx.preferences.BooleanChoices.parse_form	(		self,
		list[str]	items )

Definition at line 274 of file preferences.py.

    def parse_form(self, items: list[str]):
        if self.locked:
            return
 
        disabled = self.transform_form_items(items)
        for setting in self.choices:
            self.choices[setting] = setting not in disabled
 

References choices, searx.preferences.EnumStringSetting.choices, searx.preferences.MultipleChoiceSetting.choices, searx.preferences.SearchLanguageSetting.choices, locked, searx.preferences.MultipleChoiceSetting.locked, searx.preferences.SetSetting.locked, searx.preferences.Setting.locked, and transform_form_items().

Here is the call graph for this function:

◆ save()

searx.preferences.BooleanChoices.save	(		self,
		flask.Response	resp )

Save cookie in the HTTP response object

Definition at line 290 of file preferences.py.

    def save(self, resp: flask.Response):
        """Save cookie in the HTTP response object"""
        disabled_changed = (k for k in self.disabled if self.default_choices[k])
        enabled_changed = (k for k in self.enabled if not self.default_choices[k])
        resp.set_cookie('disabled_{0}'.format(self.name), ','.join(disabled_changed), max_age=COOKIE_MAX_AGE)
        resp.set_cookie('enabled_{0}'.format(self.name), ','.join(enabled_changed), max_age=COOKIE_MAX_AGE)
 

References default_choices, disabled, enabled, searx.engines.wikidata.WDAmountAttribute.name, searx.engines.wikidata.WDAttribute.name, searx.engines.wikidata.WDDateAttribute.name, searx.engines.wikidata.WDGeoAttribute.name, searx.engines.wikidata.WDLabelAttribute.name, and name.

◆ transform_form_items()

searx.preferences.BooleanChoices.transform_form_items	(		self,
			items )

Reimplemented in searx.preferences.EnginesSetting, and searx.preferences.PluginsSetting.

Definition at line 259 of file preferences.py.

    def transform_form_items(self, items):
        return items
 

Referenced by parse_form().

Here is the caller graph for this function:

◆ transform_values()

searx.preferences.BooleanChoices.transform_values	(		self,
			values )

Reimplemented in searx.preferences.EnginesSetting.

Definition at line 262 of file preferences.py.

    def transform_values(self, values):
        return values
 

Member Data Documentation

◆ choices

dict[str, bool] searx.preferences.BooleanChoices.choices = choices

Definition at line 255 of file preferences.py.

Referenced by disabled(), enabled(), parse_cookie(), and parse_form().

◆ default_choices

dict[str, bool] searx.preferences.BooleanChoices.default_choices = dict(choices)

Definition at line 257 of file preferences.py.

Referenced by save().

◆ disabled

searx.preferences.BooleanChoices.disabled

Definition at line 298 of file preferences.py.

Referenced by save().

◆ enabled

searx.preferences.BooleanChoices.enabled

Definition at line 301 of file preferences.py.

Referenced by save().

◆ locked

bool searx.preferences.BooleanChoices.locked = locked

Definition at line 256 of file preferences.py.

Referenced by parse_form().

◆ name

searx.preferences.BooleanChoices.name = name

Definition at line 254 of file preferences.py.

Referenced by searx.search.models.EngineRef.__eq__(), searx.search.models.EngineRef.__hash__(), searx.search.models.EngineRef.__repr__(), searx.weather.GeoLocation.__str__(), and save().

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

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ disabled()

◆ enabled()

◆ get_disabled()

◆ get_enabled()

◆ parse_cookie()

◆ parse_form()

◆ save()

◆ transform_form_items()

◆ transform_values()

Member Data Documentation

◆ choices

◆ default_choices

◆ disabled

◆ enabled

◆ locked

◆ name

◆ init()