Skip to content

fix: Adapt to CrawlerMonitor constructor change #1106

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

devxpain
Copy link

@devxpain devxpain commented May 13, 2025

The upstream commit 1630fbd (2025-03-12) introduced a new TerminalUI and modified the CrawlerMonitor.

This change updates the codebase to align with the new CrawlerMonitor constructor interface, which no longer requires the max_visible_rows and display_mode parameters.

Summary

Fix the error below

$ uv run docs/examples/dispatcher_example.py
Traceback (most recent call last):
  File "/Volumes/Data/workspace/github/devxpain-fork/crawl4ai/docs/examples/dispatcher_example.py", line 136, in <module>
    asyncio.run(main())
  File "/Users/paynechu/.local/share/uv/python/cpython-3.10.17-macos-aarch64-none/lib/python3.10/asyncio/runners.py", line 44, in run
    return loop.run_until_complete(main)
  File "/Users/paynechu/.local/share/uv/python/cpython-3.10.17-macos-aarch64-none/lib/python3.10/asyncio/base_events.py", line 649, in run_until_complete
    return future.result()
  File "/Volumes/Data/workspace/github/devxpain-fork/crawl4ai/docs/examples/dispatcher_example.py", line 120, in main
    "Memory Adaptive": await memory_adaptive(urls, browser_config, run_config),
  File "/Volumes/Data/workspace/github/devxpain-fork/crawl4ai/docs/examples/dispatcher_example.py", line 26, in memory_adaptive
    monitor=CrawlerMonitor(
TypeError: CrawlerMonitor.__init__() got an unexpected keyword argument 'max_visible_rows'

How Has This Been Tested?

$ uv run docs/examples/dispatcher_example.py

Summary by CodeRabbit

  • Documentation

    • Simplified code examples and documentation by initializing monitors with default settings, removing explicit configuration parameters from all relevant examples and usage guides.
  • Tests

    • Updated tests to use default monitor initialization, removing detailed display and row limit settings from monitor instances.

Copy link

coderabbitai bot commented May 13, 2025

Walkthrough

The changes simplify the instantiation of the CrawlerMonitor and related monitor classes across documentation, examples, and tests by removing explicit configuration parameters and using their default constructors. No functional logic, error handling, or control flow is altered; only the monitor initialization is streamlined throughout the codebase.

Changes

File(s) Change Summary
docs/examples/dispatcher_example.py, docs/examples/proxy_rotation_demo.py Removed explicit parameters from CrawlerMonitor instantiations; now uses default constructor in all examples.
docs/md_v2/advanced/multi-url-crawling.md, deploy/docker/c4ai-doc-context.md Updated documentation examples to instantiate CrawlerMonitor with default settings, removing custom arguments.
deploy/docker/c4ai-code-context.md Documentation updated to use CrawlerMonitor() with default settings in dispatcher usage examples.
tests/async/test_dispatchers.py Test now creates CrawlerMonitor without arguments; previously set custom parameters.
tests/memory/test_dispatcher_stress.py StressTestMonitor instantiation simplified by removing display-related arguments.

Poem

A monitor once dressed in detail and rows,
Now hops along simply, wherever it goes.
No more display modes or numbers to show—
Just default attire, ready to flow!
With lighter examples and tests in the sun,
The codebase is simpler, and that’s a job well done.
🐇✨

Tip

⚡️ Faster reviews with caching
  • CodeRabbit now supports caching for code and dependencies, helping speed up reviews. This means quicker feedback, reduced wait times, and a smoother review experience overall. Cached data is encrypted and stored securely. This feature will be automatically enabled for all accounts on May 16th. To opt out, configure Review - Disable Cache at either the organization or repository level. If you prefer to disable all data retention across your organization, simply turn off the Data Retention setting under your Organization Settings.

Enjoy the performance boost—your workflow just got faster.

✨ Finishing Touches
  • 📝 Generate Docstrings

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

The upstream commit 1630fbd (2025-03-12) introduced a new TerminalUI and modified the CrawlerMonitor.

This change updates the codebase to align with the new CrawlerMonitor constructor interface, which no longer requires the `max_visible_rows` and `display_mode` parameters.
@devxpain devxpain changed the title refactor: Adapt to CrawlerMonitor constructor change fix: Adapt to CrawlerMonitor constructor change May 13, 2025
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

♻️ Duplicate comments (3)
deploy/docker/c4ai-code-context.md (3)

8917-8921: Use default CrawlerMonitor constructor


8932-8936: Use default CrawlerMonitor constructor


8950-8954: Use default CrawlerMonitor constructor

🧹 Nitpick comments (3)
docs/md_v2/advanced/multi-url-crawling.md (3)

122-124: Remove unused DisplayMode import and clarify default behavior.
Since you’ve removed the explicit constructor args, DisplayMode is imported but no longer used. It would be clearer to drop it:

-from crawl4ai import CrawlerMonitor, DisplayMode
+from crawl4ai import CrawlerMonitor

Also consider stating what the default display_mode and max_visible_rows values are so readers know the out-of-the-box behavior.


151-152: Ensure CrawlerMonitor is in scope for the MemoryAdaptiveDispatcher example.
You’re passing monitor=CrawlerMonitor() without importing it in this snippet. To keep examples copy-pasteable, either add:

 from crawl4ai.async_dispatcher import MemoryAdaptiveDispatcher
+from crawl4ai import CrawlerMonitor

or qualify the class (crawl4ai.CrawlerMonitor()).


306-307: Import CrawlerMonitor in the semaphore-based snippet.
The crawl_with_semaphore example uses monitor=CrawlerMonitor() but lacks the corresponding import. Add at the top of that block:

+from crawl4ai import CrawlerMonitor

so readers don’t hit a NameError when following the guide.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 897e017 and c7e4ff5.

📒 Files selected for processing (7)
  • deploy/docker/c4ai-code-context.md (4 hunks)
  • deploy/docker/c4ai-doc-context.md (4 hunks)
  • docs/examples/dispatcher_example.py (4 hunks)
  • docs/examples/proxy_rotation_demo.py (1 hunks)
  • docs/md_v2/advanced/multi-url-crawling.md (4 hunks)
  • tests/async/test_dispatchers.py (1 hunks)
  • tests/memory/test_dispatcher_stress.py (0 hunks)
💤 Files with no reviewable changes (1)
  • tests/memory/test_dispatcher_stress.py
🧰 Additional context used
🧬 Code Graph Analysis (2)
docs/examples/dispatcher_example.py (1)
crawl4ai/components/crawler_monitor.py (1)
  • CrawlerMonitor (350-753)
docs/examples/proxy_rotation_demo.py (1)
crawl4ai/components/crawler_monitor.py (1)
  • CrawlerMonitor (350-753)
🪛 Ruff (0.8.2)
docs/examples/proxy_rotation_demo.py

106-106: Local variable monitor is assigned to but never used

Remove assignment to unused variable monitor

(F841)

🔇 Additional comments (8)
tests/async/test_dispatchers.py (1)

156-156: LGTM! Constructor parameter update is correct.

The CrawlerMonitor instantiation has been correctly updated to use the default constructor without parameters, aligning with the upstream constructor interface changes.

docs/examples/dispatcher_example.py (4)

26-27: LGTM! Constructor parameter update is correct.

The CrawlerMonitor instantiation has been correctly updated to use the default constructor without parameters, aligning with the upstream constructor interface changes.


45-46: LGTM! Constructor parameter update is correct.

The CrawlerMonitor instantiation has been correctly updated to use the default constructor without parameters, aligning with the upstream constructor interface changes.


60-61: LGTM! Constructor parameter update is correct.

The CrawlerMonitor instantiation has been correctly updated to use the default constructor without parameters, aligning with the upstream constructor interface changes.


78-79: LGTM! Constructor parameter update is correct.

The CrawlerMonitor instantiation has been correctly updated to use the default constructor without parameters, aligning with the upstream constructor interface changes.

deploy/docker/c4ai-code-context.md (1)

8899-8902: Use default CrawlerMonitor constructor
Removed explicit parameters and now instantiate CrawlerMonitor() with no arguments to match the updated constructor signature from upstream.

deploy/docker/c4ai-doc-context.md (2)

6656-6656: Documentation update correctly reflects API change.

The change properly updates the CrawlerMonitor instantiation by removing parameters that are no longer supported in the constructor, aligning with the upstream changes mentioned in the PR description.


6723-6723: Constructor parameter removal accurately implemented.

This change is consistent with the CrawlerMonitor API update, correctly removing the unsupported parameters from the dispatcher configuration example.

max_visible_rows=10,
display_mode=DisplayMode.DETAILED
)
monitor = CrawlerMonitor()
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

Unused variable detected.

The monitor variable is created but never used in this function. Either pass it to the MemoryAdaptiveDispatcher by uncommenting line 112 or remove the variable assignment completely.

Either:

-            monitor = CrawlerMonitor()

Or:

             monitor = CrawlerMonitor()
             
             dispatcher = MemoryAdaptiveDispatcher(
                 memory_threshold_percent=80.0,
                 check_interval=0.5,
                 max_session_permit=1, #len(proxies),  # Match concurrent sessions to proxy count
-                # monitor=monitor
+                monitor=monitor
             )
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
monitor = CrawlerMonitor()
dispatcher = MemoryAdaptiveDispatcher(
memory_threshold_percent=80.0,
check_interval=0.5,
max_session_permit=1, # Match concurrent sessions to proxy count
# monitor=monitor
)
Suggested change
monitor = CrawlerMonitor()
monitor = CrawlerMonitor()
dispatcher = MemoryAdaptiveDispatcher(
memory_threshold_percent=80.0,
check_interval=0.5,
max_session_permit=1, # Match concurrent sessions to proxy count
monitor=monitor
)
🧰 Tools
🪛 Ruff (0.8.2)

106-106: Local variable monitor is assigned to but never used

Remove assignment to unused variable monitor

(F841)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant