webscout 8.3.6__py3-none-any.whl → 2025.10.11__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Potentially problematic release.


This version of webscout might be problematic. Click here for more details.

Files changed (304) hide show
  1. webscout/AIauto.py +250 -250
  2. webscout/AIbase.py +379 -379
  3. webscout/AIutel.py +60 -58
  4. webscout/Bard.py +1012 -1012
  5. webscout/Bing_search.py +417 -417
  6. webscout/DWEBS.py +529 -529
  7. webscout/Extra/Act.md +309 -309
  8. webscout/Extra/GitToolkit/__init__.py +10 -10
  9. webscout/Extra/GitToolkit/gitapi/README.md +110 -110
  10. webscout/Extra/GitToolkit/gitapi/__init__.py +11 -11
  11. webscout/Extra/GitToolkit/gitapi/repository.py +195 -195
  12. webscout/Extra/GitToolkit/gitapi/user.py +96 -96
  13. webscout/Extra/GitToolkit/gitapi/utils.py +61 -61
  14. webscout/Extra/YTToolkit/README.md +375 -375
  15. webscout/Extra/YTToolkit/YTdownloader.py +956 -956
  16. webscout/Extra/YTToolkit/__init__.py +2 -2
  17. webscout/Extra/YTToolkit/transcriber.py +475 -475
  18. webscout/Extra/YTToolkit/ytapi/README.md +44 -44
  19. webscout/Extra/YTToolkit/ytapi/__init__.py +6 -6
  20. webscout/Extra/YTToolkit/ytapi/channel.py +307 -307
  21. webscout/Extra/YTToolkit/ytapi/errors.py +13 -13
  22. webscout/Extra/YTToolkit/ytapi/extras.py +118 -118
  23. webscout/Extra/YTToolkit/ytapi/https.py +88 -88
  24. webscout/Extra/YTToolkit/ytapi/patterns.py +61 -61
  25. webscout/Extra/YTToolkit/ytapi/playlist.py +58 -58
  26. webscout/Extra/YTToolkit/ytapi/pool.py +7 -7
  27. webscout/Extra/YTToolkit/ytapi/query.py +39 -39
  28. webscout/Extra/YTToolkit/ytapi/stream.py +62 -62
  29. webscout/Extra/YTToolkit/ytapi/utils.py +62 -62
  30. webscout/Extra/YTToolkit/ytapi/video.py +232 -232
  31. webscout/Extra/autocoder/__init__.py +9 -9
  32. webscout/Extra/autocoder/autocoder.py +1105 -1105
  33. webscout/Extra/autocoder/autocoder_utiles.py +332 -332
  34. webscout/Extra/gguf.md +429 -429
  35. webscout/Extra/gguf.py +1213 -1213
  36. webscout/Extra/tempmail/README.md +487 -487
  37. webscout/Extra/tempmail/__init__.py +27 -27
  38. webscout/Extra/tempmail/async_utils.py +140 -140
  39. webscout/Extra/tempmail/base.py +160 -160
  40. webscout/Extra/tempmail/cli.py +186 -186
  41. webscout/Extra/tempmail/emailnator.py +84 -84
  42. webscout/Extra/tempmail/mail_tm.py +360 -360
  43. webscout/Extra/tempmail/temp_mail_io.py +291 -291
  44. webscout/Extra/weather.md +281 -281
  45. webscout/Extra/weather.py +193 -193
  46. webscout/Litlogger/README.md +10 -10
  47. webscout/Litlogger/__init__.py +15 -15
  48. webscout/Litlogger/formats.py +13 -13
  49. webscout/Litlogger/handlers.py +121 -121
  50. webscout/Litlogger/levels.py +13 -13
  51. webscout/Litlogger/logger.py +134 -134
  52. webscout/Provider/AISEARCH/Perplexity.py +332 -332
  53. webscout/Provider/AISEARCH/README.md +279 -279
  54. webscout/Provider/AISEARCH/__init__.py +33 -11
  55. webscout/Provider/AISEARCH/felo_search.py +206 -206
  56. webscout/Provider/AISEARCH/genspark_search.py +323 -323
  57. webscout/Provider/AISEARCH/hika_search.py +185 -185
  58. webscout/Provider/AISEARCH/iask_search.py +410 -410
  59. webscout/Provider/AISEARCH/monica_search.py +219 -219
  60. webscout/Provider/AISEARCH/scira_search.py +316 -314
  61. webscout/Provider/AISEARCH/stellar_search.py +177 -177
  62. webscout/Provider/AISEARCH/webpilotai_search.py +255 -255
  63. webscout/Provider/Aitopia.py +314 -315
  64. webscout/Provider/Andi.py +3 -3
  65. webscout/Provider/Apriel.py +306 -0
  66. webscout/Provider/ChatGPTClone.py +236 -236
  67. webscout/Provider/ChatSandbox.py +343 -342
  68. webscout/Provider/Cloudflare.py +324 -324
  69. webscout/Provider/Cohere.py +208 -207
  70. webscout/Provider/Deepinfra.py +370 -369
  71. webscout/Provider/ExaAI.py +260 -260
  72. webscout/Provider/ExaChat.py +308 -387
  73. webscout/Provider/Flowith.py +221 -221
  74. webscout/Provider/GMI.py +293 -0
  75. webscout/Provider/Gemini.py +164 -162
  76. webscout/Provider/GeminiProxy.py +167 -166
  77. webscout/Provider/GithubChat.py +371 -370
  78. webscout/Provider/Groq.py +800 -800
  79. webscout/Provider/HeckAI.py +383 -379
  80. webscout/Provider/Jadve.py +282 -297
  81. webscout/Provider/K2Think.py +308 -0
  82. webscout/Provider/Koboldai.py +206 -384
  83. webscout/Provider/LambdaChat.py +423 -425
  84. webscout/Provider/Nemotron.py +244 -245
  85. webscout/Provider/Netwrck.py +248 -247
  86. webscout/Provider/OLLAMA.py +395 -394
  87. webscout/Provider/OPENAI/Cloudflare.py +394 -395
  88. webscout/Provider/OPENAI/FalconH1.py +452 -457
  89. webscout/Provider/OPENAI/FreeGemini.py +297 -299
  90. webscout/Provider/OPENAI/{monochat.py → K2Think.py} +432 -329
  91. webscout/Provider/OPENAI/NEMOTRON.py +241 -244
  92. webscout/Provider/OPENAI/PI.py +428 -427
  93. webscout/Provider/OPENAI/README.md +959 -959
  94. webscout/Provider/OPENAI/TogetherAI.py +345 -345
  95. webscout/Provider/OPENAI/TwoAI.py +466 -467
  96. webscout/Provider/OPENAI/__init__.py +33 -59
  97. webscout/Provider/OPENAI/ai4chat.py +313 -303
  98. webscout/Provider/OPENAI/base.py +249 -269
  99. webscout/Provider/OPENAI/chatglm.py +528 -0
  100. webscout/Provider/OPENAI/chatgpt.py +593 -588
  101. webscout/Provider/OPENAI/chatgptclone.py +521 -524
  102. webscout/Provider/OPENAI/chatsandbox.py +202 -177
  103. webscout/Provider/OPENAI/deepinfra.py +319 -315
  104. webscout/Provider/OPENAI/e2b.py +1665 -1665
  105. webscout/Provider/OPENAI/exaai.py +420 -420
  106. webscout/Provider/OPENAI/exachat.py +452 -452
  107. webscout/Provider/OPENAI/friendli.py +232 -232
  108. webscout/Provider/OPENAI/{refact.py → gmi.py} +324 -274
  109. webscout/Provider/OPENAI/groq.py +364 -364
  110. webscout/Provider/OPENAI/heckai.py +314 -311
  111. webscout/Provider/OPENAI/llmchatco.py +337 -337
  112. webscout/Provider/OPENAI/netwrck.py +355 -354
  113. webscout/Provider/OPENAI/oivscode.py +290 -290
  114. webscout/Provider/OPENAI/opkfc.py +518 -518
  115. webscout/Provider/OPENAI/pydantic_imports.py +1 -1
  116. webscout/Provider/OPENAI/scirachat.py +535 -529
  117. webscout/Provider/OPENAI/sonus.py +308 -308
  118. webscout/Provider/OPENAI/standardinput.py +442 -442
  119. webscout/Provider/OPENAI/textpollinations.py +340 -348
  120. webscout/Provider/OPENAI/toolbaz.py +419 -413
  121. webscout/Provider/OPENAI/typefully.py +362 -362
  122. webscout/Provider/OPENAI/utils.py +295 -295
  123. webscout/Provider/OPENAI/venice.py +436 -436
  124. webscout/Provider/OPENAI/wisecat.py +387 -387
  125. webscout/Provider/OPENAI/writecream.py +166 -166
  126. webscout/Provider/OPENAI/x0gpt.py +378 -378
  127. webscout/Provider/OPENAI/yep.py +389 -389
  128. webscout/Provider/OpenGPT.py +230 -230
  129. webscout/Provider/Openai.py +244 -496
  130. webscout/Provider/PI.py +405 -404
  131. webscout/Provider/Perplexitylabs.py +430 -431
  132. webscout/Provider/QwenLM.py +272 -254
  133. webscout/Provider/STT/__init__.py +32 -2
  134. webscout/Provider/{Llama3.py → Sambanova.py} +257 -258
  135. webscout/Provider/StandardInput.py +309 -309
  136. webscout/Provider/TTI/README.md +82 -82
  137. webscout/Provider/TTI/__init__.py +33 -12
  138. webscout/Provider/TTI/aiarta.py +413 -413
  139. webscout/Provider/TTI/base.py +136 -136
  140. webscout/Provider/TTI/bing.py +243 -243
  141. webscout/Provider/TTI/gpt1image.py +149 -149
  142. webscout/Provider/TTI/imagen.py +196 -196
  143. webscout/Provider/TTI/infip.py +211 -211
  144. webscout/Provider/TTI/magicstudio.py +232 -232
  145. webscout/Provider/TTI/monochat.py +219 -219
  146. webscout/Provider/TTI/piclumen.py +214 -214
  147. webscout/Provider/TTI/pixelmuse.py +232 -232
  148. webscout/Provider/TTI/pollinations.py +232 -232
  149. webscout/Provider/TTI/together.py +288 -288
  150. webscout/Provider/TTI/utils.py +12 -12
  151. webscout/Provider/TTI/venice.py +367 -367
  152. webscout/Provider/TTS/README.md +192 -192
  153. webscout/Provider/TTS/__init__.py +33 -10
  154. webscout/Provider/TTS/parler.py +110 -110
  155. webscout/Provider/TTS/streamElements.py +333 -333
  156. webscout/Provider/TTS/utils.py +280 -280
  157. webscout/Provider/TeachAnything.py +237 -236
  158. webscout/Provider/TextPollinationsAI.py +311 -318
  159. webscout/Provider/TogetherAI.py +356 -357
  160. webscout/Provider/TwoAI.py +313 -569
  161. webscout/Provider/TypliAI.py +312 -311
  162. webscout/Provider/UNFINISHED/ChatHub.py +208 -208
  163. webscout/Provider/UNFINISHED/ChutesAI.py +313 -313
  164. webscout/Provider/{GizAI.py → UNFINISHED/GizAI.py} +294 -294
  165. webscout/Provider/{Marcus.py → UNFINISHED/Marcus.py} +198 -198
  166. webscout/Provider/{Qodo.py → UNFINISHED/Qodo.py} +477 -477
  167. webscout/Provider/UNFINISHED/VercelAIGateway.py +338 -338
  168. webscout/Provider/{XenAI.py → UNFINISHED/XenAI.py} +324 -324
  169. webscout/Provider/UNFINISHED/Youchat.py +330 -330
  170. webscout/Provider/UNFINISHED/liner.py +334 -0
  171. webscout/Provider/UNFINISHED/liner_api_request.py +262 -262
  172. webscout/Provider/UNFINISHED/puterjs.py +634 -634
  173. webscout/Provider/UNFINISHED/samurai.py +223 -223
  174. webscout/Provider/UNFINISHED/test_lmarena.py +119 -119
  175. webscout/Provider/Venice.py +251 -250
  176. webscout/Provider/VercelAI.py +256 -255
  177. webscout/Provider/WiseCat.py +232 -231
  178. webscout/Provider/WrDoChat.py +367 -366
  179. webscout/Provider/__init__.py +33 -86
  180. webscout/Provider/ai4chat.py +174 -174
  181. webscout/Provider/akashgpt.py +331 -334
  182. webscout/Provider/cerebras.py +446 -340
  183. webscout/Provider/chatglm.py +394 -214
  184. webscout/Provider/cleeai.py +211 -212
  185. webscout/Provider/deepseek_assistant.py +1 -1
  186. webscout/Provider/elmo.py +282 -282
  187. webscout/Provider/geminiapi.py +208 -208
  188. webscout/Provider/granite.py +261 -261
  189. webscout/Provider/hermes.py +263 -265
  190. webscout/Provider/julius.py +223 -222
  191. webscout/Provider/learnfastai.py +309 -309
  192. webscout/Provider/llama3mitril.py +214 -214
  193. webscout/Provider/llmchat.py +243 -243
  194. webscout/Provider/llmchatco.py +290 -290
  195. webscout/Provider/meta.py +801 -801
  196. webscout/Provider/oivscode.py +309 -309
  197. webscout/Provider/scira_chat.py +384 -457
  198. webscout/Provider/searchchat.py +292 -291
  199. webscout/Provider/sonus.py +258 -258
  200. webscout/Provider/toolbaz.py +370 -364
  201. webscout/Provider/turboseek.py +274 -265
  202. webscout/Provider/typefully.py +208 -207
  203. webscout/Provider/x0gpt.py +1 -0
  204. webscout/Provider/yep.py +372 -371
  205. webscout/__init__.py +30 -31
  206. webscout/__main__.py +5 -5
  207. webscout/auth/api_key_manager.py +189 -189
  208. webscout/auth/config.py +175 -175
  209. webscout/auth/models.py +185 -185
  210. webscout/auth/routes.py +664 -664
  211. webscout/auth/simple_logger.py +236 -236
  212. webscout/cli.py +523 -523
  213. webscout/conversation.py +438 -438
  214. webscout/exceptions.py +361 -361
  215. webscout/litagent/Readme.md +298 -298
  216. webscout/litagent/__init__.py +28 -28
  217. webscout/litagent/agent.py +581 -581
  218. webscout/litagent/constants.py +59 -59
  219. webscout/litprinter/__init__.py +58 -58
  220. webscout/models.py +181 -181
  221. webscout/optimizers.py +419 -419
  222. webscout/prompt_manager.py +288 -288
  223. webscout/sanitize.py +1078 -1078
  224. webscout/scout/README.md +401 -401
  225. webscout/scout/__init__.py +8 -8
  226. webscout/scout/core/__init__.py +6 -6
  227. webscout/scout/core/crawler.py +297 -297
  228. webscout/scout/core/scout.py +706 -706
  229. webscout/scout/core/search_result.py +95 -95
  230. webscout/scout/core/text_analyzer.py +62 -62
  231. webscout/scout/core/text_utils.py +277 -277
  232. webscout/scout/core/web_analyzer.py +51 -51
  233. webscout/scout/element.py +599 -599
  234. webscout/scout/parsers/__init__.py +69 -69
  235. webscout/scout/parsers/html5lib_parser.py +172 -172
  236. webscout/scout/parsers/html_parser.py +236 -236
  237. webscout/scout/parsers/lxml_parser.py +178 -178
  238. webscout/scout/utils.py +37 -37
  239. webscout/swiftcli/Readme.md +323 -323
  240. webscout/swiftcli/__init__.py +95 -95
  241. webscout/swiftcli/core/__init__.py +7 -7
  242. webscout/swiftcli/core/cli.py +308 -308
  243. webscout/swiftcli/core/context.py +104 -104
  244. webscout/swiftcli/core/group.py +241 -241
  245. webscout/swiftcli/decorators/__init__.py +28 -28
  246. webscout/swiftcli/decorators/command.py +221 -221
  247. webscout/swiftcli/decorators/options.py +220 -220
  248. webscout/swiftcli/decorators/output.py +302 -302
  249. webscout/swiftcli/exceptions.py +21 -21
  250. webscout/swiftcli/plugins/__init__.py +9 -9
  251. webscout/swiftcli/plugins/base.py +135 -135
  252. webscout/swiftcli/plugins/manager.py +269 -269
  253. webscout/swiftcli/utils/__init__.py +59 -59
  254. webscout/swiftcli/utils/formatting.py +252 -252
  255. webscout/swiftcli/utils/parsing.py +267 -267
  256. webscout/update_checker.py +117 -117
  257. webscout/version.py +1 -1
  258. webscout/webscout_search.py +1183 -1183
  259. webscout/webscout_search_async.py +649 -649
  260. webscout/yep_search.py +346 -346
  261. webscout/zeroart/README.md +89 -89
  262. webscout/zeroart/__init__.py +134 -134
  263. webscout/zeroart/base.py +66 -66
  264. webscout/zeroart/effects.py +100 -100
  265. webscout/zeroart/fonts.py +1238 -1238
  266. {webscout-8.3.6.dist-info → webscout-2025.10.11.dist-info}/METADATA +937 -936
  267. webscout-2025.10.11.dist-info/RECORD +300 -0
  268. webscout/Provider/AISEARCH/DeepFind.py +0 -254
  269. webscout/Provider/AllenAI.py +0 -440
  270. webscout/Provider/Blackboxai.py +0 -793
  271. webscout/Provider/FreeGemini.py +0 -250
  272. webscout/Provider/GptOss.py +0 -207
  273. webscout/Provider/Hunyuan.py +0 -283
  274. webscout/Provider/Kimi.py +0 -445
  275. webscout/Provider/MCPCore.py +0 -322
  276. webscout/Provider/MiniMax.py +0 -207
  277. webscout/Provider/OPENAI/BLACKBOXAI.py +0 -1045
  278. webscout/Provider/OPENAI/MiniMax.py +0 -298
  279. webscout/Provider/OPENAI/Qwen3.py +0 -304
  280. webscout/Provider/OPENAI/autoproxy.py +0 -1067
  281. webscout/Provider/OPENAI/copilot.py +0 -321
  282. webscout/Provider/OPENAI/gptoss.py +0 -288
  283. webscout/Provider/OPENAI/kimi.py +0 -469
  284. webscout/Provider/OPENAI/mcpcore.py +0 -431
  285. webscout/Provider/OPENAI/multichat.py +0 -378
  286. webscout/Provider/OPENAI/qodo.py +0 -630
  287. webscout/Provider/OPENAI/xenai.py +0 -514
  288. webscout/Provider/Reka.py +0 -214
  289. webscout/Provider/UNFINISHED/fetch_together_models.py +0 -90
  290. webscout/Provider/asksteve.py +0 -220
  291. webscout/Provider/copilot.py +0 -441
  292. webscout/Provider/freeaichat.py +0 -294
  293. webscout/Provider/koala.py +0 -182
  294. webscout/Provider/lmarena.py +0 -198
  295. webscout/Provider/monochat.py +0 -275
  296. webscout/Provider/multichat.py +0 -375
  297. webscout/Provider/scnet.py +0 -244
  298. webscout/Provider/talkai.py +0 -194
  299. webscout/tempid.py +0 -128
  300. webscout-8.3.6.dist-info/RECORD +0 -327
  301. {webscout-8.3.6.dist-info → webscout-2025.10.11.dist-info}/WHEEL +0 -0
  302. {webscout-8.3.6.dist-info → webscout-2025.10.11.dist-info}/entry_points.txt +0 -0
  303. {webscout-8.3.6.dist-info → webscout-2025.10.11.dist-info}/licenses/LICENSE.md +0 -0
  304. {webscout-8.3.6.dist-info → webscout-2025.10.11.dist-info}/top_level.txt +0 -0
