webscout 8.3.7__py3-none-any.whl → 2025.10.13__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 (306) hide show
  1. webscout/AIauto.py +250 -250
  2. webscout/AIbase.py +379 -379
  3. webscout/AIutel.py +60 -60
  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 +16 -1
  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 -316
  61. webscout/Provider/AISEARCH/stellar_search.py +177 -177
  62. webscout/Provider/AISEARCH/webpilotai_search.py +255 -255
  63. webscout/Provider/Aitopia.py +314 -314
  64. webscout/Provider/Andi.py +1 -1
  65. webscout/Provider/Apriel.py +306 -0
  66. webscout/Provider/ChatGPTClone.py +237 -236
  67. webscout/Provider/ChatSandbox.py +343 -343
  68. webscout/Provider/Cloudflare.py +324 -324
  69. webscout/Provider/Cohere.py +208 -208
  70. webscout/Provider/Deepinfra.py +370 -366
  71. webscout/Provider/ExaAI.py +260 -260
  72. webscout/Provider/ExaChat.py +308 -308
  73. webscout/Provider/Flowith.py +221 -221
  74. webscout/Provider/GMI.py +293 -0
  75. webscout/Provider/Gemini.py +164 -164
  76. webscout/Provider/GeminiProxy.py +167 -167
  77. webscout/Provider/GithubChat.py +371 -372
  78. webscout/Provider/Groq.py +800 -800
  79. webscout/Provider/HeckAI.py +383 -383
  80. webscout/Provider/Jadve.py +282 -282
  81. webscout/Provider/K2Think.py +307 -307
  82. webscout/Provider/Koboldai.py +205 -205
  83. webscout/Provider/LambdaChat.py +423 -423
  84. webscout/Provider/Nemotron.py +244 -244
  85. webscout/Provider/Netwrck.py +248 -248
  86. webscout/Provider/OLLAMA.py +395 -395
  87. webscout/Provider/OPENAI/Cloudflare.py +393 -393
  88. webscout/Provider/OPENAI/FalconH1.py +451 -451
  89. webscout/Provider/OPENAI/FreeGemini.py +296 -296
  90. webscout/Provider/OPENAI/K2Think.py +431 -431
  91. webscout/Provider/OPENAI/NEMOTRON.py +240 -240
  92. webscout/Provider/OPENAI/PI.py +427 -427
  93. webscout/Provider/OPENAI/README.md +959 -959
  94. webscout/Provider/OPENAI/TogetherAI.py +345 -345
  95. webscout/Provider/OPENAI/TwoAI.py +465 -465
  96. webscout/Provider/OPENAI/__init__.py +33 -18
  97. webscout/Provider/OPENAI/base.py +248 -248
  98. webscout/Provider/OPENAI/chatglm.py +528 -0
  99. webscout/Provider/OPENAI/chatgpt.py +592 -592
  100. webscout/Provider/OPENAI/chatgptclone.py +521 -521
  101. webscout/Provider/OPENAI/chatsandbox.py +202 -202
  102. webscout/Provider/OPENAI/deepinfra.py +318 -314
  103. webscout/Provider/OPENAI/e2b.py +1665 -1665
  104. webscout/Provider/OPENAI/exaai.py +420 -420
  105. webscout/Provider/OPENAI/exachat.py +452 -452
  106. webscout/Provider/OPENAI/friendli.py +232 -232
  107. webscout/Provider/OPENAI/{refact.py → gmi.py} +324 -274
  108. webscout/Provider/OPENAI/groq.py +364 -364
  109. webscout/Provider/OPENAI/heckai.py +314 -314
  110. webscout/Provider/OPENAI/llmchatco.py +337 -337
  111. webscout/Provider/OPENAI/netwrck.py +355 -355
  112. webscout/Provider/OPENAI/oivscode.py +290 -290
  113. webscout/Provider/OPENAI/opkfc.py +518 -518
  114. webscout/Provider/OPENAI/pydantic_imports.py +1 -1
  115. webscout/Provider/OPENAI/scirachat.py +535 -535
  116. webscout/Provider/OPENAI/sonus.py +308 -308
  117. webscout/Provider/OPENAI/standardinput.py +442 -442
  118. webscout/Provider/OPENAI/textpollinations.py +340 -340
  119. webscout/Provider/OPENAI/toolbaz.py +419 -416
  120. webscout/Provider/OPENAI/typefully.py +362 -362
  121. webscout/Provider/OPENAI/utils.py +295 -295
  122. webscout/Provider/OPENAI/venice.py +436 -436
  123. webscout/Provider/OPENAI/wisecat.py +387 -387
  124. webscout/Provider/OPENAI/writecream.py +166 -166
  125. webscout/Provider/OPENAI/x0gpt.py +378 -378
  126. webscout/Provider/OPENAI/yep.py +389 -389
  127. webscout/Provider/OpenGPT.py +230 -230
  128. webscout/Provider/Openai.py +243 -243
  129. webscout/Provider/PI.py +405 -405
  130. webscout/Provider/Perplexitylabs.py +430 -430
  131. webscout/Provider/QwenLM.py +272 -272
  132. webscout/Provider/STT/__init__.py +16 -1
  133. webscout/Provider/Sambanova.py +257 -257
  134. webscout/Provider/StandardInput.py +309 -309
  135. webscout/Provider/TTI/README.md +82 -82
  136. webscout/Provider/TTI/__init__.py +33 -18
  137. webscout/Provider/TTI/aiarta.py +413 -413
  138. webscout/Provider/TTI/base.py +136 -136
  139. webscout/Provider/TTI/bing.py +243 -243
  140. webscout/Provider/TTI/gpt1image.py +149 -149
  141. webscout/Provider/TTI/imagen.py +196 -196
  142. webscout/Provider/TTI/infip.py +211 -211
  143. webscout/Provider/TTI/magicstudio.py +232 -232
  144. webscout/Provider/TTI/monochat.py +219 -219
  145. webscout/Provider/TTI/piclumen.py +214 -214
  146. webscout/Provider/TTI/pixelmuse.py +232 -232
  147. webscout/Provider/TTI/pollinations.py +232 -232
  148. webscout/Provider/TTI/together.py +288 -288
  149. webscout/Provider/TTI/utils.py +12 -12
  150. webscout/Provider/TTI/venice.py +367 -367
  151. webscout/Provider/TTS/README.md +192 -192
  152. webscout/Provider/TTS/__init__.py +33 -18
  153. webscout/Provider/TTS/parler.py +110 -110
  154. webscout/Provider/TTS/streamElements.py +333 -333
  155. webscout/Provider/TTS/utils.py +280 -280
  156. webscout/Provider/TeachAnything.py +237 -237
  157. webscout/Provider/TextPollinationsAI.py +310 -310
  158. webscout/Provider/TogetherAI.py +356 -356
  159. webscout/Provider/TwoAI.py +312 -312
  160. webscout/Provider/TypliAI.py +311 -311
  161. webscout/Provider/UNFINISHED/ChatHub.py +208 -208
  162. webscout/Provider/UNFINISHED/ChutesAI.py +313 -313
  163. webscout/Provider/UNFINISHED/GizAI.py +294 -294
  164. webscout/Provider/UNFINISHED/Marcus.py +198 -198
  165. webscout/Provider/UNFINISHED/Qodo.py +477 -477
  166. webscout/Provider/UNFINISHED/VercelAIGateway.py +338 -338
  167. webscout/Provider/UNFINISHED/XenAI.py +324 -324
  168. webscout/Provider/UNFINISHED/Youchat.py +330 -330
  169. webscout/Provider/UNFINISHED/liner.py +334 -0
  170. webscout/Provider/UNFINISHED/liner_api_request.py +262 -262
  171. webscout/Provider/UNFINISHED/puterjs.py +634 -634
  172. webscout/Provider/UNFINISHED/samurai.py +223 -223
  173. webscout/Provider/UNFINISHED/test_lmarena.py +119 -119
  174. webscout/Provider/Venice.py +250 -250
  175. webscout/Provider/VercelAI.py +256 -256
  176. webscout/Provider/WiseCat.py +231 -231
  177. webscout/Provider/WrDoChat.py +366 -366
  178. webscout/Provider/__init__.py +33 -18
  179. webscout/Provider/ai4chat.py +174 -174
  180. webscout/Provider/akashgpt.py +331 -331
  181. webscout/Provider/cerebras.py +446 -446
  182. webscout/Provider/chatglm.py +394 -301
  183. webscout/Provider/cleeai.py +211 -211
  184. webscout/Provider/elmo.py +282 -282
  185. webscout/Provider/geminiapi.py +208 -208
  186. webscout/Provider/granite.py +261 -261
  187. webscout/Provider/hermes.py +263 -263
  188. webscout/Provider/julius.py +223 -223
  189. webscout/Provider/learnfastai.py +309 -309
  190. webscout/Provider/llama3mitril.py +214 -214
  191. webscout/Provider/llmchat.py +243 -243
  192. webscout/Provider/llmchatco.py +290 -290
  193. webscout/Provider/meta.py +801 -801
  194. webscout/Provider/oivscode.py +309 -309
  195. webscout/Provider/scira_chat.py +383 -383
  196. webscout/Provider/searchchat.py +292 -292
  197. webscout/Provider/sonus.py +258 -258
  198. webscout/Provider/toolbaz.py +370 -367
  199. webscout/Provider/turboseek.py +273 -273
  200. webscout/Provider/typefully.py +207 -207
  201. webscout/Provider/yep.py +372 -372
  202. webscout/__init__.py +27 -31
  203. webscout/__main__.py +5 -5
  204. webscout/auth/api_key_manager.py +189 -189
  205. webscout/auth/config.py +175 -175
  206. webscout/auth/models.py +185 -185
  207. webscout/auth/routes.py +663 -664
  208. webscout/auth/simple_logger.py +236 -236
  209. webscout/cli.py +523 -523
  210. webscout/conversation.py +438 -438
  211. webscout/exceptions.py +361 -361
  212. webscout/litagent/Readme.md +298 -298
  213. webscout/litagent/__init__.py +28 -28
  214. webscout/litagent/agent.py +581 -581
  215. webscout/litagent/constants.py +59 -59
  216. webscout/litprinter/__init__.py +58 -58
  217. webscout/models.py +181 -181
  218. webscout/optimizers.py +419 -419
  219. webscout/prompt_manager.py +288 -288
  220. webscout/sanitize.py +1078 -1078
  221. webscout/scout/README.md +401 -401
  222. webscout/scout/__init__.py +8 -8
  223. webscout/scout/core/__init__.py +6 -6
  224. webscout/scout/core/crawler.py +297 -297
  225. webscout/scout/core/scout.py +706 -706
  226. webscout/scout/core/search_result.py +95 -95
  227. webscout/scout/core/text_analyzer.py +62 -62
  228. webscout/scout/core/text_utils.py +277 -277
  229. webscout/scout/core/web_analyzer.py +51 -51
  230. webscout/scout/element.py +599 -599
  231. webscout/scout/parsers/__init__.py +69 -69
  232. webscout/scout/parsers/html5lib_parser.py +172 -172
  233. webscout/scout/parsers/html_parser.py +236 -236
  234. webscout/scout/parsers/lxml_parser.py +178 -178
  235. webscout/scout/utils.py +37 -37
  236. webscout/search/__init__.py +51 -0
  237. webscout/search/base.py +195 -0
  238. webscout/search/duckduckgo_main.py +54 -0
  239. webscout/search/engines/__init__.py +48 -0
  240. webscout/search/engines/bing.py +84 -0
  241. webscout/search/engines/bing_news.py +52 -0
  242. webscout/search/engines/brave.py +43 -0
  243. webscout/search/engines/duckduckgo/__init__.py +25 -0
  244. webscout/search/engines/duckduckgo/answers.py +78 -0
  245. webscout/search/engines/duckduckgo/base.py +187 -0
  246. webscout/search/engines/duckduckgo/images.py +97 -0
  247. webscout/search/engines/duckduckgo/maps.py +168 -0
  248. webscout/search/engines/duckduckgo/news.py +68 -0
  249. webscout/search/engines/duckduckgo/suggestions.py +21 -0
  250. webscout/search/engines/duckduckgo/text.py +211 -0
  251. webscout/search/engines/duckduckgo/translate.py +47 -0
  252. webscout/search/engines/duckduckgo/videos.py +63 -0
  253. webscout/search/engines/duckduckgo/weather.py +74 -0
  254. webscout/search/engines/mojeek.py +37 -0
  255. webscout/search/engines/wikipedia.py +56 -0
  256. webscout/search/engines/yahoo.py +65 -0
  257. webscout/search/engines/yahoo_news.py +64 -0
  258. webscout/search/engines/yandex.py +43 -0
  259. webscout/search/engines/yep/__init__.py +13 -0
  260. webscout/search/engines/yep/base.py +32 -0
  261. webscout/search/engines/yep/images.py +99 -0
  262. webscout/search/engines/yep/suggestions.py +35 -0
  263. webscout/search/engines/yep/text.py +114 -0
  264. webscout/search/http_client.py +156 -0
  265. webscout/search/results.py +137 -0
  266. webscout/search/yep_main.py +44 -0
  267. webscout/swiftcli/Readme.md +323 -323
  268. webscout/swiftcli/__init__.py +95 -95
  269. webscout/swiftcli/core/__init__.py +7 -7
  270. webscout/swiftcli/core/cli.py +308 -308
  271. webscout/swiftcli/core/context.py +104 -104
  272. webscout/swiftcli/core/group.py +241 -241
  273. webscout/swiftcli/decorators/__init__.py +28 -28
  274. webscout/swiftcli/decorators/command.py +221 -221
  275. webscout/swiftcli/decorators/options.py +220 -220
  276. webscout/swiftcli/decorators/output.py +302 -302
  277. webscout/swiftcli/exceptions.py +21 -21
  278. webscout/swiftcli/plugins/__init__.py +9 -9
  279. webscout/swiftcli/plugins/base.py +135 -135
  280. webscout/swiftcli/plugins/manager.py +269 -269
  281. webscout/swiftcli/utils/__init__.py +59 -59
  282. webscout/swiftcli/utils/formatting.py +252 -252
  283. webscout/swiftcli/utils/parsing.py +267 -267
  284. webscout/update_checker.py +117 -117
  285. webscout/version.py +1 -1
  286. webscout/version.py.bak +2 -0
  287. webscout/zeroart/README.md +89 -89
  288. webscout/zeroart/__init__.py +134 -134
  289. webscout/zeroart/base.py +66 -66
  290. webscout/zeroart/effects.py +100 -100
  291. webscout/zeroart/fonts.py +1238 -1238
  292. {webscout-8.3.7.dist-info → webscout-2025.10.13.dist-info}/METADATA +936 -937
  293. webscout-2025.10.13.dist-info/RECORD +329 -0
  294. webscout/Provider/AISEARCH/DeepFind.py +0 -254
  295. webscout/Provider/OPENAI/Qwen3.py +0 -303
  296. webscout/Provider/OPENAI/qodo.py +0 -630
  297. webscout/Provider/OPENAI/xenai.py +0 -514
  298. webscout/tempid.py +0 -134
  299. webscout/webscout_search.py +0 -1183
  300. webscout/webscout_search_async.py +0 -649
  301. webscout/yep_search.py +0 -346
  302. webscout-8.3.7.dist-info/RECORD +0 -301
  303. {webscout-8.3.7.dist-info → webscout-2025.10.13.dist-info}/WHEEL +0 -0
  304. {webscout-8.3.7.dist-info → webscout-2025.10.13.dist-info}/entry_points.txt +0 -0
  305. {webscout-8.3.7.dist-info → webscout-2025.10.13.dist-info}/licenses/LICENSE.md +0 -0
  306. {webscout-8.3.7.dist-info → webscout-2025.10.13.dist-info}/top_level.txt +0 -0
