notte-browser 1.4.0__tar.gz

notte_browser-1.4.0/.gitignore

@@ -0,0 +1,179 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+ignore.*
+llm_usage.jsonl
+llm_parsing_error.jsonl
+traces/
+
+**/__pycache__/**
+.DS_Store
+**/.DS_Store
+old
+notebook

notte_browser-1.4.0/PKG-INFO

@@ -0,0 +1,16 @@
+Metadata-Version: 2.4
+Name: notte-browser
+Version: 1.4.0
+Summary: The web browser for LLMs agents
+Author-email: Notte Team  <hello@notte.cc>
+Requires-Python: >=3.11
+Requires-Dist: maincontentextractor
+Requires-Dist: notte-core>=1.3.3
+Requires-Dist: patchright==1.50.0
+Description-Content-Type: text/markdown
+
+# Notte Processing Pipelines
+
+Each pipeline is a set of steps that are used to preprocess either a browser snapshot or a LLM observation.
+
+Each file in this directory is a separate but mandatory in the global workflow.

notte_browser-1.4.0/README.md

@@ -0,0 +1,5 @@
+# Notte Processing Pipelines
+
+Each pipeline is a set of steps that are used to preprocess either a browser snapshot or a LLM observation.
+
+Each file in this directory is a separate but mandatory in the global workflow.

notte_browser-1.4.0/pyproject.toml

@@ -0,0 +1,28 @@
+[project]
+name = "notte-browser"
+version = "1.4.0"
+description = "The web browser for LLMs agents"
+readme = "README.md"
+authors = [
+    { name = "Notte Team ", email = "hello@notte.cc" }
+]
+packages = [
+  { include = "notte_browser", from = "src" },
+]
+
+
+requires-python = ">=3.11"
+dependencies = [
+    "notte_core>=1.3.3",
+    "patchright==1.50.0",
+    "maincontentextractor",
+]
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[dependency-groups]
+
+[tool.uv.sources]
+maincontentextractor = { git = "https://github.com/HawkClaws/main_content_extractor", rev = "7c3ed7f6ed7f6c10223a3357d43ab741663bc812" }

notte_browser-1.4.0/src/notte_browser/__init__.py

@@ -0,0 +1,3 @@
+from notte_core import check_notte_version
+
+__version__ = check_notte_version("notte_browser")

notte_browser-1.4.0/src/notte_browser/controller.py

