searx.preferences.ClientPref Class Reference

Collaboration diagram for searx.preferences.ClientPref:

Public Member Functions
	__init__ (self, Optional[babel.Locale] locale=None)
	locale_tag (self)
	from_http_request (cls, flask.Request http_request)

Static Public Attributes
babel	locale .Locale

Detailed Description

Container to assemble client prefferences and settings.

Definition at line 322 of file preferences.py.

Constructor & Destructor Documentation

__init__()

searx.preferences.ClientPref.__init__	(		self,
		Optional[babel.Locale]	locale = None )

Definition at line 330 of file preferences.py.

    def __init__(self, locale: Optional[babel.Locale] = None):
        self.locale = locale
 

References searx.preferences.ClientPref.locale, and searx.search.models.SearchQuery.locale.

Member Function Documentation

from_http_request()

searx.preferences.ClientPref.from_http_request	(		cls,
		flask.Request	http_request )

Build ClientPref object from HTTP request.

- `Accept-Language used for locale setting
  <https://www.w3.org/International/questions/qa-accept-lang-locales.en>`__

Definition at line 343 of file preferences.py.

    def from_http_request(cls, http_request: flask.Request):
        """Build ClientPref object from HTTP request.
 
        - `Accept-Language used for locale setting
          <https://www.w3.org/International/questions/qa-accept-lang-locales.en>`__
 
        """
        al_header = http_request.headers.get("Accept-Language")
        if not al_header:
            return cls(locale=None)
 
        pairs = []
        for l in al_header.split(','):
            # fmt: off
            lang, qvalue = [_.strip() for _ in (l.split(';') + ['q=1',])[:2]]
            # fmt: on
            try:
                qvalue = float(qvalue.split('=')[-1])
                locale = babel.Locale.parse(lang, sep='-')
            except (ValueError, babel.core.UnknownLocaleError):
                continue
            pairs.append((locale, qvalue))
 
        locale = None
        if pairs:
            pairs.sort(reverse=True, key=lambda x: x[1])
            locale = pairs[0][0]
        return cls(locale=locale)
 
 

locale_tag()

searx.preferences.ClientPref.locale_tag

(

self

)

Definition at line 334 of file preferences.py.

    def locale_tag(self):
        if self.locale is None:
            return None
        tag = self.locale.language
        if self.locale.territory:
            tag += '-' + self.locale.territory
        return tag
 

References searx.preferences.ClientPref.locale, and searx.search.models.SearchQuery.locale.

Member Data Documentation

locale

babel searx.preferences.ClientPref.locale .Locale

static

Definition at line 327 of file preferences.py.

Referenced by searx.preferences.ClientPref.__init__(), and searx.preferences.ClientPref.locale_tag().

---

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

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