searx.preferences.BooleanChoices Class Reference

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
	name
	choices
	locked
	default_choices
	disabled
	enabled

Detailed Description

Maps strings to booleans that are either true or false.

Definition at line 233 of file preferences.py.

Constructor & Destructor Documentation

__init__()

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

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

Definition at line 236 of file preferences.py.

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

Member Function Documentation

disabled()

searx.preferences.BooleanChoices.disabled

(

self

)

Definition at line 270 of file preferences.py.

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

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

Referenced by searx.preferences.BooleanChoices.save().

Here is the caller graph for this function:

enabled()

searx.preferences.BooleanChoices.enabled

(

self

)

Definition at line 266 of file preferences.py.

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

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

Referenced by searx.preferences.BooleanChoices.save().

Here is the caller graph for this function:

get_disabled()

searx.preferences.BooleanChoices.get_disabled

(

self

)

Definition at line 280 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 283 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 248 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 searx.preferences.EnumStringSetting.choices, searx.preferences.MultipleChoiceSetting.choices, and searx.preferences.BooleanChoices.choices.

parse_form()

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

Definition at line 257 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 searx.preferences.EnumStringSetting.choices, searx.preferences.MultipleChoiceSetting.choices, searx.preferences.BooleanChoices.choices, searx.preferences.Setting.locked, searx.preferences.BooleanChoices.locked, searx.preferences.BooleanChoices.transform_form_items(), searx.preferences.EnginesSetting.transform_form_items(), and searx.preferences.PluginsSetting.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 273 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 searx.preferences.BooleanChoices.default_choices, searx.enginelib.Engine.disabled, searx.preferences.BooleanChoices.disabled(), searx.preferences.BooleanChoices.disabled, searx.preferences.BooleanChoices.enabled(), searx.preferences.BooleanChoices.enabled, searx.format, searx.enginelib.Engine.name, searx.engines.wikidata.WDAttribute.name, searx.engines.wikidata.WDAmountAttribute.name, searx.engines.wikidata.WDLabelAttribute.name, searx.engines.wikidata.WDGeoAttribute.name, searx.engines.wikidata.WDDateAttribute.name, searx.plugins.Plugin.name, searx.preferences.BooleanChoices.name, and searx.search.models.EngineRef.name.

Here is the call graph for this function:

transform_form_items()

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

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

Definition at line 242 of file preferences.py.

    def transform_form_items(self, items):
        return items
 

Referenced by searx.preferences.BooleanChoices.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 245 of file preferences.py.

    def transform_values(self, values):
        return values
 

Member Data Documentation

choices

searx.preferences.BooleanChoices.choices

Definition at line 238 of file preferences.py.

Referenced by searx.preferences.EnumStringSetting._validate_selection(), searx.preferences.MultipleChoiceSetting._validate_selections(), searx.preferences.BooleanChoices.disabled(), searx.preferences.BooleanChoices.enabled(), searx.preferences.SearchLanguageSetting.parse(), searx.preferences.BooleanChoices.parse_cookie(), searx.preferences.MultipleChoiceSetting.parse_form(), and searx.preferences.BooleanChoices.parse_form().

default_choices

searx.preferences.BooleanChoices.default_choices

Definition at line 240 of file preferences.py.

Referenced by searx.preferences.BooleanChoices.save().

disabled

searx.preferences.BooleanChoices.disabled

Definition at line 281 of file preferences.py.

Referenced by searx.preferences.BooleanChoices.save().

enabled

searx.preferences.BooleanChoices.enabled

Definition at line 284 of file preferences.py.

Referenced by searx.preferences.BooleanChoices.save().

locked

searx.preferences.BooleanChoices.locked

Definition at line 239 of file preferences.py.

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

name

searx.preferences.BooleanChoices.name

Definition at line 237 of file preferences.py.

Referenced by searx.search.models.EngineRef.__eq__(), searx.search.models.EngineRef.__hash__(), searx.engines.wikidata.WDAttribute.__repr__(), searx.search.models.EngineRef.__repr__(), searx.engines.wikidata.WDGeoAttribute.get_geo_url(), searx.engines.wikidata.WDAttribute.get_label(), searx.engines.wikidata.WDAttribute.get_select(), searx.engines.wikidata.WDAttribute.get_str(), searx.engines.wikidata.WDAmountAttribute.get_str(), searx.engines.wikidata.WDLabelAttribute.get_str(), searx.engines.wikidata.WDURLAttribute.get_str(), searx.engines.wikidata.WDGeoAttribute.get_str(), searx.engines.wikidata.WDDateAttribute.get_str(), searx.engines.wikidata.WDAttribute.get_where(), searx.engines.wikidata.WDAmountAttribute.get_where(), searx.engines.wikidata.WDLabelAttribute.get_where(), searx.engines.wikidata.WDGeoAttribute.get_where(), searx.engines.wikidata.WDDateAttribute.get_where(), searx.engines.wikidata.WDLabelAttribute.get_wikibase_label(), and searx.preferences.BooleanChoices.save().

---

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

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