@@ -0,0 +1,219 @@
+from loguru import logger
+from notte_core.browser.snapshot import BrowserSnapshot
+from notte_core.controller.actions import (
+    BaseAction,
+    CheckAction,
+    ClickAction,
+    CompletionAction,
+    FillAction,
+    GoBackAction,
+    GoForwardAction,
+    GotoAction,
+    GotoNewTabAction,
+    InteractionAction,
+    ListDropdownOptionsAction,
+    PressKeyAction,
+    ReloadAction,
+    ScrapeAction,
+    ScrollDownAction,
+    ScrollUpAction,
+    SelectDropdownOptionAction,
+    SwitchTabAction,
+    WaitAction,
+)
+from notte_core.credentials.types import get_str_value
+from notte_core.utils.code import text_contains_tabs
+from notte_core.utils.platform import platform_control_key
+from patchright.async_api import Locator
+from typing_extensions import final
+
+from notte_browser.dom.dropdown_menu import dropdown_menu_options
+from notte_browser.dom.locate import locate_element
+from notte_browser.errors import capture_playwright_errors
+from notte_browser.window import BrowserWindow
+
+
+@final
+class BrowserController:
+    def __init__(self, window: BrowserWindow, verbose: bool = False) -> None:
+        self.window: BrowserWindow = window
+        self.verbose: bool = verbose
+
+        self.execute = capture_playwright_errors(verbose=verbose)(self.execute)  # type: ignore[reportAttributeAccessIssue]
+
+    async def switch_tab(self, tab_index: int) -> None:
+        context = self.window.page.context
+        if tab_index != -1 and (tab_index < 0 or tab_index >= len(context.pages)):
+            raise ValueError(f"Tab index '{tab_index}' is out of range for context with {len(context.pages)} pages")
+        tab_page = context.pages[tab_index]
+        await tab_page.bring_to_front()
+        self.window.page = tab_page
+        await self.window.long_wait()
+        if self.verbose:
+            logger.info(
+                f"🪦 Switched to tab {tab_index} with url: {tab_page.url} ({len(context.pages)} tabs in context)"
+            )
+
+    async def execute_browser_action(self, action: BaseAction) -> BrowserSnapshot | None:
+        match action:
+            case GotoAction(url=url):
+                return await self.window.goto(url)
+            case GotoNewTabAction(url=url):
+                new_page = await self.window.page.context.new_page()
+                self.window.page = new_page
+                _ = await new_page.goto(url)
+            case SwitchTabAction(tab_index=tab_index):
+                await self.switch_tab(tab_index)
+            case WaitAction(time_ms=time_ms):
+                await self.window.page.wait_for_timeout(time_ms)
+            case GoBackAction():
+                _ = await self.window.page.go_back()
+            case GoForwardAction():
+                _ = await self.window.page.go_forward()
+            case ReloadAction():
+                _ = await self.window.page.reload()
+                await self.window.long_wait()
+            case PressKeyAction(key=key):
+                await self.window.page.keyboard.press(key)
+            case ScrollUpAction(amount=amount):
+                if amount is not None:
+                    await self.window.page.mouse.wheel(delta_x=0, delta_y=-amount)
+                else:
+                    await self.window.page.keyboard.press("PageUp")
+            case ScrollDownAction(amount=amount):
+                if amount is not None:
+                    await self.window.page.mouse.wheel(delta_x=0, delta_y=amount)
+                else:
+                    await self.window.page.keyboard.press("PageDown")
+            case ScrapeAction():
+                raise NotImplementedError("Scrape action is not supported in the browser controller")
+            case _:
+                raise ValueError(f"Unsupported action type: {type(action)}")
+
+        # perform snapshot in execute
+        return None
+
+    async def execute_interaction_action(self, action: InteractionAction) -> BrowserSnapshot | None:
+        if action.selector is None:
+            raise ValueError(f"Selector is required for {action.name()}")
+        press_enter = False
+        if action.press_enter is not None:
+            press_enter = action.press_enter
+        # locate element (possibly in iframe)
+        locator: Locator = await locate_element(self.window.page, action.selector)
+        original_url = self.window.page.url
+
+        action_timeout = self.window.config.wait.action_timeout
+
+        match action:
+            # Interaction actions
+            case ClickAction():
+                await locator.click(timeout=action_timeout)
+            case FillAction(value=value):
+                if text_contains_tabs(text=get_str_value(value)):
+                    if self.verbose:
+                        logger.info(
+                            "🪦 Indentation detected in fill action: simulating clipboard copy/paste for better string formatting"
+                        )
+                    await locator.focus()
+
+                    if action.clear_before_fill:
+                        await self.window.page.keyboard.press(key=f"{platform_control_key()}+A")
+                        await self.window.short_wait()
+                        await self.window.page.keyboard.press(key="Backspace")
+                        await self.window.short_wait()
+
+                    # Use isolated clipboard variable instead of system clipboard
+                    await self.window.page.evaluate(
+                        """
+                        (text) => {
+                            window.__isolatedClipboard = text;
+                            const dataTransfer = new DataTransfer();
+                            dataTransfer.setData('text/plain', window.__isolatedClipboard);
+                            document.activeElement.dispatchEvent(new ClipboardEvent('paste', {
+                                clipboardData: dataTransfer,
+                                bubbles: true,
+                                cancelable: true
+                            }));
+                        }
+                    """,
+                        value,
+                    )
+
+                    await self.window.short_wait()
+                else:
+                    await locator.fill(get_str_value(value), timeout=action_timeout, force=action.clear_before_fill)
+                    await self.window.short_wait()
+            case CheckAction(value=value):
+                if value:
+                    await locator.check()
+                else:
+                    await locator.uncheck()
+            case SelectDropdownOptionAction(value=value, option_selector=option_selector):
+                # Check if it's a standard HTML select
+                tag_name: str = await locator.evaluate("el => el.tagName.toLowerCase()")
+                if tag_name == "select":
+                    # Handle standard HTML select
+                    _ = await locator.select_option(value)
+                elif option_selector is None:
+                    raise ValueError(f"Option selector is required for {action.name()}")
+                else:
+                    option_locator = await locate_element(self.window.page, option_selector)
+                    # Handle non-standard select
+                    await option_locator.click()
+
+            case ListDropdownOptionsAction():
+                options = await dropdown_menu_options(self.window.page, action.selector.xpath_selector)
+                if self.verbose:
+                    logger.info(f"Dropdown options: {options}")
+                raise NotImplementedError("ListDropdownOptionsAction is not supported in the browser controller")
+            case _:
+                raise ValueError(f"Unsupported action type: {type(action)}")
+        if press_enter:
+            if self.verbose:
+                logger.info(f"🪦 Pressing enter for action {action.id}")
+            await self.window.short_wait()
+            await self.window.page.keyboard.press("Enter")
+        if original_url != self.window.page.url:
+            if self.verbose:
+                logger.info(f"🪦 Page navigation detected for action {action.id} waiting for networkidle")
+            await self.window.long_wait()
+
+        # perform snapshot in execute
+        return None
+
+    async def execute(self, action: BaseAction) -> BrowserSnapshot:
+        context = self.window.page.context
+        num_pages = len(context.pages)
+        match action:
+            case InteractionAction():
+                retval = await self.execute_interaction_action(action)
+            case CompletionAction(success=success, answer=answer):
+                snapshot = await self.window.snapshot()
+                if self.verbose:
+                    logger.info(
+                        f"Completion action: status={'success' if success else 'failure'} with answer = {answer}"
+                    )
+                await self.window.close()
+                return snapshot
+            case _:
+                retval = await self.execute_browser_action(action)
+        # add short wait before we check for new tabs to make sure that
+        # the page has time to be created
+        await self.window.short_wait()
+        if len(context.pages) != num_pages:
+            if self.verbose:
+                logger.info(f"🪦 Action {action.id} resulted in a new tab, switched to it...")
+            await self.switch_tab(tab_index=-1)
+        elif retval is not None:
+            # only return snapshot if we didn't switch to a new tab
+            # otherwise, the snapshot is out of date and we need to take a new one
+            return retval
+
+        return await self.window.snapshot()
+
+    async def execute_multiple(self, actions: list[BaseAction]) -> list[BrowserSnapshot]:
+        snapshots: list[BrowserSnapshot] = []
+        for action in actions:
+            snapshots.append(await self.execute(action))
+        return snapshots