searx.query.BangParser Class Reference

Inheritance diagram for searx.query.BangParser:

Collaboration diagram for searx.query.BangParser:

Public Member Functions
	__call__ (self, raw_value)
Public Member Functions inherited from searx.query.QueryPartParser
	__init__ (self, raw_text_query, enable_autocomplete)

Static Public Member Functions
	check (raw_value)
Static Public Member Functions inherited from searx.query.QueryPartParser

Public Attributes
	enable_autocomplete
Public Attributes inherited from searx.query.QueryPartParser
	raw_text_query = raw_text_query
	enable_autocomplete = enable_autocomplete

Protected Member Functions
	_parse (self, value)
	_autocomplete (self, first_char, value)
Protected Member Functions inherited from searx.query.QueryPartParser
	_add_autocomplete (self, value)

Detailed Description

Definition at line 179 of file query.py.

Member Function Documentation

__call__()

searx.query.BangParser.__call__	(		self,
			raw_value )

Try to parse raw_value: set the self.raw_text_query properties

return True if raw_value has been parsed

self.raw_text_query.autocomplete_list is also modified
if self.enable_autocomplete is True

Reimplemented from searx.query.QueryPartParser.

Definition at line 185 of file query.py.

    def __call__(self, raw_value):
        value = raw_value[1:].replace('-', ' ').replace('_', ' ')
        found = self._parse(value) if len(value) > 0 else False
        if found and raw_value[0] == '!':
            self.raw_text_query.specific = True
        if self.enable_autocomplete:
            self._autocomplete(raw_value[0], value)
        return found
 

References searx.query.BangParser._parse(), searx.query.ExternalBangParser._parse(), searx.query.LanguageParser._parse(), searx.query.TimeoutParser._parse(), and searx.query.QueryPartParser.raw_text_query.

Here is the call graph for this function:

_autocomplete()

searx.query.BangParser._autocomplete ( self, first_char, value )

protected

Definition at line 217 of file query.py.

    def _autocomplete(self, first_char, value):
        if not value:
            # show some example queries
            for suggestion in ['images', 'wikipedia', 'osm']:
                if suggestion not in self.raw_text_query.disabled_engines or suggestion in categories:
                    self._add_autocomplete(first_char + suggestion)
            return
 
        # check if query starts with category name
        for category in categories:
            if category.startswith(value):
                self._add_autocomplete(first_char + category.replace(' ', '_'))
 
        # check if query starts with engine name
        for engine in engines:
            if engine.startswith(value):
                self._add_autocomplete(first_char + engine.replace(' ', '_'))
 
        # check if query starts with engine shortcut
        for engine_shortcut in engine_shortcuts:
            if engine_shortcut.startswith(value):
                self._add_autocomplete(first_char + engine_shortcut)
 
 

References searx.query.QueryPartParser._add_autocomplete(), and searx.query.QueryPartParser.raw_text_query.

Referenced by searx.query.LanguageParser.__call__(), and searx.query.TimeoutParser.__call__().

Here is the call graph for this function:

Here is the caller graph for this function:

_parse()

searx.query.BangParser._parse ( self, value )

protected

Definition at line 194 of file query.py.

    def _parse(self, value):
        # check if prefix is equal with engine shortcut
        if value in engine_shortcuts:  # pylint: disable=consider-using-get
            value = engine_shortcuts[value]
 
        # check if prefix is equal with engine name
        if value in engines:
            self.raw_text_query.enginerefs.append(EngineRef(value, 'none'))
            return True
 
        # check if prefix is equal with category name
        if value in categories:
            # using all engines for that search, which
            # are declared under that category name
            self.raw_text_query.enginerefs.extend(
                EngineRef(engine.name, value)
                for engine in categories[value]
                if (engine.name, value) not in self.raw_text_query.disabled_engines
            )
            return True
 
        return False
 

References searx.query.QueryPartParser.raw_text_query.

Referenced by searx.query.BangParser.__call__(), searx.query.ExternalBangParser.__call__(), searx.query.LanguageParser.__call__(), and searx.query.TimeoutParser.__call__().

Here is the caller graph for this function:

check()

searx.query.BangParser.check ( raw_value )

static

Check if raw_value can be parsed

Reimplemented from searx.query.QueryPartParser.

Definition at line 181 of file query.py.

    def check(raw_value):
        # make sure it's not any bang with double '!!'
        return raw_value[0] == '!' and (len(raw_value) < 2 or raw_value[1] != '!')
 

Member Data Documentation

enable_autocomplete

searx.query.BangParser.enable_autocomplete

Definition at line 190 of file query.py.

Referenced by searx.query.LanguageParser.__call__(), and searx.query.TimeoutParser.__call__().

---

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

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