@@ -1,706 +1,706 @@
1
- """
2
- Scout Main Module - HTML Parsing and Traversal
3
- """
4
- import hashlib
5
- import json
6
- import re
7
- import unicodedata
8
- import urllib.parse
9
- from typing import Any, Dict, List, Optional
10
-
11
- from ..element import NavigableString, Tag
12
- from ..parsers import ParserRegistry
13
- from ..utils import decode_markup
14
- from .search_result import ScoutSearchResult
15
- from .text_analyzer import ScoutTextAnalyzer
16
- from .text_utils import SentenceTokenizer
17
- from .web_analyzer import ScoutWebAnalyzer
18
-
19
-
20
- class Scout:
21
- """
22
- Scout - Making web scraping a breeze! 🌊
23
- A comprehensive HTML parsing and traversal library.
24
- Enhanced with advanced features and intelligent parsing.
25
- """
26
-
27
- def __init__(self, markup="", features='html.parser', from_encoding=None,
28
- exclude_encodings=None, element_classes=None, **kwargs):
29
- """
30
- Initialize Scout with HTML content.
31
-
32
- Args:
33
- markup (str): HTML content to parse
34
- features (str): Parser to use ('html.parser', 'lxml', 'html5lib', 'lxml-xml')
35
- from_encoding (str): Source encoding (if known)
36
- exclude_encodings (list): Encodings to avoid
37
- element_classes (dict): Custom classes for different element types
38
- **kwargs: Additional parsing options
39
- """
40
- # Store original markup and settings
41
- self.original_encoding = from_encoding
42
- self.exclude_encodings = exclude_encodings or []
43
- self.element_classes = element_classes or {}
44
- self.builder_features = features
45
- self.contains_replacement_characters = False
46
-
47
- # Intelligent markup handling
48
- self.markup = self._preprocess_markup(markup, from_encoding)
49
- self.features = features
50
- self.from_encoding = from_encoding
51
-
52
- # Get the right parser for the job
53
- if features not in ParserRegistry.list_parsers():
54
- raise ValueError(
55
- f"Invalid parser '{features}'! Choose from: {', '.join(ParserRegistry.list_parsers().keys())}"
56
- )
57
-
58
- parser_class = ParserRegistry.get_parser(features)
59
- self.parser = parser_class
60
-
61
- # Parse that HTML! 🎯
62
- self._soup = self.parser.parse(self.markup)
63
-
64
- # Set up the root element properly
65
- if hasattr(self._soup, 'name'):
66
- self.name = self._soup.name
67
- else:
68
- self.name = '[document]'
69
-
70
- # BeautifulSoup-like attributes
71
- self.attrs = self._soup.attrs if hasattr(self._soup, 'attrs') else {}
72
- self.contents = self._soup.contents if hasattr(self._soup, 'contents') else []
73
- self.parent = None
74
- self.next_sibling = None
75
- self.previous_sibling = None
76
-
77
- # Advanced parsing options and caching
78
- self._cache = {}
79
- self._tag_name_cache = {}
80
- self._css_selector_cache = {}
81
-
82
- # Text and web analyzers
83
- self.text_analyzer = ScoutTextAnalyzer()
84
- self.web_analyzer = ScoutWebAnalyzer()
85
-
86
- def normalize_text(self, text: str, form='NFKD') -> str:
87
- """
88
- Normalize text using Unicode normalization.
89
-
90
- Args:
91
- text (str): Input text
92
- form (str, optional): Normalization form
93
-
94
- Returns:
95
- str: Normalized text
96
- """
97
- return unicodedata.normalize(form, text)
98
-
99
- def url_parse(self, url: str) -> Dict[str, str]:
100
- """
101
- Parse and analyze a URL.
102
-
103
- Args:
104
- url (str): URL to parse
105
-
106
- Returns:
107
- Dict[str, str]: Parsed URL components
108
- """
109
- parsed = urllib.parse.urlparse(url)
110
- return {
111
- 'scheme': parsed.scheme,
112
- 'netloc': parsed.netloc,
113
- 'path': parsed.path,
114
- 'params': parsed.params,
115
- 'query': parsed.query,
116
- 'fragment': parsed.fragment
117
- }
118
-
119
- def analyze_page_structure(self) -> Dict[str, Any]:
120
- """
121
- Analyze the structure of the parsed page.
122
-
123
- Returns:
124
- Dict[str, Any]: Page structure analysis
125
- """
126
- return self.web_analyzer.analyze_page_structure(self)
127
-
128
- def analyze_text(self, text: Optional[str] = None) -> Dict[str, Any]:
129
- """
130
- Perform advanced text analysis.
131
-
132
- Args:
133
- text (str, optional): Text to analyze. If None, uses page text.
134
-
135
- Returns:
136
- Dict[str, Any]: Text analysis results
137
- """
138
- if text is None:
139
- text = self.get_text()
140
-
141
- return {
142
- 'word_count': self.text_analyzer.count_words(text),
143
- 'entities': self.text_analyzer.extract_entities(text),
144
- 'tokens': self.text_analyzer.tokenize(text)
145
- }
146
-
147
- def extract_semantic_info(self) -> Dict[str, Any]:
148
- """
149
- Extract semantic information from the document.
150
-
151
- Returns:
152
- Dict[str, Any]: Semantic information
153
- """
154
- semantic_info = {
155
- 'headings': {
156
- 'h1': [h.get_text(strip=True) for h in self.find_all('h1')],
157
- 'h2': [h.get_text(strip=True) for h in self.find_all('h2')],
158
- 'h3': [h.get_text(strip=True) for h in self.find_all('h3')]
159
- },
160
- 'lists': {
161
- 'ul': [ul.find_all('li') for ul in self.find_all('ul')],
162
- 'ol': [ol.find_all('li') for ol in self.find_all('ol')]
163
- },
164
- 'tables': {
165
- 'count': len(self.find_all('table')),
166
- 'headers': [table.find_all('th') for table in self.find_all('table')]
167
- }
168
- }
169
- return semantic_info
170
-
171
- def cache(self, key: str, value: Any = None) -> Any:
172
- """
173
- Manage a cache for parsed content.
174
-
175
- Args:
176
- key (str): Cache key
177
- value (Any, optional): Value to cache
178
-
179
- Returns:
180
- Any: Cached value or None
181
- """
182
- if value is not None:
183
- self._cache[key] = value
184
- return self._cache.get(key)
185
-
186
- def hash_content(self, method='md5') -> str:
187
- """
188
- Generate a hash of the parsed content.
189
-
190
- Args:
191
- method (str, optional): Hashing method
192
-
193
- Returns:
194
- str: Content hash
195
- """
196
- hash_methods = {
197
- 'md5': hashlib.md5,
198
- 'sha1': hashlib.sha1,
199
- 'sha256': hashlib.sha256
200
- }
201
-
202
- if method not in hash_methods:
203
- raise ValueError(f"Unsupported hash method: {method}")
204
-
205
- hasher = hash_methods[method]()
206
- hasher.update(str(self._soup).encode('utf-8'))
207
- return hasher.hexdigest()
208
-
209
- def extract_links(self, base_url: Optional[str] = None) -> List[Dict[str, str]]:
210
- """
211
- Extract all links from the document.
212
-
213
- Args:
214
- base_url (str, optional): Base URL for resolving relative links
215
-
216
- Returns:
217
- List[Dict[str, str]]: List of link dictionaries
218
- """
219
- links = []
220
- for link in self.find_all(['a', 'link']):
221
- href = link.get('href')
222
- if href:
223
- # Resolve relative URLs if base_url is provided
224
- if base_url and not href.startswith(('http://', 'https://', '//')):
225
- href = f"{base_url.rstrip('/')}/{href.lstrip('/')}"
226
-
227
- links.append({
228
- 'href': href,
229
- 'text': link.get_text(strip=True),
230
- 'rel': link.get('rel', [None])[0],
231
- 'type': link.get('type')
232
- })
233
- return links
234
-
235
- def extract_metadata(self) -> Dict[str, Any]:
236
- """
237
- Extract metadata from HTML document.
238
-
239
- Returns:
240
- Dict[str, Any]: Extracted metadata
241
- """
242
- metadata = {
243
- 'title': self.find('title').texts()[0] if self.find('title').texts() else None,
244
- 'description': self.find('meta', attrs={'name': 'description'}).attrs('content')[0] if self.find('meta', attrs={'name': 'description'}).attrs('content') else None,
245
- 'keywords': self.find('meta', attrs={'name': 'keywords'}).attrs('content')[0].split(',') if self.find('meta', attrs={'name': 'keywords'}).attrs('content') else [],
246
- 'og_metadata': {},
247
- 'twitter_metadata': {}
248
- }
249
-
250
- # Open Graph metadata
251
- for meta in self.find_all('meta', attrs={'property': re.compile(r'^og:')}):
252
- key = meta.attrs('property')[0][3:]
253
- metadata['og_metadata'][key] = meta.attrs('content')[0]
254
-
255
- # Twitter Card metadata
256
- for meta in self.find_all('meta', attrs={'name': re.compile(r'^twitter:')}):
257
- key = meta.attrs('name')[0][8:]
258
- metadata['twitter_metadata'][key] = meta.attrs('content')[0]
259
-
260
- return metadata
261
-
262
- def to_json(self, indent=2) -> str:
263
- """
264
- Convert parsed content to JSON.
265
-
266
- Args:
267
- indent (int, optional): JSON indentation
268
-
269
- Returns:
270
- str: JSON representation of the document
271
- """
272
- def _tag_to_dict(tag):
273
- if isinstance(tag, NavigableString):
274
- return str(tag)
275
-
276
- result = {
277
- 'name': tag.name,
278
- 'attrs': tag.attrs,
279
- 'text': tag.get_text(strip=True)
280
- }
281
-
282
- if tag.contents:
283
- result['children'] = [_tag_to_dict(child) for child in tag.contents]
284
-
285
- return result
286
-
287
- return json.dumps(_tag_to_dict(self._soup), indent=indent)
288
-
289
- def find(self, name=None, attrs={}, recursive=True, text=None, class_=None, **kwargs) -> ScoutSearchResult:
290
- """
291
- Find the first matching element.
292
-
293
- Args:
294
- name (str, optional): Tag name to search for
295
- attrs (dict, optional): Attributes to match
296
- recursive (bool, optional): Search recursively
297
- text (str, optional): Text content to match
298
-
299
- Returns:
300
- ScoutSearchResult: First matching element
301
- """
302
- result = self._soup.find(name, attrs, recursive, text, limit=1, class_=class_, **kwargs)
303
- return ScoutSearchResult([result]) if result else ScoutSearchResult([])
304
-
305
- def find_all(self, name=None, attrs={}, recursive=True, text=None, limit=None, class_=None, **kwargs) -> ScoutSearchResult:
306
- """
307
- Find all matching elements.
308
-
309
- Args:
310
- name (str, optional): Tag name to search for
311
- attrs (dict, optional): Attributes to match
312
- recursive (bool, optional): Search recursively
313
- text (str, optional): Text content to match
314
- limit (int, optional): Maximum number of results
315
-
316
- Returns:
317
- ScoutSearchResult: List of matching elements
318
- """
319
- results = self._soup.find_all(name, attrs, recursive, text, limit, class_=class_, **kwargs)
320
- return ScoutSearchResult(results)
321
-
322
- def find_parent(self, name=None, attrs={}, **kwargs) -> Optional[Tag]:
323
- """
324
- Find the first parent matching given criteria.
325
-
326
- Args:
327
- name (str, optional): Tag name to search for
328
- attrs (dict, optional): Attributes to match
329
-
330
- Returns:
331
- Tag or None: First matching parent
332
- """
333
- current = self._soup.parent
334
- while current:
335
- if (name is None or current.name == name) and \
336
- all(current.get(k) == v for k, v in attrs.items()):
337
- return current
338
- current = current.parent
339
- return None
340
-
341
- def find_parents(self, name=None, attrs={}, limit=None, **kwargs) -> List[Tag]:
342
- """
343
- Find all parents matching given criteria.
344
-
345
- Args:
346
- name (str, optional): Tag name to search for
347
- attrs (dict, optional): Attributes to match
348
- limit (int, optional): Maximum number of results
349
-
350
- Returns:
351
- List[Tag]: List of matching parents
352
- """
353
- parents = []
354
- current = self._soup.parent
355
- while current and (limit is None or len(parents) < limit):
356
- if (name is None or current.name == name) and \
357
- all(current.get(k) == v for k, v in attrs.items()):
358
- parents.append(current)
359
- current = current.parent
360
- return parents
361
-
362
- def find_next_sibling(self, name=None, attrs={}, **kwargs) -> Optional[Tag]:
363
- """
364
- Find the next sibling matching given criteria.
365
-
366
- Args:
367
- name (str, optional): Tag name to search for
368
- attrs (dict, optional): Attributes to match
369
-
370
- Returns:
371
- Tag or None: First matching next sibling
372
- """
373
- if not self._soup.parent:
374
- return None
375
-
376
- siblings = self._soup.parent.contents
377
- try:
378
- current_index = siblings.index(self._soup)
379
- for sibling in siblings[current_index + 1:]:
380
- if isinstance(sibling, Tag):
381
- if (name is None or sibling.name == name) and \
382
- all(sibling.get(k) == v for k, v in attrs.items()):
383
- return sibling
384
- except ValueError:
385
- pass
386
- return None
387
-
388
- def find_next_siblings(self, name=None, attrs={}, limit=None, **kwargs) -> List[Tag]:
389
- """
390
- Find all next siblings matching given criteria.
391
-
392
- Args:
393
- name (str, optional): Tag name to search for
394
- attrs (dict, optional): Attributes to match
395
- limit (int, optional): Maximum number of results
396
-
397
- Returns:
398
- List[Tag]: List of matching next siblings
399
- """
400
- if not self._soup.parent:
401
- return []
402
-
403
- siblings = []
404
- siblings_list = self._soup.parent.contents
405
- try:
406
- current_index = siblings_list.index(self._soup)
407
- for sibling in siblings_list[current_index + 1:]:
408
- if isinstance(sibling, Tag):
409
- if (name is None or sibling.name == name) and \
410
- all(sibling.get(k) == v for k, v in attrs.items()):
411
- siblings.append(sibling)
412
- if limit and len(siblings) == limit:
413
- break
414
- except ValueError:
415
- pass
416
- return siblings
417
-
418
- def find_previous_sibling(self, name=None, attrs={}, **kwargs) -> Optional[Tag]:
419
- """Find the previous sibling matching given criteria."""
420
- if not self._soup.parent:
421
- return None
422
-
423
- siblings = self._soup.parent.contents
424
- try:
425
- current_index = siblings.index(self._soup)
426
- for sibling in reversed(siblings[:current_index]):
427
- if isinstance(sibling, Tag):
428
- if (name is None or sibling.name == name) and all(
429
- sibling.get(k) == v for k, v in attrs.items()
430
- ):
431
- return sibling
432
- except ValueError:
433
- pass
434
- return None
435
-
436
- def find_previous_siblings(self, name=None, attrs={}, limit=None, **kwargs) -> List[Tag]:
437
- """Find all previous siblings matching given criteria."""
438
- if not self._soup.parent:
439
- return []
440
-
441
- siblings = []
442
- siblings_list = self._soup.parent.contents
443
- try:
444
- current_index = siblings_list.index(self._soup)
445
- for sibling in reversed(siblings_list[:current_index]):
446
- if isinstance(sibling, Tag):
447
- if (name is None or sibling.name == name) and all(
448
- sibling.get(k) == v for k, v in attrs.items()
449
- ):
450
- siblings.append(sibling)
451
- if limit and len(siblings) == limit:
452
- break
453
- except ValueError:
454
- pass
455
- return siblings
456
-
457
- def select(self, selector: str) -> List[Tag]:
458
- """
459
- Select elements using CSS selector.
460
-
461
- Args:
462
- selector (str): CSS selector string
463
-
464
- Returns:
465
- List[Tag]: List of matching elements
466
- """
467
- return self._soup.select(selector)
468
-
469
- def select_one(self, selector: str) -> Optional[Tag]:
470
- """
471
- Select the first element matching the CSS selector.
472
-
473
- Args:
474
- selector (str): CSS selector string
475
-
476
- Returns:
477
- Tag or None: First matching element
478
- """
479
- return self._soup.select_one(selector)
480
-
481
- def get_text(self, separator=' ', strip=False, types=None) -> str:
482
- """
483
- Extract all text from the parsed document.
484
-
485
- Args:
486
- separator (str, optional): Text separator
487
- strip (bool, optional): Strip whitespace
488
- types (list, optional): Types of content to extract
489
-
490
- Returns:
491
- str: Extracted text
492
- """
493
- tokenizer = SentenceTokenizer()
494
- text = self._soup.get_text(separator, strip, types)
495
- sentences = tokenizer.tokenize(text)
496
- return "\n\n".join(sentences)
497
-
498
- def get_text_robust(self, separator=' ', strip=False, types=None, encoding_fallbacks=None) -> str:
499
- """Extract text robustly, trying multiple encodings if needed."""
500
- try:
501
- return self.get_text(separator, strip, types)
502
- except UnicodeDecodeError:
503
- if encoding_fallbacks:
504
- for enc in encoding_fallbacks:
505
- try:
506
- return self._soup.get_text(separator, strip, types).encode(enc).decode(enc)
507
- except Exception:
508
- continue
509
- raise
510
-
511
- def remove_tags(self, tags: List[str]) -> None:
512
- """
513
- Remove specified tags and their contents from the document.
514
-
515
- Args:
516
- tags (List[str]): List of tag names to remove
517
- """
518
- for tag_name in tags:
519
- for tag in self._soup.find_all(tag_name):
520
- tag.decompose()
521
-
522
- def prettify(self, formatter='minimal') -> str:
523
- """
524
- Return a formatted, pretty-printed version of the HTML.
525
-
526
- Args:
527
- formatter (str, optional): Formatting style
528
-
529
- Returns:
530
- str: Prettified HTML
531
- """
532
- return self._soup.prettify(formatter)
533
-
534
- def decompose(self, tag: Tag = None) -> None:
535
- """
536
- Remove a tag and its contents from the document.
537
-
538
- Args:
539
- tag (Tag, optional): Tag to remove. If None, removes the root tag.
540
- """
541
- if tag is None:
542
- tag = self._soup
543
- tag.decompose()
544
-
545
- def extract(self, tag: Tag = None) -> Tag:
546
- """
547
- Remove a tag from the document and return it.
548
-
549
- Args:
550
- tag (Tag, optional): Tag to extract. If None, extracts the root tag.
551
-
552
- Returns:
553
- Tag: Extracted tag
554
- """
555
- if tag is None:
556
- tag = self._soup
557
- return tag.extract()
558
-
559
- def clear(self, tag: Tag = None) -> None:
560
- """
561
- Remove a tag's contents while keeping the tag itself.
562
-
563
- Args:
564
- tag (Tag, optional): Tag to clear. If None, clears the root tag.
565
- """
566
- if tag is None:
567
- tag = self._soup
568
- tag.clear()
569
-
570
- def replace_with(self, old_tag: Tag, new_tag: Tag) -> None:
571
- """
572
- Replace one tag with another.
573
-
574
- Args:
575
- old_tag (Tag): Tag to replace
576
- new_tag (Tag): Replacement tag
577
- """
578
- old_tag.replace_with(new_tag)
579
-
580
- def encode(self, encoding='utf-8', errors='strict') -> bytes:
581
- """Encode the document to a specific encoding with error handling."""
582
- try:
583
- return str(self._soup).encode(encoding, errors)
584
- except Exception:
585
- return str(self._soup).encode('utf-8', errors)
586
-
587
- def decode(self, encoding='utf-8', errors='strict') -> str:
588
- """Decode the document from a specific encoding with error handling."""
589
- try:
590
- return str(self._soup).decode(encoding, errors)
591
- except Exception:
592
- return str(self._soup)
593
-
594
- def __str__(self) -> str:
595
- """
596
- String representation of the parsed document.
597
-
598
- Returns:
599
- str: HTML content
600
- """
601
- return str(self._soup)
602
-
603
- def __repr__(self) -> str:
604
- """
605
- Detailed representation of the Scout object.
606
-
607
- Returns:
608
- str: Scout object description
609
- """
610
- return f"Scout(features='{self.features}', content_length={len(self.markup)})"
611
-
612
- def _preprocess_markup(self, markup: str, encoding: Optional[str] = None) -> str:
613
- """
614
- Preprocess markup before parsing.
615
-
616
- Args:
617
- markup (str): Input markup
618
- encoding (str, optional): Encoding to use
619
-
620
- Returns:
621
- str: Preprocessed markup
622
- """
623
- # Decode markup
624
- decoded_markup = decode_markup(markup, encoding)
625
-
626
- # Basic HTML cleaning
627
- # Remove comments, normalize whitespace, etc.
628
- decoded_markup = re.sub(r'<!--.*?-->', '', decoded_markup, flags=re.DOTALL)
629
- decoded_markup = re.sub(r'\s+', ' ', decoded_markup)
630
-
631
- return decoded_markup
632
-
633
- def wrap(self, wrapper_tag: Tag) -> Tag:
634
- """Wrap the root tag in another tag with error handling."""
635
- try:
636
- return self._soup.wrap(wrapper_tag)
637
- except Exception:
638
- return wrapper_tag
639
-
640
- def unwrap(self) -> None:
641
- """Unwrap the root tag, keeping its contents in the parent, with error handling."""
642
- try:
643
- self._soup.unwrap()
644
- except Exception:
645
- pass
646
-
647
- def insert_before(self, new_element: Tag) -> None:
648
- """Insert a tag or string immediately before the root tag with error handling."""
649
- try:
650
- self._soup.insert_before(new_element)
651
- except Exception:
652
- pass
653
-
654
- def insert_after(self, new_element: Tag) -> None:
655
- """Insert a tag or string immediately after the root tag with error handling."""
656
- try:
657
- self._soup.insert_after(new_element)
658
- except Exception:
659
- pass
660
-
661
- def append(self, tag: Tag) -> None:
662
- """Append a tag to the root tag with error handling."""
663
- try:
664
- self._soup.append(tag)
665
- except Exception:
666
- pass
667
-
668
- @property
669
- def descendants(self):
670
- """Yield all descendants of the root tag in document order."""
671
- return self._soup.descendants
672
-
673
- @property
674
- def parents(self):
675
- """Yield all parents of the root tag up the tree."""
676
- return self._soup.parents
677
-
678
- @property
679
- def next_element(self):
680
- """Return the next element in document order after the root tag."""
681
- return self._soup.next_element
682
-
683
- @property
684
- def previous_element(self):
685
- """Return the previous element in document order before the root tag."""
686
- return self._soup.previous_element
687
-
688
- def fetch_and_parse(self, url: str, requests_session=None, **kwargs) -> 'Scout':
689
- """Fetch HTML from a URL using requests and parse it with Scout."""
690
- import requests
691
- session = requests_session or requests.Session()
692
- resp = session.get(url, **kwargs)
693
- return Scout(resp.content, features=self.features)
694
-
695
- def tables_to_dataframe(self, table_index=0, pandas_module=None):
696
- """Convert the nth table in the document to a pandas DataFrame."""
697
- import pandas as pd
698
- if pandas_module:
699
- pd = pandas_module
700
- tables = self.find_all('table')
701
- if not tables or table_index >= len(tables):
702
- return None
703
- table = tables[table_index]
704
- rows = table.find_all('tr')
705
- data = [[cell.get_text(strip=True) for cell in row.find_all(['td', 'th'])] for row in rows]
706
- return pd.DataFrame(data)
1
+ """
2
+ Scout Main Module - HTML Parsing and Traversal
3
+ """
4
+ import hashlib
5
+ import json
6
+ import re
7
+ import unicodedata
8
+ import urllib.parse
9
+ from typing import Any, Dict, List, Optional
10
+
11
+ from ..element import NavigableString, Tag
12
+ from ..parsers import ParserRegistry
13
+ from ..utils import decode_markup
14
+ from .search_result import ScoutSearchResult
15
+ from .text_analyzer import ScoutTextAnalyzer
16
+ from .text_utils import SentenceTokenizer
17
+ from .web_analyzer import ScoutWebAnalyzer
18
+
19
+
20
+ class Scout:
21
+ """
22
+ Scout - Making web scraping a breeze! 🌊
23
+ A comprehensive HTML parsing and traversal library.
24
+ Enhanced with advanced features and intelligent parsing.
25
+ """
26
+
27
+ def __init__(self, markup="", features='html.parser', from_encoding=None,
28
+ exclude_encodings=None, element_classes=None, **kwargs):
29
+ """
30
+ Initialize Scout with HTML content.
31
+
32
+ Args:
33
+ markup (str): HTML content to parse
34
+ features (str): Parser to use ('html.parser', 'lxml', 'html5lib', 'lxml-xml')
35
+ from_encoding (str): Source encoding (if known)
36
+ exclude_encodings (list): Encodings to avoid
37
+ element_classes (dict): Custom classes for different element types
38
+ **kwargs: Additional parsing options
39
+ """
40
+ # Store original markup and settings
41
+ self.original_encoding = from_encoding
42
+ self.exclude_encodings = exclude_encodings or []
43
+ self.element_classes = element_classes or {}
44
+ self.builder_features = features
45
+ self.contains_replacement_characters = False
46
+
47
+ # Intelligent markup handling
48
+ self.markup = self._preprocess_markup(markup, from_encoding)
49
+ self.features = features
50
+ self.from_encoding = from_encoding
51
+
52
+ # Get the right parser for the job
53
+ if features not in ParserRegistry.list_parsers():
54
+ raise ValueError(
55
+ f"Invalid parser '{features}'! Choose from: {', '.join(ParserRegistry.list_parsers().keys())}"
56
+ )
57
+
58
+ parser_class = ParserRegistry.get_parser(features)
59
+ self.parser = parser_class
60
+
61
+ # Parse that HTML! 🎯
62
+ self._soup = self.parser.parse(self.markup)
63
+
64
+ # Set up the root element properly
65
+ if hasattr(self._soup, 'name'):
66
+ self.name = self._soup.name
67
+ else:
68
+ self.name = '[document]'
69
+
70
+ # BeautifulSoup-like attributes
71
+ self.attrs = self._soup.attrs if hasattr(self._soup, 'attrs') else {}
72
+ self.contents = self._soup.contents if hasattr(self._soup, 'contents') else []
73
+ self.parent = None
74
+ self.next_sibling = None
75
+ self.previous_sibling = None
76
+
77
+ # Advanced parsing options and caching
78
+ self._cache = {}
79
+ self._tag_name_cache = {}
80
+ self._css_selector_cache = {}
81
+
82
+ # Text and web analyzers
83
+ self.text_analyzer = ScoutTextAnalyzer()
84
+ self.web_analyzer = ScoutWebAnalyzer()
85
+
86
+ def normalize_text(self, text: str, form='NFKD') -> str:
87
+ """
88
+ Normalize text using Unicode normalization.
89
+
90
+ Args:
91
+ text (str): Input text
92
+ form (str, optional): Normalization form
93
+
94
+ Returns:
95
+ str: Normalized text
96
+ """
97
+ return unicodedata.normalize(form, text)
98
+
99
+ def url_parse(self, url: str) -> Dict[str, str]:
100
+ """
101
+ Parse and analyze a URL.
102
+
103
+ Args:
104
+ url (str): URL to parse
105
+
106
+ Returns:
107
+ Dict[str, str]: Parsed URL components
108
+ """
109
+ parsed = urllib.parse.urlparse(url)
110
+ return {
111
+ 'scheme': parsed.scheme,
112
+ 'netloc': parsed.netloc,
113
+ 'path': parsed.path,
114
+ 'params': parsed.params,
115
+ 'query': parsed.query,
116
+ 'fragment': parsed.fragment
117
+ }
118
+
119
+ def analyze_page_structure(self) -> Dict[str, Any]:
120
+ """
121
+ Analyze the structure of the parsed page.
122
+
123
+ Returns:
124
+ Dict[str, Any]: Page structure analysis
125
+ """
126
+ return self.web_analyzer.analyze_page_structure(self)
127
+
128
+ def analyze_text(self, text: Optional[str] = None) -> Dict[str, Any]:
129
+ """
130
+ Perform advanced text analysis.
131
+
132
+ Args:
133
+ text (str, optional): Text to analyze. If None, uses page text.
134
+
135
+ Returns:
136
+ Dict[str, Any]: Text analysis results
137
+ """
138
+ if text is None:
139
+ text = self.get_text()
140
+
141
+ return {
142
+ 'word_count': self.text_analyzer.count_words(text),
143
+ 'entities': self.text_analyzer.extract_entities(text),
144
+ 'tokens': self.text_analyzer.tokenize(text)
145
+ }
146
+
147
+ def extract_semantic_info(self) -> Dict[str, Any]:
148
+ """
149
+ Extract semantic information from the document.
150
+
151
+ Returns:
152
+ Dict[str, Any]: Semantic information
153
+ """
154
+ semantic_info = {
155
+ 'headings': {
156
+ 'h1': [h.get_text(strip=True) for h in self.find_all('h1')],
157
+ 'h2': [h.get_text(strip=True) for h in self.find_all('h2')],
158
+ 'h3': [h.get_text(strip=True) for h in self.find_all('h3')]
159
+ },
160
+ 'lists': {
161
+ 'ul': [ul.find_all('li') for ul in self.find_all('ul')],
162
+ 'ol': [ol.find_all('li') for ol in self.find_all('ol')]
163
+ },
164
+ 'tables': {
165
+ 'count': len(self.find_all('table')),
166
+ 'headers': [table.find_all('th') for table in self.find_all('table')]
167
+ }
168
+ }
169
+ return semantic_info
170
+
171
+ def cache(self, key: str, value: Any = None) -> Any:
172
+ """
173
+ Manage a cache for parsed content.
174
+
175
+ Args:
176
+ key (str): Cache key
177
+ value (Any, optional): Value to cache
178
+
179
+ Returns:
180
+ Any: Cached value or None
181
+ """
182
+ if value is not None:
183
+ self._cache[key] = value
184
+ return self._cache.get(key)
185
+
186
+ def hash_content(self, method='md5') -> str:
187
+ """
188
+ Generate a hash of the parsed content.
189
+
190
+ Args:
191
+ method (str, optional): Hashing method
192
+
193
+ Returns:
194
+ str: Content hash
195
+ """
196
+ hash_methods = {
197
+ 'md5': hashlib.md5,
198
+ 'sha1': hashlib.sha1,
199
+ 'sha256': hashlib.sha256
200
+ }
201
+
202
+ if method not in hash_methods:
203
+ raise ValueError(f"Unsupported hash method: {method}")
204
+
205
+ hasher = hash_methods[method]()
206
+ hasher.update(str(self._soup).encode('utf-8'))
207
+ return hasher.hexdigest()
208
+
209
+ def extract_links(self, base_url: Optional[str] = None) -> List[Dict[str, str]]:
210
+ """
211
+ Extract all links from the document.
212
+
213
+ Args:
214
+ base_url (str, optional): Base URL for resolving relative links
215
+
216
+ Returns:
217
+ List[Dict[str, str]]: List of link dictionaries
218
+ """
219
+ links = []
220
+ for link in self.find_all(['a', 'link']):
221
+ href = link.get('href')
222
+ if href:
223
+ # Resolve relative URLs if base_url is provided
224
+ if base_url and not href.startswith(('http://', 'https://', '//')):
225
+ href = f"{base_url.rstrip('/')}/{href.lstrip('/')}"
226
+
227
+ links.append({
228
+ 'href': href,
229
+ 'text': link.get_text(strip=True),
230
+ 'rel': link.get('rel', [None])[0],
231
+ 'type': link.get('type')
232
+ })
233
+ return links
234
+
235
+ def extract_metadata(self) -> Dict[str, Any]:
236
+ """
237
+ Extract metadata from HTML document.
238
+
239
+ Returns:
240
+ Dict[str, Any]: Extracted metadata
241
+ """
242
+ metadata = {
243
+ 'title': self.find('title').texts()[0] if self.find('title').texts() else None,
244
+ 'description': self.find('meta', attrs={'name': 'description'}).attrs('content')[0] if self.find('meta', attrs={'name': 'description'}).attrs('content') else None,
245
+ 'keywords': self.find('meta', attrs={'name': 'keywords'}).attrs('content')[0].split(',') if self.find('meta', attrs={'name': 'keywords'}).attrs('content') else [],
246
+ 'og_metadata': {},
247
+ 'twitter_metadata': {}
248
+ }
249
+
250
+ # Open Graph metadata
251
+ for meta in self.find_all('meta', attrs={'property': re.compile(r'^og:')}):
252
+ key = meta.attrs('property')[0][3:]
253
+ metadata['og_metadata'][key] = meta.attrs('content')[0]
254
+
255
+ # Twitter Card metadata
256
+ for meta in self.find_all('meta', attrs={'name': re.compile(r'^twitter:')}):
257
+ key = meta.attrs('name')[0][8:]
258
+ metadata['twitter_metadata'][key] = meta.attrs('content')[0]
259
+
260
+ return metadata
261
+
262
+ def to_json(self, indent=2) -> str:
263
+ """
264
+ Convert parsed content to JSON.
265
+
266
+ Args:
267
+ indent (int, optional): JSON indentation
268
+
269
+ Returns:
270
+ str: JSON representation of the document
271
+ """
272
+ def _tag_to_dict(tag):
273
+ if isinstance(tag, NavigableString):
274
+ return str(tag)
275
+
276
+ result = {
277
+ 'name': tag.name,
278
+ 'attrs': tag.attrs,
279
+ 'text': tag.get_text(strip=True)
280
+ }
281
+
282
+ if tag.contents:
283
+ result['children'] = [_tag_to_dict(child) for child in tag.contents]
284
+
285
+ return result
286
+
287
+ return json.dumps(_tag_to_dict(self._soup), indent=indent)
288
+
289
+ def find(self, name=None, attrs={}, recursive=True, text=None, class_=None, **kwargs) -> ScoutSearchResult:
290
+ """
291
+ Find the first matching element.
292
+
293
+ Args:
294
+ name (str, optional): Tag name to search for
295
+ attrs (dict, optional): Attributes to match
296
+ recursive (bool, optional): Search recursively
297
+ text (str, optional): Text content to match
298
+
299
+ Returns:
300
+ ScoutSearchResult: First matching element
301
+ """
302
+ result = self._soup.find(name, attrs, recursive, text, limit=1, class_=class_, **kwargs)
303
+ return ScoutSearchResult([result]) if result else ScoutSearchResult([])
304
+
305
+ def find_all(self, name=None, attrs={}, recursive=True, text=None, limit=None, class_=None, **kwargs) -> ScoutSearchResult:
306
+ """
307
+ Find all matching elements.
308
+
309
+ Args:
310
+ name (str, optional): Tag name to search for
311
+ attrs (dict, optional): Attributes to match
312
+ recursive (bool, optional): Search recursively
313
+ text (str, optional): Text content to match
314
+ limit (int, optional): Maximum number of results
315
+
316
+ Returns:
317
+ ScoutSearchResult: List of matching elements
318
+ """
319
+ results = self._soup.find_all(name, attrs, recursive, text, limit, class_=class_, **kwargs)
320
+ return ScoutSearchResult(results)
321
+
322
+ def find_parent(self, name=None, attrs={}, **kwargs) -> Optional[Tag]:
323
+ """
324
+ Find the first parent matching given criteria.
325
+
326
+ Args:
327
+ name (str, optional): Tag name to search for
328
+ attrs (dict, optional): Attributes to match
329
+
330
+ Returns:
331
+ Tag or None: First matching parent
332
+ """
333
+ current = self._soup.parent
334
+ while current:
335
+ if (name is None or current.name == name) and \
336
+ all(current.get(k) == v for k, v in attrs.items()):
337
+ return current
338
+ current = current.parent
339
+ return None
340
+
341
+ def find_parents(self, name=None, attrs={}, limit=None, **kwargs) -> List[Tag]:
342
+ """
343
+ Find all parents matching given criteria.
344
+
345
+ Args:
346
+ name (str, optional): Tag name to search for
347
+ attrs (dict, optional): Attributes to match
348
+ limit (int, optional): Maximum number of results
349
+
350
+ Returns:
351
+ List[Tag]: List of matching parents
352
+ """
353
+ parents = []
354
+ current = self._soup.parent
355
+ while current and (limit is None or len(parents) < limit):
356
+ if (name is None or current.name == name) and \
357
+ all(current.get(k) == v for k, v in attrs.items()):
358
+ parents.append(current)
359
+ current = current.parent
360
+ return parents
361
+
362
+ def find_next_sibling(self, name=None, attrs={}, **kwargs) -> Optional[Tag]:
363
+ """
364
+ Find the next sibling matching given criteria.
365
+
366
+ Args:
367
+ name (str, optional): Tag name to search for
368
+ attrs (dict, optional): Attributes to match
369
+
370
+ Returns:
371
+ Tag or None: First matching next sibling
372
+ """
373
+ if not self._soup.parent:
374
+ return None
375
+
376
+ siblings = self._soup.parent.contents
377
+ try:
378
+ current_index = siblings.index(self._soup)
379
+ for sibling in siblings[current_index + 1:]:
380
+ if isinstance(sibling, Tag):
381
+ if (name is None or sibling.name == name) and \
382
+ all(sibling.get(k) == v for k, v in attrs.items()):
383
+ return sibling
384
+ except ValueError:
385
+ pass
386
+ return None
387
+
388
+ def find_next_siblings(self, name=None, attrs={}, limit=None, **kwargs) -> List[Tag]:
389
+ """
390
+ Find all next siblings matching given criteria.
391
+
392
+ Args:
393
+ name (str, optional): Tag name to search for
394
+ attrs (dict, optional): Attributes to match
395
+ limit (int, optional): Maximum number of results
396
+
397
+ Returns:
398
+ List[Tag]: List of matching next siblings
399
+ """
400
+ if not self._soup.parent:
401
+ return []
402
+
403
+ siblings = []
404
+ siblings_list = self._soup.parent.contents
405
+ try:
406
+ current_index = siblings_list.index(self._soup)
407
+ for sibling in siblings_list[current_index + 1:]:
408
+ if isinstance(sibling, Tag):
409
+ if (name is None or sibling.name == name) and \
410
+ all(sibling.get(k) == v for k, v in attrs.items()):
411
+ siblings.append(sibling)
412
+ if limit and len(siblings) == limit:
413
+ break
414
+ except ValueError:
415
+ pass
416
+ return siblings
417
+
418
+ def find_previous_sibling(self, name=None, attrs={}, **kwargs) -> Optional[Tag]:
419
+ """Find the previous sibling matching given criteria."""
420
+ if not self._soup.parent:
421
+ return None
422
+
423
+ siblings = self._soup.parent.contents
424
+ try:
425
+ current_index = siblings.index(self._soup)
426
+ for sibling in reversed(siblings[:current_index]):
427
+ if isinstance(sibling, Tag):
428
+ if (name is None or sibling.name == name) and all(
429
+ sibling.get(k) == v for k, v in attrs.items()
430
+ ):
431
+ return sibling
432
+ except ValueError:
433
+ pass
434
+ return None
435
+
436
+ def find_previous_siblings(self, name=None, attrs={}, limit=None, **kwargs) -> List[Tag]:
437
+ """Find all previous siblings matching given criteria."""
438
+ if not self._soup.parent:
439
+ return []
440
+
441
+ siblings = []
442
+ siblings_list = self._soup.parent.contents
443
+ try:
444
+ current_index = siblings_list.index(self._soup)
445
+ for sibling in reversed(siblings_list[:current_index]):
446
+ if isinstance(sibling, Tag):
447
+ if (name is None or sibling.name == name) and all(
448
+ sibling.get(k) == v for k, v in attrs.items()
449
+ ):
450
+ siblings.append(sibling)
451
+ if limit and len(siblings) == limit:
452
+ break
453
+ except ValueError:
454
+ pass
455
+ return siblings
456
+
457
+ def select(self, selector: str) -> List[Tag]:
458
+ """
459
+ Select elements using CSS selector.
460
+
461
+ Args:
462
+ selector (str): CSS selector string
463
+
464
+ Returns:
465
+ List[Tag]: List of matching elements
466
+ """
467
+ return self._soup.select(selector)
468
+
469
+ def select_one(self, selector: str) -> Optional[Tag]:
470
+ """
471
+ Select the first element matching the CSS selector.
472
+
473
+ Args:
474
+ selector (str): CSS selector string
475
+
476
+ Returns:
477
+ Tag or None: First matching element
478
+ """
479
+ return self._soup.select_one(selector)
480
+
481
+ def get_text(self, separator=' ', strip=False, types=None) -> str:
482
+ """
483
+ Extract all text from the parsed document.
484
+
485
+ Args:
486
+ separator (str, optional): Text separator
487
+ strip (bool, optional): Strip whitespace
488
+ types (list, optional): Types of content to extract
489
+
490
+ Returns:
491
+ str: Extracted text
492
+ """
493
+ tokenizer = SentenceTokenizer()
494
+ text = self._soup.get_text(separator, strip, types)
495
+ sentences = tokenizer.tokenize(text)
496
+ return "\n\n".join(sentences)
497
+
498
+ def get_text_robust(self, separator=' ', strip=False, types=None, encoding_fallbacks=None) -> str:
499
+ """Extract text robustly, trying multiple encodings if needed."""
500
+ try:
501
+ return self.get_text(separator, strip, types)
502
+ except UnicodeDecodeError:
503
+ if encoding_fallbacks:
504
+ for enc in encoding_fallbacks:
505
+ try:
506
+ return self._soup.get_text(separator, strip, types).encode(enc).decode(enc)
507
+ except Exception:
508
+ continue
509
+ raise
510
+
511
+ def remove_tags(self, tags: List[str]) -> None:
512
+ """
513
+ Remove specified tags and their contents from the document.
514
+
515
+ Args:
516
+ tags (List[str]): List of tag names to remove
517
+ """
518
+ for tag_name in tags:
519
+ for tag in self._soup.find_all(tag_name):
520
+ tag.decompose()
521
+
522
+ def prettify(self, formatter='minimal') -> str:
523
+ """
524
+ Return a formatted, pretty-printed version of the HTML.
525
+
526
+ Args:
527
+ formatter (str, optional): Formatting style
528
+
529
+ Returns:
530
+ str: Prettified HTML
531
+ """
532
+ return self._soup.prettify(formatter)
533
+
534
+ def decompose(self, tag: Tag = None) -> None:
535
+ """
536
+ Remove a tag and its contents from the document.
537
+
538
+ Args:
539
+ tag (Tag, optional): Tag to remove. If None, removes the root tag.
540
+ """
541
+ if tag is None:
542
+ tag = self._soup
543
+ tag.decompose()
544
+
545
+ def extract(self, tag: Tag = None) -> Tag:
546
+ """
547
+ Remove a tag from the document and return it.
548
+
549
+ Args:
550
+ tag (Tag, optional): Tag to extract. If None, extracts the root tag.
551
+
552
+ Returns:
553
+ Tag: Extracted tag
554
+ """
555
+ if tag is None:
556
+ tag = self._soup
557
+ return tag.extract()
558
+
559
+ def clear(self, tag: Tag = None) -> None:
560
+ """
561
+ Remove a tag's contents while keeping the tag itself.
562
+
563
+ Args:
564
+ tag (Tag, optional): Tag to clear. If None, clears the root tag.
565
+ """
566
+ if tag is None:
567
+ tag = self._soup
568
+ tag.clear()
569
+
570
+ def replace_with(self, old_tag: Tag, new_tag: Tag) -> None:
571
+ """
572
+ Replace one tag with another.
573
+
574
+ Args:
575
+ old_tag (Tag): Tag to replace
576
+ new_tag (Tag): Replacement tag
577
+ """
578
+ old_tag.replace_with(new_tag)
579
+
580
+ def encode(self, encoding='utf-8', errors='strict') -> bytes:
581
+ """Encode the document to a specific encoding with error handling."""
582
+ try:
583
+ return str(self._soup).encode(encoding, errors)
584
+ except Exception:
585
+ return str(self._soup).encode('utf-8', errors)
586
+
587
+ def decode(self, encoding='utf-8', errors='strict') -> str:
588
+ """Decode the document from a specific encoding with error handling."""
589
+ try:
590
+ return str(self._soup).decode(encoding, errors)
591
+ except Exception:
592
+ return str(self._soup)
593
+
594
+ def __str__(self) -> str:
595
+ """
596
+ String representation of the parsed document.
597
+
598
+ Returns:
599
+ str: HTML content
600
+ """
601
+ return str(self._soup)
602
+
603
+ def __repr__(self) -> str:
604
+ """
605
+ Detailed representation of the Scout object.
606
+
607
+ Returns:
608
+ str: Scout object description
609
+ """
610
+ return f"Scout(features='{self.features}', content_length={len(self.markup)})"
611
+
612
+ def _preprocess_markup(self, markup: str, encoding: Optional[str] = None) -> str:
613
+ """
614
+ Preprocess markup before parsing.
615
+
616
+ Args:
617
+ markup (str): Input markup
618
+ encoding (str, optional): Encoding to use
619
+
620
+ Returns:
621
+ str: Preprocessed markup
622
+ """
623
+ # Decode markup
624
+ decoded_markup = decode_markup(markup, encoding)
625
+
626
+ # Basic HTML cleaning
627
+ # Remove comments, normalize whitespace, etc.
628
+ decoded_markup = re.sub(r'<!--.*?-->', '', decoded_markup, flags=re.DOTALL)
629
+ decoded_markup = re.sub(r'\s+', ' ', decoded_markup)
630
+
631
+ return decoded_markup
632
+
633
+ def wrap(self, wrapper_tag: Tag) -> Tag:
634
+ """Wrap the root tag in another tag with error handling."""
635
+ try:
636
+ return self._soup.wrap(wrapper_tag)
637
+ except Exception:
638
+ return wrapper_tag
639
+
640
+ def unwrap(self) -> None:
641
+ """Unwrap the root tag, keeping its contents in the parent, with error handling."""
642
+ try:
643
+ self._soup.unwrap()
644
+ except Exception:
645
+ pass
646
+
647
+ def insert_before(self, new_element: Tag) -> None:
648
+ """Insert a tag or string immediately before the root tag with error handling."""
649
+ try:
650
+ self._soup.insert_before(new_element)
651
+ except Exception:
652
+ pass
653
+
654
+ def insert_after(self, new_element: Tag) -> None:
655
+ """Insert a tag or string immediately after the root tag with error handling."""
656
+ try:
657
+ self._soup.insert_after(new_element)
658
+ except Exception:
659
+ pass
660
+
661
+ def append(self, tag: Tag) -> None:
662
+ """Append a tag to the root tag with error handling."""
663
+ try:
664
+ self._soup.append(tag)
665
+ except Exception:
666
+ pass
667
+
668
+ @property
669
+ def descendants(self):
670
+ """Yield all descendants of the root tag in document order."""
671
+ return self._soup.descendants
672
+
673
+ @property
674
+ def parents(self):
675
+ """Yield all parents of the root tag up the tree."""
676
+ return self._soup.parents
677
+
678
+ @property
679
+ def next_element(self):
680
+ """Return the next element in document order after the root tag."""
681
+ return self._soup.next_element
682
+
683
+ @property
684
+ def previous_element(self):
685
+ """Return the previous element in document order before the root tag."""
686
+ return self._soup.previous_element
687
+
688
+ def fetch_and_parse(self, url: str, requests_session=None, **kwargs) -> 'Scout':
689
+ """Fetch HTML from a URL using requests and parse it with Scout."""
690
+ import requests
691
+ session = requests_session or requests.Session()
692
+ resp = session.get(url, **kwargs)
693
+ return Scout(resp.content, features=self.features)
694
+
695
+ def tables_to_dataframe(self, table_index=0, pandas_module=None):
696
+ """Convert the nth table in the document to a pandas DataFrame."""
697
+ import pandas as pd
698
+ if pandas_module:
699
+ pd = pandas_module
700
+ tables = self.find_all('table')
701
+ if not tables or table_index >= len(tables):
702
+ return None
703
+ table = tables[table_index]
704
+ rows = table.find_all('tr')
705
+ data = [[cell.get_text(strip=True) for cell in row.find_all(['td', 'th'])] for row in rows]
706
+ return pd.DataFrame(data)