diff --git a/.gitignore b/.gitignore index 52e25a2a..d55f35ac 100644 --- a/.gitignore +++ b/.gitignore @@ -206,6 +206,7 @@ pypi_build.sh git_issues.py git_issues.md +.next/ .tests/ .issues/ .docs/ @@ -214,4 +215,6 @@ git_issues.md todo_executor.md protect-all-except-feature.sh manage-collab.sh -publish.sh \ No newline at end of file +publish.sh +combine.sh +combined_output.txt \ No newline at end of file diff --git a/README.md b/README.md index dede4a03..36ee81a9 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# ๐Ÿ”ฅ๐Ÿ•ท๏ธ Crawl4AI: Crawl Smarter, Faster, Freely. For AI. +# ๐Ÿš€๐Ÿค– Crawl4AI: Crawl Smarter, Faster, Freely. For AI. unclecode%2Fcrawl4ai | Trendshift @@ -11,9 +11,9 @@ Crawl4AI is the #1 trending GitHub repository, actively maintained by a vibrant community. It delivers blazing-fast, AI-ready web crawling tailored for LLMs, AI agents, and data pipelines. Open source, flexible, and built for real-time performance, Crawl4AI empowers developers with unmatched speed, precision, and deployment ease. -[โœจ Check out latest update v0.4.1](#-recent-updates) +[โœจ Check out latest update v0.4.2](#-recent-updates) -๐ŸŽ‰ **Version 0.4.x is out!** Introducing our experimental PruningContentFilter - a powerful new algorithm for smarter Markdown generation. Test it out and [share your feedback](https://github.com/unclecode/crawl4ai/issues)! [Read the release notes โ†’](https://crawl4ai.com/mkdocs/blog) +๐ŸŽ‰ **Version 0.4.2 is out!** Introducing our experimental PruningContentFilter - a powerful new algorithm for smarter Markdown generation. Test it out and [share your feedback](https://github.com/unclecode/crawl4ai/issues)! [Read the release notes โ†’](https://crawl4ai.com/mkdocs/blog) ## ๐Ÿง Why Crawl4AI? @@ -626,6 +626,10 @@ async def test_news_crawl(): ## โœจ Recent Updates +- ๐Ÿ”ง **Configurable Crawlers and Browsers**: Simplified crawling with `BrowserConfig` and `CrawlerRunConfig`, making setups cleaner and more scalable. +- ๐Ÿ” **Session Management Enhancements**: Import/export local storage for personalized crawling with seamless session reuse. +- ๐Ÿ“ธ **Supercharged Screenshots**: Take lightning-fast, full-page screenshots of very long pages. +- ๐Ÿ“œ **Full-Page PDF Export**: Convert any web page into a PDF for easy sharing or archiving. - ๐Ÿ–ผ๏ธ **Lazy Load Handling**: Improved support for websites with lazy-loaded images. The crawler now waits for all images to fully load, ensuring no content is missed. - โšก **Text-Only Mode**: New mode for fast, lightweight crawling. Disables images, JavaScript, and GPU rendering, improving speed by 3-4x for text-focused crawls. - ๐Ÿ“ **Dynamic Viewport Adjustment**: Automatically adjusts the browser viewport to fit page content, ensuring accurate rendering and capturing of all elements. @@ -633,7 +637,8 @@ async def test_news_crawl(): - ๐Ÿง‘โ€๐Ÿ’ป **Session Reuse**: Introduced `create_session` for efficient crawling by reusing the same browser session across multiple requests. - ๐ŸŒŸ **Light Mode**: Optimized browser performance by disabling unnecessary features like extensions, background timers, and sync processes. -Read the full details of this release in our [0.4.1 Release Notes](https://github.com/unclecode/crawl4ai/blob/main/docs/md_v2/blog/releases/0.4.1.md). + +Read the full details of this release in our [0.4.2 Release Notes](https://github.com/unclecode/crawl4ai/blob/main/docs/md_v2/blog/releases/0.4.2.md). ## ๐Ÿ“– Documentation & Roadmap diff --git a/README.sync.md b/README.sync.md deleted file mode 100644 index 6bbef7e4..00000000 --- a/README.sync.md +++ /dev/null @@ -1,244 +0,0 @@ -# Crawl4AI v0.2.77 ๐Ÿ•ท๏ธ๐Ÿค– - -[![GitHub Stars](https://img.shields.io/github/stars/unclecode/crawl4ai?style=social)](https://github.com/unclecode/crawl4ai/stargazers) -[![GitHub Forks](https://img.shields.io/github/forks/unclecode/crawl4ai?style=social)](https://github.com/unclecode/crawl4ai/network/members) -[![GitHub Issues](https://img.shields.io/github/issues/unclecode/crawl4ai)](https://github.com/unclecode/crawl4ai/issues) -[![GitHub Pull Requests](https://img.shields.io/github/issues-pr/unclecode/crawl4ai)](https://github.com/unclecode/crawl4ai/pulls) -[![License](https://img.shields.io/github/license/unclecode/crawl4ai)](https://github.com/unclecode/crawl4ai/blob/main/LICENSE) - -Crawl4AI simplifies web crawling and data extraction, making it accessible for large language models (LLMs) and AI applications. ๐Ÿ†“๐ŸŒ - -#### [v0.2.77] - 2024-08-02 - -Major improvements in functionality, performance, and cross-platform compatibility! ๐Ÿš€ - -- ๐Ÿณ **Docker enhancements**: - - Significantly improved Dockerfile for easy installation on Linux, Mac, and Windows. -- ๐ŸŒ **Official Docker Hub image**: - - Launched our first official image on Docker Hub for streamlined deployment (unclecode/crawl4ai). -- ๐Ÿ”ง **Selenium upgrade**: - - Removed dependency on ChromeDriver, now using Selenium's built-in capabilities for better compatibility. -- ๐Ÿ–ผ๏ธ **Image description**: - - Implemented ability to generate textual descriptions for extracted images from web pages. -- โšก **Performance boost**: - - Various improvements to enhance overall speed and performance. - -## Try it Now! - -โœจ Play around with this [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/drive/1sJPAmeLj5PMrg2VgOwMJ2ubGIcK0cJeX?usp=sharing) - -โœจ visit our [Documentation Website](https://crawl4ai.com/mkdocs/) - -โœจ Check [Demo](https://crawl4ai.com/mkdocs/demo) - -## Features โœจ - -- ๐Ÿ†“ Completely free and open-source -- ๐Ÿค– LLM-friendly output formats (JSON, cleaned HTML, markdown) -- ๐ŸŒ Supports crawling multiple URLs simultaneously -- ๐ŸŽจ Extracts and returns all media tags (Images, Audio, and Video) -- ๐Ÿ”— Extracts all external and internal links -- ๐Ÿ“š Extracts metadata from the page -- ๐Ÿ”„ Custom hooks for authentication, headers, and page modifications before crawling -- ๐Ÿ•ต๏ธ User-agent customization -- ๐Ÿ–ผ๏ธ Takes screenshots of the page -- ๐Ÿ“œ Executes multiple custom JavaScripts before crawling -- ๐Ÿ“š Various chunking strategies: topic-based, regex, sentence, and more -- ๐Ÿง  Advanced extraction strategies: cosine clustering, LLM, and more -- ๐ŸŽฏ CSS selector support -- ๐Ÿ“ Passes instructions/keywords to refine extraction - -# Crawl4AI - -## ๐ŸŒŸ Shoutout to Contributors of v0.2.77! - -A big thank you to the amazing contributors who've made this release possible: - -- [@aravindkarnam](https://github.com/aravindkarnam) for the new image description feature -- [@FractalMind](https://github.com/FractalMind) for our official Docker Hub image -- [@ketonkss4](https://github.com/ketonkss4) for helping streamline our Selenium setup - -Your contributions are driving Crawl4AI forward! ๐Ÿš€ - -## Cool Examples ๐Ÿš€ - -### Quick Start - -```python -from crawl4ai import WebCrawler - -# Create an instance of WebCrawler -crawler = WebCrawler() - -# Warm up the crawler (load necessary models) -crawler.warmup() - -# Run the crawler on a URL -result = crawler.run(url="https://www.nbcnews.com/business") - -# Print the extracted content -print(result.markdown) -``` - -## How to install ๐Ÿ›  - -### Using pip ๐Ÿ -```bash -virtualenv venv -source venv/bin/activate -pip install "crawl4ai @ git+https://github.com/unclecode/crawl4ai.git" -``` - -### Using Docker ๐Ÿณ - -```bash -# For Mac users (M1/M2) -# docker build --platform linux/amd64 -t crawl4ai . -docker build -t crawl4ai . -docker run -d -p 8000:80 crawl4ai -``` - -### Using Docker Hub ๐Ÿณ - -```bash -docker pull unclecode/crawl4ai:latest -docker run -d -p 8000:80 unclecode/crawl4ai:latest -``` - - -## Speed-First Design ๐Ÿš€ - -Perhaps the most important design principle for this library is speed. We need to ensure it can handle many links and resources in parallel as quickly as possible. By combining this speed with fast LLMs like Groq, the results will be truly amazing. - -```python -import time -from crawl4ai.web_crawler import WebCrawler -crawler = WebCrawler() -crawler.warmup() - -start = time.time() -url = r"https://www.nbcnews.com/business" -result = crawler.run( url, word_count_threshold=10, bypass_cache=True) -end = time.time() -print(f"Time taken: {end - start}") -``` - -Let's take a look the calculated time for the above code snippet: - -```bash -[LOG] ๐Ÿš€ Crawling done, success: True, time taken: 1.3623387813568115 seconds -[LOG] ๐Ÿš€ Content extracted, success: True, time taken: 0.05715131759643555 seconds -[LOG] ๐Ÿš€ Extraction, time taken: 0.05750393867492676 seconds. -Time taken: 1.439958095550537 -``` -Fetching the content from the page took 1.3623 seconds, and extracting the content took 0.0575 seconds. ๐Ÿš€ - -### Extract Structured Data from Web Pages ๐Ÿ“Š - -Crawl all OpenAI models and their fees from the official page. - -```python -import os -from crawl4ai import WebCrawler -from crawl4ai.extraction_strategy import LLMExtractionStrategy -from pydantic import BaseModel, Field - -class OpenAIModelFee(BaseModel): - model_name: str = Field(..., description="Name of the OpenAI model.") - input_fee: str = Field(..., description="Fee for input token for the OpenAI model.") - output_fee: str = Field(..., description="Fee for output token รŸfor the OpenAI model.") - -url = 'https://openai.com/api/pricing/' -crawler = WebCrawler() -crawler.warmup() - -result = crawler.run( - url=url, - word_count_threshold=1, - extraction_strategy= LLMExtractionStrategy( - provider= "openai/gpt-4o", api_token = os.getenv('OPENAI_API_KEY'), - schema=OpenAIModelFee.schema(), - extraction_type="schema", - instruction="""From the crawled content, extract all mentioned model names along with their fees for input and output tokens. - Do not miss any models in the entire content. One extracted model JSON format should look like this: - {"model_name": "GPT-4", "input_fee": "US$10.00 / 1M tokens", "output_fee": "US$30.00 / 1M tokens"}.""" - ), - bypass_cache=True, - ) - -print(result.extracted_content) -``` - -### Execute JS, Filter Data with CSS Selector, and Clustering - -```python -from crawl4ai import WebCrawler -from crawl4ai.chunking_strategy import CosineStrategy - -js_code = ["const loadMoreButton = Array.from(document.querySelectorAll('button')).find(button => button.textContent.includes('Load More')); loadMoreButton && loadMoreButton.click();"] - -crawler = WebCrawler() -crawler.warmup() - -result = crawler.run( - url="https://www.nbcnews.com/business", - js=js_code, - css_selector="p", - extraction_strategy=CosineStrategy(semantic_filter="technology") -) - -print(result.extracted_content) -``` - -### Extract Structured Data from Web Pages With Proxy and BaseUrl - -```python -from crawl4ai import WebCrawler -from crawl4ai.extraction_strategy import LLMExtractionStrategy - -def create_crawler(): - crawler = WebCrawler(verbose=True, proxy="http://127.0.0.1:7890") - crawler.warmup() - return crawler - -crawler = create_crawler() - -crawler.warmup() - -result = crawler.run( - url="https://www.nbcnews.com/business", - extraction_strategy=LLMExtractionStrategy( - provider="openai/gpt-4o", - api_token="sk-", - base_url="https://api.openai.com/v1" - ) -) - -print(result.markdown) -``` - -## Documentation ๐Ÿ“š - -For detailed documentation, including installation instructions, advanced features, and API reference, visit our [Documentation Website](https://crawl4ai.com/mkdocs/). - -## Contributing ๐Ÿค - -We welcome contributions from the open-source community. Check out our [contribution guidelines](https://github.com/unclecode/crawl4ai/blob/main/CONTRIBUTING.md) for more information. - -## License ๐Ÿ“„ - -Crawl4AI is released under the [Apache 2.0 License](https://github.com/unclecode/crawl4ai/blob/main/LICENSE). - -## Contact ๐Ÿ“ง - -For questions, suggestions, or feedback, feel free to reach out: - -- GitHub: [unclecode](https://github.com/unclecode) -- Twitter: [@unclecode](https://twitter.com/unclecode) -- Website: [crawl4ai.com](https://crawl4ai.com) - -Happy Crawling! ๐Ÿ•ธ๏ธ๐Ÿš€ - -## Star History - -[![Star History Chart](https://api.star-history.com/svg?repos=unclecode/crawl4ai&type=Date)](https://star-history.com/#unclecode/crawl4ai&Date) \ No newline at end of file diff --git a/a.md b/a.md new file mode 100644 index 00000000..4d68148f --- /dev/null +++ b/a.md @@ -0,0 +1,4214 @@ +diff --git a/.gitignore b/.gitignore +index 02c75b3..432b5aa 100644 +--- a/.gitignore ++++ b/.gitignore +@@ -206,6 +206,7 @@ pypi_build.sh + git_issues.py + git_issues.md + ++.next/ + .tests/ + .issues/ + .docs/ +diff --git a/README.sync.md b/README.sync.md +deleted file mode 100644 +index 6bbef7e..0000000 +--- a/README.sync.md ++++ /dev/null +@@ -1,244 +0,0 @@ +-# Crawl4AI v0.2.77 ๐Ÿ•ท๏ธ๐Ÿค– +- +-[![GitHub Stars](https://img.shields.io/github/stars/unclecode/crawl4ai?style=social)](https://github.com/unclecode/crawl4ai/stargazers) +-[![GitHub Forks](https://img.shields.io/github/forks/unclecode/crawl4ai?style=social)](https://github.com/unclecode/crawl4ai/network/members) +-[![GitHub Issues](https://img.shields.io/github/issues/unclecode/crawl4ai)](https://github.com/unclecode/crawl4ai/issues) +-[![GitHub Pull Requests](https://img.shields.io/github/issues-pr/unclecode/crawl4ai)](https://github.com/unclecode/crawl4ai/pulls) +-[![License](https://img.shields.io/github/license/unclecode/crawl4ai)](https://github.com/unclecode/crawl4ai/blob/main/LICENSE) +- +-Crawl4AI simplifies web crawling and data extraction, making it accessible for large language models (LLMs) and AI applications. ๐Ÿ†“๐ŸŒ +- +-#### [v0.2.77] - 2024-08-02 +- +-Major improvements in functionality, performance, and cross-platform compatibility! ๐Ÿš€ +- +-- ๐Ÿณ **Docker enhancements**: +- - Significantly improved Dockerfile for easy installation on Linux, Mac, and Windows. +-- ๐ŸŒ **Official Docker Hub image**: +- - Launched our first official image on Docker Hub for streamlined deployment (unclecode/crawl4ai). +-- ๐Ÿ”ง **Selenium upgrade**: +- - Removed dependency on ChromeDriver, now using Selenium's built-in capabilities for better compatibility. +-- ๐Ÿ–ผ๏ธ **Image description**: +- - Implemented ability to generate textual descriptions for extracted images from web pages. +-- โšก **Performance boost**: +- - Various improvements to enhance overall speed and performance. +- +-## Try it Now! +- +-โœจ Play around with this [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/drive/1sJPAmeLj5PMrg2VgOwMJ2ubGIcK0cJeX?usp=sharing) +- +-โœจ visit our [Documentation Website](https://crawl4ai.com/mkdocs/) +- +-โœจ Check [Demo](https://crawl4ai.com/mkdocs/demo) +- +-## Features โœจ +- +-- ๐Ÿ†“ Completely free and open-source +-- ๐Ÿค– LLM-friendly output formats (JSON, cleaned HTML, markdown) +-- ๐ŸŒ Supports crawling multiple URLs simultaneously +-- ๐ŸŽจ Extracts and returns all media tags (Images, Audio, and Video) +-- ๐Ÿ”— Extracts all external and internal links +-- ๐Ÿ“š Extracts metadata from the page +-- ๐Ÿ”„ Custom hooks for authentication, headers, and page modifications before crawling +-- ๐Ÿ•ต๏ธ User-agent customization +-- ๐Ÿ–ผ๏ธ Takes screenshots of the page +-- ๐Ÿ“œ Executes multiple custom JavaScripts before crawling +-- ๐Ÿ“š Various chunking strategies: topic-based, regex, sentence, and more +-- ๐Ÿง  Advanced extraction strategies: cosine clustering, LLM, and more +-- ๐ŸŽฏ CSS selector support +-- ๐Ÿ“ Passes instructions/keywords to refine extraction +- +-# Crawl4AI +- +-## ๐ŸŒŸ Shoutout to Contributors of v0.2.77! +- +-A big thank you to the amazing contributors who've made this release possible: +- +-- [@aravindkarnam](https://github.com/aravindkarnam) for the new image description feature +-- [@FractalMind](https://github.com/FractalMind) for our official Docker Hub image +-- [@ketonkss4](https://github.com/ketonkss4) for helping streamline our Selenium setup +- +-Your contributions are driving Crawl4AI forward! ๐Ÿš€ +- +-## Cool Examples ๐Ÿš€ +- +-### Quick Start +- +-```python +-from crawl4ai import WebCrawler +- +-# Create an instance of WebCrawler +-crawler = WebCrawler() +- +-# Warm up the crawler (load necessary models) +-crawler.warmup() +- +-# Run the crawler on a URL +-result = crawler.run(url="https://www.nbcnews.com/business") +- +-# Print the extracted content +-print(result.markdown) +-``` +- +-## How to install ๐Ÿ›  +- +-### Using pip ๐Ÿ +-```bash +-virtualenv venv +-source venv/bin/activate +-pip install "crawl4ai @ git+https://github.com/unclecode/crawl4ai.git" +-``` +- +-### Using Docker ๐Ÿณ +- +-```bash +-# For Mac users (M1/M2) +-# docker build --platform linux/amd64 -t crawl4ai . +-docker build -t crawl4ai . +-docker run -d -p 8000:80 crawl4ai +-``` +- +-### Using Docker Hub ๐Ÿณ +- +-```bash +-docker pull unclecode/crawl4ai:latest +-docker run -d -p 8000:80 unclecode/crawl4ai:latest +-``` +- +- +-## Speed-First Design ๐Ÿš€ +- +-Perhaps the most important design principle for this library is speed. We need to ensure it can handle many links and resources in parallel as quickly as possible. By combining this speed with fast LLMs like Groq, the results will be truly amazing. +- +-```python +-import time +-from crawl4ai.web_crawler import WebCrawler +-crawler = WebCrawler() +-crawler.warmup() +- +-start = time.time() +-url = r"https://www.nbcnews.com/business" +-result = crawler.run( url, word_count_threshold=10, bypass_cache=True) +-end = time.time() +-print(f"Time taken: {end - start}") +-``` +- +-Let's take a look the calculated time for the above code snippet: +- +-```bash +-[LOG] ๐Ÿš€ Crawling done, success: True, time taken: 1.3623387813568115 seconds +-[LOG] ๐Ÿš€ Content extracted, success: True, time taken: 0.05715131759643555 seconds +-[LOG] ๐Ÿš€ Extraction, time taken: 0.05750393867492676 seconds. +-Time taken: 1.439958095550537 +-``` +-Fetching the content from the page took 1.3623 seconds, and extracting the content took 0.0575 seconds. ๐Ÿš€ +- +-### Extract Structured Data from Web Pages ๐Ÿ“Š +- +-Crawl all OpenAI models and their fees from the official page. +- +-```python +-import os +-from crawl4ai import WebCrawler +-from crawl4ai.extraction_strategy import LLMExtractionStrategy +-from pydantic import BaseModel, Field +- +-class OpenAIModelFee(BaseModel): +- model_name: str = Field(..., description="Name of the OpenAI model.") +- input_fee: str = Field(..., description="Fee for input token for the OpenAI model.") +- output_fee: str = Field(..., description="Fee for output token รŸfor the OpenAI model.") +- +-url = 'https://openai.com/api/pricing/' +-crawler = WebCrawler() +-crawler.warmup() +- +-result = crawler.run( +- url=url, +- word_count_threshold=1, +- extraction_strategy= LLMExtractionStrategy( +- provider= "openai/gpt-4o", api_token = os.getenv('OPENAI_API_KEY'), +- schema=OpenAIModelFee.schema(), +- extraction_type="schema", +- instruction="""From the crawled content, extract all mentioned model names along with their fees for input and output tokens. +- Do not miss any models in the entire content. One extracted model JSON format should look like this: +- {"model_name": "GPT-4", "input_fee": "US$10.00 / 1M tokens", "output_fee": "US$30.00 / 1M tokens"}.""" +- ), +- bypass_cache=True, +- ) +- +-print(result.extracted_content) +-``` +- +-### Execute JS, Filter Data with CSS Selector, and Clustering +- +-```python +-from crawl4ai import WebCrawler +-from crawl4ai.chunking_strategy import CosineStrategy +- +-js_code = ["const loadMoreButton = Array.from(document.querySelectorAll('button')).find(button => button.textContent.includes('Load More')); loadMoreButton && loadMoreButton.click();"] +- +-crawler = WebCrawler() +-crawler.warmup() +- +-result = crawler.run( +- url="https://www.nbcnews.com/business", +- js=js_code, +- css_selector="p", +- extraction_strategy=CosineStrategy(semantic_filter="technology") +-) +- +-print(result.extracted_content) +-``` +- +-### Extract Structured Data from Web Pages With Proxy and BaseUrl +- +-```python +-from crawl4ai import WebCrawler +-from crawl4ai.extraction_strategy import LLMExtractionStrategy +- +-def create_crawler(): +- crawler = WebCrawler(verbose=True, proxy="http://127.0.0.1:7890") +- crawler.warmup() +- return crawler +- +-crawler = create_crawler() +- +-crawler.warmup() +- +-result = crawler.run( +- url="https://www.nbcnews.com/business", +- extraction_strategy=LLMExtractionStrategy( +- provider="openai/gpt-4o", +- api_token="sk-", +- base_url="https://api.openai.com/v1" +- ) +-) +- +-print(result.markdown) +-``` +- +-## Documentation ๐Ÿ“š +- +-For detailed documentation, including installation instructions, advanced features, and API reference, visit our [Documentation Website](https://crawl4ai.com/mkdocs/). +- +-## Contributing ๐Ÿค +- +-We welcome contributions from the open-source community. Check out our [contribution guidelines](https://github.com/unclecode/crawl4ai/blob/main/CONTRIBUTING.md) for more information. +- +-## License ๐Ÿ“„ +- +-Crawl4AI is released under the [Apache 2.0 License](https://github.com/unclecode/crawl4ai/blob/main/LICENSE). +- +-## Contact ๐Ÿ“ง +- +-For questions, suggestions, or feedback, feel free to reach out: +- +-- GitHub: [unclecode](https://github.com/unclecode) +-- Twitter: [@unclecode](https://twitter.com/unclecode) +-- Website: [crawl4ai.com](https://crawl4ai.com) +- +-Happy Crawling! ๐Ÿ•ธ๏ธ๐Ÿš€ +- +-## Star History +- +-[![Star History Chart](https://api.star-history.com/svg?repos=unclecode/crawl4ai&type=Date)](https://star-history.com/#unclecode/crawl4ai&Date) +\ No newline at end of file +diff --git a/crawl4ai/__init__.py b/crawl4ai/__init__.py +index cee7c25..d297dfc 100644 +--- a/crawl4ai/__init__.py ++++ b/crawl4ai/__init__.py +@@ -1,7 +1,11 @@ + # __init__.py + + from .async_webcrawler import AsyncWebCrawler, CacheMode +- ++from .async_configs import BrowserConfig, CrawlerRunConfig ++from .extraction_strategy import ExtractionStrategy, LLMExtractionStrategy, CosineStrategy, JsonCssExtractionStrategy ++from .chunking_strategy import ChunkingStrategy, RegexChunking ++from .markdown_generation_strategy import DefaultMarkdownGenerator ++from .content_filter_strategy import PruningContentFilter, BM25ContentFilter + from .models import CrawlResult + from .__version__ import __version__ + +@@ -9,6 +13,17 @@ __all__ = [ + "AsyncWebCrawler", + "CrawlResult", + "CacheMode", ++ 'BrowserConfig', ++ 'CrawlerRunConfig', ++ 'ExtractionStrategy', ++ 'LLMExtractionStrategy', ++ 'CosineStrategy', ++ 'JsonCssExtractionStrategy', ++ 'ChunkingStrategy', ++ 'RegexChunking', ++ 'DefaultMarkdownGenerator', ++ 'PruningContentFilter', ++ 'BM25ContentFilter', + ] + + def is_sync_version_installed(): +diff --git a/crawl4ai/async_crawler_strategy.current.py b/crawl4ai/async_crawler_strategy.current.py +deleted file mode 100644 +index 6302447..0000000 +--- a/crawl4ai/async_crawler_strategy.current.py ++++ /dev/null +@@ -1,1475 +0,0 @@ +-import asyncio +-import base64 +-import time +-from abc import ABC, abstractmethod +-from typing import Callable, Dict, Any, List, Optional, Awaitable +-import os, sys, shutil +-import tempfile, subprocess +-from playwright.async_api import async_playwright, Page, Browser, Error +-from playwright.async_api import TimeoutError as PlaywrightTimeoutError +-from io import BytesIO +-from PIL import Image, ImageDraw, ImageFont +-from pathlib import Path +-from playwright.async_api import ProxySettings +-from pydantic import BaseModel +-import hashlib +-import json +-import uuid +-from .models import AsyncCrawlResponse +-from .utils import create_box_message +-from .user_agent_generator import UserAgentGenerator +-from playwright_stealth import StealthConfig, stealth_async +- +-stealth_config = StealthConfig( +- webdriver=True, +- chrome_app=True, +- chrome_csi=True, +- chrome_load_times=True, +- chrome_runtime=True, +- navigator_languages=True, +- navigator_plugins=True, +- navigator_permissions=True, +- webgl_vendor=True, +- outerdimensions=True, +- navigator_hardware_concurrency=True, +- media_codecs=True, +-) +- +-BROWSER_DISABLE_OPTIONS = [ +- "--disable-background-networking", +- "--disable-background-timer-throttling", +- "--disable-backgrounding-occluded-windows", +- "--disable-breakpad", +- "--disable-client-side-phishing-detection", +- "--disable-component-extensions-with-background-pages", +- "--disable-default-apps", +- "--disable-extensions", +- "--disable-features=TranslateUI", +- "--disable-hang-monitor", +- "--disable-ipc-flooding-protection", +- "--disable-popup-blocking", +- "--disable-prompt-on-repost", +- "--disable-sync", +- "--force-color-profile=srgb", +- "--metrics-recording-only", +- "--no-first-run", +- "--password-store=basic", +- "--use-mock-keychain" +-] +- +- +-class ManagedBrowser: +- def __init__(self, browser_type: str = "chromium", user_data_dir: Optional[str] = None, headless: bool = False, logger = None, host: str = "localhost", debugging_port: int = 9222): +- self.browser_type = browser_type +- self.user_data_dir = user_data_dir +- self.headless = headless +- self.browser_process = None +- self.temp_dir = None +- self.debugging_port = debugging_port +- self.host = host +- self.logger = logger +- self.shutting_down = False +- +- async def start(self) -> str: +- """ +- Starts the browser process and returns the CDP endpoint URL. +- If user_data_dir is not provided, creates a temporary directory. +- """ +- +- # Create temp dir if needed +- if not self.user_data_dir: +- self.temp_dir = tempfile.mkdtemp(prefix="browser-profile-") +- self.user_data_dir = self.temp_dir +- +- # Get browser path and args based on OS and browser type +- browser_path = self._get_browser_path() +- args = self._get_browser_args() +- +- # Start browser process +- try: +- self.browser_process = subprocess.Popen( +- args, +- stdout=subprocess.PIPE, +- stderr=subprocess.PIPE +- ) +- # Monitor browser process output for errors +- asyncio.create_task(self._monitor_browser_process()) +- await asyncio.sleep(2) # Give browser time to start +- return f"http://{self.host}:{self.debugging_port}" +- except Exception as e: +- await self.cleanup() +- raise Exception(f"Failed to start browser: {e}") +- +- async def _monitor_browser_process(self): +- """Monitor the browser process for unexpected termination.""" +- if self.browser_process: +- try: +- stdout, stderr = await asyncio.gather( +- asyncio.to_thread(self.browser_process.stdout.read), +- asyncio.to_thread(self.browser_process.stderr.read) +- ) +- +- # Check shutting_down flag BEFORE logging anything +- if self.browser_process.poll() is not None: +- if not self.shutting_down: +- self.logger.error( +- message="Browser process terminated unexpectedly | Code: {code} | STDOUT: {stdout} | STDERR: {stderr}", +- tag="ERROR", +- params={ +- "code": self.browser_process.returncode, +- "stdout": stdout.decode(), +- "stderr": stderr.decode() +- } +- ) +- await self.cleanup() +- else: +- self.logger.info( +- message="Browser process terminated normally | Code: {code}", +- tag="INFO", +- params={"code": self.browser_process.returncode} +- ) +- except Exception as e: +- if not self.shutting_down: +- self.logger.error( +- message="Error monitoring browser process: {error}", +- tag="ERROR", +- params={"error": str(e)} +- ) +- +- def _get_browser_path(self) -> str: +- """Returns the browser executable path based on OS and browser type""" +- if sys.platform == "darwin": # macOS +- paths = { +- "chromium": "/Applications/Google Chrome.app/Contents/MacOS/Google Chrome", +- "firefox": "/Applications/Firefox.app/Contents/MacOS/firefox", +- "webkit": "/Applications/Safari.app/Contents/MacOS/Safari" +- } +- elif sys.platform == "win32": # Windows +- paths = { +- "chromium": "C:\\Program Files\\Google\\Chrome\\Application\\chrome.exe", +- "firefox": "C:\\Program Files\\Mozilla Firefox\\firefox.exe", +- "webkit": None # WebKit not supported on Windows +- } +- else: # Linux +- paths = { +- "chromium": "google-chrome", +- "firefox": "firefox", +- "webkit": None # WebKit not supported on Linux +- } +- +- return paths.get(self.browser_type) +- +- def _get_browser_args(self) -> List[str]: +- """Returns browser-specific command line arguments""" +- base_args = [self._get_browser_path()] +- +- if self.browser_type == "chromium": +- args = [ +- f"--remote-debugging-port={self.debugging_port}", +- f"--user-data-dir={self.user_data_dir}", +- ] +- if self.headless: +- args.append("--headless=new") +- elif self.browser_type == "firefox": +- args = [ +- "--remote-debugging-port", str(self.debugging_port), +- "--profile", self.user_data_dir, +- ] +- if self.headless: +- args.append("--headless") +- else: +- raise NotImplementedError(f"Browser type {self.browser_type} not supported") +- +- return base_args + args +- +- async def cleanup(self): +- """Cleanup browser process and temporary directory""" +- # Set shutting_down flag BEFORE any termination actions +- self.shutting_down = True +- +- if self.browser_process: +- try: +- self.browser_process.terminate() +- # Wait for process to end gracefully +- for _ in range(10): # 10 attempts, 100ms each +- if self.browser_process.poll() is not None: +- break +- await asyncio.sleep(0.1) +- +- # Force kill if still running +- if self.browser_process.poll() is None: +- self.browser_process.kill() +- await asyncio.sleep(0.1) # Brief wait for kill to take effect +- +- except Exception as e: +- self.logger.error( +- message="Error terminating browser: {error}", +- tag="ERROR", +- params={"error": str(e)} +- ) +- +- if self.temp_dir and os.path.exists(self.temp_dir): +- try: +- shutil.rmtree(self.temp_dir) +- except Exception as e: +- self.logger.error( +- message="Error removing temporary directory: {error}", +- tag="ERROR", +- params={"error": str(e)} +- ) +- +- +-class AsyncCrawlerStrategy(ABC): +- @abstractmethod +- async def crawl(self, url: str, **kwargs) -> AsyncCrawlResponse: +- pass +- +- @abstractmethod +- async def crawl_many(self, urls: List[str], **kwargs) -> List[AsyncCrawlResponse]: +- pass +- +- @abstractmethod +- async def take_screenshot(self, **kwargs) -> str: +- pass +- +- @abstractmethod +- def update_user_agent(self, user_agent: str): +- pass +- +- @abstractmethod +- def set_hook(self, hook_type: str, hook: Callable): +- pass +- +-class AsyncPlaywrightCrawlerStrategy(AsyncCrawlerStrategy): +- def __init__(self, use_cached_html=False, js_code=None, logger = None, **kwargs): +- self.text_only = kwargs.get("text_only", False) +- self.light_mode = kwargs.get("light_mode", False) +- self.logger = logger +- self.use_cached_html = use_cached_html +- self.viewport_width = kwargs.get("viewport_width", 800 if self.text_only else 1920) +- self.viewport_height = kwargs.get("viewport_height", 600 if self.text_only else 1080) +- +- if self.text_only: +- self.extra_args = kwargs.get("extra_args", []) + [ +- '--disable-images', +- '--disable-javascript', +- '--disable-gpu', +- '--disable-software-rasterizer', +- '--disable-dev-shm-usage' +- ] +- +- self.user_agent = kwargs.get( +- "user_agent", +- "Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:109.0) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/116.0.5845.187 Safari/604.1 Edg/117.0.2045.47" +- # "Mozilla/5.0 (Linux; Android 11; SM-G973F) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.120 Mobile Safari/537.36" +- ) +- user_agenr_generator = UserAgentGenerator() +- if kwargs.get("user_agent_mode") == "random": +- self.user_agent = user_agenr_generator.generate( +- **kwargs.get("user_agent_generator_config", {}) +- ) +- self.proxy = kwargs.get("proxy") +- self.proxy_config = kwargs.get("proxy_config") +- self.headless = kwargs.get("headless", True) +- self.browser_type = kwargs.get("browser_type", "chromium") +- self.headers = kwargs.get("headers", {}) +- self.browser_hint = user_agenr_generator.generate_client_hints(self.user_agent) +- self.headers.setdefault("sec-ch-ua", self.browser_hint) +- self.cookies = kwargs.get("cookies", []) +- self.storage_state = kwargs.get("storage_state", None) +- self.sessions = {} +- self.session_ttl = 1800 +- self.js_code = js_code +- self.verbose = kwargs.get("verbose", False) +- self.playwright = None +- self.browser = None +- self.sleep_on_close = kwargs.get("sleep_on_close", False) +- self.use_managed_browser = kwargs.get("use_managed_browser", False) +- self.user_data_dir = kwargs.get("user_data_dir", None) +- self.use_persistent_context = kwargs.get("use_persistent_context", False) +- self.chrome_channel = kwargs.get("chrome_channel", "chrome") +- self.managed_browser = None +- self.default_context = None +- self.hooks = { +- 'on_browser_created': None, +- 'on_user_agent_updated': None, +- 'on_execution_started': None, +- 'before_goto': None, +- 'after_goto': None, +- 'before_return_html': None, +- 'before_retrieve_html': None +- } +- self.extra_args = kwargs.get("extra_args", []) +- self.ignore_https_errors = kwargs.get("ignore_https_errors", True) +- self.java_script_enabled = kwargs.get("java_script_enabled", True) +- self.accept_downloads = kwargs.get("accept_downloads", False) +- self.downloads_path = kwargs.get("downloads_path") +- self._downloaded_files = [] # Track downloaded files for current crawl +- if self.accept_downloads and not self.downloads_path: +- self.downloads_path = os.path.join(os.getcwd(), "downloads") +- os.makedirs(self.downloads_path, exist_ok=True) +- +- +- async def __aenter__(self): +- await self.start() +- return self +- +- async def __aexit__(self, exc_type, exc_val, exc_tb): +- await self.close() +- +- async def start(self): +- if self.playwright is None: +- self.playwright = await async_playwright().start() +- if self.browser is None: +- if self.use_managed_browser: +- # Use managed browser approach +- self.managed_browser = ManagedBrowser( +- browser_type=self.browser_type, +- user_data_dir=self.user_data_dir, +- headless=self.headless, +- logger=self.logger +- ) +- cdp_url = await self.managed_browser.start() +- self.browser = await self.playwright.chromium.connect_over_cdp(cdp_url) +- +- # Get the default context that maintains the user profile +- contexts = self.browser.contexts +- if contexts: +- self.default_context = contexts[0] +- else: +- # If no default context exists, create one +- self.default_context = await self.browser.new_context( +- viewport={"width": self.viewport_width, "height": self.viewport_height}, +- storage_state=self.storage_state, +- user_agent= self.user_agent, +- accept_downloads=self.accept_downloads, +- ignore_https_errors=self.ignore_https_errors, +- java_script_enabled=self.java_script_enabled, +- ) +- +- # Set up the default context +- if self.default_context: +- await self.default_context.set_extra_http_headers(self.headers) +- if self.cookies: +- await self.default_context.add_cookies(self.cookies) +- if self.storage_state: +- # If storage_state is a dictionary or file path, Playwright will handle it. +- await self.default_context.storage_state(path=None) # Just ensuring default_context is ready +- if self.accept_downloads: +- await self.default_context.set_default_timeout(60000) +- await self.default_context.set_default_navigation_timeout(60000) +- self.default_context._impl_obj._options["accept_downloads"] = True +- self.default_context._impl_obj._options["downloads_path"] = self.downloads_path +- +- if self.user_agent: +- await self.default_context.set_extra_http_headers({ +- "User-Agent": self.user_agent, +- "sec-ch-ua": self.browser_hint, +- # **self.headers +- }) +- else: +- # Base browser arguments +- browser_args = { +- "headless": self.headless, +- "args": [ +- "--no-sandbox", +- "--disable-dev-shm-usage", +- "--no-first-run", +- "--no-default-browser-check", +- "--disable-infobars", +- "--window-position=0,0", +- "--ignore-certificate-errors", +- "--ignore-certificate-errors-spki-list", +- "--disable-blink-features=AutomationControlled", +- "--window-position=400,0", +- f"--window-size={self.viewport_width},{self.viewport_height}", +- ] +- } +- +- if self.light_mode: +- browser_args["args"].extend(BROWSER_DISABLE_OPTIONS) +- +- if self.text_only: +- browser_args["args"].extend([ +- '--blink-settings=imagesEnabled=false', +- '--disable-remote-fonts' +- ]) +- +- # Add channel if specified (try Chrome first) +- if self.chrome_channel: +- browser_args["channel"] = self.chrome_channel +- +- # Add extra args if provided +- if self.extra_args: +- browser_args["args"].extend(self.extra_args) +- +- # Add downloads path if downloads are enabled +- if self.accept_downloads: +- browser_args["downloads_path"] = self.downloads_path +- +- # Add proxy settings if a proxy is specified +- if self.proxy: +- proxy_settings = ProxySettings(server=self.proxy) +- browser_args["proxy"] = proxy_settings +- elif self.proxy_config: +- proxy_settings = ProxySettings( +- server=self.proxy_config.get("server"), +- username=self.proxy_config.get("username"), +- password=self.proxy_config.get("password") +- ) +- browser_args["proxy"] = proxy_settings +- +- try: +- # Select the appropriate browser based on the browser_type +- if self.browser_type == "firefox": +- self.browser = await self.playwright.firefox.launch(**browser_args) +- elif self.browser_type == "webkit": +- if "viewport" not in browser_args: +- browser_args["viewport"] = {"width": self.viewport_width, "height": self.viewport_height} +- self.browser = await self.playwright.webkit.launch(**browser_args) +- else: +- if self.use_persistent_context and self.user_data_dir: +- self.browser = await self.playwright.chromium.launch_persistent_context( +- user_data_dir=self.user_data_dir, +- accept_downloads=self.accept_downloads, +- downloads_path=self.downloads_path if self.accept_downloads else None, +- **browser_args +- ) +- self.default_context = self.browser +- else: +- self.browser = await self.playwright.chromium.launch(**browser_args) +- self.default_context = self.browser +- +- except Exception as e: +- # Fallback to chromium if Chrome channel fails +- if "chrome" in str(e) and browser_args.get("channel") == "chrome": +- browser_args["channel"] = "chromium" +- if self.use_persistent_context and self.user_data_dir: +- self.browser = await self.playwright.chromium.launch_persistent_context( +- user_data_dir=self.user_data_dir, +- **browser_args +- ) +- self.default_context = self.browser +- else: +- self.browser = await self.playwright.chromium.launch(**browser_args) +- else: +- raise +- +- await self.execute_hook('on_browser_created', self.browser) +- +- async def close(self): +- if self.sleep_on_close: +- await asyncio.sleep(0.5) +- +- # Close all active sessions +- session_ids = list(self.sessions.keys()) +- for session_id in session_ids: +- await self.kill_session(session_id) +- +- if self.browser: +- await self.browser.close() +- self.browser = None +- +- if self.managed_browser: +- await asyncio.sleep(0.5) +- await self.managed_browser.cleanup() +- self.managed_browser = None +- +- if self.playwright: +- await self.playwright.stop() +- self.playwright = None +- +- # Issue #256: Remove __del__ method to avoid potential issues with async cleanup +- # def __del__(self): +- # if self.browser or self.playwright: +- # asyncio.get_event_loop().run_until_complete(self.close()) +- +- def set_hook(self, hook_type: str, hook: Callable): +- if hook_type in self.hooks: +- self.hooks[hook_type] = hook +- else: +- raise ValueError(f"Invalid hook type: {hook_type}") +- +- async def execute_hook(self, hook_type: str, *args, **kwargs): +- hook = self.hooks.get(hook_type) +- if hook: +- if asyncio.iscoroutinefunction(hook): +- return await hook(*args, **kwargs) +- else: +- return hook(*args, **kwargs) +- return args[0] if args else None +- +- def update_user_agent(self, user_agent: str): +- self.user_agent = user_agent +- +- def set_custom_headers(self, headers: Dict[str, str]): +- self.headers = headers +- +- async def kill_session(self, session_id: str): +- if session_id in self.sessions: +- context, page, _ = self.sessions[session_id] +- await page.close() +- if not self.use_managed_browser: +- await context.close() +- del self.sessions[session_id] +- +- def _cleanup_expired_sessions(self): +- current_time = time.time() +- expired_sessions = [ +- sid for sid, (_, _, last_used) in self.sessions.items() +- if current_time - last_used > self.session_ttl +- ] +- for sid in expired_sessions: +- asyncio.create_task(self.kill_session(sid)) +- +- async def smart_wait(self, page: Page, wait_for: str, timeout: float = 30000): +- wait_for = wait_for.strip() +- +- if wait_for.startswith('js:'): +- # Explicitly specified JavaScript +- js_code = wait_for[3:].strip() +- return await self.csp_compliant_wait(page, js_code, timeout) +- elif wait_for.startswith('css:'): +- # Explicitly specified CSS selector +- css_selector = wait_for[4:].strip() +- try: +- await page.wait_for_selector(css_selector, timeout=timeout) +- except Error as e: +- if 'Timeout' in str(e): +- raise TimeoutError(f"Timeout after {timeout}ms waiting for selector '{css_selector}'") +- else: +- raise ValueError(f"Invalid CSS selector: '{css_selector}'") +- else: +- # Auto-detect based on content +- if wait_for.startswith('()') or wait_for.startswith('function'): +- # It's likely a JavaScript function +- return await self.csp_compliant_wait(page, wait_for, timeout) +- else: +- # Assume it's a CSS selector first +- try: +- await page.wait_for_selector(wait_for, timeout=timeout) +- except Error as e: +- if 'Timeout' in str(e): +- raise TimeoutError(f"Timeout after {timeout}ms waiting for selector '{wait_for}'") +- else: +- # If it's not a timeout error, it might be an invalid selector +- # Let's try to evaluate it as a JavaScript function as a fallback +- try: +- return await self.csp_compliant_wait(page, f"() => {{{wait_for}}}", timeout) +- except Error: +- raise ValueError(f"Invalid wait_for parameter: '{wait_for}'. " +- "It should be either a valid CSS selector, a JavaScript function, " +- "or explicitly prefixed with 'js:' or 'css:'.") +- +- async def csp_compliant_wait(self, page: Page, user_wait_function: str, timeout: float = 30000): +- wrapper_js = f""" +- async () => {{ +- const userFunction = {user_wait_function}; +- const startTime = Date.now(); +- while (true) {{ +- if (await userFunction()) {{ +- return true; +- }} +- if (Date.now() - startTime > {timeout}) {{ +- throw new Error('Timeout waiting for condition'); +- }} +- await new Promise(resolve => setTimeout(resolve, 100)); +- }} +- }} +- """ +- +- try: +- await page.evaluate(wrapper_js) +- except TimeoutError: +- raise TimeoutError(f"Timeout after {timeout}ms waiting for condition") +- except Exception as e: +- raise RuntimeError(f"Error in wait condition: {str(e)}") +- +- async def process_iframes(self, page): +- # Find all iframes +- iframes = await page.query_selector_all('iframe') +- +- for i, iframe in enumerate(iframes): +- try: +- # Add a unique identifier to the iframe +- await iframe.evaluate(f'(element) => element.id = "iframe-{i}"') +- +- # Get the frame associated with this iframe +- frame = await iframe.content_frame() +- +- if frame: +- # Wait for the frame to load +- await frame.wait_for_load_state('load', timeout=30000) # 30 seconds timeout +- +- # Extract the content of the iframe's body +- iframe_content = await frame.evaluate('() => document.body.innerHTML') +- +- # Generate a unique class name for this iframe +- class_name = f'extracted-iframe-content-{i}' +- +- # Replace the iframe with a div containing the extracted content +- _iframe = iframe_content.replace('`', '\\`') +- await page.evaluate(f""" +- () => {{ +- const iframe = document.getElementById('iframe-{i}'); +- const div = document.createElement('div'); +- div.innerHTML = `{_iframe}`; +- div.className = '{class_name}'; +- iframe.replaceWith(div); +- }} +- """) +- else: +- # print(f"Warning: Could not access content frame for iframe {i}") +- self.logger.warning( +- message="Could not access content frame for iframe {index}", +- tag="SCRAPE", +- params={"index": i} +- ) +- except Exception as e: +- self.logger.error( +- message="Error processing iframe {index}: {error}", +- tag="ERROR", +- params={"index": i, "error": str(e)} +- ) +- # print(f"Error processing iframe {i}: {str(e)}") +- +- # Return the page object +- return page +- +- async def create_session(self, **kwargs) -> str: +- """Creates a new browser session and returns its ID.""" +- if not self.browser: +- await self.start() +- +- session_id = kwargs.get('session_id') or str(uuid.uuid4()) +- +- if self.use_managed_browser: +- page = await self.default_context.new_page() +- self.sessions[session_id] = (self.default_context, page, time.time()) +- else: +- if self.use_persistent_context and self.browser_type in ["chrome", "chromium"]: +- context = self.browser +- page = await context.new_page() +- else: +- context = await self.browser.new_context( +- user_agent=kwargs.get("user_agent", self.user_agent), +- viewport={"width": self.viewport_width, "height": self.viewport_height}, +- proxy={"server": self.proxy} if self.proxy else None, +- accept_downloads=self.accept_downloads, +- storage_state=self.storage_state, +- ignore_https_errors=True +- ) +- +- if self.cookies: +- await context.add_cookies(self.cookies) +- await context.set_extra_http_headers(self.headers) +- page = await context.new_page() +- +- self.sessions[session_id] = (context, page, time.time()) +- +- return session_id +- +- async def crawl(self, url: str, **kwargs) -> AsyncCrawlResponse: +- """ +- Crawls a given URL or processes raw HTML/local file content based on the URL prefix. +- +- Args: +- url (str): The URL to crawl. Supported prefixes: +- - 'http://' or 'https://': Web URL to crawl. +- - 'file://': Local file path to process. +- - 'raw:': Raw HTML content to process. +- **kwargs: Additional parameters: +- - 'screenshot' (bool): Whether to take a screenshot. +- - ... [other existing parameters] +- +- Returns: +- AsyncCrawlResponse: The response containing HTML, headers, status code, and optional screenshot. +- """ +- response_headers = {} +- status_code = 200 # Default to 200 for local/raw HTML +- screenshot_requested = kwargs.get('screenshot', False) +- screenshot_data = None +- +- if url.startswith(('http://', 'https://')): +- # Proceed with standard web crawling +- return await self._crawl_web(url, **kwargs) +- +- elif url.startswith('file://'): +- # Process local file +- local_file_path = url[7:] # Remove 'file://' prefix +- if not os.path.exists(local_file_path): +- raise FileNotFoundError(f"Local file not found: {local_file_path}") +- with open(local_file_path, 'r', encoding='utf-8') as f: +- html = f.read() +- if screenshot_requested: +- screenshot_data = await self._generate_screenshot_from_html(html) +- return AsyncCrawlResponse( +- html=html, +- response_headers=response_headers, +- status_code=status_code, +- screenshot=screenshot_data, +- get_delayed_content=None +- ) +- +- elif url.startswith('raw:'): +- # Process raw HTML content +- raw_html = url[4:] # Remove 'raw:' prefix +- html = raw_html +- if screenshot_requested: +- screenshot_data = await self._generate_screenshot_from_html(html) +- return AsyncCrawlResponse( +- html=html, +- response_headers=response_headers, +- status_code=status_code, +- screenshot=screenshot_data, +- get_delayed_content=None +- ) +- else: +- raise ValueError("URL must start with 'http://', 'https://', 'file://', or 'raw:'") +- +- +- async def _crawl_web(self, url: str, **kwargs) -> AsyncCrawlResponse: +- """ +- Existing web crawling logic remains unchanged. +- +- Args: +- url (str): The web URL to crawl. +- **kwargs: Additional parameters. +- +- Returns: +- AsyncCrawlResponse: The response containing HTML, headers, status code, and optional screenshot. +- """ +- response_headers = {} +- status_code = None +- +- # Reset downloaded files list for new crawl +- self._downloaded_files = [] +- +- self._cleanup_expired_sessions() +- session_id = kwargs.get("session_id") +- +- # Check if in kwargs we have user_agent that will override the default user_agent +- user_agent = kwargs.get("user_agent", self.user_agent) +- +- # Generate random user agent if magic mode is enabled and user_agent_mode is not random +- if kwargs.get("user_agent_mode") != "random" and kwargs.get("magic", False): +- user_agent = UserAgentGenerator().generate( +- **kwargs.get("user_agent_generator_config", {}) +- ) +- +- # Handle page creation differently for managed browser +- context = None +- if self.use_managed_browser: +- if session_id: +- # Reuse existing session if available +- context, page, _ = self.sessions.get(session_id, (None, None, None)) +- if not page: +- # Create new page in default context if session doesn't exist +- page = await self.default_context.new_page() +- self.sessions[session_id] = (self.default_context, page, time.time()) +- else: +- # Create new page in default context for non-session requests +- page = await self.default_context.new_page() +- else: +- if session_id: +- context, page, _ = self.sessions.get(session_id, (None, None, None)) +- if not context: +- if self.use_persistent_context and self.browser_type in ["chrome", "chromium"]: +- # In persistent context, browser is the context +- context = self.browser +- else: +- # Normal context creation for non-persistent or non-Chrome browsers +- context = await self.browser.new_context( +- user_agent=user_agent, +- viewport={"width": self.viewport_width, "height": self.viewport_height}, +- proxy={"server": self.proxy} if self.proxy else None, +- java_script_enabled=True, +- accept_downloads=self.accept_downloads, +- storage_state=self.storage_state, +- # downloads_path=self.downloads_path if self.accept_downloads else None +- ) +- await context.add_cookies([{"name": "cookiesEnabled", "value": "true", "url": url}]) +- if self.cookies: +- await context.add_cookies(self.cookies) +- await context.set_extra_http_headers(self.headers) +- +- page = await context.new_page() +- self.sessions[session_id] = (context, page, time.time()) +- else: +- if self.use_persistent_context and self.browser_type in ["chrome", "chromium"]: +- # In persistent context, browser is the context +- context = self.browser +- else: +- # Normal context creation +- context = await self.browser.new_context( +- user_agent=user_agent, +- # viewport={"width": 1920, "height": 1080}, +- viewport={"width": self.viewport_width, "height": self.viewport_height}, +- proxy={"server": self.proxy} if self.proxy else None, +- accept_downloads=self.accept_downloads, +- storage_state=self.storage_state, +- ignore_https_errors=True # Add this line +- ) +- if self.cookies: +- await context.add_cookies(self.cookies) +- await context.set_extra_http_headers(self.headers) +- +- if kwargs.get("override_navigator", False) or kwargs.get("simulate_user", False) or kwargs.get("magic", False): +- # Inject scripts to override navigator properties +- await context.add_init_script(""" +- // Pass the Permissions Test. +- const originalQuery = window.navigator.permissions.query; +- window.navigator.permissions.query = (parameters) => ( +- parameters.name === 'notifications' ? +- Promise.resolve({ state: Notification.permission }) : +- originalQuery(parameters) +- ); +- Object.defineProperty(navigator, 'webdriver', { +- get: () => undefined +- }); +- window.navigator.chrome = { +- runtime: {}, +- // Add other properties if necessary +- }; +- Object.defineProperty(navigator, 'plugins', { +- get: () => [1, 2, 3, 4, 5], +- }); +- Object.defineProperty(navigator, 'languages', { +- get: () => ['en-US', 'en'], +- }); +- Object.defineProperty(document, 'hidden', { +- get: () => false +- }); +- Object.defineProperty(document, 'visibilityState', { +- get: () => 'visible' +- }); +- """) +- +- page = await context.new_page() +- if kwargs.get("magic", False): +- await stealth_async(page, stealth_config) +- +- # Add console message and error logging +- if kwargs.get("log_console", False): +- page.on("console", lambda msg: print(f"Console: {msg.text}")) +- page.on("pageerror", lambda exc: print(f"Page Error: {exc}")) +- +- try: +- # Set up download handling if enabled +- if self.accept_downloads: +- page.on("download", lambda download: asyncio.create_task(self._handle_download(download))) +- +- if self.use_cached_html: +- cache_file_path = os.path.join( +- os.getenv("CRAWL4_AI_BASE_DIRECTORY", Path.home()), ".crawl4ai", "cache", hashlib.md5(url.encode()).hexdigest() +- ) +- if os.path.exists(cache_file_path): +- html = "" +- with open(cache_file_path, "r") as f: +- html = f.read() +- # retrieve response headers and status code from cache +- with open(cache_file_path + ".meta", "r") as f: +- meta = json.load(f) +- response_headers = meta.get("response_headers", {}) +- status_code = meta.get("status_code") +- response = AsyncCrawlResponse( +- html=html, response_headers=response_headers, status_code=status_code +- ) +- return response +- +- if not kwargs.get("js_only", False): +- await self.execute_hook('before_goto', page, context = context, **kwargs) +- +- try: +- response = await page.goto( +- url, +- # wait_until=kwargs.get("wait_until", ["domcontentloaded", "networkidle"]), +- wait_until=kwargs.get("wait_until", "domcontentloaded"), +- timeout=kwargs.get("page_timeout", 60000), +- ) +- except Error as e: +- raise RuntimeError(f"Failed on navigating ACS-GOTO :\n{str(e)}") +- +- await self.execute_hook('after_goto', page, context = context, **kwargs) +- +- # Get status code and headers +- status_code = response.status +- response_headers = response.headers +- else: +- status_code = 200 +- response_headers = {} +- +- # Replace the current wait_for_selector line with this more robust check: +- try: +- # First wait for body to exist, regardless of visibility +- await page.wait_for_selector('body', state='attached', timeout=30000) +- +- # Then wait for it to become visible by checking CSS +- await page.wait_for_function(""" +- () => { +- const body = document.body; +- const style = window.getComputedStyle(body); +- return style.display !== 'none' && +- style.visibility !== 'hidden' && +- style.opacity !== '0'; +- } +- """, timeout=30000) +- +- except Error as e: +- # If waiting fails, let's try to diagnose the issue +- visibility_info = await page.evaluate(""" +- () => { +- const body = document.body; +- const style = window.getComputedStyle(body); +- return { +- display: style.display, +- visibility: style.visibility, +- opacity: style.opacity, +- hasContent: body.innerHTML.length, +- classList: Array.from(body.classList) +- } +- } +- """) +- +- if self.verbose: +- print(f"Body visibility debug info: {visibility_info}") +- +- # Even if body is hidden, we might still want to proceed +- if kwargs.get('ignore_body_visibility', True): +- if self.verbose: +- print("Proceeding despite hidden body...") +- pass +- else: +- raise Error(f"Body element is hidden: {visibility_info}") +- +- # CONTENT LOADING ASSURANCE +- if not self.text_only and (kwargs.get("wait_for_images", True) or kwargs.get("adjust_viewport_to_content", False)): +- # Wait for network idle after initial load and images to load +- # await page.wait_for_load_state("networkidle") +- await page.wait_for_load_state("domcontentloaded") +- await asyncio.sleep(0.1) +- from playwright.async_api import TimeoutError as PlaywrightTimeoutError +- try: +- await page.wait_for_function("Array.from(document.images).every(img => img.complete)", timeout=1000) +- # Check for TimeoutError and ignore it +- except PlaywrightTimeoutError: +- pass +- +- # After initial load, adjust viewport to content size +- if not self.text_only and kwargs.get("adjust_viewport_to_content", False): +- try: +- # Get actual page dimensions +- page_width = await page.evaluate("document.documentElement.scrollWidth") +- page_height = await page.evaluate("document.documentElement.scrollHeight") +- +- target_width = self.viewport_width +- target_height = int(target_width * page_width / page_height * 0.95) +- await page.set_viewport_size({"width": target_width, "height": target_height}) +- +- # Compute scale factor +- # We want the entire page visible: the scale should make both width and height fit +- scale = min(target_width / page_width, target_height / page_height) +- +- # Now we call CDP to set metrics. +- # We tell Chrome that the "device" is page_width x page_height in size, +- # but we scale it down so everything fits within the real viewport. +- cdp = await page.context.new_cdp_session(page) +- await cdp.send('Emulation.setDeviceMetricsOverride', { +- 'width': page_width, # full page width +- 'height': page_height, # full page height +- 'deviceScaleFactor': 1, # keep normal DPR +- 'mobile': False, +- 'scale': scale # scale the entire rendered content +- }) +- +- except Exception as e: +- self.logger.warning( +- message="Failed to adjust viewport to content: {error}", +- tag="VIEWPORT", +- params={"error": str(e)} +- ) +- +- # After viewport adjustment, handle page scanning if requested +- if kwargs.get("scan_full_page", False): +- try: +- viewport_height = page.viewport_size.get("height", self.viewport_height) +- current_position = viewport_height # Start with one viewport height +- scroll_delay = kwargs.get("scroll_delay", 0.2) +- +- # Initial scroll +- await page.evaluate(f"window.scrollTo(0, {current_position})") +- await asyncio.sleep(scroll_delay) +- +- # Get height after first scroll to account for any dynamic content +- total_height = await page.evaluate("document.documentElement.scrollHeight") +- +- while current_position < total_height: +- current_position = min(current_position + viewport_height, total_height) +- await page.evaluate(f"window.scrollTo(0, {current_position})") +- await asyncio.sleep(scroll_delay) +- +- # Check for dynamic content +- new_height = await page.evaluate("document.documentElement.scrollHeight") +- if new_height > total_height: +- total_height = new_height +- +- # Scroll back to top +- await page.evaluate("window.scrollTo(0, 0)") +- +- except Exception as e: +- self.logger.warning( +- message="Failed to perform full page scan: {error}", +- tag="PAGE_SCAN", +- params={"error": str(e)} +- ) +- else: +- # Scroll to the bottom of the page +- await page.evaluate("window.scrollTo(0, document.body.scrollHeight)") +- +- js_code = kwargs.get("js_code", kwargs.get("js", self.js_code)) +- if js_code: +- if isinstance(js_code, str): +- await page.evaluate(js_code) +- elif isinstance(js_code, list): +- for js in js_code: +- await page.evaluate(js) +- +- # await page.wait_for_timeout(100) +- +- # Check for on execution event +- await self.execute_hook('on_execution_started', page, context = context, **kwargs) +- +- if kwargs.get("simulate_user", False) or kwargs.get("magic", False): +- # Simulate user interactions +- await page.mouse.move(100, 100) +- await page.mouse.down() +- await page.mouse.up() +- await page.keyboard.press('ArrowDown') +- +- # Handle the wait_for parameter +- wait_for = kwargs.get("wait_for") +- if wait_for: +- try: +- await self.smart_wait(page, wait_for, timeout=kwargs.get("page_timeout", 60000)) +- except Exception as e: +- raise RuntimeError(f"Wait condition failed: {str(e)}") +- +- # if not wait_for and js_code: +- # await page.wait_for_load_state('networkidle', timeout=5000) +- +- # Update image dimensions +- if not self.text_only: +- update_image_dimensions_js = """ +- () => { +- return new Promise((resolve) => { +- const filterImage = (img) => { +- // Filter out images that are too small +- if (img.width < 100 && img.height < 100) return false; +- +- // Filter out images that are not visible +- const rect = img.getBoundingClientRect(); +- if (rect.width === 0 || rect.height === 0) return false; +- +- // Filter out images with certain class names (e.g., icons, thumbnails) +- if (img.classList.contains('icon') || img.classList.contains('thumbnail')) return false; +- +- // Filter out images with certain patterns in their src (e.g., placeholder images) +- if (img.src.includes('placeholder') || img.src.includes('icon')) return false; +- +- return true; +- }; +- +- const images = Array.from(document.querySelectorAll('img')).filter(filterImage); +- let imagesLeft = images.length; +- +- if (imagesLeft === 0) { +- resolve(); +- return; +- } +- +- const checkImage = (img) => { +- if (img.complete && img.naturalWidth !== 0) { +- img.setAttribute('width', img.naturalWidth); +- img.setAttribute('height', img.naturalHeight); +- imagesLeft--; +- if (imagesLeft === 0) resolve(); +- } +- }; +- +- images.forEach(img => { +- checkImage(img); +- if (!img.complete) { +- img.onload = () => { +- checkImage(img); +- }; +- img.onerror = () => { +- imagesLeft--; +- if (imagesLeft === 0) resolve(); +- }; +- } +- }); +- +- // Fallback timeout of 5 seconds +- // setTimeout(() => resolve(), 5000); +- resolve(); +- }); +- } +- """ +- +- try: +- try: +- await page.wait_for_load_state( +- # state="load", +- state="domcontentloaded", +- timeout=5 +- ) +- except PlaywrightTimeoutError: +- pass +- await page.evaluate(update_image_dimensions_js) +- except Exception as e: +- self.logger.error( +- message="Error updating image dimensions ACS-UPDATE_IMAGE_DIMENSIONS_JS: {error}", +- tag="ERROR", +- params={"error": str(e)} +- ) +- # raise RuntimeError(f"Error updating image dimensions ACS-UPDATE_IMAGE_DIMENSIONS_JS: {str(e)}") +- +- # Wait a bit for any onload events to complete +- # await page.wait_for_timeout(100) +- +- # Process iframes +- if kwargs.get("process_iframes", False): +- page = await self.process_iframes(page) +- +- await self.execute_hook('before_retrieve_html', page, context = context, **kwargs) +- # Check if delay_before_return_html is set then wait for that time +- delay_before_return_html = kwargs.get("delay_before_return_html", 0.1) +- if delay_before_return_html: +- await asyncio.sleep(delay_before_return_html) +- +- # Check for remove_overlay_elements parameter +- if kwargs.get("remove_overlay_elements", False): +- await self.remove_overlay_elements(page) +- +- html = await page.content() +- await self.execute_hook('before_return_html', page, html, context = context, **kwargs) +- +- # Check if kwargs has screenshot=True then take screenshot +- screenshot_data = None +- if kwargs.get("screenshot"): +- # Check we have screenshot_wait_for parameter, if we have simply wait for that time +- screenshot_wait_for = kwargs.get("screenshot_wait_for") +- if screenshot_wait_for: +- await asyncio.sleep(screenshot_wait_for) +- screenshot_data = await self.take_screenshot(page) +- +- # if self.verbose: +- # print(f"[LOG] โœ… Crawled {url} successfully!") +- +- if self.use_cached_html: +- cache_file_path = os.path.join( +- os.getenv("CRAWL4_AI_BASE_DIRECTORY", Path.home()), ".crawl4ai", "cache", hashlib.md5(url.encode()).hexdigest() +- ) +- with open(cache_file_path, "w", encoding="utf-8") as f: +- f.write(html) +- # store response headers and status code in cache +- with open(cache_file_path + ".meta", "w", encoding="utf-8") as f: +- json.dump({ +- "response_headers": response_headers, +- "status_code": status_code +- }, f) +- +- async def get_delayed_content(delay: float = 5.0) -> str: +- if self.verbose: +- print(f"[LOG] Waiting for {delay} seconds before retrieving content for {url}") +- await asyncio.sleep(delay) +- return await page.content() +- +- response = AsyncCrawlResponse( +- html=html, +- response_headers=response_headers, +- status_code=status_code, +- screenshot=screenshot_data, +- get_delayed_content=get_delayed_content, +- downloaded_files=self._downloaded_files if self._downloaded_files else None +- ) +- return response +- except Error as e: +- raise Error(f"async_crawler_strategy.py:_crawleb(): {str(e)}") +- # finally: +- # if not session_id: +- # await page.close() +- # await context.close() +- +- async def _handle_download(self, download): +- """Handle file downloads.""" +- try: +- suggested_filename = download.suggested_filename +- download_path = os.path.join(self.downloads_path, suggested_filename) +- +- self.logger.info( +- message="Downloading {filename} to {path}", +- tag="FETCH", +- params={"filename": suggested_filename, "path": download_path} +- ) +- +- start_time = time.perf_counter() +- await download.save_as(download_path) +- end_time = time.perf_counter() +- self._downloaded_files.append(download_path) +- +- self.logger.success( +- message="Downloaded {filename} successfully", +- tag="COMPLETE", +- params={"filename": suggested_filename, "path": download_path, "duration": f"{end_time - start_time:.2f}s"} +- ) +- except Exception as e: +- self.logger.error( +- message="Failed to handle download: {error}", +- tag="ERROR", +- params={"error": str(e)} +- ) +- +- # if self.verbose: +- # print(f"[ERROR] Failed to handle download: {str(e)}") +- +- async def crawl_many(self, urls: List[str], **kwargs) -> List[AsyncCrawlResponse]: +- semaphore_count = kwargs.get('semaphore_count', 5) # Adjust as needed +- semaphore = asyncio.Semaphore(semaphore_count) +- +- async def crawl_with_semaphore(url): +- async with semaphore: +- return await self.crawl(url, **kwargs) +- +- tasks = [crawl_with_semaphore(url) for url in urls] +- results = await asyncio.gather(*tasks, return_exceptions=True) +- return [result if not isinstance(result, Exception) else str(result) for result in results] +- +- async def remove_overlay_elements(self, page: Page) -> None: +- """ +- Removes popup overlays, modals, cookie notices, and other intrusive elements from the page. +- +- Args: +- page (Page): The Playwright page instance +- """ +- remove_overlays_js = """ +- async () => { +- // Function to check if element is visible +- const isVisible = (elem) => { +- const style = window.getComputedStyle(elem); +- return style.display !== 'none' && +- style.visibility !== 'hidden' && +- style.opacity !== '0'; +- }; +- +- // Common selectors for popups and overlays +- const commonSelectors = [ +- // Close buttons first +- 'button[class*="close" i]', 'button[class*="dismiss" i]', +- 'button[aria-label*="close" i]', 'button[title*="close" i]', +- 'a[class*="close" i]', 'span[class*="close" i]', +- +- // Cookie notices +- '[class*="cookie-banner" i]', '[id*="cookie-banner" i]', +- '[class*="cookie-consent" i]', '[id*="cookie-consent" i]', +- +- // Newsletter/subscription dialogs +- '[class*="newsletter" i]', '[class*="subscribe" i]', +- +- // Generic popups/modals +- '[class*="popup" i]', '[class*="modal" i]', +- '[class*="overlay" i]', '[class*="dialog" i]', +- '[role="dialog"]', '[role="alertdialog"]' +- ]; +- +- // Try to click close buttons first +- for (const selector of commonSelectors.slice(0, 6)) { +- const closeButtons = document.querySelectorAll(selector); +- for (const button of closeButtons) { +- if (isVisible(button)) { +- try { +- button.click(); +- await new Promise(resolve => setTimeout(resolve, 100)); +- } catch (e) { +- console.log('Error clicking button:', e); +- } +- } +- } +- } +- +- // Remove remaining overlay elements +- const removeOverlays = () => { +- // Find elements with high z-index +- const allElements = document.querySelectorAll('*'); +- for (const elem of allElements) { +- const style = window.getComputedStyle(elem); +- const zIndex = parseInt(style.zIndex); +- const position = style.position; +- +- if ( +- isVisible(elem) && +- (zIndex > 999 || position === 'fixed' || position === 'absolute') && +- ( +- elem.offsetWidth > window.innerWidth * 0.5 || +- elem.offsetHeight > window.innerHeight * 0.5 || +- style.backgroundColor.includes('rgba') || +- parseFloat(style.opacity) < 1 +- ) +- ) { +- elem.remove(); +- } +- } +- +- // Remove elements matching common selectors +- for (const selector of commonSelectors) { +- const elements = document.querySelectorAll(selector); +- elements.forEach(elem => { +- if (isVisible(elem)) { +- elem.remove(); +- } +- }); +- } +- }; +- +- // Remove overlay elements +- removeOverlays(); +- +- // Remove any fixed/sticky position elements at the top/bottom +- const removeFixedElements = () => { +- const elements = document.querySelectorAll('*'); +- elements.forEach(elem => { +- const style = window.getComputedStyle(elem); +- if ( +- (style.position === 'fixed' || style.position === 'sticky') && +- isVisible(elem) +- ) { +- elem.remove(); +- } +- }); +- }; +- +- removeFixedElements(); +- +- // Remove empty block elements as: div, p, span, etc. +- const removeEmptyBlockElements = () => { +- const blockElements = document.querySelectorAll('div, p, span, section, article, header, footer, aside, nav, main, ul, ol, li, dl, dt, dd, h1, h2, h3, h4, h5, h6'); +- blockElements.forEach(elem => { +- if (elem.innerText.trim() === '') { +- elem.remove(); +- } +- }); +- }; +- +- // Remove margin-right and padding-right from body (often added by modal scripts) +- document.body.style.marginRight = '0px'; +- document.body.style.paddingRight = '0px'; +- document.body.style.overflow = 'auto'; +- +- // Wait a bit for any animations to complete +- await new Promise(resolve => setTimeout(resolve, 100)); +- } +- """ +- +- try: +- await page.evaluate(remove_overlays_js) +- await page.wait_for_timeout(500) # Wait for any animations to complete +- except Exception as e: +- self.logger.warning( +- message="Failed to remove overlay elements: {error}", +- tag="SCRAPE", +- params={"error": str(e)} +- ) +- # if self.verbose: +- # print(f"Warning: Failed to remove overlay elements: {str(e)}") +- +- async def take_screenshot(self, page: Page) -> str: +- """ +- Takes a screenshot of the current page. +- +- Args: +- page (Page): The Playwright page instance +- +- Returns: +- str: Base64-encoded screenshot image +- """ +- try: +- # The page is already loaded, just take the screenshot +- screenshot = await page.screenshot(full_page=True) +- return base64.b64encode(screenshot).decode('utf-8') +- except Exception as e: +- error_message = f"Failed to take screenshot: {str(e)}" +- self.logger.error( +- message="Screenshot failed: {error}", +- tag="ERROR", +- params={"error": error_message} +- ) +- +- +- # Generate an error image +- img = Image.new('RGB', (800, 600), color='black') +- draw = ImageDraw.Draw(img) +- font = ImageFont.load_default() +- draw.text((10, 10), error_message, fill=(255, 255, 255), font=font) +- +- buffered = BytesIO() +- img.save(buffered, format="JPEG") +- return base64.b64encode(buffered.getvalue()).decode('utf-8') +- finally: +- await page.close() +- +- async def export_storage_state(self, path: str = None) -> dict: +- """ +- Exports the current storage state (cookies, localStorage, sessionStorage) +- to a JSON file at the specified path. +- """ +- if self.default_context: +- state = await self.default_context.storage_state(path=path) +- self.logger.info( +- message="Exported storage state to {path}", +- tag="INFO", +- params={"path": path} +- ) +- return state +- else: +- self.logger.warning( +- message="No default_context available to export storage state.", +- tag="WARNING" +- ) +- +- async def _generate_screenshot_from_html(self, html: str) -> Optional[str]: +- """ +- Generates a screenshot from raw HTML content. +- +- Args: +- html (str): The HTML content to render and capture. +- +- Returns: +- Optional[str]: Base64-encoded screenshot image or an error image if failed. +- """ +- try: +- if not self.browser: +- await self.start() +- page = await self.browser.new_page() +- await page.set_content(html, wait_until='networkidle') +- screenshot = await page.screenshot(full_page=True) +- await page.close() +- return base64.b64encode(screenshot).decode('utf-8') +- except Exception as e: +- error_message = f"Failed to take screenshot: {str(e)}" +- # print(error_message) +- self.logger.error( +- message="Screenshot failed: {error}", +- tag="ERROR", +- params={"error": error_message} +- ) +- +- # Generate an error image +- img = Image.new('RGB', (800, 600), color='black') +- draw = ImageDraw.Draw(img) +- font = ImageFont.load_default() +- draw.text((10, 10), error_message, fill=(255, 255, 255), font=font) +- +- buffered = BytesIO() +- img.save(buffered, format="JPEG") +- return base64.b64encode(buffered.getvalue()).decode('utf-8') +- +diff --git a/crawl4ai/async_crawler_strategy.py b/crawl4ai/async_crawler_strategy.py +index 553e9df..3f040e1 100644 +--- a/crawl4ai/async_crawler_strategy.py ++++ b/crawl4ai/async_crawler_strategy.py +@@ -17,9 +17,10 @@ import json + import uuid + from .js_snippet import load_js_script + from .models import AsyncCrawlResponse +-from .utils import create_box_message ++from .utils import get_error_context + from .user_agent_generator import UserAgentGenerator +-from .config import SCREENSHOT_HEIGHT_TRESHOLD ++from .config import SCREENSHOT_HEIGHT_TRESHOLD, DOWNLOAD_PAGE_TIMEOUT ++from .async_configs import BrowserConfig, CrawlerRunConfig + from playwright_stealth import StealthConfig, stealth_async + + +@@ -64,7 +65,6 @@ BROWSER_DISABLE_OPTIONS = [ + "--use-mock-keychain" + ] + +- + class ManagedBrowser: + def __init__(self, browser_type: str = "chromium", user_data_dir: Optional[str] = None, headless: bool = False, logger = None, host: str = "localhost", debugging_port: int = 9222): + self.browser_type = browser_type +@@ -225,50 +225,44 @@ class ManagedBrowser: + params={"error": str(e)} + ) + +- + class BrowserManager: +- def __init__(self, use_managed_browser: bool, user_data_dir: Optional[str], headless: bool, logger, browser_type: str, proxy, proxy_config, chrome_channel: str, viewport_width: int, viewport_height: int, accept_downloads: bool, storage_state, ignore_https_errors: bool, java_script_enabled: bool, cookies: List[dict], headers: dict, extra_args: List[str], text_only: bool, light_mode: bool, user_agent: str, browser_hint: str, downloads_path: Optional[str]): +- self.use_managed_browser = use_managed_browser +- self.user_data_dir = user_data_dir +- self.headless = headless ++ def __init__(self, browser_config: BrowserConfig, logger=None): ++ """ ++ Initialize the BrowserManager with a browser configuration. ++ ++ Args: ++ browser_config (BrowserConfig): Configuration object containing all browser settings ++ logger: Logger instance for recording events and errors ++ """ ++ self.config = browser_config + self.logger = logger +- self.browser_type = browser_type +- self.proxy = proxy +- self.proxy_config = proxy_config +- self.chrome_channel = chrome_channel +- self.viewport_width = viewport_width +- self.viewport_height = viewport_height +- self.accept_downloads = accept_downloads +- self.storage_state = storage_state +- self.ignore_https_errors = ignore_https_errors +- self.java_script_enabled = java_script_enabled +- self.cookies = cookies or [] +- self.headers = headers or {} +- self.extra_args = extra_args or [] +- self.text_only = text_only +- self.light_mode = light_mode ++ ++ # Browser state + self.browser = None +- self.default_context : BrowserContext = None ++ self.default_context = None + self.managed_browser = None +- self.sessions = {} +- self.session_ttl = 1800 + self.playwright = None +- self.user_agent = user_agent +- self.browser_hint = browser_hint +- self.downloads_path = downloads_path ++ ++ # Session management ++ self.sessions = {} ++ self.session_ttl = 1800 # 30 minutes ++ ++ # Initialize ManagedBrowser if needed ++ if self.config.use_managed_browser: ++ self.managed_browser = ManagedBrowser( ++ browser_type=self.config.browser_type, ++ user_data_dir=self.config.user_data_dir, ++ headless=self.config.headless, ++ logger=self.logger ++ ) + + async def start(self): ++ """Start the browser instance and set up the default context.""" + if self.playwright is None: + from playwright.async_api import async_playwright + self.playwright = await async_playwright().start() + +- if self.use_managed_browser: +- self.managed_browser = ManagedBrowser( +- browser_type=self.browser_type, +- user_data_dir=self.user_data_dir, +- headless=self.headless, +- logger=self.logger +- ) ++ if self.config.use_managed_browser: + cdp_url = await self.managed_browser.start() + self.browser = await self.playwright.chromium.connect_over_cdp(cdp_url) + contexts = self.browser.contexts +@@ -276,142 +270,126 @@ class BrowserManager: + self.default_context = contexts[0] + else: + self.default_context = await self.browser.new_context( +- viewport={"width": self.viewport_width, "height": self.viewport_height}, +- storage_state=self.storage_state, +- user_agent=self.headers.get("User-Agent"), +- accept_downloads=self.accept_downloads, +- ignore_https_errors=self.ignore_https_errors, +- java_script_enabled=self.java_script_enabled ++ viewport={"width": self.config.viewport_width, "height": self.config.viewport_height}, ++ storage_state=self.config.storage_state, ++ user_agent=self.config.headers.get("User-Agent", self.config.user_agent), ++ accept_downloads=self.config.accept_downloads, ++ ignore_https_errors=self.config.ignore_https_errors, ++ java_script_enabled=self.config.java_script_enabled + ) + await self.setup_context(self.default_context) + else: +- browser_args = { +- "headless": self.headless, +- "args": [ +- "--no-sandbox", +- "--disable-dev-shm-usage", +- "--no-first-run", +- "--no-default-browser-check", +- "--disable-infobars", +- "--window-position=0,0", +- "--ignore-certificate-errors", +- "--ignore-certificate-errors-spki-list", +- "--disable-blink-features=AutomationControlled", +- "--window-position=400,0", +- f"--window-size={self.viewport_width},{self.viewport_height}", +- ] +- } +- +- if self.light_mode: +- browser_args["args"].extend(BROWSER_DISABLE_OPTIONS) ++ browser_args = self._build_browser_args() ++ ++ # Launch appropriate browser type ++ if self.config.browser_type == "firefox": ++ self.browser = await self.playwright.firefox.launch(**browser_args) ++ elif self.config.browser_type == "webkit": ++ self.browser = await self.playwright.webkit.launch(**browser_args) ++ else: ++ self.browser = await self.playwright.chromium.launch(**browser_args) + +- if self.text_only: +- browser_args["args"].extend(['--blink-settings=imagesEnabled=false','--disable-remote-fonts']) ++ self.default_context = self.browser + +- if self.chrome_channel: +- browser_args["channel"] = self.chrome_channel ++ def _build_browser_args(self) -> dict: ++ """Build browser launch arguments from config.""" ++ args = [ ++ "--no-sandbox", ++ "--disable-dev-shm-usage", ++ "--no-first-run", ++ "--no-default-browser-check", ++ "--disable-infobars", ++ "--window-position=0,0", ++ "--ignore-certificate-errors", ++ "--ignore-certificate-errors-spki-list", ++ "--disable-blink-features=AutomationControlled", ++ "--window-position=400,0", ++ f"--window-size={self.config.viewport_width},{self.config.viewport_height}", ++ ] + +- if self.extra_args: +- browser_args["args"].extend(self.extra_args) ++ if self.config.light_mode: ++ args.extend(BROWSER_DISABLE_OPTIONS) + +- if self.accept_downloads: +- browser_args["downloads_path"] = os.path.join(os.getcwd(), "downloads") +- os.makedirs(browser_args["downloads_path"], exist_ok=True) ++ if self.config.text_only: ++ args.extend(['--blink-settings=imagesEnabled=false', '--disable-remote-fonts']) + +- if self.proxy: +- from playwright.async_api import ProxySettings +- proxy_settings = ProxySettings(server=self.proxy) +- browser_args["proxy"] = proxy_settings +- elif self.proxy_config: +- from playwright.async_api import ProxySettings +- proxy_settings = ProxySettings( +- server=self.proxy_config.get("server"), +- username=self.proxy_config.get("username"), +- password=self.proxy_config.get("password") +- ) +- browser_args["proxy"] = proxy_settings ++ if self.config.extra_args: ++ args.extend(self.config.extra_args) + +- if self.browser_type == "firefox": +- self.browser = await self.playwright.firefox.launch(**browser_args) +- elif self.browser_type == "webkit": +- self.browser = await self.playwright.webkit.launch(**browser_args) +- else: +- self.browser = await self.playwright.chromium.launch(**browser_args) ++ browser_args = { ++ "headless": self.config.headless, ++ "args": args ++ } + +- self.default_context = self.browser +- # Since default_context in non-managed mode is the browser, no setup needed here. ++ if self.config.chrome_channel: ++ browser_args["channel"] = self.config.chrome_channel ++ ++ if self.config.accept_downloads: ++ browser_args["downloads_path"] = (self.config.downloads_path or ++ os.path.join(os.getcwd(), "downloads")) ++ os.makedirs(browser_args["downloads_path"], exist_ok=True) ++ ++ if self.config.proxy or self.config.proxy_config: ++ from playwright.async_api import ProxySettings ++ proxy_settings = ( ++ ProxySettings(server=self.config.proxy) if self.config.proxy else ++ ProxySettings( ++ server=self.config.proxy_config.get("server"), ++ username=self.config.proxy_config.get("username"), ++ password=self.config.proxy_config.get("password") ++ ) ++ ) ++ browser_args["proxy"] = proxy_settings + ++ return browser_args + +- async def setup_context(self, context : BrowserContext, is_default=False): +- # Set extra headers +- if self.headers: +- await context.set_extra_http_headers(self.headers) ++ async def setup_context(self, context: BrowserContext, is_default=False): ++ """Set up a browser context with the configured options.""" ++ if self.config.headers: ++ await context.set_extra_http_headers(self.config.headers) + +- # Add cookies if any +- if self.cookies: +- await context.add_cookies(self.cookies) ++ if self.config.cookies: ++ await context.add_cookies(self.config.cookies) + +- # Ensure storage_state if provided +- if self.storage_state: +- # If storage_state is a dictionary or file path, Playwright will handle it. ++ if self.config.storage_state: + await context.storage_state(path=None) + +- # If accept_downloads, set timeouts and ensure properties +- if self.accept_downloads: +- await context.set_default_timeout(60000) +- await context.set_default_navigation_timeout(60000) +- if self.downloads_path: ++ if self.config.accept_downloads: ++ context.set_default_timeout(DOWNLOAD_PAGE_TIMEOUT) ++ context.set_default_navigation_timeout(DOWNLOAD_PAGE_TIMEOUT) ++ if self.config.downloads_path: + context._impl_obj._options["accept_downloads"] = True +- context._impl_obj._options["downloads_path"] = self.downloads_path ++ context._impl_obj._options["downloads_path"] = self.config.downloads_path + +- # If we have a user_agent, override it along with sec-ch-ua +- if self.user_agent: +- # Merge headers if needed +- combined_headers = {"User-Agent": self.user_agent, "sec-ch-ua": self.browser_hint} +- combined_headers.update(self.headers) ++ # Handle user agent and browser hints ++ if self.config.user_agent: ++ combined_headers = { ++ "User-Agent": self.config.user_agent, ++ "sec-ch-ua": self.config.browser_hint ++ } ++ combined_headers.update(self.config.headers) + await context.set_extra_http_headers(combined_headers) +- +- async def close(self): +- # Close all active sessions +- session_ids = list(self.sessions.keys()) +- for session_id in session_ids: +- await self.kill_session(session_id) +- +- if self.browser: +- await self.browser.close() +- self.browser = None +- +- if self.managed_browser: +- await asyncio.sleep(0.5) +- await self.managed_browser.cleanup() +- self.managed_browser = None +- +- if self.playwright: +- await self.playwright.stop() +- self.playwright = None + + async def get_page(self, session_id: Optional[str], user_agent: str): +- # Cleanup expired sessions ++ """Get a page for the given session ID, creating a new one if needed.""" + self._cleanup_expired_sessions() + +- if session_id: +- context, page, _ = self.sessions.get(session_id, (None, None, None)) +- if context and page: +- self.sessions[session_id] = (context, page, time.time()) +- return page, context ++ if session_id and session_id in self.sessions: ++ context, page, _ = self.sessions[session_id] ++ self.sessions[session_id] = (context, page, time.time()) ++ return page, context + +- # Create a new context/page pair +- if self.use_managed_browser: ++ if self.config.use_managed_browser: + context = self.default_context + page = await context.new_page() + else: + context = await self.browser.new_context( + user_agent=user_agent, +- viewport={"width": self.viewport_width, "height": self.viewport_height}, +- proxy={"server": self.proxy} if self.proxy else None, +- accept_downloads=self.accept_downloads, +- storage_state=self.storage_state, +- ignore_https_errors=self.ignore_https_errors ++ viewport={"width": self.config.viewport_width, "height": self.config.viewport_height}, ++ proxy={"server": self.config.proxy} if self.config.proxy else None, ++ accept_downloads=self.config.accept_downloads, ++ storage_state=self.config.storage_state, ++ ignore_https_errors=self.config.ignore_https_errors + ) + await self.setup_context(context) + page = await context.new_page() +@@ -422,14 +400,16 @@ class BrowserManager: + return page, context + + async def kill_session(self, session_id: str): ++ """Kill a browser session and clean up resources.""" + if session_id in self.sessions: + context, page, _ = self.sessions[session_id] + await page.close() +- if not self.use_managed_browser: ++ if not self.config.use_managed_browser: + await context.close() + del self.sessions[session_id] + + def _cleanup_expired_sessions(self): ++ """Clean up expired sessions based on TTL.""" + current_time = time.time() + expired_sessions = [ + sid for sid, (_, _, last_used) in self.sessions.items() +@@ -438,6 +418,28 @@ class BrowserManager: + for sid in expired_sessions: + asyncio.create_task(self.kill_session(sid)) + ++ async def close(self): ++ """Close all browser resources and clean up.""" ++ if self.config.sleep_on_close: ++ await asyncio.sleep(0.5) ++ ++ session_ids = list(self.sessions.keys()) ++ for session_id in session_ids: ++ await self.kill_session(session_id) ++ ++ if self.browser: ++ await self.browser.close() ++ self.browser = None ++ ++ if self.managed_browser: ++ await asyncio.sleep(0.5) ++ await self.managed_browser.cleanup() ++ self.managed_browser = None ++ ++ if self.playwright: ++ await self.playwright.stop() ++ self.playwright = None ++ + class AsyncCrawlerStrategy(ABC): + @abstractmethod + async def crawl(self, url: str, **kwargs) -> AsyncCrawlResponse: +@@ -460,60 +462,24 @@ class AsyncCrawlerStrategy(ABC): + pass + + class AsyncPlaywrightCrawlerStrategy(AsyncCrawlerStrategy): +- def __init__(self, use_cached_html=False, js_code=None, logger = None, **kwargs): +- self.text_only = kwargs.get("text_only", False) +- self.light_mode = kwargs.get("light_mode", False) ++ def __init__(self, browser_config: BrowserConfig = None, logger = None, **kwargs): ++ """ ++ Initialize the AsyncPlaywrightCrawlerStrategy with a browser configuration. ++ ++ Args: ++ browser_config (BrowserConfig): Configuration object containing browser settings. ++ If None, will be created from kwargs for backwards compatibility. ++ logger: Logger instance for recording events and errors. ++ **kwargs: Additional arguments for backwards compatibility and extending functionality. ++ """ ++ # Initialize browser config, either from provided object or kwargs ++ self.browser_config = browser_config or BrowserConfig.from_kwargs(kwargs) + self.logger = logger +- self.use_cached_html = use_cached_html +- self.viewport_width = kwargs.get("viewport_width", 800 if self.text_only else 1920) +- self.viewport_height = kwargs.get("viewport_height", 600 if self.text_only else 1080) + +- if self.text_only: +- self.extra_args = kwargs.get("extra_args", []) + [ +- '--disable-images', +- '--disable-javascript', +- '--disable-gpu', +- '--disable-software-rasterizer', +- '--disable-dev-shm-usage' +- ] +- +- self.user_agent = kwargs.get( +- "user_agent", +- "Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:109.0) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/116.0.5845.187 Safari/604.1 Edg/117.0.2045.47" +- # "Mozilla/5.0 (Linux; Android 11; SM-G973F) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.120 Mobile Safari/537.36" +- ) +- user_agenr_generator = UserAgentGenerator() +- if kwargs.get("user_agent_mode") == "random": +- self.user_agent = user_agenr_generator.generate( +- **kwargs.get("user_agent_generator_config", {}) +- ) +- self.pdf = kwargs.get("pdf", False) # New flag +- self.screenshot_requested = kwargs.get('screenshot', False) ++ # Initialize session management ++ self._downloaded_files = [] + +- self.proxy = kwargs.get("proxy") +- self.proxy_config = kwargs.get("proxy_config") +- self.headless = kwargs.get("headless", True) +- self.browser_type = kwargs.get("browser_type", "chromium") +- self.headers = kwargs.get("headers", {}) +- self.browser_hint = user_agenr_generator.generate_client_hints(self.user_agent) +- self.headers.setdefault("sec-ch-ua", self.browser_hint) +- self.cookies = kwargs.get("cookies", []) +- self.storage_state = kwargs.get("storage_state", None) +- self.sessions = {} +- self.session_ttl = 1800 +- self.js_code = js_code +- self.verbose = kwargs.get("verbose", False) +- self.playwright = None +- self.browser = None +- self.sleep_on_close = kwargs.get("sleep_on_close", False) +- self.use_managed_browser = kwargs.get("use_managed_browser", False) +- self.user_data_dir = kwargs.get("user_data_dir", None) +- self.use_persistent_context = kwargs.get("use_persistent_context", False) +- if self.use_persistent_context: +- self.use_managed_browser = True +- self.chrome_channel = kwargs.get("chrome_channel", "chrome") +- self.managed_browser = None +- self.default_context = None ++ # Initialize hooks system + self.hooks = { + 'on_browser_created': None, + 'on_user_agent_updated': None, +@@ -523,40 +489,12 @@ class AsyncPlaywrightCrawlerStrategy(AsyncCrawlerStrategy): + 'before_return_html': None, + 'before_retrieve_html': None + } +- self.extra_args = kwargs.get("extra_args", []) +- self.ignore_https_errors = kwargs.get("ignore_https_errors", True) +- self.java_script_enabled = kwargs.get("java_script_enabled", True) +- self.accept_downloads = kwargs.get("accept_downloads", False) +- self.downloads_path = kwargs.get("downloads_path") +- self._downloaded_files = [] # Track downloaded files for current crawl +- if self.accept_downloads and not self.downloads_path: +- self.downloads_path = os.path.join(os.getcwd(), "downloads") +- os.makedirs(self.downloads_path, exist_ok=True) +- ++ ++ # Initialize browser manager with config + self.browser_manager = BrowserManager( +- use_managed_browser=self.use_managed_browser, +- user_data_dir=self.user_data_dir, +- headless=self.headless, +- logger=self.logger, +- browser_type=self.browser_type, +- proxy=self.proxy, +- proxy_config=self.proxy_config, +- chrome_channel=self.chrome_channel, +- viewport_width=self.viewport_width, +- viewport_height=self.viewport_height, +- accept_downloads=self.accept_downloads, +- storage_state=self.storage_state, +- ignore_https_errors=self.ignore_https_errors, +- java_script_enabled=self.java_script_enabled, +- cookies=self.cookies, +- headers=self.headers, +- extra_args=self.extra_args, +- text_only=self.text_only, +- light_mode=self.light_mode, +- user_agent=self.user_agent, +- browser_hint=self.browser_hint, +- downloads_path=self.downloads_path +- ) ++ browser_config=self.browser_config, ++ logger=self.logger ++ ) + + async def __aenter__(self): + await self.start() +@@ -570,15 +508,15 @@ class AsyncPlaywrightCrawlerStrategy(AsyncCrawlerStrategy): + await self.execute_hook('on_browser_created', self.browser_manager.browser, context = self.browser_manager.default_context) + + async def close(self): +- if self.sleep_on_close: +- await asyncio.sleep(0.5) +- + await self.browser_manager.close() +- +- # Issue #256: Remove __del__ method to avoid potential issues with async cleanup +- # def __del__(self): +- # if self.browser or self.playwright: +- # asyncio.get_event_loop().run_until_complete(self.close()) ++ ++ async def kill_session(self, session_id: str): ++ # Log a warning message and no need kill session, in new version auto kill session ++ self.logger.warning( ++ message="Session auto-kill is enabled in the new version. No need to manually kill sessions.", ++ tag="WARNING" ++ ) ++ await self.browser_manager.kill_session(session_id) + + def set_hook(self, hook_type: str, hook: Callable): + if hook_type in self.hooks: +@@ -600,23 +538,6 @@ class AsyncPlaywrightCrawlerStrategy(AsyncCrawlerStrategy): + + def set_custom_headers(self, headers: Dict[str, str]): + self.headers = headers +- +- async def kill_session(self, session_id: str): +- if session_id in self.sessions: +- context, page, _ = self.sessions[session_id] +- await page.close() +- if not self.use_managed_browser: +- await context.close() +- del self.sessions[session_id] +- +- def _cleanup_expired_sessions(self): +- current_time = time.time() +- expired_sessions = [ +- sid for sid, (_, _, last_used) in self.sessions.items() +- if current_time - last_used > self.session_ttl +- ] +- for sid in expired_sessions: +- asyncio.create_task(self.kill_session(sid)) + + async def smart_wait(self, page: Page, wait_for: str, timeout: float = 30000): + wait_for = wait_for.strip() +@@ -715,7 +636,6 @@ class AsyncPlaywrightCrawlerStrategy(AsyncCrawlerStrategy): + }} + """) + else: +- # print(f"Warning: Could not access content frame for iframe {i}") + self.logger.warning( + message="Could not access content frame for iframe {index}", + tag="SCRAPE", +@@ -727,7 +647,6 @@ class AsyncPlaywrightCrawlerStrategy(AsyncCrawlerStrategy): + tag="ERROR", + params={"index": i, "error": str(e)} + ) +- # print(f"Error processing iframe {i}: {str(e)}") + + # Return the page object + return page +@@ -743,7 +662,7 @@ class AsyncPlaywrightCrawlerStrategy(AsyncCrawlerStrategy): + page, context = await self.browser_manager.get_page(session_id, user_agent) + return session_id + +- async def crawl(self, url: str, **kwargs) -> AsyncCrawlResponse: ++ async def crawl(self, url: str, config: CrawlerRunConfig, **kwargs) -> AsyncCrawlResponse: + """ + Crawls a given URL or processes raw HTML/local file content based on the URL prefix. + +@@ -759,15 +678,13 @@ class AsyncPlaywrightCrawlerStrategy(AsyncCrawlerStrategy): + Returns: + AsyncCrawlResponse: The response containing HTML, headers, status code, and optional screenshot. + """ ++ config = config or CrawlerRunConfig.from_kwargs(kwargs) + response_headers = {} +- status_code = 200 # Default to 200 for local/raw HTML +- screenshot_requested = kwargs.get("screenshot", self.screenshot_requested) +- pdf_requested = kwargs.get("pdf", self.pdf) ++ status_code = 200 # Default for local/raw HTML + screenshot_data = None + + if url.startswith(('http://', 'https://')): +- # Proceed with standard web crawling +- return await self._crawl_web(url, **kwargs) ++ return await self._crawl_web(url, config) + + elif url.startswith('file://'): + # Process local file +@@ -776,7 +693,7 @@ class AsyncPlaywrightCrawlerStrategy(AsyncCrawlerStrategy): + raise FileNotFoundError(f"Local file not found: {local_file_path}") + with open(local_file_path, 'r', encoding='utf-8') as f: + html = f.read() +- if screenshot_requested: ++ if config.screenshot: + screenshot_data = await self._generate_screenshot_from_html(html) + return AsyncCrawlResponse( + html=html, +@@ -790,7 +707,7 @@ class AsyncPlaywrightCrawlerStrategy(AsyncCrawlerStrategy): + # Process raw HTML content + raw_html = url[4:] # Remove 'raw:' prefix + html = raw_html +- if screenshot_requested: ++ if config.screenshot: + screenshot_data = await self._generate_screenshot_from_html(html) + return AsyncCrawlResponse( + html=html, +@@ -802,92 +719,85 @@ class AsyncPlaywrightCrawlerStrategy(AsyncCrawlerStrategy): + else: + raise ValueError("URL must start with 'http://', 'https://', 'file://', or 'raw:'") + +- async def _crawl_web(self, url: str, **kwargs) -> AsyncCrawlResponse: ++ async def _crawl_web(self, url: str, config: CrawlerRunConfig) -> AsyncCrawlResponse: ++ """ ++ Internal method to crawl web URLs with the specified configuration. ++ ++ Args: ++ url (str): The web URL to crawl ++ config (CrawlerRunConfig): Configuration object controlling the crawl behavior ++ ++ Returns: ++ AsyncCrawlResponse: The response containing HTML, headers, status code, and optional data ++ """ + response_headers = {} + status_code = None + +- screenshot_requested = kwargs.get("screenshot", self.screenshot_requested) +- pdf_requested = kwargs.get("pdf", self.pdf) +- + # Reset downloaded files list for new crawl + self._downloaded_files = [] + +- self._cleanup_expired_sessions() +- session_id = kwargs.get("session_id") +- +- # Check if in kwargs we have user_agent that will override the default user_agent +- user_agent = kwargs.get("user_agent", self.user_agent) +- +- # Generate random user agent if magic mode is enabled and user_agent_mode is not random +- if kwargs.get("user_agent_mode") != "random" and kwargs.get("magic", False): ++ # Handle user agent with magic mode ++ user_agent = self.browser_config.user_agent ++ if config.magic and self.browser_config.user_agent_mode != "random": + user_agent = UserAgentGenerator().generate( +- **kwargs.get("user_agent_generator_config", {}) ++ **(self.browser_config.user_agent_generator_config or {}) + ) + +- # Handle page creation differently for managed browser +- page, context = await self.browser_manager.get_page(session_id, user_agent) ++ # Get page for session ++ page, context = await self.browser_manager.get_page( ++ session_id=config.session_id, ++ user_agent=user_agent ++ ) ++ ++ # Add default cookie + await context.add_cookies([{"name": "cookiesEnabled", "value": "true", "url": url}]) + +- if kwargs.get("override_navigator", False) or kwargs.get("simulate_user", False) or kwargs.get("magic", False): +- # Inject scripts to override navigator properties ++ # Handle navigator overrides ++ if config.override_navigator or config.simulate_user or config.magic: + await context.add_init_script(load_js_script("navigator_overrider")) + +- # Add console message and error logging +- if kwargs.get("log_console", False): +- page.on("console", lambda msg: print(f"Console: {msg.text}")) +- page.on("pageerror", lambda exc: print(f"Page Error: {exc}")) ++ # Set up console logging if requested ++ if config.log_console: ++ page.on("console", lambda msg: self.logger.debug( ++ message="Console: {msg}", ++ tag="CONSOLE", ++ params={"msg": msg.text} ++ )) ++ page.on("pageerror", lambda exc: self.logger.error( ++ message="Page error: {exc}", ++ tag="ERROR", ++ params={"exc": exc} ++ )) + + try: +- # Set up download handling if enabled +- if self.accept_downloads: ++ # Set up download handling ++ if self.browser_config.accept_downloads: + page.on("download", lambda download: asyncio.create_task(self._handle_download(download))) + +- if self.use_cached_html: +- cache_file_path = os.path.join( +- os.getenv("CRAWL4_AI_BASE_DIRECTORY", Path.home()), ".crawl4ai", "cache", hashlib.md5(url.encode()).hexdigest() +- ) +- if os.path.exists(cache_file_path): +- html = "" +- with open(cache_file_path, "r") as f: +- html = f.read() +- # retrieve response headers and status code from cache +- with open(cache_file_path + ".meta", "r") as f: +- meta = json.load(f) +- response_headers = meta.get("response_headers", {}) +- status_code = meta.get("status_code") +- response = AsyncCrawlResponse( +- html=html, response_headers=response_headers, status_code=status_code +- ) +- return response +- +- if not kwargs.get("js_only", False): +- await self.execute_hook('before_goto', page, context = context, **kwargs) ++ # Handle page navigation and content loading ++ if not config.js_only: ++ await self.execute_hook('before_goto', page, context=context) + + try: + response = await page.goto( + url, +- # wait_until=kwargs.get("wait_until", ["domcontentloaded", "networkidle"]), +- wait_until=kwargs.get("wait_until", "domcontentloaded"), +- timeout=kwargs.get("page_timeout", 60000), ++ wait_until=config.wait_until, ++ timeout=config.page_timeout + ) + except Error as e: +- raise RuntimeError(f"Failed on navigating ACS-GOTO :\n{str(e)}") ++ raise RuntimeError(f"Failed on navigating ACS-GOTO:\n{str(e)}") + +- await self.execute_hook('after_goto', page, context = context, **kwargs) ++ await self.execute_hook('after_goto', page, context=context) + +- # Get status code and headers + status_code = response.status + response_headers = response.headers + else: + status_code = 200 + response_headers = {} + +- # Replace the current wait_for_selector line with this more robust check: ++ # Wait for body element and visibility + try: +- # First wait for body to exist, regardless of visibility + await page.wait_for_selector('body', state='attached', timeout=30000) +- +- # Then wait for it to become visible by checking CSS + await page.wait_for_function(""" + () => { + const body = document.body; +@@ -897,9 +807,7 @@ class AsyncPlaywrightCrawlerStrategy(AsyncCrawlerStrategy): + style.opacity !== '0'; + } + """, timeout=30000) +- + except Error as e: +- # If waiting fails, let's try to diagnose the issue + visibility_info = await page.evaluate(""" + () => { + const body = document.body; +@@ -914,233 +822,195 @@ class AsyncPlaywrightCrawlerStrategy(AsyncCrawlerStrategy): + } + """) + +- if self.verbose: +- print(f"Body visibility debug info: {visibility_info}") ++ if self.config.verbose: ++ self.logger.debug( ++ message="Body visibility info: {info}", ++ tag="DEBUG", ++ params={"info": visibility_info} ++ ) + +- # Even if body is hidden, we might still want to proceed +- if kwargs.get('ignore_body_visibility', True): +- if self.verbose: +- print("Proceeding despite hidden body...") +- pass +- else: ++ if not config.ignore_body_visibility: + raise Error(f"Body element is hidden: {visibility_info}") +- +- # CONTENT LOADING ASSURANCE +- if not self.text_only and (kwargs.get("wait_for_images", True) or kwargs.get("adjust_viewport_to_content", False)): +- # Wait for network idle after initial load and images to load +- # await page.wait_for_load_state("networkidle") ++ ++ # Handle content loading and viewport adjustment ++ if not self.browser_config.text_only and (config.wait_for_images or config.adjust_viewport_to_content): + await page.wait_for_load_state("domcontentloaded") + await asyncio.sleep(0.1) +- from playwright.async_api import TimeoutError as PlaywrightTimeoutError + try: +- await page.wait_for_function("Array.from(document.images).every(img => img.complete)", timeout=1000) +- # Check for TimeoutError and ignore it ++ await page.wait_for_function( ++ "Array.from(document.images).every(img => img.complete)", ++ timeout=1000 ++ ) + except PlaywrightTimeoutError: + pass +- +- # After initial load, adjust viewport to content size +- if not self.text_only and kwargs.get("adjust_viewport_to_content", False): +- try: +- # Get actual page dimensions ++ ++ # Adjust viewport if needed ++ if not self.browser_config.text_only and config.adjust_viewport_to_content: ++ try: + page_width = await page.evaluate("document.documentElement.scrollWidth") + page_height = await page.evaluate("document.documentElement.scrollHeight") + +- target_width = self.viewport_width ++ target_width = self.browser_config.viewport_width + target_height = int(target_width * page_width / page_height * 0.95) + await page.set_viewport_size({"width": target_width, "height": target_height}) + +- # Compute scale factor +- # We want the entire page visible: the scale should make both width and height fit + scale = min(target_width / page_width, target_height / page_height) +- +- # Now we call CDP to set metrics. +- # We tell Chrome that the "device" is page_width x page_height in size, +- # but we scale it down so everything fits within the real viewport. + cdp = await page.context.new_cdp_session(page) + await cdp.send('Emulation.setDeviceMetricsOverride', { +- 'width': page_width, # full page width +- 'height': page_height, # full page height +- 'deviceScaleFactor': 1, # keep normal DPR ++ 'width': page_width, ++ 'height': page_height, ++ 'deviceScaleFactor': 1, + 'mobile': False, +- 'scale': scale # scale the entire rendered content ++ 'scale': scale + }) +- + except Exception as e: + self.logger.warning( + message="Failed to adjust viewport to content: {error}", + tag="VIEWPORT", + params={"error": str(e)} +- ) +- +- # After viewport adjustment, handle page scanning if requested +- if kwargs.get("scan_full_page", False): +- try: +- viewport_height = page.viewport_size.get("height", self.viewport_height) +- current_position = viewport_height # Start with one viewport height +- scroll_delay = kwargs.get("scroll_delay", 0.2) +- +- # Initial scroll +- await page.evaluate(f"window.scrollTo(0, {current_position})") +- await asyncio.sleep(scroll_delay) +- +- # Get height after first scroll to account for any dynamic content +- total_height = await page.evaluate("document.documentElement.scrollHeight") +- +- while current_position < total_height: +- current_position = min(current_position + viewport_height, total_height) +- await page.evaluate(f"window.scrollTo(0, {current_position})") +- await asyncio.sleep(scroll_delay) +- +- # Check for dynamic content +- new_height = await page.evaluate("document.documentElement.scrollHeight") +- if new_height > total_height: +- total_height = new_height +- +- # Scroll back to top +- await page.evaluate("window.scrollTo(0, 0)") +- +- except Exception as e: +- self.logger.warning( +- message="Failed to perform full page scan: {error}", +- tag="PAGE_SCAN", +- params={"error": str(e)} + ) +- else: +- # Scroll to the bottom of the page +- await page.evaluate("window.scrollTo(0, document.body.scrollHeight)") +- +- js_code = kwargs.get("js_code", kwargs.get("js", self.js_code)) +- if js_code: +- if isinstance(js_code, str): +- await page.evaluate(js_code) +- elif isinstance(js_code, list): +- for js in js_code: ++ ++ # Handle full page scanning ++ if config.scan_full_page: ++ await self._handle_full_page_scan(page, config.scroll_delay) ++ ++ # Execute JavaScript if provided ++ if config.js_code: ++ if isinstance(config.js_code, str): ++ await page.evaluate(config.js_code) ++ elif isinstance(config.js_code, list): ++ for js in config.js_code: + await page.evaluate(js) + +- # await page.wait_for_timeout(100) +- +- # Check for on execution event +- await self.execute_hook('on_execution_started', page, context = context, **kwargs) +- +- if kwargs.get("simulate_user", False) or kwargs.get("magic", False): +- # Simulate user interactions ++ await self.execute_hook('on_execution_started', page, context=context) ++ ++ # Handle user simulation ++ if config.simulate_user or config.magic: + await page.mouse.move(100, 100) + await page.mouse.down() + await page.mouse.up() + await page.keyboard.press('ArrowDown') + +- # Handle the wait_for parameter +- wait_for = kwargs.get("wait_for") +- if wait_for: ++ # Handle wait_for condition ++ if config.wait_for: + try: +- await self.smart_wait(page, wait_for, timeout=kwargs.get("page_timeout", 60000)) ++ await self.smart_wait(page, config.wait_for, timeout=config.page_timeout) + except Exception as e: + raise RuntimeError(f"Wait condition failed: {str(e)}") +- +- # if not wait_for and js_code: +- # await page.wait_for_load_state('networkidle', timeout=5000) + +- # Update image dimensions +- if not self.text_only: ++ # Update image dimensions if needed ++ if not self.browser_config.text_only: + update_image_dimensions_js = load_js_script("update_image_dimensions") +- + try: + try: +- await page.wait_for_load_state( +- # state="load", +- state="domcontentloaded", +- timeout=5 +- ) ++ await page.wait_for_load_state("domcontentloaded", timeout=5) + except PlaywrightTimeoutError: + pass + await page.evaluate(update_image_dimensions_js) + except Exception as e: + self.logger.error( +- message="Error updating image dimensions ACS-UPDATE_IMAGE_DIMENSIONS_JS: {error}", ++ message="Error updating image dimensions: {error}", + tag="ERROR", + params={"error": str(e)} + ) +- # raise RuntimeError(f"Error updating image dimensions ACS-UPDATE_IMAGE_DIMENSIONS_JS: {str(e)}") + +- # Wait a bit for any onload events to complete +- # await page.wait_for_timeout(100) +- +- # Process iframes +- if kwargs.get("process_iframes", False): ++ # Process iframes if needed ++ if config.process_iframes: + page = await self.process_iframes(page) +- +- await self.execute_hook('before_retrieve_html', page, context = context, **kwargs) +- # Check if delay_before_return_html is set then wait for that time +- delay_before_return_html = kwargs.get("delay_before_return_html", 0.1) +- if delay_before_return_html: +- await asyncio.sleep(delay_before_return_html) +- +- # Check for remove_overlay_elements parameter +- if kwargs.get("remove_overlay_elements", False): ++ ++ # Pre-content retrieval hooks and delay ++ await self.execute_hook('before_retrieve_html', page, context=context) ++ if config.delay_before_return_html: ++ await asyncio.sleep(config.delay_before_return_html) ++ ++ # Handle overlay removal ++ if config.remove_overlay_elements: + await self.remove_overlay_elements(page) +- ++ ++ # Get final HTML content + html = await page.content() +- await self.execute_hook('before_return_html', page, html, context = context, **kwargs) +- ++ await self.execute_hook('before_return_html', page, html, context=context) ++ ++ # Handle PDF and screenshot generation + start_export_time = time.perf_counter() + pdf_data = None +- if pdf_requested: +- # Generate PDF once +- pdf_data = await self.export_pdf(page) +- +- # Check if kwargs has screenshot=True then take screenshot + screenshot_data = None +- if screenshot_requested: #kwargs.get("screenshot"): +- # Check we have screenshot_wait_for parameter, if we have simply wait for that time +- screenshot_wait_for = kwargs.get("screenshot_wait_for") +- if screenshot_wait_for: +- await asyncio.sleep(screenshot_wait_for) +- +- screenshot_data = await self.take_screenshot(page, **kwargs) +- end_export_time = time.perf_counter() ++ ++ if config.pdf: ++ pdf_data = await self.export_pdf(page) ++ ++ if config.screenshot: ++ if config.screenshot_wait_for: ++ await asyncio.sleep(config.screenshot_wait_for) ++ screenshot_data = await self.take_screenshot( ++ page, ++ screenshot_height_threshold=config.screenshot_height_threshold ++ ) ++ + if screenshot_data or pdf_data: + self.logger.info( + message="Exporting PDF and taking screenshot took {duration:.2f}s", + tag="EXPORT", +- params={"duration": end_export_time - start_export_time} ++ params={"duration": time.perf_counter() - start_export_time} + ) +- +- if self.use_cached_html: +- cache_file_path = os.path.join( +- os.getenv("CRAWL4_AI_BASE_DIRECTORY", Path.home()), ".crawl4ai", "cache", hashlib.md5(url.encode()).hexdigest() +- ) +- with open(cache_file_path, "w", encoding="utf-8") as f: +- f.write(html) +- # store response headers and status code in cache +- with open(cache_file_path + ".meta", "w", encoding="utf-8") as f: +- json.dump({ +- "response_headers": response_headers, +- "status_code": status_code +- }, f) + ++ # Define delayed content getter + async def get_delayed_content(delay: float = 5.0) -> str: +- if self.verbose: +- print(f"[LOG] Waiting for {delay} seconds before retrieving content for {url}") ++ if self.config.verbose: ++ self.logger.info( ++ message="Waiting for {delay} seconds before retrieving content for {url}", ++ tag="INFO", ++ params={"delay": delay, "url": url} ++ ) + await asyncio.sleep(delay) + return await page.content() +- +- response = AsyncCrawlResponse( +- html=html, +- response_headers=response_headers, ++ ++ # Return complete response ++ return AsyncCrawlResponse( ++ html=html, ++ response_headers=response_headers, + status_code=status_code, + screenshot=screenshot_data, + pdf_data=pdf_data, + get_delayed_content=get_delayed_content, + downloaded_files=self._downloaded_files if self._downloaded_files else None + ) +- return response +- except Error as e: +- raise Error(f"async_crawler_strategy.py:_crawleb(): {str(e)}") +- # finally: +- # if not session_id: +- # await page.close() +- # await context.close() + ++ except Exception as e: ++ raise e ++ ++ async def _handle_full_page_scan(self, page: Page, scroll_delay: float): ++ """Helper method to handle full page scanning""" ++ try: ++ viewport_height = page.viewport_size.get("height", self.browser_config.viewport_height) ++ current_position = viewport_height ++ ++ await page.evaluate(f"window.scrollTo(0, {current_position})") ++ await asyncio.sleep(scroll_delay) ++ ++ total_height = await page.evaluate("document.documentElement.scrollHeight") ++ ++ while current_position < total_height: ++ current_position = min(current_position + viewport_height, total_height) ++ await page.evaluate(f"window.scrollTo(0, {current_position})") ++ await asyncio.sleep(scroll_delay) ++ ++ new_height = await page.evaluate("document.documentElement.scrollHeight") ++ if new_height > total_height: ++ total_height = new_height ++ ++ await page.evaluate("window.scrollTo(0, 0)") ++ ++ except Exception as e: ++ self.logger.warning( ++ message="Failed to perform full page scan: {error}", ++ tag="PAGE_SCAN", ++ params={"error": str(e)} ++ ) ++ else: ++ await page.evaluate("window.scrollTo(0, document.body.scrollHeight)") ++ ++ + async def _handle_download(self, download): + """Handle file downloads.""" + try: +@@ -1170,8 +1040,6 @@ class AsyncPlaywrightCrawlerStrategy(AsyncCrawlerStrategy): + params={"error": str(e)} + ) + +- # if self.verbose: +- # print(f"[ERROR] Failed to handle download: {str(e)}") + + async def crawl_many(self, urls: List[str], **kwargs) -> List[AsyncCrawlResponse]: + semaphore_count = kwargs.get('semaphore_count', 5) # Adjust as needed +@@ -1192,7 +1060,7 @@ class AsyncPlaywrightCrawlerStrategy(AsyncCrawlerStrategy): + Args: + page (Page): The Playwright page instance + """ +- remove_overlays_js = load_js_script("remove_overlays") ++ remove_overlays_js = load_js_script("remove_overlay_elements") + + try: + await page.evaluate(remove_overlays_js) +@@ -1203,8 +1071,6 @@ class AsyncPlaywrightCrawlerStrategy(AsyncCrawlerStrategy): + tag="SCRAPE", + params={"error": str(e)} + ) +- # if self.verbose: +- # print(f"Warning: Failed to remove overlay elements: {str(e)}") + + async def export_pdf(self, page: Page) -> bytes: + """ +@@ -1386,7 +1252,6 @@ class AsyncPlaywrightCrawlerStrategy(AsyncCrawlerStrategy): + return base64.b64encode(screenshot).decode('utf-8') + except Exception as e: + error_message = f"Failed to take screenshot: {str(e)}" +- # print(error_message) + self.logger.error( + message="Screenshot failed: {error}", + tag="ERROR", +diff --git a/crawl4ai/async_database.py b/crawl4ai/async_database.py +index 3c97e7d..5cdafac 100644 +--- a/crawl4ai/async_database.py ++++ b/crawl4ai/async_database.py +@@ -1,4 +1,4 @@ +-import os ++import os, sys + from pathlib import Path + import aiosqlite + import asyncio +@@ -13,6 +13,7 @@ import aiofiles + from .config import NEED_MIGRATION + from .version_manager import VersionManager + from .async_logger import AsyncLogger ++from .utils import get_error_context, create_box_message + # Set up logging + logging.basicConfig(level=logging.INFO) + logger = logging.getLogger(__name__) +@@ -97,35 +98,84 @@ class AsyncDatabaseManager: + + @asynccontextmanager + async def get_connection(self): +- """Connection pool manager""" ++ """Connection pool manager with enhanced error handling""" + if not self._initialized: +- # Use an asyncio.Lock to ensure only one initialization occurs + async with self.init_lock: + if not self._initialized: +- await self.initialize() +- self._initialized = True ++ try: ++ await self.initialize() ++ self._initialized = True ++ except Exception as e: ++ import sys ++ error_context = get_error_context(sys.exc_info()) ++ self.logger.error( ++ message="Database initialization failed:\n{error}\n\nContext:\n{context}\n\nTraceback:\n{traceback}", ++ tag="ERROR", ++ force_verbose=True, ++ params={ ++ "error": str(e), ++ "context": error_context["code_context"], ++ "traceback": error_context["full_traceback"] ++ } ++ ) ++ raise + + await self.connection_semaphore.acquire() + task_id = id(asyncio.current_task()) ++ + try: + async with self.pool_lock: + if task_id not in self.connection_pool: +- conn = await aiosqlite.connect( +- self.db_path, +- timeout=30.0 +- ) +- await conn.execute('PRAGMA journal_mode = WAL') +- await conn.execute('PRAGMA busy_timeout = 5000') +- self.connection_pool[task_id] = conn ++ try: ++ conn = await aiosqlite.connect( ++ self.db_path, ++ timeout=30.0 ++ ) ++ await conn.execute('PRAGMA journal_mode = WAL') ++ await conn.execute('PRAGMA busy_timeout = 5000') ++ ++ # Verify database structure ++ async with conn.execute("PRAGMA table_info(crawled_data)") as cursor: ++ columns = await cursor.fetchall() ++ column_names = [col[1] for col in columns] ++ expected_columns = { ++ 'url', 'html', 'cleaned_html', 'markdown', 'extracted_content', ++ 'success', 'media', 'links', 'metadata', 'screenshot', ++ 'response_headers', 'downloaded_files' ++ } ++ missing_columns = expected_columns - set(column_names) ++ if missing_columns: ++ raise ValueError(f"Database missing columns: {missing_columns}") ++ ++ self.connection_pool[task_id] = conn ++ except Exception as e: ++ import sys ++ error_context = get_error_context(sys.exc_info()) ++ error_message = ( ++ f"Unexpected error in db get_connection at line {error_context['line_no']} " ++ f"in {error_context['function']} ({error_context['filename']}):\n" ++ f"Error: {str(e)}\n\n" ++ f"Code context:\n{error_context['code_context']}" ++ ) ++ self.logger.error( ++ message=create_box_message(error_message, type= "error"), ++ ) ++ ++ raise + + yield self.connection_pool[task_id] + + except Exception as e: ++ import sys ++ error_context = get_error_context(sys.exc_info()) ++ error_message = ( ++ f"Unexpected error in db get_connection at line {error_context['line_no']} " ++ f"in {error_context['function']} ({error_context['filename']}):\n" ++ f"Error: {str(e)}\n\n" ++ f"Code context:\n{error_context['code_context']}" ++ ) + self.logger.error( +- message="Connection error: {error}", +- tag="ERROR", +- force_verbose=True, +- params={"error": str(e)} ++ message=create_box_message(error_message, type= "error"), + ) + raise + finally: +@@ -230,7 +280,8 @@ class AsyncDatabaseManager: + 'cleaned_html': row_dict['cleaned_html'], + 'markdown': row_dict['markdown'], + 'extracted_content': row_dict['extracted_content'], +- 'screenshot': row_dict['screenshot'] ++ 'screenshot': row_dict['screenshot'], ++ 'screenshots': row_dict['screenshot'], + } + + for field, hash_value in content_fields.items(): +diff --git a/crawl4ai/async_webcrawler.py b/crawl4ai/async_webcrawler.py +index fc6fe82..72ef0bf 100644 +--- a/crawl4ai/async_webcrawler.py ++++ b/crawl4ai/async_webcrawler.py +@@ -1,4 +1,4 @@ +-import os ++import os, sys + import time + import warnings + from enum import Enum +@@ -17,7 +17,7 @@ from .async_crawler_strategy import AsyncCrawlerStrategy, AsyncPlaywrightCrawler + from .cache_context import CacheMode, CacheContext, _legacy_to_cache_mode + from .content_scraping_strategy import WebScrapingStrategy + from .async_logger import AsyncLogger +- ++from .async_configs import BrowserConfig, CrawlerRunConfig + from .config import ( + MIN_WORD_THRESHOLD, + IMAGE_DESCRIPTION_MIN_WORD_THRESHOLD, +@@ -40,31 +40,20 @@ class AsyncWebCrawler: + """ + Asynchronous web crawler with flexible caching capabilities. + +- Migration Guide (from version X.X.X): ++ Migration Guide: + Old way (deprecated): +- crawler = AsyncWebCrawler(always_by_pass_cache=True) +- result = await crawler.arun( +- url="https://example.com", +- bypass_cache=True, +- no_cache_read=True, +- no_cache_write=False +- ) ++ crawler = AsyncWebCrawler(always_by_pass_cache=True, browser_type="chromium", headless=True) + + New way (recommended): +- crawler = AsyncWebCrawler(always_bypass_cache=True) +- result = await crawler.arun( +- url="https://example.com", +- cache_mode=CacheMode.WRITE_ONLY +- ) +- +- To disable deprecation warnings: +- Pass warning=False to suppress the warning. ++ browser_config = BrowserConfig(browser_type="chromium", headless=True) ++ crawler = AsyncWebCrawler(browser_config=browser_config) + """ + _domain_last_hit = {} + + def __init__( + self, + crawler_strategy: Optional[AsyncCrawlerStrategy] = None, ++ config: Optional[BrowserConfig] = None, + always_bypass_cache: bool = False, + always_by_pass_cache: Optional[bool] = None, # Deprecated parameter + base_directory: str = str(os.getenv("CRAWL4_AI_BASE_DIRECTORY", Path.home())), +@@ -75,28 +64,48 @@ class AsyncWebCrawler: + Initialize the AsyncWebCrawler. + + Args: +- crawler_strategy: Strategy for crawling web pages ++ crawler_strategy: Strategy for crawling web pages. If None, will create AsyncPlaywrightCrawlerStrategy ++ config: Configuration object for browser settings. If None, will be created from kwargs + always_bypass_cache: Whether to always bypass cache (new parameter) + always_by_pass_cache: Deprecated, use always_bypass_cache instead + base_directory: Base directory for storing cache ++ thread_safe: Whether to use thread-safe operations ++ **kwargs: Additional arguments for backwards compatibility + """ +- self.verbose = kwargs.get("verbose", False) ++ # Handle browser configuration ++ browser_config = config ++ if browser_config is not None: ++ if any(k in kwargs for k in ["browser_type", "headless", "viewport_width", "viewport_height"]): ++ self.logger.warning( ++ message="Both browser_config and legacy browser parameters provided. browser_config will take precedence.", ++ tag="WARNING" ++ ) ++ else: ++ # Create browser config from kwargs for backwards compatibility ++ browser_config = BrowserConfig.from_kwargs(kwargs) ++ ++ self.browser_config = browser_config ++ ++ # Initialize logger first since other components may need it + self.logger = AsyncLogger( + log_file=os.path.join(base_directory, ".crawl4ai", "crawler.log"), +- verbose=self.verbose, ++ verbose=self.browser_config.verbose, + tag_width=10 + ) ++ + ++ # Initialize crawler strategy + self.crawler_strategy = crawler_strategy or AsyncPlaywrightCrawlerStrategy( +- logger = self.logger, +- **kwargs ++ browser_config=browser_config, ++ logger=self.logger, ++ **kwargs # Pass remaining kwargs for backwards compatibility + ) + +- # Handle deprecated parameter ++ # Handle deprecated cache parameter + if always_by_pass_cache is not None: + if kwargs.get("warning", True): + warnings.warn( +- "'always_by_pass_cache' is deprecated and will be removed in version X.X.X. " ++ "'always_by_pass_cache' is deprecated and will be removed in version 0.5.0. " + "Use 'always_bypass_cache' instead. " + "Pass warning=False to suppress this warning.", + DeprecationWarning, +@@ -106,13 +115,15 @@ class AsyncWebCrawler: + else: + self.always_bypass_cache = always_bypass_cache + ++ # Thread safety setup + self._lock = asyncio.Lock() if thread_safe else None + ++ # Initialize directories + self.crawl4ai_folder = os.path.join(base_directory, ".crawl4ai") + os.makedirs(self.crawl4ai_folder, exist_ok=True) + os.makedirs(f"{self.crawl4ai_folder}/cache", exist_ok=True) ++ + self.ready = False +- self.verbose = kwargs.get("verbose", False) + + async def __aenter__(self): + await self.crawler_strategy.__aenter__() +@@ -131,197 +142,198 @@ class AsyncWebCrawler: + self.logger.info(f"Crawl4AI {crawl4ai_version}", tag="INIT") + self.ready = True + +- async def arun( +- self, +- url: str, +- word_count_threshold=MIN_WORD_THRESHOLD, +- extraction_strategy: ExtractionStrategy = None, +- chunking_strategy: ChunkingStrategy = RegexChunking(), +- content_filter: RelevantContentFilter = None, +- cache_mode: Optional[CacheMode] = None, +- # Deprecated parameters +- bypass_cache: bool = False, +- disable_cache: bool = False, +- no_cache_read: bool = False, +- no_cache_write: bool = False, +- # Other parameters +- css_selector: str = None, +- screenshot: bool = False, +- pdf: bool = False, +- user_agent: str = None, +- verbose=True, +- **kwargs, +- ) -> CrawlResult: +- """ +- Runs the crawler for a single source: URL (web, local file, or raw HTML). + +- Migration from legacy cache parameters: ++ async def arun( ++ self, ++ url: str, ++ config: Optional[CrawlerRunConfig] = None, ++ # Legacy parameters maintained for backwards compatibility ++ word_count_threshold=MIN_WORD_THRESHOLD, ++ extraction_strategy: ExtractionStrategy = None, ++ chunking_strategy: ChunkingStrategy = RegexChunking(), ++ content_filter: RelevantContentFilter = None, ++ cache_mode: Optional[CacheMode] = None, ++ # Deprecated cache parameters ++ bypass_cache: bool = False, ++ disable_cache: bool = False, ++ no_cache_read: bool = False, ++ no_cache_write: bool = False, ++ # Other legacy parameters ++ css_selector: str = None, ++ screenshot: bool = False, ++ pdf: bool = False, ++ user_agent: str = None, ++ verbose=True, ++ **kwargs, ++ ) -> CrawlResult: ++ """ ++ Runs the crawler for a single source: URL (web, local file, or raw HTML). ++ ++ Migration Guide: + Old way (deprecated): +- await crawler.arun(url, bypass_cache=True, no_cache_read=True) ++ result = await crawler.arun( ++ url="https://example.com", ++ word_count_threshold=200, ++ screenshot=True, ++ ... ++ ) + +- New way: +- await crawler.arun(url, cache_mode=CacheMode.BYPASS) ++ New way (recommended): ++ config = CrawlerRunConfig( ++ word_count_threshold=200, ++ screenshot=True, ++ ... ++ ) ++ result = await crawler.arun(url="https://example.com", crawler_config=config) + +- Args: +- url: The URL to crawl (http://, https://, file://, or raw:) +- cache_mode: Cache behavior control (recommended) +- word_count_threshold: Minimum word count threshold +- extraction_strategy: Strategy for content extraction +- chunking_strategy: Strategy for content chunking +- css_selector: CSS selector for content extraction +- screenshot: Whether to capture screenshot +- user_agent: Custom user agent +- verbose: Enable verbose logging ++ Args: ++ url: The URL to crawl (http://, https://, file://, or raw:) ++ crawler_config: Configuration object controlling crawl behavior ++ [other parameters maintained for backwards compatibility] + +- Deprecated Args: +- bypass_cache: Use cache_mode=CacheMode.BYPASS instead +- disable_cache: Use cache_mode=CacheMode.DISABLED instead +- no_cache_read: Use cache_mode=CacheMode.WRITE_ONLY instead +- no_cache_write: Use cache_mode=CacheMode.READ_ONLY instead +- +- Returns: +- CrawlResult: The result of crawling and processing +- """ +- # Check if url is not string and is not empty +- if not isinstance(url, str) or not url: +- raise ValueError("Invalid URL, make sure the URL is a non-empty string") +- +- async with self._lock or self.nullcontext(): # Lock for thread safety previously -> nullcontext(): +- try: +- # Handle deprecated parameters +- if any([bypass_cache, disable_cache, no_cache_read, no_cache_write]): +- if kwargs.get("warning", True): +- warnings.warn( +- "Cache control boolean flags are deprecated and will be removed in version X.X.X. " +- "Use 'cache_mode' parameter instead. Examples:\n" +- "- For bypass_cache=True, use cache_mode=CacheMode.BYPASS\n" +- "- For disable_cache=True, use cache_mode=CacheMode.DISABLED\n" +- "- For no_cache_read=True, use cache_mode=CacheMode.WRITE_ONLY\n" +- "- For no_cache_write=True, use cache_mode=CacheMode.READ_ONLY\n" +- "Pass warning=False to suppress this warning.", +- DeprecationWarning, +- stacklevel=2 +- ) ++ Returns: ++ CrawlResult: The result of crawling and processing ++ """ ++ crawler_config = config ++ if not isinstance(url, str) or not url: ++ raise ValueError("Invalid URL, make sure the URL is a non-empty string") ++ ++ async with self._lock or self.nullcontext(): ++ try: ++ # Handle configuration ++ if crawler_config is not None: ++ if any(param is not None for param in [ ++ word_count_threshold, extraction_strategy, chunking_strategy, ++ content_filter, cache_mode, css_selector, screenshot, pdf ++ ]): ++ self.logger.warning( ++ message="Both crawler_config and legacy parameters provided. crawler_config will take precedence.", ++ tag="WARNING" ++ ) ++ config = crawler_config ++ else: ++ # Merge all parameters into a single kwargs dict for config creation ++ config_kwargs = { ++ "word_count_threshold": word_count_threshold, ++ "extraction_strategy": extraction_strategy, ++ "chunking_strategy": chunking_strategy, ++ "content_filter": content_filter, ++ "cache_mode": cache_mode, ++ "bypass_cache": bypass_cache, ++ "disable_cache": disable_cache, ++ "no_cache_read": no_cache_read, ++ "no_cache_write": no_cache_write, ++ "css_selector": css_selector, ++ "screenshot": screenshot, ++ "pdf": pdf, ++ "verbose": verbose, ++ **kwargs ++ } ++ config = CrawlerRunConfig.from_kwargs(config_kwargs) ++ ++ # Handle deprecated cache parameters ++ if any([bypass_cache, disable_cache, no_cache_read, no_cache_write]): ++ if kwargs.get("warning", True): ++ warnings.warn( ++ "Cache control boolean flags are deprecated and will be removed in version 0.5.0. " ++ "Use 'cache_mode' parameter instead.", ++ DeprecationWarning, ++ stacklevel=2 ++ ) ++ ++ # Convert legacy parameters if cache_mode not provided ++ if config.cache_mode is None: ++ config.cache_mode = _legacy_to_cache_mode( ++ disable_cache=disable_cache, ++ bypass_cache=bypass_cache, ++ no_cache_read=no_cache_read, ++ no_cache_write=no_cache_write ++ ) + +- # Convert legacy parameters if cache_mode not provided +- if cache_mode is None: +- cache_mode = _legacy_to_cache_mode( +- disable_cache=disable_cache, +- bypass_cache=bypass_cache, +- no_cache_read=no_cache_read, +- no_cache_write=no_cache_write +- ) +- +- # Default to ENABLED if no cache mode specified +- if cache_mode is None: +- cache_mode = CacheMode.ENABLED +- +- # Create cache context +- cache_context = CacheContext(url, cache_mode, self.always_bypass_cache) +- +- extraction_strategy = extraction_strategy or NoExtractionStrategy() +- extraction_strategy.verbose = verbose +- if not isinstance(extraction_strategy, ExtractionStrategy): +- raise ValueError("Unsupported extraction strategy") +- if not isinstance(chunking_strategy, ChunkingStrategy): +- raise ValueError("Unsupported chunking strategy") +- +- word_count_threshold = max(word_count_threshold, MIN_WORD_THRESHOLD) +- +- async_response: AsyncCrawlResponse = None +- cached_result = None +- screenshot_data = None +- pdf_data = None +- extracted_content = None +- +- start_time = time.perf_counter() +- +- # Try to get cached result if appropriate +- if cache_context.should_read(): +- cached_result = await async_db_manager.aget_cached_url(url) +- +- if cached_result: +- html = sanitize_input_encode(cached_result.html) +- extracted_content = sanitize_input_encode(cached_result.extracted_content or "") +- if screenshot: ++ # Default to ENABLED if no cache mode specified ++ if config.cache_mode is None: ++ config.cache_mode = CacheMode.ENABLED ++ ++ # Create cache context ++ cache_context = CacheContext(url, config.cache_mode, self.always_bypass_cache) ++ ++ # Initialize processing variables ++ async_response: AsyncCrawlResponse = None ++ cached_result = None ++ screenshot_data = None ++ pdf_data = None ++ extracted_content = None ++ start_time = time.perf_counter() ++ ++ # Try to get cached result if appropriate ++ if cache_context.should_read(): ++ cached_result = await async_db_manager.aget_cached_url(url) ++ ++ if cached_result: ++ html = sanitize_input_encode(cached_result.html) ++ extracted_content = sanitize_input_encode(cached_result.extracted_content or "") ++ # If screenshot is requested but its not in cache, then set cache_result to None + screenshot_data = cached_result.screenshot +- if not screenshot_data: +- cached_result = None +- if pdf: + pdf_data = cached_result.pdf +- if not pdf_data: ++ if config.screenshot and not screenshot or config.pdf and not pdf: + cached_result = None +- # if verbose: +- # print(f"{Fore.BLUE}{self.tag_format('FETCH')} {self.log_icons['FETCH']} Cache hit for {cache_context.display_url} | Status: {Fore.GREEN if bool(html) else Fore.RED}{bool(html)}{Style.RESET_ALL} | Time: {time.perf_counter() - start_time:.2f}s") +- self.logger.url_status( ++ ++ self.logger.url_status( + url=cache_context.display_url, + success=bool(html), + timing=time.perf_counter() - start_time, + tag="FETCH" +- ) ++ ) + ++ # Fetch fresh content if needed ++ if not cached_result or not html: ++ t1 = time.perf_counter() ++ ++ if user_agent: ++ self.crawler_strategy.update_user_agent(user_agent) ++ ++ # Pass config to crawl method ++ async_response = await self.crawler_strategy.crawl( ++ url, ++ config=config # Pass the entire config object ++ ) ++ ++ html = sanitize_input_encode(async_response.html) ++ screenshot_data = async_response.screenshot ++ pdf_data = async_response.pdf_data ++ ++ t2 = time.perf_counter() ++ self.logger.url_status( ++ url=cache_context.display_url, ++ success=bool(html), ++ timing=t2 - t1, ++ tag="FETCH" ++ ) + +- # Fetch fresh content if needed +- if not cached_result or not html: +- t1 = time.perf_counter() +- +- if user_agent: +- self.crawler_strategy.update_user_agent(user_agent) +- async_response: AsyncCrawlResponse = await self.crawler_strategy.crawl( +- url, +- screenshot=screenshot, +- pdf=pdf, +- **kwargs +- ) +- html = sanitize_input_encode(async_response.html) +- screenshot_data = async_response.screenshot +- pdf_data = async_response.pdf_data +- t2 = time.perf_counter() +- self.logger.url_status( +- url=cache_context.display_url, +- success=bool(html), +- timing=t2 - t1, +- tag="FETCH" ++ # Process the HTML content ++ crawl_result = await self.aprocess_html( ++ url=url, ++ html=html, ++ extracted_content=extracted_content, ++ config=config, # Pass the config object instead of individual parameters ++ screenshot=screenshot_data, ++ pdf_data=pdf_data, ++ verbose=config.verbose + ) +- # if verbose: +- # print(f"{Fore.BLUE}{self.tag_format('FETCH')} {self.log_icons['FETCH']} Live fetch for {cache_context.display_url}... | Status: {Fore.GREEN if bool(html) else Fore.RED}{bool(html)}{Style.RESET_ALL} | Time: {t2 - t1:.2f}s") +- +- # Process the HTML content +- crawl_result = await self.aprocess_html( +- url=url, +- html=html, +- extracted_content=extracted_content, +- word_count_threshold=word_count_threshold, +- extraction_strategy=extraction_strategy, +- chunking_strategy=chunking_strategy, +- content_filter=content_filter, +- css_selector=css_selector, +- screenshot=screenshot_data, +- pdf_data=pdf_data, +- verbose=verbose, +- is_cached=bool(cached_result), +- async_response=async_response, +- is_web_url=cache_context.is_web_url, +- is_local_file=cache_context.is_local_file, +- is_raw_html=cache_context.is_raw_html, +- **kwargs, +- ) +- +- # Set response data +- if async_response: +- crawl_result.status_code = async_response.status_code +- crawl_result.response_headers = async_response.response_headers +- crawl_result.downloaded_files = async_response.downloaded_files +- else: +- crawl_result.status_code = 200 +- crawl_result.response_headers = cached_result.response_headers if cached_result else {} + +- crawl_result.success = bool(html) +- crawl_result.session_id = kwargs.get("session_id", None) ++ # Set response data ++ if async_response: ++ crawl_result.status_code = async_response.status_code ++ crawl_result.response_headers = async_response.response_headers ++ crawl_result.downloaded_files = async_response.downloaded_files ++ else: ++ crawl_result.status_code = 200 ++ crawl_result.response_headers = cached_result.response_headers if cached_result else {} ++ ++ crawl_result.success = bool(html) ++ crawl_result.session_id = getattr(config, 'session_id', None) + +- # if verbose: +- # print(f"{Fore.GREEN}{self.tag_format('COMPLETE')} {self.log_icons['COMPLETE']} {cache_context.display_url[:URL_LOG_SHORTEN_LENGTH]}... | Status: {Fore.GREEN if crawl_result.success else Fore.RED}{crawl_result.success} | {Fore.YELLOW}Total: {time.perf_counter() - start_time:.2f}s{Style.RESET_ALL}") +- self.logger.success( ++ self.logger.success( + message="{url:.50}... | Status: {status} | Total: {timing}", + tag="COMPLETE", + params={ +@@ -335,254 +347,312 @@ class AsyncWebCrawler: + } + ) + +- # Update cache if appropriate +- if cache_context.should_write() and not bool(cached_result): +- await async_db_manager.acache_url(crawl_result) ++ # Update cache if appropriate ++ if cache_context.should_write() and not bool(cached_result): ++ await async_db_manager.acache_url(crawl_result) ++ ++ return crawl_result + +- return crawl_result ++ except Exception as e: ++ error_context = get_error_context(sys.exc_info()) ++ ++ error_message = ( ++ f"Unexpected error in _crawl_web at line {error_context['line_no']} " ++ f"in {error_context['function']} ({error_context['filename']}):\n" ++ f"Error: {str(e)}\n\n" ++ f"Code context:\n{error_context['code_context']}" ++ ) ++ # if not hasattr(e, "msg"): ++ # e.msg = str(e) ++ ++ self.logger.error_status( ++ url=url, ++ error=create_box_message(error_message, type="error"), ++ tag="ERROR" ++ ) ++ ++ return CrawlResult( ++ url=url, ++ html="", ++ success=False, ++ error_message=error_message ++ ) ++ ++ async def aprocess_html( ++ self, ++ url: str, ++ html: str, ++ extracted_content: str, ++ config: CrawlerRunConfig, ++ screenshot: str, ++ pdf_data: str, ++ verbose: bool, ++ **kwargs, ++ ) -> CrawlResult: ++ """ ++ Process HTML content using the provided configuration. ++ ++ Args: ++ url: The URL being processed ++ html: Raw HTML content ++ extracted_content: Previously extracted content (if any) ++ config: Configuration object controlling processing behavior ++ screenshot: Screenshot data (if any) ++ verbose: Whether to enable verbose logging ++ **kwargs: Additional parameters for backwards compatibility + ++ Returns: ++ CrawlResult: Processed result containing extracted and formatted content ++ """ ++ try: ++ _url = url if not kwargs.get("is_raw_html", False) else "Raw HTML" ++ t1 = time.perf_counter() ++ ++ # Initialize scraping strategy ++ scrapping_strategy = WebScrapingStrategy(logger=self.logger) ++ ++ # Process HTML content ++ result = scrapping_strategy.scrap( ++ url, ++ html, ++ word_count_threshold=config.word_count_threshold, ++ css_selector=config.css_selector, ++ only_text=config.only_text, ++ image_description_min_word_threshold=config.image_description_min_word_threshold, ++ content_filter=config.content_filter ++ ) ++ ++ if result is None: ++ raise ValueError(f"Process HTML, Failed to extract content from the website: {url}") ++ ++ except InvalidCSSSelectorError as e: ++ raise ValueError(str(e)) + except Exception as e: +- if not hasattr(e, "msg"): +- e.msg = str(e) +- # print(f"{Fore.RED}{self.tag_format('ERROR')} {self.log_icons['ERROR']} Failed to crawl {cache_context.display_url[:URL_LOG_SHORTEN_LENGTH]}... | {e.msg}{Style.RESET_ALL}") ++ raise ValueError(f"Process HTML, Failed to extract content from the website: {url}, error: {str(e)}") ++ ++ # Extract results ++ markdown_v2 = result.get("markdown_v2", None) ++ cleaned_html = sanitize_input_encode(result.get("cleaned_html", "")) ++ markdown = sanitize_input_encode(result.get("markdown", "")) ++ fit_markdown = sanitize_input_encode(result.get("fit_markdown", "")) ++ fit_html = sanitize_input_encode(result.get("fit_html", "")) ++ media = result.get("media", []) ++ links = result.get("links", []) ++ metadata = result.get("metadata", {}) ++ ++ # Log processing completion ++ self.logger.info( ++ message="Processed {url:.50}... | Time: {timing}ms", ++ tag="SCRAPE", ++ params={ ++ "url": _url, ++ "timing": int((time.perf_counter() - t1) * 1000) ++ } ++ ) ++ ++ # Handle content extraction if needed ++ if (extracted_content is None and ++ config.extraction_strategy and ++ config.chunking_strategy and ++ not isinstance(config.extraction_strategy, NoExtractionStrategy)): + +- self.logger.error_status( +- # url=cache_context.display_url, +- url=url, +- error=create_box_message(e.msg, type = "error"), +- tag="ERROR" +- ) +- return CrawlResult( +- url=url, +- html="", +- success=False, +- error_message=e.msg ++ t1 = time.perf_counter() ++ ++ # Handle different extraction strategy types ++ if isinstance(config.extraction_strategy, (JsonCssExtractionStrategy, JsonCssExtractionStrategy)): ++ config.extraction_strategy.verbose = verbose ++ extracted_content = config.extraction_strategy.run(url, [html]) ++ extracted_content = json.dumps(extracted_content, indent=4, default=str, ensure_ascii=False) ++ else: ++ sections = config.chunking_strategy.chunk(markdown) ++ extracted_content = config.extraction_strategy.run(url, sections) ++ extracted_content = json.dumps(extracted_content, indent=4, default=str, ensure_ascii=False) ++ ++ # Log extraction completion ++ self.logger.info( ++ message="Completed for {url:.50}... | Time: {timing}s", ++ tag="EXTRACT", ++ params={ ++ "url": _url, ++ "timing": time.perf_counter() - t1 ++ } + ) + +- async def arun_many( +- self, +- urls: List[str], +- word_count_threshold=MIN_WORD_THRESHOLD, +- extraction_strategy: ExtractionStrategy = None, +- chunking_strategy: ChunkingStrategy = RegexChunking(), +- content_filter: RelevantContentFilter = None, +- cache_mode: Optional[CacheMode] = None, +- # Deprecated parameters +- bypass_cache: bool = False, +- css_selector: str = None, +- screenshot: bool = False, +- pdf: bool = False, +- user_agent: str = None, +- verbose=True, +- **kwargs, +- ) -> List[CrawlResult]: +- """ +- Runs the crawler for multiple URLs concurrently. ++ # Handle screenshot and PDF data ++ screenshot_data = None if not screenshot else screenshot ++ pdf_data = None if not pdf_data else pdf_data ++ ++ # Apply HTML formatting if requested ++ if config.prettiify: ++ cleaned_html = fast_format_html(cleaned_html) ++ ++ # Return complete crawl result ++ return CrawlResult( ++ url=url, ++ html=html, ++ cleaned_html=cleaned_html, ++ markdown_v2=markdown_v2, ++ markdown=markdown, ++ fit_markdown=fit_markdown, ++ fit_html=fit_html, ++ media=media, ++ links=links, ++ metadata=metadata, ++ screenshot=screenshot_data, ++ pdf=pdf_data, ++ extracted_content=extracted_content, ++ success=True, ++ error_message="", ++ ) + +- Migration from legacy parameters: ++ async def arun_many( ++ self, ++ urls: List[str], ++ config: Optional[CrawlerRunConfig] = None, ++ # Legacy parameters maintained for backwards compatibility ++ word_count_threshold=MIN_WORD_THRESHOLD, ++ extraction_strategy: ExtractionStrategy = None, ++ chunking_strategy: ChunkingStrategy = RegexChunking(), ++ content_filter: RelevantContentFilter = None, ++ cache_mode: Optional[CacheMode] = None, ++ bypass_cache: bool = False, ++ css_selector: str = None, ++ screenshot: bool = False, ++ pdf: bool = False, ++ user_agent: str = None, ++ verbose=True, ++ **kwargs, ++ ) -> List[CrawlResult]: ++ """ ++ Runs the crawler for multiple URLs concurrently. ++ ++ Migration Guide: + Old way (deprecated): +- results = await crawler.arun_many(urls, bypass_cache=True) ++ results = await crawler.arun_many( ++ urls, ++ word_count_threshold=200, ++ screenshot=True, ++ ... ++ ) + +- New way: +- results = await crawler.arun_many(urls, cache_mode=CacheMode.BYPASS) +- +- Args: +- urls: List of URLs to crawl +- cache_mode: Cache behavior control (recommended) +- [other parameters same as arun()] +- +- Returns: +- List[CrawlResult]: Results for each URL +- """ +- if bypass_cache: +- if kwargs.get("warning", True): +- warnings.warn( +- "'bypass_cache' is deprecated and will be removed in version X.X.X. " +- "Use 'cache_mode=CacheMode.BYPASS' instead. " +- "Pass warning=False to suppress this warning.", +- DeprecationWarning, +- stacklevel=2 ++ New way (recommended): ++ config = CrawlerRunConfig( ++ word_count_threshold=200, ++ screenshot=True, ++ ... + ) +- if cache_mode is None: +- cache_mode = CacheMode.BYPASS +- +- semaphore_count = kwargs.get('semaphore_count', 10) +- semaphore = asyncio.Semaphore(semaphore_count) ++ results = await crawler.arun_many(urls, crawler_config=config) + +- async def crawl_with_semaphore(url): +- domain = urlparse(url).netloc +- current_time = time.time() +- +- # print(f"{Fore.LIGHTBLACK_EX}{self.tag_format('PARALLEL')} Started task for {url[:50]}...{Style.RESET_ALL}") +- self.logger.debug( +- message="Started task for {url:.50}...", +- tag="PARALLEL", +- params={"url": url} +- ) +- +- # Get delay settings from kwargs or use defaults +- mean_delay = kwargs.get('mean_delay', 0.1) # 0.5 seconds default mean delay +- max_range = kwargs.get('max_range', 0.3) # 1 seconds default max additional delay +- +- # Check if we need to wait +- if domain in self._domain_last_hit: +- time_since_last = current_time - self._domain_last_hit[domain] +- if time_since_last < mean_delay: +- delay = mean_delay + random.uniform(0, max_range) +- await asyncio.sleep(delay) ++ Args: ++ urls: List of URLs to crawl ++ crawler_config: Configuration object controlling crawl behavior for all URLs ++ [other parameters maintained for backwards compatibility] + +- # Update last hit time +- self._domain_last_hit[domain] = current_time +- +- async with semaphore: +- return await self.arun( +- url, +- word_count_threshold=word_count_threshold, +- extraction_strategy=extraction_strategy, +- chunking_strategy=chunking_strategy, +- content_filter=content_filter, +- cache_mode=cache_mode, +- css_selector=css_selector, +- screenshot=screenshot, +- user_agent=user_agent, +- verbose=verbose, +- **kwargs, +- ) ++ Returns: ++ List[CrawlResult]: Results for each URL ++ """ ++ crawler_config = config ++ # Handle configuration ++ if crawler_config is not None: ++ if any(param is not None for param in [ ++ word_count_threshold, extraction_strategy, chunking_strategy, ++ content_filter, cache_mode, css_selector, screenshot, pdf ++ ]): ++ self.logger.warning( ++ message="Both crawler_config and legacy parameters provided. crawler_config will take precedence.", ++ tag="WARNING" ++ ) ++ config = crawler_config ++ else: ++ # Merge all parameters into a single kwargs dict for config creation ++ config_kwargs = { ++ "word_count_threshold": word_count_threshold, ++ "extraction_strategy": extraction_strategy, ++ "chunking_strategy": chunking_strategy, ++ "content_filter": content_filter, ++ "cache_mode": cache_mode, ++ "bypass_cache": bypass_cache, ++ "css_selector": css_selector, ++ "screenshot": screenshot, ++ "pdf": pdf, ++ "verbose": verbose, ++ **kwargs ++ } ++ config = CrawlerRunConfig.from_kwargs(config_kwargs) ++ ++ if bypass_cache: ++ if kwargs.get("warning", True): ++ warnings.warn( ++ "'bypass_cache' is deprecated and will be removed in version 0.5.0. " ++ "Use 'cache_mode=CacheMode.BYPASS' instead. " ++ "Pass warning=False to suppress this warning.", ++ DeprecationWarning, ++ stacklevel=2 ++ ) ++ if config.cache_mode is None: ++ config.cache_mode = CacheMode.BYPASS + +- # Print start message +- # print(f"{Fore.CYAN}{self.tag_format('INIT')} {self.log_icons['INIT']} Starting concurrent crawling for {len(urls)} URLs...{Style.RESET_ALL}") +- self.logger.info( +- message="Starting concurrent crawling for {count} URLs...", +- tag="INIT", +- params={"count": len(urls)} +- ) +- start_time = time.perf_counter() +- tasks = [crawl_with_semaphore(url) for url in urls] +- results = await asyncio.gather(*tasks, return_exceptions=True) +- end_time = time.perf_counter() +- # print(f"{Fore.YELLOW}{self.tag_format('COMPLETE')} {self.log_icons['COMPLETE']} Concurrent crawling completed for {len(urls)} URLs | Total time: {end_time - start_time:.2f}s{Style.RESET_ALL}") +- self.logger.success( +- message="Concurrent crawling completed for {count} URLs | " + Fore.YELLOW + " Total time: {timing}" + Style.RESET_ALL, +- tag="COMPLETE", +- params={ +- "count": len(urls), +- "timing": f"{end_time - start_time:.2f}s" +- }, +- colors={"timing": Fore.YELLOW} +- ) +- return [result if not isinstance(result, Exception) else str(result) for result in results] ++ semaphore_count = config.semaphore_count or 5 ++ semaphore = asyncio.Semaphore(semaphore_count) + ++ async def crawl_with_semaphore(url): ++ # Handle rate limiting per domain ++ domain = urlparse(url).netloc ++ current_time = time.time() ++ ++ self.logger.debug( ++ message="Started task for {url:.50}...", ++ tag="PARALLEL", ++ params={"url": url} ++ ) + +- async def aprocess_html( +- self, +- url: str, +- html: str, +- extracted_content: str, +- word_count_threshold: int, +- extraction_strategy: ExtractionStrategy, +- chunking_strategy: ChunkingStrategy, +- content_filter: RelevantContentFilter, +- css_selector: str, +- screenshot: str, +- verbose: bool, +- **kwargs, +- ) -> CrawlResult: +- # Extract content from HTML +- try: +- _url = url if not kwargs.get("is_raw_html", False) else "Raw HTML" +- t1 = time.perf_counter() +- scrapping_strategy = WebScrapingStrategy( +- logger=self.logger, +- ) +- # result = await scrapping_strategy.ascrap( +- result = scrapping_strategy.scrap( +- url, +- html, +- word_count_threshold=word_count_threshold, +- css_selector=css_selector, +- only_text=kwargs.pop("only_text", False), +- image_description_min_word_threshold=kwargs.pop( +- "image_description_min_word_threshold", IMAGE_DESCRIPTION_MIN_WORD_THRESHOLD +- ), +- content_filter = content_filter, +- **kwargs, +- ) ++ # Get delay settings from config ++ mean_delay = config.mean_delay ++ max_range = config.max_range ++ ++ # Apply rate limiting ++ if domain in self._domain_last_hit: ++ time_since_last = current_time - self._domain_last_hit[domain] ++ if time_since_last < mean_delay: ++ delay = mean_delay + random.uniform(0, max_range) ++ await asyncio.sleep(delay) ++ ++ self._domain_last_hit[domain] = current_time + +- if result is None: +- raise ValueError(f"Process HTML, Failed to extract content from the website: {url}") +- except InvalidCSSSelectorError as e: +- raise ValueError(str(e)) +- except Exception as e: +- raise ValueError(f"Process HTML, Failed to extract content from the website: {url}, error: {str(e)}") ++ async with semaphore: ++ return await self.arun( ++ url, ++ crawler_config=config, # Pass the entire config object ++ user_agent=user_agent # Maintain user_agent override capability ++ ) + +- markdown_v2: MarkdownGenerationResult = result.get("markdown_v2", None) +- +- cleaned_html = sanitize_input_encode(result.get("cleaned_html", "")) +- markdown = sanitize_input_encode(result.get("markdown", "")) +- fit_markdown = sanitize_input_encode(result.get("fit_markdown", "")) +- fit_html = sanitize_input_encode(result.get("fit_html", "")) +- media = result.get("media", []) +- links = result.get("links", []) +- metadata = result.get("metadata", {}) +- +- # if verbose: +- # print(f"{Fore.MAGENTA}{self.tag_format('SCRAPE')} {self.log_icons['SCRAPE']} Processed {_url[:URL_LOG_SHORTEN_LENGTH]}...{Style.RESET_ALL} | Time: {int((time.perf_counter() - t1) * 1000)}ms") +- self.logger.info( +- message="Processed {url:.50}... | Time: {timing}ms", +- tag="SCRAPE", +- params={ +- "url": _url, +- "timing": int((time.perf_counter() - t1) * 1000) +- } +- ) ++ # Log start of concurrent crawling ++ self.logger.info( ++ message="Starting concurrent crawling for {count} URLs...", ++ tag="INIT", ++ params={"count": len(urls)} ++ ) + ++ # Execute concurrent crawls ++ start_time = time.perf_counter() ++ tasks = [crawl_with_semaphore(url) for url in urls] ++ results = await asyncio.gather(*tasks, return_exceptions=True) ++ end_time = time.perf_counter() + +- if extracted_content is None and extraction_strategy and chunking_strategy and not isinstance(extraction_strategy, NoExtractionStrategy): +- t1 = time.perf_counter() +- # Check if extraction strategy is type of JsonCssExtractionStrategy +- if isinstance(extraction_strategy, JsonCssExtractionStrategy) or isinstance(extraction_strategy, JsonCssExtractionStrategy): +- extraction_strategy.verbose = verbose +- extracted_content = extraction_strategy.run(url, [html]) +- extracted_content = json.dumps(extracted_content, indent=4, default=str, ensure_ascii=False) +- else: +- sections = chunking_strategy.chunk(markdown) +- extracted_content = extraction_strategy.run(url, sections) +- extracted_content = json.dumps(extracted_content, indent=4, default=str, ensure_ascii=False) +- # if verbose: +- # print(f"{Fore.YELLOW}{self.tag_format('EXTRACT')} {self.log_icons['EXTRACT']} Completed for {_url[:URL_LOG_SHORTEN_LENGTH]}...{Style.RESET_ALL} | Time: {time.perf_counter() - t1:.2f}s{Style.RESET_ALL}") +- self.logger.info( +- message="Completed for {url:.50}... | Time: {timing}s", +- tag="EXTRACT", ++ # Log completion ++ self.logger.success( ++ message="Concurrent crawling completed for {count} URLs | Total time: {timing}", ++ tag="COMPLETE", + params={ +- "url": _url, +- "timing": time.perf_counter() - t1 ++ "count": len(urls), ++ "timing": f"{end_time - start_time:.2f}s" ++ }, ++ colors={ ++ "timing": Fore.YELLOW + } + ) + +- screenshot = None if not screenshot else screenshot +- pdf_data = kwargs.get("pdf_data", None) +- +- +- if kwargs.get("prettiify", False): +- cleaned_html = fast_format_html(cleaned_html) +- +- return CrawlResult( +- url=url, +- html=html, +- cleaned_html=cleaned_html, +- markdown_v2=markdown_v2, +- markdown=markdown, +- fit_markdown=fit_markdown, +- fit_html= fit_html, +- media=media, +- links=links, +- metadata=metadata, +- screenshot=screenshot, +- pdf=pdf_data, +- extracted_content=extracted_content, +- success=True, +- error_message="", +- ) ++ return [result if not isinstance(result, Exception) else str(result) for result in results] + + async def aclear_cache(self): + """Clear the cache database.""" +diff --git a/crawl4ai/config.py b/crawl4ai/config.py +index e17ff34..7c8a931 100644 +--- a/crawl4ai/config.py ++++ b/crawl4ai/config.py +@@ -57,4 +57,6 @@ MAX_METRICS_HISTORY = 1000 + NEED_MIGRATION = True + URL_LOG_SHORTEN_LENGTH = 30 + SHOW_DEPRECATION_WARNINGS = True +-SCREENSHOT_HEIGHT_TRESHOLD = 10000 +\ No newline at end of file ++SCREENSHOT_HEIGHT_TRESHOLD = 10000 ++PAGE_TIMEOUT=60000 ++DOWNLOAD_PAGE_TIMEOUT=60000 +\ No newline at end of file +diff --git a/crawl4ai/utils.py b/crawl4ai/utils.py +index 8a12ff0..7ecc22d 100644 +--- a/crawl4ai/utils.py ++++ b/crawl4ai/utils.py +@@ -29,7 +29,7 @@ class InvalidCSSSelectorError(Exception): + def create_box_message( + message: str, + type: str = "info", +- width: int = 80, ++ width: int = 120, + add_newlines: bool = True, + double_line: bool = False + ) -> str: +@@ -1223,7 +1223,8 @@ def ensure_content_dirs(base_path: str) -> Dict[str, str]: + 'cleaned': 'cleaned_html', + 'markdown': 'markdown_content', + 'extracted': 'extracted_content', +- 'screenshots': 'screenshots' ++ 'screenshots': 'screenshots', ++ 'screenshot': 'screenshots' + } + + content_paths = {} +@@ -1232,4 +1233,60 @@ def ensure_content_dirs(base_path: str) -> Dict[str, str]: + os.makedirs(path, exist_ok=True) + content_paths[key] = path + +- return content_paths +\ No newline at end of file ++ return content_paths ++ ++def get_error_context(exc_info, context_lines: int = 5): ++ """ ++ Extract error context with more reliable line number tracking. ++ ++ Args: ++ exc_info: The exception info from sys.exc_info() ++ context_lines: Number of lines to show before and after the error ++ ++ Returns: ++ dict: Error context information ++ """ ++ import traceback ++ import linecache ++ import os ++ ++ # Get the full traceback ++ tb = traceback.extract_tb(exc_info[2]) ++ ++ # Get the last frame (where the error occurred) ++ last_frame = tb[-1] ++ filename = last_frame.filename ++ line_no = last_frame.lineno ++ func_name = last_frame.name ++ ++ # Get the source code context using linecache ++ # This is more reliable than inspect.getsourcelines ++ context_start = max(1, line_no - context_lines) ++ context_end = line_no + context_lines + 1 ++ ++ # Build the context lines with line numbers ++ context_lines = [] ++ for i in range(context_start, context_end): ++ line = linecache.getline(filename, i) ++ if line: ++ # Remove any trailing whitespace/newlines and add the pointer for error line ++ line = line.rstrip() ++ pointer = 'โ†’' if i == line_no else ' ' ++ context_lines.append(f"{i:4d} {pointer} {line}") ++ ++ # Join the lines with newlines ++ code_context = '\n'.join(context_lines) ++ ++ # Get relative path for cleaner output ++ try: ++ rel_path = os.path.relpath(filename) ++ except ValueError: ++ # Fallback if relpath fails (can happen on Windows with different drives) ++ rel_path = filename ++ ++ return { ++ "filename": rel_path, ++ "line_no": line_no, ++ "function": func_name, ++ "code_context": code_context ++ } +\ No newline at end of file +diff --git a/docs/md_v2/basic/cache-modes.md b/docs/md_v2/basic/cache-modes.md +index 04a4f21..01cfe34 100644 +--- a/docs/md_v2/basic/cache-modes.md ++++ b/docs/md_v2/basic/cache-modes.md +@@ -1,7 +1,7 @@ + # Crawl4AI Cache System and Migration Guide + + ## Overview +-Starting from version X.X.X, Crawl4AI introduces a new caching system that replaces the old boolean flags with a more intuitive `CacheMode` enum. This change simplifies cache control and makes the behavior more predictable. ++Starting from version 0.5.0, Crawl4AI introduces a new caching system that replaces the old boolean flags with a more intuitive `CacheMode` enum. This change simplifies cache control and makes the behavior more predictable. + + ## Old vs New Approach + diff --git a/crawl4ai/__init__.py b/crawl4ai/__init__.py index cee7c25b..d297dfca 100644 --- a/crawl4ai/__init__.py +++ b/crawl4ai/__init__.py @@ -1,7 +1,11 @@ # __init__.py from .async_webcrawler import AsyncWebCrawler, CacheMode - +from .async_configs import BrowserConfig, CrawlerRunConfig +from .extraction_strategy import ExtractionStrategy, LLMExtractionStrategy, CosineStrategy, JsonCssExtractionStrategy +from .chunking_strategy import ChunkingStrategy, RegexChunking +from .markdown_generation_strategy import DefaultMarkdownGenerator +from .content_filter_strategy import PruningContentFilter, BM25ContentFilter from .models import CrawlResult from .__version__ import __version__ @@ -9,6 +13,17 @@ __all__ = [ "AsyncWebCrawler", "CrawlResult", "CacheMode", + 'BrowserConfig', + 'CrawlerRunConfig', + 'ExtractionStrategy', + 'LLMExtractionStrategy', + 'CosineStrategy', + 'JsonCssExtractionStrategy', + 'ChunkingStrategy', + 'RegexChunking', + 'DefaultMarkdownGenerator', + 'PruningContentFilter', + 'BM25ContentFilter', ] def is_sync_version_installed(): diff --git a/crawl4ai/__version__.py b/crawl4ai/__version__.py index 80861132..ee26a705 100644 --- a/crawl4ai/__version__.py +++ b/crawl4ai/__version__.py @@ -1,2 +1,2 @@ # crawl4ai/_version.py -__version__ = "0.4.1" +__version__ = "0.4.2" diff --git a/crawl4ai/async_configs.py b/crawl4ai/async_configs.py new file mode 100644 index 00000000..41574fe6 --- /dev/null +++ b/crawl4ai/async_configs.py @@ -0,0 +1,402 @@ +from .config import ( + MIN_WORD_THRESHOLD, + IMAGE_DESCRIPTION_MIN_WORD_THRESHOLD, + SCREENSHOT_HEIGHT_TRESHOLD, + PAGE_TIMEOUT +) +from .user_agent_generator import UserAgentGenerator +from .extraction_strategy import ExtractionStrategy +from .chunking_strategy import ChunkingStrategy + +class BrowserConfig: + """ + Configuration class for setting up a browser instance and its context in AsyncPlaywrightCrawlerStrategy. + + This class centralizes all parameters that affect browser and context creation. Instead of passing + scattered keyword arguments, users can instantiate and modify this configuration object. The crawler + code will then reference these settings to initialize the browser in a consistent, documented manner. + + Attributes: + browser_type (str): The type of browser to launch. Supported values: "chromium", "firefox", "webkit". + Default: "chromium". + headless (bool): Whether to run the browser in headless mode (no visible GUI). + Default: True. + use_managed_browser (bool): Launch the browser using a managed approach (e.g., via CDP), allowing + advanced manipulation. Default: False. + use_persistent_context (bool): Use a persistent browser context (like a persistent profile). + Automatically sets use_managed_browser=True. Default: False. + user_data_dir (str or None): Path to a user data directory for persistent sessions. If None, a + temporary directory may be used. Default: None. + chrome_channel (str): The Chrome channel to launch (e.g., "chrome", "msedge"). Only applies if browser_type + is "chromium". Default: "chrome". + proxy (str or None): Proxy server URL (e.g., "http://username:password@proxy:port"). If None, no proxy is used. + Default: None. + proxy_config (dict or None): Detailed proxy configuration, e.g. {"server": "...", "username": "..."}. + If None, no additional proxy config. Default: None. + viewport_width (int): Default viewport width for pages. Default: 1920. + viewport_height (int): Default viewport height for pages. Default: 1080. + verbose (bool): Enable verbose logging. + Default: True. + accept_downloads (bool): Whether to allow file downloads. If True, requires a downloads_path. + Default: False. + downloads_path (str or None): Directory to store downloaded files. If None and accept_downloads is True, + a default path will be created. Default: None. + storage_state (str or dict or None): Path or object describing storage state (cookies, localStorage). + Default: None. + ignore_https_errors (bool): Ignore HTTPS certificate errors. Default: True. + java_script_enabled (bool): Enable JavaScript execution in pages. Default: True. + cookies (list): List of cookies to add to the browser context. Each cookie is a dict with fields like + {"name": "...", "value": "...", "url": "..."}. + Default: []. + headers (dict): Extra HTTP headers to apply to all requests in this context. + Default: {}. + user_agent (str): Custom User-Agent string to use. Default: "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) " + "AppleWebKit/537.36 (KHTML, like Gecko) Chrome/116.0.0.0 Safari/537.36". + user_agent_mode (str or None): Mode for generating the user agent (e.g., "random"). If None, use the provided + user_agent as-is. Default: None. + user_agent_generator_config (dict or None): Configuration for user agent generation if user_agent_mode is set. + Default: None. + text_only (bool): If True, disables images and other rich content for potentially faster load times. + Default: False. + light_mode (bool): Disables certain background features for performance gains. Default: False. + extra_args (list): Additional command-line arguments passed to the browser. + Default: []. + """ + + def __init__( + self, + browser_type: str = "chromium", + headless: bool = True, + use_managed_browser: bool = False, + use_persistent_context: bool = False, + user_data_dir: str = None, + chrome_channel: str = "chrome", + proxy: str = None, + proxy_config: dict = None, + viewport_width: int = 1920, + viewport_height: int = 1080, + accept_downloads: bool = False, + downloads_path: str = None, + storage_state=None, + ignore_https_errors: bool = True, + java_script_enabled: bool = True, + sleep_on_close: bool = False, + verbose: bool = True, + cookies: list = None, + headers: dict = None, + user_agent: str = ( + "Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:109.0) AppleWebKit/537.36 " + "(KHTML, like Gecko) Chrome/116.0.5845.187 Safari/604.1 Edg/117.0.2045.47" + ), + user_agent_mode: str = None, + user_agent_generator_config: dict = None, + text_only: bool = False, + light_mode: bool = False, + extra_args: list = None, + ): + self.browser_type = browser_type + self.headless = headless + self.use_managed_browser = use_managed_browser + self.use_persistent_context = use_persistent_context + self.user_data_dir = user_data_dir + if self.browser_type == "chromium": + self.chrome_channel = "chrome" + elif self.browser_type == "firefox": + self.chrome_channel = "firefox" + elif self.browser_type == "webkit": + self.chrome_channel = "webkit" + else: + self.chrome_channel = chrome_channel or "chrome" + self.proxy = proxy + self.proxy_config = proxy_config + self.viewport_width = viewport_width + self.viewport_height = viewport_height + self.accept_downloads = accept_downloads + self.downloads_path = downloads_path + self.storage_state = storage_state + self.ignore_https_errors = ignore_https_errors + self.java_script_enabled = java_script_enabled + self.cookies = cookies if cookies is not None else [] + self.headers = headers if headers is not None else {} + self.user_agent = user_agent + self.user_agent_mode = user_agent_mode + self.user_agent_generator_config = user_agent_generator_config + self.text_only = text_only + self.light_mode = light_mode + self.extra_args = extra_args if extra_args is not None else [] + self.sleep_on_close = sleep_on_close + self.verbose = verbose + + user_agenr_generator = UserAgentGenerator() + if self.user_agent_mode != "random": + self.user_agent = user_agenr_generator.generate( + **(self.user_agent_generator_config or {}) + ) + self.browser_hint = user_agenr_generator.generate_client_hints(self.user_agent) + self.headers.setdefault("sec-ch-ua", self.browser_hint) + + # If persistent context is requested, ensure managed browser is enabled + if self.use_persistent_context: + self.use_managed_browser = True + + @staticmethod + def from_kwargs(kwargs: dict) -> "BrowserConfig": + return BrowserConfig( + browser_type=kwargs.get("browser_type", "chromium"), + headless=kwargs.get("headless", True), + use_managed_browser=kwargs.get("use_managed_browser", False), + use_persistent_context=kwargs.get("use_persistent_context", False), + user_data_dir=kwargs.get("user_data_dir"), + chrome_channel=kwargs.get("chrome_channel", "chrome"), + proxy=kwargs.get("proxy"), + proxy_config=kwargs.get("proxy_config"), + viewport_width=kwargs.get("viewport_width", 1920), + viewport_height=kwargs.get("viewport_height", 1080), + accept_downloads=kwargs.get("accept_downloads", False), + downloads_path=kwargs.get("downloads_path"), + storage_state=kwargs.get("storage_state"), + ignore_https_errors=kwargs.get("ignore_https_errors", True), + java_script_enabled=kwargs.get("java_script_enabled", True), + cookies=kwargs.get("cookies", []), + headers=kwargs.get("headers", {}), + user_agent=kwargs.get("user_agent", + "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) " + "AppleWebKit/537.36 (KHTML, like Gecko) Chrome/116.0.0.0 Safari/537.36" + ), + user_agent_mode=kwargs.get("user_agent_mode"), + user_agent_generator_config=kwargs.get("user_agent_generator_config"), + text_only=kwargs.get("text_only", False), + light_mode=kwargs.get("light_mode", False), + extra_args=kwargs.get("extra_args", []) + ) + + +class CrawlerRunConfig: + """ + Configuration class for controlling how the crawler runs each crawl operation. + This includes parameters for content extraction, page manipulation, waiting conditions, + caching, and other runtime behaviors. + + This centralizes parameters that were previously scattered as kwargs to `arun()` and related methods. + By using this class, you have a single place to understand and adjust the crawling options. + + Attributes: + word_count_threshold (int): Minimum word count threshold before processing content. + Default: MIN_WORD_THRESHOLD (typically 200). + extraction_strategy (ExtractionStrategy or None): Strategy to extract structured data from crawled pages. + Default: None (NoExtractionStrategy is used if None). + chunking_strategy (ChunkingStrategy): Strategy to chunk content before extraction. + Default: RegexChunking(). + content_filter (RelevantContentFilter or None): Optional filter to prune irrelevant content. + Default: None. + cache_mode (CacheMode or None): Defines how caching is handled. + If None, defaults to CacheMode.ENABLED internally. + Default: None. + session_id (str or None): Optional session ID to persist the browser context and the created + page instance. If the ID already exists, the crawler does not + create a new page and uses the current page to preserve the state; + if not, it creates a new page and context then stores it in + memory with the given session ID. + bypass_cache (bool): Legacy parameter, if True acts like CacheMode.BYPASS. + Default: False. + disable_cache (bool): Legacy parameter, if True acts like CacheMode.DISABLED. + Default: False. + no_cache_read (bool): Legacy parameter, if True acts like CacheMode.WRITE_ONLY. + Default: False. + no_cache_write (bool): Legacy parameter, if True acts like CacheMode.READ_ONLY. + Default: False. + css_selector (str or None): CSS selector to extract a specific portion of the page. + Default: None. + screenshot (bool): Whether to take a screenshot after crawling. + Default: False. + pdf (bool): Whether to generate a PDF of the page. + Default: False. + verbose (bool): Enable verbose logging. + Default: True. + only_text (bool): If True, attempt to extract text-only content where applicable. + Default: False. + image_description_min_word_threshold (int): Minimum words for image description extraction. + Default: IMAGE_DESCRIPTION_MIN_WORD_THRESHOLD (e.g., 50). + prettiify (bool): If True, apply `fast_format_html` to produce prettified HTML output. + Default: False. + js_code (str or list of str or None): JavaScript code/snippets to run on the page. + Default: None. + wait_for (str or None): A CSS selector or JS condition to wait for before extracting content. + Default: None. + js_only (bool): If True, indicates subsequent calls are JS-driven updates, not full page loads. + Default: False. + wait_until (str): The condition to wait for when navigating, e.g. "domcontentloaded". + Default: "domcontentloaded". + page_timeout (int): Timeout in ms for page operations like navigation. + Default: 60000 (60 seconds). + ignore_body_visibility (bool): If True, ignore whether the body is visible before proceeding. + Default: True. + wait_for_images (bool): If True, wait for images to load before extracting content. + Default: True. + adjust_viewport_to_content (bool): If True, adjust viewport according to the page content dimensions. + Default: False. + scan_full_page (bool): If True, scroll through the entire page to load all content. + Default: False. + scroll_delay (float): Delay in seconds between scroll steps if scan_full_page is True. + Default: 0.2. + process_iframes (bool): If True, attempts to process and inline iframe content. + Default: False. + remove_overlay_elements (bool): If True, remove overlays/popups before extracting HTML. + Default: False. + delay_before_return_html (float): Delay in seconds before retrieving final HTML. + Default: 0.1. + log_console (bool): If True, log console messages from the page. + Default: False. + simulate_user (bool): If True, simulate user interactions (mouse moves, clicks) for anti-bot measures. + Default: False. + override_navigator (bool): If True, overrides navigator properties for more human-like behavior. + Default: False. + magic (bool): If True, attempts automatic handling of overlays/popups. + Default: False. + screenshot_wait_for (float or None): Additional wait time before taking a screenshot. + Default: None. + screenshot_height_threshold (int): Threshold for page height to decide screenshot strategy. + Default: SCREENSHOT_HEIGHT_TRESHOLD (from config, e.g. 20000). + mean_delay (float): Mean base delay between requests when calling arun_many. + Default: 0.1. + max_range (float): Max random additional delay range for requests in arun_many. + Default: 0.3. + # session_id and semaphore_count might be set at runtime, not needed as defaults here. + """ + + def __init__( + self, + word_count_threshold: int = MIN_WORD_THRESHOLD , + extraction_strategy : ExtractionStrategy=None, # Will default to NoExtractionStrategy if None + chunking_strategy : ChunkingStrategy= None, # Will default to RegexChunking if None + content_filter=None, + cache_mode=None, + session_id: str = None, + bypass_cache: bool = False, + disable_cache: bool = False, + no_cache_read: bool = False, + no_cache_write: bool = False, + css_selector: str = None, + screenshot: bool = False, + pdf: bool = False, + verbose: bool = True, + only_text: bool = False, + image_description_min_word_threshold: int = IMAGE_DESCRIPTION_MIN_WORD_THRESHOLD, + prettiify: bool = False, + js_code=None, + wait_for: str = None, + js_only: bool = False, + wait_until: str = "domcontentloaded", + page_timeout: int = PAGE_TIMEOUT, + ignore_body_visibility: bool = True, + wait_for_images: bool = True, + adjust_viewport_to_content: bool = False, + scan_full_page: bool = False, + scroll_delay: float = 0.2, + process_iframes: bool = False, + remove_overlay_elements: bool = False, + delay_before_return_html: float = 0.1, + log_console: bool = False, + simulate_user: bool = False, + override_navigator: bool = False, + magic: bool = False, + screenshot_wait_for: float = None, + screenshot_height_threshold: int = SCREENSHOT_HEIGHT_TRESHOLD, + mean_delay: float = 0.1, + max_range: float = 0.3, + semaphore_count: int = 5, + ): + self.word_count_threshold = word_count_threshold + self.extraction_strategy = extraction_strategy + self.chunking_strategy = chunking_strategy + self.content_filter = content_filter + self.cache_mode = cache_mode + self.session_id = session_id + self.bypass_cache = bypass_cache + self.disable_cache = disable_cache + self.no_cache_read = no_cache_read + self.no_cache_write = no_cache_write + self.css_selector = css_selector + self.screenshot = screenshot + self.pdf = pdf + self.verbose = verbose + self.only_text = only_text + self.image_description_min_word_threshold = image_description_min_word_threshold + self.prettiify = prettiify + self.js_code = js_code + self.wait_for = wait_for + self.js_only = js_only + self.wait_until = wait_until + self.page_timeout = page_timeout + self.ignore_body_visibility = ignore_body_visibility + self.wait_for_images = wait_for_images + self.adjust_viewport_to_content = adjust_viewport_to_content + self.scan_full_page = scan_full_page + self.scroll_delay = scroll_delay + self.process_iframes = process_iframes + self.remove_overlay_elements = remove_overlay_elements + self.delay_before_return_html = delay_before_return_html + self.log_console = log_console + self.simulate_user = simulate_user + self.override_navigator = override_navigator + self.magic = magic + self.screenshot_wait_for = screenshot_wait_for + self.screenshot_height_threshold = screenshot_height_threshold + self.mean_delay = mean_delay + self.max_range = max_range + self.semaphore_count = semaphore_count + + # Validate type of extraction strategy and chunking strategy if they are provided + if self.extraction_strategy is not None and not isinstance(self.extraction_strategy, ExtractionStrategy): + raise ValueError("extraction_strategy must be an instance of ExtractionStrategy") + if self.chunking_strategy is not None and not isinstance(self.chunking_strategy, ChunkingStrategy): + raise ValueError("chunking_strategy must be an instance of ChunkingStrategy") + + # Set default chunking strategy if None + if self.chunking_strategy is None: + from .chunking_strategy import RegexChunking + self.chunking_strategy = RegexChunking() + + + @staticmethod + def from_kwargs(kwargs: dict) -> "CrawlerRunConfig": + return CrawlerRunConfig( + word_count_threshold=kwargs.get("word_count_threshold", 200), + extraction_strategy=kwargs.get("extraction_strategy"), + chunking_strategy=kwargs.get("chunking_strategy"), + content_filter=kwargs.get("content_filter"), + cache_mode=kwargs.get("cache_mode"), + session_id=kwargs.get("session_id"), + bypass_cache=kwargs.get("bypass_cache", False), + disable_cache=kwargs.get("disable_cache", False), + no_cache_read=kwargs.get("no_cache_read", False), + no_cache_write=kwargs.get("no_cache_write", False), + css_selector=kwargs.get("css_selector"), + screenshot=kwargs.get("screenshot", False), + pdf=kwargs.get("pdf", False), + verbose=kwargs.get("verbose", True), + only_text=kwargs.get("only_text", False), + image_description_min_word_threshold=kwargs.get("image_description_min_word_threshold", IMAGE_DESCRIPTION_MIN_WORD_THRESHOLD), + prettiify=kwargs.get("prettiify", False), + js_code=kwargs.get("js_code"), # If not provided here, will default inside constructor + wait_for=kwargs.get("wait_for"), + js_only=kwargs.get("js_only", False), + wait_until=kwargs.get("wait_until", "domcontentloaded"), + page_timeout=kwargs.get("page_timeout", 60000), + ignore_body_visibility=kwargs.get("ignore_body_visibility", True), + adjust_viewport_to_content=kwargs.get("adjust_viewport_to_content", False), + scan_full_page=kwargs.get("scan_full_page", False), + scroll_delay=kwargs.get("scroll_delay", 0.2), + process_iframes=kwargs.get("process_iframes", False), + remove_overlay_elements=kwargs.get("remove_overlay_elements", False), + delay_before_return_html=kwargs.get("delay_before_return_html", 0.1), + log_console=kwargs.get("log_console", False), + simulate_user=kwargs.get("simulate_user", False), + override_navigator=kwargs.get("override_navigator", False), + magic=kwargs.get("magic", False), + screenshot_wait_for=kwargs.get("screenshot_wait_for"), + screenshot_height_threshold=kwargs.get("screenshot_height_threshold", 20000), + mean_delay=kwargs.get("mean_delay", 0.1), + max_range=kwargs.get("max_range", 0.3), + semaphore_count=kwargs.get("semaphore_count", 5) + ) diff --git a/crawl4ai/async_crawler_strategy.py b/crawl4ai/async_crawler_strategy.py index 5c706239..3f040e13 100644 --- a/crawl4ai/async_crawler_strategy.py +++ b/crawl4ai/async_crawler_strategy.py @@ -5,7 +5,7 @@ from abc import ABC, abstractmethod from typing import Callable, Dict, Any, List, Optional, Awaitable import os, sys, shutil import tempfile, subprocess -from playwright.async_api import async_playwright, Page, Browser, Error +from playwright.async_api import async_playwright, Page, Browser, Error, BrowserContext from playwright.async_api import TimeoutError as PlaywrightTimeoutError from io import BytesIO from PIL import Image, ImageDraw, ImageFont @@ -15,11 +15,19 @@ from pydantic import BaseModel import hashlib import json import uuid +from .js_snippet import load_js_script from .models import AsyncCrawlResponse -from .utils import create_box_message +from .utils import get_error_context from .user_agent_generator import UserAgentGenerator +from .config import SCREENSHOT_HEIGHT_TRESHOLD, DOWNLOAD_PAGE_TIMEOUT +from .async_configs import BrowserConfig, CrawlerRunConfig from playwright_stealth import StealthConfig, stealth_async + +from io import BytesIO +import base64 +from PIL import Image, ImageDraw, ImageFont + stealth_config = StealthConfig( webdriver=True, chrome_app=True, @@ -35,6 +43,27 @@ stealth_config = StealthConfig( media_codecs=True, ) +BROWSER_DISABLE_OPTIONS = [ + "--disable-background-networking", + "--disable-background-timer-throttling", + "--disable-backgrounding-occluded-windows", + "--disable-breakpad", + "--disable-client-side-phishing-detection", + "--disable-component-extensions-with-background-pages", + "--disable-default-apps", + "--disable-extensions", + "--disable-features=TranslateUI", + "--disable-hang-monitor", + "--disable-ipc-flooding-protection", + "--disable-popup-blocking", + "--disable-prompt-on-repost", + "--disable-sync", + "--force-color-profile=srgb", + "--metrics-recording-only", + "--no-first-run", + "--password-store=basic", + "--use-mock-keychain" +] class ManagedBrowser: def __init__(self, browser_type: str = "chromium", user_data_dir: Optional[str] = None, headless: bool = False, logger = None, host: str = "localhost", debugging_port: int = 9222): @@ -196,11 +225,225 @@ class ManagedBrowser: params={"error": str(e)} ) +class BrowserManager: + def __init__(self, browser_config: BrowserConfig, logger=None): + """ + Initialize the BrowserManager with a browser configuration. + + Args: + browser_config (BrowserConfig): Configuration object containing all browser settings + logger: Logger instance for recording events and errors + """ + self.config = browser_config + self.logger = logger + + # Browser state + self.browser = None + self.default_context = None + self.managed_browser = None + self.playwright = None + + # Session management + self.sessions = {} + self.session_ttl = 1800 # 30 minutes + + # Initialize ManagedBrowser if needed + if self.config.use_managed_browser: + self.managed_browser = ManagedBrowser( + browser_type=self.config.browser_type, + user_data_dir=self.config.user_data_dir, + headless=self.config.headless, + logger=self.logger + ) + + async def start(self): + """Start the browser instance and set up the default context.""" + if self.playwright is None: + from playwright.async_api import async_playwright + self.playwright = await async_playwright().start() + + if self.config.use_managed_browser: + cdp_url = await self.managed_browser.start() + self.browser = await self.playwright.chromium.connect_over_cdp(cdp_url) + contexts = self.browser.contexts + if contexts: + self.default_context = contexts[0] + else: + self.default_context = await self.browser.new_context( + viewport={"width": self.config.viewport_width, "height": self.config.viewport_height}, + storage_state=self.config.storage_state, + user_agent=self.config.headers.get("User-Agent", self.config.user_agent), + accept_downloads=self.config.accept_downloads, + ignore_https_errors=self.config.ignore_https_errors, + java_script_enabled=self.config.java_script_enabled + ) + await self.setup_context(self.default_context) + else: + browser_args = self._build_browser_args() + + # Launch appropriate browser type + if self.config.browser_type == "firefox": + self.browser = await self.playwright.firefox.launch(**browser_args) + elif self.config.browser_type == "webkit": + self.browser = await self.playwright.webkit.launch(**browser_args) + else: + self.browser = await self.playwright.chromium.launch(**browser_args) + + self.default_context = self.browser + + def _build_browser_args(self) -> dict: + """Build browser launch arguments from config.""" + args = [ + "--no-sandbox", + "--disable-dev-shm-usage", + "--no-first-run", + "--no-default-browser-check", + "--disable-infobars", + "--window-position=0,0", + "--ignore-certificate-errors", + "--ignore-certificate-errors-spki-list", + "--disable-blink-features=AutomationControlled", + "--window-position=400,0", + f"--window-size={self.config.viewport_width},{self.config.viewport_height}", + ] + + if self.config.light_mode: + args.extend(BROWSER_DISABLE_OPTIONS) + + if self.config.text_only: + args.extend(['--blink-settings=imagesEnabled=false', '--disable-remote-fonts']) + + if self.config.extra_args: + args.extend(self.config.extra_args) + + browser_args = { + "headless": self.config.headless, + "args": args + } + + if self.config.chrome_channel: + browser_args["channel"] = self.config.chrome_channel + + if self.config.accept_downloads: + browser_args["downloads_path"] = (self.config.downloads_path or + os.path.join(os.getcwd(), "downloads")) + os.makedirs(browser_args["downloads_path"], exist_ok=True) + + if self.config.proxy or self.config.proxy_config: + from playwright.async_api import ProxySettings + proxy_settings = ( + ProxySettings(server=self.config.proxy) if self.config.proxy else + ProxySettings( + server=self.config.proxy_config.get("server"), + username=self.config.proxy_config.get("username"), + password=self.config.proxy_config.get("password") + ) + ) + browser_args["proxy"] = proxy_settings + + return browser_args + + async def setup_context(self, context: BrowserContext, is_default=False): + """Set up a browser context with the configured options.""" + if self.config.headers: + await context.set_extra_http_headers(self.config.headers) + + if self.config.cookies: + await context.add_cookies(self.config.cookies) + + if self.config.storage_state: + await context.storage_state(path=None) + + if self.config.accept_downloads: + context.set_default_timeout(DOWNLOAD_PAGE_TIMEOUT) + context.set_default_navigation_timeout(DOWNLOAD_PAGE_TIMEOUT) + if self.config.downloads_path: + context._impl_obj._options["accept_downloads"] = True + context._impl_obj._options["downloads_path"] = self.config.downloads_path + + # Handle user agent and browser hints + if self.config.user_agent: + combined_headers = { + "User-Agent": self.config.user_agent, + "sec-ch-ua": self.config.browser_hint + } + combined_headers.update(self.config.headers) + await context.set_extra_http_headers(combined_headers) + + async def get_page(self, session_id: Optional[str], user_agent: str): + """Get a page for the given session ID, creating a new one if needed.""" + self._cleanup_expired_sessions() + + if session_id and session_id in self.sessions: + context, page, _ = self.sessions[session_id] + self.sessions[session_id] = (context, page, time.time()) + return page, context + + if self.config.use_managed_browser: + context = self.default_context + page = await context.new_page() + else: + context = await self.browser.new_context( + user_agent=user_agent, + viewport={"width": self.config.viewport_width, "height": self.config.viewport_height}, + proxy={"server": self.config.proxy} if self.config.proxy else None, + accept_downloads=self.config.accept_downloads, + storage_state=self.config.storage_state, + ignore_https_errors=self.config.ignore_https_errors + ) + await self.setup_context(context) + page = await context.new_page() + + if session_id: + self.sessions[session_id] = (context, page, time.time()) + + return page, context + + async def kill_session(self, session_id: str): + """Kill a browser session and clean up resources.""" + if session_id in self.sessions: + context, page, _ = self.sessions[session_id] + await page.close() + if not self.config.use_managed_browser: + await context.close() + del self.sessions[session_id] + + def _cleanup_expired_sessions(self): + """Clean up expired sessions based on TTL.""" + current_time = time.time() + expired_sessions = [ + sid for sid, (_, _, last_used) in self.sessions.items() + if current_time - last_used > self.session_ttl + ] + for sid in expired_sessions: + asyncio.create_task(self.kill_session(sid)) + + async def close(self): + """Close all browser resources and clean up.""" + if self.config.sleep_on_close: + await asyncio.sleep(0.5) + + session_ids = list(self.sessions.keys()) + for session_id in session_ids: + await self.kill_session(session_id) + + if self.browser: + await self.browser.close() + self.browser = None + + if self.managed_browser: + await asyncio.sleep(0.5) + await self.managed_browser.cleanup() + self.managed_browser = None + + if self.playwright: + await self.playwright.stop() + self.playwright = None class AsyncCrawlerStrategy(ABC): @abstractmethod async def crawl(self, url: str, **kwargs) -> AsyncCrawlResponse: - pass + pass # 4 + 3 @abstractmethod async def crawl_many(self, urls: List[str], **kwargs) -> List[AsyncCrawlResponse]: @@ -219,54 +462,24 @@ class AsyncCrawlerStrategy(ABC): pass class AsyncPlaywrightCrawlerStrategy(AsyncCrawlerStrategy): - def __init__(self, use_cached_html=False, js_code=None, logger = None, **kwargs): - self.text_only = kwargs.get("text_only", False) - self.light_mode = kwargs.get("light_mode", False) - self.logger = logger - self.use_cached_html = use_cached_html - self.viewport_width = kwargs.get("viewport_width", 800 if self.text_only else 1920) - self.viewport_height = kwargs.get("viewport_height", 600 if self.text_only else 1080) + def __init__(self, browser_config: BrowserConfig = None, logger = None, **kwargs): + """ + Initialize the AsyncPlaywrightCrawlerStrategy with a browser configuration. - if self.text_only: - self.extra_args = kwargs.get("extra_args", []) + [ - '--disable-images', - '--disable-javascript', - '--disable-gpu', - '--disable-software-rasterizer', - '--disable-dev-shm-usage' - ] - - self.user_agent = kwargs.get( - "user_agent", - # "Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:109.0) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/116.0.5845.187 Safari/604.1 Edg/117.0.2045.47" - "Mozilla/5.0 (Linux; Android 11; SM-G973F) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.120 Mobile Safari/537.36" - ) - user_agenr_generator = UserAgentGenerator() - if kwargs.get("user_agent_mode") == "random": - self.user_agent = user_agenr_generator.generate( - **kwargs.get("user_agent_generator_config", {}) - ) - self.proxy = kwargs.get("proxy") - self.proxy_config = kwargs.get("proxy_config") - self.headless = kwargs.get("headless", True) - self.browser_type = kwargs.get("browser_type", "chromium") - self.headers = kwargs.get("headers", {}) - self.browser_hint = user_agenr_generator.generate_client_hints(self.user_agent) - self.headers.setdefault("sec-ch-ua", self.browser_hint) - self.cookies = kwargs.get("cookies", []) - self.sessions = {} - self.session_ttl = 1800 - self.js_code = js_code - self.verbose = kwargs.get("verbose", False) - self.playwright = None - self.browser = None - self.sleep_on_close = kwargs.get("sleep_on_close", False) - self.use_managed_browser = kwargs.get("use_managed_browser", False) - self.user_data_dir = kwargs.get("user_data_dir", None) - self.use_persistent_context = kwargs.get("use_persistent_context", False) - self.chrome_channel = kwargs.get("chrome_channel", "chrome") - self.managed_browser = None - self.default_context = None + Args: + browser_config (BrowserConfig): Configuration object containing browser settings. + If None, will be created from kwargs for backwards compatibility. + logger: Logger instance for recording events and errors. + **kwargs: Additional arguments for backwards compatibility and extending functionality. + """ + # Initialize browser config, either from provided object or kwargs + self.browser_config = browser_config or BrowserConfig.from_kwargs(kwargs) + self.logger = logger + + # Initialize session management + self._downloaded_files = [] + + # Initialize hooks system self.hooks = { 'on_browser_created': None, 'on_user_agent_updated': None, @@ -276,14 +489,12 @@ class AsyncPlaywrightCrawlerStrategy(AsyncCrawlerStrategy): 'before_return_html': None, 'before_retrieve_html': None } - self.extra_args = kwargs.get("extra_args", []) - self.accept_downloads = kwargs.get("accept_downloads", False) - self.downloads_path = kwargs.get("downloads_path") - self._downloaded_files = [] # Track downloaded files for current crawl - if self.accept_downloads and not self.downloads_path: - self.downloads_path = os.path.join(os.getcwd(), "downloads") - os.makedirs(self.downloads_path, exist_ok=True) + # Initialize browser manager with config + self.browser_manager = BrowserManager( + browser_config=self.browser_config, + logger=self.logger + ) async def __aenter__(self): await self.start() @@ -293,183 +504,19 @@ class AsyncPlaywrightCrawlerStrategy(AsyncCrawlerStrategy): await self.close() async def start(self): - if self.playwright is None: - self.playwright = await async_playwright().start() - if self.browser is None: - if self.use_managed_browser: - # Use managed browser approach - self.managed_browser = ManagedBrowser( - browser_type=self.browser_type, - user_data_dir=self.user_data_dir, - headless=self.headless, - logger=self.logger - ) - cdp_url = await self.managed_browser.start() - self.browser = await self.playwright.chromium.connect_over_cdp(cdp_url) - - # Get the default context that maintains the user profile - contexts = self.browser.contexts - if contexts: - self.default_context = contexts[0] - else: - # If no default context exists, create one - self.default_context = await self.browser.new_context( - # viewport={"width": 1920, "height": 1080} - viewport={"width": self.viewport_width, "height": self.viewport_height} - ) - - # Set up the default context - if self.default_context: - await self.default_context.set_extra_http_headers(self.headers) - if self.cookies: - await self.default_context.add_cookies(self.cookies) - if self.accept_downloads: - await self.default_context.set_default_timeout(60000) - await self.default_context.set_default_navigation_timeout(60000) - self.default_context._impl_obj._options["accept_downloads"] = True - self.default_context._impl_obj._options["downloads_path"] = self.downloads_path - - if self.user_agent: - await self.default_context.set_extra_http_headers({ - "User-Agent": self.user_agent, - "sec-ch-ua": self.browser_hint, - # **self.headers - }) - else: - # Base browser arguments - browser_args = { - "headless": self.headless, - "args": [ - "--no-sandbox", - "--disable-dev-shm-usage", - "--no-first-run", - "--no-default-browser-check", - "--disable-infobars", - "--window-position=0,0", - "--ignore-certificate-errors", - "--ignore-certificate-errors-spki-list", - "--disable-blink-features=AutomationControlled", - "--window-position=400,0", - f"--window-size={self.viewport_width},{self.viewport_height}", - ] - } - - if self.light_mode: - browser_args["args"].extend([ - # "--disable-background-networking", - "--disable-background-timer-throttling", - "--disable-backgrounding-occluded-windows", - "--disable-breakpad", - "--disable-client-side-phishing-detection", - "--disable-component-extensions-with-background-pages", - "--disable-default-apps", - "--disable-extensions", - "--disable-features=TranslateUI", - "--disable-hang-monitor", - "--disable-ipc-flooding-protection", - "--disable-popup-blocking", - "--disable-prompt-on-repost", - "--disable-sync", - "--force-color-profile=srgb", - "--metrics-recording-only", - "--no-first-run", - "--password-store=basic", - "--use-mock-keychain" - ]) - - if self.text_only: - browser_args["args"].extend([ - '--blink-settings=imagesEnabled=false', - '--disable-remote-fonts' - ]) - - # Add channel if specified (try Chrome first) - if self.chrome_channel: - browser_args["channel"] = self.chrome_channel - - # Add extra args if provided - if self.extra_args: - browser_args["args"].extend(self.extra_args) - - # Add downloads path if downloads are enabled - if self.accept_downloads: - browser_args["downloads_path"] = self.downloads_path - - # Add proxy settings if a proxy is specified - if self.proxy: - proxy_settings = ProxySettings(server=self.proxy) - browser_args["proxy"] = proxy_settings - elif self.proxy_config: - proxy_settings = ProxySettings( - server=self.proxy_config.get("server"), - username=self.proxy_config.get("username"), - password=self.proxy_config.get("password") - ) - browser_args["proxy"] = proxy_settings - - try: - # Select the appropriate browser based on the browser_type - if self.browser_type == "firefox": - self.browser = await self.playwright.firefox.launch(**browser_args) - elif self.browser_type == "webkit": - if "viewport" not in browser_args: - browser_args["viewport"] = {"width": self.viewport_width, "height": self.viewport_height} - self.browser = await self.playwright.webkit.launch(**browser_args) - else: - if self.use_persistent_context and self.user_data_dir: - self.browser = await self.playwright.chromium.launch_persistent_context( - user_data_dir=self.user_data_dir, - accept_downloads=self.accept_downloads, - downloads_path=self.downloads_path if self.accept_downloads else None, - **browser_args - ) - self.default_context = self.browser - else: - self.browser = await self.playwright.chromium.launch(**browser_args) - - except Exception as e: - # Fallback to chromium if Chrome channel fails - if "chrome" in str(e) and browser_args.get("channel") == "chrome": - browser_args["channel"] = "chromium" - if self.use_persistent_context and self.user_data_dir: - self.browser = await self.playwright.chromium.launch_persistent_context( - user_data_dir=self.user_data_dir, - **browser_args - ) - self.default_context = self.browser - else: - self.browser = await self.playwright.chromium.launch(**browser_args) - else: - raise - - await self.execute_hook('on_browser_created', self.browser) - + await self.browser_manager.start() + await self.execute_hook('on_browser_created', self.browser_manager.browser, context = self.browser_manager.default_context) + async def close(self): - if self.sleep_on_close: - await asyncio.sleep(0.5) - - # Close all active sessions - session_ids = list(self.sessions.keys()) - for session_id in session_ids: - await self.kill_session(session_id) - - if self.browser: - await self.browser.close() - self.browser = None - - if self.managed_browser: - await asyncio.sleep(0.5) - await self.managed_browser.cleanup() - self.managed_browser = None - - if self.playwright: - await self.playwright.stop() - self.playwright = None - - # Issue #256: Remove __del__ method to avoid potential issues with async cleanup - # def __del__(self): - # if self.browser or self.playwright: - # asyncio.get_event_loop().run_until_complete(self.close()) + await self.browser_manager.close() + + async def kill_session(self, session_id: str): + # Log a warning message and no need kill session, in new version auto kill session + self.logger.warning( + message="Session auto-kill is enabled in the new version. No need to manually kill sessions.", + tag="WARNING" + ) + await self.browser_manager.kill_session(session_id) def set_hook(self, hook_type: str, hook: Callable): if hook_type in self.hooks: @@ -491,23 +538,6 @@ class AsyncPlaywrightCrawlerStrategy(AsyncCrawlerStrategy): def set_custom_headers(self, headers: Dict[str, str]): self.headers = headers - - async def kill_session(self, session_id: str): - if session_id in self.sessions: - context, page, _ = self.sessions[session_id] - await page.close() - if not self.use_managed_browser: - await context.close() - del self.sessions[session_id] - - def _cleanup_expired_sessions(self): - current_time = time.time() - expired_sessions = [ - sid for sid, (_, _, last_used) in self.sessions.items() - if current_time - last_used > self.session_ttl - ] - for sid in expired_sessions: - asyncio.create_task(self.kill_session(sid)) async def smart_wait(self, page: Page, wait_for: str, timeout: float = 30000): wait_for = wait_for.strip() @@ -606,7 +636,6 @@ class AsyncPlaywrightCrawlerStrategy(AsyncCrawlerStrategy): }} """) else: - # print(f"Warning: Could not access content frame for iframe {i}") self.logger.warning( message="Could not access content frame for iframe {index}", tag="SCRAPE", @@ -618,44 +647,22 @@ class AsyncPlaywrightCrawlerStrategy(AsyncCrawlerStrategy): tag="ERROR", params={"index": i, "error": str(e)} ) - # print(f"Error processing iframe {i}: {str(e)}") # Return the page object return page async def create_session(self, **kwargs) -> str: """Creates a new browser session and returns its ID.""" - if not self.browser: - await self.start() - + await self.start() + session_id = kwargs.get('session_id') or str(uuid.uuid4()) - if self.use_managed_browser: - page = await self.default_context.new_page() - self.sessions[session_id] = (self.default_context, page, time.time()) - else: - if self.use_persistent_context and self.browser_type in ["chrome", "chromium"]: - context = self.browser - page = await context.new_page() - else: - context = await self.browser.new_context( - user_agent=kwargs.get("user_agent", self.user_agent), - viewport={"width": self.viewport_width, "height": self.viewport_height}, - proxy={"server": self.proxy} if self.proxy else None, - accept_downloads=self.accept_downloads, - ignore_https_errors=True - ) - - if self.cookies: - await context.add_cookies(self.cookies) - await context.set_extra_http_headers(self.headers) - page = await context.new_page() - - self.sessions[session_id] = (context, page, time.time()) - + user_agent = kwargs.get("user_agent", self.user_agent) + # Use browser_manager to get a fresh page & context assigned to this session_id + page, context = await self.browser_manager.get_page(session_id, user_agent) return session_id - async def crawl(self, url: str, **kwargs) -> AsyncCrawlResponse: + async def crawl(self, url: str, config: CrawlerRunConfig, **kwargs) -> AsyncCrawlResponse: """ Crawls a given URL or processes raw HTML/local file content based on the URL prefix. @@ -671,14 +678,13 @@ class AsyncPlaywrightCrawlerStrategy(AsyncCrawlerStrategy): Returns: AsyncCrawlResponse: The response containing HTML, headers, status code, and optional screenshot. """ + config = config or CrawlerRunConfig.from_kwargs(kwargs) response_headers = {} - status_code = 200 # Default to 200 for local/raw HTML - screenshot_requested = kwargs.get('screenshot', False) + status_code = 200 # Default for local/raw HTML screenshot_data = None if url.startswith(('http://', 'https://')): - # Proceed with standard web crawling - return await self._crawl_web(url, **kwargs) + return await self._crawl_web(url, config) elif url.startswith('file://'): # Process local file @@ -687,7 +693,7 @@ class AsyncPlaywrightCrawlerStrategy(AsyncCrawlerStrategy): raise FileNotFoundError(f"Local file not found: {local_file_path}") with open(local_file_path, 'r', encoding='utf-8') as f: html = f.read() - if screenshot_requested: + if config.screenshot: screenshot_data = await self._generate_screenshot_from_html(html) return AsyncCrawlResponse( html=html, @@ -701,7 +707,7 @@ class AsyncPlaywrightCrawlerStrategy(AsyncCrawlerStrategy): # Process raw HTML content raw_html = url[4:] # Remove 'raw:' prefix html = raw_html - if screenshot_requested: + if config.screenshot: screenshot_data = await self._generate_screenshot_from_html(html) return AsyncCrawlResponse( html=html, @@ -713,17 +719,16 @@ class AsyncPlaywrightCrawlerStrategy(AsyncCrawlerStrategy): else: raise ValueError("URL must start with 'http://', 'https://', 'file://', or 'raw:'") - - async def _crawl_web(self, url: str, **kwargs) -> AsyncCrawlResponse: + async def _crawl_web(self, url: str, config: CrawlerRunConfig) -> AsyncCrawlResponse: """ - Existing web crawling logic remains unchanged. - + Internal method to crawl web URLs with the specified configuration. + Args: - url (str): The web URL to crawl. - **kwargs: Additional parameters. - + url (str): The web URL to crawl + config (CrawlerRunConfig): Configuration object controlling the crawl behavior + Returns: - AsyncCrawlResponse: The response containing HTML, headers, status code, and optional screenshot. + AsyncCrawlResponse: The response containing HTML, headers, status code, and optional data """ response_headers = {} status_code = None @@ -731,164 +736,68 @@ class AsyncPlaywrightCrawlerStrategy(AsyncCrawlerStrategy): # Reset downloaded files list for new crawl self._downloaded_files = [] - self._cleanup_expired_sessions() - session_id = kwargs.get("session_id") - - # Check if in kwargs we have user_agent that will override the default user_agent - user_agent = kwargs.get("user_agent", self.user_agent) - - # Generate random user agent if magic mode is enabled and user_agent_mode is not random - if kwargs.get("user_agent_mode") != "random" and kwargs.get("magic", False): + # Handle user agent with magic mode + user_agent = self.browser_config.user_agent + if config.magic and self.browser_config.user_agent_mode != "random": user_agent = UserAgentGenerator().generate( - **kwargs.get("user_agent_generator_config", {}) + **(self.browser_config.user_agent_generator_config or {}) ) - # Handle page creation differently for managed browser - context = None - if self.use_managed_browser: - if session_id: - # Reuse existing session if available - context, page, _ = self.sessions.get(session_id, (None, None, None)) - if not page: - # Create new page in default context if session doesn't exist - page = await self.default_context.new_page() - self.sessions[session_id] = (self.default_context, page, time.time()) - else: - # Create new page in default context for non-session requests - page = await self.default_context.new_page() - else: - if session_id: - context, page, _ = self.sessions.get(session_id, (None, None, None)) - if not context: - if self.use_persistent_context and self.browser_type in ["chrome", "chromium"]: - # In persistent context, browser is the context - context = self.browser - else: - # Normal context creation for non-persistent or non-Chrome browsers - context = await self.browser.new_context( - user_agent=user_agent, - viewport={"width": self.viewport_width, "height": self.viewport_height}, - proxy={"server": self.proxy} if self.proxy else None, - java_script_enabled=True, - accept_downloads=self.accept_downloads, - # downloads_path=self.downloads_path if self.accept_downloads else None - ) - await context.add_cookies([{"name": "cookiesEnabled", "value": "true", "url": url}]) - if self.cookies: - await context.add_cookies(self.cookies) - await context.set_extra_http_headers(self.headers) - - page = await context.new_page() - self.sessions[session_id] = (context, page, time.time()) - else: - if self.use_persistent_context and self.browser_type in ["chrome", "chromium"]: - # In persistent context, browser is the context - context = self.browser - else: - # Normal context creation - context = await self.browser.new_context( - user_agent=user_agent, - # viewport={"width": 1920, "height": 1080}, - viewport={"width": self.viewport_width, "height": self.viewport_height}, - proxy={"server": self.proxy} if self.proxy else None, - accept_downloads=self.accept_downloads, - ignore_https_errors=True # Add this line - ) - if self.cookies: - await context.add_cookies(self.cookies) - await context.set_extra_http_headers(self.headers) - - if kwargs.get("override_navigator", False) or kwargs.get("simulate_user", False) or kwargs.get("magic", False): - # Inject scripts to override navigator properties - await context.add_init_script(""" - // Pass the Permissions Test. - const originalQuery = window.navigator.permissions.query; - window.navigator.permissions.query = (parameters) => ( - parameters.name === 'notifications' ? - Promise.resolve({ state: Notification.permission }) : - originalQuery(parameters) - ); - Object.defineProperty(navigator, 'webdriver', { - get: () => undefined - }); - window.navigator.chrome = { - runtime: {}, - // Add other properties if necessary - }; - Object.defineProperty(navigator, 'plugins', { - get: () => [1, 2, 3, 4, 5], - }); - Object.defineProperty(navigator, 'languages', { - get: () => ['en-US', 'en'], - }); - Object.defineProperty(document, 'hidden', { - get: () => false - }); - Object.defineProperty(document, 'visibilityState', { - get: () => 'visible' - }); - """) - - page = await context.new_page() - if kwargs.get("magic", False): - await stealth_async(page, stealth_config) - - # Add console message and error logging - if kwargs.get("log_console", False): - page.on("console", lambda msg: print(f"Console: {msg.text}")) - page.on("pageerror", lambda exc: print(f"Page Error: {exc}")) + # Get page for session + page, context = await self.browser_manager.get_page( + session_id=config.session_id, + user_agent=user_agent + ) + + # Add default cookie + await context.add_cookies([{"name": "cookiesEnabled", "value": "true", "url": url}]) + + # Handle navigator overrides + if config.override_navigator or config.simulate_user or config.magic: + await context.add_init_script(load_js_script("navigator_overrider")) + + # Set up console logging if requested + if config.log_console: + page.on("console", lambda msg: self.logger.debug( + message="Console: {msg}", + tag="CONSOLE", + params={"msg": msg.text} + )) + page.on("pageerror", lambda exc: self.logger.error( + message="Page error: {exc}", + tag="ERROR", + params={"exc": exc} + )) try: - # Set up download handling if enabled - if self.accept_downloads: + # Set up download handling + if self.browser_config.accept_downloads: page.on("download", lambda download: asyncio.create_task(self._handle_download(download))) - if self.use_cached_html: - cache_file_path = os.path.join( - os.getenv("CRAWL4_AI_BASE_DIRECTORY", Path.home()), ".crawl4ai", "cache", hashlib.md5(url.encode()).hexdigest() - ) - if os.path.exists(cache_file_path): - html = "" - with open(cache_file_path, "r") as f: - html = f.read() - # retrieve response headers and status code from cache - with open(cache_file_path + ".meta", "r") as f: - meta = json.load(f) - response_headers = meta.get("response_headers", {}) - status_code = meta.get("status_code") - response = AsyncCrawlResponse( - html=html, response_headers=response_headers, status_code=status_code - ) - return response - - if not kwargs.get("js_only", False): - await self.execute_hook('before_goto', page, context = context) + # Handle page navigation and content loading + if not config.js_only: + await self.execute_hook('before_goto', page, context=context) try: response = await page.goto( url, - # wait_until=kwargs.get("wait_until", ["domcontentloaded", "networkidle"]), - wait_until=kwargs.get("wait_until", "domcontentloaded"), - timeout=kwargs.get("page_timeout", 60000), + wait_until=config.wait_until, + timeout=config.page_timeout ) except Error as e: - raise RuntimeError(f"Failed on navigating ACS-GOTO :\n{str(e)}") + raise RuntimeError(f"Failed on navigating ACS-GOTO:\n{str(e)}") - await self.execute_hook('after_goto', page, context = context) + await self.execute_hook('after_goto', page, context=context) - # Get status code and headers status_code = response.status response_headers = response.headers else: status_code = 200 response_headers = {} - # Replace the current wait_for_selector line with this more robust check: + # Wait for body element and visibility try: - # First wait for body to exist, regardless of visibility await page.wait_for_selector('body', state='attached', timeout=30000) - - # Then wait for it to become visible by checking CSS await page.wait_for_function(""" () => { const body = document.body; @@ -898,9 +807,7 @@ class AsyncPlaywrightCrawlerStrategy(AsyncCrawlerStrategy): style.opacity !== '0'; } """, timeout=30000) - except Error as e: - # If waiting fails, let's try to diagnose the issue visibility_info = await page.evaluate(""" () => { const body = document.body; @@ -915,270 +822,195 @@ class AsyncPlaywrightCrawlerStrategy(AsyncCrawlerStrategy): } """) - if self.verbose: - print(f"Body visibility debug info: {visibility_info}") + if self.config.verbose: + self.logger.debug( + message="Body visibility info: {info}", + tag="DEBUG", + params={"info": visibility_info} + ) - # Even if body is hidden, we might still want to proceed - if kwargs.get('ignore_body_visibility', True): - if self.verbose: - print("Proceeding despite hidden body...") - pass - else: + if not config.ignore_body_visibility: raise Error(f"Body element is hidden: {visibility_info}") - - # CONTENT LOADING ASSURANCE - if not self.text_only and (kwargs.get("wait_for_images", True) or kwargs.get("adjust_viewport_to_content", False)): - # Wait for network idle after initial load and images to load - await page.wait_for_load_state("networkidle") + + # Handle content loading and viewport adjustment + if not self.browser_config.text_only and (config.wait_for_images or config.adjust_viewport_to_content): + await page.wait_for_load_state("domcontentloaded") await asyncio.sleep(0.1) - await page.wait_for_function("Array.from(document.images).every(img => img.complete)") - - # After initial load, adjust viewport to content size - if not self.text_only and kwargs.get("adjust_viewport_to_content", False): - try: - # Get actual page dimensions + try: + await page.wait_for_function( + "Array.from(document.images).every(img => img.complete)", + timeout=1000 + ) + except PlaywrightTimeoutError: + pass + + # Adjust viewport if needed + if not self.browser_config.text_only and config.adjust_viewport_to_content: + try: page_width = await page.evaluate("document.documentElement.scrollWidth") page_height = await page.evaluate("document.documentElement.scrollHeight") - target_width = self.viewport_width + target_width = self.browser_config.viewport_width target_height = int(target_width * page_width / page_height * 0.95) await page.set_viewport_size({"width": target_width, "height": target_height}) - # Compute scale factor - # We want the entire page visible: the scale should make both width and height fit scale = min(target_width / page_width, target_height / page_height) - - # Now we call CDP to set metrics. - # We tell Chrome that the "device" is page_width x page_height in size, - # but we scale it down so everything fits within the real viewport. cdp = await page.context.new_cdp_session(page) await cdp.send('Emulation.setDeviceMetricsOverride', { - 'width': page_width, # full page width - 'height': page_height, # full page height - 'deviceScaleFactor': 1, # keep normal DPR + 'width': page_width, + 'height': page_height, + 'deviceScaleFactor': 1, 'mobile': False, - 'scale': scale # scale the entire rendered content + 'scale': scale }) - except Exception as e: self.logger.warning( message="Failed to adjust viewport to content: {error}", tag="VIEWPORT", params={"error": str(e)} - ) - - # After viewport adjustment, handle page scanning if requested - if kwargs.get("scan_full_page", False): - try: - viewport_height = page.viewport_size.get("height", self.viewport_height) - current_position = viewport_height # Start with one viewport height - scroll_delay = kwargs.get("scroll_delay", 0.2) - - # Initial scroll - await page.evaluate(f"window.scrollTo(0, {current_position})") - await asyncio.sleep(scroll_delay) - - # Get height after first scroll to account for any dynamic content - total_height = await page.evaluate("document.documentElement.scrollHeight") - - while current_position < total_height: - current_position = min(current_position + viewport_height, total_height) - await page.evaluate(f"window.scrollTo(0, {current_position})") - await asyncio.sleep(scroll_delay) - - # Check for dynamic content - new_height = await page.evaluate("document.documentElement.scrollHeight") - if new_height > total_height: - total_height = new_height - - # Scroll back to top - await page.evaluate("window.scrollTo(0, 0)") - - except Exception as e: - self.logger.warning( - message="Failed to perform full page scan: {error}", - tag="PAGE_SCAN", - params={"error": str(e)} ) - else: - # Scroll to the bottom of the page - await page.evaluate("window.scrollTo(0, document.body.scrollHeight)") - js_code = kwargs.get("js_code", kwargs.get("js", self.js_code)) - if js_code: - if isinstance(js_code, str): - await page.evaluate(js_code) - elif isinstance(js_code, list): - for js in js_code: + # Handle full page scanning + if config.scan_full_page: + await self._handle_full_page_scan(page, config.scroll_delay) + + # Execute JavaScript if provided + if config.js_code: + if isinstance(config.js_code, str): + await page.evaluate(config.js_code) + elif isinstance(config.js_code, list): + for js in config.js_code: await page.evaluate(js) - # await page.wait_for_timeout(100) - - # Check for on execution event - await self.execute_hook('on_execution_started', page, context = context) - - if kwargs.get("simulate_user", False) or kwargs.get("magic", False): - # Simulate user interactions + await self.execute_hook('on_execution_started', page, context=context) + + # Handle user simulation + if config.simulate_user or config.magic: await page.mouse.move(100, 100) await page.mouse.down() await page.mouse.up() await page.keyboard.press('ArrowDown') - # Handle the wait_for parameter - wait_for = kwargs.get("wait_for") - if wait_for: + # Handle wait_for condition + if config.wait_for: try: - await self.smart_wait(page, wait_for, timeout=kwargs.get("page_timeout", 60000)) + await self.smart_wait(page, config.wait_for, timeout=config.page_timeout) except Exception as e: raise RuntimeError(f"Wait condition failed: {str(e)}") - - # if not wait_for and js_code: - # await page.wait_for_load_state('networkidle', timeout=5000) - # Update image dimensions - if not self.text_only: - update_image_dimensions_js = """ - () => { - return new Promise((resolve) => { - const filterImage = (img) => { - // Filter out images that are too small - if (img.width < 100 && img.height < 100) return false; - - // Filter out images that are not visible - const rect = img.getBoundingClientRect(); - if (rect.width === 0 || rect.height === 0) return false; - - // Filter out images with certain class names (e.g., icons, thumbnails) - if (img.classList.contains('icon') || img.classList.contains('thumbnail')) return false; - - // Filter out images with certain patterns in their src (e.g., placeholder images) - if (img.src.includes('placeholder') || img.src.includes('icon')) return false; - - return true; - }; - - const images = Array.from(document.querySelectorAll('img')).filter(filterImage); - let imagesLeft = images.length; - - if (imagesLeft === 0) { - resolve(); - return; - } - - const checkImage = (img) => { - if (img.complete && img.naturalWidth !== 0) { - img.setAttribute('width', img.naturalWidth); - img.setAttribute('height', img.naturalHeight); - imagesLeft--; - if (imagesLeft === 0) resolve(); - } - }; - - images.forEach(img => { - checkImage(img); - if (!img.complete) { - img.onload = () => { - checkImage(img); - }; - img.onerror = () => { - imagesLeft--; - if (imagesLeft === 0) resolve(); - }; - } - }); - - // Fallback timeout of 5 seconds - // setTimeout(() => resolve(), 5000); - resolve(); - }); - } - """ - + # Update image dimensions if needed + if not self.browser_config.text_only: + update_image_dimensions_js = load_js_script("update_image_dimensions") try: try: - await page.wait_for_load_state( - # state="load", - state="domcontentloaded", - timeout=5 - ) + await page.wait_for_load_state("domcontentloaded", timeout=5) except PlaywrightTimeoutError: pass await page.evaluate(update_image_dimensions_js) except Exception as e: self.logger.error( - message="Error updating image dimensions ACS-UPDATE_IMAGE_DIMENSIONS_JS: {error}", + message="Error updating image dimensions: {error}", tag="ERROR", params={"error": str(e)} ) - # raise RuntimeError(f"Error updating image dimensions ACS-UPDATE_IMAGE_DIMENSIONS_JS: {str(e)}") - # Wait a bit for any onload events to complete - # await page.wait_for_timeout(100) - - # Process iframes - if kwargs.get("process_iframes", False): + # Process iframes if needed + if config.process_iframes: page = await self.process_iframes(page) - - await self.execute_hook('before_retrieve_html', page, context = context) - # Check if delay_before_return_html is set then wait for that time - delay_before_return_html = kwargs.get("delay_before_return_html", 0.1) - if delay_before_return_html: - await asyncio.sleep(delay_before_return_html) - - # Check for remove_overlay_elements parameter - if kwargs.get("remove_overlay_elements", False): + + # Pre-content retrieval hooks and delay + await self.execute_hook('before_retrieve_html', page, context=context) + if config.delay_before_return_html: + await asyncio.sleep(config.delay_before_return_html) + + # Handle overlay removal + if config.remove_overlay_elements: await self.remove_overlay_elements(page) - + + # Get final HTML content html = await page.content() - await self.execute_hook('before_return_html', page, html, context = context) - - # Check if kwargs has screenshot=True then take screenshot + await self.execute_hook('before_return_html', page, html, context=context) + + # Handle PDF and screenshot generation + start_export_time = time.perf_counter() + pdf_data = None screenshot_data = None - if kwargs.get("screenshot"): - # Check we have screenshot_wait_for parameter, if we have simply wait for that time - screenshot_wait_for = kwargs.get("screenshot_wait_for") - if screenshot_wait_for: - await asyncio.sleep(screenshot_wait_for) - screenshot_data = await self.take_screenshot(page) - # if self.verbose: - # print(f"[LOG] โœ… Crawled {url} successfully!") - - if self.use_cached_html: - cache_file_path = os.path.join( - os.getenv("CRAWL4_AI_BASE_DIRECTORY", Path.home()), ".crawl4ai", "cache", hashlib.md5(url.encode()).hexdigest() + if config.pdf: + pdf_data = await self.export_pdf(page) + + if config.screenshot: + if config.screenshot_wait_for: + await asyncio.sleep(config.screenshot_wait_for) + screenshot_data = await self.take_screenshot( + page, + screenshot_height_threshold=config.screenshot_height_threshold ) - with open(cache_file_path, "w", encoding="utf-8") as f: - f.write(html) - # store response headers and status code in cache - with open(cache_file_path + ".meta", "w", encoding="utf-8") as f: - json.dump({ - "response_headers": response_headers, - "status_code": status_code - }, f) + if screenshot_data or pdf_data: + self.logger.info( + message="Exporting PDF and taking screenshot took {duration:.2f}s", + tag="EXPORT", + params={"duration": time.perf_counter() - start_export_time} + ) + + # Define delayed content getter async def get_delayed_content(delay: float = 5.0) -> str: - if self.verbose: - print(f"[LOG] Waiting for {delay} seconds before retrieving content for {url}") + if self.config.verbose: + self.logger.info( + message="Waiting for {delay} seconds before retrieving content for {url}", + tag="INFO", + params={"delay": delay, "url": url} + ) await asyncio.sleep(delay) return await page.content() - - response = AsyncCrawlResponse( - html=html, - response_headers=response_headers, + + # Return complete response + return AsyncCrawlResponse( + html=html, + response_headers=response_headers, status_code=status_code, screenshot=screenshot_data, + pdf_data=pdf_data, get_delayed_content=get_delayed_content, downloaded_files=self._downloaded_files if self._downloaded_files else None ) - return response - except Error as e: - raise Error(f"async_crawler_strategy.py:_crawleb(): {str(e)}") - # finally: - # if not session_id: - # await page.close() - # await context.close() + except Exception as e: + raise e + + async def _handle_full_page_scan(self, page: Page, scroll_delay: float): + """Helper method to handle full page scanning""" + try: + viewport_height = page.viewport_size.get("height", self.browser_config.viewport_height) + current_position = viewport_height + + await page.evaluate(f"window.scrollTo(0, {current_position})") + await asyncio.sleep(scroll_delay) + + total_height = await page.evaluate("document.documentElement.scrollHeight") + + while current_position < total_height: + current_position = min(current_position + viewport_height, total_height) + await page.evaluate(f"window.scrollTo(0, {current_position})") + await asyncio.sleep(scroll_delay) + + new_height = await page.evaluate("document.documentElement.scrollHeight") + if new_height > total_height: + total_height = new_height + + await page.evaluate("window.scrollTo(0, 0)") + + except Exception as e: + self.logger.warning( + message="Failed to perform full page scan: {error}", + tag="PAGE_SCAN", + params={"error": str(e)} + ) + else: + await page.evaluate("window.scrollTo(0, document.body.scrollHeight)") + + async def _handle_download(self, download): """Handle file downloads.""" try: @@ -1208,8 +1040,6 @@ class AsyncPlaywrightCrawlerStrategy(AsyncCrawlerStrategy): params={"error": str(e)} ) - # if self.verbose: - # print(f"[ERROR] Failed to handle download: {str(e)}") async def crawl_many(self, urls: List[str], **kwargs) -> List[AsyncCrawlResponse]: semaphore_count = kwargs.get('semaphore_count', 5) # Adjust as needed @@ -1230,124 +1060,8 @@ class AsyncPlaywrightCrawlerStrategy(AsyncCrawlerStrategy): Args: page (Page): The Playwright page instance """ - remove_overlays_js = """ - async () => { - // Function to check if element is visible - const isVisible = (elem) => { - const style = window.getComputedStyle(elem); - return style.display !== 'none' && - style.visibility !== 'hidden' && - style.opacity !== '0'; - }; - - // Common selectors for popups and overlays - const commonSelectors = [ - // Close buttons first - 'button[class*="close" i]', 'button[class*="dismiss" i]', - 'button[aria-label*="close" i]', 'button[title*="close" i]', - 'a[class*="close" i]', 'span[class*="close" i]', - - // Cookie notices - '[class*="cookie-banner" i]', '[id*="cookie-banner" i]', - '[class*="cookie-consent" i]', '[id*="cookie-consent" i]', - - // Newsletter/subscription dialogs - '[class*="newsletter" i]', '[class*="subscribe" i]', - - // Generic popups/modals - '[class*="popup" i]', '[class*="modal" i]', - '[class*="overlay" i]', '[class*="dialog" i]', - '[role="dialog"]', '[role="alertdialog"]' - ]; - - // Try to click close buttons first - for (const selector of commonSelectors.slice(0, 6)) { - const closeButtons = document.querySelectorAll(selector); - for (const button of closeButtons) { - if (isVisible(button)) { - try { - button.click(); - await new Promise(resolve => setTimeout(resolve, 100)); - } catch (e) { - console.log('Error clicking button:', e); - } - } - } - } - - // Remove remaining overlay elements - const removeOverlays = () => { - // Find elements with high z-index - const allElements = document.querySelectorAll('*'); - for (const elem of allElements) { - const style = window.getComputedStyle(elem); - const zIndex = parseInt(style.zIndex); - const position = style.position; - - if ( - isVisible(elem) && - (zIndex > 999 || position === 'fixed' || position === 'absolute') && - ( - elem.offsetWidth > window.innerWidth * 0.5 || - elem.offsetHeight > window.innerHeight * 0.5 || - style.backgroundColor.includes('rgba') || - parseFloat(style.opacity) < 1 - ) - ) { - elem.remove(); - } - } - - // Remove elements matching common selectors - for (const selector of commonSelectors) { - const elements = document.querySelectorAll(selector); - elements.forEach(elem => { - if (isVisible(elem)) { - elem.remove(); - } - }); - } - }; - - // Remove overlay elements - removeOverlays(); - - // Remove any fixed/sticky position elements at the top/bottom - const removeFixedElements = () => { - const elements = document.querySelectorAll('*'); - elements.forEach(elem => { - const style = window.getComputedStyle(elem); - if ( - (style.position === 'fixed' || style.position === 'sticky') && - isVisible(elem) - ) { - elem.remove(); - } - }); - }; - - removeFixedElements(); - - // Remove empty block elements as: div, p, span, etc. - const removeEmptyBlockElements = () => { - const blockElements = document.querySelectorAll('div, p, span, section, article, header, footer, aside, nav, main, ul, ol, li, dl, dt, dd, h1, h2, h3, h4, h5, h6'); - blockElements.forEach(elem => { - if (elem.innerText.trim() === '') { - elem.remove(); - } - }); - }; - - // Remove margin-right and padding-right from body (often added by modal scripts) - document.body.style.marginRight = '0px'; - document.body.style.paddingRight = '0px'; - document.body.style.overflow = 'auto'; - - // Wait a bit for any animations to complete - await new Promise(resolve => setTimeout(resolve, 100)); - } - """ - + remove_overlays_js = load_js_script("remove_overlay_elements") + try: await page.evaluate(remove_overlays_js) await page.wait_for_timeout(500) # Wait for any animations to complete @@ -1357,10 +1071,113 @@ class AsyncPlaywrightCrawlerStrategy(AsyncCrawlerStrategy): tag="SCRAPE", params={"error": str(e)} ) - # if self.verbose: - # print(f"Warning: Failed to remove overlay elements: {str(e)}") - async def take_screenshot(self, page: Page) -> str: + async def export_pdf(self, page: Page) -> bytes: + """ + Exports the current page as a PDF. + """ + pdf_data = await page.pdf(print_background=True) + return pdf_data + + async def take_screenshot(self, page, **kwargs) -> str: + page_height = await page.evaluate("document.documentElement.scrollHeight") + if page_height < kwargs.get("screenshot_height_threshold", SCREENSHOT_HEIGHT_TRESHOLD): + # Page is short enough, just take a screenshot + return await self.take_screenshot_naive(page) + else: + # Page is too long, try to take a full-page screenshot + return await self.take_screenshot_scroller(page, **kwargs) + # return await self.take_screenshot_from_pdf(await self.export_pdf(page)) + + async def take_screenshot_from_pdf(self, pdf_data: bytes) -> str: + """ + Convert the first page of the PDF to a screenshot. + Requires pdf2image and poppler. + """ + try: + from pdf2image import convert_from_bytes + images = convert_from_bytes(pdf_data) + final_img = images[0].convert('RGB') + buffered = BytesIO() + final_img.save(buffered, format="JPEG") + return base64.b64encode(buffered.getvalue()).decode('utf-8') + except Exception as e: + error_message = f"Failed to take PDF-based screenshot: {str(e)}" + self.logger.error( + message="PDF Screenshot failed: {error}", + tag="ERROR", + params={"error": error_message} + ) + # Return error image as fallback + img = Image.new('RGB', (800, 600), color='black') + draw = ImageDraw.Draw(img) + font = ImageFont.load_default() + draw.text((10, 10), error_message, fill=(255, 255, 255), font=font) + buffered = BytesIO() + img.save(buffered, format="JPEG") + return base64.b64encode(buffered.getvalue()).decode('utf-8') + + async def take_screenshot_scroller(self, page: Page, **kwargs) -> str: + """ + Attempt to set a large viewport and take a full-page screenshot. + If still too large, segment the page as before. + """ + try: + # Get page height + page_height = await page.evaluate("document.documentElement.scrollHeight") + page_width = await page.evaluate("document.documentElement.scrollWidth") + + # Set a large viewport + large_viewport_height = min(page_height, kwargs.get("screenshot_height_threshold", SCREENSHOT_HEIGHT_TRESHOLD)) + await page.set_viewport_size({"width": page_width, "height": large_viewport_height}) + + # Page still too long, segment approach + segments = [] + viewport_size = page.viewport_size + viewport_height = viewport_size["height"] + + num_segments = (page_height // viewport_height) + 1 + for i in range(num_segments): + y_offset = i * viewport_height + await page.evaluate(f"window.scrollTo(0, {y_offset})") + await asyncio.sleep(0.01) # wait for render + seg_shot = await page.screenshot(full_page=False) + img = Image.open(BytesIO(seg_shot)).convert('RGB') + segments.append(img) + + total_height = sum(img.height for img in segments) + stitched = Image.new('RGB', (segments[0].width, total_height)) + offset = 0 + for img in segments: + # stitched.paste(img, (0, offset)) + stitched.paste(img.convert('RGB'), (0, offset)) + offset += img.height + + buffered = BytesIO() + stitched = stitched.convert('RGB') + stitched.save(buffered, format="BMP", quality=85) + encoded = base64.b64encode(buffered.getvalue()).decode('utf-8') + + return encoded + except Exception as e: + error_message = f"Failed to take large viewport screenshot: {str(e)}" + self.logger.error( + message="Large viewport screenshot failed: {error}", + tag="ERROR", + params={"error": error_message} + ) + # return error image + img = Image.new('RGB', (800, 600), color='black') + draw = ImageDraw.Draw(img) + font = ImageFont.load_default() + draw.text((10, 10), error_message, fill=(255, 255, 255), font=font) + buffered = BytesIO() + img.save(buffered, format="JPEG") + return base64.b64encode(buffered.getvalue()).decode('utf-8') + finally: + await page.close() + + async def take_screenshot_naive(self, page: Page) -> str: """ Takes a screenshot of the current page. @@ -1372,7 +1189,7 @@ class AsyncPlaywrightCrawlerStrategy(AsyncCrawlerStrategy): """ try: # The page is already loaded, just take the screenshot - screenshot = await page.screenshot(full_page=True) + screenshot = await page.screenshot(full_page=False) return base64.b64encode(screenshot).decode('utf-8') except Exception as e: error_message = f"Failed to take screenshot: {str(e)}" @@ -1394,6 +1211,25 @@ class AsyncPlaywrightCrawlerStrategy(AsyncCrawlerStrategy): return base64.b64encode(buffered.getvalue()).decode('utf-8') finally: await page.close() + + async def export_storage_state(self, path: str = None) -> dict: + """ + Exports the current storage state (cookies, localStorage, sessionStorage) + to a JSON file at the specified path. + """ + if self.default_context: + state = await self.default_context.storage_state(path=path) + self.logger.info( + message="Exported storage state to {path}", + tag="INFO", + params={"path": path} + ) + return state + else: + self.logger.warning( + message="No default_context available to export storage state.", + tag="WARNING" + ) async def _generate_screenshot_from_html(self, html: str) -> Optional[str]: """ @@ -1406,16 +1242,16 @@ class AsyncPlaywrightCrawlerStrategy(AsyncCrawlerStrategy): Optional[str]: Base64-encoded screenshot image or an error image if failed. """ try: - if not self.browser: - await self.start() - page = await self.browser.new_page() + await self.start() + # Create a temporary page without a session_id + page, context = await self.browser_manager.get_page(None, self.user_agent) + await page.set_content(html, wait_until='networkidle') screenshot = await page.screenshot(full_page=True) await page.close() return base64.b64encode(screenshot).decode('utf-8') except Exception as e: error_message = f"Failed to take screenshot: {str(e)}" - # print(error_message) self.logger.error( message="Screenshot failed: {error}", tag="ERROR", diff --git a/crawl4ai/async_database.py b/crawl4ai/async_database.py index 3c97e7d1..5cdafac2 100644 --- a/crawl4ai/async_database.py +++ b/crawl4ai/async_database.py @@ -1,4 +1,4 @@ -import os +import os, sys from pathlib import Path import aiosqlite import asyncio @@ -13,6 +13,7 @@ import aiofiles from .config import NEED_MIGRATION from .version_manager import VersionManager from .async_logger import AsyncLogger +from .utils import get_error_context, create_box_message # Set up logging logging.basicConfig(level=logging.INFO) logger = logging.getLogger(__name__) @@ -97,35 +98,84 @@ class AsyncDatabaseManager: @asynccontextmanager async def get_connection(self): - """Connection pool manager""" + """Connection pool manager with enhanced error handling""" if not self._initialized: - # Use an asyncio.Lock to ensure only one initialization occurs async with self.init_lock: if not self._initialized: - await self.initialize() - self._initialized = True + try: + await self.initialize() + self._initialized = True + except Exception as e: + import sys + error_context = get_error_context(sys.exc_info()) + self.logger.error( + message="Database initialization failed:\n{error}\n\nContext:\n{context}\n\nTraceback:\n{traceback}", + tag="ERROR", + force_verbose=True, + params={ + "error": str(e), + "context": error_context["code_context"], + "traceback": error_context["full_traceback"] + } + ) + raise await self.connection_semaphore.acquire() task_id = id(asyncio.current_task()) + try: async with self.pool_lock: if task_id not in self.connection_pool: - conn = await aiosqlite.connect( - self.db_path, - timeout=30.0 - ) - await conn.execute('PRAGMA journal_mode = WAL') - await conn.execute('PRAGMA busy_timeout = 5000') - self.connection_pool[task_id] = conn + try: + conn = await aiosqlite.connect( + self.db_path, + timeout=30.0 + ) + await conn.execute('PRAGMA journal_mode = WAL') + await conn.execute('PRAGMA busy_timeout = 5000') + + # Verify database structure + async with conn.execute("PRAGMA table_info(crawled_data)") as cursor: + columns = await cursor.fetchall() + column_names = [col[1] for col in columns] + expected_columns = { + 'url', 'html', 'cleaned_html', 'markdown', 'extracted_content', + 'success', 'media', 'links', 'metadata', 'screenshot', + 'response_headers', 'downloaded_files' + } + missing_columns = expected_columns - set(column_names) + if missing_columns: + raise ValueError(f"Database missing columns: {missing_columns}") + + self.connection_pool[task_id] = conn + except Exception as e: + import sys + error_context = get_error_context(sys.exc_info()) + error_message = ( + f"Unexpected error in db get_connection at line {error_context['line_no']} " + f"in {error_context['function']} ({error_context['filename']}):\n" + f"Error: {str(e)}\n\n" + f"Code context:\n{error_context['code_context']}" + ) + self.logger.error( + message=create_box_message(error_message, type= "error"), + ) + + raise yield self.connection_pool[task_id] except Exception as e: + import sys + error_context = get_error_context(sys.exc_info()) + error_message = ( + f"Unexpected error in db get_connection at line {error_context['line_no']} " + f"in {error_context['function']} ({error_context['filename']}):\n" + f"Error: {str(e)}\n\n" + f"Code context:\n{error_context['code_context']}" + ) self.logger.error( - message="Connection error: {error}", - tag="ERROR", - force_verbose=True, - params={"error": str(e)} + message=create_box_message(error_message, type= "error"), ) raise finally: @@ -230,7 +280,8 @@ class AsyncDatabaseManager: 'cleaned_html': row_dict['cleaned_html'], 'markdown': row_dict['markdown'], 'extracted_content': row_dict['extracted_content'], - 'screenshot': row_dict['screenshot'] + 'screenshot': row_dict['screenshot'], + 'screenshots': row_dict['screenshot'], } for field, hash_value in content_fields.items(): diff --git a/crawl4ai/async_tools.py b/crawl4ai/async_tools.py new file mode 100644 index 00000000..157e5596 --- /dev/null +++ b/crawl4ai/async_tools.py @@ -0,0 +1,183 @@ +import asyncio +import base64 +import time +from abc import ABC, abstractmethod +from typing import Callable, Dict, Any, List, Optional, Awaitable +import os, sys, shutil +import tempfile, subprocess +from playwright.async_api import async_playwright, Page, Browser, Error +from playwright.async_api import TimeoutError as PlaywrightTimeoutError +from io import BytesIO +from PIL import Image, ImageDraw, ImageFont +from pathlib import Path +from playwright.async_api import ProxySettings +from pydantic import BaseModel +import hashlib +import json +import uuid +from .models import AsyncCrawlResponse +from .utils import create_box_message +from .user_agent_generator import UserAgentGenerator +from playwright_stealth import StealthConfig, stealth_async + + +class ManagedBrowser: + def __init__(self, browser_type: str = "chromium", user_data_dir: Optional[str] = None, headless: bool = False, logger = None, host: str = "localhost", debugging_port: int = 9222): + self.browser_type = browser_type + self.user_data_dir = user_data_dir + self.headless = headless + self.browser_process = None + self.temp_dir = None + self.debugging_port = debugging_port + self.host = host + self.logger = logger + self.shutting_down = False + + async def start(self) -> str: + """ + Starts the browser process and returns the CDP endpoint URL. + If user_data_dir is not provided, creates a temporary directory. + """ + + # Create temp dir if needed + if not self.user_data_dir: + self.temp_dir = tempfile.mkdtemp(prefix="browser-profile-") + self.user_data_dir = self.temp_dir + + # Get browser path and args based on OS and browser type + browser_path = self._get_browser_path() + args = self._get_browser_args() + + # Start browser process + try: + self.browser_process = subprocess.Popen( + args, + stdout=subprocess.PIPE, + stderr=subprocess.PIPE + ) + # Monitor browser process output for errors + asyncio.create_task(self._monitor_browser_process()) + await asyncio.sleep(2) # Give browser time to start + return f"http://{self.host}:{self.debugging_port}" + except Exception as e: + await self.cleanup() + raise Exception(f"Failed to start browser: {e}") + + async def _monitor_browser_process(self): + """Monitor the browser process for unexpected termination.""" + if self.browser_process: + try: + stdout, stderr = await asyncio.gather( + asyncio.to_thread(self.browser_process.stdout.read), + asyncio.to_thread(self.browser_process.stderr.read) + ) + + # Check shutting_down flag BEFORE logging anything + if self.browser_process.poll() is not None: + if not self.shutting_down: + self.logger.error( + message="Browser process terminated unexpectedly | Code: {code} | STDOUT: {stdout} | STDERR: {stderr}", + tag="ERROR", + params={ + "code": self.browser_process.returncode, + "stdout": stdout.decode(), + "stderr": stderr.decode() + } + ) + await self.cleanup() + else: + self.logger.info( + message="Browser process terminated normally | Code: {code}", + tag="INFO", + params={"code": self.browser_process.returncode} + ) + except Exception as e: + if not self.shutting_down: + self.logger.error( + message="Error monitoring browser process: {error}", + tag="ERROR", + params={"error": str(e)} + ) + + def _get_browser_path(self) -> str: + """Returns the browser executable path based on OS and browser type""" + if sys.platform == "darwin": # macOS + paths = { + "chromium": "/Applications/Google Chrome.app/Contents/MacOS/Google Chrome", + "firefox": "/Applications/Firefox.app/Contents/MacOS/firefox", + "webkit": "/Applications/Safari.app/Contents/MacOS/Safari" + } + elif sys.platform == "win32": # Windows + paths = { + "chromium": "C:\\Program Files\\Google\\Chrome\\Application\\chrome.exe", + "firefox": "C:\\Program Files\\Mozilla Firefox\\firefox.exe", + "webkit": None # WebKit not supported on Windows + } + else: # Linux + paths = { + "chromium": "google-chrome", + "firefox": "firefox", + "webkit": None # WebKit not supported on Linux + } + + return paths.get(self.browser_type) + + def _get_browser_args(self) -> List[str]: + """Returns browser-specific command line arguments""" + base_args = [self._get_browser_path()] + + if self.browser_type == "chromium": + args = [ + f"--remote-debugging-port={self.debugging_port}", + f"--user-data-dir={self.user_data_dir}", + ] + if self.headless: + args.append("--headless=new") + elif self.browser_type == "firefox": + args = [ + "--remote-debugging-port", str(self.debugging_port), + "--profile", self.user_data_dir, + ] + if self.headless: + args.append("--headless") + else: + raise NotImplementedError(f"Browser type {self.browser_type} not supported") + + return base_args + args + + async def cleanup(self): + """Cleanup browser process and temporary directory""" + # Set shutting_down flag BEFORE any termination actions + self.shutting_down = True + + if self.browser_process: + try: + self.browser_process.terminate() + # Wait for process to end gracefully + for _ in range(10): # 10 attempts, 100ms each + if self.browser_process.poll() is not None: + break + await asyncio.sleep(0.1) + + # Force kill if still running + if self.browser_process.poll() is None: + self.browser_process.kill() + await asyncio.sleep(0.1) # Brief wait for kill to take effect + + except Exception as e: + self.logger.error( + message="Error terminating browser: {error}", + tag="ERROR", + params={"error": str(e)} + ) + + if self.temp_dir and os.path.exists(self.temp_dir): + try: + shutil.rmtree(self.temp_dir) + except Exception as e: + self.logger.error( + message="Error removing temporary directory: {error}", + tag="ERROR", + params={"error": str(e)} + ) + diff --git a/crawl4ai/async_webcrawler.py b/crawl4ai/async_webcrawler.py index 2c17602d..8515a387 100644 --- a/crawl4ai/async_webcrawler.py +++ b/crawl4ai/async_webcrawler.py @@ -1,4 +1,4 @@ -import os +import os, sys import time import warnings from enum import Enum @@ -7,7 +7,7 @@ from pathlib import Path from typing import Optional, List, Union import json import asyncio -from contextlib import nullcontext +from contextlib import nullcontext, asynccontextmanager from .models import CrawlResult, MarkdownGenerationResult from .async_database import async_db_manager from .chunking_strategy import * @@ -17,7 +17,7 @@ from .async_crawler_strategy import AsyncCrawlerStrategy, AsyncPlaywrightCrawler from .cache_context import CacheMode, CacheContext, _legacy_to_cache_mode from .content_scraping_strategy import WebScrapingStrategy from .async_logger import AsyncLogger - +from .async_configs import BrowserConfig, CrawlerRunConfig from .config import ( MIN_WORD_THRESHOLD, IMAGE_DESCRIPTION_MIN_WORD_THRESHOLD, @@ -40,31 +40,20 @@ class AsyncWebCrawler: """ Asynchronous web crawler with flexible caching capabilities. - Migration Guide (from version X.X.X): + Migration Guide: Old way (deprecated): - crawler = AsyncWebCrawler(always_by_pass_cache=True) - result = await crawler.arun( - url="https://example.com", - bypass_cache=True, - no_cache_read=True, - no_cache_write=False - ) + crawler = AsyncWebCrawler(always_by_pass_cache=True, browser_type="chromium", headless=True) New way (recommended): - crawler = AsyncWebCrawler(always_bypass_cache=True) - result = await crawler.arun( - url="https://example.com", - cache_mode=CacheMode.WRITE_ONLY - ) - - To disable deprecation warnings: - Pass warning=False to suppress the warning. + browser_config = BrowserConfig(browser_type="chromium", headless=True) + crawler = AsyncWebCrawler(browser_config=browser_config) """ _domain_last_hit = {} def __init__( self, crawler_strategy: Optional[AsyncCrawlerStrategy] = None, + config: Optional[BrowserConfig] = None, always_bypass_cache: bool = False, always_by_pass_cache: Optional[bool] = None, # Deprecated parameter base_directory: str = str(os.getenv("CRAWL4_AI_BASE_DIRECTORY", Path.home())), @@ -75,28 +64,48 @@ class AsyncWebCrawler: Initialize the AsyncWebCrawler. Args: - crawler_strategy: Strategy for crawling web pages + crawler_strategy: Strategy for crawling web pages. If None, will create AsyncPlaywrightCrawlerStrategy + config: Configuration object for browser settings. If None, will be created from kwargs always_bypass_cache: Whether to always bypass cache (new parameter) always_by_pass_cache: Deprecated, use always_bypass_cache instead base_directory: Base directory for storing cache + thread_safe: Whether to use thread-safe operations + **kwargs: Additional arguments for backwards compatibility """ - self.verbose = kwargs.get("verbose", False) + # Handle browser configuration + browser_config = config + if browser_config is not None: + if any(k in kwargs for k in ["browser_type", "headless", "viewport_width", "viewport_height"]): + self.logger.warning( + message="Both browser_config and legacy browser parameters provided. browser_config will take precedence.", + tag="WARNING" + ) + else: + # Create browser config from kwargs for backwards compatibility + browser_config = BrowserConfig.from_kwargs(kwargs) + + self.browser_config = browser_config + + # Initialize logger first since other components may need it self.logger = AsyncLogger( log_file=os.path.join(base_directory, ".crawl4ai", "crawler.log"), - verbose=self.verbose, + verbose=self.browser_config.verbose, tag_width=10 ) + + # Initialize crawler strategy self.crawler_strategy = crawler_strategy or AsyncPlaywrightCrawlerStrategy( - logger = self.logger, - **kwargs + browser_config=browser_config, + logger=self.logger, + **kwargs # Pass remaining kwargs for backwards compatibility ) - # Handle deprecated parameter + # Handle deprecated cache parameter if always_by_pass_cache is not None: if kwargs.get("warning", True): warnings.warn( - "'always_by_pass_cache' is deprecated and will be removed in version X.X.X. " + "'always_by_pass_cache' is deprecated and will be removed in version 0.5.0. " "Use 'always_bypass_cache' instead. " "Pass warning=False to suppress this warning.", DeprecationWarning, @@ -106,13 +115,15 @@ class AsyncWebCrawler: else: self.always_bypass_cache = always_bypass_cache + # Thread safety setup self._lock = asyncio.Lock() if thread_safe else None + # Initialize directories self.crawl4ai_folder = os.path.join(base_directory, ".crawl4ai") os.makedirs(self.crawl4ai_folder, exist_ok=True) os.makedirs(f"{self.crawl4ai_folder}/cache", exist_ok=True) + self.ready = False - self.verbose = kwargs.get("verbose", False) async def __aenter__(self): await self.crawler_strategy.__aenter__() @@ -122,194 +133,212 @@ class AsyncWebCrawler: async def __aexit__(self, exc_type, exc_val, exc_tb): await self.crawler_strategy.__aexit__(exc_type, exc_val, exc_tb) + @asynccontextmanager + async def nullcontext(self): + yield + async def awarmup(self): """Initialize the crawler with warm-up sequence.""" self.logger.info(f"Crawl4AI {crawl4ai_version}", tag="INIT") - # if self.verbose: - # print(f"{Fore.CYAN}{self.tag_format('INIT')} {self.log_icons['INIT']} Crawl4AI {crawl4ai_version}{Style.RESET_ALL}") - # print(f"{Fore.CYAN}{self.tag_format('INIT')} {self.log_icons['INIT']} Warming up AsyncWebCrawler{Style.RESET_ALL}") self.ready = True - # if self.verbose: - # print(f"{Fore.GREEN}{self.tag_format('READY')} {self.log_icons['READY']} AsyncWebCrawler initialized{Style.RESET_ALL}") + + @asynccontextmanager + async def nullcontext(self): + """ๅผ‚ๆญฅ็ฉบไธŠไธ‹ๆ–‡็ฎก็†ๅ™จ""" + yield + async def arun( - self, - url: str, - word_count_threshold=MIN_WORD_THRESHOLD, - extraction_strategy: ExtractionStrategy = None, - chunking_strategy: ChunkingStrategy = RegexChunking(), - content_filter: RelevantContentFilter = None, - cache_mode: Optional[CacheMode] = None, - # Deprecated parameters - bypass_cache: bool = False, - disable_cache: bool = False, - no_cache_read: bool = False, - no_cache_write: bool = False, - # Other parameters - css_selector: str = None, - screenshot: bool = False, - user_agent: str = None, - verbose=True, - **kwargs, - ) -> CrawlResult: - """ - Runs the crawler for a single source: URL (web, local file, or raw HTML). + self, + url: str, + config: Optional[CrawlerRunConfig] = None, + # Legacy parameters maintained for backwards compatibility + word_count_threshold=MIN_WORD_THRESHOLD, + extraction_strategy: ExtractionStrategy = None, + chunking_strategy: ChunkingStrategy = RegexChunking(), + content_filter: RelevantContentFilter = None, + cache_mode: Optional[CacheMode] = None, + # Deprecated cache parameters + bypass_cache: bool = False, + disable_cache: bool = False, + no_cache_read: bool = False, + no_cache_write: bool = False, + # Other legacy parameters + css_selector: str = None, + screenshot: bool = False, + pdf: bool = False, + user_agent: str = None, + verbose=True, + **kwargs, + ) -> CrawlResult: + """ + Runs the crawler for a single source: URL (web, local file, or raw HTML). - Migration from legacy cache parameters: + Migration Guide: Old way (deprecated): - await crawler.arun(url, bypass_cache=True, no_cache_read=True) + result = await crawler.arun( + url="https://example.com", + word_count_threshold=200, + screenshot=True, + ... + ) - New way: - await crawler.arun(url, cache_mode=CacheMode.BYPASS) + New way (recommended): + config = CrawlerRunConfig( + word_count_threshold=200, + screenshot=True, + ... + ) + result = await crawler.arun(url="https://example.com", crawler_config=config) - Args: - url: The URL to crawl (http://, https://, file://, or raw:) - cache_mode: Cache behavior control (recommended) - word_count_threshold: Minimum word count threshold - extraction_strategy: Strategy for content extraction - chunking_strategy: Strategy for content chunking - css_selector: CSS selector for content extraction - screenshot: Whether to capture screenshot - user_agent: Custom user agent - verbose: Enable verbose logging + Args: + url: The URL to crawl (http://, https://, file://, or raw:) + crawler_config: Configuration object controlling crawl behavior + [other parameters maintained for backwards compatibility] - Deprecated Args: - bypass_cache: Use cache_mode=CacheMode.BYPASS instead - disable_cache: Use cache_mode=CacheMode.DISABLED instead - no_cache_read: Use cache_mode=CacheMode.WRITE_ONLY instead - no_cache_write: Use cache_mode=CacheMode.READ_ONLY instead + Returns: + CrawlResult: The result of crawling and processing + """ + crawler_config = config + if not isinstance(url, str) or not url: + raise ValueError("Invalid URL, make sure the URL is a non-empty string") + + async with self._lock or self.nullcontext(): + try: + # Handle configuration + if crawler_config is not None: + if any(param is not None for param in [ + word_count_threshold, extraction_strategy, chunking_strategy, + content_filter, cache_mode, css_selector, screenshot, pdf + ]): + self.logger.warning( + message="Both crawler_config and legacy parameters provided. crawler_config will take precedence.", + tag="WARNING" + ) + config = crawler_config + else: + # Merge all parameters into a single kwargs dict for config creation + config_kwargs = { + "word_count_threshold": word_count_threshold, + "extraction_strategy": extraction_strategy, + "chunking_strategy": chunking_strategy, + "content_filter": content_filter, + "cache_mode": cache_mode, + "bypass_cache": bypass_cache, + "disable_cache": disable_cache, + "no_cache_read": no_cache_read, + "no_cache_write": no_cache_write, + "css_selector": css_selector, + "screenshot": screenshot, + "pdf": pdf, + "verbose": verbose, + **kwargs + } + config = CrawlerRunConfig.from_kwargs(config_kwargs) - Returns: - CrawlResult: The result of crawling and processing - """ - async with self._lock or nullcontext(): - try: - # Handle deprecated parameters - if any([bypass_cache, disable_cache, no_cache_read, no_cache_write]): - if kwargs.get("warning", True): - warnings.warn( - "Cache control boolean flags are deprecated and will be removed in version X.X.X. " - "Use 'cache_mode' parameter instead. Examples:\n" - "- For bypass_cache=True, use cache_mode=CacheMode.BYPASS\n" - "- For disable_cache=True, use cache_mode=CacheMode.DISABLED\n" - "- For no_cache_read=True, use cache_mode=CacheMode.WRITE_ONLY\n" - "- For no_cache_write=True, use cache_mode=CacheMode.READ_ONLY\n" - "Pass warning=False to suppress this warning.", - DeprecationWarning, - stacklevel=2 - ) + # Handle deprecated cache parameters + if any([bypass_cache, disable_cache, no_cache_read, no_cache_write]): + if kwargs.get("warning", True): + warnings.warn( + "Cache control boolean flags are deprecated and will be removed in version 0.5.0. " + "Use 'cache_mode' parameter instead.", + DeprecationWarning, + stacklevel=2 + ) + + # Convert legacy parameters if cache_mode not provided + if config.cache_mode is None: + config.cache_mode = _legacy_to_cache_mode( + disable_cache=disable_cache, + bypass_cache=bypass_cache, + no_cache_read=no_cache_read, + no_cache_write=no_cache_write + ) - # Convert legacy parameters if cache_mode not provided - if cache_mode is None: - cache_mode = _legacy_to_cache_mode( - disable_cache=disable_cache, - bypass_cache=bypass_cache, - no_cache_read=no_cache_read, - no_cache_write=no_cache_write - ) - - # Default to ENABLED if no cache mode specified - if cache_mode is None: - cache_mode = CacheMode.ENABLED + # Default to ENABLED if no cache mode specified + if config.cache_mode is None: + config.cache_mode = CacheMode.ENABLED - # Create cache context - cache_context = CacheContext(url, cache_mode, self.always_bypass_cache) + # Create cache context + cache_context = CacheContext(url, config.cache_mode, self.always_bypass_cache) - extraction_strategy = extraction_strategy or NoExtractionStrategy() - extraction_strategy.verbose = verbose - if not isinstance(extraction_strategy, ExtractionStrategy): - raise ValueError("Unsupported extraction strategy") - if not isinstance(chunking_strategy, ChunkingStrategy): - raise ValueError("Unsupported chunking strategy") - - word_count_threshold = max(word_count_threshold, MIN_WORD_THRESHOLD) + # Initialize processing variables + async_response: AsyncCrawlResponse = None + cached_result = None + screenshot_data = None + pdf_data = None + extracted_content = None + start_time = time.perf_counter() - async_response: AsyncCrawlResponse = None - cached_result = None - screenshot_data = None - extracted_content = None - - start_time = time.perf_counter() - - # Try to get cached result if appropriate - if cache_context.should_read(): - cached_result = await async_db_manager.aget_cached_url(url) - - if cached_result: - html = sanitize_input_encode(cached_result.html) - extracted_content = sanitize_input_encode(cached_result.extracted_content or "") - if screenshot: + # Try to get cached result if appropriate + if cache_context.should_read(): + cached_result = await async_db_manager.aget_cached_url(url) + + if cached_result: + html = sanitize_input_encode(cached_result.html) + extracted_content = sanitize_input_encode(cached_result.extracted_content or "") + # If screenshot is requested but its not in cache, then set cache_result to None screenshot_data = cached_result.screenshot - if not screenshot_data: + pdf_data = cached_result.pdf + if config.screenshot and not screenshot or config.pdf and not pdf: cached_result = None - # if verbose: - # print(f"{Fore.BLUE}{self.tag_format('FETCH')} {self.log_icons['FETCH']} Cache hit for {cache_context.display_url} | Status: {Fore.GREEN if bool(html) else Fore.RED}{bool(html)}{Style.RESET_ALL} | Time: {time.perf_counter() - start_time:.2f}s") - self.logger.url_status( + + self.logger.url_status( url=cache_context.display_url, success=bool(html), timing=time.perf_counter() - start_time, tag="FETCH" - ) + ) + # Fetch fresh content if needed + if not cached_result or not html: + t1 = time.perf_counter() + + if user_agent: + self.crawler_strategy.update_user_agent(user_agent) + + # Pass config to crawl method + async_response = await self.crawler_strategy.crawl( + url, + config=config # Pass the entire config object + ) + + html = sanitize_input_encode(async_response.html) + screenshot_data = async_response.screenshot + pdf_data = async_response.pdf_data + + t2 = time.perf_counter() + self.logger.url_status( + url=cache_context.display_url, + success=bool(html), + timing=t2 - t1, + tag="FETCH" + ) - # Fetch fresh content if needed - if not cached_result or not html: - t1 = time.perf_counter() - - if user_agent: - self.crawler_strategy.update_user_agent(user_agent) - async_response: AsyncCrawlResponse = await self.crawler_strategy.crawl( - url, - screenshot=screenshot, - **kwargs + # Process the HTML content + crawl_result = await self.aprocess_html( + url=url, + html=html, + extracted_content=extracted_content, + config=config, # Pass the config object instead of individual parameters + screenshot=screenshot_data, + pdf_data=pdf_data, + verbose=config.verbose ) - html = sanitize_input_encode(async_response.html) - screenshot_data = async_response.screenshot - t2 = time.perf_counter() - self.logger.url_status( - url=cache_context.display_url, - success=bool(html), - timing=t2 - t1, - tag="FETCH" - ) - # if verbose: - # print(f"{Fore.BLUE}{self.tag_format('FETCH')} {self.log_icons['FETCH']} Live fetch for {cache_context.display_url}... | Status: {Fore.GREEN if bool(html) else Fore.RED}{bool(html)}{Style.RESET_ALL} | Time: {t2 - t1:.2f}s") - # Process the HTML content - crawl_result = await self.aprocess_html( - url=url, - html=html, - extracted_content=extracted_content, - word_count_threshold=word_count_threshold, - extraction_strategy=extraction_strategy, - chunking_strategy=chunking_strategy, - content_filter=content_filter, - css_selector=css_selector, - screenshot=screenshot_data, - verbose=verbose, - is_cached=bool(cached_result), - async_response=async_response, - is_web_url=cache_context.is_web_url, - is_local_file=cache_context.is_local_file, - is_raw_html=cache_context.is_raw_html, - **kwargs, - ) - - # Set response data - if async_response: - crawl_result.status_code = async_response.status_code - crawl_result.response_headers = async_response.response_headers - crawl_result.downloaded_files = async_response.downloaded_files - else: - crawl_result.status_code = 200 - crawl_result.response_headers = cached_result.response_headers if cached_result else {} + # Set response data + if async_response: + crawl_result.status_code = async_response.status_code + crawl_result.response_headers = async_response.response_headers + crawl_result.downloaded_files = async_response.downloaded_files + else: + crawl_result.status_code = 200 + crawl_result.response_headers = cached_result.response_headers if cached_result else {} - crawl_result.success = bool(html) - crawl_result.session_id = kwargs.get("session_id", None) + crawl_result.success = bool(html) + crawl_result.session_id = getattr(config, 'session_id', None) - # if verbose: - # print(f"{Fore.GREEN}{self.tag_format('COMPLETE')} {self.log_icons['COMPLETE']} {cache_context.display_url[:URL_LOG_SHORTEN_LENGTH]}... | Status: {Fore.GREEN if crawl_result.success else Fore.RED}{crawl_result.success} | {Fore.YELLOW}Total: {time.perf_counter() - start_time:.2f}s{Style.RESET_ALL}") - self.logger.success( + self.logger.success( message="{url:.50}... | Status: {status} | Total: {timing}", tag="COMPLETE", params={ @@ -323,250 +352,312 @@ class AsyncWebCrawler: } ) - # Update cache if appropriate - if cache_context.should_write() and not bool(cached_result): - await async_db_manager.acache_url(crawl_result) + # Update cache if appropriate + if cache_context.should_write() and not bool(cached_result): + await async_db_manager.acache_url(crawl_result) - return crawl_result - - except Exception as e: - if not hasattr(e, "msg"): - e.msg = str(e) - # print(f"{Fore.RED}{self.tag_format('ERROR')} {self.log_icons['ERROR']} Failed to crawl {cache_context.display_url[:URL_LOG_SHORTEN_LENGTH]}... | {e.msg}{Style.RESET_ALL}") + return crawl_result + + except Exception as e: + error_context = get_error_context(sys.exc_info()) - self.logger.error_status( - url=cache_context.display_url, - error=create_box_message(e.msg, type = "error"), - tag="ERROR" - ) - return CrawlResult( - url=url, - html="", - success=False, - error_message=e.msg - ) - - async def arun_many( - self, - urls: List[str], - word_count_threshold=MIN_WORD_THRESHOLD, - extraction_strategy: ExtractionStrategy = None, - chunking_strategy: ChunkingStrategy = RegexChunking(), - content_filter: RelevantContentFilter = None, - cache_mode: Optional[CacheMode] = None, - # Deprecated parameters - bypass_cache: bool = False, - css_selector: str = None, - screenshot: bool = False, - user_agent: str = None, - verbose=True, - **kwargs, - ) -> List[CrawlResult]: - """ - Runs the crawler for multiple URLs concurrently. - - Migration from legacy parameters: - Old way (deprecated): - results = await crawler.arun_many(urls, bypass_cache=True) - - New way: - results = await crawler.arun_many(urls, cache_mode=CacheMode.BYPASS) - - Args: - urls: List of URLs to crawl - cache_mode: Cache behavior control (recommended) - [other parameters same as arun()] - - Returns: - List[CrawlResult]: Results for each URL - """ - if bypass_cache: - if kwargs.get("warning", True): - warnings.warn( - "'bypass_cache' is deprecated and will be removed in version X.X.X. " - "Use 'cache_mode=CacheMode.BYPASS' instead. " - "Pass warning=False to suppress this warning.", - DeprecationWarning, - stacklevel=2 - ) - if cache_mode is None: - cache_mode = CacheMode.BYPASS - - semaphore_count = kwargs.get('semaphore_count', 10) - semaphore = asyncio.Semaphore(semaphore_count) - - async def crawl_with_semaphore(url): - domain = urlparse(url).netloc - current_time = time.time() - - # print(f"{Fore.LIGHTBLACK_EX}{self.tag_format('PARALLEL')} Started task for {url[:50]}...{Style.RESET_ALL}") - self.logger.debug( - message="Started task for {url:.50}...", - tag="PARALLEL", - params={"url": url} - ) - - # Get delay settings from kwargs or use defaults - mean_delay = kwargs.get('mean_delay', 0.1) # 0.5 seconds default mean delay - max_range = kwargs.get('max_range', 0.3) # 1 seconds default max additional delay - - # Check if we need to wait - if domain in self._domain_last_hit: - time_since_last = current_time - self._domain_last_hit[domain] - if time_since_last < mean_delay: - delay = mean_delay + random.uniform(0, max_range) - await asyncio.sleep(delay) - - # Update last hit time - self._domain_last_hit[domain] = current_time + error_message = ( + f"Unexpected error in _crawl_web at line {error_context['line_no']} " + f"in {error_context['function']} ({error_context['filename']}):\n" + f"Error: {str(e)}\n\n" + f"Code context:\n{error_context['code_context']}" + ) + # if not hasattr(e, "msg"): + # e.msg = str(e) - async with semaphore: - return await self.arun( - url, - word_count_threshold=word_count_threshold, - extraction_strategy=extraction_strategy, - chunking_strategy=chunking_strategy, - content_filter=content_filter, - cache_mode=cache_mode, - css_selector=css_selector, - screenshot=screenshot, - user_agent=user_agent, - verbose=verbose, - **kwargs, - ) - - # Print start message - # print(f"{Fore.CYAN}{self.tag_format('INIT')} {self.log_icons['INIT']} Starting concurrent crawling for {len(urls)} URLs...{Style.RESET_ALL}") - self.logger.info( - message="Starting concurrent crawling for {count} URLs...", - tag="INIT", - params={"count": len(urls)} - ) - start_time = time.perf_counter() - tasks = [crawl_with_semaphore(url) for url in urls] - results = await asyncio.gather(*tasks, return_exceptions=True) - end_time = time.perf_counter() - # print(f"{Fore.YELLOW}{self.tag_format('COMPLETE')} {self.log_icons['COMPLETE']} Concurrent crawling completed for {len(urls)} URLs | Total time: {end_time - start_time:.2f}s{Style.RESET_ALL}") - self.logger.success( - message="Concurrent crawling completed for {count} URLs | " + Fore.YELLOW + " Total time: {timing}" + Style.RESET_ALL, - tag="COMPLETE", - params={ - "count": len(urls), - "timing": f"{end_time - start_time:.2f}s" - }, - colors={"timing": Fore.YELLOW} - ) - return [result if not isinstance(result, Exception) else str(result) for result in results] - + self.logger.error_status( + url=url, + error=create_box_message(error_message, type="error"), + tag="ERROR" + ) + + return CrawlResult( + url=url, + html="", + success=False, + error_message=error_message + ) async def aprocess_html( - self, - url: str, - html: str, - extracted_content: str, - word_count_threshold: int, - extraction_strategy: ExtractionStrategy, - chunking_strategy: ChunkingStrategy, - content_filter: RelevantContentFilter, - css_selector: str, - screenshot: str, - verbose: bool, - **kwargs, - ) -> CrawlResult: - # Extract content from HTML - try: - _url = url if not kwargs.get("is_raw_html", False) else "Raw HTML" - t1 = time.perf_counter() - scrapping_strategy = WebScrapingStrategy( - logger=self.logger, - ) - # result = await scrapping_strategy.ascrap( - result = scrapping_strategy.scrap( - url, - html, - word_count_threshold=word_count_threshold, - css_selector=css_selector, - only_text=kwargs.pop("only_text", False), - image_description_min_word_threshold=kwargs.pop( - "image_description_min_word_threshold", IMAGE_DESCRIPTION_MIN_WORD_THRESHOLD - ), - content_filter = content_filter, - **kwargs, - ) + self, + url: str, + html: str, + extracted_content: str, + config: CrawlerRunConfig, + screenshot: str, + pdf_data: str, + verbose: bool, + **kwargs, + ) -> CrawlResult: + """ + Process HTML content using the provided configuration. + + Args: + url: The URL being processed + html: Raw HTML content + extracted_content: Previously extracted content (if any) + config: Configuration object controlling processing behavior + screenshot: Screenshot data (if any) + verbose: Whether to enable verbose logging + **kwargs: Additional parameters for backwards compatibility + + Returns: + CrawlResult: Processed result containing extracted and formatted content + """ + try: + _url = url if not kwargs.get("is_raw_html", False) else "Raw HTML" + t1 = time.perf_counter() - if result is None: - raise ValueError(f"Process HTML, Failed to extract content from the website: {url}") - except InvalidCSSSelectorError as e: - raise ValueError(str(e)) - except Exception as e: - raise ValueError(f"Process HTML, Failed to extract content from the website: {url}, error: {str(e)}") + # Initialize scraping strategy + scrapping_strategy = WebScrapingStrategy(logger=self.logger) - markdown_v2: MarkdownGenerationResult = result.get("markdown_v2", None) - - cleaned_html = sanitize_input_encode(result.get("cleaned_html", "")) - markdown = sanitize_input_encode(result.get("markdown", "")) - fit_markdown = sanitize_input_encode(result.get("fit_markdown", "")) - fit_html = sanitize_input_encode(result.get("fit_html", "")) - media = result.get("media", []) - links = result.get("links", []) - metadata = result.get("metadata", {}) - - # if verbose: - # print(f"{Fore.MAGENTA}{self.tag_format('SCRAPE')} {self.log_icons['SCRAPE']} Processed {_url[:URL_LOG_SHORTEN_LENGTH]}...{Style.RESET_ALL} | Time: {int((time.perf_counter() - t1) * 1000)}ms") - self.logger.info( - message="Processed {url:.50}... | Time: {timing}ms", - tag="SCRAPE", - params={ - "url": _url, - "timing": int((time.perf_counter() - t1) * 1000) - } - ) + # Process HTML content + result = scrapping_strategy.scrap( + url, + html, + word_count_threshold=config.word_count_threshold, + css_selector=config.css_selector, + only_text=config.only_text, + image_description_min_word_threshold=config.image_description_min_word_threshold, + content_filter=config.content_filter + ) + if result is None: + raise ValueError(f"Process HTML, Failed to extract content from the website: {url}") - if extracted_content is None and extraction_strategy and chunking_strategy and not isinstance(extraction_strategy, NoExtractionStrategy): - t1 = time.perf_counter() - # Check if extraction strategy is type of JsonCssExtractionStrategy - if isinstance(extraction_strategy, JsonCssExtractionStrategy) or isinstance(extraction_strategy, JsonCssExtractionStrategy): - extraction_strategy.verbose = verbose - extracted_content = extraction_strategy.run(url, [html]) - extracted_content = json.dumps(extracted_content, indent=4, default=str, ensure_ascii=False) - else: - sections = chunking_strategy.chunk(markdown) - extracted_content = extraction_strategy.run(url, sections) - extracted_content = json.dumps(extracted_content, indent=4, default=str, ensure_ascii=False) - # if verbose: - # print(f"{Fore.YELLOW}{self.tag_format('EXTRACT')} {self.log_icons['EXTRACT']} Completed for {_url[:URL_LOG_SHORTEN_LENGTH]}...{Style.RESET_ALL} | Time: {time.perf_counter() - t1:.2f}s{Style.RESET_ALL}") + except InvalidCSSSelectorError as e: + raise ValueError(str(e)) + except Exception as e: + raise ValueError(f"Process HTML, Failed to extract content from the website: {url}, error: {str(e)}") + + # Extract results + markdown_v2 = result.get("markdown_v2", None) + cleaned_html = sanitize_input_encode(result.get("cleaned_html", "")) + markdown = sanitize_input_encode(result.get("markdown", "")) + fit_markdown = sanitize_input_encode(result.get("fit_markdown", "")) + fit_html = sanitize_input_encode(result.get("fit_html", "")) + media = result.get("media", []) + links = result.get("links", []) + metadata = result.get("metadata", {}) + + # Log processing completion self.logger.info( - message="Completed for {url:.50}... | Time: {timing}s", - tag="EXTRACT", + message="Processed {url:.50}... | Time: {timing}ms", + tag="SCRAPE", params={ "url": _url, - "timing": time.perf_counter() - t1 + "timing": int((time.perf_counter() - t1) * 1000) } ) - screenshot = None if not screenshot else screenshot - - - if kwargs.get("prettiify", False): - cleaned_html = fast_format_html(cleaned_html) - - return CrawlResult( - url=url, - html=html, - cleaned_html=cleaned_html, - markdown_v2=markdown_v2, - markdown=markdown, - fit_markdown=fit_markdown, - fit_html= fit_html, - media=media, - links=links, - metadata=metadata, - screenshot=screenshot, - extracted_content=extracted_content, - success=True, - error_message="", - ) + # Handle content extraction if needed + if (extracted_content is None and + config.extraction_strategy and + config.chunking_strategy and + not isinstance(config.extraction_strategy, NoExtractionStrategy)): + + t1 = time.perf_counter() + + # Handle different extraction strategy types + if isinstance(config.extraction_strategy, (JsonCssExtractionStrategy, JsonCssExtractionStrategy)): + config.extraction_strategy.verbose = verbose + extracted_content = config.extraction_strategy.run(url, [html]) + extracted_content = json.dumps(extracted_content, indent=4, default=str, ensure_ascii=False) + else: + sections = config.chunking_strategy.chunk(markdown) + extracted_content = config.extraction_strategy.run(url, sections) + extracted_content = json.dumps(extracted_content, indent=4, default=str, ensure_ascii=False) + + # Log extraction completion + self.logger.info( + message="Completed for {url:.50}... | Time: {timing}s", + tag="EXTRACT", + params={ + "url": _url, + "timing": time.perf_counter() - t1 + } + ) + + # Handle screenshot and PDF data + screenshot_data = None if not screenshot else screenshot + pdf_data = None if not pdf_data else pdf_data + + # Apply HTML formatting if requested + if config.prettiify: + cleaned_html = fast_format_html(cleaned_html) + + # Return complete crawl result + return CrawlResult( + url=url, + html=html, + cleaned_html=cleaned_html, + markdown_v2=markdown_v2, + markdown=markdown, + fit_markdown=fit_markdown, + fit_html=fit_html, + media=media, + links=links, + metadata=metadata, + screenshot=screenshot_data, + pdf=pdf_data, + extracted_content=extracted_content, + success=True, + error_message="", + ) + + async def arun_many( + self, + urls: List[str], + config: Optional[CrawlerRunConfig] = None, + # Legacy parameters maintained for backwards compatibility + word_count_threshold=MIN_WORD_THRESHOLD, + extraction_strategy: ExtractionStrategy = None, + chunking_strategy: ChunkingStrategy = RegexChunking(), + content_filter: RelevantContentFilter = None, + cache_mode: Optional[CacheMode] = None, + bypass_cache: bool = False, + css_selector: str = None, + screenshot: bool = False, + pdf: bool = False, + user_agent: str = None, + verbose=True, + **kwargs, + ) -> List[CrawlResult]: + """ + Runs the crawler for multiple URLs concurrently. + + Migration Guide: + Old way (deprecated): + results = await crawler.arun_many( + urls, + word_count_threshold=200, + screenshot=True, + ... + ) + + New way (recommended): + config = CrawlerRunConfig( + word_count_threshold=200, + screenshot=True, + ... + ) + results = await crawler.arun_many(urls, crawler_config=config) + + Args: + urls: List of URLs to crawl + crawler_config: Configuration object controlling crawl behavior for all URLs + [other parameters maintained for backwards compatibility] + + Returns: + List[CrawlResult]: Results for each URL + """ + crawler_config = config + # Handle configuration + if crawler_config is not None: + if any(param is not None for param in [ + word_count_threshold, extraction_strategy, chunking_strategy, + content_filter, cache_mode, css_selector, screenshot, pdf + ]): + self.logger.warning( + message="Both crawler_config and legacy parameters provided. crawler_config will take precedence.", + tag="WARNING" + ) + config = crawler_config + else: + # Merge all parameters into a single kwargs dict for config creation + config_kwargs = { + "word_count_threshold": word_count_threshold, + "extraction_strategy": extraction_strategy, + "chunking_strategy": chunking_strategy, + "content_filter": content_filter, + "cache_mode": cache_mode, + "bypass_cache": bypass_cache, + "css_selector": css_selector, + "screenshot": screenshot, + "pdf": pdf, + "verbose": verbose, + **kwargs + } + config = CrawlerRunConfig.from_kwargs(config_kwargs) + + if bypass_cache: + if kwargs.get("warning", True): + warnings.warn( + "'bypass_cache' is deprecated and will be removed in version 0.5.0. " + "Use 'cache_mode=CacheMode.BYPASS' instead. " + "Pass warning=False to suppress this warning.", + DeprecationWarning, + stacklevel=2 + ) + if config.cache_mode is None: + config.cache_mode = CacheMode.BYPASS + + semaphore_count = config.semaphore_count or 5 + semaphore = asyncio.Semaphore(semaphore_count) + + async def crawl_with_semaphore(url): + # Handle rate limiting per domain + domain = urlparse(url).netloc + current_time = time.time() + + self.logger.debug( + message="Started task for {url:.50}...", + tag="PARALLEL", + params={"url": url} + ) + + # Get delay settings from config + mean_delay = config.mean_delay + max_range = config.max_range + + # Apply rate limiting + if domain in self._domain_last_hit: + time_since_last = current_time - self._domain_last_hit[domain] + if time_since_last < mean_delay: + delay = mean_delay + random.uniform(0, max_range) + await asyncio.sleep(delay) + + self._domain_last_hit[domain] = current_time + + async with semaphore: + return await self.arun( + url, + crawler_config=config, # Pass the entire config object + user_agent=user_agent # Maintain user_agent override capability + ) + + # Log start of concurrent crawling + self.logger.info( + message="Starting concurrent crawling for {count} URLs...", + tag="INIT", + params={"count": len(urls)} + ) + + # Execute concurrent crawls + start_time = time.perf_counter() + tasks = [crawl_with_semaphore(url) for url in urls] + results = await asyncio.gather(*tasks, return_exceptions=True) + end_time = time.perf_counter() + + # Log completion + self.logger.success( + message="Concurrent crawling completed for {count} URLs | Total time: {timing}", + tag="COMPLETE", + params={ + "count": len(urls), + "timing": f"{end_time - start_time:.2f}s" + }, + colors={ + "timing": Fore.YELLOW + } + ) + + return [result if not isinstance(result, Exception) else str(result) for result in results] async def aclear_cache(self): """Clear the cache database.""" diff --git a/crawl4ai/config.py b/crawl4ai/config.py index 786ca4e5..7c8a9314 100644 --- a/crawl4ai/config.py +++ b/crawl4ai/config.py @@ -56,4 +56,7 @@ MAX_METRICS_HISTORY = 1000 NEED_MIGRATION = True URL_LOG_SHORTEN_LENGTH = 30 -SHOW_DEPRECATION_WARNINGS = True \ No newline at end of file +SHOW_DEPRECATION_WARNINGS = True +SCREENSHOT_HEIGHT_TRESHOLD = 10000 +PAGE_TIMEOUT=60000 +DOWNLOAD_PAGE_TIMEOUT=60000 \ No newline at end of file diff --git a/crawl4ai/content_scraping_strategy.py b/crawl4ai/content_scraping_strategy.py index 970c40f0..f58e1eac 100644 --- a/crawl4ai/content_scraping_strategy.py +++ b/crawl4ai/content_scraping_strategy.py @@ -14,15 +14,11 @@ from .content_filter_strategy import RelevantContentFilter, BM25ContentFilter#, from .markdown_generation_strategy import MarkdownGenerationStrategy, DefaultMarkdownGenerator from .models import MarkdownGenerationResult from .utils import ( - sanitize_input_encode, - sanitize_html, extract_metadata, - InvalidCSSSelectorError, - CustomHTML2Text, normalize_url, is_external_url ) -from .tools import profile_and_time + # Pre-compile regular expressions for Open Graph and Twitter metadata OG_REGEX = re.compile(r'^og:') @@ -76,10 +72,10 @@ class WebScrapingStrategy(ContentScrapingStrategy): log_method(message=message, tag=tag, **kwargs) def scrap(self, url: str, html: str, **kwargs) -> Dict[str, Any]: - return self._get_content_of_website_optimized(url, html, is_async=False, **kwargs) + return self._scrap(url, html, is_async=False, **kwargs) async def ascrap(self, url: str, html: str, **kwargs) -> Dict[str, Any]: - return await asyncio.to_thread(self._get_content_of_website_optimized, url, html, **kwargs) + return await asyncio.to_thread(self._scrap, url, html, **kwargs) def _generate_markdown_content(self, cleaned_html: str, @@ -103,8 +99,6 @@ class WebScrapingStrategy(ContentScrapingStrategy): html2text_options=kwargs.get('html2text', {}) ) - help_message = """""" - return { 'markdown': markdown_result.raw_markdown, 'fit_markdown': markdown_result.fit_markdown, @@ -126,38 +120,40 @@ class WebScrapingStrategy(ContentScrapingStrategy): } # Legacy method - h = CustomHTML2Text() - h.update_params(**kwargs.get('html2text', {})) - markdown = h.handle(cleaned_html) - markdown = markdown.replace(' ```', '```') + """ + # h = CustomHTML2Text() + # h.update_params(**kwargs.get('html2text', {})) + # markdown = h.handle(cleaned_html) + # markdown = markdown.replace(' ```', '```') - fit_markdown = "Set flag 'fit_markdown' to True to get cleaned HTML content." - fit_html = "Set flag 'fit_markdown' to True to get cleaned HTML content." + # fit_markdown = "Set flag 'fit_markdown' to True to get cleaned HTML content." + # fit_html = "Set flag 'fit_markdown' to True to get cleaned HTML content." - if kwargs.get('content_filter', None) or kwargs.get('fit_markdown', False): - content_filter = kwargs.get('content_filter', None) - if not content_filter: - content_filter = BM25ContentFilter( - user_query=kwargs.get('fit_markdown_user_query', None), - bm25_threshold=kwargs.get('fit_markdown_bm25_threshold', 1.0) - ) - fit_html = content_filter.filter_content(html) - fit_html = '\n'.join('
{}
'.format(s) for s in fit_html) - fit_markdown = h.handle(fit_html) + # if kwargs.get('content_filter', None) or kwargs.get('fit_markdown', False): + # content_filter = kwargs.get('content_filter', None) + # if not content_filter: + # content_filter = BM25ContentFilter( + # user_query=kwargs.get('fit_markdown_user_query', None), + # bm25_threshold=kwargs.get('fit_markdown_bm25_threshold', 1.0) + # ) + # fit_html = content_filter.filter_content(html) + # fit_html = '\n'.join('
{}
'.format(s) for s in fit_html) + # fit_markdown = h.handle(fit_html) - markdown_v2 = MarkdownGenerationResult( - raw_markdown=markdown, - markdown_with_citations=markdown, - references_markdown=markdown, - fit_markdown=fit_markdown - ) + # markdown_v2 = MarkdownGenerationResult( + # raw_markdown=markdown, + # markdown_with_citations=markdown, + # references_markdown=markdown, + # fit_markdown=fit_markdown + # ) - return { - 'markdown': markdown, - 'fit_markdown': fit_markdown, - 'fit_html': fit_html, - 'markdown_v2' : markdown_v2 - } + # return { + # 'markdown': markdown, + # 'fit_markdown': fit_markdown, + # 'fit_html': fit_html, + # 'markdown_v2' : markdown_v2 + # } + """ def flatten_nested_elements(self, node): if isinstance(node, NavigableString): @@ -483,7 +479,7 @@ class WebScrapingStrategy(ContentScrapingStrategy): ) return False - def _get_content_of_website_optimized(self, url: str, html: str, word_count_threshold: int = MIN_WORD_THRESHOLD, css_selector: str = None, **kwargs) -> Dict[str, Any]: + def _scrap(self, url: str, html: str, word_count_threshold: int = MIN_WORD_THRESHOLD, css_selector: str = None, **kwargs) -> Dict[str, Any]: success = True if not html: return None diff --git a/crawl4ai/extraction_strategy.py b/crawl4ai/extraction_strategy.py index b79e0c43..50e5da36 100644 --- a/crawl4ai/extraction_strategy.py +++ b/crawl4ai/extraction_strategy.py @@ -92,8 +92,10 @@ class LLMExtractionStrategy(ExtractionStrategy): def extract(self, url: str, ix:int, html: str) -> List[Dict[str, Any]]: - # print("[LOG] Extracting blocks from URL:", url) - print(f"[LOG] Call LLM for {url} - block index: {ix}") + if self.verbose: + # print("[LOG] Extracting blocks from URL:", url) + print(f"[LOG] Call LLM for {url} - block index: {ix}") + variable_values = { "URL": url, "HTML": escape_json_string(sanitize_html(html)), @@ -632,7 +634,7 @@ class ContentSummarizationStrategy(ExtractionStrategy): # Sort summaries by the original section index to maintain order summaries.sort(key=lambda x: x[0]) return [summary for _, summary in summaries] - + class JsonCssExtractionStrategy(ExtractionStrategy): def __init__(self, schema: Dict[str, Any], **kwargs): super().__init__(**kwargs) @@ -868,4 +870,4 @@ class JsonXPATHExtractionStrategy(ExtractionStrategy): def run(self, url: str, sections: List[str], *q, **kwargs) -> List[Dict[str, Any]]: combined_html = self.DEL.join(sections) - return self.extract(url, combined_html, **kwargs) \ No newline at end of file + return self.extract(url, combined_html, **kwargs) diff --git a/crawl4ai/html2text/__init__.py b/crawl4ai/html2text/__init__.py index c1effe6b..c41258e0 100644 --- a/crawl4ai/html2text/__init__.py +++ b/crawl4ai/html2text/__init__.py @@ -1006,10 +1006,136 @@ class HTML2Text(html.parser.HTMLParser): newlines += 1 return result - def html2text(html: str, baseurl: str = "", bodywidth: Optional[int] = None) -> str: if bodywidth is None: bodywidth = config.BODY_WIDTH h = HTML2Text(baseurl=baseurl, bodywidth=bodywidth) return h.handle(html) + +class CustomHTML2Text(HTML2Text): + def __init__(self, *args, handle_code_in_pre=False, **kwargs): + super().__init__(*args, **kwargs) + self.inside_pre = False + self.inside_code = False + self.preserve_tags = set() # Set of tags to preserve + self.current_preserved_tag = None + self.preserved_content = [] + self.preserve_depth = 0 + self.handle_code_in_pre = handle_code_in_pre + + # Configuration options + self.skip_internal_links = False + self.single_line_break = False + self.mark_code = False + self.include_sup_sub = False + self.body_width = 0 + self.ignore_mailto_links = True + self.ignore_links = False + self.escape_backslash = False + self.escape_dot = False + self.escape_plus = False + self.escape_dash = False + self.escape_snob = False + + def update_params(self, **kwargs): + """Update parameters and set preserved tags.""" + for key, value in kwargs.items(): + if key == 'preserve_tags': + self.preserve_tags = set(value) + elif key == 'handle_code_in_pre': + self.handle_code_in_pre = value + else: + setattr(self, key, value) + + def handle_tag(self, tag, attrs, start): + # Handle preserved tags + if tag in self.preserve_tags: + if start: + if self.preserve_depth == 0: + self.current_preserved_tag = tag + self.preserved_content = [] + # Format opening tag with attributes + attr_str = ''.join(f' {k}="{v}"' for k, v in attrs.items() if v is not None) + self.preserved_content.append(f'<{tag}{attr_str}>') + self.preserve_depth += 1 + return + else: + self.preserve_depth -= 1 + if self.preserve_depth == 0: + self.preserved_content.append(f'') + # Output the preserved HTML block with proper spacing + preserved_html = ''.join(self.preserved_content) + self.o('\n' + preserved_html + '\n') + self.current_preserved_tag = None + return + + # If we're inside a preserved tag, collect all content + if self.preserve_depth > 0: + if start: + # Format nested tags with attributes + attr_str = ''.join(f' {k}="{v}"' for k, v in attrs.items() if v is not None) + self.preserved_content.append(f'<{tag}{attr_str}>') + else: + self.preserved_content.append(f'') + return + + # Handle pre tags + if tag == 'pre': + if start: + self.o('```\n') # Markdown code block start + self.inside_pre = True + else: + self.o('\n```\n') # Markdown code block end + self.inside_pre = False + elif tag == 'code': + if self.inside_pre and not self.handle_code_in_pre: + # Ignore code tags inside pre blocks if handle_code_in_pre is False + return + if start: + self.o('`') # Markdown inline code start + self.inside_code = True + else: + self.o('`') # Markdown inline code end + self.inside_code = False + else: + super().handle_tag(tag, attrs, start) + + def handle_data(self, data, entity_char=False): + """Override handle_data to capture content within preserved tags.""" + if self.preserve_depth > 0: + self.preserved_content.append(data) + return + + if self.inside_pre: + # Output the raw content for pre blocks, including content inside code tags + self.o(data) # Directly output the data as-is (preserve newlines) + return + if self.inside_code: + # Inline code: no newlines allowed + self.o(data.replace('\n', ' ')) + return + + # Default behavior for other tags + super().handle_data(data, entity_char) + + + # # Handle pre tags + # if tag == 'pre': + # if start: + # self.o('```\n') + # self.inside_pre = True + # else: + # self.o('\n```') + # self.inside_pre = False + # # elif tag in ["h1", "h2", "h3", "h4", "h5", "h6"]: + # # pass + # else: + # super().handle_tag(tag, attrs, start) + + # def handle_data(self, data, entity_char=False): + # """Override handle_data to capture content within preserved tags.""" + # if self.preserve_depth > 0: + # self.preserved_content.append(data) + # return + # super().handle_data(data, entity_char) diff --git a/crawl4ai/js_snippet/__init__.py b/crawl4ai/js_snippet/__init__.py new file mode 100644 index 00000000..73b0c2dd --- /dev/null +++ b/crawl4ai/js_snippet/__init__.py @@ -0,0 +1,15 @@ +import os, sys + +# Create a function get name of a js script, then load from the CURRENT folder of this script and return its content as string, make sure its error free +def load_js_script(script_name): + # Get the path of the current script + current_script_path = os.path.dirname(os.path.realpath(__file__)) + # Get the path of the script to load + script_path = os.path.join(current_script_path, script_name + '.js') + # Check if the script exists + if not os.path.exists(script_path): + raise ValueError(f"Script {script_name} not found in the folder {current_script_path}") + # Load the content of the script + with open(script_path, 'r') as f: + script_content = f.read() + return script_content diff --git a/crawl4ai/js_snippet/navigator_overrider.js b/crawl4ai/js_snippet/navigator_overrider.js new file mode 100644 index 00000000..f341ceeb --- /dev/null +++ b/crawl4ai/js_snippet/navigator_overrider.js @@ -0,0 +1,25 @@ +// Pass the Permissions Test. +const originalQuery = window.navigator.permissions.query; +window.navigator.permissions.query = (parameters) => + parameters.name === "notifications" + ? Promise.resolve({ state: Notification.permission }) + : originalQuery(parameters); +Object.defineProperty(navigator, "webdriver", { + get: () => undefined, +}); +window.navigator.chrome = { + runtime: {}, + // Add other properties if necessary +}; +Object.defineProperty(navigator, "plugins", { + get: () => [1, 2, 3, 4, 5], +}); +Object.defineProperty(navigator, "languages", { + get: () => ["en-US", "en"], +}); +Object.defineProperty(document, "hidden", { + get: () => false, +}); +Object.defineProperty(document, "visibilityState", { + get: () => "visible", +}); diff --git a/crawl4ai/js_snippet/remove_overlay_elements.js b/crawl4ai/js_snippet/remove_overlay_elements.js new file mode 100644 index 00000000..0400d89c --- /dev/null +++ b/crawl4ai/js_snippet/remove_overlay_elements.js @@ -0,0 +1,119 @@ +async () => { + // Function to check if element is visible + const isVisible = (elem) => { + const style = window.getComputedStyle(elem); + return style.display !== "none" && style.visibility !== "hidden" && style.opacity !== "0"; + }; + + // Common selectors for popups and overlays + const commonSelectors = [ + // Close buttons first + 'button[class*="close" i]', + 'button[class*="dismiss" i]', + 'button[aria-label*="close" i]', + 'button[title*="close" i]', + 'a[class*="close" i]', + 'span[class*="close" i]', + + // Cookie notices + '[class*="cookie-banner" i]', + '[id*="cookie-banner" i]', + '[class*="cookie-consent" i]', + '[id*="cookie-consent" i]', + + // Newsletter/subscription dialogs + '[class*="newsletter" i]', + '[class*="subscribe" i]', + + // Generic popups/modals + '[class*="popup" i]', + '[class*="modal" i]', + '[class*="overlay" i]', + '[class*="dialog" i]', + '[role="dialog"]', + '[role="alertdialog"]', + ]; + + // Try to click close buttons first + for (const selector of commonSelectors.slice(0, 6)) { + const closeButtons = document.querySelectorAll(selector); + for (const button of closeButtons) { + if (isVisible(button)) { + try { + button.click(); + await new Promise((resolve) => setTimeout(resolve, 100)); + } catch (e) { + console.log("Error clicking button:", e); + } + } + } + } + + // Remove remaining overlay elements + const removeOverlays = () => { + // Find elements with high z-index + const allElements = document.querySelectorAll("*"); + for (const elem of allElements) { + const style = window.getComputedStyle(elem); + const zIndex = parseInt(style.zIndex); + const position = style.position; + + if ( + isVisible(elem) && + (zIndex > 999 || position === "fixed" || position === "absolute") && + (elem.offsetWidth > window.innerWidth * 0.5 || + elem.offsetHeight > window.innerHeight * 0.5 || + style.backgroundColor.includes("rgba") || + parseFloat(style.opacity) < 1) + ) { + elem.remove(); + } + } + + // Remove elements matching common selectors + for (const selector of commonSelectors) { + const elements = document.querySelectorAll(selector); + elements.forEach((elem) => { + if (isVisible(elem)) { + elem.remove(); + } + }); + } + }; + + // Remove overlay elements + removeOverlays(); + + // Remove any fixed/sticky position elements at the top/bottom + const removeFixedElements = () => { + const elements = document.querySelectorAll("*"); + elements.forEach((elem) => { + const style = window.getComputedStyle(elem); + if ((style.position === "fixed" || style.position === "sticky") && isVisible(elem)) { + elem.remove(); + } + }); + }; + + removeFixedElements(); + + // Remove empty block elements as: div, p, span, etc. + const removeEmptyBlockElements = () => { + const blockElements = document.querySelectorAll( + "div, p, span, section, article, header, footer, aside, nav, main, ul, ol, li, dl, dt, dd, h1, h2, h3, h4, h5, h6" + ); + blockElements.forEach((elem) => { + if (elem.innerText.trim() === "") { + elem.remove(); + } + }); + }; + + // Remove margin-right and padding-right from body (often added by modal scripts) + document.body.style.marginRight = "0px"; + document.body.style.paddingRight = "0px"; + document.body.style.overflow = "auto"; + + // Wait a bit for any animations to complete + await new Promise((resolve) => setTimeout(resolve, 100)); +}; diff --git a/crawl4ai/js_snippet/update_image_dimensions.js b/crawl4ai/js_snippet/update_image_dimensions.js new file mode 100644 index 00000000..709a35d5 --- /dev/null +++ b/crawl4ai/js_snippet/update_image_dimensions.js @@ -0,0 +1,54 @@ +() => { + return new Promise((resolve) => { + const filterImage = (img) => { + // Filter out images that are too small + if (img.width < 100 && img.height < 100) return false; + + // Filter out images that are not visible + const rect = img.getBoundingClientRect(); + if (rect.width === 0 || rect.height === 0) return false; + + // Filter out images with certain class names (e.g., icons, thumbnails) + if (img.classList.contains("icon") || img.classList.contains("thumbnail")) return false; + + // Filter out images with certain patterns in their src (e.g., placeholder images) + if (img.src.includes("placeholder") || img.src.includes("icon")) return false; + + return true; + }; + + const images = Array.from(document.querySelectorAll("img")).filter(filterImage); + let imagesLeft = images.length; + + if (imagesLeft === 0) { + resolve(); + return; + } + + const checkImage = (img) => { + if (img.complete && img.naturalWidth !== 0) { + img.setAttribute("width", img.naturalWidth); + img.setAttribute("height", img.naturalHeight); + imagesLeft--; + if (imagesLeft === 0) resolve(); + } + }; + + images.forEach((img) => { + checkImage(img); + if (!img.complete) { + img.onload = () => { + checkImage(img); + }; + img.onerror = () => { + imagesLeft--; + if (imagesLeft === 0) resolve(); + }; + } + }); + + // Fallback timeout of 5 seconds + // setTimeout(() => resolve(), 5000); + resolve(); + }); +}; diff --git a/crawl4ai/markdown_generation_strategy.py b/crawl4ai/markdown_generation_strategy.py index 1e0ca664..b9e4b0c6 100644 --- a/crawl4ai/markdown_generation_strategy.py +++ b/crawl4ai/markdown_generation_strategy.py @@ -1,7 +1,7 @@ from abc import ABC, abstractmethod from typing import Optional, Dict, Any, Tuple from .models import MarkdownGenerationResult -from .utils import CustomHTML2Text +from .html2text import CustomHTML2Text from .content_filter_strategy import RelevantContentFilter, BM25ContentFilter import re from urllib.parse import urljoin @@ -9,6 +9,17 @@ from urllib.parse import urljoin # Pre-compile the regex pattern LINK_PATTERN = re.compile(r'!?\[([^\]]+)\]\(([^)]+?)(?:\s+"([^"]*)")?\)') +def fast_urljoin(base: str, url: str) -> str: + """Fast URL joining for common cases.""" + if url.startswith(('http://', 'https://', 'mailto:', '//')): + return url + if url.startswith('/'): + # Handle absolute paths + if base.endswith('/'): + return base[:-1] + url + return base + url + return urljoin(base, url) + class MarkdownGenerationStrategy(ABC): """Abstract base class for markdown generation strategies.""" def __init__(self, content_filter: Optional[RelevantContentFilter] = None, options: Optional[Dict[str, Any]] = None): @@ -118,13 +129,3 @@ class DefaultMarkdownGenerator(MarkdownGenerationStrategy): fit_html=filtered_html, ) -def fast_urljoin(base: str, url: str) -> str: - """Fast URL joining for common cases.""" - if url.startswith(('http://', 'https://', 'mailto:', '//')): - return url - if url.startswith('/'): - # Handle absolute paths - if base.endswith('/'): - return base[:-1] + url - return base + url - return urljoin(base, url) \ No newline at end of file diff --git a/crawl4ai/models.py b/crawl4ai/models.py index 3a1b8bd1..315069fb 100644 --- a/crawl4ai/models.py +++ b/crawl4ai/models.py @@ -23,6 +23,7 @@ class CrawlResult(BaseModel): links: Dict[str, List[Dict]] = {} downloaded_files: Optional[List[str]] = None screenshot: Optional[str] = None + pdf : Optional[bytes] = None markdown: Optional[Union[str, MarkdownGenerationResult]] = None markdown_v2: Optional[MarkdownGenerationResult] = None fit_markdown: Optional[str] = None @@ -39,6 +40,7 @@ class AsyncCrawlResponse(BaseModel): response_headers: Dict[str, str] status_code: int screenshot: Optional[str] = None + pdf_data: Optional[bytes] = None get_delayed_content: Optional[Callable[[Optional[float]], Awaitable[str]]] = None downloaded_files: Optional[List[str]] = None diff --git a/crawl4ai/tools.py b/crawl4ai/tools.py deleted file mode 100644 index ff36b53a..00000000 --- a/crawl4ai/tools.py +++ /dev/null @@ -1,34 +0,0 @@ -import time -import cProfile -import pstats -from functools import wraps - -def profile_and_time(func): - @wraps(func) - def wrapper(self, *args, **kwargs): - # Start timer - start_time = time.perf_counter() - - # Setup profiler - profiler = cProfile.Profile() - profiler.enable() - - # Run function - result = func(self, *args, **kwargs) - - # Stop profiler - profiler.disable() - - # Calculate elapsed time - elapsed_time = time.perf_counter() - start_time - - # Print timing - print(f"[PROFILER] Scraping completed in {elapsed_time:.2f} seconds") - - # Print profiling stats - stats = pstats.Stats(profiler) - stats.sort_stats('cumulative') # Sort by cumulative time - stats.print_stats(20) # Print top 20 time-consuming functions - - return result - return wrapper \ No newline at end of file diff --git a/crawl4ai/utils.py b/crawl4ai/utils.py index 0a9e6f56..7ecc22da 100644 --- a/crawl4ai/utils.py +++ b/crawl4ai/utils.py @@ -19,142 +19,17 @@ from typing import Optional, Tuple, Dict, Any import xxhash from colorama import Fore, Style, init import textwrap +import cProfile +import pstats +from functools import wraps -from .html2text import HTML2Text -class CustomHTML2Text(HTML2Text): - def __init__(self, *args, handle_code_in_pre=False, **kwargs): - super().__init__(*args, **kwargs) - self.inside_pre = False - self.inside_code = False - self.preserve_tags = set() # Set of tags to preserve - self.current_preserved_tag = None - self.preserved_content = [] - self.preserve_depth = 0 - self.handle_code_in_pre = handle_code_in_pre - - # Configuration options - self.skip_internal_links = False - self.single_line_break = False - self.mark_code = False - self.include_sup_sub = False - self.body_width = 0 - self.ignore_mailto_links = True - self.ignore_links = False - self.escape_backslash = False - self.escape_dot = False - self.escape_plus = False - self.escape_dash = False - self.escape_snob = False - - def update_params(self, **kwargs): - """Update parameters and set preserved tags.""" - for key, value in kwargs.items(): - if key == 'preserve_tags': - self.preserve_tags = set(value) - elif key == 'handle_code_in_pre': - self.handle_code_in_pre = value - else: - setattr(self, key, value) - - def handle_tag(self, tag, attrs, start): - # Handle preserved tags - if tag in self.preserve_tags: - if start: - if self.preserve_depth == 0: - self.current_preserved_tag = tag - self.preserved_content = [] - # Format opening tag with attributes - attr_str = ''.join(f' {k}="{v}"' for k, v in attrs.items() if v is not None) - self.preserved_content.append(f'<{tag}{attr_str}>') - self.preserve_depth += 1 - return - else: - self.preserve_depth -= 1 - if self.preserve_depth == 0: - self.preserved_content.append(f'') - # Output the preserved HTML block with proper spacing - preserved_html = ''.join(self.preserved_content) - self.o('\n' + preserved_html + '\n') - self.current_preserved_tag = None - return - - # If we're inside a preserved tag, collect all content - if self.preserve_depth > 0: - if start: - # Format nested tags with attributes - attr_str = ''.join(f' {k}="{v}"' for k, v in attrs.items() if v is not None) - self.preserved_content.append(f'<{tag}{attr_str}>') - else: - self.preserved_content.append(f'') - return - - # Handle pre tags - if tag == 'pre': - if start: - self.o('```\n') # Markdown code block start - self.inside_pre = True - else: - self.o('\n```\n') # Markdown code block end - self.inside_pre = False - elif tag == 'code': - if self.inside_pre and not self.handle_code_in_pre: - # Ignore code tags inside pre blocks if handle_code_in_pre is False - return - if start: - self.o('`') # Markdown inline code start - self.inside_code = True - else: - self.o('`') # Markdown inline code end - self.inside_code = False - else: - super().handle_tag(tag, attrs, start) - - def handle_data(self, data, entity_char=False): - """Override handle_data to capture content within preserved tags.""" - if self.preserve_depth > 0: - self.preserved_content.append(data) - return - - if self.inside_pre: - # Output the raw content for pre blocks, including content inside code tags - self.o(data) # Directly output the data as-is (preserve newlines) - return - if self.inside_code: - # Inline code: no newlines allowed - self.o(data.replace('\n', ' ')) - return - - # Default behavior for other tags - super().handle_data(data, entity_char) - - - # # Handle pre tags - # if tag == 'pre': - # if start: - # self.o('```\n') - # self.inside_pre = True - # else: - # self.o('\n```') - # self.inside_pre = False - # # elif tag in ["h1", "h2", "h3", "h4", "h5", "h6"]: - # # pass - # else: - # super().handle_tag(tag, attrs, start) - - # def handle_data(self, data, entity_char=False): - # """Override handle_data to capture content within preserved tags.""" - # if self.preserve_depth > 0: - # self.preserved_content.append(data) - # return - # super().handle_data(data, entity_char) class InvalidCSSSelectorError(Exception): pass - def create_box_message( message: str, type: str = "info", - width: int = 80, + width: int = 120, add_newlines: bool = True, double_line: bool = False ) -> str: @@ -373,50 +248,6 @@ def escape_json_string(s): return s -class CustomHTML2Text_v0(HTML2Text): - def __init__(self, *args, **kwargs): - super().__init__(*args, **kwargs) - self.inside_pre = False - self.inside_code = False - - self.skip_internal_links = False - self.single_line_break = False - self.mark_code = False - self.include_sup_sub = False - self.body_width = 0 - self.ignore_mailto_links = True - self.ignore_links = False - self.escape_backslash = False - self.escape_dot = False - self.escape_plus = False - self.escape_dash = False - self.escape_snob = False - - - def handle_tag(self, tag, attrs, start): - if tag == 'pre': - if start: - self.o('```\n') - self.inside_pre = True - else: - self.o('\n```') - self.inside_pre = False - elif tag in ["h1", "h2", "h3", "h4", "h5", "h6"]: - pass - - - # elif tag == 'code' and not self.inside_pre: - # if start: - # if not self.inside_pre: - # self.o('`') - # self.inside_code = True - # else: - # if not self.inside_pre: - # self.o('`') - # self.inside_code = False - - super().handle_tag(tag, attrs, start) - def replace_inline_tags(soup, tags, only_text=False): tag_replacements = { 'b': lambda tag: f"**{tag.text}**", @@ -978,7 +809,6 @@ def extract_metadata(html, soup=None): return metadata - def extract_xml_tags(string): tags = re.findall(r'<(\w+)>', string) return list(set(tags)) @@ -996,7 +826,6 @@ def extract_xml_data(tags, string): return data -# Function to perform the completion with exponential backoff def perform_completion_with_backoff( provider, prompt_with_variables, @@ -1010,7 +839,11 @@ def perform_completion_with_backoff( max_attempts = 3 base_delay = 2 # Base delay in seconds, you can adjust this based on your needs - extra_args = {} + extra_args = { + "temperature": 0.01, + 'api_key': api_token, + 'base_url': base_url + } if json_response: extra_args["response_format"] = { "type": "json_object" } @@ -1019,14 +852,12 @@ def perform_completion_with_backoff( for attempt in range(max_attempts): try: + response =completion( model=provider, messages=[ {"role": "user", "content": prompt_with_variables} ], - temperature=0.01, - api_key=api_token, - base_url=base_url, **extra_args ) return response # Return the successful response @@ -1350,6 +1181,35 @@ def clean_tokens(tokens: list[str]) -> list[str]: and not token.startswith('โ–ฒ') and not token.startswith('โฌ†')] +def profile_and_time(func): + @wraps(func) + def wrapper(self, *args, **kwargs): + # Start timer + start_time = time.perf_counter() + + # Setup profiler + profiler = cProfile.Profile() + profiler.enable() + + # Run function + result = func(self, *args, **kwargs) + + # Stop profiler + profiler.disable() + + # Calculate elapsed time + elapsed_time = time.perf_counter() - start_time + + # Print timing + print(f"[PROFILER] Scraping completed in {elapsed_time:.2f} seconds") + + # Print profiling stats + stats = pstats.Stats(profiler) + stats.sort_stats('cumulative') # Sort by cumulative time + stats.print_stats(20) # Print top 20 time-consuming functions + + return result + return wrapper def generate_content_hash(content: str) -> str: """Generate a unique hash for content""" @@ -1363,7 +1223,8 @@ def ensure_content_dirs(base_path: str) -> Dict[str, str]: 'cleaned': 'cleaned_html', 'markdown': 'markdown_content', 'extracted': 'extracted_content', - 'screenshots': 'screenshots' + 'screenshots': 'screenshots', + 'screenshot': 'screenshots' } content_paths = {} @@ -1372,4 +1233,60 @@ def ensure_content_dirs(base_path: str) -> Dict[str, str]: os.makedirs(path, exist_ok=True) content_paths[key] = path - return content_paths \ No newline at end of file + return content_paths + +def get_error_context(exc_info, context_lines: int = 5): + """ + Extract error context with more reliable line number tracking. + + Args: + exc_info: The exception info from sys.exc_info() + context_lines: Number of lines to show before and after the error + + Returns: + dict: Error context information + """ + import traceback + import linecache + import os + + # Get the full traceback + tb = traceback.extract_tb(exc_info[2]) + + # Get the last frame (where the error occurred) + last_frame = tb[-1] + filename = last_frame.filename + line_no = last_frame.lineno + func_name = last_frame.name + + # Get the source code context using linecache + # This is more reliable than inspect.getsourcelines + context_start = max(1, line_no - context_lines) + context_end = line_no + context_lines + 1 + + # Build the context lines with line numbers + context_lines = [] + for i in range(context_start, context_end): + line = linecache.getline(filename, i) + if line: + # Remove any trailing whitespace/newlines and add the pointer for error line + line = line.rstrip() + pointer = 'โ†’' if i == line_no else ' ' + context_lines.append(f"{i:4d} {pointer} {line}") + + # Join the lines with newlines + code_context = '\n'.join(context_lines) + + # Get relative path for cleaner output + try: + rel_path = os.path.relpath(filename) + except ValueError: + # Fallback if relpath fails (can happen on Windows with different drives) + rel_path = filename + + return { + "filename": rel_path, + "line_no": line_no, + "function": func_name, + "code_context": code_context + } \ No newline at end of file diff --git a/docs/examples/full_page_screenshot_and_pdf_export.md b/docs/examples/full_page_screenshot_and_pdf_export.md new file mode 100644 index 00000000..1afc24ba --- /dev/null +++ b/docs/examples/full_page_screenshot_and_pdf_export.md @@ -0,0 +1,58 @@ +# Capturing Full-Page Screenshots and PDFs from Massive Webpages with Crawl4AI + +When dealing with very long web pages, traditional full-page screenshots can be slow or fail entirely. For large pages (like extensive Wikipedia articles), generating a single massive screenshot often leads to delays, memory issues, or style differences. + +**The New Approach:** +Weโ€™ve introduced a new feature that effortlessly handles even the biggest pages by first exporting them as a PDF, then converting that PDF into a high-quality image. This approach leverages the browserโ€™s built-in PDF rendering, making it both stable and efficient for very long content. You also have the option to directly save the PDF for your own usageโ€”no need for multiple passes or complex stitching logic. + +**Key Benefits:** +- **Reliability:** The PDF export never times out and works regardless of page length. +- **Versatility:** Get both the PDF and a screenshot in one crawl, without reloading or reprocessing. +- **Performance:** Skips manual scrolling and stitching images, reducing complexity and runtime. + +**Simple Example:** +```python +import os, sys +import asyncio +from crawl4ai import AsyncWebCrawler, CacheMode + +# Adjust paths as needed +parent_dir = os.path.dirname(os.path.dirname(os.path.abspath(__file__))) +sys.path.append(parent_dir) +__location__ = os.path.realpath(os.path.join(os.getcwd(), os.path.dirname(__file__))) + +async def main(): + async with AsyncWebCrawler() as crawler: + # Request both PDF and screenshot + result = await crawler.arun( + url='https://en.wikipedia.org/wiki/List_of_common_misconceptions', + cache_mode=CacheMode.BYPASS, + pdf=True, + screenshot=True + ) + + if result.success: + # Save screenshot + if result.screenshot: + from base64 import b64decode + with open(os.path.join(__location__, "screenshot.png"), "wb") as f: + f.write(b64decode(result.screenshot)) + + # Save PDF + if result.pdf_data: + pdf_bytes = b64decode(result.pdf_data) + with open(os.path.join(__location__, "page.pdf"), "wb") as f: + f.write(pdf_bytes) + +if __name__ == "__main__": + asyncio.run(main()) +``` + +**What Happens Under the Hood:** +- Crawl4AI navigates to the target page. +- If `pdf=True`, it exports the current page as a full PDF, capturing all of its content no matter the length. +- If `screenshot=True`, and a PDF is already available, it directly converts the first page of that PDF to an image for youโ€”no repeated loading or scrolling. +- Finally, you get your PDF and/or screenshot ready to use. + +**Conclusion:** +With this feature, Crawl4AI becomes even more robust and versatile for large-scale content extraction. Whether you need a PDF snapshot or a quick screenshot, you now have a reliable solution for even the most extensive webpages. \ No newline at end of file diff --git a/docs/examples/quickstart_async.config.py b/docs/examples/quickstart_async.config.py new file mode 100644 index 00000000..e1feba55 --- /dev/null +++ b/docs/examples/quickstart_async.config.py @@ -0,0 +1,517 @@ +import os, sys +sys.path.append(os.path.dirname(os.path.dirname(os.path.dirname(os.path.abspath(__file__))))) +os.environ['FIRECRAWL_API_KEY'] = "fc-84b370ccfad44beabc686b38f1769692" + +import asyncio +import time +import json +import re +from typing import Dict, List +from bs4 import BeautifulSoup +from pydantic import BaseModel, Field +from crawl4ai import AsyncWebCrawler, CacheMode, BrowserConfig, CrawlerRunConfig +from crawl4ai.markdown_generation_strategy import DefaultMarkdownGenerator +from crawl4ai.content_filter_strategy import BM25ContentFilter, PruningContentFilter +from crawl4ai.extraction_strategy import JsonCssExtractionStrategy, LLMExtractionStrategy + +__location__ = os.path.realpath(os.path.join(os.getcwd(), os.path.dirname(__file__))) + +print("Crawl4AI: Advanced Web Crawling and Data Extraction") +print("GitHub Repository: https://github.com/unclecode/crawl4ai") +print("Twitter: @unclecode") +print("Website: https://crawl4ai.com") + +# Basic Example - Simple Crawl +async def simple_crawl(): + print("\n--- Basic Usage ---") + browser_config = BrowserConfig(headless=True) + crawler_config = CrawlerRunConfig( + cache_mode=CacheMode.BYPASS + ) + + async with AsyncWebCrawler(config=browser_config) as crawler: + result = await crawler.arun( + url="https://www.nbcnews.com/business", + config=crawler_config + ) + print(result.markdown[:500]) + +# JavaScript Execution Example +async def simple_example_with_running_js_code(): + print("\n--- Executing JavaScript and Using CSS Selectors ---") + + browser_config = BrowserConfig( + headless=True, + java_script_enabled=True + ) + + crawler_config = CrawlerRunConfig( + cache_mode=CacheMode.BYPASS, + js_code=["const loadMoreButton = Array.from(document.querySelectorAll('button')).find(button => button.textContent.includes('Load More')); loadMoreButton && loadMoreButton.click();"], + # wait_for="() => { return Array.from(document.querySelectorAll('article.tease-card')).length > 10; }" + ) + + async with AsyncWebCrawler(config=browser_config) as crawler: + result = await crawler.arun( + url="https://www.nbcnews.com/business", + config=crawler_config + ) + print(result.markdown[:500]) + +# CSS Selector Example +async def simple_example_with_css_selector(): + print("\n--- Using CSS Selectors ---") + browser_config = BrowserConfig(headless=True) + crawler_config = CrawlerRunConfig( + cache_mode=CacheMode.BYPASS, + css_selector=".wide-tease-item__description" + ) + + async with AsyncWebCrawler(config=browser_config) as crawler: + result = await crawler.arun( + url="https://www.nbcnews.com/business", + config=crawler_config + ) + print(result.markdown[:500]) + +# Proxy Example +async def use_proxy(): + print("\n--- Using a Proxy ---") + browser_config = BrowserConfig( + headless=True, + proxy="http://your-proxy-url:port" + ) + crawler_config = CrawlerRunConfig( + cache_mode=CacheMode.BYPASS + ) + + async with AsyncWebCrawler(config=browser_config) as crawler: + result = await crawler.arun( + url="https://www.nbcnews.com/business", + config=crawler_config + ) + if result.success: + print(result.markdown[:500]) + +# Screenshot Example +async def capture_and_save_screenshot(url: str, output_path: str): + browser_config = BrowserConfig(headless=True) + crawler_config = CrawlerRunConfig( + cache_mode=CacheMode.BYPASS, + screenshot=True + ) + + async with AsyncWebCrawler(config=browser_config) as crawler: + result = await crawler.arun( + url=url, + config=crawler_config + ) + + if result.success and result.screenshot: + import base64 + screenshot_data = base64.b64decode(result.screenshot) + with open(output_path, 'wb') as f: + f.write(screenshot_data) + print(f"Screenshot saved successfully to {output_path}") + else: + print("Failed to capture screenshot") + +# LLM Extraction Example +class OpenAIModelFee(BaseModel): + model_name: str = Field(..., description="Name of the OpenAI model.") + input_fee: str = Field(..., description="Fee for input token for the OpenAI model.") + output_fee: str = Field(..., description="Fee for output token for the OpenAI model.") + +async def extract_structured_data_using_llm(provider: str, api_token: str = None, extra_headers: Dict[str, str] = None): + print(f"\n--- Extracting Structured Data with {provider} ---") + + if api_token is None and provider != "ollama": + print(f"API token is required for {provider}. Skipping this example.") + return + + browser_config = BrowserConfig(headless=True) + + extra_args = { + "temperature": 0, + "top_p": 0.9, + "max_tokens": 2000 + } + if extra_headers: + extra_args["extra_headers"] = extra_headers + + crawler_config = CrawlerRunConfig( + cache_mode=CacheMode.BYPASS, + word_count_threshold=1, + extraction_strategy=LLMExtractionStrategy( + provider=provider, + api_token=api_token, + schema=OpenAIModelFee.model_json_schema(), + extraction_type="schema", + instruction="""From the crawled content, extract all mentioned model names along with their fees for input and output tokens. + Do not miss any models in the entire content.""", + extra_args=extra_args + ) + ) + + async with AsyncWebCrawler(config=browser_config) as crawler: + result = await crawler.arun( + url="https://openai.com/api/pricing/", + config=crawler_config + ) + print(result.extracted_content) + +# CSS Extraction Example +async def extract_structured_data_using_css_extractor(): + print("\n--- Using JsonCssExtractionStrategy for Fast Structured Output ---") + schema = { + "name": "KidoCode Courses", + "baseSelector": "section.charge-methodology .w-tab-content > div", + "fields": [ + { + "name": "section_title", + "selector": "h3.heading-50", + "type": "text", + }, + { + "name": "section_description", + "selector": ".charge-content", + "type": "text", + }, + { + "name": "course_name", + "selector": ".text-block-93", + "type": "text", + }, + { + "name": "course_description", + "selector": ".course-content-text", + "type": "text", + }, + { + "name": "course_icon", + "selector": ".image-92", + "type": "attribute", + "attribute": "src" + } + ] + } + + browser_config = BrowserConfig( + headless=True, + java_script_enabled=True + ) + + js_click_tabs = """ + (async () => { + const tabs = document.querySelectorAll("section.charge-methodology .tabs-menu-3 > div"); + for(let tab of tabs) { + tab.scrollIntoView(); + tab.click(); + await new Promise(r => setTimeout(r, 500)); + } + })(); + """ + + crawler_config = CrawlerRunConfig( + cache_mode=CacheMode.BYPASS, + extraction_strategy=JsonCssExtractionStrategy(schema), + js_code=[js_click_tabs] + ) + + async with AsyncWebCrawler(config=browser_config) as crawler: + result = await crawler.arun( + url="https://www.kidocode.com/degrees/technology", + config=crawler_config + ) + + companies = json.loads(result.extracted_content) + print(f"Successfully extracted {len(companies)} companies") + print(json.dumps(companies[0], indent=2)) + +# Dynamic Content Examples - Method 1 +async def crawl_dynamic_content_pages_method_1(): + print("\n--- Advanced Multi-Page Crawling with JavaScript Execution ---") + first_commit = "" + + async def on_execution_started(page, **kwargs): + nonlocal first_commit + try: + while True: + await page.wait_for_selector("li.Box-sc-g0xbh4-0 h4") + commit = await page.query_selector("li.Box-sc-g0xbh4-0 h4") + commit = await commit.evaluate("(element) => element.textContent") + commit = re.sub(r"\s+", "", commit) + if commit and commit != first_commit: + first_commit = commit + break + await asyncio.sleep(0.5) + except Exception as e: + print(f"Warning: New content didn't appear after JavaScript execution: {e}") + + browser_config = BrowserConfig( + headless=False, + java_script_enabled=True + ) + + async with AsyncWebCrawler(config=browser_config) as crawler: + crawler.crawler_strategy.set_hook("on_execution_started", on_execution_started) + + url = "https://github.com/microsoft/TypeScript/commits/main" + session_id = "typescript_commits_session" + all_commits = [] + + js_next_page = """ + const button = document.querySelector('a[data-testid="pagination-next-button"]'); + if (button) button.click(); + """ + + for page in range(3): + crawler_config = CrawlerRunConfig( + cache_mode=CacheMode.BYPASS, + css_selector="li.Box-sc-g0xbh4-0", + js_code=js_next_page if page > 0 else None, + js_only=page > 0, + session_id=session_id + ) + + result = await crawler.arun(url=url, config=crawler_config) + assert result.success, f"Failed to crawl page {page + 1}" + + soup = BeautifulSoup(result.cleaned_html, "html.parser") + commits = soup.select("li") + all_commits.extend(commits) + + print(f"Page {page + 1}: Found {len(commits)} commits") + + print(f"Successfully crawled {len(all_commits)} commits across 3 pages") + +# Dynamic Content Examples - Method 2 +async def crawl_dynamic_content_pages_method_2(): + print("\n--- Advanced Multi-Page Crawling with JavaScript Execution ---") + + browser_config = BrowserConfig( + headless=False, + java_script_enabled=True + ) + + js_next_page_and_wait = """ + (async () => { + const getCurrentCommit = () => { + const commits = document.querySelectorAll('li.Box-sc-g0xbh4-0 h4'); + return commits.length > 0 ? commits[0].textContent.trim() : null; + }; + + const initialCommit = getCurrentCommit(); + const button = document.querySelector('a[data-testid="pagination-next-button"]'); + if (button) button.click(); + + while (true) { + await new Promise(resolve => setTimeout(resolve, 100)); + const newCommit = getCurrentCommit(); + if (newCommit && newCommit !== initialCommit) { + break; + } + } + })(); + """ + + schema = { + "name": "Commit Extractor", + "baseSelector": "li.Box-sc-g0xbh4-0", + "fields": [ + { + "name": "title", + "selector": "h4.markdown-title", + "type": "text", + "transform": "strip", + }, + ], + } + + async with AsyncWebCrawler(config=browser_config) as crawler: + url = "https://github.com/microsoft/TypeScript/commits/main" + session_id = "typescript_commits_session" + all_commits = [] + + extraction_strategy = JsonCssExtractionStrategy(schema) + + for page in range(3): + crawler_config = CrawlerRunConfig( + cache_mode=CacheMode.BYPASS, + css_selector="li.Box-sc-g0xbh4-0", + extraction_strategy=extraction_strategy, + js_code=js_next_page_and_wait if page > 0 else None, + js_only=page > 0, + session_id=session_id + ) + + result = await crawler.arun(url=url, config=crawler_config) + assert result.success, f"Failed to crawl page {page + 1}" + + commits = json.loads(result.extracted_content) + all_commits.extend(commits) + print(f"Page {page + 1}: Found {len(commits)} commits") + + print(f"Successfully crawled {len(all_commits)} commits across 3 pages") + +# Browser Comparison +async def crawl_custom_browser_type(): + print("\n--- Browser Comparison ---") + + # Firefox + browser_config_firefox = BrowserConfig( + browser_type="firefox", + headless=True + ) + start = time.time() + async with AsyncWebCrawler(config=browser_config_firefox) as crawler: + result = await crawler.arun( + url="https://www.example.com", + config=CrawlerRunConfig(cache_mode=CacheMode.BYPASS) + ) + print("Firefox:", time.time() - start) + print(result.markdown[:500]) + + # WebKit + browser_config_webkit = BrowserConfig( + browser_type="webkit", + headless=True + ) + start = time.time() + async with AsyncWebCrawler(config=browser_config_webkit) as crawler: + result = await crawler.arun( + url="https://www.example.com", + config=CrawlerRunConfig(cache_mode=CacheMode.BYPASS) + ) + print("WebKit:", time.time() - start) + print(result.markdown[:500]) + + # Chromium (default) + browser_config_chromium = BrowserConfig( + browser_type="chromium", + headless=True + ) + start = time.time() + async with AsyncWebCrawler(config=browser_config_chromium) as crawler: + result = await crawler.arun( + url="https://www.example.com", + config=CrawlerRunConfig(cache_mode=CacheMode.BYPASS) + ) + print("Chromium:", time.time() - start) + print(result.markdown[:500]) + +# Anti-Bot and User Simulation +async def crawl_with_user_simulation(): + browser_config = BrowserConfig( + headless=True, + user_agent_mode="random", + user_agent_generator_config={ + "device_type": "mobile", + "os_type": "android" + } + ) + + crawler_config = CrawlerRunConfig( + cache_mode=CacheMode.BYPASS, + magic=True, + simulate_user=True, + override_navigator=True + ) + + async with AsyncWebCrawler(config=browser_config) as crawler: + result = await crawler.arun( + url="YOUR-URL-HERE", + config=crawler_config + ) + print(result.markdown) + +# Speed Comparison +async def speed_comparison(): + print("\n--- Speed Comparison ---") + + # Firecrawl comparison + from firecrawl import FirecrawlApp + app = FirecrawlApp(api_key=os.environ['FIRECRAWL_API_KEY']) + start = time.time() + scrape_status = app.scrape_url( + 'https://www.nbcnews.com/business', + params={'formats': ['markdown', 'html']} + ) + end = time.time() + print("Firecrawl:") + print(f"Time taken: {end - start:.2f} seconds") + print(f"Content length: {len(scrape_status['markdown'])} characters") + print(f"Images found: {scrape_status['markdown'].count('cldnry.s-nbcnews.com')}") + print() + + # Crawl4AI comparisons + browser_config = BrowserConfig(headless=True) + + # Simple crawl + async with AsyncWebCrawler(config=browser_config) as crawler: + start = time.time() + result = await crawler.arun( + url="https://www.nbcnews.com/business", + config=CrawlerRunConfig( + cache_mode=CacheMode.BYPASS, + word_count_threshold=0 + ) + ) + end = time.time() + print("Crawl4AI (simple crawl):") + print(f"Time taken: {end - start:.2f} seconds") + print(f"Content length: {len(result.markdown)} characters") + print(f"Images found: {result.markdown.count('cldnry.s-nbcnews.com')}") + print() + + # Advanced filtering + start = time.time() + result = await crawler.arun( + url="https://www.nbcnews.com/business", + config=CrawlerRunConfig( + cache_mode=CacheMode.BYPASS, + word_count_threshold=0, + markdown_generator=DefaultMarkdownGenerator( + content_filter=PruningContentFilter( + threshold=0.48, + threshold_type="fixed", + min_word_threshold=0 + ) + ) + ) + ) + end = time.time() + print("Crawl4AI (Markdown Plus):") + print(f"Time taken: {end - start:.2f} seconds") + print(f"Content length: {len(result.markdown_v2.raw_markdown)} characters") + print(f"Fit Markdown: {len(result.markdown_v2.fit_markdown)} characters") + print(f"Images found: {result.markdown.count('cldnry.s-nbcnews.com')}") + print() + +# Main execution +async def main(): + # Basic examples + # await simple_crawl() + # await simple_example_with_running_js_code() + # await simple_example_with_css_selector() + + # Advanced examples + # await extract_structured_data_using_css_extractor() + # await extract_structured_data_using_llm("openai/gpt-4o", os.getenv("OPENAI_API_KEY")) + # await crawl_dynamic_content_pages_method_1() + # await crawl_dynamic_content_pages_method_2() + + # Browser comparisons + await crawl_custom_browser_type() + + # Performance testing + # await speed_comparison() + + # Screenshot example + await capture_and_save_screenshot( + "https://www.example.com", + os.path.join(__location__, "tmp/example_screenshot.jpg") + ) + +if __name__ == "__main__": + asyncio.run(main()) \ No newline at end of file diff --git a/docs/examples/quickstart_async.py b/docs/examples/quickstart_async.py index ac844ed5..1c76bf18 100644 --- a/docs/examples/quickstart_async.py +++ b/docs/examples/quickstart_async.py @@ -117,7 +117,13 @@ async def extract_structured_data_using_llm(provider: str, api_token: str = None print(f"API token is required for {provider}. Skipping this example.") return - extra_args = {} + # extra_args = {} + extra_args={ + "temperature": 0, + "top_p": 0.9, + "max_tokens": 2000, + # any other supported parameters for litellm + } if extra_headers: extra_args["extra_headers"] = extra_headers @@ -598,6 +604,8 @@ async def fit_markdown_remove_overlay(): async def main(): + await extract_structured_data_using_llm("openai/gpt-4o", os.getenv("OPENAI_API_KEY")) + await simple_crawl() await simple_example_with_running_js_code() await simple_example_with_css_selector() @@ -609,7 +617,6 @@ async def main(): # await extract_structured_data_using_llm() # await extract_structured_data_using_llm("huggingface/meta-llama/Meta-Llama-3.1-8B-Instruct", os.getenv("HUGGINGFACE_API_KEY")) # await extract_structured_data_using_llm("ollama/llama3.2") - await extract_structured_data_using_llm("openai/gpt-4o", os.getenv("OPENAI_API_KEY")) # You always can pass custom headers to the extraction strategy # custom_headers = { diff --git a/docs/examples/storage_state_tutorial.md b/docs/examples/storage_state_tutorial.md new file mode 100644 index 00000000..304e6399 --- /dev/null +++ b/docs/examples/storage_state_tutorial.md @@ -0,0 +1,225 @@ +### Using `storage_state` to Pre-Load Cookies and LocalStorage + +Crawl4aiโ€™s `AsyncWebCrawler` lets you preserve and reuse session data, including cookies and localStorage, across multiple runs. By providing a `storage_state`, you can start your crawls already โ€œlogged inโ€ or with any other necessary session dataโ€”no need to repeat the login flow every time. + +#### What is `storage_state`? + +`storage_state` can be: + +- A dictionary containing cookies and localStorage data. +- A path to a JSON file that holds this information. + +When you pass `storage_state` to the crawler, it applies these cookies and localStorage entries before loading any pages. This means your crawler effectively starts in a known authenticated or pre-configured state. + +#### Example Structure + +Hereโ€™s an example storage state: + +```json +{ + "cookies": [ + { + "name": "session", + "value": "abcd1234", + "domain": "example.com", + "path": "/", + "expires": 1675363572.037711, + "httpOnly": false, + "secure": false, + "sameSite": "None" + } + ], + "origins": [ + { + "origin": "https://example.com", + "localStorage": [ + { "name": "token", "value": "my_auth_token" }, + { "name": "refreshToken", "value": "my_refresh_token" } + ] + } + ] +} +``` + +This JSON sets a `session` cookie and two localStorage entries (`token` and `refreshToken`) for `https://example.com`. + +--- + +### Passing `storage_state` as a Dictionary + +You can directly provide the data as a dictionary: + +```python +import asyncio +from crawl4ai import AsyncWebCrawler + +async def main(): + storage_dict = { + "cookies": [ + { + "name": "session", + "value": "abcd1234", + "domain": "example.com", + "path": "/", + "expires": 1675363572.037711, + "httpOnly": False, + "secure": False, + "sameSite": "None" + } + ], + "origins": [ + { + "origin": "https://example.com", + "localStorage": [ + {"name": "token", "value": "my_auth_token"}, + {"name": "refreshToken", "value": "my_refresh_token"} + ] + } + ] + } + + async with AsyncWebCrawler( + headless=True, + storage_state=storage_dict + ) as crawler: + result = await crawler.arun(url='https://example.com/protected') + if result.success: + print("Crawl succeeded with pre-loaded session data!") + print("Page HTML length:", len(result.html)) + +if __name__ == "__main__": + asyncio.run(main()) +``` + +--- + +### Passing `storage_state` as a File + +If you prefer a file-based approach, save the JSON above to `mystate.json` and reference it: + +```python +import asyncio +from crawl4ai import AsyncWebCrawler + +async def main(): + async with AsyncWebCrawler( + headless=True, + storage_state="mystate.json" # Uses a JSON file instead of a dictionary + ) as crawler: + result = await crawler.arun(url='https://example.com/protected') + if result.success: + print("Crawl succeeded with pre-loaded session data!") + print("Page HTML length:", len(result.html)) + +if __name__ == "__main__": + asyncio.run(main()) +``` + +--- + +### Using `storage_state` to Avoid Repeated Logins (Sign In Once, Use Later) + +A common scenario is when you need to log in to a site (entering username/password, etc.) to access protected pages. Doing so every crawl is cumbersome. Instead, you can: + +1. Perform the login once in a hook. +2. After login completes, export the resulting `storage_state` to a file. +3. On subsequent runs, provide that `storage_state` to skip the login step. + +**Step-by-Step Example:** + +**First Run (Perform Login and Save State):** + +```python +import asyncio +from crawl4ai import AsyncWebCrawler, CacheMode +from crawl4ai.markdown_generation_strategy import DefaultMarkdownGenerator + +async def on_browser_created_hook(browser): + # Access the default context and create a page + context = browser.contexts[0] + page = await context.new_page() + + # Navigate to the login page + await page.goto("https://example.com/login", wait_until="domcontentloaded") + + # Fill in credentials and submit + await page.fill("input[name='username']", "myuser") + await page.fill("input[name='password']", "mypassword") + await page.click("button[type='submit']") + await page.wait_for_load_state("networkidle") + + # Now the site sets tokens in localStorage and cookies + # Export this state to a file so we can reuse it + await context.storage_state(path="my_storage_state.json") + await page.close() + +async def main(): + # First run: perform login and export the storage_state + async with AsyncWebCrawler( + headless=True, + verbose=True, + hooks={"on_browser_created": on_browser_created_hook}, + use_persistent_context=True, + user_data_dir="./my_user_data" + ) as crawler: + + # After on_browser_created_hook runs, we have storage_state saved to my_storage_state.json + result = await crawler.arun( + url='https://example.com/protected-page', + cache_mode=CacheMode.BYPASS, + markdown_generator=DefaultMarkdownGenerator(options={"ignore_links": True}), + ) + print("First run result success:", result.success) + if result.success: + print("Protected page HTML length:", len(result.html)) + +if __name__ == "__main__": + asyncio.run(main()) +``` + +**Second Run (Reuse Saved State, No Login Needed):** + +```python +import asyncio +from crawl4ai import AsyncWebCrawler, CacheMode +from crawl4ai.markdown_generation_strategy import DefaultMarkdownGenerator + +async def main(): + # Second run: no need to hook on_browser_created this time. + # Just provide the previously saved storage state. + async with AsyncWebCrawler( + headless=True, + verbose=True, + use_persistent_context=True, + user_data_dir="./my_user_data", + storage_state="my_storage_state.json" # Reuse previously exported state + ) as crawler: + + # Now the crawler starts already logged in + result = await crawler.arun( + url='https://example.com/protected-page', + cache_mode=CacheMode.BYPASS, + markdown_generator=DefaultMarkdownGenerator(options={"ignore_links": True}), + ) + print("Second run result success:", result.success) + if result.success: + print("Protected page HTML length:", len(result.html)) + +if __name__ == "__main__": + asyncio.run(main()) +``` + +**Whatโ€™s Happening Here?** + +- During the first run, the `on_browser_created_hook` logs into the site. +- After logging in, the crawler exports the current session (cookies, localStorage, etc.) to `my_storage_state.json`. +- On subsequent runs, passing `storage_state="my_storage_state.json"` starts the browser context with these tokens already in place, skipping the login steps. + +**Sign Out Scenario:** +If the website allows you to sign out by clearing tokens or by navigating to a sign-out URL, you can also run a script that uses `on_browser_created_hook` or `arun` to simulate signing out, then export the resulting `storage_state` again. That would give you a baseline โ€œlogged outโ€ state to start fresh from next time. + +--- + +### Conclusion + +By using `storage_state`, you can skip repetitive actions, like logging in, and jump straight into crawling protected content. Whether you provide a file path or a dictionary, this powerful feature helps maintain state between crawls, simplifying your data extraction pipelines. \ No newline at end of file diff --git a/docs/examples/tutorial_dynamic_clicks.md b/docs/examples/tutorial_dynamic_clicks.md new file mode 100644 index 00000000..d9669952 --- /dev/null +++ b/docs/examples/tutorial_dynamic_clicks.md @@ -0,0 +1,117 @@ +# Tutorial: Clicking Buttons to Load More Content with Crawl4AI + +## Introduction + +When scraping dynamic websites, itโ€™s common to encounter โ€œLoad Moreโ€ or โ€œNextโ€ buttons that must be clicked to reveal new content. Crawl4AI provides a straightforward way to handle these situations using JavaScript execution and waiting conditions. In this tutorial, weโ€™ll cover two approaches: + +1. **Step-by-step (Session-based) Approach:** Multiple calls to `arun()` to progressively load more content. +2. **Single-call Approach:** Execute a more complex JavaScript snippet inside a single `arun()` call to handle all clicks at once before the extraction. + +## Prerequisites + +- A working installation of Crawl4AI +- Basic familiarity with Pythonโ€™s `async`/`await` syntax + +## Step-by-Step Approach + +Use a session ID to maintain state across multiple `arun()` calls: + +```python +from crawl4ai import AsyncWebCrawler, CacheMode + +js_code = [ + # This JS finds the โ€œNextโ€ button and clicks it + "const nextButton = document.querySelector('button.next'); nextButton && nextButton.click();" +] + +wait_for_condition = "css:.new-content-class" + +async with AsyncWebCrawler(headless=True, verbose=True) as crawler: + # 1. Load the initial page + result_initial = await crawler.arun( + url="https://example.com", + cache_mode=CacheMode.BYPASS, + session_id="my_session" + ) + + # 2. Click the 'Next' button and wait for new content + result_next = await crawler.arun( + url="https://example.com", + session_id="my_session", + js_code=js_code, + wait_for=wait_for_condition, + js_only=True, + cache_mode=CacheMode.BYPASS + ) + +# `result_next` now contains the updated HTML after clicking 'Next' +``` + +**Key Points:** +- **`session_id`**: Keeps the same browser context open. +- **`js_code`**: Executes JavaScript in the context of the already loaded page. +- **`wait_for`**: Ensures the crawler waits until new content is fully loaded. +- **`js_only=True`**: Runs the JS in the current session without reloading the page. + +By repeating the `arun()` call multiple times and modifying the `js_code` (e.g., clicking different modules or pages), you can iteratively load all the desired content. + +## Single-call Approach + +If the page allows it, you can run a single `arun()` call with a more elaborate JavaScript snippet that: +- Iterates over all the modules or "Next" buttons +- Clicks them one by one +- Waits for content updates between each click +- Once done, returns control to Crawl4AI for extraction. + +Example snippet: + +```python +from crawl4ai import AsyncWebCrawler, CacheMode + +js_code = [ + # Example JS that clicks multiple modules: + """ + (async () => { + const modules = document.querySelectorAll('.module-item'); + for (let i = 0; i < modules.length; i++) { + modules[i].scrollIntoView(); + modules[i].click(); + // Wait for each moduleโ€™s content to load, adjust 100ms as needed + await new Promise(r => setTimeout(r, 100)); + } + })(); + """ +] + +async with AsyncWebCrawler(headless=True, verbose=True) as crawler: + result = await crawler.arun( + url="https://example.com", + js_code=js_code, + wait_for="css:.final-loaded-content-class", + cache_mode=CacheMode.BYPASS + ) + +# `result` now contains all content after all modules have been clicked in one go. +``` + +**Key Points:** +- All interactions (clicks and waits) happen before the extraction. +- Ideal for pages where all steps can be done in a single pass. + +## Choosing the Right Approach + +- **Step-by-Step (Session-based)**: + - Good when you need fine-grained control or must dynamically check conditions before clicking the next page. + - Useful if the page requires multiple conditions checked at runtime. + +- **Single-call**: + - Perfect if the sequence of interactions is known in advance. + - Cleaner code if the pageโ€™s structure is consistent and predictable. + +## Conclusion + +Crawl4AI makes it easy to handle dynamic content: +- Use session IDs and multiple `arun()` calls for stepwise crawling. +- Or pack all actions into one `arun()` call if the interactions are well-defined upfront. + +This flexibility ensures you can handle a wide range of dynamic web pages efficiently. diff --git a/docs/md_v2/basic/cache-modes.md b/docs/md_v2/basic/cache-modes.md index 04a4f218..01cfe34e 100644 --- a/docs/md_v2/basic/cache-modes.md +++ b/docs/md_v2/basic/cache-modes.md @@ -1,7 +1,7 @@ # Crawl4AI Cache System and Migration Guide ## Overview -Starting from version X.X.X, Crawl4AI introduces a new caching system that replaces the old boolean flags with a more intuitive `CacheMode` enum. This change simplifies cache control and makes the behavior more predictable. +Starting from version 0.5.0, Crawl4AI introduces a new caching system that replaces the old boolean flags with a more intuitive `CacheMode` enum. This change simplifies cache control and makes the behavior more predictable. ## Old vs New Approach diff --git a/docs/md_v2/basic/quickstart.md b/docs/md_v2/basic/quickstart.md index 95b8a397..c18cd7d1 100644 --- a/docs/md_v2/basic/quickstart.md +++ b/docs/md_v2/basic/quickstart.md @@ -8,7 +8,7 @@ First, let's import the necessary modules and create an instance of `AsyncWebCra ```python import asyncio -from crawl4ai import AsyncWebCrawler, CasheMode +from crawl4ai import AsyncWebCrawler, CacheMode async def main(): async with AsyncWebCrawler(verbose=True) as crawler: diff --git a/docs/md_v2/blog/index.md b/docs/md_v2/blog/index.md index 28ccfa6b..f7c8494d 100644 --- a/docs/md_v2/blog/index.md +++ b/docs/md_v2/blog/index.md @@ -4,6 +4,15 @@ Welcome to the Crawl4AI blog! Here you'll find detailed release notes, technical ## Latest Release +### [0.4.2 - Configurable Crawlers, Session Management, and Smarter Screenshots](releases/0.4.2.md) +*December 12, 2024* + +The 0.4.2 update brings massive improvements to configuration, making crawlers and browsers easier to manage with dedicated objects. You can now import/export local storage for seamless session management. Plus, long-page screenshots are faster and cleaner, and full-page PDF exports are now possible. Check out all the new features to make your crawling experience even smoother. + +[Read full release notes โ†’](releases/0.4.2.md) + +--- + ### [0.4.1 - Smarter Crawling with Lazy-Load Handling, Text-Only Mode, and More](releases/0.4.1.md) *December 8, 2024* @@ -35,3 +44,4 @@ Curious about how Crawl4AI has evolved? Check out our [complete changelog](https - Star us on [GitHub](https://github.com/unclecode/crawl4ai) - Follow [@unclecode](https://twitter.com/unclecode) on Twitter - Join our community discussions on GitHub + diff --git a/docs/md_v2/blog/releases/0.4.2.md b/docs/md_v2/blog/releases/0.4.2.md new file mode 100644 index 00000000..6f8f39e9 --- /dev/null +++ b/docs/md_v2/blog/releases/0.4.2.md @@ -0,0 +1,86 @@ +## ๐Ÿš€ Crawl4AI 0.4.2 Update: Smarter Crawling Just Got Easier (Dec 12, 2024) + +### Hey Developers, + +Iโ€™m excited to share Crawl4AI 0.4.2โ€”a major upgrade that makes crawling smarter, faster, and a whole lot more intuitive. Iโ€™ve packed in a bunch of new features to simplify your workflows and improve your experience. Letโ€™s cut to the chase! + +--- + +### ๐Ÿ”ง **Configurable Browser and Crawler Behavior** + +Youโ€™ve asked for better control over how browsers and crawlers are configured, and now youโ€™ve got it. With the new `BrowserConfig` and `CrawlerRunConfig` objects, you can set up your browser and crawling behavior exactly how you want. No more cluttering `arun` with a dozen argumentsโ€”just pass in your configs and go. + +**Example:** +```python +from crawl4ai import BrowserConfig, CrawlerRunConfig, AsyncWebCrawler + +browser_config = BrowserConfig(headless=True, viewport_width=1920, viewport_height=1080) +crawler_config = CrawlerRunConfig(cache_mode="BYPASS") + +async with AsyncWebCrawler(config=browser_config) as crawler: + result = await crawler.arun(url="https://example.com", config=crawler_config) + print(result.markdown[:500]) +``` + +This setup is a game-changer for scalability, keeping your code clean and flexible as we add more parameters in the future. + +Remember: If you like to use the old way, you can still pass arguments directly to `arun` as before, no worries! + +--- + +### ๐Ÿ” **Streamlined Session Management** + +Hereโ€™s the big one: You can now pass local storage and cookies directly. Whether itโ€™s setting values programmatically or importing a saved JSON state, managing sessions has never been easier. This is a must-have for authenticated crawlsโ€”just export your storage state once and reuse it effortlessly across runs. + +**Example:** +1. Open a browser, log in manually, and export the storage state. +2. Import the JSON file for seamless authenticated crawling: + +```python +result = await crawler.arun( + url="https://example.com/protected", + storage_state="my_storage_state.json" +) +``` + +--- + +### ๐Ÿ”ข **Handling Large Pages: Supercharged Screenshots and PDF Conversion** + +Two big upgrades here: + +- **Blazing-fast long-page screenshots**: Turn extremely long web pages into clean, high-quality screenshotsโ€”without breaking a sweat. Itโ€™s optimized to handle large content without lag. + +- **Full-page PDF exports**: Now, you can also convert any page into a PDF with all the details intact. Perfect for archiving or sharing complex layouts. + +--- + +### ๐Ÿ”ง **Other Cool Stuff** + +- **Anti-bot enhancements**: Magic mode now handles overlays, user simulation, and anti-detection features like a pro. +- **JavaScript execution**: Execute custom JS snippets to handle dynamic content. No more wrestling with endless page interactions. + +--- + +### ๐Ÿ“Š **Performance Boosts and Dev-friendly Updates** + +- Faster rendering and viewport adjustments for better performance. +- Improved cookie and local storage handling for seamless authentication. +- Better debugging with detailed logs and actionable error messages. + +--- + +### ๐Ÿ”  **Use Cases Youโ€™ll Love** + +1. **Authenticated Crawls**: Login once, export your storage state, and reuse it across multiple requests without the headache. +2. **Long-page Screenshots**: Perfect for blogs, e-commerce pages, or any endless-scroll website. +3. **PDF Export**: Create professional-looking page PDFs in seconds. + +--- + +### Letโ€™s Get Crawling + +Crawl4AI 0.4.2 is ready for you to download and try. Iโ€™m always looking for ways to improve, so donโ€™t hold backโ€”share your thoughts and feedback. + +Happy Crawling! ๐Ÿš€ + diff --git a/main.py b/main.py index 1c2452d0..b593c118 100644 --- a/main.py +++ b/main.py @@ -342,7 +342,7 @@ app.add_middleware( # API token security security = HTTPBearer() -CRAWL4AI_API_TOKEN = os.getenv("CRAWL4AI_API_TOKEN") or "test_api_code" +CRAWL4AI_API_TOKEN = os.getenv("CRAWL4AI_API_TOKEN") async def verify_token(credentials: HTTPAuthorizationCredentials = Security(security)): if not CRAWL4AI_API_TOKEN: diff --git a/tests/async/test_0.4.2_browser_manager.py b/tests/async/test_0.4.2_browser_manager.py new file mode 100644 index 00000000..9bb19582 --- /dev/null +++ b/tests/async/test_0.4.2_browser_manager.py @@ -0,0 +1,153 @@ +import os, sys +parent_dir = os.path.dirname(os.path.dirname(os.path.abspath(__file__))) +sys.path.append(parent_dir) +__location__ = os.path.realpath( os.path.join(os.getcwd(), os.path.dirname(__file__))) + +import os, sys +import asyncio +from crawl4ai import AsyncWebCrawler, CacheMode +from crawl4ai.content_filter_strategy import PruningContentFilter +from crawl4ai.markdown_generation_strategy import DefaultMarkdownGenerator + +# Assuming that the changes made allow different configurations +# for managed browser, persistent context, and so forth. + +async def test_default_headless(): + async with AsyncWebCrawler( + headless=True, + verbose=True, + user_agent_mode="random", + user_agent_generator_config={"device_type": "mobile", "os_type": "android"}, + use_managed_browser=False, + use_persistent_context=False, + ignore_https_errors=True, + # Testing normal ephemeral context + ) as crawler: + result = await crawler.arun( + url='https://www.kidocode.com/degrees/technology', + cache_mode=CacheMode.BYPASS, + markdown_generator=DefaultMarkdownGenerator(options={"ignore_links": True}), + ) + print("[test_default_headless] success:", result.success) + print("HTML length:", len(result.html if result.html else "")) + +async def test_managed_browser_persistent(): + # Treating use_persistent_context=True as managed_browser scenario. + async with AsyncWebCrawler( + headless=False, + verbose=True, + user_agent_mode="random", + user_agent_generator_config={"device_type": "desktop", "os_type": "mac"}, + use_managed_browser=True, + use_persistent_context=True, # now should behave same as managed browser + user_data_dir="./outpu/test_profile", + # This should store and reuse profile data across runs + ) as crawler: + result = await crawler.arun( + url='https://www.google.com', + cache_mode=CacheMode.BYPASS, + markdown_generator=DefaultMarkdownGenerator(options={"ignore_links": True}) + ) + print("[test_managed_browser_persistent] success:", result.success) + print("HTML length:", len(result.html if result.html else "")) + +async def test_session_reuse(): + # Test creating a session, using it for multiple calls + session_id = "my_session" + async with AsyncWebCrawler( + headless=False, + verbose=True, + user_agent="Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36", + # Fixed user-agent for consistency + use_managed_browser=False, + use_persistent_context=False, + ) as crawler: + + # First call: create session + result1 = await crawler.arun( + url='https://www.example.com', + cache_mode=CacheMode.BYPASS, + session_id=session_id, + markdown_generator=DefaultMarkdownGenerator(options={"ignore_links": True}) + ) + print("[test_session_reuse first call] success:", result1.success) + + # Second call: same session, possibly cookie retained + result2 = await crawler.arun( + url='https://www.example.com/about', + cache_mode=CacheMode.BYPASS, + session_id=session_id, + markdown_generator=DefaultMarkdownGenerator(options={"ignore_links": True}) + ) + print("[test_session_reuse second call] success:", result2.success) + +async def test_magic_mode(): + # Test magic mode with override_navigator and simulate_user + async with AsyncWebCrawler( + headless=False, + verbose=True, + user_agent_mode="random", + user_agent_generator_config={"device_type": "desktop", "os_type": "windows"}, + use_managed_browser=False, + use_persistent_context=False, + magic=True, + override_navigator=True, + simulate_user=True, + ) as crawler: + result = await crawler.arun( + url='https://www.kidocode.com/degrees/business', + cache_mode=CacheMode.BYPASS, + markdown_generator=DefaultMarkdownGenerator(options={"ignore_links": True}) + ) + print("[test_magic_mode] success:", result.success) + print("HTML length:", len(result.html if result.html else "")) + +async def test_proxy_settings(): + # Test with a proxy (if available) to ensure code runs with proxy + async with AsyncWebCrawler( + headless=True, + verbose=False, + user_agent="Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36", + proxy="http://127.0.0.1:8080", # Assuming local proxy server for test + use_managed_browser=False, + use_persistent_context=False, + ) as crawler: + result = await crawler.arun( + url='https://httpbin.org/ip', + cache_mode=CacheMode.BYPASS, + markdown_generator=DefaultMarkdownGenerator(options={"ignore_links": True}) + ) + print("[test_proxy_settings] success:", result.success) + if result.success: + print("HTML preview:", result.html[:200] if result.html else "") + +async def test_ignore_https_errors(): + # Test ignore HTTPS errors with a self-signed or invalid cert domain + # This is just conceptual, the domain should be one that triggers SSL error. + # Using a hypothetical URL that fails SSL: + async with AsyncWebCrawler( + headless=True, + verbose=True, + user_agent="Mozilla/5.0", + ignore_https_errors=True, + use_managed_browser=False, + use_persistent_context=False, + ) as crawler: + result = await crawler.arun( + url='https://self-signed.badssl.com/', + cache_mode=CacheMode.BYPASS, + markdown_generator=DefaultMarkdownGenerator(options={"ignore_links": True}) + ) + print("[test_ignore_https_errors] success:", result.success) + +async def main(): + print("Running tests...") + # await test_default_headless() + # await test_managed_browser_persistent() + # await test_session_reuse() + # await test_magic_mode() + # await test_proxy_settings() + await test_ignore_https_errors() + +if __name__ == "__main__": + asyncio.run(main()) diff --git a/tests/async/test_0.4.2_config_params.py b/tests/async/test_0.4.2_config_params.py new file mode 100644 index 00000000..28529ac2 --- /dev/null +++ b/tests/async/test_0.4.2_config_params.py @@ -0,0 +1,231 @@ +import os, sys +parent_dir = os.path.dirname(os.path.dirname(os.path.abspath(__file__))) +sys.path.append(parent_dir) +__location__ = os.path.realpath(os.path.join(os.getcwd(), os.path.dirname(__file__))) + +import asyncio +from crawl4ai import AsyncWebCrawler, CacheMode +from crawl4ai.async_configs import BrowserConfig, CrawlerRunConfig +from crawl4ai.content_filter_strategy import PruningContentFilter +from crawl4ai.extraction_strategy import JsonCssExtractionStrategy +from crawl4ai.chunking_strategy import RegexChunking +from crawl4ai.markdown_generation_strategy import DefaultMarkdownGenerator + +# Category 1: Browser Configuration Tests +async def test_browser_config_object(): + """Test the new BrowserConfig object with various browser settings""" + browser_config = BrowserConfig( + browser_type="chromium", + headless=False, + viewport_width=1920, + viewport_height=1080, + use_managed_browser=True, + user_agent_mode="random", + user_agent_generator_config={"device_type": "desktop", "os_type": "windows"} + ) + + async with AsyncWebCrawler(config=browser_config, verbose=True) as crawler: + result = await crawler.arun('https://example.com', cache_mode=CacheMode.BYPASS) + assert result.success, "Browser config crawl failed" + assert len(result.html) > 0, "No HTML content retrieved" + +async def test_browser_performance_config(): + """Test browser configurations focused on performance""" + browser_config = BrowserConfig( + text_only=True, + light_mode=True, + extra_args=['--disable-gpu', '--disable-software-rasterizer'], + ignore_https_errors=True, + java_script_enabled=False + ) + + async with AsyncWebCrawler(config=browser_config) as crawler: + result = await crawler.arun('https://example.com') + assert result.success, "Performance optimized crawl failed" + assert result.status_code == 200, "Unexpected status code" + +# Category 2: Content Processing Tests +async def test_content_extraction_config(): + """Test content extraction with various strategies""" + crawler_config = CrawlerRunConfig( + word_count_threshold=300, + extraction_strategy=JsonCssExtractionStrategy( + schema={ + "name": "article", + "baseSelector": "div", + "fields": [{ + "name": "title", + "selector": "h1", + "type": "text" + }] + } + ), + chunking_strategy=RegexChunking(), + content_filter=PruningContentFilter() + ) + + async with AsyncWebCrawler() as crawler: + result = await crawler.arun( + 'https://example.com/article', + config=crawler_config + ) + assert result.extracted_content is not None, "Content extraction failed" + assert 'title' in result.extracted_content, "Missing expected content field" + +# Category 3: Cache and Session Management Tests +async def test_cache_and_session_management(): + """Test different cache modes and session handling""" + browser_config = BrowserConfig(use_persistent_context=True) + crawler_config = CrawlerRunConfig( + cache_mode=CacheMode.WRITE_ONLY, + process_iframes=True, + remove_overlay_elements=True + ) + + async with AsyncWebCrawler(config=browser_config) as crawler: + # First request - should write to cache + result1 = await crawler.arun( + 'https://example.com', + config=crawler_config + ) + + # Second request - should use fresh fetch due to WRITE_ONLY mode + result2 = await crawler.arun( + 'https://example.com', + config=crawler_config + ) + + assert result1.success and result2.success, "Cache mode crawl failed" + assert result1.html == result2.html, "Inconsistent results between requests" + +# Category 4: Media Handling Tests +async def test_media_handling_config(): + """Test configurations related to media handling""" + # Get the base path for home directroy ~/.crawl4ai/downloads, make sure it exists + os.makedirs(os.path.expanduser("~/.crawl4ai/downloads"), exist_ok=True) + browser_config = BrowserConfig( + viewport_width=1920, + viewport_height=1080, + accept_downloads=True, + downloads_path= os.path.expanduser("~/.crawl4ai/downloads") + ) + crawler_config = CrawlerRunConfig( + screenshot=True, + pdf=True, + adjust_viewport_to_content=True, + wait_for_images=True, + screenshot_height_threshold=20000 + ) + + async with AsyncWebCrawler(config=browser_config) as crawler: + result = await crawler.arun( + 'https://example.com', + config=crawler_config + ) + assert result.screenshot is not None, "Screenshot capture failed" + assert result.pdf is not None, "PDF generation failed" + +# Category 5: Anti-Bot and Site Interaction Tests +async def test_antibot_config(): + """Test configurations for handling anti-bot measures""" + crawler_config = CrawlerRunConfig( + simulate_user=True, + override_navigator=True, + magic=True, + wait_for="js:()=>document.querySelector('body')", + delay_before_return_html=1.0, + log_console=True, + cache_mode=CacheMode.BYPASS + ) + + async with AsyncWebCrawler() as crawler: + result = await crawler.arun( + 'https://example.com', + config=crawler_config + ) + assert result.success, "Anti-bot measure handling failed" + +# Category 6: Parallel Processing Tests +async def test_parallel_processing(): + """Test parallel processing capabilities""" + crawler_config = CrawlerRunConfig( + mean_delay=0.5, + max_range=1.0, + semaphore_count=5 + ) + + urls = [ + 'https://example.com/1', + 'https://example.com/2', + 'https://example.com/3' + ] + + async with AsyncWebCrawler() as crawler: + results = await crawler.arun_many( + urls, + config=crawler_config + ) + assert len(results) == len(urls), "Not all URLs were processed" + assert all(r.success for r in results), "Some parallel requests failed" + +# Category 7: Backwards Compatibility Tests +async def test_legacy_parameter_support(): + """Test that legacy parameters still work""" + async with AsyncWebCrawler( + headless=True, + browser_type="chromium", + viewport_width=1024, + viewport_height=768 + ) as crawler: + result = await crawler.arun( + 'https://example.com', + screenshot=True, + word_count_threshold=200, + bypass_cache=True, + css_selector=".main-content" + ) + assert result.success, "Legacy parameter support failed" + +# Category 8: Mixed Configuration Tests +async def test_mixed_config_usage(): + """Test mixing new config objects with legacy parameters""" + browser_config = BrowserConfig(headless=True) + crawler_config = CrawlerRunConfig(screenshot=True) + + async with AsyncWebCrawler( + config=browser_config, + verbose=True # legacy parameter + ) as crawler: + result = await crawler.arun( + 'https://example.com', + config=crawler_config, + cache_mode=CacheMode.BYPASS, # legacy parameter + css_selector="body" # legacy parameter + ) + assert result.success, "Mixed configuration usage failed" + +if __name__ == "__main__": + async def run_tests(): + test_functions = [ + test_browser_config_object, + # test_browser_performance_config, + # test_content_extraction_config, + # test_cache_and_session_management, + # test_media_handling_config, + # test_antibot_config, + # test_parallel_processing, + # test_legacy_parameter_support, + # test_mixed_config_usage + ] + + for test in test_functions: + print(f"\nRunning {test.__name__}...") + try: + await test() + print(f"โœ“ {test.__name__} passed") + except AssertionError as e: + print(f"โœ— {test.__name__} failed: {str(e)}") + except Exception as e: + print(f"โœ— {test.__name__} error: {str(e)}") + + asyncio.run(run_tests()) \ No newline at end of file