forked from Archives/langchain
You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
84 lines
2.9 KiB
Python
84 lines
2.9 KiB
Python
"""Playwright web browser toolkit."""
|
|
from __future__ import annotations
|
|
|
|
from typing import TYPE_CHECKING, List, Optional, Type, cast
|
|
|
|
from pydantic import Extra, root_validator
|
|
|
|
from langchain.agents.agent_toolkits.base import BaseToolkit
|
|
from langchain.tools.base import BaseTool
|
|
from langchain.tools.playwright.base import (
|
|
BaseBrowserTool,
|
|
lazy_import_playwright_browsers,
|
|
)
|
|
from langchain.tools.playwright.click import ClickTool
|
|
from langchain.tools.playwright.current_page import CurrentWebPageTool
|
|
from langchain.tools.playwright.extract_hyperlinks import ExtractHyperlinksTool
|
|
from langchain.tools.playwright.extract_text import ExtractTextTool
|
|
from langchain.tools.playwright.get_elements import GetElementsTool
|
|
from langchain.tools.playwright.navigate import NavigateTool
|
|
from langchain.tools.playwright.navigate_back import NavigateBackTool
|
|
|
|
if TYPE_CHECKING:
|
|
from playwright.async_api import Browser as AsyncBrowser
|
|
from playwright.sync_api import Browser as SyncBrowser
|
|
else:
|
|
try:
|
|
# We do this so pydantic can resolve the types when instantiating
|
|
from playwright.async_api import Browser as AsyncBrowser
|
|
from playwright.sync_api import Browser as SyncBrowser
|
|
except ImportError:
|
|
pass
|
|
|
|
|
|
class PlayWrightBrowserToolkit(BaseToolkit):
|
|
"""Toolkit for web browser tools."""
|
|
|
|
sync_browser: Optional["SyncBrowser"] = None
|
|
async_browser: Optional["AsyncBrowser"] = None
|
|
|
|
class Config:
|
|
"""Configuration for this pydantic object."""
|
|
|
|
extra = Extra.forbid
|
|
arbitrary_types_allowed = True
|
|
|
|
@root_validator
|
|
def validate_imports_and_browser_provided(cls, values: dict) -> dict:
|
|
"""Check that the arguments are valid."""
|
|
lazy_import_playwright_browsers()
|
|
if values.get("async_browser") is None and values.get("sync_browser") is None:
|
|
raise ValueError("Either async_browser or sync_browser must be specified.")
|
|
return values
|
|
|
|
def get_tools(self) -> List[BaseTool]:
|
|
"""Get the tools in the toolkit."""
|
|
tool_classes: List[Type[BaseBrowserTool]] = [
|
|
ClickTool,
|
|
NavigateTool,
|
|
NavigateBackTool,
|
|
ExtractTextTool,
|
|
ExtractHyperlinksTool,
|
|
GetElementsTool,
|
|
CurrentWebPageTool,
|
|
]
|
|
|
|
tools = [
|
|
tool_cls.from_browser(
|
|
sync_browser=self.sync_browser, async_browser=self.async_browser
|
|
)
|
|
for tool_cls in tool_classes
|
|
]
|
|
return cast(List[BaseTool], tools)
|
|
|
|
@classmethod
|
|
def from_browser(
|
|
cls,
|
|
sync_browser: Optional[SyncBrowser] = None,
|
|
async_browser: Optional[AsyncBrowser] = None,
|
|
) -> PlayWrightBrowserToolkit:
|
|
"""Instantiate the toolkit."""
|
|
# This is to raise a better error than the forward ref ones Pydantic would have
|
|
lazy_import_playwright_browsers()
|
|
return cls(sync_browser=sync_browser, async_browser=async_browser)
|