Public Member Functions
	__init__ (self, str query, list disabled_engines)

	get_autocomplete_full_query (self, text)

	changeQuery (self, query)

	getQuery (self)

	getFullQuery (self)

	__str__ (self)

	__repr__ (self)

Public Attributes
	query = query

	disabled_engines = disabled_engines if disabled_engines else []

list	enginerefs = []

list	languages = []

	timeout_limit = None

	external_bang = None

bool	specific = False

list	autocomplete_list = []

list	query_parts = []

list	user_query_parts = []

tuple	autocomplete_location = None

bool	redirect_to_first_result = False

Static Public Attributes
list	PARSER_CLASSES

Protected Member Functions
	_parse_query (self)

Detailed Description

parse raw text query (the value from the html input)

Definition at line 251 of file query.py.

Constructor & Destructor Documentation

◆ init()

searx.query.RawTextQuery.__init__	(		self,
		str	query,
		list	disabled_engines )

Definition at line 262 of file query.py.

    def __init__(self, query: str, disabled_engines: list):
        assert isinstance(query, str)
        # input parameters
        self.query = query
        self.disabled_engines = disabled_engines if disabled_engines else []
        # parsed values
        self.enginerefs = []
        self.languages = []
        self.timeout_limit = None
        self.external_bang = None
        self.specific = False
        self.autocomplete_list = []
        # internal properties
        self.query_parts = []  # use self.getFullQuery()
        self.user_query_parts = []  # use self.getQuery()
        self.autocomplete_location = None
        self.redirect_to_first_result = False
        self._parse_query()
 

Member Function Documentation

◆ repr()

searx.query.RawTextQuery.__repr__ ( self )

Definition at line 336 of file query.py.

    def __repr__(self):
        return (
            f"<{self.__class__.__name__} "
            + f"query={self.query!r} "
            + f"disabled_engines={self.disabled_engines!r}\n  "
            + f"languages={self.languages!r} "
            + f"timeout_limit={self.timeout_limit!r} "
            + f"external_bang={self.external_bang!r} "
            + f"specific={self.specific!r} "
            + f"enginerefs={self.enginerefs!r}\n  "
            + f"autocomplete_list={self.autocomplete_list!r}\n  "
            + f"query_parts={self.query_parts!r}\n  "
            + f"user_query_parts={self.user_query_parts!r} >\n"
            + f"redirect_to_first_result={self.redirect_to_first_result!r}"
        )

◆ str()

searx.query.RawTextQuery.__str__ ( self )

Definition at line 333 of file query.py.

    def __str__(self):
        return self.getFullQuery()
 

References searx.query.RawTextQuery.getFullQuery().

Here is the call graph for this function:

◆ _parse_query()

searx.query.RawTextQuery._parse_query ( self )

protected

parse self.query, if tags are set, which
change the search engine or search-language

Definition at line 281 of file query.py.

    def _parse_query(self):
        """
        parse self.query, if tags are set, which
        change the search engine or search-language
        """
 
        # split query, including whitespaces
        raw_query_parts = re.split(r'(\s+)', self.query)
 
        last_index_location = None
        autocomplete_index = len(raw_query_parts) - 1
 
        for i, query_part in enumerate(raw_query_parts):
            # part does only contain spaces, skip
            if query_part.isspace() or query_part == '':
                continue
 
            # parse special commands
            special_part = False
            for parser_class in RawTextQuery.PARSER_CLASSES:
                if parser_class.check(query_part):
                    special_part = parser_class(self, i == autocomplete_index)(query_part)
                    break
 
            # append query part to query_part list
            qlist = self.query_parts if special_part else self.user_query_parts
            qlist.append(query_part)
            last_index_location = (qlist, len(qlist) - 1)
 
        self.autocomplete_location = last_index_location
 

References searx.query.RawTextQuery.autocomplete_location, searx.query.RawTextQuery.query, searx.search.models.SearchQuery.query, searx.query.RawTextQuery.query_parts, and searx.query.RawTextQuery.user_query_parts.

◆ changeQuery()

searx.query.RawTextQuery.changeQuery	(		self,
			query )

Definition at line 317 of file query.py.

    def changeQuery(self, query):
        self.user_query_parts = query.strip().split()
        self.query = self.getFullQuery()
        self.autocomplete_location = (self.user_query_parts, len(self.user_query_parts) - 1)
        self.autocomplete_list = []
        return self
 

References searx.query.RawTextQuery.autocomplete_list, searx.query.RawTextQuery.autocomplete_location, searx.query.RawTextQuery.getFullQuery(), searx.query.RawTextQuery.query, searx.search.models.SearchQuery.query, and searx.query.RawTextQuery.user_query_parts.

