searx.engines.yep Namespace Reference

Functions
	request (query, params)
	_web_result (result)
	_images_result (result)
	_news_result (result)
	response (resp)

Variables
dict	about
str	base_url = "https://api.yep.com"
str	search_type = "web"
bool	safesearch = True
dict	safesearch_map = {0: 'off', 1: 'moderate', 2: 'strict'}

Detailed Description

Yep (general, images, news)

Function Documentation

_images_result()

searx.engines.yep._images_result ( result )

protected

Definition at line 45 of file yep.py.

def _images_result(result):
    return {
        'template': 'images.html',
        'url': result['host_page'],
        'title': result.get('title', ''),
        'content': '',
        'img_src': result['image_id'],
        'thumbnail_src': result['src'],
    }
 
 

Referenced by searx.engines.yep.response().

Here is the caller graph for this function:

_news_result()

searx.engines.yep._news_result ( result )

protected

Definition at line 56 of file yep.py.

def _news_result(result):
    return {
        'url': result['url'],
        'title': result['title'],
        'content': html_to_text(result['snippet']),
        'publishedDate': datetime.strptime(result['first_seen'][:19], '%Y-%m-%dT%H:%M:%S'),
    }
 
 

Referenced by searx.engines.yep.response().

Here is the caller graph for this function:

_web_result()

searx.engines.yep._web_result ( result )

protected

Definition at line 37 of file yep.py.

def _web_result(result):
    return {
        'url': result['url'],
        'title': result['title'],
        'content': html_to_text(result['snippet']),
    }
 
 

Referenced by searx.engines.yep.response().

Here is the caller graph for this function:

request()

searx.engines.yep.request	(		query,
			params )

Definition at line 24 of file yep.py.

def request(query, params):
    args = {
        'client': 'web',
        'no_correct': 'false',
        'q': query,
        'safeSearch': safesearch_map[params['safesearch']],
        'type': search_type,
    }
    params['url'] = f"{base_url}/fs/2/search?{urlencode(args)}"
    params['headers']['Referer'] = 'https://yep.com/'
    return params
 
 

response()

searx.engines.yep.response

(

resp

)

Definition at line 65 of file yep.py.

def response(resp):
    results = []
 
    for result in resp.json()[1]['results']:
        if search_type == "web":
            if result['type'] != 'Organic':
                continue
            results.append(_web_result(result))
        elif search_type == "images":
            results.append(_images_result(result))
        elif search_type == "news":
            results.append(_news_result(result))
        else:
            raise ValueError(f"Unsupported yep search type: {search_type}")
 
    return results

References searx.engines.yep._images_result(), searx.engines.yep._news_result(), and searx.engines.yep._web_result().

Here is the call graph for this function:

Variable Documentation

about

dict searx.engines.yep.about

Initial value:

=  {
    'website': 'https://yep.com/',
    'official_api_documentation': 'https://docs.developer.yelp.com',
    'use_official_api': False,
    'require_api_key': False,
    'results': 'JSON',
}

Definition at line 9 of file yep.py.

base_url

str searx.engines.yep.base_url = "https://api.yep.com"

Definition at line 17 of file yep.py.

safesearch

bool searx.engines.yep.safesearch = True

Definition at line 20 of file yep.py.

safesearch_map

dict searx.engines.yep.safesearch_map = {0: 'off', 1: 'moderate', 2: 'strict'}

Definition at line 21 of file yep.py.

search_type

str searx.engines.yep.search_type = "web"

Definition at line 18 of file yep.py.