Spaces:
Sleeping
Sleeping
File size: 8,668 Bytes
097eaf0 | 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 | from typing import Optional, List, Dict, Any
from ...types import ScrapeOptions, WebhookConfig, Document, BatchScrapeResponse, BatchScrapeJob, PaginationConfig
from ...utils.http_client_async import AsyncHttpClient
from ...utils.validation import prepare_scrape_options
from ...utils.error_handler import handle_response_error
from ...utils.normalize import normalize_document_input
from ...methods.batch import validate_batch_urls
import time
def _parse_batch_scrape_documents(data_list: Optional[List[Any]]) -> List[Document]:
documents: List[Document] = []
for doc in data_list or []:
if isinstance(doc, dict):
normalized = normalize_document_input(doc)
documents.append(Document(**normalized))
return documents
def _parse_batch_scrape_status_response(body: Dict[str, Any]) -> Dict[str, Any]:
if not body.get("success"):
raise Exception(body.get("error", "Unknown error occurred"))
return {
"status": body.get("status"),
"completed": body.get("completed", 0),
"total": body.get("total", 0),
"credits_used": body.get("creditsUsed"),
"expires_at": body.get("expiresAt"),
"next": body.get("next"),
"data": _parse_batch_scrape_documents(body.get("data", []) or []),
}
def _prepare(urls: List[str], *, options: Optional[ScrapeOptions] = None, **kwargs) -> Dict[str, Any]:
if not urls:
raise ValueError("URLs list cannot be empty")
validated_urls = validate_batch_urls([u.strip() if isinstance(u, str) else u for u in urls])
payload: Dict[str, Any] = {"urls": validated_urls}
if options:
opts = prepare_scrape_options(options)
if opts:
payload.update(opts)
if (w := kwargs.get("webhook")) is not None:
payload["webhook"] = w if isinstance(w, str) else w.model_dump(exclude_none=True)
if (v := kwargs.get("append_to_id")) is not None:
payload["appendToId"] = v
if (v := kwargs.get("ignore_invalid_urls")) is not None:
payload["ignoreInvalidURLs"] = v
if (v := kwargs.get("max_concurrency")) is not None:
payload["maxConcurrency"] = v
if (v := kwargs.get("zero_data_retention")) is not None:
payload["zeroDataRetention"] = v
if (v := kwargs.get("integration")) is not None:
trimmed_integration = str(v).strip()
if trimmed_integration:
payload["integration"] = trimmed_integration
return payload
async def start_batch_scrape(client: AsyncHttpClient, urls: List[str], **kwargs) -> BatchScrapeResponse:
payload = _prepare(urls, **kwargs)
response = await client.post("/v2/batch/scrape", payload)
if response.status_code >= 400:
handle_response_error(response, "start batch scrape")
body = response.json()
if not body.get("success"):
raise Exception(body.get("error", "Unknown error occurred"))
return BatchScrapeResponse(id=body.get("id"), url=body.get("url"), invalid_urls=body.get("invalidURLs"))
async def get_batch_scrape_status(
client: AsyncHttpClient,
job_id: str,
pagination_config: Optional[PaginationConfig] = None
) -> BatchScrapeJob:
"""
Get the status of a batch scrape job.
Args:
client: Async HTTP client instance
job_id: ID of the batch scrape job
pagination_config: Optional configuration for pagination behavior
Returns:
BatchScrapeJob containing job status and data
Raises:
Exception: If the status check fails
"""
response = await client.get(f"/v2/batch/scrape/{job_id}")
if response.status_code >= 400:
handle_response_error(response, "get batch scrape status")
body = response.json()
payload = _parse_batch_scrape_status_response(body)
docs = payload["data"]
# Handle pagination if requested
auto_paginate = pagination_config.auto_paginate if pagination_config else True
if auto_paginate and payload["next"]:
docs = await _fetch_all_batch_pages_async(
client,
payload["next"],
docs,
pagination_config
)
return BatchScrapeJob(
status=payload["status"],
completed=payload["completed"],
total=payload["total"],
credits_used=payload["credits_used"],
expires_at=payload["expires_at"],
next=payload["next"] if not auto_paginate else None,
data=docs,
)
async def get_batch_scrape_status_page(
client: AsyncHttpClient,
next_url: str,
*,
request_timeout: Optional[float] = None,
) -> BatchScrapeJob:
"""
Fetch a single page of batch scrape results using the provided next URL.
Args:
client: Async HTTP client instance
next_url: Opaque next URL from a prior batch scrape status response
request_timeout: Timeout (in seconds) for the HTTP request
Returns:
BatchScrapeJob with the page data and next URL (if any)
Raises:
Exception: If the request fails or returns an error response
"""
response = await client.get(next_url, timeout=request_timeout)
if response.status_code >= 400:
handle_response_error(response, "get batch scrape status page")
body = response.json()
payload = _parse_batch_scrape_status_response(body)
return BatchScrapeJob(
status=payload["status"],
completed=payload["completed"],
total=payload["total"],
credits_used=payload["credits_used"],
expires_at=payload["expires_at"],
next=payload["next"],
data=payload["data"],
)
async def _fetch_all_batch_pages_async(
client: AsyncHttpClient,
next_url: str,
initial_documents: List[Document],
pagination_config: Optional[PaginationConfig] = None
) -> List[Document]:
"""
Fetch all pages of batch scrape results asynchronously.
Args:
client: Async HTTP client instance
next_url: URL for the next page
initial_documents: Documents from the first page
pagination_config: Optional configuration for pagination limits
Returns:
List of all documents from all pages
"""
documents = initial_documents.copy()
current_url = next_url
page_count = 0
# Apply pagination limits
max_pages = pagination_config.max_pages if pagination_config else None
max_results = pagination_config.max_results if pagination_config else None
max_wait_time = pagination_config.max_wait_time if pagination_config else None
start_time = time.monotonic()
while current_url:
# Check pagination limits
if (max_pages is not None) and (page_count >= max_pages):
break
if (max_wait_time is not None) and (time.monotonic() - start_time) > max_wait_time:
break
# Fetch next page
response = await client.get(current_url)
if response.status_code >= 400:
# Log error but continue with what we have
import logging
logger = logging.getLogger("firecrawl")
logger.warning(f"Failed to fetch next page: {response.status_code}")
break
page_data = response.json()
try:
page_payload = _parse_batch_scrape_status_response(page_data)
except Exception:
break
# Add documents from this page
for document in page_payload["data"]:
# Check max_results limit
if (max_results is not None) and (len(documents) >= max_results):
break
documents.append(document)
# Check if we hit max_results limit
if (max_results is not None) and (len(documents) >= max_results):
break
# Get next URL
current_url = page_payload["next"]
page_count += 1
return documents
async def cancel_batch_scrape(client: AsyncHttpClient, job_id: str) -> bool:
response = await client.delete(f"/v2/batch/scrape/{job_id}")
if response.status_code >= 400:
handle_response_error(response, "cancel batch scrape")
body = response.json()
return body.get("status") == "cancelled"
async def get_batch_scrape_errors(client: AsyncHttpClient, job_id: str) -> Dict[str, Any]:
response = await client.get(f"/v2/batch/scrape/{job_id}/errors")
if response.status_code >= 400:
handle_response_error(response, "get batch scrape errors")
body = response.json()
if not body.get("success"):
raise Exception(body.get("error", "Unknown error occurred"))
return body
|