add tests

Author: Mantisus

src/crawlee/browsers/_stagehand_browser_controller.py

@@ -179,9 +179,12 @@ async def _ensure_session(
         browser_new_context_options: Mapping[str, Any] | None = None,
         proxy_info: ProxyInfo | None = None,
     ) -> None:
+
         if self._session is not None:
             return
+
         async with self._session_init_lock:
+            # Double-check if the session was created while waiting for the lock.
             if self._session is not None:
                 return
 
@@ -231,7 +234,5 @@ async def _ensure_session(
                 )
 
             self._browser = await self._playwright.chromium.connect_over_cdp(cdp_url)
-            self._browser_context = (
-                self._browser.contexts[0] if self._browser.contexts else await self._browser.new_context()
-            )
+            self._browser_context = self._browser.contexts[0]
             self._session = session

src/crawlee/browsers/_stagehand_browser_plugin.py

@@ -71,9 +71,9 @@ def __init__(
         config = service_locator.get_configuration()
 
         self._max_open_pages_per_browser = max_open_pages_per_browser
-        self.stagehand_options = stagehand_options or StagehandOptions()
+        self._stagehand_options = stagehand_options or StagehandOptions()
 
-        is_local = self.stagehand_options.env == 'LOCAL'
+        is_local = self._stagehand_options.env == 'LOCAL'
 
         # browser_launch_options take priority over browser_new_context_options for shared keys.
         self._browser_launch_options: dict[str, Any] = {
@@ -93,14 +93,14 @@ def __init__(
         self._stagehand_init_params: dict[str, Any] = {
             'server': 'local' if is_local else 'remote',
             'local_headless': self._browser_launch_options['headless'],
-            'local_ready_timeout_s': self.stagehand_options.local_ready_timeout_s,
+            'local_ready_timeout_s': self._stagehand_options.local_ready_timeout_s,
         }
-        if self.stagehand_options.model_api_key is not None:
-            self._stagehand_init_params['model_api_key'] = self.stagehand_options.model_api_key
+        if self._stagehand_options.model_api_key is not None:
+            self._stagehand_init_params['model_api_key'] = self._stagehand_options.model_api_key
 
         if not is_local:
-            self._stagehand_init_params['browserbase_api_key'] = self.stagehand_options.browserbase_api_key
-            self._stagehand_init_params['browserbase_project_id'] = self.stagehand_options.project_id
+            self._stagehand_init_params['browserbase_api_key'] = self._stagehand_options.browserbase_api_key
+            self._stagehand_init_params['browserbase_project_id'] = self._stagehand_options.project_id
 
         self._stagehand_client: AsyncStagehand | None = None
         self._playwright_context_manager = async_playwright()
@@ -145,6 +145,11 @@ def browser_new_context_options(self) -> Mapping[str, Any]:
     def max_open_pages_per_browser(self) -> int:
         return self._max_open_pages_per_browser
 
+    @property
+    def stagehand_options(self) -> StagehandOptions:
+        """Return the Stagehand-specific configuration options."""
+        return self._stagehand_options
+
     @override
     async def __aenter__(self) -> StagehandBrowserPlugin:
         if self._active:
@@ -153,7 +158,7 @@ async def __aenter__(self) -> StagehandBrowserPlugin:
         self._active = True
         self._playwright = await self._playwright_context_manager.__aenter__()
 
-        if self.stagehand_options.env == 'LOCAL':
+        if self._stagehand_options.env == 'LOCAL':
             if 'executable_path' not in self._browser_launch_options:
                 chrome_path = self._playwright.chromium.executable_path
                 self._browser_launch_options['executable_path'] = chrome_path
@@ -195,6 +200,6 @@ async def new_browser(self) -> BrowserController:
         return StagehandBrowserController(
             playwright=self._playwright,
             stagehand_client=self._stagehand_client,
-            stagehand_options=self.stagehand_options,
+            stagehand_options=self._stagehand_options,
             max_open_pages_per_browser=self._max_open_pages_per_browser,
         )

src/crawlee/browsers/_stagehand_types.py

@@ -79,7 +79,7 @@ def __init__(self, page: Page, session: AsyncSession) -> None:
         self._session = session
 
     async def act(self, **kwargs: Unpack[SessionActParams]) -> SessionActResponse:
-        """Perform an action on the page using natural language.
+        """Perform an action on the page using natural language. Argument `page` is automatically set.
 
         Args:
             **kwargs: Parameters passed to ``AsyncSession.act()``.
@@ -92,7 +92,7 @@ async def act(self, **kwargs: Unpack[SessionActParams]) -> SessionActResponse:
         return await self._session.act(page=self, **kwargs)
 
     async def observe(self, **kwargs: Unpack[SessionObserveParams]) -> SessionObserveResponse:
-        """Observe the page and get AI-suggested actions.
+        """Observe the page and get AI-suggested actions. Argument `page` is automatically set.
 
         Args:
             **kwargs: Parameters passed to ``AsyncSession.observe()``.
@@ -104,7 +104,7 @@ async def observe(self, **kwargs: Unpack[SessionObserveParams]) -> SessionObserv
         return await self._session.observe(page=self, **kwargs)
 
     async def extract(self, **kwargs: Unpack[SessionExtractParams]) -> SessionExtractResponse:
-        """Extract structured data from the page using natural language.
+        """Extract structured data from the page using natural language. Argument `page` is automatically set.
 
         Args:
             **kwargs: Parameters passed to ``AsyncSession.extract()``.
@@ -116,7 +116,7 @@ async def extract(self, **kwargs: Unpack[SessionExtractParams]) -> SessionExtrac
         return await self._session.extract(page=self, **kwargs)
 
     async def execute(self, **kwargs: Unpack[SessionExecuteParams]) -> SessionExecuteResponse:
-        """Execute arbitrary code on the page via natural language instructions.
+        """Execute arbitrary code on the page via natural language instructions. Argument `page` is automatically set.
 
         Args:
             **kwargs: Parameters passed to ``AsyncSession.execute()``.

src/crawlee/crawlers/_stagehand/_stagehand_crawler.py

@@ -1,5 +1,6 @@
 from __future__ import annotations
 
+import logging
 from typing import TYPE_CHECKING, Any
 
 from crawlee._utils.docs import docs_group
@@ -67,7 +68,7 @@ class StagehandCrawler(
 
     crawler = StagehandCrawler(
         stagehand_options=StagehandOptions(
-            api_key='sk-...',
+            model_api_key='sk-...',
             model='openai/gpt-4.1-mini',
         ),
     )
@@ -168,6 +169,8 @@ def __init__(
                 ]
             )
 
+        kwargs.setdefault('_logger', logging.getLogger(__name__))
+
         super().__init__(
             browser_pool=browser_pool,
             goto_options=goto_options,