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.
67 lines
2.4 KiB
Python
67 lines
2.4 KiB
Python
"""Playwright web browser toolkit."""
|
|
from __future__ import annotations
|
|
|
|
from typing import TYPE_CHECKING, List, Type
|
|
|
|
from pydantic import Extra, Field, root_validator
|
|
|
|
from langchain.agents.agent_toolkits.base import BaseToolkit
|
|
from langchain.tools.base import BaseTool
|
|
from langchain.tools.playwright.base import BaseBrowserTool
|
|
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
|
|
from langchain.tools.playwright.utils import create_playwright_browser
|
|
|
|
if TYPE_CHECKING:
|
|
from playwright.async_api import Browser as AsyncBrowser
|
|
|
|
|
|
class PlayWrightBrowserToolkit(BaseToolkit):
|
|
"""Toolkit for web browser tools."""
|
|
|
|
browser: AsyncBrowser = Field(default_factory=create_playwright_browser)
|
|
|
|
class Config:
|
|
"""Configuration for this pydantic object."""
|
|
|
|
extra = Extra.forbid
|
|
arbitrary_types_allowed = True
|
|
|
|
@root_validator
|
|
def check_args(cls, values: dict) -> dict:
|
|
"""Check that the arguments are valid."""
|
|
try:
|
|
from playwright.async_api import Browser as AsyncBrowser # noqa: F401
|
|
except ImportError:
|
|
raise ValueError(
|
|
"The 'playwright' package is required to use this tool."
|
|
" Please install it with 'pip install playwright'."
|
|
)
|
|
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,
|
|
]
|
|
|
|
return [tool_cls.from_browser(self.browser) for tool_cls in tool_classes]
|
|
|
|
@classmethod
|
|
def from_browser(cls, browser: AsyncBrowser) -> PlayWrightBrowserToolkit:
|
|
from playwright.async_api import Browser as AsyncBrowser
|
|
|
|
cls.update_forward_refs(AsyncBrowser=AsyncBrowser)
|
|
return cls(browser=browser)
|