Public Member Functions
	__init__ (self, str query, list[EngineRef] engineref_list, str lang='all', typing.Literal[0, 1, 2] safesearch=0, int pageno=1, typing.Literal["day", "week", "month", "year"]\|None time_range=None, float\|None timeout_limit=None, str\|None external_bang=None, dict[str, dict[str, str]]\|None engine_data=None, bool\|None redirect_to_first_result=None)
	categories (self)
	__repr__ (self)
	__eq__ (self, other)
	__hash__ (self)
	__copy__ (self)

Public Attributes
	query = query
	engineref_list = engineref_list
	lang = lang
typing.Literal[0, 1, 2]	safesearch = safesearch
	pageno = pageno
typing.Literal[,,,]\|None	time_range = time_range
	timeout_limit = timeout_limit
	external_bang = external_bang
	engine_data = engine_data or {}
	redirect_to_first_result = redirect_to_first_result
	locale = None

Detailed Description

container for all the search parameters (query, language, etc...)

Definition at line 28 of file models.py.

Constructor & Destructor Documentation

◆ init()

searx.search.models.SearchQuery.__init__	(		self,
		str	query,
		list[EngineRef]	engineref_list,
		str	lang = 'all',
		typing.Literal[0, 1, 2]	safesearch = 0,
		int	pageno = 1,
		typing.Literal["day", "week", "month", "year"] \| None	time_range = None,
		float \| None	timeout_limit = None,
		str \| None	external_bang = None,
		dict[str, dict[str, str]] \| None	engine_data = None,
		bool \| None	redirect_to_first_result = None )

Definition at line 31 of file models.py.

    ):  # pylint:disable=too-many-arguments
        self.query = query
        self.engineref_list = engineref_list
        self.lang = lang
        self.safesearch: typing.Literal[0, 1, 2] = safesearch
        self.pageno = pageno
        self.time_range: typing.Literal["day", "week", "month", "year"] | None = time_range
        self.timeout_limit = timeout_limit
        self.external_bang = external_bang
        self.engine_data = engine_data or {}
        self.redirect_to_first_result = redirect_to_first_result
 
        self.locale = None
        if self.lang:
            try:
                self.locale = babel.Locale.parse(self.lang, sep='-')
            except babel.core.UnknownLocaleError:
                pass
 

Member Function Documentation

◆ copy()

searx.search.models.SearchQuery.__copy__ ( self )

Definition at line 107 of file models.py.

    def __copy__(self):
        return SearchQuery(
            self.query,
            self.engineref_list,
            self.lang,
            self.safesearch,
            self.pageno,
            self.time_range,
            self.timeout_limit,
            self.external_bang,
            self.engine_data,
            self.redirect_to_first_result,
        )

References searx.results.ResultContainer.engine_data, engine_data, engineref_list, searx.query.RawTextQuery.external_bang, external_bang, lang, pageno, searx.query.RawTextQuery.query, query, searx.query.RawTextQuery.redirect_to_first_result, redirect_to_first_result, safesearch, time_range, searx.query.RawTextQuery.timeout_limit, and timeout_limit.

◆ eq()

searx.search.models.SearchQuery.__eq__	(		self,
			other )

Definition at line 79 of file models.py.

    def __eq__(self, other):
        return (
            self.query == other.query
            and self.engineref_list == other.engineref_list
            and self.lang == other.lang
            and self.safesearch == other.safesearch
            and self.pageno == other.pageno
            and self.time_range == other.time_range
            and self.timeout_limit == other.timeout_limit
            and self.external_bang == other.external_bang
            and self.redirect_to_first_result == other.redirect_to_first_result
        )
 

References engineref_list, searx.query.RawTextQuery.external_bang, external_bang, lang, pageno, searx.query.RawTextQuery.query, query, searx.query.RawTextQuery.redirect_to_first_result, redirect_to_first_result, safesearch, time_range, searx.query.RawTextQuery.timeout_limit, and timeout_limit.

◆ hash()

searx.search.models.SearchQuery.__hash__ ( self )

