.oO SearXNG Developer Documentation Oo.: searx.search.models.SearchQuery Class Reference

.oO SearXNG Developer Documentation Oo.

Loading...

Searching...

No Matches

Public Member Functions
	__init__ (self, str query, typing.List[EngineRef] engineref_list, str lang='all', int safesearch=0, int pageno=1, typing.Optional[str] time_range=None, typing.Optional[float] timeout_limit=None, typing.Optional[str] external_bang=None, typing.Optional[typing.Dict[str, str]] engine_data=None, typing.Optional[bool] 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

	safesearch = safesearch

	pageno = pageno

	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

Static Private Attributes
tuple	__slots__

Detailed Description

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

Definition at line 27 of file models.py.

Constructor & Destructor Documentation

◆ init()

searx.search.models.SearchQuery.__init__	(		self,
		str	query,
		typing.List[EngineRef]	engineref_list,
		str	lang = 'all',
		int	safesearch = 0,
		int	pageno = 1,
		typing.Optional[str]	time_range = None,
		typing.Optional[float]	timeout_limit = None,
		typing.Optional[str]	external_bang = None,
		typing.Optional[typing.Dict[str, str]]	engine_data = None,
		typing.Optional[bool]	redirect_to_first_result = None )

Definition at line 44 of file models.py.

    ):  # pylint:disable=too-many-arguments
        self.query = query
        self.engineref_list = engineref_list
        self.lang = lang
        self.safesearch = safesearch
        self.pageno = pageno
        self.time_range = 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 120 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, searx.search.models.SearchQuery.engine_data, searx.search.checker.impl.Checker.engineref_list(), searx.search.models.SearchQuery.engineref_list, searx.query.RawTextQuery.external_bang, searx.search.models.SearchQuery.external_bang, searx.search.models.SearchQuery.lang, searx.search.models.SearchQuery.pageno, searx.query.RawTextQuery.query, searx.search.models.SearchQuery.query, searx.query.RawTextQuery.redirect_to_first_result, searx.search.models.SearchQuery.redirect_to_first_result, searx.search.models.SearchQuery.safesearch, searx.search.models.SearchQuery.time_range, searx.query.RawTextQuery.timeout_limit, and searx.search.models.SearchQuery.timeout_limit.

Here is the call graph for this function:

◆ eq()

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

Definition at line 92 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 searx.search.checker.impl.Checker.engineref_list(), searx.search.models.SearchQuery.engineref_list, searx.query.RawTextQuery.external_bang, searx.search.models.SearchQuery.external_bang, searx.search.models.SearchQuery.lang, searx.search.models.SearchQuery.pageno, searx.query.RawTextQuery.query, searx.search.models.SearchQuery.query, searx.query.RawTextQuery.redirect_to_first_result, searx.search.models.SearchQuery.redirect_to_first_result, searx.search.models.SearchQuery.safesearch, searx.search.models.SearchQuery.time_range, searx.query.RawTextQuery.timeout_limit, and searx.search.models.SearchQuery.timeout_limit.

Here is the call graph for this function:

◆ hash()

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

Definition at line 105 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 searx.search.checker.impl.Checker.engineref_list(), searx.search.models.SearchQuery.engineref_list, searx.query.RawTextQuery.external_bang, searx.search.models.SearchQuery.external_bang, searx.search.models.SearchQuery.lang, searx.search.models.SearchQuery.pageno, searx.query.RawTextQuery.query, searx.search.models.SearchQuery.query, searx.query.RawTextQuery.redirect_to_first_result, searx.search.models.SearchQuery.redirect_to_first_result, searx.search.models.SearchQuery.safesearch, searx.search.models.SearchQuery.time_range, searx.query.RawTextQuery.timeout_limit, and searx.search.models.SearchQuery.timeout_limit.

Here is the call graph for this function:

◆ repr()

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

Definition at line 79 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 searx.search.checker.impl.Checker.engineref_list(), searx.search.models.SearchQuery.engineref_list, searx.query.RawTextQuery.external_bang, searx.search.models.SearchQuery.external_bang, searx.format, searx.search.models.SearchQuery.lang, searx.search.models.SearchQuery.pageno, searx.query.RawTextQuery.query, searx.search.models.SearchQuery.query, searx.query.RawTextQuery.redirect_to_first_result, searx.search.models.SearchQuery.redirect_to_first_result, searx.search.models.SearchQuery.safesearch, searx.search.models.SearchQuery.time_range, searx.query.RawTextQuery.timeout_limit, and searx.search.models.SearchQuery.timeout_limit.