@@ -1,1183 +1,1183 @@
1
- from __future__ import annotations
2
-
3
- # import logging
4
- import json
5
- import os
6
- import warnings
7
- from concurrent.futures import ThreadPoolExecutor
8
- from datetime import datetime, timezone
9
- from decimal import Decimal
10
- from functools import cached_property
11
- from itertools import cycle, islice
12
- from random import choice, shuffle
13
- from threading import Event
14
- from time import sleep, time
15
- from types import TracebackType
16
- from typing import Any, Literal
17
- from urllib.parse import quote
18
-
19
- from webscout.litagent import LitAgent
20
-
21
- # Import trio before curl_cffi to prevent eventlet socket monkey-patching conflicts
22
- # See: https://github.com/python-trio/trio/issues/3015
23
- try:
24
- import trio # noqa: F401
25
- except ImportError:
26
- pass # trio is optional, ignore if not available
27
- import curl_cffi.requests # type: ignore
28
-
29
- try:
30
- from lxml.etree import _Element
31
- from lxml.html import HTMLParser as LHTMLParser
32
- from lxml.html import document_fromstring
33
-
34
- LXML_AVAILABLE = True
35
- except ImportError:
36
- LXML_AVAILABLE = False
37
-
38
- from .exceptions import RatelimitE, TimeoutE, WebscoutE
39
- from .utils import (
40
- _calculate_distance,
41
- _expand_proxy_tb_alias,
42
- _extract_vqd,
43
- _normalize,
44
- _normalize_url,
45
- _text_extract_json,
46
- json_loads,
47
- )
48
-
49
- # logger = logging.getLogger("webscout.WEBS")
50
-
51
-
52
- class WEBS:
53
- """webscout class to get search results from duckduckgo.com."""
54
-
55
- _executor: ThreadPoolExecutor = ThreadPoolExecutor()
56
- # curl_cffi supports different browser versions than primp
57
- _impersonates = (
58
- "chrome99", "chrome100", "chrome101", "chrome104", "chrome107", "chrome110",
59
- "chrome116", "chrome119", "chrome120", "chrome123", "chrome124", "chrome131", "chrome133a",
60
- "chrome99_android", "chrome131_android",
61
- "safari15_3", "safari15_5", "safari17_0", "safari17_2_ios", "safari18_0", "safari18_0_ios",
62
- "edge99", "edge101",
63
- "firefox133", "firefox135",
64
- ) # fmt: skip
65
- _impersonates_os = ("android", "ios", "linux", "macos", "windows")
66
-
67
-
68
- def __init__(
69
- self,
70
- headers: dict[str, str] | None = None,
71
- proxy: str | None = None,
72
- proxies: dict[str, str] | str | None = None, # deprecated
73
- timeout: int | None = 10,
74
- verify: bool = True,
75
- ) -> None:
76
- """Initialize the WEBS object.
77
-
78
- Args:
79
- headers (dict, optional): Dictionary of headers for the HTTP client. Defaults to None.
80
- proxy (str, optional): proxy for the HTTP client, supports http/https/socks5 protocols.
81
- example: "http://user:pass@example.com:3128". Defaults to None.
82
- timeout (int, optional): Timeout value for the HTTP client. Defaults to 10.
83
- verify (bool): SSL verification when making the request. Defaults to True.
84
- """
85
- ddgs_proxy: str | None = os.environ.get("DDGS_PROXY")
86
- self.proxy: str | None = ddgs_proxy if ddgs_proxy else _expand_proxy_tb_alias(proxy)
87
- assert self.proxy is None or isinstance(self.proxy, str), "proxy must be a str"
88
- if not proxy and proxies:
89
- warnings.warn("'proxies' is deprecated, use 'proxy' instead.", stacklevel=1)
90
- self.proxy = proxies.get("http") or proxies.get("https") if isinstance(proxies, dict) else proxies
91
-
92
- default_headers = {
93
- **LitAgent().generate_fingerprint(),
94
- "Origin": "https://duckduckgo.com",
95
- "Referer": "https://yep.com/",
96
- }
97
-
98
- self.headers = headers if headers else {}
99
- self.headers.update(default_headers)
100
-
101
- # curl_cffi has different parameters than primp
102
- impersonate_browser = choice(self._impersonates)
103
- self.client = curl_cffi.requests.Session(
104
- headers=self.headers,
105
- proxies={'http': self.proxy, 'https': self.proxy} if self.proxy else None,
106
- timeout=timeout,
107
- # curl_cffi doesn't accept cookies=True, it needs a dict or None
108
- impersonate=impersonate_browser,
109
- verify=verify,
110
- )
111
- self.timeout = timeout
112
- self.sleep_timestamp = 0.0
113
-
114
- self._exception_event = Event()
115
-
116
- def __enter__(self) -> WEBS:
117
- return self
118
-
119
- def __exit__(
120
- self,
121
- exc_type: type[BaseException] | None = None,
122
- exc_val: BaseException | None = None,
123
- exc_tb: TracebackType | None = None,
124
- ) -> None:
125
- pass
126
-
127
- @cached_property
128
- def parser(self) -> LHTMLParser:
129
- """Get HTML parser."""
130
- return LHTMLParser(remove_blank_text=True, remove_comments=True, remove_pis=True, collect_ids=False)
131
-
132
- def _sleep(self, sleeptime: float = 0.75) -> None:
133
- """Sleep between API requests."""
134
- delay = 0.0 if not self.sleep_timestamp else 0.0 if time() - self.sleep_timestamp >= 20 else sleeptime
135
- self.sleep_timestamp = time()
136
- sleep(delay)
137
-
138
- def _get_url(
139
- self,
140
- method: Literal["GET", "HEAD", "OPTIONS", "DELETE", "POST", "PUT", "PATCH"],
141
- url: str,
142
- params: dict[str, str] | None = None,
143
- content: bytes | None = None,
144
- data: dict[str, str] | None = None,
145
- headers: dict[str, str] | None = None,
146
- cookies: dict[str, str] | None = None,
147
- json: Any = None,
148
- timeout: float | None = None,
149
- ) -> Any:
150
- self._sleep()
151
- try:
152
- # curl_cffi doesn't accept cookies=True in request methods
153
- request_kwargs = {
154
- "params": params,
155
- "headers": headers,
156
- "json": json,
157
- "timeout": timeout or self.timeout,
158
- }
159
-
160
- # Add cookies if they're a dict, not a bool
161
- if isinstance(cookies, dict):
162
- request_kwargs["cookies"] = cookies
163
-
164
- if method == "GET":
165
- # curl_cffi uses data instead of content
166
- if content:
167
- request_kwargs["data"] = content
168
- resp = self.client.get(url, **request_kwargs)
169
- elif method == "POST":
170
- # handle both data and content
171
- if data or content:
172
- request_kwargs["data"] = data or content
173
- resp = self.client.post(url, **request_kwargs)
174
- else:
175
- # handle both data and content
176
- if data or content:
177
- request_kwargs["data"] = data or content
178
- resp = self.client.request(method, url, **request_kwargs)
179
- except Exception as ex:
180
- if "time" in str(ex).lower():
181
- raise TimeoutE(f"{url} {type(ex).__name__}: {ex}") from ex
182
- raise WebscoutE(f"{url} {type(ex).__name__}: {ex}") from ex
183
- if resp.status_code == 200:
184
- return resp
185
- elif resp.status_code in (202, 301, 403, 400, 429, 418):
186
- raise RatelimitE(f"{resp.url} {resp.status_code} Ratelimit")
187
- raise WebscoutE(f"{resp.url} return None. {params=} {content=} {data=}")
188
-
189
- def _get_vqd(self, keywords: str) -> str:
190
- """Get vqd value for a search query."""
191
- resp_content = self._get_url("GET", "https://duckduckgo.com", params={"q": keywords}).content
192
- return _extract_vqd(resp_content, keywords)
193
-
194
-
195
-
196
- def text(
197
- self,
198
- keywords: str,
199
- region: str = "wt-wt",
200
- safesearch: str = "moderate",
201
- timelimit: str | None = None,
202
- backend: str = "auto",
203
- max_results: int | None = None,
204
- ) -> list[dict[str, str]]:
205
- """webscout text search. Query params: https://duckduckgo.com/params.
206
-
207
- Args:
208
- keywords: keywords for query.
209
- region: wt-wt, us-en, uk-en, ru-ru, etc. Defaults to "wt-wt".
210
- safesearch: on, moderate, off. Defaults to "moderate".
211
- timelimit: d, w, m, y. Defaults to None.
212
- backend: auto, html, lite. Defaults to auto.
213
- auto - try all backends in random order,
214
- html - collect data from https://html.duckduckgo.com,
215
- lite - collect data from https://lite.duckduckgo.com.
216
- max_results: max number of results. If None, returns results only from the first response. Defaults to None.
217
-
218
- Returns:
219
- List of dictionaries with search results.
220
-
221
- Raises:
222
- WebscoutE: Base exception for webscout errors.
223
- RatelimitE: Inherits from WebscoutE, raised for exceeding API request rate limits.
224
- TimeoutE: Inherits from WebscoutE, raised for API request timeouts.
225
- """
226
- if backend in ("api", "ecosia"):
227
- warnings.warn(f"{backend=} is deprecated, using backend='auto'", stacklevel=2)
228
- backend = "auto"
229
- backends = ["html", "lite"] if backend == "auto" else [backend]
230
- shuffle(backends)
231
-
232
- results, err = [], None
233
- for b in backends:
234
- try:
235
- if b == "html":
236
- results = self._text_html(keywords, region, timelimit, max_results)
237
- elif b == "lite":
238
- results = self._text_lite(keywords, region, timelimit, max_results)
239
- return results
240
- except Exception as ex:
241
- err = ex
242
-
243
- raise WebscoutE(err)
244
-
245
- def _text_api(
246
- self,
247
- keywords: str,
248
- region: str = "wt-wt",
249
- safesearch: str = "moderate",
250
- timelimit: str | None = None,
251
- max_results: int | None = None,
252
- ) -> list[dict[str, str]]:
253
- """webscout text search. Query params: https://duckduckgo.com/params.
254
-
255
- Args:
256
- keywords: keywords for query.
257
- region: wt-wt, us-en, uk-en, ru-ru, etc. Defaults to "wt-wt".
258
- safesearch: on, moderate, off. Defaults to "moderate".
259
- timelimit: d, w, m, y. Defaults to None.
260
- max_results: max number of results. If None, returns results only from the first response. Defaults to None.
261
-
262
- Returns:
263
- List of dictionaries with search results.
264
-
265
- Raises:
266
- WebscoutE: Base exception for webscout errors.
267
- RatelimitE: Inherits from WebscoutE, raised for exceeding API request rate limits.
268
- TimeoutE: Inherits from WebscoutE, raised for API request timeouts.
269
- """
270
- assert keywords, "keywords is mandatory"
271
-
272
- vqd = self._get_vqd(keywords)
273
-
274
- payload = {
275
- "q": keywords,
276
- "kl": region,
277
- "l": region,
278
- "p": "",
279
- "s": "0",
280
- "df": "",
281
- "vqd": vqd,
282
- "bing_market": f"{region[3:]}-{region[:2].upper()}",
283
- "ex": "",
284
- }
285
- safesearch = safesearch.lower()
286
- if safesearch == "moderate":
287
- payload["ex"] = "-1"
288
- elif safesearch == "off":
289
- payload["ex"] = "-2"
290
- elif safesearch == "on": # strict
291
- payload["p"] = "1"
292
- if timelimit:
293
- payload["df"] = timelimit
294
-
295
- cache = set()
296
- results: list[dict[str, str]] = []
297
-
298
- def _text_api_page(s: int) -> list[dict[str, str]]:
299
- payload["s"] = f"{s}"
300
- resp_content = self._get_url("GET", "https://links.duckduckgo.com/d.js", params=payload).content
301
- page_data = _text_extract_json(resp_content, keywords)
302
- page_results = []
303
- for row in page_data:
304
- href = row.get("u", None)
305
- if href and href not in cache and href != f"http://www.google.com/search?q={keywords}":
306
- cache.add(href)
307
- body = _normalize(row["a"])
308
- if body:
309
- result = {
310
- "title": _normalize(row["t"]),
311
- "href": _normalize_url(href),
312
- "body": body,
313
- }
314
- page_results.append(result)
315
- return page_results
316
-
317
- slist = [0]
318
- if max_results:
319
- max_results = min(max_results, 2023)
320
- slist.extend(range(23, max_results, 50))
321
- try:
322
- for r in self._executor.map(_text_api_page, slist):
323
- results.extend(r)
324
- except Exception as e:
325
- raise e
326
-
327
- return list(islice(results, max_results))
328
-
329
- def _text_html(
330
- self,
331
- keywords: str,
332
- region: str = "wt-wt",
333
- timelimit: str | None = None,
334
- max_results: int | None = None,
335
- ) -> list[dict[str, str]]:
336
- """webscout text search. Query params: https://duckduckgo.com/params.
337
-
338
- Args:
339
- keywords: keywords for query.
340
- region: wt-wt, us-en, uk-en, ru-ru, etc. Defaults to "wt-wt".
341
- timelimit: d, w, m, y. Defaults to None.
342
- max_results: max number of results. If None, returns results only from the first response. Defaults to None.
343
-
344
- Returns:
345
- List of dictionaries with search results.
346
-
347
- Raises:
348
- WebscoutE: Base exception for webscout errors.
349
- RatelimitE: Inherits from WebscoutE, raised for exceeding API request rate limits.
350
- TimeoutE: Inherits from WebscoutE, raised for API request timeouts.
351
- """
352
- assert keywords, "keywords is mandatory"
353
-
354
- payload = {
355
- "q": keywords,
356
- "s": "0",
357
- "o": "json",
358
- "api": "d.js",
359
- "vqd": "",
360
- "kl": region,
361
- "bing_market": region,
362
- }
363
- if timelimit:
364
- payload["df"] = timelimit
365
- if max_results and max_results > 20:
366
- vqd = self._get_vqd(keywords)
367
- payload["vqd"] = vqd
368
-
369
- cache = set()
370
- results: list[dict[str, str]] = []
371
-
372
- def _text_html_page(s: int) -> list[dict[str, str]]:
373
- payload["s"] = f"{s}"
374
- resp_content = self._get_url("POST", "https://html.duckduckgo.com/html", data=payload).content
375
- if b"No results." in resp_content:
376
- return []
377
-
378
- page_results = []
379
- # curl_cffi returns bytes, not a file-like object
380
- tree = document_fromstring(resp_content)
381
- elements = tree.xpath("//div[h2]")
382
- if not isinstance(elements, list):
383
- return []
384
- for e in elements:
385
- if isinstance(e, _Element):
386
- hrefxpath = e.xpath("./a/@href")
387
- href = str(hrefxpath[0]) if hrefxpath and isinstance(hrefxpath, list) else None
388
- if (
389
- href
390
- and href not in cache
391
- and not href.startswith(
392
- ("http://www.google.com/search?q=", "https://duckduckgo.com/y.js?ad_domain")
393
- )
394
- ):
395
- cache.add(href)
396
- titlexpath = e.xpath("./h2/a/text()")
397
- title = str(titlexpath[0]) if titlexpath and isinstance(titlexpath, list) else ""
398
- bodyxpath = e.xpath("./a//text()")
399
- body = "".join(str(x) for x in bodyxpath) if bodyxpath and isinstance(bodyxpath, list) else ""
400
- result = {
401
- "title": _normalize(title),
402
- "href": _normalize_url(href),
403
- "body": _normalize(body),
404
- }
405
- page_results.append(result)
406
- return page_results
407
-
408
- slist = [0]
409
- if max_results:
410
- max_results = min(max_results, 2023)
411
- slist.extend(range(23, max_results, 50))
412
- try:
413
- for r in self._executor.map(_text_html_page, slist):
414
- results.extend(r)
415
- except Exception as e:
416
- raise e
417
-
418
- return list(islice(results, max_results))
419
-
420
- def _text_lite(
421
- self,
422
- keywords: str,
423
- region: str = "wt-wt",
424
- timelimit: str | None = None,
425
- max_results: int | None = None,
426
- ) -> list[dict[str, str]]:
427
- """webscout text search. Query params: https://duckduckgo.com/params.
428
-
429
- Args:
430
- keywords: keywords for query.
431
- region: wt-wt, us-en, uk-en, ru-ru, etc. Defaults to "wt-wt".
432
- timelimit: d, w, m, y. Defaults to None.
433
- max_results: max number of results. If None, returns results only from the first response. Defaults to None.
434
-
435
- Returns:
436
- List of dictionaries with search results.
437
-
438
- Raises:
439
- WebscoutE: Base exception for webscout errors.
440
- RatelimitE: Inherits from WebscoutE, raised for exceeding API request rate limits.
441
- TimeoutE: Inherits from WebscoutE, raised for API request timeouts.
442
- """
443
- assert keywords, "keywords is mandatory"
444
-
445
- payload = {
446
- "q": keywords,
447
- "s": "0",
448
- "o": "json",
449
- "api": "d.js",
450
- "vqd": "",
451
- "kl": region,
452
- "bing_market": region,
453
- }
454
- if timelimit:
455
- payload["df"] = timelimit
456
-
457
- cache = set()
458
- results: list[dict[str, str]] = []
459
-
460
- def _text_lite_page(s: int) -> list[dict[str, str]]:
461
- payload["s"] = f"{s}"
462
- resp_content = self._get_url("POST", "https://lite.duckduckgo.com/lite/", data=payload).content
463
- if b"No more results." in resp_content:
464
- return []
465
-
466
- page_results = []
467
- # curl_cffi returns bytes, not a file-like object
468
- tree = document_fromstring(resp_content)
469
- elements = tree.xpath("//table[last()]//tr")
470
- if not isinstance(elements, list):
471
- return []
472
-
473
- data = zip(cycle(range(1, 5)), elements)
474
- for i, e in data:
475
- if isinstance(e, _Element):
476
- if i == 1:
477
- hrefxpath = e.xpath(".//a//@href")
478
- href = str(hrefxpath[0]) if hrefxpath and isinstance(hrefxpath, list) else None
479
- if (
480
- href is None
481
- or href in cache
482
- or href.startswith(
483
- ("http://www.google.com/search?q=", "https://duckduckgo.com/y.js?ad_domain")
484
- )
485
- ):
486
- [next(data, None) for _ in range(3)] # skip block(i=1,2,3,4)
487
- else:
488
- cache.add(href)
489
- titlexpath = e.xpath(".//a//text()")
490
- title = str(titlexpath[0]) if titlexpath and isinstance(titlexpath, list) else ""
491
- elif i == 2:
492
- bodyxpath = e.xpath(".//td[@class='result-snippet']//text()")
493
- body = (
494
- "".join(str(x) for x in bodyxpath).strip()
495
- if bodyxpath and isinstance(bodyxpath, list)
496
- else ""
497
- )
498
- if href:
499
- result = {
500
- "title": _normalize(title),
501
- "href": _normalize_url(href),
502
- "body": _normalize(body),
503
- }
504
- page_results.append(result)
505
- return page_results
506
-
507
- slist = [0]
508
- if max_results:
509
- max_results = min(max_results, 2023)
510
- slist.extend(range(23, max_results, 50))
511
- try:
512
- for r in self._executor.map(_text_lite_page, slist):
513
- results.extend(r)
514
- except Exception as e:
515
- raise e
516
-
517
- return list(islice(results, max_results))
518
-
519
- def images(
520
- self,
521
- keywords: str,
522
- region: str = "wt-wt",
523
- safesearch: str = "moderate",
524
- timelimit: str | None = None,
525
- size: str | None = None,
526
- color: str | None = None,
527
- type_image: str | None = None,
528
- layout: str | None = None,
529
- license_image: str | None = None,
530
- max_results: int | None = None,
531
- ) -> list[dict[str, str]]:
532
- """webscout images search. Query params: https://duckduckgo.com/params.
533
-
534
- Args:
535
- keywords: keywords for query.
536
- region: wt-wt, us-en, uk-en, ru-ru, etc. Defaults to "wt-wt".
537
- safesearch: on, moderate, off. Defaults to "moderate".
538
- timelimit: Day, Week, Month, Year. Defaults to None.
539
- size: Small, Medium, Large, Wallpaper. Defaults to None.
540
- color: color, Monochrome, Red, Orange, Yellow, Green, Blue,
541
- Purple, Pink, Brown, Black, Gray, Teal, White. Defaults to None.
542
- type_image: photo, clipart, gif, transparent, line.
543
- Defaults to None.
544
- layout: Square, Tall, Wide. Defaults to None.
545
- license_image: any (All Creative Commons), Public (PublicDomain),
546
- Share (Free to Share and Use), ShareCommercially (Free to Share and Use Commercially),
547
- Modify (Free to Modify, Share, and Use), ModifyCommercially (Free to Modify, Share, and
548
- Use Commercially). Defaults to None.
549
- max_results: max number of results. If None, returns results only from the first response. Defaults to None.
550
-
551
- Returns:
552
- List of dictionaries with images search results.
553
-
554
- Raises:
555
- WebscoutE: Base exception for webscout errors.
556
- RatelimitE: Inherits from WebscoutE, raised for exceeding API request rate limits.
557
- TimeoutE: Inherits from WebscoutE, raised for API request timeouts.
558
- """
559
- assert keywords, "keywords is mandatory"
560
-
561
- vqd = self._get_vqd(keywords)
562
-
563
- safesearch_base = {"on": "1", "moderate": "1", "off": "-1"}
564
- timelimit = f"time:{timelimit}" if timelimit else ""
565
- size = f"size:{size}" if size else ""
566
- color = f"color:{color}" if color else ""
567
- type_image = f"type:{type_image}" if type_image else ""
568
- layout = f"layout:{layout}" if layout else ""
569
- license_image = f"license:{license_image}" if license_image else ""
570
- payload = {
571
- "l": region,
572
- "o": "json",
573
- "q": keywords,
574
- "vqd": vqd,
575
- "f": f"{timelimit},{size},{color},{type_image},{layout},{license_image}",
576
- "p": safesearch_base[safesearch.lower()],
577
- }
578
-
579
- cache = set()
580
- results: list[dict[str, str]] = []
581
-
582
- def _images_page(s: int) -> list[dict[str, str]]:
583
- payload["s"] = f"{s}"
584
- resp_content = self._get_url("GET", "https://duckduckgo.com/i.js", params=payload).content
585
- resp_json = json_loads(resp_content)
586
-
587
- page_data = resp_json.get("results", [])
588
- page_results = []
589
- for row in page_data:
590
- image_url = row.get("image")
591
- if image_url and image_url not in cache:
592
- cache.add(image_url)
593
- result = {
594
- "title": row["title"],
595
- "image": _normalize_url(image_url),
596
- "thumbnail": _normalize_url(row["thumbnail"]),
597
- "url": _normalize_url(row["url"]),
598
- "height": row["height"],
599
- "width": row["width"],
600
- "source": row["source"],
601
- }
602
- page_results.append(result)
603
- return page_results
604
-
605
- slist = [0]
606
- if max_results:
607
- max_results = min(max_results, 500)
608
- slist.extend(range(100, max_results, 100))
609
- try:
610
- for r in self._executor.map(_images_page, slist):
611
- results.extend(r)
612
- except Exception as e:
613
- raise e
614
-
615
- return list(islice(results, max_results))
616
-
617
- def videos(
618
- self,
619
- keywords: str,
620
- region: str = "wt-wt",
621
- safesearch: str = "moderate",
622
- timelimit: str | None = None,
623
- resolution: str | None = None,
624
- duration: str | None = None,
625
- license_videos: str | None = None,
626
- max_results: int | None = None,
627
- ) -> list[dict[str, str]]:
628
- """webscout videos search. Query params: https://duckduckgo.com/params.
629
-
630
- Args:
631
- keywords: keywords for query.
632
- region: wt-wt, us-en, uk-en, ru-ru, etc. Defaults to "wt-wt".
633
- safesearch: on, moderate, off. Defaults to "moderate".
634
- timelimit: d, w, m. Defaults to None.
635
- resolution: high, standart. Defaults to None.
636
- duration: short, medium, long. Defaults to None.
637
- license_videos: creativeCommon, youtube. Defaults to None.
638
- max_results: max number of results. If None, returns results only from the first response. Defaults to None.
639
-
640
- Returns:
641
- List of dictionaries with videos search results.
642
-
643
- Raises:
644
- WebscoutE: Base exception for webscout errors.
645
- RatelimitE: Inherits from WebscoutE, raised for exceeding API request rate limits.
646
- TimeoutE: Inherits from WebscoutE, raised for API request timeouts.
647
- """
648
- assert keywords, "keywords is mandatory"
649
-
650
- vqd = self._get_vqd(keywords)
651
-
652
- safesearch_base = {"on": "1", "moderate": "-1", "off": "-2"}
653
- timelimit = f"publishedAfter:{timelimit}" if timelimit else ""
654
- resolution = f"videoDefinition:{resolution}" if resolution else ""
655
- duration = f"videoDuration:{duration}" if duration else ""
656
- license_videos = f"videoLicense:{license_videos}" if license_videos else ""
657
- payload = {
658
- "l": region,
659
- "o": "json",
660
- "q": keywords,
661
- "vqd": vqd,
662
- "f": f"{timelimit},{resolution},{duration},{license_videos}",
663
- "p": safesearch_base[safesearch.lower()],
664
- }
665
-
666
- cache = set()
667
- results: list[dict[str, str]] = []
668
-
669
- def _videos_page(s: int) -> list[dict[str, str]]:
670
- payload["s"] = f"{s}"
671
- resp_content = self._get_url("GET", "https://duckduckgo.com/v.js", params=payload).content
672
- resp_json = json_loads(resp_content)
673
-
674
- page_data = resp_json.get("results", [])
675
- page_results = []
676
- for row in page_data:
677
- if row["content"] not in cache:
678
- cache.add(row["content"])
679
- page_results.append(row)
680
- return page_results
681
-
682
- slist = [0]
683
- if max_results:
684
- max_results = min(max_results, 400)
685
- slist.extend(range(60, max_results, 60))
686
- try:
687
- for r in self._executor.map(_videos_page, slist):
688
- results.extend(r)
689
- except Exception as e:
690
- raise e
691
-
692
- return list(islice(results, max_results))
693
-
694
- def news(
695
- self,
696
- keywords: str,
697
- region: str = "wt-wt",
698
- safesearch: str = "moderate",
699
- timelimit: str | None = None,
700
- max_results: int | None = None,
701
- ) -> list[dict[str, str]]:
702
- """webscout news search. Query params: https://duckduckgo.com/params.
703
-
704
- Args:
705
- keywords: keywords for query.
706
- region: wt-wt, us-en, uk-en, ru-ru, etc. Defaults to "wt-wt".
707
- safesearch: on, moderate, off. Defaults to "moderate".
708
- timelimit: d, w, m. Defaults to None.
709
- max_results: max number of results. If None, returns results only from the first response. Defaults to None.
710
-
711
- Returns:
712
- List of dictionaries with news search results.
713
-
714
- Raises:
715
- WebscoutE: Base exception for webscout errors.
716
- RatelimitE: Inherits from WebscoutE, raised for exceeding API request rate limits.
717
- TimeoutE: Inherits from WebscoutE, raised for API request timeouts.
718
- """
719
- assert keywords, "keywords is mandatory"
720
-
721
- vqd = self._get_vqd(keywords)
722
-
723
- safesearch_base = {"on": "1", "moderate": "-1", "off": "-2"}
724
- payload = {
725
- "l": region,
726
- "o": "json",
727
- "noamp": "1",
728
- "q": keywords,
729
- "vqd": vqd,
730
- "p": safesearch_base[safesearch.lower()],
731
- }
732
- if timelimit:
733
- payload["df"] = timelimit
734
-
735
- cache = set()
736
- results: list[dict[str, str]] = []
737
-
738
- def _news_page(s: int) -> list[dict[str, str]]:
739
- payload["s"] = f"{s}"
740
- resp_content = self._get_url("GET", "https://duckduckgo.com/news.js", params=payload).content
741
- resp_json = json_loads(resp_content)
742
- page_data = resp_json.get("results", [])
743
- page_results = []
744
- for row in page_data:
745
- if row["url"] not in cache:
746
- cache.add(row["url"])
747
- image_url = row.get("image", None)
748
- result = {
749
- "date": datetime.fromtimestamp(row["date"], timezone.utc).isoformat(),
750
- "title": row["title"],
751
- "body": _normalize(row["excerpt"]),
752
- "url": _normalize_url(row["url"]),
753
- "image": _normalize_url(image_url),
754
- "source": row["source"],
755
- }
756
- page_results.append(result)
757
- return page_results
758
-
759
- slist = [0]
760
- if max_results:
761
- max_results = min(max_results, 120)
762
- slist.extend(range(30, max_results, 30))
763
- try:
764
- for r in self._executor.map(_news_page, slist):
765
- results.extend(r)
766
- except Exception as e:
767
- raise e
768
-
769
- return list(islice(results, max_results))
770
-
771
- def answers(self, keywords: str) -> list[dict[str, str]]:
772
- """webscout instant answers. Query params: https://duckduckgo.com/params.
773
-
774
- Args:
775
- keywords: keywords for query,
776
-
777
- Returns:
778
- List of dictionaries with instant answers results.
779
-
780
- Raises:
781
- WebscoutE: Base exception for webscout errors.
782
- RatelimitE: Inherits from WebscoutE, raised for exceeding API request rate limits.
783
- TimeoutE: Inherits from WebscoutE, raised for API request timeouts.
784
- """
785
- assert keywords, "keywords is mandatory"
786
-
787
- payload = {
788
- "q": f"what is {keywords}",
789
- "format": "json",
790
- }
791
- resp_content = self._get_url("GET", "https://api.duckduckgo.com/", params=payload).content
792
- page_data = json_loads(resp_content)
793
-
794
- results = []
795
- answer = page_data.get("AbstractText")
796
- url = page_data.get("AbstractURL")
797
- if answer:
798
- results.append(
799
- {
800
- "icon": None,
801
- "text": answer,
802
- "topic": None,
803
- "url": url,
804
- }
805
- )
806
-
807
- # related
808
- payload = {
809
- "q": f"{keywords}",
810
- "format": "json",
811
- }
812
- resp_content = self._get_url("GET", "https://api.duckduckgo.com/", params=payload).content
813
- resp_json = json_loads(resp_content)
814
- page_data = resp_json.get("RelatedTopics", [])
815
-
816
- for row in page_data:
817
- topic = row.get("Name")
818
- if not topic:
819
- icon = row["Icon"].get("URL")
820
- results.append(
821
- {
822
- "icon": f"https://duckduckgo.com{icon}" if icon else "",
823
- "text": row["Text"],
824
- "topic": None,
825
- "url": row["FirstURL"],
826
- }
827
- )
828
- else:
829
- for subrow in row["Topics"]:
830
- icon = subrow["Icon"].get("URL")
831
- results.append(
832
- {
833
- "icon": f"https://duckduckgo.com{icon}" if icon else "",
834
- "text": subrow["Text"],
835
- "topic": topic,
836
- "url": subrow["FirstURL"],
837
- }
838
- )
839
-
840
- return results
841
-
842
- def suggestions(self, keywords: str, region: str = "wt-wt") -> list[dict[str, str]]:
843
- """webscout suggestions. Query params: https://duckduckgo.com/params.
844
-
845
- Args:
846
- keywords: keywords for query.
847
- region: wt-wt, us-en, uk-en, ru-ru, etc. Defaults to "wt-wt".
848
-
849
- Returns:
850
- List of dictionaries with suggestions results.
851
-
852
- Raises:
853
- WebscoutE: Base exception for webscout errors.
854
- RatelimitE: Inherits from WebscoutE, raised for exceeding API request rate limits.
855
- TimeoutE: Inherits from WebscoutE, raised for API request timeouts.
856
- """
857
- assert keywords, "keywords is mandatory"
858
-
859
- payload = {
860
- "q": keywords,
861
- "kl": region,
862
- }
863
- resp_content = self._get_url("GET", "https://duckduckgo.com/ac/", params=payload).content
864
- page_data = json_loads(resp_content)
865
- return [r for r in page_data]
866
-
867
- def maps(
868
- self,
869
- keywords: str,
870
- place: str | None = None,
871
- street: str | None = None,
872
- city: str | None = None,
873
- county: str | None = None,
874
- state: str | None = None,
875
- country: str | None = None,
876
- postalcode: str | None = None,
877
- latitude: str | None = None,
878
- longitude: str | None = None,
879
- radius: int = 0,
880
- max_results: int | None = None,
881
- ) -> list[dict[str, str]]:
882
- """webscout maps search. Query params: https://duckduckgo.com/params.
883
-
884
- Args:
885
- keywords: keywords for query
886
- place: if set, the other parameters are not used. Defaults to None.
887
- street: house number/street. Defaults to None.
888
- city: city of search. Defaults to None.
889
- county: county of search. Defaults to None.
890
- state: state of search. Defaults to None.
891
- country: country of search. Defaults to None.
892
- postalcode: postalcode of search. Defaults to None.
893
- latitude: geographic coordinate (north-south position). Defaults to None.
894
- longitude: geographic coordinate (east-west position); if latitude and
895
- longitude are set, the other parameters are not used. Defaults to None.
896
- radius: expand the search square by the distance in kilometers. Defaults to 0.
897
- max_results: max number of results. If None, returns results only from the first response. Defaults to None.
898
-
899
- Returns:
900
- List of dictionaries with maps search results, or None if there was an error.
901
-
902
- Raises:
903
- WebscoutE: Base exception for webscout errors.
904
- RatelimitE: Inherits from WebscoutE, raised for exceeding API request rate limits.
905
- TimeoutE: Inherits from WebscoutE, raised for API request timeouts.
906
- """
907
- assert keywords, "keywords is mandatory"
908
-
909
- vqd = self._get_vqd(keywords)
910
-
911
- # if longitude and latitude are specified, skip the request about bbox to the nominatim api
912
- if latitude and longitude:
913
- lat_t = Decimal(latitude.replace(",", "."))
914
- lat_b = Decimal(latitude.replace(",", "."))
915
- lon_l = Decimal(longitude.replace(",", "."))
916
- lon_r = Decimal(longitude.replace(",", "."))
917
- if radius == 0:
918
- radius = 1
919
- # otherwise request about bbox to nominatim api
920
- else:
921
- if place:
922
- params = {
923
- "q": place,
924
- "polygon_geojson": "0",
925
- "format": "jsonv2",
926
- }
927
- else:
928
- params = {
929
- "polygon_geojson": "0",
930
- "format": "jsonv2",
931
- }
932
- if street:
933
- params["street"] = street
934
- if city:
935
- params["city"] = city
936
- if county:
937
- params["county"] = county
938
- if state:
939
- params["state"] = state
940
- if country:
941
- params["country"] = country
942
- if postalcode:
943
- params["postalcode"] = postalcode
944
- # request nominatim api to get coordinates box
945
- resp_content = self._get_url(
946
- "GET",
947
- "https://nominatim.openstreetmap.org/search.php",
948
- params=params,
949
- ).content
950
- if resp_content == b"[]":
951
- raise WebscoutE("maps() Coordinates are not found, check function parameters.")
952
- resp_json = json_loads(resp_content)
953
- coordinates = resp_json[0]["boundingbox"]
954
- lat_t, lon_l = Decimal(coordinates[1]), Decimal(coordinates[2])
955
- lat_b, lon_r = Decimal(coordinates[0]), Decimal(coordinates[3])
956
-
957
- # if a radius is specified, expand the search square
958
- lat_t += Decimal(radius) * Decimal(0.008983)
959
- lat_b -= Decimal(radius) * Decimal(0.008983)
960
- lon_l -= Decimal(radius) * Decimal(0.008983)
961
- lon_r += Decimal(radius) * Decimal(0.008983)
962
- # logger.debug(f"bbox coordinates\n{lat_t} {lon_l}\n{lat_b} {lon_r}")
963
-
964
- cache = set()
965
- results: list[dict[str, str]] = []
966
-
967
- def _maps_page(
968
- bbox: tuple[Decimal, Decimal, Decimal, Decimal],
969
- ) -> list[dict[str, str]] | None:
970
- if max_results and len(results) >= max_results:
971
- return None
972
- lat_t, lon_l, lat_b, lon_r = bbox
973
- params = {
974
- "q": keywords,
975
- "vqd": vqd,
976
- "tg": "maps_places",
977
- "rt": "D",
978
- "mkexp": "b",
979
- "wiki_info": "1",
980
- "is_requery": "1",
981
- "bbox_tl": f"{lat_t},{lon_l}",
982
- "bbox_br": f"{lat_b},{lon_r}",
983
- "strict_bbox": "1",
984
- }
985
- resp_content = self._get_url("GET", "https://duckduckgo.com/local.js", params=params).content
986
- resp_json = json_loads(resp_content)
987
- page_data = resp_json.get("results", [])
988
-
989
- page_results = []
990
- for res in page_data:
991
- r_name = f'{res["name"]} {res["address"]}'
992
- if r_name in cache:
993
- continue
994
- else:
995
- cache.add(r_name)
996
- result = {
997
- "title": res["name"],
998
- "address": res["address"],
999
- "country_code": res["country_code"],
1000
- "url": _normalize_url(res["website"]),
1001
- "phone": res["phone"] or "",
1002
- "latitude": res["coordinates"]["latitude"],
1003
- "longitude": res["coordinates"]["longitude"],
1004
- "source": _normalize_url(res["url"]),
1005
- "image": x.get("image", "") if (x := res["embed"]) else "",
1006
- "desc": x.get("description", "") if (x := res["embed"]) else "",
1007
- "hours": res["hours"] or "",
1008
- "category": res["ddg_category"] or "",
1009
- "facebook": f"www.facebook.com/profile.php?id={x}" if (x := res["facebook_id"]) else "",
1010
- "instagram": f"https://www.instagram.com/{x}" if (x := res["instagram_id"]) else "",
1011
- "twitter": f"https://twitter.com/{x}" if (x := res["twitter_id"]) else "",
1012
- }
1013
- page_results.append(result)
1014
- return page_results
1015
-
1016
- # search squares (bboxes)
1017
- start_bbox = (lat_t, lon_l, lat_b, lon_r)
1018
- work_bboxes = [start_bbox]
1019
- while work_bboxes:
1020
- queue_bboxes = [] # for next iteration, at the end of the iteration work_bboxes = queue_bboxes
1021
- tasks = []
1022
- for bbox in work_bboxes:
1023
- tasks.append(bbox)
1024
- # if distance between coordinates > 1, divide the square into 4 parts and save them in queue_bboxes
1025
- if _calculate_distance(lat_t, lon_l, lat_b, lon_r) > 1:
1026
- lat_t, lon_l, lat_b, lon_r = bbox
1027
- lat_middle = (lat_t + lat_b) / 2
1028
- lon_middle = (lon_l + lon_r) / 2
1029
- bbox1 = (lat_t, lon_l, lat_middle, lon_middle)
1030
- bbox2 = (lat_t, lon_middle, lat_middle, lon_r)
1031
- bbox3 = (lat_middle, lon_l, lat_b, lon_middle)
1032
- bbox4 = (lat_middle, lon_middle, lat_b, lon_r)
1033
- queue_bboxes.extend([bbox1, bbox2, bbox3, bbox4])
1034
-
1035
- # gather tasks using asyncio.wait_for and timeout
1036
- work_bboxes_results = []
1037
- try:
1038
- for r in self._executor.map(_maps_page, tasks):
1039
- if r:
1040
- work_bboxes_results.extend(r)
1041
- except Exception as e:
1042
- raise e
1043
-
1044
- for x in work_bboxes_results:
1045
- if isinstance(x, list):
1046
- results.extend(x)
1047
- elif isinstance(x, dict):
1048
- results.append(x)
1049
-
1050
- work_bboxes = queue_bboxes
1051
- if not max_results or len(results) >= max_results or len(work_bboxes_results) == 0:
1052
- break
1053
-
1054
- return list(islice(results, max_results))
1055
-
1056
- def translate(self, keywords: list[str] | str, from_: str | None = None, to: str = "en") -> list[dict[str, str]]:
1057
- """webscout translate.
1058
-
1059
- Args:
1060
- keywords: string or list of strings to translate.
1061
- from_: translate from (defaults automatically). Defaults to None.
1062
- to: what language to translate. Defaults to "en".
1063
-
1064
- Returns:
1065
- List od dictionaries with translated keywords.
1066
-
1067
- Raises:
1068
- WebscoutE: Base exception for webscout errors.
1069
- RatelimitE: Inherits from WebscoutE, raised for exceeding API request rate limits.
1070
- TimeoutE: Inherits from WebscoutE, raised for API request timeouts.
1071
- """
1072
- assert keywords, "keywords is mandatory"
1073
-
1074
- vqd = self._get_vqd("translate")
1075
-
1076
- payload = {
1077
- "vqd": vqd,
1078
- "query": "translate",
1079
- "to": to,
1080
- }
1081
- if from_:
1082
- payload["from"] = from_
1083
-
1084
- def _translate_keyword(keyword: str) -> dict[str, str]:
1085
- resp_content = self._get_url(
1086
- "POST",
1087
- "https://duckduckgo.com/translation.js",
1088
- params=payload,
1089
- content=keyword.encode(),
1090
- ).content
1091
- page_data: dict[str, str] = json_loads(resp_content)
1092
- page_data["original"] = keyword
1093
- return page_data
1094
-
1095
- if isinstance(keywords, str):
1096
- keywords = [keywords]
1097
-
1098
- results = []
1099
- try:
1100
- for r in self._executor.map(_translate_keyword, keywords):
1101
- results.append(r)
1102
- except Exception as e:
1103
- raise e
1104
-
1105
- return results
1106
-
1107
- def weather(
1108
- self,
1109
- location: str,
1110
- language: str = "en",
1111
- ) -> dict[str, Any]:
1112
- """Get weather information for a location from DuckDuckGo.
1113
-
1114
- Args:
1115
- location: Location to get weather for.
1116
- language: Language code (e.g. 'en', 'es'). Defaults to "en".
1117
-
1118
- Returns:
1119
- Dictionary containing weather data with structure described in docstring.
1120
-
1121
- Raises:
1122
- WebscoutE: Base exception for webscout errors.
1123
- RatelimitE: Inherits from WebscoutE, raised for exceeding API request rate limits.
1124
- TimeoutE: Inherits from WebscoutE, raised for API request timeouts.
1125
- """
1126
- assert location, "location is mandatory"
1127
- lang = language.split('-')[0]
1128
- url = f"https://duckduckgo.com/js/spice/forecast/{quote(location)}/{lang}"
1129
-
1130
- resp = self._get_url("GET", url).content
1131
- resp_text = resp.decode('utf-8')
1132
-
1133
- if "ddg_spice_forecast(" not in resp_text:
1134
- raise WebscoutE(f"No weather data found for {location}")
1135
-
1136
- json_text = resp_text[resp_text.find('(') + 1:resp_text.rfind(')')]
1137
- try:
1138
- result = json.loads(json_text)
1139
- except Exception as e:
1140
- raise WebscoutE(f"Error parsing weather JSON: {e}")
1141
-
1142
- if not result or 'currentWeather' not in result or 'forecastDaily' not in result:
1143
- raise WebscoutE(f"Invalid weather data format for {location}")
1144
-
1145
- formatted_data = {
1146
- "location": result["currentWeather"]["metadata"].get("ddg-location", "Unknown"),
1147
- "current": {
1148
- "condition": result["currentWeather"].get("conditionCode"),
1149
- "temperature_c": result["currentWeather"].get("temperature"),
1150
- "feels_like_c": result["currentWeather"].get("temperatureApparent"),
1151
- "humidity": result["currentWeather"].get("humidity"),
1152
- "wind_speed_ms": result["currentWeather"].get("windSpeed"),
1153
- "wind_direction": result["currentWeather"].get("windDirection"),
1154
- "visibility_m": result["currentWeather"].get("visibility"),
1155
- },
1156
- "daily_forecast": [],
1157
- "hourly_forecast": []
1158
- }
1159
-
1160
- for day in result["forecastDaily"]["days"]:
1161
- formatted_data["daily_forecast"].append({
1162
- "date": datetime.fromisoformat(day["forecastStart"].replace("Z", "+00:00")).strftime("%Y-%m-%d"),
1163
- "condition": day["daytimeForecast"].get("conditionCode"),
1164
- "max_temp_c": day["temperatureMax"],
1165
- "min_temp_c": day["temperatureMin"],
1166
- "sunrise": datetime.fromisoformat(day["sunrise"].replace("Z", "+00:00")).strftime("%H:%M"),
1167
- "sunset": datetime.fromisoformat(day["sunset"].replace("Z", "+00:00")).strftime("%H:%M"),
1168
- })
1169
-
1170
- if 'forecastHourly' in result and 'hours' in result['forecastHourly']:
1171
- for hour in result['forecastHourly']['hours']:
1172
- formatted_data["hourly_forecast"].append({
1173
- "time": datetime.fromisoformat(hour["forecastStart"].replace("Z", "+00:00")).strftime("%H:%M"),
1174
- "condition": hour.get("conditionCode"),
1175
- "temperature_c": hour.get("temperature"),
1176
- "feels_like_c": hour.get("temperatureApparent"),
1177
- "humidity": hour.get("humidity"),
1178
- "wind_speed_ms": hour.get("windSpeed"),
1179
- "wind_direction": hour.get("windDirection"),
1180
- "visibility_m": hour.get("visibility"),
1181
- })
1182
-
1183
- return formatted_data
1
+ from __future__ import annotations
2
+
3
+ # import logging
4
+ import json
5
+ import os
6
+ import warnings
7
+ from concurrent.futures import ThreadPoolExecutor
8
+ from datetime import datetime, timezone
9
+ from decimal import Decimal
10
+ from functools import cached_property
11
+ from itertools import cycle, islice
12
+ from random import choice, shuffle
13
+ from threading import Event
14
+ from time import sleep, time
15
+ from types import TracebackType
16
+ from typing import Any, Literal
17
+ from urllib.parse import quote
18
+
19
+ from webscout.litagent import LitAgent
20
+
21
+ # Import trio before curl_cffi to prevent eventlet socket monkey-patching conflicts
22
+ # See: https://github.com/python-trio/trio/issues/3015
23
+ try:
24
+ import trio # noqa: F401
25
+ except ImportError:
26
+ pass # trio is optional, ignore if not available
27
+ import curl_cffi.requests # type: ignore
28
+
29
+ try:
30
+ from lxml.etree import _Element
31
+ from lxml.html import HTMLParser as LHTMLParser
32
+ from lxml.html import document_fromstring
33
+
34
+ LXML_AVAILABLE = True
35
+ except ImportError:
36
+ LXML_AVAILABLE = False
37
+
38
+ from .exceptions import RatelimitE, TimeoutE, WebscoutE
39
+ from .utils import (
40
+ _calculate_distance,
41
+ _expand_proxy_tb_alias,
42
+ _extract_vqd,
43
+ _normalize,
44
+ _normalize_url,
45
+ _text_extract_json,
46
+ json_loads,
47
+ )
48
+
49
+ # logger = logging.getLogger("webscout.WEBS")
50
+
51
+
52
+ class WEBS:
53
+ """webscout class to get search results from duckduckgo.com."""
54
+
55
+ _executor: ThreadPoolExecutor = ThreadPoolExecutor()
56
+ # curl_cffi supports different browser versions than primp
57
+ _impersonates = (
58
+ "chrome99", "chrome100", "chrome101", "chrome104", "chrome107", "chrome110",
59
+ "chrome116", "chrome119", "chrome120", "chrome123", "chrome124", "chrome131", "chrome133a",
60
+ "chrome99_android", "chrome131_android",
61
+ "safari15_3", "safari15_5", "safari17_0", "safari17_2_ios", "safari18_0", "safari18_0_ios",
62
+ "edge99", "edge101",
63
+ "firefox133", "firefox135",
64
+ ) # fmt: skip
65
+ _impersonates_os = ("android", "ios", "linux", "macos", "windows")
66
+
67
+
68
+ def __init__(
69
+ self,
70
+ headers: dict[str, str] | None = None,
71
+ proxy: str | None = None,
72
+ proxies: dict[str, str] | str | None = None, # deprecated
73
+ timeout: int | None = 10,
74
+ verify: bool = True,
75
+ ) -> None:
76
+ """Initialize the WEBS object.
77
+
78
+ Args:
79
+ headers (dict, optional): Dictionary of headers for the HTTP client. Defaults to None.
80
+ proxy (str, optional): proxy for the HTTP client, supports http/https/socks5 protocols.
81
+ example: "http://user:pass@example.com:3128". Defaults to None.
82
+ timeout (int, optional): Timeout value for the HTTP client. Defaults to 10.
83
+ verify (bool): SSL verification when making the request. Defaults to True.
84
+ """
85
+ ddgs_proxy: str | None = os.environ.get("DDGS_PROXY")
86
+ self.proxy: str | None = ddgs_proxy if ddgs_proxy else _expand_proxy_tb_alias(proxy)
87
+ assert self.proxy is None or isinstance(self.proxy, str), "proxy must be a str"
88
+ if not proxy and proxies:
89
+ warnings.warn("'proxies' is deprecated, use 'proxy' instead.", stacklevel=1)
90
+ self.proxy = proxies.get("http") or proxies.get("https") if isinstance(proxies, dict) else proxies
91
+
92
+ default_headers = {
93
+ **LitAgent().generate_fingerprint(),
94
+ "Origin": "https://duckduckgo.com",
95
+ "Referer": "https://yep.com/",
96
+ }
97
+
98
+ self.headers = headers if headers else {}
99
+ self.headers.update(default_headers)
100
+
101
+ # curl_cffi has different parameters than primp
102
+ impersonate_browser = choice(self._impersonates)
103
+ self.client = curl_cffi.requests.Session(
104
+ headers=self.headers,
105
+ proxies={'http': self.proxy, 'https': self.proxy} if self.proxy else None,
106
+ timeout=timeout,
107
+ # curl_cffi doesn't accept cookies=True, it needs a dict or None
108
+ impersonate=impersonate_browser,
109
+ verify=verify,
110
+ )
111
+ self.timeout = timeout
112
+ self.sleep_timestamp = 0.0
113
+
114
+ self._exception_event = Event()
115
+
116
+ def __enter__(self) -> WEBS:
117
+ return self
118
+
119
+ def __exit__(
120
+ self,
121
+ exc_type: type[BaseException] | None = None,
122
+ exc_val: BaseException | None = None,
123
+ exc_tb: TracebackType | None = None,
124
+ ) -> None:
125
+ pass
126
+
127
+ @cached_property
128
+ def parser(self) -> LHTMLParser:
129
+ """Get HTML parser."""
130
+ return LHTMLParser(remove_blank_text=True, remove_comments=True, remove_pis=True, collect_ids=False)
131
+
132
+ def _sleep(self, sleeptime: float = 0.75) -> None:
133
+ """Sleep between API requests."""
134
+ delay = 0.0 if not self.sleep_timestamp else 0.0 if time() - self.sleep_timestamp >= 20 else sleeptime
135
+ self.sleep_timestamp = time()
136
+ sleep(delay)
137
+
138
+ def _get_url(
139
+ self,
140
+ method: Literal["GET", "HEAD", "OPTIONS", "DELETE", "POST", "PUT", "PATCH"],
141
+ url: str,
142
+ params: dict[str, str] | None = None,
143
+ content: bytes | None = None,
144
+ data: dict[str, str] | None = None,
145
+ headers: dict[str, str] | None = None,
146
+ cookies: dict[str, str] | None = None,
147
+ json: Any = None,
148
+ timeout: float | None = None,
149
+ ) -> Any:
150
+ self._sleep()
151
+ try:
152
+ # curl_cffi doesn't accept cookies=True in request methods
153
+ request_kwargs = {
154
+ "params": params,
155
+ "headers": headers,
156
+ "json": json,
157
+ "timeout": timeout or self.timeout,
158
+ }
159
+
160
+ # Add cookies if they're a dict, not a bool
161
+ if isinstance(cookies, dict):
162
+ request_kwargs["cookies"] = cookies
163
+
164
+ if method == "GET":
165
+ # curl_cffi uses data instead of content
166
+ if content:
167
+ request_kwargs["data"] = content
168
+ resp = self.client.get(url, **request_kwargs)
169
+ elif method == "POST":
170
+ # handle both data and content
171
+ if data or content:
172
+ request_kwargs["data"] = data or content
173
+ resp = self.client.post(url, **request_kwargs)
174
+ else:
175
+ # handle both data and content
176
+ if data or content:
177
+ request_kwargs["data"] = data or content
178
+ resp = self.client.request(method, url, **request_kwargs)
179
+ except Exception as ex:
180
+ if "time" in str(ex).lower():
181
+ raise TimeoutE(f"{url} {type(ex).__name__}: {ex}") from ex
182
+ raise WebscoutE(f"{url} {type(ex).__name__}: {ex}") from ex
183
+ if resp.status_code == 200:
184
+ return resp
185
+ elif resp.status_code in (202, 301, 403, 400, 429, 418):
186
+ raise RatelimitE(f"{resp.url} {resp.status_code} Ratelimit")
187
+ raise WebscoutE(f"{resp.url} return None. {params=} {content=} {data=}")
188
+
189
+ def _get_vqd(self, keywords: str) -> str:
190
+ """Get vqd value for a search query."""
191
+ resp_content = self._get_url("GET", "https://duckduckgo.com", params={"q": keywords}).content
192
+ return _extract_vqd(resp_content, keywords)
193
+
194
+
195
+
196
+ def text(
197
+ self,
198
+ keywords: str,
199
+ region: str = "wt-wt",
200
+ safesearch: str = "moderate",
201
+ timelimit: str | None = None,
202
+ backend: str = "auto",
203
+ max_results: int | None = None,
204
+ ) -> list[dict[str, str]]:
205
+ """webscout text search. Query params: https://duckduckgo.com/params.
206
+
207
+ Args:
208
+ keywords: keywords for query.
209
+ region: wt-wt, us-en, uk-en, ru-ru, etc. Defaults to "wt-wt".
210
+ safesearch: on, moderate, off. Defaults to "moderate".
211
+ timelimit: d, w, m, y. Defaults to None.
212
+ backend: auto, html, lite. Defaults to auto.
213
+ auto - try all backends in random order,
214
+ html - collect data from https://html.duckduckgo.com,
215
+ lite - collect data from https://lite.duckduckgo.com.
216
+ max_results: max number of results. If None, returns results only from the first response. Defaults to None.
217
+
218
+ Returns:
219
+ List of dictionaries with search results.
220
+
221
+ Raises:
222
+ WebscoutE: Base exception for webscout errors.
223
+ RatelimitE: Inherits from WebscoutE, raised for exceeding API request rate limits.
224
+ TimeoutE: Inherits from WebscoutE, raised for API request timeouts.
225
+ """
226
+ if backend in ("api", "ecosia"):
227
+ warnings.warn(f"{backend=} is deprecated, using backend='auto'", stacklevel=2)
228
+ backend = "auto"
229
+ backends = ["html", "lite"] if backend == "auto" else [backend]
230
+ shuffle(backends)
231
+
232
+ results, err = [], None
233
+ for b in backends:
234
+ try:
235
+ if b == "html":
236
+ results = self._text_html(keywords, region, timelimit, max_results)
237
+ elif b == "lite":
238
+ results = self._text_lite(keywords, region, timelimit, max_results)
239
+ return results
240
+ except Exception as ex:
241
+ err = ex
242
+
243
+ raise WebscoutE(err)
244
+
245
+ def _text_api(
246
+ self,
247
+ keywords: str,
248
+ region: str = "wt-wt",
249
+ safesearch: str = "moderate",
250
+ timelimit: str | None = None,
251
+ max_results: int | None = None,
252
+ ) -> list[dict[str, str]]:
253
+ """webscout text search. Query params: https://duckduckgo.com/params.
254
+
255
+ Args:
256
+ keywords: keywords for query.
257
+ region: wt-wt, us-en, uk-en, ru-ru, etc. Defaults to "wt-wt".
258
+ safesearch: on, moderate, off. Defaults to "moderate".
259
+ timelimit: d, w, m, y. Defaults to None.
260
+ max_results: max number of results. If None, returns results only from the first response. Defaults to None.
261
+
262
+ Returns:
263
+ List of dictionaries with search results.
264
+
265
+ Raises:
266
+ WebscoutE: Base exception for webscout errors.
267
+ RatelimitE: Inherits from WebscoutE, raised for exceeding API request rate limits.
268
+ TimeoutE: Inherits from WebscoutE, raised for API request timeouts.
269
+ """
270
+ assert keywords, "keywords is mandatory"
271
+
272
+ vqd = self._get_vqd(keywords)
273
+
274
+ payload = {
275
+ "q": keywords,
276
+ "kl": region,
277
+ "l": region,
278
+ "p": "",
279
+ "s": "0",
280
+ "df": "",
281
+ "vqd": vqd,
282
+ "bing_market": f"{region[3:]}-{region[:2].upper()}",
283
+ "ex": "",
284
+ }
285
+ safesearch = safesearch.lower()
286
+ if safesearch == "moderate":
287
+ payload["ex"] = "-1"
288
+ elif safesearch == "off":
289
+ payload["ex"] = "-2"
290
+ elif safesearch == "on": # strict
291
+ payload["p"] = "1"
292
+ if timelimit:
293
+ payload["df"] = timelimit
294
+
295
+ cache = set()
296
+ results: list[dict[str, str]] = []
297
+
298
+ def _text_api_page(s: int) -> list[dict[str, str]]:
299
+ payload["s"] = f"{s}"
300
+ resp_content = self._get_url("GET", "https://links.duckduckgo.com/d.js", params=payload).content
301
+ page_data = _text_extract_json(resp_content, keywords)
302
+ page_results = []
303
+ for row in page_data:
304
+ href = row.get("u", None)
305
+ if href and href not in cache and href != f"http://www.google.com/search?q={keywords}":
306
+ cache.add(href)
307
+ body = _normalize(row["a"])
308
+ if body:
309
+ result = {
310
+ "title": _normalize(row["t"]),
311
+ "href": _normalize_url(href),
312
+ "body": body,
313
+ }
314
+ page_results.append(result)
315
+ return page_results
316
+
317
+ slist = [0]
318
+ if max_results:
319
+ max_results = min(max_results, 2023)
320
+ slist.extend(range(23, max_results, 50))
321
+ try:
322
+ for r in self._executor.map(_text_api_page, slist):
323
+ results.extend(r)
324
+ except Exception as e:
325
+ raise e
326
+
327
+ return list(islice(results, max_results))
328
+
329
+ def _text_html(
330
+ self,
331
+ keywords: str,
332
+ region: str = "wt-wt",
333
+ timelimit: str | None = None,
334
+ max_results: int | None = None,
335
+ ) -> list[dict[str, str]]:
336
+ """webscout text search. Query params: https://duckduckgo.com/params.
337
+
338
+ Args:
339
+ keywords: keywords for query.
340
+ region: wt-wt, us-en, uk-en, ru-ru, etc. Defaults to "wt-wt".
341
+ timelimit: d, w, m, y. Defaults to None.
342
+ max_results: max number of results. If None, returns results only from the first response. Defaults to None.
343
+
344
+ Returns:
345
+ List of dictionaries with search results.
346
+
347
+ Raises:
348
+ WebscoutE: Base exception for webscout errors.
349
+ RatelimitE: Inherits from WebscoutE, raised for exceeding API request rate limits.
350
+ TimeoutE: Inherits from WebscoutE, raised for API request timeouts.
351
+ """
352
+ assert keywords, "keywords is mandatory"
353
+
354
+ payload = {
355
+ "q": keywords,
356
+ "s": "0",
357
+ "o": "json",
358
+ "api": "d.js",
359
+ "vqd": "",
360
+ "kl": region,
361
+ "bing_market": region,
362
+ }
363
+ if timelimit:
364
+ payload["df"] = timelimit
365
+ if max_results and max_results > 20:
366
+ vqd = self._get_vqd(keywords)
367
+ payload["vqd"] = vqd
368
+
369
+ cache = set()
370
+ results: list[dict[str, str]] = []
371
+
372
+ def _text_html_page(s: int) -> list[dict[str, str]]:
373
+ payload["s"] = f"{s}"
374
+ resp_content = self._get_url("POST", "https://html.duckduckgo.com/html", data=payload).content
375
+ if b"No results." in resp_content:
376
+ return []
377
+
378
+ page_results = []
379
+ # curl_cffi returns bytes, not a file-like object
380
+ tree = document_fromstring(resp_content)
381
+ elements = tree.xpath("//div[h2]")
382
+ if not isinstance(elements, list):
383
+ return []
384
+ for e in elements:
385
+ if isinstance(e, _Element):
386
+ hrefxpath = e.xpath("./a/@href")
387
+ href = str(hrefxpath[0]) if hrefxpath and isinstance(hrefxpath, list) else None
388
+ if (
389
+ href
390
+ and href not in cache
391
+ and not href.startswith(
392
+ ("http://www.google.com/search?q=", "https://duckduckgo.com/y.js?ad_domain")
393
+ )
394
+ ):
395
+ cache.add(href)
396
+ titlexpath = e.xpath("./h2/a/text()")
397
+ title = str(titlexpath[0]) if titlexpath and isinstance(titlexpath, list) else ""
398
+ bodyxpath = e.xpath("./a//text()")
399
+ body = "".join(str(x) for x in bodyxpath) if bodyxpath and isinstance(bodyxpath, list) else ""
400
+ result = {
401
+ "title": _normalize(title),
402
+ "href": _normalize_url(href),
403
+ "body": _normalize(body),
404
+ }
405
+ page_results.append(result)
406
+ return page_results
407
+
408
+ slist = [0]
409
+ if max_results:
410
+ max_results = min(max_results, 2023)
411
+ slist.extend(range(23, max_results, 50))
412
+ try:
413
+ for r in self._executor.map(_text_html_page, slist):
414
+ results.extend(r)
415
+ except Exception as e:
416
+ raise e
417
+
418
+ return list(islice(results, max_results))
419
+
420
+ def _text_lite(
421
+ self,
422
+ keywords: str,
423
+ region: str = "wt-wt",
424
+ timelimit: str | None = None,
425
+ max_results: int | None = None,
426
+ ) -> list[dict[str, str]]:
427
+ """webscout text search. Query params: https://duckduckgo.com/params.
428
+
429
+ Args:
430
+ keywords: keywords for query.
431
+ region: wt-wt, us-en, uk-en, ru-ru, etc. Defaults to "wt-wt".
432
+ timelimit: d, w, m, y. Defaults to None.
433
+ max_results: max number of results. If None, returns results only from the first response. Defaults to None.
434
+
435
+ Returns:
436
+ List of dictionaries with search results.
437
+
438
+ Raises:
439
+ WebscoutE: Base exception for webscout errors.
440
+ RatelimitE: Inherits from WebscoutE, raised for exceeding API request rate limits.
441
+ TimeoutE: Inherits from WebscoutE, raised for API request timeouts.
442
+ """
443
+ assert keywords, "keywords is mandatory"
444
+
445
+ payload = {
446
+ "q": keywords,
447
+ "s": "0",
448
+ "o": "json",
449
+ "api": "d.js",
450
+ "vqd": "",
451
+ "kl": region,
452
+ "bing_market": region,
453
+ }
454
+ if timelimit:
455
+ payload["df"] = timelimit
456
+
457
+ cache = set()
458
+ results: list[dict[str, str]] = []
459
+
460
+ def _text_lite_page(s: int) -> list[dict[str, str]]:
461
+ payload["s"] = f"{s}"
462
+ resp_content = self._get_url("POST", "https://lite.duckduckgo.com/lite/", data=payload).content
463
+ if b"No more results." in resp_content:
464
+ return []
465
+
466
+ page_results = []
467
+ # curl_cffi returns bytes, not a file-like object
468
+ tree = document_fromstring(resp_content)
469
+ elements = tree.xpath("//table[last()]//tr")
470
+ if not isinstance(elements, list):
471
+ return []
472
+
473
+ data = zip(cycle(range(1, 5)), elements)
474
+ for i, e in data:
475
+ if isinstance(e, _Element):
476
+ if i == 1:
477
+ hrefxpath = e.xpath(".//a//@href")
478
+ href = str(hrefxpath[0]) if hrefxpath and isinstance(hrefxpath, list) else None
479
+ if (
480
+ href is None
481
+ or href in cache
482
+ or href.startswith(
483
+ ("http://www.google.com/search?q=", "https://duckduckgo.com/y.js?ad_domain")
484
+ )
485
+ ):
486
+ [next(data, None) for _ in range(3)] # skip block(i=1,2,3,4)
487
+ else:
488
+ cache.add(href)
489
+ titlexpath = e.xpath(".//a//text()")
490
+ title = str(titlexpath[0]) if titlexpath and isinstance(titlexpath, list) else ""
491
+ elif i == 2:
492
+ bodyxpath = e.xpath(".//td[@class='result-snippet']//text()")
493
+ body = (
494
+ "".join(str(x) for x in bodyxpath).strip()
495
+ if bodyxpath and isinstance(bodyxpath, list)
496
+ else ""
497
+ )
498
+ if href:
499
+ result = {
500
+ "title": _normalize(title),
501
+ "href": _normalize_url(href),
502
+ "body": _normalize(body),
503
+ }
504
+ page_results.append(result)
505
+ return page_results
506
+
507
+ slist = [0]
508
+ if max_results:
509
+ max_results = min(max_results, 2023)
510
+ slist.extend(range(23, max_results, 50))
511
+ try:
512
+ for r in self._executor.map(_text_lite_page, slist):
513
+ results.extend(r)
514
+ except Exception as e:
515
+ raise e
516
+
517
+ return list(islice(results, max_results))
518
+
519
+ def images(
520
+ self,
521
+ keywords: str,
522
+ region: str = "wt-wt",
523
+ safesearch: str = "moderate",
524
+ timelimit: str | None = None,
525
+ size: str | None = None,
526
+ color: str | None = None,
527
+ type_image: str | None = None,
528
+ layout: str | None = None,
529
+ license_image: str | None = None,
530
+ max_results: int | None = None,
531
+ ) -> list[dict[str, str]]:
532
+ """webscout images search. Query params: https://duckduckgo.com/params.
533
+
534
+ Args:
535
+ keywords: keywords for query.
536
+ region: wt-wt, us-en, uk-en, ru-ru, etc. Defaults to "wt-wt".
537
+ safesearch: on, moderate, off. Defaults to "moderate".
538
+ timelimit: Day, Week, Month, Year. Defaults to None.
539
+ size: Small, Medium, Large, Wallpaper. Defaults to None.
540
+ color: color, Monochrome, Red, Orange, Yellow, Green, Blue,
541
+ Purple, Pink, Brown, Black, Gray, Teal, White. Defaults to None.
542
+ type_image: photo, clipart, gif, transparent, line.
543
+ Defaults to None.
544
+ layout: Square, Tall, Wide. Defaults to None.
545
+ license_image: any (All Creative Commons), Public (PublicDomain),
546
+ Share (Free to Share and Use), ShareCommercially (Free to Share and Use Commercially),
547
+ Modify (Free to Modify, Share, and Use), ModifyCommercially (Free to Modify, Share, and
548
+ Use Commercially). Defaults to None.
549
+ max_results: max number of results. If None, returns results only from the first response. Defaults to None.
550
+
551
+ Returns:
552
+ List of dictionaries with images search results.
553
+
554
+ Raises:
555
+ WebscoutE: Base exception for webscout errors.
556
+ RatelimitE: Inherits from WebscoutE, raised for exceeding API request rate limits.
557
+ TimeoutE: Inherits from WebscoutE, raised for API request timeouts.
558
+ """
559
+ assert keywords, "keywords is mandatory"
560
+
561
+ vqd = self._get_vqd(keywords)
562
+
563
+ safesearch_base = {"on": "1", "moderate": "1", "off": "-1"}
564
+ timelimit = f"time:{timelimit}" if timelimit else ""
565
+ size = f"size:{size}" if size else ""
566
+ color = f"color:{color}" if color else ""
567
+ type_image = f"type:{type_image}" if type_image else ""
568
+ layout = f"layout:{layout}" if layout else ""
569
+ license_image = f"license:{license_image}" if license_image else ""
570
+ payload = {
571
+ "l": region,
572
+ "o": "json",
573
+ "q": keywords,
574
+ "vqd": vqd,
575
+ "f": f"{timelimit},{size},{color},{type_image},{layout},{license_image}",
576
+ "p": safesearch_base[safesearch.lower()],
577
+ }
578
+
579
+ cache = set()
580
+ results: list[dict[str, str]] = []
581
+
582
+ def _images_page(s: int) -> list[dict[str, str]]:
583
+ payload["s"] = f"{s}"
584
+ resp_content = self._get_url("GET", "https://duckduckgo.com/i.js", params=payload).content
585
+ resp_json = json_loads(resp_content)
586
+
587
+ page_data = resp_json.get("results", [])
588
+ page_results = []
589
+ for row in page_data:
590
+ image_url = row.get("image")
591
+ if image_url and image_url not in cache:
592
+ cache.add(image_url)
593
+ result = {
594
+ "title": row["title"],
595
+ "image": _normalize_url(image_url),
596
+ "thumbnail": _normalize_url(row["thumbnail"]),
597
+ "url": _normalize_url(row["url"]),
598
+ "height": row["height"],
599
+ "width": row["width"],
600
+ "source": row["source"],
601
+ }
602
+ page_results.append(result)
603
+ return page_results
604
+
605
+ slist = [0]
606
+ if max_results:
607
+ max_results = min(max_results, 500)
608
+ slist.extend(range(100, max_results, 100))
609
+ try:
610
+ for r in self._executor.map(_images_page, slist):
611
+ results.extend(r)
612
+ except Exception as e:
613
+ raise e
614
+
615
+ return list(islice(results, max_results))
616
+
617
+ def videos(
618
+ self,
619
+ keywords: str,
620
+ region: str = "wt-wt",
621
+ safesearch: str = "moderate",
622
+ timelimit: str | None = None,
623
+ resolution: str | None = None,
624
+ duration: str | None = None,
625
+ license_videos: str | None = None,
626
+ max_results: int | None = None,
627
+ ) -> list[dict[str, str]]:
628
+ """webscout videos search. Query params: https://duckduckgo.com/params.
629
+
630
+ Args:
631
+ keywords: keywords for query.
632
+ region: wt-wt, us-en, uk-en, ru-ru, etc. Defaults to "wt-wt".
633
+ safesearch: on, moderate, off. Defaults to "moderate".
634
+ timelimit: d, w, m. Defaults to None.
635
+ resolution: high, standart. Defaults to None.
636
+ duration: short, medium, long. Defaults to None.
637
+ license_videos: creativeCommon, youtube. Defaults to None.
638
+ max_results: max number of results. If None, returns results only from the first response. Defaults to None.
639
+
640
+ Returns:
641
+ List of dictionaries with videos search results.
642
+
643
+ Raises:
644
+ WebscoutE: Base exception for webscout errors.
645
+ RatelimitE: Inherits from WebscoutE, raised for exceeding API request rate limits.
646
+ TimeoutE: Inherits from WebscoutE, raised for API request timeouts.
647
+ """
648
+ assert keywords, "keywords is mandatory"
649
+
650
+ vqd = self._get_vqd(keywords)
651
+
652
+ safesearch_base = {"on": "1", "moderate": "-1", "off": "-2"}
653
+ timelimit = f"publishedAfter:{timelimit}" if timelimit else ""
654
+ resolution = f"videoDefinition:{resolution}" if resolution else ""
655
+ duration = f"videoDuration:{duration}" if duration else ""
656
+ license_videos = f"videoLicense:{license_videos}" if license_videos else ""
657
+ payload = {
658
+ "l": region,
659
+ "o": "json",
660
+ "q": keywords,
661
+ "vqd": vqd,
662
+ "f": f"{timelimit},{resolution},{duration},{license_videos}",
663
+ "p": safesearch_base[safesearch.lower()],
664
+ }
665
+
666
+ cache = set()
667
+ results: list[dict[str, str]] = []
668
+
669
+ def _videos_page(s: int) -> list[dict[str, str]]:
670
+ payload["s"] = f"{s}"
671
+ resp_content = self._get_url("GET", "https://duckduckgo.com/v.js", params=payload).content
672
+ resp_json = json_loads(resp_content)
673
+
674
+ page_data = resp_json.get("results", [])
675
+ page_results = []
676
+ for row in page_data:
677
+ if row["content"] not in cache:
678
+ cache.add(row["content"])
679
+ page_results.append(row)
680
+ return page_results
681
+
682
+ slist = [0]
683
+ if max_results:
684
+ max_results = min(max_results, 400)
685
+ slist.extend(range(60, max_results, 60))
686
+ try:
687
+ for r in self._executor.map(_videos_page, slist):
688
+ results.extend(r)
689
+ except Exception as e:
690
+ raise e
691
+
692
+ return list(islice(results, max_results))
693
+
694
+ def news(
695
+ self,
696
+ keywords: str,
697
+ region: str = "wt-wt",
698
+ safesearch: str = "moderate",
699
+ timelimit: str | None = None,
700
+ max_results: int | None = None,
701
+ ) -> list[dict[str, str]]:
702
+ """webscout news search. Query params: https://duckduckgo.com/params.
703
+
704
+ Args:
705
+ keywords: keywords for query.
706
+ region: wt-wt, us-en, uk-en, ru-ru, etc. Defaults to "wt-wt".
707
+ safesearch: on, moderate, off. Defaults to "moderate".
708
+ timelimit: d, w, m. Defaults to None.
709
+ max_results: max number of results. If None, returns results only from the first response. Defaults to None.
710
+
711
+ Returns:
712
+ List of dictionaries with news search results.
713
+
714
+ Raises:
715
+ WebscoutE: Base exception for webscout errors.
716
+ RatelimitE: Inherits from WebscoutE, raised for exceeding API request rate limits.
717
+ TimeoutE: Inherits from WebscoutE, raised for API request timeouts.
718
+ """
719
+ assert keywords, "keywords is mandatory"
720
+
721
+ vqd = self._get_vqd(keywords)
722
+
723
+ safesearch_base = {"on": "1", "moderate": "-1", "off": "-2"}
724
+ payload = {
725
+ "l": region,
726
+ "o": "json",
727
+ "noamp": "1",
728
+ "q": keywords,
729
+ "vqd": vqd,
730
+ "p": safesearch_base[safesearch.lower()],
731
+ }
732
+ if timelimit:
733
+ payload["df"] = timelimit
734
+
735
+ cache = set()
736
+ results: list[dict[str, str]] = []
737
+
738
+ def _news_page(s: int) -> list[dict[str, str]]:
739
+ payload["s"] = f"{s}"
740
+ resp_content = self._get_url("GET", "https://duckduckgo.com/news.js", params=payload).content
741
+ resp_json = json_loads(resp_content)
742
+ page_data = resp_json.get("results", [])
743
+ page_results = []
744
+ for row in page_data:
745
+ if row["url"] not in cache:
746
+ cache.add(row["url"])
747
+ image_url = row.get("image", None)
748
+ result = {
749
+ "date": datetime.fromtimestamp(row["date"], timezone.utc).isoformat(),
750
+ "title": row["title"],
751
+ "body": _normalize(row["excerpt"]),
752
+ "url": _normalize_url(row["url"]),
753
+ "image": _normalize_url(image_url),
754
+ "source": row["source"],
755
+ }
756
+ page_results.append(result)
757
+ return page_results
758
+
759
+ slist = [0]
760
+ if max_results:
761
+ max_results = min(max_results, 120)
762
+ slist.extend(range(30, max_results, 30))
763
+ try:
764
+ for r in self._executor.map(_news_page, slist):
765
+ results.extend(r)
766
+ except Exception as e:
767
+ raise e
768
+
769
+ return list(islice(results, max_results))
770
+
771
+ def answers(self, keywords: str) -> list[dict[str, str]]:
772
+ """webscout instant answers. Query params: https://duckduckgo.com/params.
773
+
774
+ Args:
775
+ keywords: keywords for query,
776
+
777
+ Returns:
778
+ List of dictionaries with instant answers results.
779
+
780
+ Raises:
781
+ WebscoutE: Base exception for webscout errors.
782
+ RatelimitE: Inherits from WebscoutE, raised for exceeding API request rate limits.
783
+ TimeoutE: Inherits from WebscoutE, raised for API request timeouts.
784
+ """
785
+ assert keywords, "keywords is mandatory"
786
+
787
+ payload = {
788
+ "q": f"what is {keywords}",
789
+ "format": "json",
790
+ }
791
+ resp_content = self._get_url("GET", "https://api.duckduckgo.com/", params=payload).content
792
+ page_data = json_loads(resp_content)
793
+
794
+ results = []
795
+ answer = page_data.get("AbstractText")
796
+ url = page_data.get("AbstractURL")
797
+ if answer:
798
+ results.append(
799
+ {
800
+ "icon": None,
801
+ "text": answer,
802
+ "topic": None,
803
+ "url": url,
804
+ }
805
+ )
806
+
807
+ # related
808
+ payload = {
809
+ "q": f"{keywords}",
810
+ "format": "json",
811
+ }
812
+ resp_content = self._get_url("GET", "https://api.duckduckgo.com/", params=payload).content
813
+ resp_json = json_loads(resp_content)
814
+ page_data = resp_json.get("RelatedTopics", [])
815
+
816
+ for row in page_data:
817
+ topic = row.get("Name")
818
+ if not topic:
819
+ icon = row["Icon"].get("URL")
820
+ results.append(
821
+ {
822
+ "icon": f"https://duckduckgo.com{icon}" if icon else "",
823
+ "text": row["Text"],
824
+ "topic": None,
825
+ "url": row["FirstURL"],
826
+ }
827
+ )
828
+ else:
829
+ for subrow in row["Topics"]:
830
+ icon = subrow["Icon"].get("URL")
831
+ results.append(
832
+ {
833
+ "icon": f"https://duckduckgo.com{icon}" if icon else "",
834
+ "text": subrow["Text"],
835
+ "topic": topic,
836
+ "url": subrow["FirstURL"],
837
+ }
838
+ )
839
+
840
+ return results
841
+
842
+ def suggestions(self, keywords: str, region: str = "wt-wt") -> list[dict[str, str]]:
843
+ """webscout suggestions. Query params: https://duckduckgo.com/params.
844
+
845
+ Args:
846
+ keywords: keywords for query.
847
+ region: wt-wt, us-en, uk-en, ru-ru, etc. Defaults to "wt-wt".
848
+
849
+ Returns:
850
+ List of dictionaries with suggestions results.
851
+
852
+ Raises:
853
+ WebscoutE: Base exception for webscout errors.
854
+ RatelimitE: Inherits from WebscoutE, raised for exceeding API request rate limits.
855
+ TimeoutE: Inherits from WebscoutE, raised for API request timeouts.
856
+ """
857
+ assert keywords, "keywords is mandatory"
858
+
859
+ payload = {
860
+ "q": keywords,
861
+ "kl": region,
862
+ }
863
+ resp_content = self._get_url("GET", "https://duckduckgo.com/ac/", params=payload).content
864
+ page_data = json_loads(resp_content)
865
+ return [r for r in page_data]
866
+
867
+ def maps(
868
+ self,
869
+ keywords: str,
870
+ place: str | None = None,
871
+ street: str | None = None,
872
+ city: str | None = None,
873
+ county: str | None = None,
874
+ state: str | None = None,
875
+ country: str | None = None,
876
+ postalcode: str | None = None,
877
+ latitude: str | None = None,
878
+ longitude: str | None = None,
879
+ radius: int = 0,
880
+ max_results: int | None = None,
881
+ ) -> list[dict[str, str]]:
882
+ """webscout maps search. Query params: https://duckduckgo.com/params.
883
+
884
+ Args:
885
+ keywords: keywords for query
886
+ place: if set, the other parameters are not used. Defaults to None.
887
+ street: house number/street. Defaults to None.
888
+ city: city of search. Defaults to None.
889
+ county: county of search. Defaults to None.
890
+ state: state of search. Defaults to None.
891
+ country: country of search. Defaults to None.
892
+ postalcode: postalcode of search. Defaults to None.
893
+ latitude: geographic coordinate (north-south position). Defaults to None.
894
+ longitude: geographic coordinate (east-west position); if latitude and
895
+ longitude are set, the other parameters are not used. Defaults to None.
896
+ radius: expand the search square by the distance in kilometers. Defaults to 0.
897
+ max_results: max number of results. If None, returns results only from the first response. Defaults to None.
898
+
899
+ Returns:
900
+ List of dictionaries with maps search results, or None if there was an error.
901
+
902
+ Raises:
903
+ WebscoutE: Base exception for webscout errors.
904
+ RatelimitE: Inherits from WebscoutE, raised for exceeding API request rate limits.
905
+ TimeoutE: Inherits from WebscoutE, raised for API request timeouts.
906
+ """
907
+ assert keywords, "keywords is mandatory"
908
+
909
+ vqd = self._get_vqd(keywords)
910
+
911
+ # if longitude and latitude are specified, skip the request about bbox to the nominatim api
912
+ if latitude and longitude:
913
+ lat_t = Decimal(latitude.replace(",", "."))
914
+ lat_b = Decimal(latitude.replace(",", "."))
915
+ lon_l = Decimal(longitude.replace(",", "."))
916
+ lon_r = Decimal(longitude.replace(",", "."))
917
+ if radius == 0:
918
+ radius = 1
919
+ # otherwise request about bbox to nominatim api
920
+ else:
921
+ if place:
922
+ params = {
923
+ "q": place,
924
+ "polygon_geojson": "0",
925
+ "format": "jsonv2",
926
+ }
927
+ else:
928
+ params = {
929
+ "polygon_geojson": "0",
930
+ "format": "jsonv2",
931
+ }
932
+ if street:
933
+ params["street"] = street
934
+ if city:
935
+ params["city"] = city
936
+ if county:
937
+ params["county"] = county
938
+ if state:
939
+ params["state"] = state
940
+ if country:
941
+ params["country"] = country
942
+ if postalcode:
943
+ params["postalcode"] = postalcode
944
+ # request nominatim api to get coordinates box
945
+ resp_content = self._get_url(
946
+ "GET",
947
+ "https://nominatim.openstreetmap.org/search.php",
948
+ params=params,
949
+ ).content
950
+ if resp_content == b"[]":
951
+ raise WebscoutE("maps() Coordinates are not found, check function parameters.")
952
+ resp_json = json_loads(resp_content)
953
+ coordinates = resp_json[0]["boundingbox"]
954
+ lat_t, lon_l = Decimal(coordinates[1]), Decimal(coordinates[2])
955
+ lat_b, lon_r = Decimal(coordinates[0]), Decimal(coordinates[3])
956
+
957
+ # if a radius is specified, expand the search square
958
+ lat_t += Decimal(radius) * Decimal(0.008983)
959
+ lat_b -= Decimal(radius) * Decimal(0.008983)
960
+ lon_l -= Decimal(radius) * Decimal(0.008983)
961
+ lon_r += Decimal(radius) * Decimal(0.008983)
962
+ # logger.debug(f"bbox coordinates\n{lat_t} {lon_l}\n{lat_b} {lon_r}")
963
+
964
+ cache = set()
965
+ results: list[dict[str, str]] = []
966
+
967
+ def _maps_page(
968
+ bbox: tuple[Decimal, Decimal, Decimal, Decimal],
969
+ ) -> list[dict[str, str]] | None:
970
+ if max_results and len(results) >= max_results:
971
+ return None
972
+ lat_t, lon_l, lat_b, lon_r = bbox
973
+ params = {
974
+ "q": keywords,
975
+ "vqd": vqd,
976
+ "tg": "maps_places",
977
+ "rt": "D",
978
+ "mkexp": "b",
979
+ "wiki_info": "1",
980
+ "is_requery": "1",
981
+ "bbox_tl": f"{lat_t},{lon_l}",
982
+ "bbox_br": f"{lat_b},{lon_r}",
983
+ "strict_bbox": "1",
984
+ }
985
+ resp_content = self._get_url("GET", "https://duckduckgo.com/local.js", params=params).content
986
+ resp_json = json_loads(resp_content)
987
+ page_data = resp_json.get("results", [])
988
+
989
+ page_results = []
990
+ for res in page_data:
991
+ r_name = f'{res["name"]} {res["address"]}'
992
+ if r_name in cache:
993
+ continue
994
+ else:
995
+ cache.add(r_name)
996
+ result = {
997
+ "title": res["name"],
998
+ "address": res["address"],
999
+ "country_code": res["country_code"],
1000
+ "url": _normalize_url(res["website"]),
1001
+ "phone": res["phone"] or "",
1002
+ "latitude": res["coordinates"]["latitude"],
1003
+ "longitude": res["coordinates"]["longitude"],
1004
+ "source": _normalize_url(res["url"]),
1005
+ "image": x.get("image", "") if (x := res["embed"]) else "",
1006
+ "desc": x.get("description", "") if (x := res["embed"]) else "",
1007
+ "hours": res["hours"] or "",
1008
+ "category": res["ddg_category"] or "",
1009
+ "facebook": f"www.facebook.com/profile.php?id={x}" if (x := res["facebook_id"]) else "",
1010
+ "instagram": f"https://www.instagram.com/{x}" if (x := res["instagram_id"]) else "",
1011
+ "twitter": f"https://twitter.com/{x}" if (x := res["twitter_id"]) else "",
1012
+ }
1013
+ page_results.append(result)
1014
+ return page_results
1015
+
1016
+ # search squares (bboxes)
1017
+ start_bbox = (lat_t, lon_l, lat_b, lon_r)
1018
+ work_bboxes = [start_bbox]
1019
+ while work_bboxes:
1020
+ queue_bboxes = [] # for next iteration, at the end of the iteration work_bboxes = queue_bboxes
1021
+ tasks = []
1022
+ for bbox in work_bboxes:
1023
+ tasks.append(bbox)
1024
+ # if distance between coordinates > 1, divide the square into 4 parts and save them in queue_bboxes
1025
+ if _calculate_distance(lat_t, lon_l, lat_b, lon_r) > 1:
1026
+ lat_t, lon_l, lat_b, lon_r = bbox
1027
+ lat_middle = (lat_t + lat_b) / 2
1028
+ lon_middle = (lon_l + lon_r) / 2
1029
+ bbox1 = (lat_t, lon_l, lat_middle, lon_middle)
1030
+ bbox2 = (lat_t, lon_middle, lat_middle, lon_r)
1031
+ bbox3 = (lat_middle, lon_l, lat_b, lon_middle)
1032
+ bbox4 = (lat_middle, lon_middle, lat_b, lon_r)
1033
+ queue_bboxes.extend([bbox1, bbox2, bbox3, bbox4])
1034
+
1035
+ # gather tasks using asyncio.wait_for and timeout
1036
+ work_bboxes_results = []
1037
+ try:
1038
+ for r in self._executor.map(_maps_page, tasks):
1039
+ if r:
1040
+ work_bboxes_results.extend(r)
1041
+ except Exception as e:
1042
+ raise e
1043
+
1044
+ for x in work_bboxes_results:
1045
+ if isinstance(x, list):
1046
+ results.extend(x)
1047
+ elif isinstance(x, dict):
1048
+ results.append(x)
1049
+
1050
+ work_bboxes = queue_bboxes
1051
+ if not max_results or len(results) >= max_results or len(work_bboxes_results) == 0:
1052
+ break
1053
+
1054
+ return list(islice(results, max_results))
1055
+
1056
+ def translate(self, keywords: list[str] | str, from_: str | None = None, to: str = "en") -> list[dict[str, str]]:
1057
+ """webscout translate.
1058
+
1059
+ Args:
1060
+ keywords: string or list of strings to translate.
1061
+ from_: translate from (defaults automatically). Defaults to None.
1062
+ to: what language to translate. Defaults to "en".
1063
+
1064
+ Returns:
1065
+ List od dictionaries with translated keywords.
1066
+
1067
+ Raises:
1068
+ WebscoutE: Base exception for webscout errors.
1069
+ RatelimitE: Inherits from WebscoutE, raised for exceeding API request rate limits.
1070
+ TimeoutE: Inherits from WebscoutE, raised for API request timeouts.
1071
+ """
1072
+ assert keywords, "keywords is mandatory"
1073
+
1074
+ vqd = self._get_vqd("translate")
1075
+
1076
+ payload = {
1077
+ "vqd": vqd,
1078
+ "query": "translate",
1079
+ "to": to,
1080
+ }
1081
+ if from_:
1082
+ payload["from"] = from_
1083
+
1084
+ def _translate_keyword(keyword: str) -> dict[str, str]:
1085
+ resp_content = self._get_url(
1086
+ "POST",
1087
+ "https://duckduckgo.com/translation.js",
1088
+ params=payload,
1089
+ content=keyword.encode(),
1090
+ ).content
1091
+ page_data: dict[str, str] = json_loads(resp_content)
1092
+ page_data["original"] = keyword
1093
+ return page_data
1094
+
1095
+ if isinstance(keywords, str):
1096
+ keywords = [keywords]
1097
+
1098
+ results = []
1099
+ try:
1100
+ for r in self._executor.map(_translate_keyword, keywords):
1101
+ results.append(r)
1102
+ except Exception as e:
1103
+ raise e
1104
+
1105
+ return results
1106
+
1107
+ def weather(
1108
+ self,
1109
+ location: str,
1110
+ language: str = "en",
1111
+ ) -> dict[str, Any]:
1112
+ """Get weather information for a location from DuckDuckGo.
1113
+
1114
+ Args:
1115
+ location: Location to get weather for.
1116
+ language: Language code (e.g. 'en', 'es'). Defaults to "en".
1117
+
1118
+ Returns:
1119
+ Dictionary containing weather data with structure described in docstring.
1120
+
1121
+ Raises:
1122
+ WebscoutE: Base exception for webscout errors.
1123
+ RatelimitE: Inherits from WebscoutE, raised for exceeding API request rate limits.
1124
+ TimeoutE: Inherits from WebscoutE, raised for API request timeouts.
1125
+ """
1126
+ assert location, "location is mandatory"
1127
+ lang = language.split('-')[0]
1128
+ url = f"https://duckduckgo.com/js/spice/forecast/{quote(location)}/{lang}"
1129
+
1130
+ resp = self._get_url("GET", url).content
1131
+ resp_text = resp.decode('utf-8')
1132
+
1133
+ if "ddg_spice_forecast(" not in resp_text:
1134
+ raise WebscoutE(f"No weather data found for {location}")
1135
+
1136
+ json_text = resp_text[resp_text.find('(') + 1:resp_text.rfind(')')]
1137
+ try:
1138
+ result = json.loads(json_text)
1139
+ except Exception as e:
1140
+ raise WebscoutE(f"Error parsing weather JSON: {e}")
1141
+
1142
+ if not result or 'currentWeather' not in result or 'forecastDaily' not in result:
1143
+ raise WebscoutE(f"Invalid weather data format for {location}")
1144
+
1145
+ formatted_data = {
1146
+ "location": result["currentWeather"]["metadata"].get("ddg-location", "Unknown"),
1147
+ "current": {
1148
+ "condition": result["currentWeather"].get("conditionCode"),
1149
+ "temperature_c": result["currentWeather"].get("temperature"),
1150
+ "feels_like_c": result["currentWeather"].get("temperatureApparent"),
1151
+ "humidity": result["currentWeather"].get("humidity"),
1152
+ "wind_speed_ms": result["currentWeather"].get("windSpeed"),
1153
+ "wind_direction": result["currentWeather"].get("windDirection"),
1154
+ "visibility_m": result["currentWeather"].get("visibility"),
1155
+ },
1156
+ "daily_forecast": [],
1157
+ "hourly_forecast": []
1158
+ }
1159
+
1160
+ for day in result["forecastDaily"]["days"]:
1161
+ formatted_data["daily_forecast"].append({
1162
+ "date": datetime.fromisoformat(day["forecastStart"].replace("Z", "+00:00")).strftime("%Y-%m-%d"),
1163
+ "condition": day["daytimeForecast"].get("conditionCode"),
1164
+ "max_temp_c": day["temperatureMax"],
1165
+ "min_temp_c": day["temperatureMin"],
1166
+ "sunrise": datetime.fromisoformat(day["sunrise"].replace("Z", "+00:00")).strftime("%H:%M"),
1167
+ "sunset": datetime.fromisoformat(day["sunset"].replace("Z", "+00:00")).strftime("%H:%M"),
1168
+ })
1169
+
1170
+ if 'forecastHourly' in result and 'hours' in result['forecastHourly']:
1171
+ for hour in result['forecastHourly']['hours']:
1172
+ formatted_data["hourly_forecast"].append({
1173
+ "time": datetime.fromisoformat(hour["forecastStart"].replace("Z", "+00:00")).strftime("%H:%M"),
1174
+ "condition": hour.get("conditionCode"),
1175
+ "temperature_c": hour.get("temperature"),
1176
+ "feels_like_c": hour.get("temperatureApparent"),
1177
+ "humidity": hour.get("humidity"),
1178
+ "wind_speed_ms": hour.get("windSpeed"),
1179
+ "wind_direction": hour.get("windDirection"),
1180
+ "visibility_m": hour.get("visibility"),
1181
+ })
1182
+
1183
+ return formatted_data