Public Member Functions
	__init__ (self, TestResults test_results, str test_name, SearchQuery search_query, ResultContainer result_container)
	result_urls (self)
	check_basic (self)
	has_infobox (self)
	has_answer (self)
	has_language (self, lang)
	not_empty (self)
	one_title_contains (self, str title)

Public Attributes
	test_name = test_name
	search_query = search_query
	result_container = result_container
typing.Set[str]	languages = set()
	test_results = test_results
bool	stop_test = False

Protected Member Functions
None	_record_error (self, str message, *args)
typing.Optional[str]	_add_language (self, str text)
	_check_result (self, result)
	_check_results (self, list results)
	_check_answers (self, answers)
	_check_infoboxes (self, infoboxes)

Static Private Attributes
str	__slots__ = 'test_name', 'search_query', 'result_container', 'languages', 'stop_test', 'test_results'

Detailed Description

Definition at line 185 of file impl.py.

Constructor & Destructor Documentation

◆ init()

searx.search.checker.impl.ResultContainerTests.__init__	(		self,
		TestResults	test_results,
		str	test_name,
		SearchQuery	search_query,
		ResultContainer	result_container )

Definition at line 189 of file impl.py.

    ):
        self.test_name = test_name
        self.search_query = search_query
        self.result_container = result_container
        self.languages: typing.Set[str] = set()
        self.test_results = test_results
        self.stop_test = False
 

Member Function Documentation

◆ _add_language()

typing.Optional[str] searx.search.checker.impl.ResultContainerTests._add_language	(		self,
		str	text )

protected

Definition at line 209 of file impl.py.

    def _add_language(self, text: str) -> typing.Optional[str]:
        langStr = detect_language(text)
        if langStr:
            self.languages.add(langStr)
            self.test_results.add_language(langStr)
 

References searx.enginelib.traits.EngineTraits.languages, searx.query.RawTextQuery.languages, languages, searx.search.checker.impl.TestResults.languages, and test_results.

Referenced by _check_infoboxes(), and _check_result().

Here is the caller graph for this function:

◆ _check_answers()

searx.search.checker.impl.ResultContainerTests._check_answers	(		self,
			answers )

protected

Definition at line 249 of file impl.py.

    def _check_answers(self, answers):
        for answer in answers:
            if not _check_no_html(answer):
                self._record_error('HTML in answer', answer)
 

References searx.search.checker.impl._check_no_html, and _record_error().

Referenced by check_basic().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _check_infoboxes()

searx.search.checker.impl.ResultContainerTests._check_infoboxes	(		self,
			infoboxes )

protected

Definition at line 254 of file impl.py.

    def _check_infoboxes(self, infoboxes):
        for infobox in infoboxes:
            if not _check_no_html(infobox.get('content', '')):
                self._record_error('HTML in infobox content', infobox.get('content', ''))
            self._add_language(infobox.get('content', ''))
            for attribute in infobox.get('attributes', {}):
                if not _check_no_html(attribute.get('value', '')):
                    self._record_error('HTML in infobox attribute value', attribute.get('value', ''))
 

References _add_language(), searx.search.checker.impl._check_no_html, and _record_error().

Referenced by check_basic().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _check_result()

searx.search.checker.impl.ResultContainerTests._check_result	(		self,
			result )

protected

Definition at line 215 of file impl.py.

    def _check_result(self, result):
        if not _check_no_html(result.get('title', '')):
            self._record_error('HTML in title', repr(result.get('title', '')))
        if not _check_no_html(result.get('content', '')):
            self._record_error('HTML in content', repr(result.get('content', '')))
        if result.get('url') is None:
            self._record_error('url is None')
 
        self._add_language(result.get('title', ''))
        self._add_language(result.get('content', ''))
 
        template = result.get('template', 'default.html')
        if template == 'default.html':
            return
        if template == 'code.html':
            return
        if template == 'torrent.html':
            return
        if template == 'map.html':
            return
        if template == 'images.html':
            thumbnail_src = result.get('thumbnail_src')
            if thumbnail_src is not None:
                if not _is_url_image(thumbnail_src):
                    self._record_error('thumbnail_src URL is invalid', thumbnail_src)
            elif not _is_url_image(result.get('img_src')):
                self._record_error('img_src URL is invalid', result.get('img_src'))
        if template == 'videos.html' and not _is_url_image(result.get('thumbnail')):
            self._record_error('thumbnail URL is invalid', result.get('img_src'))
 

References _add_language(), searx.search.checker.impl._check_no_html, searx.search.checker.impl._is_url_image(), and _record_error().

Referenced by _check_results().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _check_results()

searx.search.checker.impl.ResultContainerTests._check_results	(		self,
		list	results )

protected

Definition at line 245 of file impl.py.

    def _check_results(self, results: list):
        for result in results:
            self._check_result(result)
 

References _check_result().

Referenced by check_basic().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _record_error()

None searx.search.checker.impl.ResultContainerTests._record_error	(		self,
		str	message,
		*	args )

protected

Definition at line 204 of file impl.py.

    def _record_error(self, message: str, *args) -> None:
        sq = _search_query_to_dict(self.search_query)
        sqstr = ' '.join(['{}={!r}'.format(k, v) for k, v in sq.items()])
        self.test_results.add_error(self.test_name, message, *args, '(' + sqstr + ')')
 

References searx.search.checker.impl._search_query_to_dict(), search_query, searx.search.Search.search_query, test_name, and test_results.

