Spaces:
Sleeping
Sleeping
File size: 29,683 Bytes
ab65628 54ec9cb ab65628 54ec9cb ab65628 54ec9cb ab65628 54ec9cb ab65628 54ec9cb ab65628 54ec9cb ab65628 54ec9cb ab65628 54ec9cb ab65628 54ec9cb ab65628 54ec9cb ab65628 54ec9cb ab65628 54ec9cb ab65628 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 | """Web scraper RL environment."""
import csv
import io
import logging
import re
import time
from typing import Any
from urllib.parse import urlparse
import certifi
import httpx
from app.config import Settings, get_settings
from app.core.action import Action, ActionType
from app.core.episode import Episode, EpisodeManager
from app.core.observation import (
AvailableAction,
ExtractedField,
MemoryContext,
Observation,
TaskContext,
)
from app.core.reward import RewardBreakdown, RewardEngine
from app.utils.html import extract_links, extract_tables, extract_text, parse_html
logger = logging.getLogger(__name__)
class WebScraperEnv:
"""
Reinforcement Learning environment for web scraping.
Follows the Gymnasium API pattern:
- reset(task_id, seed) -> observation, info
- step(action) -> observation, reward, terminated, truncated, info
- get_state() -> state dict
"""
def __init__(
self,
episode_id: str,
settings: Settings | None = None,
) -> None:
"""
Initialize the environment.
Args:
episode_id: Unique identifier for this episode.
settings: Application settings.
"""
self.episode_id = episode_id
self.settings = settings or get_settings()
self.reward_engine = RewardEngine(settings)
self.episode_manager = EpisodeManager()
# State
self._episode: Episode | None = None
self._current_observation: Observation | None = None
self._task_context: TaskContext | None = None
self._ground_truth: dict[str, Any] | None = None
# Browser state (placeholder - would use Playwright in production)
self._current_url: str | None = None
self._page_html: str | None = None
self._page_title: str | None = None
self._page_content_type: str | None = None
self._page_status_code: int | None = None
# Extraction state
self._extracted_fields: list[ExtractedField] = []
self._navigation_history: list[str] = []
# Timing
self._start_time: float | None = None
async def reset(
self,
task_id: str,
seed: int | None = None,
config: dict[str, Any] | None = None,
) -> tuple[Observation, dict[str, Any]]:
"""
Reset the environment for a new episode.
Args:
task_id: ID of the task to execute.
seed: Random seed for reproducibility.
config: Optional episode configuration.
Returns:
Tuple of (initial_observation, info_dict).
"""
logger.info(f"Resetting environment for task {task_id}")
# Reset state
self.reward_engine.reset()
self._extracted_fields = []
self._navigation_history = []
self._start_time = time.time()
self._current_url = None
self._page_html = None
self._page_title = None
self._page_content_type = None
self._page_status_code = None
# Create episode
self._episode = self.episode_manager.create_episode(
episode_id=self.episode_id,
task_id=task_id,
max_steps=self.settings.max_steps_per_episode,
seed=seed,
config=config or {},
)
self._episode.start()
# Load task context
self._task_context = await self._load_task_context(task_id)
# Create initial observation
self._current_observation = self._create_observation()
info = {
"episode_id": self.episode_id,
"task_id": task_id,
"max_steps": self._episode.max_steps,
"target_fields": self._task_context.target_fields if self._task_context else [],
}
return self._current_observation, info
async def step(
self,
action: Action,
) -> tuple[Observation, float, dict[str, float], bool, bool, dict[str, Any]]:
"""
Execute an action and return the result.
Args:
action: The action to execute.
Returns:
Tuple of (observation, reward, reward_breakdown, terminated, truncated, info).
"""
if self._episode is None or self._current_observation is None:
raise RuntimeError("Environment not reset. Call reset() first.")
if self._episode.is_terminal:
raise RuntimeError("Episode has already terminated.")
step_start = time.time()
prev_observation = self._current_observation
# Validate action
errors = action.validate_params()
if errors:
logger.warning(f"Invalid action parameters: {errors}")
# Execute action
action_result = await self._execute_action(action)
# Update observation
self._current_observation = self._create_observation()
if action_result.get("error"):
self._current_observation.last_action_error = action_result["error"]
self._current_observation.consecutive_errors = (
prev_observation.consecutive_errors + 1
)
else:
self._current_observation.consecutive_errors = 0
# Compute reward
reward, breakdown = self.reward_engine.compute_reward(
action=action,
prev_observation=prev_observation,
new_observation=self._current_observation,
ground_truth=self._ground_truth,
max_steps=self._episode.max_steps,
)
# Check termination
terminated = self._check_terminated(action)
truncated = self._check_truncated()
# Update episode
step_duration = (time.time() - step_start) * 1000
self._episode.add_step(
action_type=action.action_type.value,
action_params=action.parameters,
action_reasoning=action.reasoning,
reward=reward,
reward_breakdown=breakdown.to_dict(),
observation_summary={
"url": self._current_observation.current_url,
"progress": self._current_observation.extraction_progress,
"fields_extracted": len(self._current_observation.extracted_so_far),
},
error=action_result.get("error"),
duration_ms=step_duration,
)
# Handle terminal states
if terminated:
success = action.action_type == ActionType.DONE and action.get_param(
"success", True
)
self._episode.complete(
success=success,
extracted_data=self._current_observation.get_extraction_dict(),
)
# Add terminal reward
terminal_reward, terminal_breakdown = (
self.reward_engine.compute_terminal_reward(
self._current_observation,
success=success,
ground_truth=self._ground_truth,
)
)
reward += terminal_reward
breakdown.total += terminal_reward
elif truncated:
self._episode.truncate()
info = {
"action_result": action_result,
"step_duration_ms": step_duration,
"episode_step": self._episode.current_step,
}
return (
self._current_observation,
reward,
breakdown.to_dict(),
terminated,
truncated,
info,
)
def get_state(self) -> dict[str, Any]:
"""Get the current state of the environment."""
if self._episode is None:
return {
"episode_id": self.episode_id,
"status": "not_started",
}
return {
"episode_id": self.episode_id,
"task_id": self._episode.task_id,
"step_number": self._episode.current_step,
"current_url": self._current_url,
"is_terminal": self._episode.is_terminal,
"total_reward": self._episode.total_reward,
"extracted_data": (
self._current_observation.get_extraction_dict()
if self._current_observation
else {}
),
"status": self._episode.status.value,
}
async def _load_task_context(self, task_id: str) -> TaskContext:
"""Load task context from task repository."""
# In production, this would fetch from database
from app.api.routes.tasks import TASK_REPOSITORY
task = TASK_REPOSITORY.get(task_id)
if task:
return TaskContext(
task_id=task.id,
task_name=task.name,
task_type=task.task_type.value,
target_fields=[f.name for f in task.fields_to_extract],
required_fields=task.success_criteria.get("required_fields", []),
hints=task.hints,
success_criteria=task.success_criteria,
)
# Default context
return TaskContext(
task_id=task_id,
task_name=f"Task {task_id}",
task_type="unknown",
target_fields=[],
required_fields=[],
)
def _create_observation(self) -> Observation:
"""Create an observation from current state."""
if self._episode is None:
raise RuntimeError("Episode not initialized")
elapsed = time.time() - (self._start_time or time.time())
# Get available actions
available_actions = self._get_available_actions()
# Calculate progress
target_fields = (
self._task_context.target_fields if self._task_context else []
)
extracted_names = {f.field_name for f in self._extracted_fields}
fields_remaining = [f for f in target_fields if f not in extracted_names]
progress = (
len(self._extracted_fields) / len(target_fields)
if target_fields
else 0.0
)
return Observation(
episode_id=self.episode_id,
task_id=self._episode.task_id,
step_number=self._episode.current_step,
elapsed_seconds=elapsed,
current_url=self._current_url,
page_title=self._page_title,
page_html=self._page_html,
navigation_history=self._navigation_history.copy(),
can_go_back=len(self._navigation_history) > 1,
task_context=self._task_context,
extracted_so_far=self._extracted_fields.copy(),
extraction_progress=progress,
fields_remaining=fields_remaining,
memory_context=MemoryContext(),
available_actions=available_actions,
tokens_used=self._episode.tokens_used,
api_calls_made=self._episode.api_calls,
)
def _get_available_actions(self) -> list[AvailableAction]:
"""Get list of currently available actions."""
actions = []
# Navigation actions
actions.append(
AvailableAction(
action_type="navigate",
description="Navigate to a URL",
parameters={"url": "required"},
)
)
if self._current_url:
# Page interaction actions
actions.extend([
AvailableAction(
action_type="click",
description="Click on an element",
parameters={"selector": "required"},
),
AvailableAction(
action_type="extract_field",
description="Extract a field from the page",
parameters={"field_name": "required", "selector": "optional"},
),
AvailableAction(
action_type="search_page",
description="Search within the current page",
parameters={"query": "required"},
),
])
# Always available
actions.extend([
AvailableAction(
action_type="search_engine",
description="Perform a web search",
parameters={"query": "required", "engine": "optional"},
),
AvailableAction(
action_type="done",
description="Mark task as complete",
parameters={"success": "boolean"},
),
])
return actions
async def _execute_action(self, action: Action) -> dict[str, Any]:
"""Execute an action and return the result."""
result: dict[str, Any] = {"success": False}
try:
match action.action_type:
case ActionType.NAVIGATE:
result = await self._execute_navigate(action)
case ActionType.CLICK:
result = await self._execute_click(action)
case ActionType.FILL:
result = await self._execute_fill(action)
case ActionType.EXTRACT_FIELD:
result = await self._execute_extract(action)
case ActionType.SEARCH_ENGINE:
result = await self._execute_search_engine(action)
case ActionType.DONE:
result = {"success": True, "done": True}
case ActionType.WAIT:
await self._execute_wait(action)
result = {"success": True}
case _:
result = {
"success": False,
"error": f"Action type {action.action_type} not implemented",
}
except Exception as e:
logger.error(f"Action execution failed: {e}")
result = {"success": False, "error": str(e)}
return result
async def _execute_navigate(self, action: Action) -> dict[str, Any]:
"""Execute a navigate action."""
url = action.get_param("url")
if not url:
return {"success": False, "error": "URL is required"}
normalized_url = str(url).strip()
if not re.match(r"^https?://", normalized_url, flags=re.IGNORECASE):
normalized_url = f"https://{normalized_url}"
try:
parsed = urlparse(normalized_url)
if not parsed.scheme or not parsed.netloc:
return {"success": False, "error": f"Invalid URL: {url}"}
timeout = httpx.Timeout(self.settings.default_timeout_seconds)
headers = {"User-Agent": "ScrapeRL/1.0 (+https://github.com/NeerajCodz/scrapeRL)"}
tls_verification_bypassed = False
try:
async with httpx.AsyncClient(
timeout=timeout,
follow_redirects=True,
headers=headers,
verify=certifi.where(),
) as client:
response = await client.get(normalized_url)
except httpx.HTTPError as exc:
if "CERTIFICATE_VERIFY_FAILED" not in str(exc):
raise
logger.warning(
"TLS verification failed for %s; retrying with verify=False in sandboxed fetch mode",
normalized_url,
)
tls_verification_bypassed = True
async with httpx.AsyncClient(
timeout=timeout,
follow_redirects=True,
headers=headers,
verify=False, # noqa: S501 - controlled retry path after explicit TLS verification failure
) as client:
response = await client.get(normalized_url)
self._current_url = str(response.url)
self._navigation_history.append(self._current_url)
self._page_status_code = response.status_code
self._page_content_type = response.headers.get("content-type", "").lower()
self._page_html = response.text
if "html" in self._page_content_type and self._page_html:
soup = parse_html(self._page_html)
title_tag = soup.find("title")
self._page_title = (
title_tag.get_text(strip=True)
if title_tag and title_tag.get_text(strip=True)
else self._current_url
)
else:
self._page_title = self._current_url
return {
"success": response.status_code < 500,
"url": self._current_url,
"status_code": response.status_code,
"content_type": self._page_content_type,
"tls_verification_bypassed": tls_verification_bypassed,
}
except Exception as exc:
logger.error(f"Navigation failed for {normalized_url}: {exc}")
return {"success": False, "error": str(exc), "url": normalized_url}
async def _execute_click(self, action: Action) -> dict[str, Any]:
"""Execute a click action."""
selector = action.get_param("selector")
if not selector:
return {"success": False, "error": "Selector is required"}
# Placeholder
return {"success": True, "selector": selector, "clicked": True}
async def _execute_fill(self, action: Action) -> dict[str, Any]:
"""Execute a fill action."""
selector = action.get_param("selector")
value = action.get_param("value")
if not selector or value is None:
return {"success": False, "error": "Selector and value are required"}
# Placeholder
return {"success": True, "selector": selector, "filled": True}
async def _execute_extract(self, action: Action) -> dict[str, Any]:
"""Execute an extract action."""
field_name = action.get_param("field_name")
if not field_name:
return {"success": False, "error": "field_name is required"}
selector = action.get_param("selector")
extracted_value: Any = None
confidence = 0.3
if self._page_html:
is_csv = self._is_csv_payload(self._page_html, self._page_content_type)
if selector and not is_csv and "html" in (self._page_content_type or ""):
try:
soup = parse_html(self._page_html)
matched = soup.select_one(str(selector))
if matched:
extracted_value = matched.get_text(" ", strip=True)
confidence = 0.95
except Exception:
extracted_value = None
if extracted_value is None:
normalized_field = str(field_name).lower()
if normalized_field == "title":
extracted_value = self._page_title or self._current_url
confidence = 0.95 if extracted_value else 0.4
elif normalized_field == "content":
if is_csv:
lines = self._page_html.splitlines()
extracted_value = "\n".join(lines[:20])
else:
extracted_value = extract_text(self._page_html)[:6000]
confidence = 0.9 if extracted_value else 0.4
elif normalized_field == "links":
if is_csv:
extracted_value = [{"href": self._current_url or "", "text": "source_csv"}]
else:
extracted_value = extract_links(
self._page_html,
base_url=self._current_url,
include_text=True,
)[:100]
confidence = 0.9 if extracted_value else 0.4
elif normalized_field == "meta":
extracted_value = self._extract_meta()
confidence = 0.85 if extracted_value else 0.4
elif normalized_field == "images":
extracted_value = self._extract_images()
confidence = 0.85 if extracted_value else 0.4
elif normalized_field == "data":
extracted_value = self._extract_structured_data()
confidence = 0.9 if extracted_value else 0.4
elif normalized_field == "tables":
extracted_value = self._extract_tables_or_csv()
confidence = 0.9 if extracted_value else 0.4
elif normalized_field == "forms":
extracted_value = self._extract_forms()
confidence = 0.8 if extracted_value else 0.4
elif normalized_field == "scripts":
extracted_value = self._extract_scripts()
confidence = 0.8 if extracted_value else 0.4
else:
extracted_value = extract_text(self._page_html)[:2000]
confidence = 0.6 if extracted_value else 0.3
if extracted_value is None:
extracted_value = ""
confidence = 0.2
self._extracted_fields = [
field for field in self._extracted_fields if field.field_name != field_name
]
extracted_field = ExtractedField(
field_name=field_name,
value=extracted_value,
confidence=confidence,
source_selector=selector,
extraction_step=self._episode.current_step if self._episode else 0,
)
self._extracted_fields.append(extracted_field)
return {
"success": True,
"field_name": field_name,
"value": extracted_field.value,
"confidence": extracted_field.confidence,
}
async def _execute_search_engine(self, action: Action) -> dict[str, Any]:
"""Execute a search engine action."""
query = action.get_param("query")
if not query:
return {"success": False, "error": "Query is required"}
engine = action.get_param("engine", "google")
query_l = str(query).lower()
if "gold" in query_l and ("price" in query_l or "trend" in query_l):
return {
"success": True,
"query": query,
"engine": engine,
"results": [
{
"title": "Monthly gold prices dataset (historical)",
"url": "https://raw.githubusercontent.com/datasets/gold-prices/master/data/monthly.csv",
},
{
"title": "Gold prices dataset repository",
"url": "https://github.com/datasets/gold-prices",
},
],
}
return {
"success": True,
"query": query,
"engine": engine,
"results": [
{"title": f"Result 1 for {query}", "url": "https://example.com/1"},
{"title": f"Result 2 for {query}", "url": "https://example.com/2"},
],
}
async def _execute_wait(self, action: Action) -> None:
"""Execute a wait action."""
import asyncio
duration_ms = action.get_param("duration_ms", 1000)
await asyncio.sleep(duration_ms / 1000)
@staticmethod
def _is_csv_payload(content: str | None, content_type: str | None) -> bool:
"""Determine whether the loaded payload is CSV-like."""
lowered_content_type = (content_type or "").lower()
if lowered_content_type:
if "csv" in lowered_content_type:
return True
if any(
marker in lowered_content_type
for marker in ("html", "xml", "json", "javascript")
):
return False
if not content:
return False
stripped = content.lstrip("\ufeff").lstrip()
head = stripped[:500].lower()
if stripped.startswith("<") or "<html" in head or "<!doctype html" in head:
return False
lines = [line.strip() for line in stripped.splitlines() if line.strip()]
if len(lines) < 2:
return False
header = lines[0]
if "," not in header:
return False
header_fields = [part.strip() for part in header.split(",")]
if len(header_fields) < 2:
return False
if any(not field for field in header_fields):
return False
if any(re.search(r"[<>]", field) for field in header_fields):
return False
second_line = lines[1]
if second_line.count(",") < len(header_fields) - 1:
return False
return True
def _parse_csv_rows(self, max_rows: int = 5000) -> list[dict[str, str]]:
"""Parse current payload as CSV rows."""
if not self._page_html:
return []
stream = io.StringIO(self._page_html.lstrip("\ufeff"))
reader = csv.DictReader(stream)
rows: list[dict[str, str]] = []
for idx, row in enumerate(reader):
if idx >= max_rows:
break
rows.append({k: (v or "").strip() for k, v in row.items() if k is not None})
return rows
def _extract_meta(self) -> dict[str, Any]:
"""Extract metadata from current HTML."""
meta: dict[str, Any] = {
"url": self._current_url,
"content_type": self._page_content_type,
"status_code": self._page_status_code,
}
if not self._page_html or "html" not in (self._page_content_type or ""):
return meta
soup = parse_html(self._page_html)
for tag in soup.find_all("meta"):
key = tag.get("name") or tag.get("property")
if key and tag.get("content"):
meta[str(key)] = str(tag.get("content"))
return meta
def _extract_images(self) -> list[dict[str, str]]:
"""Extract image references from current HTML."""
if not self._page_html or "html" not in (self._page_content_type or ""):
return []
soup = parse_html(self._page_html)
images: list[dict[str, str]] = []
for img in soup.find_all("img")[:100]:
src = img.get("src")
if not src:
continue
images.append(
{
"src": str(src),
"alt": str(img.get("alt", "")),
}
)
return images
def _extract_structured_data(self) -> Any:
"""Extract structured data (CSV rows or HTML tables)."""
if self._is_csv_payload(self._page_html, self._page_content_type):
return self._parse_csv_rows()
if not self._page_html:
return []
return extract_tables(self._page_html)
def _extract_tables_or_csv(self) -> Any:
"""Extract table-like content from page payload."""
if self._is_csv_payload(self._page_html, self._page_content_type):
rows = self._parse_csv_rows()
if not rows:
return []
headers = list(rows[0].keys())
return [{"headers": headers, "rows": [[row.get(h, "") for h in headers] for row in rows]}]
if not self._page_html:
return []
return extract_tables(self._page_html)
def _extract_forms(self) -> list[dict[str, Any]]:
"""Extract form descriptors from HTML."""
if not self._page_html or "html" not in (self._page_content_type or ""):
return []
soup = parse_html(self._page_html)
forms: list[dict[str, Any]] = []
for form in soup.find_all("form")[:50]:
fields = []
for field in form.find_all(["input", "select", "textarea"])[:100]:
fields.append(
{
"tag": field.name or "",
"name": str(field.get("name", "")),
"type": str(field.get("type", "")),
}
)
forms.append(
{
"action": str(form.get("action", "")),
"method": str(form.get("method", "get")).lower(),
"fields": fields,
}
)
return forms
def _extract_scripts(self) -> dict[str, Any]:
"""Extract script information from HTML."""
if not self._page_html or "html" not in (self._page_content_type or ""):
return {"count": 0, "external": []}
soup = parse_html(self._page_html)
scripts = soup.find_all("script")
external = [str(script.get("src")) for script in scripts if script.get("src")]
return {"count": len(scripts), "external": external[:100]}
def _check_terminated(self, action: Action) -> bool:
"""Check if the episode should terminate."""
if action.action_type == ActionType.DONE:
return True
if action.action_type == ActionType.FAIL:
return True
return False
def _check_truncated(self) -> bool:
"""Check if the episode should be truncated."""
if self._episode is None:
return False
if self._episode.current_step >= self._episode.max_steps:
return True
return False
|