.oO SearXNG Developer Documentation Oo.
Loading...
Searching...
No Matches
searx.engines.duckduckgo_extra Namespace Reference

Functions

 request (query, params)
 
 _image_result (result)
 
 _video_result (result)
 
 _news_result (result)
 
 response (resp)
 

Variables

logging logger .Logger
 
EngineTraits traits
 
dict about
 
list categories = ['images', 'web']
 
str ddg_category = 'images'
 
bool paging = True
 
bool safesearch = True
 
bool send_accept_language_header = True
 
dict safesearch_cookies = {0: '-2', 1: None, 2: '1'}
 
dict safesearch_args = {0: '1', 1: None, 2: '1'}
 
dict search_path_map = {'images': 'i', 'videos': 'v', 'news': 'news'}
 

Detailed Description

DuckDuckGo Extra (images, videos, news)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Function Documentation

◆ _image_result()

searx.engines.duckduckgo_extra._image_result ( result)
protected

Definition at line 91 of file duckduckgo_extra.py.

91def _image_result(result):
92 return {
93 'template': 'images.html',
94 'url': result['url'],
95 'title': result['title'],
96 'content': '',
97 'thumbnail_src': result['thumbnail'],
98 'img_src': result['image'],
99 'resolution': '%s x %s' % (result['width'], result['height']),
100 'source': result['source'],
101 }
102
103

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

+ Here is the caller graph for this function:

◆ _news_result()

searx.engines.duckduckgo_extra._news_result ( result)
protected

Definition at line 118 of file duckduckgo_extra.py.

118def _news_result(result):
119 return {
120 'url': result['url'],
121 'title': result['title'],
122 'content': result['excerpt'],
123 'source': result['source'],
124 'publishedDate': datetime.utcfromtimestamp(result['date']),
125 }
126
127

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

+ Here is the caller graph for this function:

◆ _video_result()

searx.engines.duckduckgo_extra._video_result ( result)
protected

Definition at line 104 of file duckduckgo_extra.py.

104def _video_result(result):
105 return {
106 'template': 'videos.html',
107 'url': result['content'],
108 'title': result['title'],
109 'content': result['description'],
110 'thumbnail': result['images'].get('small') or result['images'].get('medium'),
111 'iframe_src': result['embed_url'],
112 'source': result['provider'],
113 'length': result['duration'],
114 'metadata': result.get('uploader'),
115 }
116
117

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

+ Here is the caller graph for this function:

◆ request()

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

Definition at line 49 of file duckduckgo_extra.py.

49def request(query, params):
50
51 # request needs a vqd argument
52 vqd = get_vqd(query)
53 if not vqd:
54 # some search terms do not have results and therefore no vqd value
55 params['url'] = None
56 return params
57
58 eng_region = traits.get_region(params['searxng_locale'], traits.all_locale)
59 eng_lang = get_ddg_lang(traits, params['searxng_locale'])
60
61 args = {
62 'q': query,
63 'o': 'json',
64 # 'u': 'bing',
65 'l': eng_region,
66 'f': ',,,,,',
67 'vqd': vqd,
68 }
69
70 if params['pageno'] > 1:
71 args['s'] = (params['pageno'] - 1) * 100
72
73 params['cookies']['ad'] = eng_lang # zh_CN
74 params['cookies']['ah'] = eng_region # "us-en,de-de"
75 params['cookies']['l'] = eng_region # "hk-tzh"
76
77 safe_search = safesearch_cookies.get(params['safesearch'])
78 if safe_search is not None:
79 params['cookies']['p'] = safe_search # "-2", "1"
80 safe_search = safesearch_args.get(params['safesearch'])
81 if safe_search is not None:
82 args['p'] = safe_search # "-1", "1"
83
84 logger.debug("cookies: %s", params['cookies'])
85
86 params['url'] = f'https://duckduckgo.com/{search_path_map[ddg_category]}.js?{urlencode(args)}'
87
88 return params
89
90

◆ response()

searx.engines.duckduckgo_extra.response ( resp)

Definition at line 128 of file duckduckgo_extra.py.

128def response(resp):
129 results = []
130 res_json = resp.json()
131
132 for result in res_json['results']:
133 if ddg_category == 'images':
134 results.append(_image_result(result))
135 elif ddg_category == 'videos':
136 results.append(_video_result(result))
137 elif ddg_category == 'news':
138 results.append(_news_result(result))
139 else:
140 raise ValueError(f"Invalid duckduckgo category: {ddg_category}")
141
142 return results

References searx.engines.duckduckgo_extra._image_result(), searx.engines.duckduckgo_extra._news_result(), and searx.engines.duckduckgo_extra._video_result().

+ Here is the call graph for this function:

Variable Documentation

◆ about

dict searx.engines.duckduckgo_extra.about
Initial value:
1= {
2 "website": 'https://duckduckgo.com/',
3 "wikidata_id": 'Q12805',
4 "use_official_api": False,
5 "require_api_key": False,
6 "results": 'JSON (site requires js to get images)',
7}

Definition at line 26 of file duckduckgo_extra.py.

◆ categories

list searx.engines.duckduckgo_extra.categories = ['images', 'web']

Definition at line 35 of file duckduckgo_extra.py.

◆ ddg_category

str searx.engines.duckduckgo_extra.ddg_category = 'images'

Definition at line 36 of file duckduckgo_extra.py.

◆ logger

logging searx.engines.duckduckgo_extra.logger .Logger

Definition at line 21 of file duckduckgo_extra.py.

◆ paging

bool searx.engines.duckduckgo_extra.paging = True

Definition at line 39 of file duckduckgo_extra.py.

◆ safesearch

bool searx.engines.duckduckgo_extra.safesearch = True

Definition at line 40 of file duckduckgo_extra.py.

◆ safesearch_args

dict searx.engines.duckduckgo_extra.safesearch_args = {0: '1', 1: None, 2: '1'}

Definition at line 44 of file duckduckgo_extra.py.

◆ safesearch_cookies

dict searx.engines.duckduckgo_extra.safesearch_cookies = {0: '-2', 1: None, 2: '1'}

Definition at line 43 of file duckduckgo_extra.py.

◆ search_path_map

dict searx.engines.duckduckgo_extra.search_path_map = {'images': 'i', 'videos': 'v', 'news': 'news'}

Definition at line 46 of file duckduckgo_extra.py.

◆ send_accept_language_header

bool searx.engines.duckduckgo_extra.send_accept_language_header = True

Definition at line 41 of file duckduckgo_extra.py.

◆ traits

EngineTraits searx.engines.duckduckgo_extra.traits

Definition at line 23 of file duckduckgo_extra.py.