Referenced by _check_answers(), _check_infoboxes(), _check_result(), check_basic(), and has_infobox().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ check_basic()

searx.search.checker.impl.ResultContainerTests.check_basic ( self )

Definition at line 263 of file impl.py.

    def check_basic(self):
        if len(self.result_container.unresponsive_engines) > 0:
            for message in self.result_container.unresponsive_engines:
                self._record_error(message[1] + ' ' + (message[2] or ''))
            self.stop_test = True
            return
 
        results = self.result_container.get_ordered_results()
        if len(results) > 0:
            self._check_results(results)
 
        if len(self.result_container.answers) > 0:
            self._check_answers(self.result_container.answers)
 
        if len(self.result_container.infoboxes) > 0:
            self._check_infoboxes(self.result_container.infoboxes)
 

References _check_answers(), _check_infoboxes(), _check_results(), _record_error(), result_container, searx.search.Search.result_container, and stop_test.

Here is the call graph for this function:

◆ has_answer()

searx.search.checker.impl.ResultContainerTests.has_answer ( self )

Check the ResultContainer has at least one answer

Definition at line 285 of file impl.py.

    def has_answer(self):
        """Check the ResultContainer has at least one answer"""
        if len(self.result_container.answers) == 0:
            self._record_error('No answer')
 

◆ has_infobox()

searx.search.checker.impl.ResultContainerTests.has_infobox ( self )

Check the ResultContainer has at least one infobox

Definition at line 280 of file impl.py.

    def has_infobox(self):
        """Check the ResultContainer has at least one infobox"""
        if len(self.result_container.infoboxes) == 0:
            self._record_error('No infobox')
 

References _record_error(), result_container, and searx.search.Search.result_container.

Here is the call graph for this function:

◆ has_language()

searx.search.checker.impl.ResultContainerTests.has_language	(		self,
			lang )

Check at least one title or content of the results is written in the `lang`.

Detected using pycld3, may be not accurate

Definition at line 290 of file impl.py.

    def has_language(self, lang):
        """Check at least one title or content of the results is written in the `lang`.
 
        Detected using pycld3, may be not accurate"""
        if lang not in self.languages:
            self._record_error(lang + ' not found')
 

◆ not_empty()

searx.search.checker.impl.ResultContainerTests.not_empty ( self )

Check the ResultContainer has at least one answer or infobox or result

Definition at line 297 of file impl.py.

    def not_empty(self):
        """Check the ResultContainer has at least one answer or infobox or result"""
        result_types = set()
        results = self.result_container.get_ordered_results()
        if len(results) > 0:
            result_types.add('results')
 
        if len(self.result_container.answers) > 0:
            result_types.add('answers')
 
        if len(self.result_container.infoboxes) > 0:
            result_types.add('infoboxes')
 
        if len(result_types) == 0:
            self._record_error('No result')
 

◆ one_title_contains()

searx.search.checker.impl.ResultContainerTests.one_title_contains	(		self,
		str	title )

Check one of the title contains `title` (case insensitive comparison)

Definition at line 313 of file impl.py.

    def one_title_contains(self, title: str):
        """Check one of the title contains `title` (case insensitive comparison)"""
        title = title.lower()
        for result in self.result_container.get_ordered_results():
            if title in result['title'].lower():
                return
        self._record_error(('{!r} not found in the title'.format(title)))
 
 

◆ result_urls()

searx.search.checker.impl.ResultContainerTests.result_urls ( self )

Definition at line 200 of file impl.py.

    def result_urls(self):
        results = self.result_container.get_ordered_results()
        return [result['url'] for result in results if 'url' in result]
 

References result_container, and searx.search.Search.result_container.

Member Data Documentation

◆ slots

str searx.search.checker.impl.ResultContainerTests.__slots__ = 'test_name', 'search_query', 'result_container', 'languages', 'stop_test', 'test_results'

staticprivate

Definition at line 187 of file impl.py.

◆ languages

typing.Set[str] searx.search.checker.impl.ResultContainerTests.languages = set()

Definition at line 195 of file impl.py.

Referenced by _add_language().

◆ result_container

searx.search.checker.impl.ResultContainerTests.result_container = result_container

Definition at line 194 of file impl.py.

Referenced by check_basic(), has_infobox(), and result_urls().

◆ search_query

searx.search.checker.impl.ResultContainerTests.search_query = search_query

Definition at line 193 of file impl.py.

Referenced by _record_error().

◆ stop_test

bool searx.search.checker.impl.ResultContainerTests.stop_test = False

Definition at line 197 of file impl.py.

Referenced by check_basic().

◆ test_name

searx.search.checker.impl.ResultContainerTests.test_name = test_name

Definition at line 192 of file impl.py.

Referenced by _record_error().

◆ test_results

searx.search.checker.impl.ResultContainerTests.test_results = test_results

Definition at line 196 of file impl.py.

Referenced by _add_language(), and _record_error().

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

/home/andrew/Documents/code/public/searxng/searx/search/checker/impl.py

Public Member Functions

Public Attributes

Protected Member Functions

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ _add_language()

◆ _check_answers()

◆ _check_infoboxes()

◆ _check_result()

◆ _check_results()

◆ _record_error()

◆ check_basic()

◆ has_answer()

◆ has_infobox()

◆ has_language()

◆ not_empty()

◆ one_title_contains()

◆ result_urls()

Member Data Documentation

◆ __slots__

◆ languages

◆ result_container

◆ search_query

◆ stop_test

◆ test_name

◆ test_results

◆ init()

◆ slots