Here is the call graph for this function:

◆ categories()

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

Definition at line 76 of file models.py.

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

References searx.search.checker.impl.Checker.engineref_list(), and searx.search.models.SearchQuery.engineref_list.

Here is the call graph for this function:

Member Data Documentation

◆ slots

tuple searx.search.models.SearchQuery.__slots__

staticprivate

Initial value:

=  (
        'query',
        'engineref_list',
        'lang',
        'locale',
        'safesearch',
        'pageno',
        'time_range',
        'timeout_limit',
        'external_bang',
        'engine_data',
        'redirect_to_first_result',
    )

Definition at line 30 of file models.py.

◆ engine_data

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

Definition at line 65 of file models.py.

Referenced by searx.search.models.SearchQuery.__copy__().

◆ engineref_list

searx.search.models.SearchQuery.engineref_list = engineref_list

Definition at line 58 of file models.py.

Referenced by searx.search.models.SearchQuery.__copy__(), searx.search.models.SearchQuery.__eq__(), searx.search.models.SearchQuery.__hash__(), searx.search.models.SearchQuery.__repr__(), and searx.search.models.SearchQuery.categories().

◆ external_bang

searx.search.models.SearchQuery.external_bang = external_bang

Definition at line 64 of file models.py.

Referenced by searx.search.models.SearchQuery.__copy__(), searx.search.models.SearchQuery.__eq__(), searx.search.models.SearchQuery.__hash__(), and searx.search.models.SearchQuery.__repr__().

◆ lang

searx.search.models.SearchQuery.lang = lang

Definition at line 59 of file models.py.

Referenced by searx.search.models.SearchQuery.__copy__(), searx.search.models.SearchQuery.__eq__(), searx.search.models.SearchQuery.__hash__(), and searx.search.models.SearchQuery.__repr__().

◆ locale

searx.search.models.SearchQuery.locale = None

Definition at line 68 of file models.py.

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

◆ pageno

searx.search.models.SearchQuery.pageno = pageno

Definition at line 61 of file models.py.

Referenced by searx.search.models.SearchQuery.__copy__(), searx.search.models.SearchQuery.__eq__(), searx.search.models.SearchQuery.__hash__(), and searx.search.models.SearchQuery.__repr__().

◆ query

searx.search.models.SearchQuery.query = query

Definition at line 57 of file models.py.

Referenced by searx.search.models.SearchQuery.__copy__(), searx.search.models.SearchQuery.__eq__(), searx.search.models.SearchQuery.__hash__(), searx.search.models.SearchQuery.__repr__(), searx.query.RawTextQuery._parse_query(), and searx.query.RawTextQuery.changeQuery().

◆ redirect_to_first_result

searx.search.models.SearchQuery.redirect_to_first_result = redirect_to_first_result

Definition at line 66 of file models.py.

Referenced by searx.search.models.SearchQuery.__copy__(), searx.search.models.SearchQuery.__eq__(), searx.search.models.SearchQuery.__hash__(), and searx.search.models.SearchQuery.__repr__().

◆ safesearch

searx.search.models.SearchQuery.safesearch = safesearch

Definition at line 60 of file models.py.

Referenced by searx.search.models.SearchQuery.__copy__(), searx.search.models.SearchQuery.__eq__(), searx.search.models.SearchQuery.__hash__(), and searx.search.models.SearchQuery.__repr__().

◆ time_range

searx.search.models.SearchQuery.time_range = time_range

Definition at line 62 of file models.py.

Referenced by searx.search.models.SearchQuery.__copy__(), searx.search.models.SearchQuery.__eq__(), searx.search.models.SearchQuery.__hash__(), and searx.search.models.SearchQuery.__repr__().

◆ timeout_limit

searx.search.models.SearchQuery.timeout_limit = timeout_limit

Definition at line 63 of file models.py.

Referenced by searx.search.models.SearchQuery.__copy__(), searx.search.models.SearchQuery.__eq__(), searx.search.models.SearchQuery.__hash__(), and searx.search.models.SearchQuery.__repr__().

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

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

searx
search
models
SearchQuery
Generated on Sat Nov 16 2024 00:10:58 for .oO SearXNG Developer Documentation Oo. by 1.12.0