Definition at line 92 of file models.py.

    def __hash__(self):
        return hash(
            (
                self.query,
                tuple(self.engineref_list),
                self.lang,
                self.safesearch,
                self.pageno,
                self.time_range,
                self.timeout_limit,
                self.external_bang,
                self.redirect_to_first_result,
            )
        )
 

References engineref_list, searx.query.RawTextQuery.external_bang, external_bang, lang, pageno, searx.query.RawTextQuery.query, query, searx.query.RawTextQuery.redirect_to_first_result, redirect_to_first_result, safesearch, time_range, searx.query.RawTextQuery.timeout_limit, and timeout_limit.

◆ repr()

searx.search.models.SearchQuery.__repr__ ( self )

Definition at line 66 of file models.py.

    def __repr__(self):
        return "SearchQuery({!r}, {!r}, {!r}, {!r}, {!r}, {!r}, {!r}, {!r}, {!r})".format(
            self.query,
            self.engineref_list,
            self.lang,
            self.safesearch,
            self.pageno,
            self.time_range,
            self.timeout_limit,
            self.external_bang,
            self.redirect_to_first_result,
        )
 

References engineref_list, searx.query.RawTextQuery.external_bang, external_bang, lang, pageno, searx.query.RawTextQuery.query, query, searx.query.RawTextQuery.redirect_to_first_result, redirect_to_first_result, safesearch, time_range, searx.query.RawTextQuery.timeout_limit, and timeout_limit.

◆ categories()

searx.search.models.SearchQuery.categories ( self )

Definition at line 63 of file models.py.

    def categories(self):
        return list(set(map(lambda engineref: engineref.category, self.engineref_list)))
 

References engineref_list.

Member Data Documentation

◆ engine_data

searx.search.models.SearchQuery.engine_data = engine_data or {}

Definition at line 52 of file models.py.

Referenced by __copy__().

◆ engineref_list

searx.search.models.SearchQuery.engineref_list = engineref_list

Definition at line 45 of file models.py.

Referenced by __copy__(), __eq__(), __hash__(), __repr__(), and categories().

◆ external_bang

searx.search.models.SearchQuery.external_bang = external_bang

Definition at line 51 of file models.py.

Referenced by __copy__(), __eq__(), __hash__(), and __repr__().

◆ lang

searx.search.models.SearchQuery.lang = lang

Definition at line 46 of file models.py.

Referenced by __copy__(), __eq__(), __hash__(), and __repr__().

◆ locale

searx.search.models.SearchQuery.locale = None

Definition at line 55 of file models.py.

◆ pageno

searx.search.models.SearchQuery.pageno = pageno

Definition at line 48 of file models.py.

Referenced by __copy__(), __eq__(), __hash__(), and __repr__().

◆ query

searx.search.models.SearchQuery.query = query

Definition at line 44 of file models.py.

Referenced by __copy__(), __eq__(), __hash__(), and __repr__().

◆ redirect_to_first_result

searx.search.models.SearchQuery.redirect_to_first_result = redirect_to_first_result

Definition at line 53 of file models.py.

Referenced by __copy__(), __eq__(), __hash__(), and __repr__().

◆ safesearch

searx.search.models.SearchQuery.safesearch = safesearch

Definition at line 47 of file models.py.

Referenced by __copy__(), __eq__(), __hash__(), and __repr__().

◆ time_range

searx.search.models.SearchQuery.time_range = time_range

Definition at line 49 of file models.py.

Referenced by __copy__(), __eq__(), __hash__(), and __repr__().

◆ timeout_limit

searx.search.models.SearchQuery.timeout_limit = timeout_limit

Definition at line 50 of file models.py.

Referenced by __copy__(), __eq__(), __hash__(), and __repr__().

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

/home/andrew/Documents/code/public/searxng/searx/search/models.py

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ __copy__()

◆ __eq__()

◆ __hash__()

◆ __repr__()

◆ categories()

Member Data Documentation

◆ engine_data

◆ engineref_list

◆ external_bang

◆ lang

◆ locale

◆ pageno

◆ query

◆ redirect_to_first_result

◆ safesearch

◆ time_range

◆ timeout_limit

◆ init()

◆ copy()

◆ eq()

◆ hash()

◆ repr()