Here is the call graph for this function:

◆ get_autocomplete_full_query()

searx.query.RawTextQuery.get_autocomplete_full_query	(		self,
			text )

Definition at line 312 of file query.py.

    def get_autocomplete_full_query(self, text):
        qlist, position = self.autocomplete_location
        qlist[position] = text
        return self.getFullQuery()
 

References searx.query.RawTextQuery.autocomplete_location, and searx.query.RawTextQuery.getFullQuery().

Here is the call graph for this function:

◆ getFullQuery()

searx.query.RawTextQuery.getFullQuery ( self )

get full query including whitespaces

Definition at line 327 of file query.py.

    def getFullQuery(self):
        """
        get full query including whitespaces
        """
        return '{0} {1}'.format(' '.join(self.query_parts), self.getQuery()).strip()
 

References searx.format, searx.query.RawTextQuery.getQuery(), and searx.query.RawTextQuery.query_parts.

Referenced by searx.query.RawTextQuery.__str__(), searx.query.RawTextQuery.changeQuery(), and searx.query.RawTextQuery.get_autocomplete_full_query().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getQuery()

searx.query.RawTextQuery.getQuery ( self )

Definition at line 324 of file query.py.

    def getQuery(self):
        return ' '.join(self.user_query_parts)
 

References searx.query.RawTextQuery.user_query_parts.

Referenced by searx.query.RawTextQuery.getFullQuery().

Here is the caller graph for this function:

Member Data Documentation

◆ autocomplete_list

list searx.query.RawTextQuery.autocomplete_list = []

Definition at line 273 of file query.py.

Referenced by searx.query.RawTextQuery.changeQuery().

◆ autocomplete_location

tuple searx.query.RawTextQuery.autocomplete_location = None

Definition at line 277 of file query.py.

Referenced by searx.query.RawTextQuery._parse_query(), searx.query.RawTextQuery.changeQuery(), and searx.query.RawTextQuery.get_autocomplete_full_query().

◆ disabled_engines

searx.query.RawTextQuery.disabled_engines = disabled_engines if disabled_engines else []

Definition at line 266 of file query.py.

◆ enginerefs

list searx.query.RawTextQuery.enginerefs = []

Definition at line 268 of file query.py.

◆ external_bang

searx.query.RawTextQuery.external_bang = None

Definition at line 271 of file query.py.

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

◆ languages

list searx.query.RawTextQuery.languages = []

Definition at line 269 of file query.py.

Referenced by searx.search.checker.impl.ResultContainerTests._add_language(), searx.search.checker.impl.TestResults.add_language(), and searx.enginelib.traits.EngineTraits.get_language().

◆ PARSER_CLASSES

list searx.query.RawTextQuery.PARSER_CLASSES

static

Initial value:

=  [
        TimeoutParser,  # force the timeout
        LanguageParser,  # force a language
        ExternalBangParser,  # external bang (must be before BangParser)
        BangParser,  # force an engine or category
        FeelingLuckyParser,  # redirect to the first link in the results list
    ]

Definition at line 254 of file query.py.

◆ query

searx.query.RawTextQuery.query = query

Definition at line 265 of file query.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().

◆ query_parts

searx.query.RawTextQuery.query_parts = []

Definition at line 275 of file query.py.

Referenced by searx.query.RawTextQuery._parse_query(), and searx.query.RawTextQuery.getFullQuery().

◆ redirect_to_first_result

bool searx.query.RawTextQuery.redirect_to_first_result = False

Definition at line 278 of file query.py.

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

◆ specific

bool searx.query.RawTextQuery.specific = False

Definition at line 272 of file query.py.

◆ timeout_limit

searx.query.RawTextQuery.timeout_limit = None

Definition at line 270 of file query.py.

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

◆ user_query_parts

searx.query.RawTextQuery.user_query_parts = []

Definition at line 276 of file query.py.

Referenced by searx.query.RawTextQuery._parse_query(), searx.query.RawTextQuery.changeQuery(), and searx.query.RawTextQuery.getQuery().

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

/home/andrew/Documents/code/public/searxng/searx/query.py

Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ __repr__()

◆ __str__()

◆ _parse_query()

◆ changeQuery()

◆ get_autocomplete_full_query()

◆ getFullQuery()

◆ getQuery()

Member Data Documentation

◆ autocomplete_list

◆ autocomplete_location

◆ disabled_engines

◆ enginerefs

◆ external_bang

◆ languages

◆ PARSER_CLASSES

◆ query

◆ query_parts

◆ redirect_to_first_result

◆ specific

◆ timeout_limit

◆ user_query_parts

◆ init()

◆ repr()

◆ str()