diff --git a/.azure-pipelines/publish.yml b/.azure-pipelines/publish.yml index 52af52ceb..1a2e0e7a4 100644 --- a/.azure-pipelines/publish.yml +++ b/.azure-pipelines/publish.yml @@ -29,35 +29,54 @@ extends: stages: - stage: Stage jobs: - - job: HostJob + - job: Build + templateContext: + outputs: + - output: pipelineArtifact + path: $(Build.ArtifactStagingDirectory)/esrp-build + artifact: esrp-build steps: - task: UsePythonVersion@0 inputs: - versionSpec: '3.8' + versionSpec: '3.9' displayName: 'Use Python' - script: | python -m pip install --upgrade pip pip install -r local-requirements.txt + pip install -r requirements.txt pip install -e . - python setup.py bdist_wheel --all + for wheel in $(python setup.py --list-wheels); do + PLAYWRIGHT_TARGET_WHEEL=$wheel python -m build --wheel --outdir $(Build.ArtifactStagingDirectory)/esrp-build + done displayName: 'Install & Build' - - task: EsrpRelease@7 + - job: Publish + dependsOn: Build + templateContext: + type: releaseJob + isProduction: true inputs: - connectedservicename: 'Playwright-ESRP-Azure' - keyvaultname: 'pw-publishing-secrets' - authcertname: 'ESRP-Release-Auth' - signcertname: 'ESRP-Release-Sign' - clientid: '13434a40-7de4-4c23-81a3-d843dc81c2c5' - intent: 'PackageDistribution' - contenttype: 'PyPi' - # Keeping it commented out as a workaround for: - # https://portal.microsofticm.com/imp/v3/incidents/incident/499972482/summary - # contentsource: 'folder' - folderlocation: './dist/' - waitforreleasecompletion: true - owners: 'maxschmitt@microsoft.com' - approvers: 'maxschmitt@microsoft.com' - serviceendpointurl: 'https://api.esrp.microsoft.com' - mainpublisher: 'Playwright' - domaintenantid: '72f988bf-86f1-41af-91ab-2d7cd011db47' - displayName: 'ESRP Release to PIP' + - input: pipelineArtifact + artifactName: esrp-build + targetPath: $(Build.ArtifactStagingDirectory)/esrp-build + steps: + - checkout: none + - task: EsrpRelease@9 + inputs: + connectedservicename: 'Playwright-ESRP-PME' + usemanagedidentity: true + keyvaultname: 'playwright-esrp-pme' + signcertname: 'ESRP-Release-Sign' + clientid: '13434a40-7de4-4c23-81a3-d843dc81c2c5' + intent: 'PackageDistribution' + contenttype: 'PyPi' + # Keeping it commented out as a workaround for: + # https://portal.microsofticm.com/imp/v3/incidents/incident/499972482/summary + # contentsource: 'folder' + folderlocation: '$(Build.ArtifactStagingDirectory)/esrp-build' + waitforreleasecompletion: true + owners: 'yurys@microsoft.com' + approvers: 'yurys@microsoft.com' + serviceendpointurl: 'https://api.esrp.microsoft.com' + mainpublisher: 'Playwright' + domaintenantid: '975f013f-7f24-47e8-a7d3-abc4752bf346' + displayName: 'ESRP Release to PIP' diff --git a/.claude/skills/playwright-roll/SKILL.md b/.claude/skills/playwright-roll/SKILL.md new file mode 100644 index 000000000..ece920353 --- /dev/null +++ b/.claude/skills/playwright-roll/SKILL.md @@ -0,0 +1,23 @@ +--- +name: playwright-roll +description: Roll Playwright Python to a new version +--- + +Help the user roll to a new version of Playwright. +../../../ROLLING.md contains general instructions and scripts. + +Start with updating the version and generating the API to see the state of things. + +Afterwards, work through the list of changes that need to be backported. +You can find a list of pull requests that might need to be taking into account in the issue titled "Backport changes". +Work through them one-by-one and check off the items that you have handled. +Not all of them will be relevant, some might have partially been reverted, etc. - so feel free to check with the upstream release branch. + +Rolling includes: +- updating client implementation to match changes in the upstream JS implementation (see ../playwright/packages/playwright-core/src/client) +- adding a couple of new tests to verify new/changed functionality + +## Tips & Tricks +- Project checkouts are in the parent directory (`../`). +- when updating checkboxes, store the issue content into /tmp and edit it there, then update the issue based on the file +- use the "gh" cli to interact with GitHub diff --git a/.github/dependabot.yml b/.github/dependabot.yml index 6a7695c06..33c127127 100644 --- a/.github/dependabot.yml +++ b/.github/dependabot.yml @@ -4,3 +4,11 @@ updates: directory: "/" schedule: interval: "weekly" + - package-ecosystem: "github-actions" + directory: "/" + schedule: + interval: "weekly" + groups: + actions: + patterns: + - "*" diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 55f66440c..65ba1f433 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -21,17 +21,18 @@ jobs: name: Lint runs-on: ubuntu-latest steps: - - uses: actions/checkout@v3 + - uses: actions/checkout@v5 - name: Set up Python - uses: actions/setup-python@v4 + uses: actions/setup-python@v6 with: python-version: "3.10" - name: Install dependencies & browsers run: | python -m pip install --upgrade pip pip install -r local-requirements.txt + pip install -r requirements.txt pip install -e . - python setup.py bdist_wheel + python -m build --wheel python -m playwright install --with-deps - name: Lint run: pre-commit run --show-diff-on-failure --color=always --all-files @@ -47,18 +48,9 @@ jobs: fail-fast: false matrix: os: [ubuntu-latest, windows-latest, macos-latest] - python-version: [3.8, 3.9] + python-version: ['3.9', '3.10'] browser: [chromium, firefox, webkit] include: - - os: ubuntu-latest - python-version: '3.10' - browser: chromium - - os: windows-latest - python-version: '3.10' - browser: chromium - - os: macos-latest - python-version: '3.10' - browser: chromium - os: windows-latest python-version: '3.11' browser: chromium @@ -77,19 +69,29 @@ jobs: - os: ubuntu-latest python-version: '3.12' browser: chromium + - os: windows-latest + python-version: '3.13' + browser: chromium + - os: macos-latest + python-version: '3.13' + browser: chromium + - os: ubuntu-latest + python-version: '3.13' + browser: chromium runs-on: ${{ matrix.os }} steps: - - uses: actions/checkout@v3 + - uses: actions/checkout@v5 - name: Set up Python - uses: actions/setup-python@v4 + uses: actions/setup-python@v6 with: python-version: ${{ matrix.python-version }} - name: Install dependencies & browsers run: | python -m pip install --upgrade pip pip install -r local-requirements.txt + pip install -r requirements.txt pip install -e . - python setup.py bdist_wheel + python -m build --wheel python -m playwright install --with-deps ${{ matrix.browser }} - name: Common Tests run: pytest tests/common --browser=${{ matrix.browser }} --timeout 90 @@ -125,17 +127,18 @@ jobs: browser-channel: msedge runs-on: ${{ matrix.os }} steps: - - uses: actions/checkout@v3 + - uses: actions/checkout@v5 - name: Set up Python - uses: actions/setup-python@v4 + uses: actions/setup-python@v6 with: python-version: "3.10" - name: Install dependencies & browsers run: | python -m pip install --upgrade pip pip install -r local-requirements.txt + pip install -r requirements.txt pip install -e . - python setup.py bdist_wheel + python -m build --wheel python -m playwright install ${{ matrix.browser-channel }} --with-deps - name: Common Tests run: pytest tests/common --browser=chromium --browser-channel=${{ matrix.browser-channel }} --timeout 90 @@ -157,10 +160,10 @@ jobs: strategy: fail-fast: false matrix: - os: [ubuntu-20.04, macos-13, windows-2019] + os: [ubuntu-22.04, macos-13, windows-2022] runs-on: ${{ matrix.os }} steps: - - uses: actions/checkout@v3 + - uses: actions/checkout@v5 with: fetch-depth: 0 - name: Get conda @@ -168,6 +171,7 @@ jobs: with: python-version: 3.9 channels: conda-forge + miniconda-version: latest - name: Prepare run: conda install conda-build conda-verify - name: Build @@ -180,9 +184,9 @@ jobs: run: working-directory: examples/todomvc/ steps: - - uses: actions/checkout@v3 + - uses: actions/checkout@v5 - name: Set up Python - uses: actions/setup-python@v4 + uses: actions/setup-python@v6 with: python-version: '3.10' - name: Install dependencies & browsers diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml index cae28da1a..c6e71028a 100644 --- a/.github/workflows/publish.yml +++ b/.github/workflows/publish.yml @@ -2,9 +2,11 @@ name: Upload Python Package on: release: types: [published] + workflow_dispatch: jobs: deploy-conda: strategy: + fail-fast: false matrix: include: - os: ubuntu-latest @@ -23,18 +25,17 @@ jobs: # Required for conda-incubator/setup-miniconda@v3 shell: bash -el {0} steps: - - uses: actions/checkout@v3 + - uses: actions/checkout@v5 with: fetch-depth: 0 - name: Get conda uses: conda-incubator/setup-miniconda@v3 with: - python-version: 3.12 + python-version: 3.9 channels: conda-forge miniconda-version: latest - name: Prepare - # Pinned because of https://github.com/conda/conda-build/issues/5267 - run: conda install anaconda-client conda-build=24.1.2 conda-verify py-lief=0.12.3 + run: conda install anaconda-client conda-build conda-verify - name: Build and Upload env: ANACONDA_API_TOKEN: ${{ secrets.ANACONDA_API_TOKEN }} @@ -43,7 +44,6 @@ jobs: if [ "${{ matrix.target-platform }}" == "osx-arm64" ]; then conda build --user microsoft . -m conda_build_config_osx_arm64.yaml elif [ "${{ matrix.target-platform }}" == "linux-aarch64" ]; then - conda install cross-python_linux-aarch64 conda build --user microsoft . -m conda_build_config_linux_aarch64.yaml else conda build --user microsoft . diff --git a/.github/workflows/publish_docker.yml b/.github/workflows/publish_docker.yml index d0db5543d..7494f1abc 100644 --- a/.github/workflows/publish_docker.yml +++ b/.github/workflows/publish_docker.yml @@ -15,7 +15,7 @@ jobs: contents: read # This is required for actions/checkout to succeed environment: Docker steps: - - uses: actions/checkout@v3 + - uses: actions/checkout@v5 - name: Azure login uses: azure/login@v2 with: @@ -25,16 +25,17 @@ jobs: - name: Login to ACR via OIDC run: az acr login --name playwright - name: Set up Python - uses: actions/setup-python@v4 + uses: actions/setup-python@v6 with: python-version: "3.10" - name: Set up Docker QEMU for arm64 docker builds - uses: docker/setup-qemu-action@v2 + uses: docker/setup-qemu-action@v3 with: platforms: arm64 - name: Install dependencies & browsers run: | python -m pip install --upgrade pip pip install -r local-requirements.txt + pip install -r requirements.txt pip install -e . - run: ./utils/docker/publish_docker.sh stable diff --git a/.github/workflows/test_docker.yml b/.github/workflows/test_docker.yml index 178200f75..464eb3b46 100644 --- a/.github/workflows/test_docker.yml +++ b/.github/workflows/test_docker.yml @@ -19,34 +19,40 @@ on: jobs: build: timeout-minutes: 120 - runs-on: ubuntu-24.04 + runs-on: ${{ matrix.runs-on }} strategy: fail-fast: false matrix: docker-image-variant: - - focal - jammy - noble + runs-on: + - ubuntu-24.04 + - ubuntu-24.04-arm steps: - - uses: actions/checkout@v3 + - uses: actions/checkout@v5 - name: Set up Python - uses: actions/setup-python@v4 + uses: actions/setup-python@v6 with: python-version: "3.10" - name: Install dependencies run: | python -m pip install --upgrade pip pip install -r local-requirements.txt + pip install -r requirements.txt pip install -e . - name: Build Docker image - run: bash utils/docker/build.sh --amd64 ${{ matrix.docker-image-variant }} playwright-python:localbuild-${{ matrix.docker-image-variant }} + run: | + ARCH="${{ matrix.runs-on == 'ubuntu-24.04-arm' && 'arm64' || 'amd64' }}" + bash utils/docker/build.sh --$ARCH ${{ matrix.docker-image-variant }} playwright-python:localbuild-${{ matrix.docker-image-variant }} - name: Test run: | - CONTAINER_ID="$(docker run --rm -v $(pwd):/root/playwright --name playwright-docker-test --workdir /root/playwright/ -d -t playwright-python:localbuild-${{ matrix.docker-image-variant }} /bin/bash)" + CONTAINER_ID="$(docker run --rm -e CI -v $(pwd):/root/playwright --name playwright-docker-test --workdir /root/playwright/ -d -t playwright-python:localbuild-${{ matrix.docker-image-variant }} /bin/bash)" # Fix permissions for Git inside the container docker exec "${CONTAINER_ID}" chown -R root:root /root/playwright docker exec "${CONTAINER_ID}" pip install -r local-requirements.txt + docker exec "${CONTAINER_ID}" pip install -r requirements.txt docker exec "${CONTAINER_ID}" pip install -e . - docker exec "${CONTAINER_ID}" python setup.py bdist_wheel - docker exec "${CONTAINER_ID}" xvfb-run pytest -vv tests/sync/ - docker exec "${CONTAINER_ID}" xvfb-run pytest -vv tests/async/ + docker exec "${CONTAINER_ID}" python -m build --wheel + docker exec "${CONTAINER_ID}" xvfb-run pytest tests/sync/ + docker exec "${CONTAINER_ID}" xvfb-run pytest tests/async/ diff --git a/.github/workflows/trigger_internal_tests.yml b/.github/workflows/trigger_internal_tests.yml deleted file mode 100644 index b4e6c21db..000000000 --- a/.github/workflows/trigger_internal_tests.yml +++ /dev/null @@ -1,21 +0,0 @@ -name: "Internal Tests" - -on: - push: - branches: - - main - - release-* - -jobs: - trigger: - name: "trigger" - runs-on: ubuntu-20.04 - steps: - - run: | - curl -X POST \ - -H "Accept: application/vnd.github.v3+json" \ - -H "Authorization: token ${GH_TOKEN}" \ - --data "{\"event_type\": \"playwright_tests_python\", \"client_payload\": {\"ref\": \"${GITHUB_SHA}\"}}" \ - https://api.github.com/repos/microsoft/playwright-browsers/dispatches - env: - GH_TOKEN: ${{ secrets.REPOSITORY_DISPATCH_PERSONAL_ACCESS_TOKEN }} diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 5198070e1..57fdca816 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -2,7 +2,7 @@ # See https://pre-commit.com/hooks.html for more hooks repos: - repo: https://github.com/pre-commit/pre-commit-hooks - rev: v4.5.0 + rev: v5.0.0 hooks: - id: trailing-whitespace - id: end-of-file-fixer @@ -15,20 +15,20 @@ repos: - id: check-executables-have-shebangs - id: check-merge-conflict - repo: https://github.com/psf/black - rev: 23.9.1 + rev: 25.1.0 hooks: - id: black - repo: https://github.com/pre-commit/mirrors-mypy - rev: v1.8.0 + rev: v1.17.0 hooks: - id: mypy - additional_dependencies: [types-pyOpenSSL==23.2.0.2, types-requests==2.31.0.10] + additional_dependencies: [types-pyOpenSSL==24.1.0.20240722, types-requests==2.32.4.20250611] - repo: https://github.com/pycqa/flake8 - rev: 6.1.0 + rev: 7.3.0 hooks: - id: flake8 - repo: https://github.com/pycqa/isort - rev: 5.13.2 + rev: 6.0.1 hooks: - id: isort - repo: local @@ -39,7 +39,7 @@ repos: language: node pass_filenames: false types: [python] - additional_dependencies: ["pyright@1.1.278"] + additional_dependencies: ["pyright@1.1.403"] - repo: local hooks: - id: check-license-header diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a5ab7d4bd..b59e281c8 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -23,9 +23,7 @@ Build and install drivers: ```sh pip install -e . -python setup.py bdist_wheel -# For all platforms -python setup.py bdist_wheel --all +python -m build --wheel ``` Run tests: @@ -47,7 +45,7 @@ pre-commit install pre-commit run --all-files ``` -For more details look at the [CI configuration](./blob/main/.github/workflows/ci.yml). +For more details look at the [CI configuration](./.github/workflows/ci.yml). Collect coverage diff --git a/README.md b/README.md index d94692919..c5e2d70b0 100644 --- a/README.md +++ b/README.md @@ -4,9 +4,9 @@ Playwright is a Python library to automate [Chromium](https://www.chromium.org/H | | Linux | macOS | Windows | | :--- | :---: | :---: | :---: | -| Chromium 129.0.6668.29 | ✅ | ✅ | ✅ | -| WebKit 18.0 | ✅ | ✅ | ✅ | -| Firefox 130.0 | ✅ | ✅ | ✅ | +| Chromium 145.0.7632.6 | ✅ | ✅ | ✅ | +| WebKit 26.0 | ✅ | ✅ | ✅ | +| Firefox 146.0.1 | ✅ | ✅ | ✅ | ## Documentation diff --git a/ROLLING.md b/ROLLING.md index 2d35ee1e7..811d7fcb3 100644 --- a/ROLLING.md +++ b/ROLLING.md @@ -5,12 +5,14 @@ * create virtual environment, if don't have one: `python -m venv env` * activate venv: `source env/bin/activate` * install all deps: - - `python -m pip install --upgrade pip` - - `pip install -r local-requirements.txt` - - `pre-commit install` - - `pip install -e .` +``` +python -m pip install --upgrade pip +pip install -r local-requirements.txt +pre-commit install +pip install -e . +``` * change driver version in `setup.py` -* download new driver: `python setup.py bdist_wheel` +* download new driver: `python -m build --wheel` * generate API: `./scripts/update_api.sh` * commit changes & send PR * wait for bots to pass & merge the PR diff --git a/examples/todomvc/requirements.txt b/examples/todomvc/requirements.txt index eb6fcbbd0..801cd515b 100644 --- a/examples/todomvc/requirements.txt +++ b/examples/todomvc/requirements.txt @@ -1 +1 @@ -pytest-playwright==0.3.0 +pytest-playwright diff --git a/local-requirements.txt b/local-requirements.txt index 6e5fd056f..8a72b5745 100644 --- a/local-requirements.txt +++ b/local-requirements.txt @@ -1,24 +1,22 @@ -auditwheel==6.1.0 autobahn==23.1.2 -black==24.8.0 -flake8==7.1.1 -flaky==3.8.1 -mypy==1.11.2 -objgraph==3.6.1 -Pillow==10.4.0 +black==25.1.0 +build==1.3.0 +flake8==7.2.0 +mypy==1.17.1 +objgraph==3.6.2 +Pillow==11.3.0 pixelmatch==0.3.0 -pre-commit==3.4.0 -pyOpenSSL==24.2.1 -pytest==8.3.2 -pytest-asyncio==0.21.2 -pytest-cov==5.0.0 -pytest-repeat==0.9.3 -pytest-timeout==2.3.1 -pytest-xdist==3.6.1 -requests==2.32.3 -service_identity==24.1.0 -setuptools==74.0.0 -twisted==24.7.0 +pre-commit==3.5.0 +pyOpenSSL==25.1.0 +pytest==8.4.1 +pytest-asyncio==1.1.0 +pytest-cov==6.3.0 +pytest-repeat==0.9.4 +pytest-rerunfailures==15.1 +pytest-timeout==2.4.0 +pytest-xdist==3.8.0 +requests==2.32.5 +service_identity==24.2.0 +twisted==25.5.0 types-pyOpenSSL==24.1.0.20240722 -types-requests==2.32.0.20240712 -wheel==0.42.0 +types-requests==2.32.4.20250809 diff --git a/meta.yaml b/meta.yaml index 4b416db9c..343f9b568 100644 --- a/meta.yaml +++ b/meta.yaml @@ -15,21 +15,25 @@ build: requirements: build: - - python >=3.8 # [build_platform != target_platform] + - python >=3.9 # [build_platform != target_platform] - pip # [build_platform != target_platform] - cross-python_{{ target_platform }} # [build_platform != target_platform] host: - - python >=3.8 + - python >=3.9 - wheel - pip - curl - setuptools_scm run: - - python >=3.8 - - greenlet ==3.0.3 - - pyee ==12.0.0 + - python >=3.9 + # This should be the same as the dependencies in pyproject.toml + - greenlet>=3.1.1,<4.0.0 + - pyee>=13,<14 test: # [build_platform == target_platform] + files: + - scripts/example_sync.py + - scripts/example_async.py requires: - pip imports: @@ -38,6 +42,9 @@ test: # [build_platform == target_platform] - playwright.async_api commands: - playwright --help + - playwright install --with-deps + - python scripts/example_sync.py + - python scripts/example_async.py about: home: https://github.com/microsoft/playwright-python diff --git a/playwright/_impl/_accessibility.py b/playwright/_impl/_accessibility.py deleted file mode 100644 index 010b4e8c5..000000000 --- a/playwright/_impl/_accessibility.py +++ /dev/null @@ -1,69 +0,0 @@ -# Copyright (c) Microsoft Corporation. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - -from typing import Dict, Optional - -from playwright._impl._connection import Channel -from playwright._impl._element_handle import ElementHandle -from playwright._impl._helper import locals_to_params - - -def _ax_node_from_protocol(axNode: Dict) -> Dict: - result = {**axNode} - if "valueNumber" in axNode: - result["value"] = axNode["valueNumber"] - elif "valueString" in axNode: - result["value"] = axNode["valueString"] - - if "checked" in axNode: - result["checked"] = ( - True - if axNode.get("checked") == "checked" - else ( - False if axNode.get("checked") == "unchecked" else axNode.get("checked") - ) - ) - - if "pressed" in axNode: - result["pressed"] = ( - True - if axNode.get("pressed") == "pressed" - else ( - False if axNode.get("pressed") == "released" else axNode.get("pressed") - ) - ) - - if axNode.get("children"): - result["children"] = list(map(_ax_node_from_protocol, axNode["children"])) - if "valueNumber" in result: - del result["valueNumber"] - if "valueString" in result: - del result["valueString"] - return result - - -class Accessibility: - def __init__(self, channel: Channel) -> None: - self._channel = channel - self._loop = channel._connection._loop - self._dispatcher_fiber = channel._connection._dispatcher_fiber - - async def snapshot( - self, interestingOnly: bool = None, root: ElementHandle = None - ) -> Optional[Dict]: - params = locals_to_params(locals()) - if root: - params["root"] = root._channel - result = await self._channel.send("accessibilitySnapshot", params) - return _ax_node_from_protocol(result) if result else None diff --git a/playwright/_impl/_api_structures.py b/playwright/_impl/_api_structures.py index 904a590a9..c0d0ee442 100644 --- a/playwright/_impl/_api_structures.py +++ b/playwright/_impl/_api_structures.py @@ -32,6 +32,18 @@ class Cookie(TypedDict, total=False): httpOnly: bool secure: bool sameSite: Literal["Lax", "None", "Strict"] + partitionKey: Optional[str] + + +class StorageStateCookie(TypedDict, total=False): + name: str + value: str + domain: str + path: str + expires: float + httpOnly: bool + secure: bool + sameSite: Literal["Lax", "None", "Strict"] # TODO: We are waiting for PEP705 so SetCookieParam can be readonly and matches Cookie. @@ -45,6 +57,7 @@ class SetCookieParam(TypedDict, total=False): httpOnly: Optional[bool] secure: Optional[bool] sameSite: Optional[Literal["Lax", "None", "Strict"]] + partitionKey: Optional[str] class FloatRect(TypedDict): @@ -97,7 +110,7 @@ class ProxySettings(TypedDict, total=False): class StorageState(TypedDict, total=False): - cookies: List[Cookie] + cookies: List[StorageStateCookie] origins: List[OriginState] @@ -205,6 +218,7 @@ class FrameExpectResult(TypedDict): matches: bool received: Any log: List[str] + errorMessage: Optional[str] AriaRole = Literal[ @@ -291,3 +305,9 @@ class FrameExpectResult(TypedDict): "treegrid", "treeitem", ] + + +class TracingGroupLocation(TypedDict): + file: str + line: Optional[int] + column: Optional[int] diff --git a/playwright/_impl/_artifact.py b/playwright/_impl/_artifact.py index d619c35e2..a08294cbe 100644 --- a/playwright/_impl/_artifact.py +++ b/playwright/_impl/_artifact.py @@ -33,27 +33,55 @@ async def path_after_finished(self) -> pathlib.Path: raise Error( "Path is not available when using browser_type.connect(). Use save_as() to save a local copy." ) - path = await self._channel.send("pathAfterFinished") + path = await self._channel.send( + "pathAfterFinished", + None, + ) return pathlib.Path(path) async def save_as(self, path: Union[str, Path]) -> None: - stream = cast(Stream, from_channel(await self._channel.send("saveAsStream"))) + stream = cast( + Stream, + from_channel( + await self._channel.send( + "saveAsStream", + None, + ) + ), + ) make_dirs_for_file(path) await stream.save_as(path) async def failure(self) -> Optional[str]: - reason = await self._channel.send("failure") + reason = await self._channel.send( + "failure", + None, + ) if reason is None: return None return patch_error_message(reason) async def delete(self) -> None: - await self._channel.send("delete") + await self._channel.send( + "delete", + None, + ) async def read_info_buffer(self) -> bytes: - stream = cast(Stream, from_channel(await self._channel.send("stream"))) + stream = cast( + Stream, + from_channel( + await self._channel.send( + "stream", + None, + ) + ), + ) buffer = await stream.read_all() return buffer - async def cancel(self) -> None: - await self._channel.send("cancel") + async def cancel(self) -> None: # pyright: ignore[reportIncompatibleMethodOverride] + await self._channel.send( + "cancel", + None, + ) diff --git a/playwright/_impl/_assertions.py b/playwright/_impl/_assertions.py index 5841eca5a..aea37d35c 100644 --- a/playwright/_impl/_assertions.py +++ b/playwright/_impl/_assertions.py @@ -20,6 +20,7 @@ AriaRole, ExpectedTextValue, FrameExpectOptions, + FrameExpectResult, ) from playwright._impl._connection import format_call_log from playwright._impl._errors import Error @@ -45,12 +46,20 @@ def __init__( self._is_not = is_not self._custom_message = message + async def _call_expect( + self, expression: str, expect_options: FrameExpectOptions, title: Optional[str] + ) -> FrameExpectResult: + raise NotImplementedError( + "_call_expect must be implemented in a derived class." + ) + async def _expect_impl( self, expression: str, expect_options: FrameExpectOptions, expected: Any, message: str, + title: str = None, ) -> None: __tracebackhide__ = True expect_options["isNot"] = self._is_not @@ -60,7 +69,7 @@ async def _expect_impl( message = message.replace("expected to", "expected not to") if "useInnerText" in expect_options and expect_options["useInnerText"] is None: del expect_options["useInnerText"] - result = await self._actual_locator._expect(expression, expect_options) + result = await self._call_expect(expression, expect_options, title) if result["matches"] == self._is_not: actual = result.get("received") if self._custom_message: @@ -71,8 +80,10 @@ async def _expect_impl( out_message = ( f"{message} '{expected}'" if expected is not None else f"{message}" ) + error_message = result.get("errorMessage") + error_message = f"\n{error_message}" if error_message else "" raise AssertionError( - f"{out_message}\nActual value: {actual} {format_call_log(result.get('log'))}" + f"{out_message}\nActual value: {actual}{error_message} {format_call_log(result.get('log'))}" ) @@ -87,6 +98,14 @@ def __init__( super().__init__(page.locator(":root"), timeout, is_not, message) self._actual_page = page + async def _call_expect( + self, expression: str, expect_options: FrameExpectOptions, title: Optional[str] + ) -> FrameExpectResult: + __tracebackhide__ = True + return await self._actual_page.main_frame._expect( + None, expression, expect_options, title + ) + @property def _not(self) -> "PageAssertions": return PageAssertions( @@ -105,6 +124,7 @@ async def to_have_title( FrameExpectOptions(expectedText=expected_values, timeout=timeout), titleOrRegExp, "Page title expected to be", + 'Expect "to_have_title"', ) async def not_to_have_title( @@ -120,7 +140,7 @@ async def to_have_url( ignoreCase: bool = None, ) -> None: __tracebackhide__ = True - base_url = self._actual_page.context._options.get("baseURL") + base_url = self._actual_page.context._base_url if isinstance(urlOrRegExp, str) and base_url: urlOrRegExp = urljoin(base_url, urlOrRegExp) expected_text = to_expected_text_values([urlOrRegExp], ignoreCase=ignoreCase) @@ -129,6 +149,7 @@ async def to_have_url( FrameExpectOptions(expectedText=expected_text, timeout=timeout), urlOrRegExp, "Page URL expected to be", + 'Expect "to_have_url"', ) async def not_to_have_url( @@ -152,6 +173,12 @@ def __init__( super().__init__(locator, timeout, is_not, message) self._actual_locator = locator + async def _call_expect( + self, expression: str, expect_options: FrameExpectOptions, title: Optional[str] + ) -> FrameExpectResult: + __tracebackhide__ = True + return await self._actual_locator._expect(expression, expect_options, title) + @property def _not(self) -> "LocatorAssertions": return LocatorAssertions( @@ -190,6 +217,7 @@ async def to_contain_text( ), expected, "Locator expected to contain text", + 'Expect "to_contain_text"', ) else: expected_text = to_expected_text_values( @@ -207,6 +235,7 @@ async def to_contain_text( ), expected, "Locator expected to contain text", + 'Expect "to_contain_text"', ) async def not_to_contain_text( @@ -241,6 +270,7 @@ async def to_have_attribute( ), value, "Locator expected to have attribute", + 'Expect "to_have_attribute"', ) async def not_to_have_attribute( @@ -276,6 +306,7 @@ async def to_have_class( FrameExpectOptions(expectedText=expected_text, timeout=timeout), expected, "Locator expected to have class", + 'Expect "to_have_class"', ) else: expected_text = to_expected_text_values([expected]) @@ -284,6 +315,7 @@ async def to_have_class( FrameExpectOptions(expectedText=expected_text, timeout=timeout), expected, "Locator expected to have class", + 'Expect "to_have_class"', ) async def not_to_have_class( @@ -300,6 +332,47 @@ async def not_to_have_class( __tracebackhide__ = True await self._not.to_have_class(expected, timeout) + async def to_contain_class( + self, + expected: Union[ + Sequence[str], + str, + ], + timeout: float = None, + ) -> None: + __tracebackhide__ = True + if isinstance(expected, collections.abc.Sequence) and not isinstance( + expected, str + ): + expected_text = to_expected_text_values(expected) + await self._expect_impl( + "to.contain.class.array", + FrameExpectOptions(expectedText=expected_text, timeout=timeout), + expected, + "Locator expected to contain class names", + 'Expect "to_contain_class"', + ) + else: + expected_text = to_expected_text_values([expected]) + await self._expect_impl( + "to.contain.class", + FrameExpectOptions(expectedText=expected_text, timeout=timeout), + expected, + "Locator expected to contain class", + 'Expect "to_contain_class"', + ) + + async def not_to_contain_class( + self, + expected: Union[ + Sequence[str], + str, + ], + timeout: float = None, + ) -> None: + __tracebackhide__ = True + await self._not.to_contain_class(expected, timeout) + async def to_have_count( self, count: int, @@ -311,6 +384,7 @@ async def to_have_count( FrameExpectOptions(expectedNumber=count, timeout=timeout), count, "Locator expected to have count", + 'Expect "to_have_count"', ) async def not_to_have_count( @@ -336,6 +410,7 @@ async def to_have_css( ), value, "Locator expected to have CSS", + 'Expect "to_have_css"', ) async def not_to_have_css( @@ -359,6 +434,7 @@ async def to_have_id( FrameExpectOptions(expectedText=expected_text, timeout=timeout), id, "Locator expected to have ID", + 'Expect "to_have_id"', ) async def not_to_have_id( @@ -383,6 +459,7 @@ async def to_have_js_property( ), value, "Locator expected to have JS Property", + 'Expect "to_have_property"', ) async def not_to_have_js_property( @@ -406,6 +483,7 @@ async def to_have_value( FrameExpectOptions(expectedText=expected_text, timeout=timeout), value, "Locator expected to have Value", + 'Expect "to_have_value"', ) async def not_to_have_value( @@ -430,6 +508,7 @@ async def to_have_values( FrameExpectOptions(expectedText=expected_text, timeout=timeout), values, "Locator expected to have Values", + 'Expect "to_have_values"', ) async def not_to_have_values( @@ -473,6 +552,7 @@ async def to_have_text( ), expected, "Locator expected to have text", + 'Expect "to_have_text"', ) else: expected_text = to_expected_text_values( @@ -487,6 +567,7 @@ async def to_have_text( ), expected, "Locator expected to have text", + 'Expect "to_have_text"', ) async def not_to_have_text( @@ -511,28 +592,40 @@ async def to_be_attached( timeout: float = None, ) -> None: __tracebackhide__ = True + if attached is None: + attached = True + attached_string = "attached" if attached else "detached" await self._expect_impl( - "to.be.attached" - if (attached is None or attached is True) - else "to.be.detached", + ("to.be.attached" if attached else "to.be.detached"), FrameExpectOptions(timeout=timeout), None, - "Locator expected to be attached", + f"Locator expected to be {attached_string}", + 'Expect "to_be_attached"', ) async def to_be_checked( self, timeout: float = None, checked: bool = None, + indeterminate: bool = None, ) -> None: __tracebackhide__ = True + expected_value = {} + if indeterminate is not None: + expected_value["indeterminate"] = indeterminate + if checked is not None: + expected_value["checked"] = checked + checked_string: str + if indeterminate: + checked_string = "indeterminate" + else: + checked_string = "unchecked" if checked is False else "checked" await self._expect_impl( - "to.be.checked" - if checked is None or checked is True - else "to.be.unchecked", - FrameExpectOptions(timeout=timeout), + "to.be.checked", + FrameExpectOptions(timeout=timeout, expectedValue=expected_value), None, - "Locator expected to be checked", + f"Locator expected to be {checked_string}", + 'Expect "to_be_checked"', ) async def not_to_be_attached( @@ -560,6 +653,7 @@ async def to_be_disabled( FrameExpectOptions(timeout=timeout), None, "Locator expected to be disabled", + 'Expect "to_be_disabled"', ) async def not_to_be_disabled( @@ -577,11 +671,13 @@ async def to_be_editable( __tracebackhide__ = True if editable is None: editable = True + editable_string = "editable" if editable else "readonly" await self._expect_impl( "to.be.editable" if editable else "to.be.readonly", FrameExpectOptions(timeout=timeout), None, - "Locator expected to be editable", + f"Locator expected to be {editable_string}", + 'Expect "to_be_editable"', ) async def not_to_be_editable( @@ -602,6 +698,7 @@ async def to_be_empty( FrameExpectOptions(timeout=timeout), None, "Locator expected to be empty", + 'Expect "to_be_empty"', ) async def not_to_be_empty( @@ -619,11 +716,13 @@ async def to_be_enabled( __tracebackhide__ = True if enabled is None: enabled = True + enabled_string = "enabled" if enabled else "disabled" await self._expect_impl( "to.be.enabled" if enabled else "to.be.disabled", FrameExpectOptions(timeout=timeout), None, - "Locator expected to be enabled", + f"Locator expected to be {enabled_string}", + 'Expect "to_be_enabled"', ) async def not_to_be_enabled( @@ -644,6 +743,7 @@ async def to_be_hidden( FrameExpectOptions(timeout=timeout), None, "Locator expected to be hidden", + 'Expect "to_be_hidden"', ) async def not_to_be_hidden( @@ -661,11 +761,13 @@ async def to_be_visible( __tracebackhide__ = True if visible is None: visible = True + visible_string = "visible" if visible else "hidden" await self._expect_impl( "to.be.visible" if visible else "to.be.hidden", FrameExpectOptions(timeout=timeout), None, - "Locator expected to be visible", + f"Locator expected to be {visible_string}", + 'Expect "to_be_visible"', ) async def not_to_be_visible( @@ -686,6 +788,7 @@ async def to_be_focused( FrameExpectOptions(timeout=timeout), None, "Locator expected to be focused", + 'Expect "to_be_focused"', ) async def not_to_be_focused( @@ -706,6 +809,7 @@ async def to_be_in_viewport( FrameExpectOptions(timeout=timeout, expectedNumber=ratio), None, "Locator expected to be in viewport", + 'Expect "to_be_in_viewport"', ) async def not_to_be_in_viewport( @@ -721,12 +825,15 @@ async def to_have_accessible_description( timeout: float = None, ) -> None: __tracebackhide__ = True - expected_values = to_expected_text_values([description], ignoreCase=ignoreCase) + expected_values = to_expected_text_values( + [description], ignoreCase=ignoreCase, normalize_white_space=True + ) await self._expect_impl( "to.have.accessible.description", FrameExpectOptions(expectedText=expected_values, timeout=timeout), None, "Locator expected to have accessible description", + 'Expect "to_have_accessible_description"', ) async def not_to_have_accessible_description( @@ -745,12 +852,15 @@ async def to_have_accessible_name( timeout: float = None, ) -> None: __tracebackhide__ = True - expected_values = to_expected_text_values([name], ignoreCase=ignoreCase) + expected_values = to_expected_text_values( + [name], ignoreCase=ignoreCase, normalize_white_space=True + ) await self._expect_impl( "to.have.accessible.name", FrameExpectOptions(expectedText=expected_values, timeout=timeout), None, "Locator expected to have accessible name", + 'Expect "to_have_accessible_name"', ) async def not_to_have_accessible_name( @@ -772,12 +882,60 @@ async def to_have_role(self, role: AriaRole, timeout: float = None) -> None: FrameExpectOptions(expectedText=expected_values, timeout=timeout), None, "Locator expected to have accessible role", + 'Expect "to_have_role"', + ) + + async def to_have_accessible_error_message( + self, + errorMessage: Union[str, Pattern[str]], + ignoreCase: bool = None, + timeout: float = None, + ) -> None: + __tracebackhide__ = True + expected_values = to_expected_text_values( + [errorMessage], ignoreCase=ignoreCase, normalize_white_space=True + ) + await self._expect_impl( + "to.have.accessible.error.message", + FrameExpectOptions(expectedText=expected_values, timeout=timeout), + None, + "Locator expected to have accessible error message", + 'Expect "to_have_accessible_error_message"', + ) + + async def not_to_have_accessible_error_message( + self, + errorMessage: Union[str, Pattern[str]], + ignoreCase: bool = None, + timeout: float = None, + ) -> None: + __tracebackhide__ = True + await self._not.to_have_accessible_error_message( + errorMessage=errorMessage, ignoreCase=ignoreCase, timeout=timeout ) async def not_to_have_role(self, role: AriaRole, timeout: float = None) -> None: __tracebackhide__ = True await self._not.to_have_role(role, timeout) + async def to_match_aria_snapshot( + self, expected: str, timeout: float = None + ) -> None: + __tracebackhide__ = True + await self._expect_impl( + "to.match.aria", + FrameExpectOptions(expectedValue=expected, timeout=timeout), + expected, + "Locator expected to match Aria snapshot", + 'Expect "to_match_aria_snapshot"', + ) + + async def not_to_match_aria_snapshot( + self, expected: str, timeout: float = None + ) -> None: + __tracebackhide__ = True + await self._not.to_match_aria_snapshot(expected, timeout) + class APIResponseAssertions: def __init__( @@ -852,7 +1010,7 @@ def to_expected_text_values( ignoreCase: Optional[bool] = None, ) -> Sequence[ExpectedTextValue]: out: List[ExpectedTextValue] = [] - assert isinstance(items, list) + assert isinstance(items, (list, tuple)) for item in items: if isinstance(item, str): o = ExpectedTextValue( diff --git a/playwright/_impl/_async_base.py b/playwright/_impl/_async_base.py index e9544b733..db7e5d005 100644 --- a/playwright/_impl/_async_base.py +++ b/playwright/_impl/_async_base.py @@ -15,7 +15,7 @@ import asyncio from contextlib import AbstractAsyncContextManager from types import TracebackType -from typing import Any, Callable, Generic, Optional, Type, TypeVar +from typing import Any, Callable, Generic, Optional, Type, TypeVar, Union from playwright._impl._impl_to_api_mapping import ImplToApiMapping, ImplWrapper @@ -68,7 +68,9 @@ def __init__(self, impl_obj: Any) -> None: def __str__(self) -> str: return self._impl_obj.__str__() - def _wrap_handler(self, handler: Any) -> Callable[..., None]: + def _wrap_handler( + self, handler: Union[Callable[..., Any], Any] + ) -> Callable[..., None]: if callable(handler): return mapping.wrap_handler(handler) return handler @@ -94,11 +96,10 @@ async def __aenter__(self: Self) -> Self: async def __aexit__( self, - exc_type: Type[BaseException], - exc_val: BaseException, - traceback: TracebackType, + exc_type: Optional[Type[BaseException]], + exc_val: Optional[BaseException], + traceback: Optional[TracebackType], ) -> None: await self.close() - async def close(self) -> None: - ... + async def close(self) -> None: ... diff --git a/playwright/_impl/_browser.py b/playwright/_impl/_browser.py index c5a9022a3..5a9a87450 100644 --- a/playwright/_impl/_browser.py +++ b/playwright/_impl/_browser.py @@ -12,10 +12,19 @@ # See the License for the specific language governing permissions and # limitations under the License. -import json from pathlib import Path from types import SimpleNamespace -from typing import TYPE_CHECKING, Dict, List, Optional, Pattern, Sequence, Union, cast +from typing import ( + TYPE_CHECKING, + Dict, + List, + Optional, + Pattern, + Sequence, + Set, + Union, + cast, +) from playwright._impl._api_structures import ( ClientCertificate, @@ -32,17 +41,15 @@ from playwright._impl._errors import is_target_closed_error from playwright._impl._helper import ( ColorScheme, + Contrast, ForcedColors, HarContentPolicy, HarMode, ReducedMotion, ServiceWorkersPolicy, - async_readfile, locals_to_params, make_dirs_for_file, - prepare_record_har_options, ) -from playwright._impl._network import serialize_headers, to_client_certificates_protocol from playwright._impl._page import Page if TYPE_CHECKING: # pragma: no cover @@ -58,28 +65,61 @@ def __init__( self, parent: "BrowserType", type: str, guid: str, initializer: Dict ) -> None: super().__init__(parent, type, guid, initializer) - self._browser_type = parent + self._browser_type: Optional["BrowserType"] = None self._is_connected = True self._should_close_connection_on_close = False self._cr_tracing_path: Optional[str] = None - self._contexts: List[BrowserContext] = [] + self._contexts: Set[BrowserContext] = set() + self._traces_dir: Optional[str] = None + self._channel.on( + "context", + lambda params: self._did_create_context( + cast(BrowserContext, from_channel(params["context"])) + ), + ) self._channel.on("close", lambda _: self._on_close()) self._close_reason: Optional[str] = None def __repr__(self) -> str: return f"" + def _connect_to_browser_type( + self, + browser_type: "BrowserType", + traces_dir: Optional[str] = None, + ) -> None: + # Note: when using connect(), `browserType` is different from `this.parent`. + # This is why browser type is not wired up in the constructor, and instead this separate method is called later on. + self._browser_type = browser_type + self._traces_dir = traces_dir + for context in self._contexts: + self._setup_browser_context(context) + + def _did_create_context(self, context: BrowserContext) -> None: + context._browser = self + self._contexts.add(context) + # Note: when connecting to a browser, initial contexts arrive before `_browserType` is set, + # and will be configured later in `ConnectToBrowserType`. + if self._browser_type: + self._setup_browser_context(context) + + def _setup_browser_context(self, context: BrowserContext) -> None: + context._tracing._traces_dir = self._traces_dir + assert self._browser_type is not None + self._browser_type._playwright.selectors._contexts_for_selectors.add(context) + def _on_close(self) -> None: self._is_connected = False self.emit(Browser.Events.Disconnected, self) @property def contexts(self) -> List[BrowserContext]: - return self._contexts.copy() + return list(self._contexts) @property def browser_type(self) -> "BrowserType": + assert self._browser_type is not None return self._browser_type def is_connected(self) -> bool: @@ -107,6 +147,7 @@ async def new_context( colorScheme: ColorScheme = None, reducedMotion: ReducedMotion = None, forcedColors: ForcedColors = None, + contrast: Contrast = None, acceptDownloads: bool = None, defaultBrowserType: str = None, proxy: ProxySettings = None, @@ -124,11 +165,18 @@ async def new_context( clientCertificates: List[ClientCertificate] = None, ) -> BrowserContext: params = locals_to_params(locals()) - await prepare_browser_context_params(params) + assert self._browser_type is not None + await self._browser_type._prepare_browser_context_params(params) - channel = await self._channel.send("newContext", params) + channel = await self._channel.send("newContext", None, params) context = cast(BrowserContext, from_channel(channel)) - self._browser_type._did_create_context(context, params, {}) + await context._initialize_har_from_options( + record_har_content=recordHarContent, + record_har_mode=recordHarMode, + record_har_omit_content=recordHarOmitContent, + record_har_path=recordHarPath, + record_har_url_filter=recordHarUrlFilter, + ) return context async def new_page( @@ -152,6 +200,7 @@ async def new_page( hasTouch: bool = None, colorScheme: ColorScheme = None, forcedColors: ForcedColors = None, + contrast: Contrast = None, reducedMotion: ReducedMotion = None, acceptDownloads: bool = None, defaultBrowserType: str = None, @@ -178,7 +227,7 @@ async def inner() -> Page: context._owner_page = page return page - return await self._connection.wrap_api_call(inner) + return await self._connection.wrap_api_call(inner, title="Create page") async def close(self, reason: str = None) -> None: self._close_reason = reason @@ -186,7 +235,7 @@ async def close(self, reason: str = None) -> None: if self._should_close_connection_on_close: await self._connection.stop_async() else: - await self._channel.send("close", {"reason": reason}) + await self._channel.send("close", None, {"reason": reason}) except Exception as e: if not is_target_closed_error(e): raise e @@ -196,7 +245,7 @@ def version(self) -> str: return self._initializer["version"] async def new_browser_cdp_session(self) -> CDPSession: - return from_channel(await self._channel.send("newBrowserCDPSession")) + return from_channel(await self._channel.send("newBrowserCDPSession", None)) async def start_tracing( self, @@ -211,10 +260,12 @@ async def start_tracing( if path: self._cr_tracing_path = str(path) params["path"] = str(path) - await self._channel.send("startTracing", params) + await self._channel.send("startTracing", None, params) async def stop_tracing(self) -> bytes: - artifact = cast(Artifact, from_channel(await self._channel.send("stopTracing"))) + artifact = cast( + Artifact, from_channel(await self._channel.send("stopTracing", None)) + ) buffer = await artifact.read_info_buffer() await artifact.delete() if self._cr_tracing_path: @@ -223,41 +274,3 @@ async def stop_tracing(self) -> bytes: f.write(buffer) self._cr_tracing_path = None return buffer - - -async def prepare_browser_context_params(params: Dict) -> None: - if params.get("noViewport"): - del params["noViewport"] - params["noDefaultViewport"] = True - if "defaultBrowserType" in params: - del params["defaultBrowserType"] - if "extraHTTPHeaders" in params: - params["extraHTTPHeaders"] = serialize_headers(params["extraHTTPHeaders"]) - if "recordHarPath" in params: - params["recordHar"] = prepare_record_har_options(params) - del params["recordHarPath"] - if "recordVideoDir" in params: - params["recordVideo"] = {"dir": Path(params["recordVideoDir"]).absolute()} - if "recordVideoSize" in params: - params["recordVideo"]["size"] = params["recordVideoSize"] - del params["recordVideoSize"] - del params["recordVideoDir"] - if "storageState" in params: - storageState = params["storageState"] - if not isinstance(storageState, dict): - params["storageState"] = json.loads( - (await async_readfile(storageState)).decode() - ) - if params.get("colorScheme", None) == "null": - params["colorScheme"] = "no-override" - if params.get("reducedMotion", None) == "null": - params["reducedMotion"] = "no-override" - if params.get("forcedColors", None) == "null": - params["forcedColors"] = "no-override" - if "acceptDownloads" in params: - params["acceptDownloads"] = "accept" if params["acceptDownloads"] else "deny" - - if "clientCertificates" in params: - params["clientCertificates"] = await to_client_certificates_protocol( - params["clientCertificates"] - ) diff --git a/playwright/_impl/_browser_context.py b/playwright/_impl/_browser_context.py index 455bf3410..e27a9437a 100644 --- a/playwright/_impl/_browser_context.py +++ b/playwright/_impl/_browser_context.py @@ -61,15 +61,21 @@ RouteHandlerCallback, TimeoutSettings, URLMatch, - URLMatcher, + WebSocketRouteHandlerCallback, async_readfile, async_writefile, locals_to_params, parse_error, - prepare_record_har_options, to_impl, ) -from playwright._impl._network import Request, Response, Route, serialize_headers +from playwright._impl._network import ( + Request, + Response, + Route, + WebSocketRoute, + WebSocketRouteHandler, + serialize_headers, +) from playwright._impl._page import BindingCall, Page, Worker from playwright._impl._str_utils import escape_regex_flags from playwright._impl._tracing import Tracing @@ -82,6 +88,7 @@ class BrowserContext(ChannelOwner): Events = SimpleNamespace( + # Deprecated in v1.56, never emitted anymore. BackgroundPage="backgroundpage", Close="close", Console="console", @@ -99,22 +106,25 @@ def __init__( self, parent: ChannelOwner, type: str, guid: str, initializer: Dict ) -> None: super().__init__(parent, type, guid, initializer) + # Browser is null for browser contexts created outside of normal browser, e.g. android or electron. # circular import workaround: self._browser: Optional["Browser"] = None if parent.__class__.__name__ == "Browser": self._browser = cast("Browser", parent) - self._browser._contexts.append(self) self._pages: List[Page] = [] self._routes: List[RouteHandler] = [] + self._web_socket_routes: List[WebSocketRouteHandler] = [] self._bindings: Dict[str, Any] = {} self._timeout_settings = TimeoutSettings(None) self._owner_page: Optional[Page] = None - self._options: Dict[str, Any] = {} - self._background_pages: Set[Page] = set() + self._options: Dict[str, Any] = initializer["options"] self._service_workers: Set[Worker] = set() + self._base_url: Optional[str] = self._options.get("baseURL") + self._videos_dir: Optional[str] = self._options.get("recordVideo") self._tracing = cast(Tracing, from_channel(initializer["tracing"])) self._har_recorders: Dict[str, HarRecordingMetadata] = {} self._request: APIRequestContext = from_channel(initializer["requestContext"]) + self._request._timeout_settings = self._timeout_settings self._clock = Clock(self) self._channel.on( "bindingCall", @@ -132,10 +142,13 @@ def __init__( ) ), ) - self._channel.on( - "backgroundPage", - lambda params: self._on_background_page(from_channel(params["page"])), + "webSocketRoute", + lambda params: self._loop.create_task( + self._on_web_socket_route( + from_channel(params["webSocketRoute"]), + ) + ), ) self._channel.on( @@ -205,7 +218,7 @@ def __init__( BrowserContext.Events.RequestFailed: "requestFailed", } ) - self._close_was_called = False + self._closing_or_closed = False def __repr__(self) -> str: return f"" @@ -222,7 +235,7 @@ async def _on_route(self, route: Route) -> None: route_handlers = self._routes.copy() for route_handler in route_handlers: # If the page or the context was closed we stall all requests right away. - if (page and page._close_was_called) or self._close_was_called: + if (page and page._close_was_called) or self._closing_or_closed: return if not route_handler.matches(route.request.url): continue @@ -244,10 +257,24 @@ async def _on_route(self, route: Route) -> None: try: # If the page is closed or unrouteAll() was called without waiting and interception disabled, # the method will throw an error - silence it. - await route._internal_continue(is_internal=True) + await route._inner_continue(True) except Exception: pass + async def _on_web_socket_route(self, web_socket_route: WebSocketRoute) -> None: + route_handler = next( + ( + route_handler + for route_handler in self._web_socket_routes + if route_handler.matches(web_socket_route.url) + ), + None, + ) + if route_handler: + await route_handler.handle(web_socket_route) + else: + web_socket_route.connect_to_server() + def _on_binding(self, binding_call: BindingCall) -> None: func = self._bindings.get(binding_call._initializer["name"]) if func is None: @@ -259,19 +286,12 @@ def set_default_navigation_timeout(self, timeout: float) -> None: def _set_default_navigation_timeout_impl(self, timeout: Optional[float]) -> None: self._timeout_settings.set_default_navigation_timeout(timeout) - self._channel.send_no_reply( - "setDefaultNavigationTimeoutNoReply", - {} if timeout is None else {"timeout": timeout}, - ) def set_default_timeout(self, timeout: float) -> None: return self._set_default_timeout_impl(timeout) def _set_default_timeout_impl(self, timeout: Optional[float]) -> None: self._timeout_settings.set_default_timeout(timeout) - self._channel.send_no_reply( - "setDefaultTimeoutNoReply", {} if timeout is None else {"timeout": timeout} - ) @property def pages(self) -> List[Page]: @@ -281,29 +301,45 @@ def pages(self) -> List[Page]: def browser(self) -> Optional["Browser"]: return self._browser - def _set_options(self, context_options: Dict, browser_options: Dict) -> None: - self._options = context_options - if self._options.get("recordHar"): - self._har_recorders[""] = { - "path": self._options["recordHar"]["path"], - "content": self._options["recordHar"].get("content"), - } - self._tracing._traces_dir = browser_options.get("tracesDir") + async def _initialize_har_from_options( + self, + record_har_path: Optional[Union[Path, str]], + record_har_content: Optional[HarContentPolicy], + record_har_omit_content: Optional[bool], + record_har_url_filter: Optional[Union[Pattern[str], str]], + record_har_mode: Optional[HarMode], + ) -> None: + if not record_har_path: + return + record_har_path = str(record_har_path) + default_policy: HarContentPolicy = ( + "attach" if record_har_path.endswith(".zip") else "embed" + ) + content_policy: HarContentPolicy = record_har_content or ( + "omit" if record_har_omit_content is True else default_policy + ) + await self._record_into_har( + har=record_har_path, + page=None, + url=record_har_url_filter, + update_content=content_policy, + update_mode=(record_har_mode or "full"), + ) async def new_page(self) -> Page: if self._owner_page: raise Error("Please use browser.new_context()") - return from_channel(await self._channel.send("newPage")) + return from_channel(await self._channel.send("newPage", None)) async def cookies(self, urls: Union[str, Sequence[str]] = None) -> List[Cookie]: if urls is None: urls = [] if isinstance(urls, str): urls = [urls] - return await self._channel.send("cookies", dict(urls=urls)) + return await self._channel.send("cookies", None, dict(urls=urls)) async def add_cookies(self, cookies: Sequence[SetCookieParam]) -> None: - await self._channel.send("addCookies", dict(cookies=cookies)) + await self._channel.send("addCookies", None, dict(cookies=cookies)) async def clear_cookies( self, @@ -313,45 +349,46 @@ async def clear_cookies( ) -> None: await self._channel.send( "clearCookies", + None, { "name": name if isinstance(name, str) else None, "nameRegexSource": name.pattern if isinstance(name, Pattern) else None, - "nameRegexFlags": escape_regex_flags(name) - if isinstance(name, Pattern) - else None, + "nameRegexFlags": ( + escape_regex_flags(name) if isinstance(name, Pattern) else None + ), "domain": domain if isinstance(domain, str) else None, - "domainRegexSource": domain.pattern - if isinstance(domain, Pattern) - else None, - "domainRegexFlags": escape_regex_flags(domain) - if isinstance(domain, Pattern) - else None, + "domainRegexSource": ( + domain.pattern if isinstance(domain, Pattern) else None + ), + "domainRegexFlags": ( + escape_regex_flags(domain) if isinstance(domain, Pattern) else None + ), "path": path if isinstance(path, str) else None, "pathRegexSource": path.pattern if isinstance(path, Pattern) else None, - "pathRegexFlags": escape_regex_flags(path) - if isinstance(path, Pattern) - else None, + "pathRegexFlags": ( + escape_regex_flags(path) if isinstance(path, Pattern) else None + ), }, ) async def grant_permissions( self, permissions: Sequence[str], origin: str = None ) -> None: - await self._channel.send("grantPermissions", locals_to_params(locals())) + await self._channel.send("grantPermissions", None, locals_to_params(locals())) async def clear_permissions(self) -> None: - await self._channel.send("clearPermissions") + await self._channel.send("clearPermissions", None) async def set_geolocation(self, geolocation: Geolocation = None) -> None: - await self._channel.send("setGeolocation", locals_to_params(locals())) + await self._channel.send("setGeolocation", None, locals_to_params(locals())) async def set_extra_http_headers(self, headers: Dict[str, str]) -> None: await self._channel.send( - "setExtraHTTPHeaders", dict(headers=serialize_headers(headers)) + "setExtraHTTPHeaders", None, dict(headers=serialize_headers(headers)) ) async def set_offline(self, offline: bool) -> None: - await self._channel.send("setOffline", dict(offline=offline)) + await self._channel.send("setOffline", None, dict(offline=offline)) async def add_init_script( self, script: str = None, path: Union[str, Path] = None @@ -360,7 +397,7 @@ async def add_init_script( script = (await async_readfile(path)).decode() if not isinstance(script, str): raise Error("Either path or script parameter must be specified") - await self._channel.send("addInitScript", dict(source=script)) + await self._channel.send("addInitScript", None, dict(source=script)) async def expose_binding( self, name: str, callback: Callable, handle: bool = None @@ -374,7 +411,7 @@ async def expose_binding( raise Error(f'Function "{name}" has been already registered') self._bindings[name] = callback await self._channel.send( - "exposeBinding", dict(name=name, needsHandle=handle or False) + "exposeBinding", None, dict(name=name, needsHandle=handle or False) ) async def expose_function(self, name: str, callback: Callable) -> None: @@ -386,7 +423,8 @@ async def route( self._routes.insert( 0, RouteHandler( - URLMatcher(self._options.get("baseURL"), url), + self._base_url, + url, handler, True if self._dispatcher_fiber else False, times, @@ -400,7 +438,7 @@ async def unroute( removed = [] remaining = [] for route in self._routes: - if route.matcher.match != url or (handler and route.handler != handler): + if route.url != url or (handler and route.handler != handler): remaining.append(route) else: removed.append(route) @@ -413,10 +451,18 @@ async def _unroute_internal( behavior: Literal["default", "ignoreErrors", "wait"] = None, ) -> None: self._routes = remaining + if behavior is not None and behavior != "default": + await asyncio.gather(*map(lambda router: router.stop(behavior), removed)) # type: ignore await self._update_interception_patterns() - if behavior is None or behavior == "default": - return - await asyncio.gather(*map(lambda router: router.stop(behavior), removed)) # type: ignore + + async def route_web_socket( + self, url: URLMatch, handler: WebSocketRouteHandlerCallback + ) -> None: + self._web_socket_routes.insert( + 0, + WebSocketRouteHandler(self._base_url, url, handler), + ) + await self._update_web_socket_interception_patterns() def _dispose_har_routers(self) -> None: for router in self._har_routers: @@ -437,22 +483,25 @@ async def _record_into_har( update_content: HarContentPolicy = None, update_mode: HarMode = None, ) -> None: + update_content = update_content or "attach" params: Dict[str, Any] = { - "options": prepare_record_har_options( - { - "recordHarPath": har, - "recordHarContent": update_content or "attach", - "recordHarMode": update_mode or "minimal", - "recordHarUrlFilter": url, - } - ) + "options": { + "zip": str(har).endswith(".zip"), + "content": update_content, + "urlGlob": url if isinstance(url, str) else None, + "urlRegexSource": url.pattern if isinstance(url, Pattern) else None, + "urlRegexFlags": ( + escape_regex_flags(url) if isinstance(url, Pattern) else None + ), + "mode": update_mode or "minimal", + } } if page: params["page"] = page._channel - har_id = await self._channel.send("harStart", params) + har_id = await self._channel.send("harStart", None, params) self._har_recorders[har_id] = { "path": str(har), - "content": update_content or "attach", + "content": update_content, } async def route_from_har( @@ -485,7 +534,15 @@ async def route_from_har( async def _update_interception_patterns(self) -> None: patterns = RouteHandler.prepare_interception_patterns(self._routes) await self._channel.send( - "setNetworkInterceptionPatterns", {"patterns": patterns} + "setNetworkInterceptionPatterns", None, {"patterns": patterns} + ) + + async def _update_web_socket_interception_patterns(self) -> None: + patterns = WebSocketRouteHandler.prepare_interception_patterns( + self._web_socket_routes + ) + await self._channel.send( + "setWebSocketInterceptionPatterns", None, {"patterns": patterns} ) def expect_event( @@ -508,29 +565,37 @@ def expect_event( return EventContextManagerImpl(waiter.result()) def _on_close(self) -> None: + self._closing_or_closed = True if self._browser: - self._browser._contexts.remove(self) + if self in self._browser._contexts: + self._browser._contexts.remove(self) + assert self._browser._browser_type is not None + if ( + self + in self._browser._browser_type._playwright.selectors._contexts_for_selectors + ): + self._browser._browser_type._playwright.selectors._contexts_for_selectors.remove( + self + ) self._dispose_har_routers() self._tracing._reset_stack_counter() self.emit(BrowserContext.Events.Close, self) async def close(self, reason: str = None) -> None: - if self._close_was_called: + if self._closing_or_closed: return self._close_reason = reason - self._close_was_called = True + self._closing_or_closed = True - await self._channel._connection.wrap_api_call( - lambda: self.request.dispose(reason=reason), True - ) + await self.request.dispose(reason=reason) async def _inner_close() -> None: for har_id, params in self._har_recorders.items(): har = cast( Artifact, from_channel( - await self._channel.send("harExport", {"harId": har_id}) + await self._channel.send("harExport", None, {"harId": har_id}) ), ) # Server side will compress artifact if content is attach or if file is .zip. @@ -549,11 +614,15 @@ async def _inner_close() -> None: await har.delete() await self._channel._connection.wrap_api_call(_inner_close, True) - await self._channel.send("close", {"reason": reason}) + await self._channel.send("close", None, {"reason": reason}) await self._closed_future - async def storage_state(self, path: Union[str, Path] = None) -> StorageState: - result = await self._channel.send_return_as_dict("storageState") + async def storage_state( + self, path: Union[str, Path] = None, indexedDB: bool = None + ) -> StorageState: + result = await self._channel.send_return_as_dict( + "storageState", None, {"indexedDB": indexedDB} + ) if path: await async_writefile(path, json.dumps(result)) return result @@ -586,10 +655,6 @@ def expect_page( ) -> EventContextManagerImpl[Page]: return self.expect_event(BrowserContext.Events.Page, predicate, timeout) - def _on_background_page(self, page: Page) -> None: - self._background_pages.add(page) - self.emit(BrowserContext.Events.BackgroundPage, page) - def _on_service_worker(self, worker: Worker) -> None: worker._context = self self._service_workers.add(worker) @@ -624,10 +689,13 @@ def _on_request_finished( def _on_console_message(self, event: Dict) -> None: message = ConsoleMessage(event, self._loop, self._dispatcher_fiber) - self.emit(BrowserContext.Events.Console, message) + worker = message.worker + if worker: + worker.emit(Worker.Events.Console, message) page = message.page if page: page.emit(Page.Events.Console, message) + self.emit(BrowserContext.Events.Console, message) def _on_dialog(self, dialog: Dialog) -> None: has_listeners = self.emit(BrowserContext.Events.Dialog, dialog) @@ -645,7 +713,10 @@ def _on_dialog(self, dialog: Dialog) -> None: asyncio.create_task(dialog.dismiss()) def _on_page_error(self, error: Error, page: Optional[Page]) -> None: - self.emit(BrowserContext.Events.WebError, WebError(self._loop, page, error)) + self.emit( + BrowserContext.Events.WebError, + WebError(self._loop, self._dispatcher_fiber, page, error), + ) if page: page.emit(Page.Events.PageError, error) @@ -661,7 +732,7 @@ def _on_response(self, response: Response, page: Optional[Page]) -> None: @property def background_pages(self) -> List[Page]: - return list(self._background_pages) + return [] @property def service_workers(self) -> List[Worker]: @@ -676,7 +747,7 @@ async def new_cdp_session(self, page: Union[Page, Frame]) -> CDPSession: params["frame"] = page._channel else: raise Error("page: expected Page or Frame") - return from_channel(await self._channel.send("newCDPSession", params)) + return from_channel(await self._channel.send("newCDPSession", None, params)) @property def tracing(self) -> Tracing: diff --git a/playwright/_impl/_browser_type.py b/playwright/_impl/_browser_type.py index 1c9303c7f..3aef7dd6d 100644 --- a/playwright/_impl/_browser_type.py +++ b/playwright/_impl/_browser_type.py @@ -13,7 +13,9 @@ # limitations under the License. import asyncio +import json import pathlib +import sys from pathlib import Path from typing import TYPE_CHECKING, Dict, List, Optional, Pattern, Sequence, Union, cast @@ -24,27 +26,26 @@ ProxySettings, ViewportSize, ) -from playwright._impl._browser import Browser, prepare_browser_context_params +from playwright._impl._browser import Browser from playwright._impl._browser_context import BrowserContext -from playwright._impl._connection import ( - ChannelOwner, - Connection, - from_channel, - from_nullable_channel, -) +from playwright._impl._connection import ChannelOwner, Connection, from_channel from playwright._impl._errors import Error from playwright._impl._helper import ( + PLAYWRIGHT_MAX_DEADLINE, ColorScheme, + Contrast, Env, ForcedColors, HarContentPolicy, HarMode, ReducedMotion, ServiceWorkersPolicy, + TimeoutSettings, + async_readfile, locals_to_params, ) from playwright._impl._json_pipe import JsonPipeTransport -from playwright._impl._network import serialize_headers +from playwright._impl._network import serialize_headers, to_client_certificates_protocol from playwright._impl._waiter import throw_on_timeout if TYPE_CHECKING: @@ -81,7 +82,6 @@ async def launch( timeout: float = None, env: Env = None, headless: bool = None, - devtools: bool = None, proxy: ProxySettings = None, downloadsPath: Union[str, Path] = None, slowMo: float = None, @@ -92,9 +92,16 @@ async def launch( params = locals_to_params(locals()) normalize_launch_params(params) browser = cast( - Browser, from_channel(await self._channel.send("launch", params)) + Browser, + from_channel( + await self._channel.send( + "launch", TimeoutSettings.launch_timeout, params + ) + ), + ) + browser._connect_to_browser_type( + self, str(tracesDir) if tracesDir is not None else None ) - self._did_launch_browser(browser) return browser async def launch_persistent_context( @@ -110,7 +117,6 @@ async def launch_persistent_context( timeout: float = None, env: Env = None, headless: bool = None, - devtools: bool = None, proxy: ProxySettings = None, downloadsPath: Union[str, Path] = None, slowMo: float = None, @@ -134,6 +140,7 @@ async def launch_persistent_context( colorScheme: ColorScheme = None, reducedMotion: ReducedMotion = None, forcedColors: ForcedColors = None, + contrast: Contrast = None, acceptDownloads: bool = None, tracesDir: Union[pathlib.Path, str] = None, chromiumSandbox: bool = None, @@ -150,37 +157,58 @@ async def launch_persistent_context( recordHarContent: HarContentPolicy = None, clientCertificates: List[ClientCertificate] = None, ) -> BrowserContext: - userDataDir = str(Path(userDataDir)) if userDataDir else "" + userDataDir = self._user_data_dir(userDataDir) params = locals_to_params(locals()) - await prepare_browser_context_params(params) + await self._prepare_browser_context_params(params) normalize_launch_params(params) - context = cast( - BrowserContext, - from_channel(await self._channel.send("launchPersistentContext", params)), + result = await self._channel.send_return_as_dict( + "launchPersistentContext", TimeoutSettings.launch_timeout, params + ) + browser = cast( + Browser, + from_channel(result["browser"]), + ) + browser._connect_to_browser_type( + self, str(tracesDir) if tracesDir is not None else None + ) + context = cast(BrowserContext, from_channel(result["context"])) + await context._initialize_har_from_options( + record_har_content=recordHarContent, + record_har_mode=recordHarMode, + record_har_omit_content=recordHarOmitContent, + record_har_path=recordHarPath, + record_har_url_filter=recordHarUrlFilter, ) - self._did_create_context(context, params, params) return context + def _user_data_dir(self, userDataDir: Optional[Union[str, Path]]) -> str: + if not userDataDir: + return "" + if not Path(userDataDir).is_absolute(): + # Can be dropped once we drop Python 3.9 support (10/2025): + # https://github.com/python/cpython/issues/82852 + if sys.platform == "win32" and sys.version_info[:2] < (3, 10): + return str(pathlib.Path.cwd() / userDataDir) + return str(Path(userDataDir).resolve()) + return str(Path(userDataDir)) + async def connect_over_cdp( self, endpointURL: str, timeout: float = None, slowMo: float = None, headers: Dict[str, str] = None, + isLocal: bool = None, ) -> Browser: params = locals_to_params(locals()) if params.get("headers"): params["headers"] = serialize_headers(params["headers"]) - response = await self._channel.send_return_as_dict("connectOverCDP", params) + response = await self._channel.send_return_as_dict( + "connectOverCDP", TimeoutSettings.launch_timeout, params + ) browser = cast(Browser, from_channel(response["browser"])) - self._did_launch_browser(browser) + browser._connect_to_browser_type(self, None) - default_context = cast( - Optional[BrowserContext], - from_nullable_channel(response.get("defaultContext")), - ) - if default_context: - self._did_create_context(default_context, {}, {}) return browser async def connect( @@ -191,8 +219,6 @@ async def connect( headers: Dict[str, str] = None, exposeNetwork: str = None, ) -> Browser: - if timeout is None: - timeout = 30000 if slowMo is None: slowMo = 0 @@ -201,11 +227,12 @@ async def connect( pipe_channel = ( await local_utils._channel.send_return_as_dict( "connect", + None, { "wsEndpoint": wsEndpoint, "headers": headers, "slowMo": slowMo, - "timeout": timeout, + "timeout": timeout if timeout is not None else 0, "exposeNetwork": exposeNetwork, }, ) @@ -245,7 +272,10 @@ def handle_transport_close(reason: Optional[str]) -> None: connection._loop.create_task(connection.run()) playwright_future = connection.playwright_future - timeout_future = throw_on_timeout(timeout, Error("Connection timed out")) + timeout_future = throw_on_timeout( + timeout if timeout is not None else PLAYWRIGHT_MAX_DEADLINE, + Error("Connection timed out"), + ) done, pending = await asyncio.wait( {transport.on_error_future, playwright_future, timeout_future}, return_when=asyncio.FIRST_COMPLETED, @@ -260,18 +290,59 @@ def handle_transport_close(reason: Optional[str]) -> None: pre_launched_browser = playwright._initializer.get("preLaunchedBrowser") assert pre_launched_browser browser = cast(Browser, from_channel(pre_launched_browser)) - self._did_launch_browser(browser) browser._should_close_connection_on_close = True + browser._connect_to_browser_type(self, None) return browser - def _did_create_context( - self, context: BrowserContext, context_options: Dict, browser_options: Dict - ) -> None: - context._set_options(context_options, browser_options) + async def _prepare_browser_context_params(self, params: Dict) -> None: + if params.get("noViewport"): + del params["noViewport"] + params["noDefaultViewport"] = True + if "defaultBrowserType" in params: + del params["defaultBrowserType"] + if "extraHTTPHeaders" in params: + params["extraHTTPHeaders"] = serialize_headers(params["extraHTTPHeaders"]) + if "recordVideoDir" in params: + params["recordVideo"] = {"dir": Path(params["recordVideoDir"]).absolute()} + if "recordVideoSize" in params: + params["recordVideo"]["size"] = params["recordVideoSize"] + del params["recordVideoSize"] + del params["recordVideoDir"] + if "storageState" in params: + storageState = params["storageState"] + if not isinstance(storageState, dict): + params["storageState"] = json.loads( + (await async_readfile(storageState)).decode() + ) + if params.get("colorScheme", None) == "null": + params["colorScheme"] = "no-override" + if params.get("reducedMotion", None) == "null": + params["reducedMotion"] = "no-override" + if params.get("forcedColors", None) == "null": + params["forcedColors"] = "no-override" + if params.get("contrast", None) == "null": + params["contrast"] = "no-override" + if "acceptDownloads" in params: + params["acceptDownloads"] = ( + "accept" if params["acceptDownloads"] else "deny" + ) + + if "clientCertificates" in params: + params["clientCertificates"] = await to_client_certificates_protocol( + params["clientCertificates"] + ) + params["selectorEngines"] = self._playwright.selectors._selector_engines + params["testIdAttributeName"] = ( + self._playwright.selectors._test_id_attribute_name + ) - def _did_launch_browser(self, browser: Browser) -> None: - browser._browser_type = self + # Remove HAR options + params.pop("recordHarPath", None) + params.pop("recordHarOmitContent", None) + params.pop("recordHarUrlFilter", None) + params.pop("recordHarMode", None) + params.pop("recordHarContent", None) def normalize_launch_params(params: Dict) -> None: diff --git a/playwright/_impl/_cdp_session.py b/playwright/_impl/_cdp_session.py index b6e383ff2..95e65c57a 100644 --- a/playwright/_impl/_cdp_session.py +++ b/playwright/_impl/_cdp_session.py @@ -29,7 +29,10 @@ def _on_event(self, params: Any) -> None: self.emit(params["method"], params.get("params")) async def send(self, method: str, params: Dict = None) -> Dict: - return await self._channel.send("send", locals_to_params(locals())) + return await self._channel.send("send", None, locals_to_params(locals())) async def detach(self) -> None: - await self._channel.send("detach") + await self._channel.send( + "detach", + None, + ) diff --git a/playwright/_impl/_clock.py b/playwright/_impl/_clock.py index d8bb58718..f6eb7c42d 100644 --- a/playwright/_impl/_clock.py +++ b/playwright/_impl/_clock.py @@ -27,7 +27,9 @@ def __init__(self, browser_context: "BrowserContext") -> None: async def install(self, time: Union[float, str, datetime.datetime] = None) -> None: await self._browser_context._channel.send( - "clockInstall", parse_time(time) if time is not None else {} + "clockInstall", + None, + parse_time(time) if time is not None else {}, ) async def fast_forward( @@ -35,43 +37,59 @@ async def fast_forward( ticks: Union[int, str], ) -> None: await self._browser_context._channel.send( - "clockFastForward", parse_ticks(ticks) + "clockFastForward", + None, + parse_ticks(ticks), ) async def pause_at( self, time: Union[float, str, datetime.datetime], ) -> None: - await self._browser_context._channel.send("clockPauseAt", parse_time(time)) + await self._browser_context._channel.send( + "clockPauseAt", + None, + parse_time(time), + ) async def resume( self, ) -> None: - await self._browser_context._channel.send("clockResume") + await self._browser_context._channel.send("clockResume", None) async def run_for( self, ticks: Union[int, str], ) -> None: - await self._browser_context._channel.send("clockRunFor", parse_ticks(ticks)) + await self._browser_context._channel.send( + "clockRunFor", + None, + parse_ticks(ticks), + ) async def set_fixed_time( self, time: Union[float, str, datetime.datetime], ) -> None: - await self._browser_context._channel.send("clockSetFixedTime", parse_time(time)) + await self._browser_context._channel.send( + "clockSetFixedTime", + None, + parse_time(time), + ) async def set_system_time( self, time: Union[float, str, datetime.datetime], ) -> None: await self._browser_context._channel.send( - "clockSetSystemTime", parse_time(time) + "clockSetSystemTime", + None, + parse_time(time), ) def parse_time( - time: Union[float, str, datetime.datetime] + time: Union[float, str, datetime.datetime], ) -> Dict[str, Union[int, str]]: if isinstance(time, (float, int)): return {"timeNumber": int(time * 1_000)} diff --git a/playwright/_impl/_connection.py b/playwright/_impl/_connection.py index eb4d182d3..bbc42b6e1 100644 --- a/playwright/_impl/_connection.py +++ b/playwright/_impl/_connection.py @@ -37,6 +37,7 @@ from pyee.asyncio import AsyncIOEventEmitter import playwright +import playwright._impl._impl_to_api_mapping from playwright._impl._errors import TargetClosedError, rewrite_error from playwright._impl._greenlets import EventGreenlet from playwright._impl._helper import Error, ParsedMessagePayload, parse_error @@ -46,6 +47,8 @@ from playwright._impl._local_utils import LocalUtils from playwright._impl._playwright import Playwright +TimeoutCalculator = Optional[Callable[[Optional[float]], float]] + class Channel(AsyncIOEventEmitter): def __init__(self, connection: "Connection", object: "ChannelOwner") -> None: @@ -55,35 +58,67 @@ def __init__(self, connection: "Connection", object: "ChannelOwner") -> None: self._object = object self.on("error", lambda exc: self._connection._on_event_listener_error(exc)) - async def send(self, method: str, params: Dict = None) -> Any: + async def send( + self, + method: str, + timeout_calculator: TimeoutCalculator, + params: Dict = None, + is_internal: bool = False, + title: str = None, + ) -> Any: return await self._connection.wrap_api_call( - lambda: self.inner_send(method, params, False) + lambda: self._inner_send(method, timeout_calculator, params, False), + is_internal, + title, ) - async def send_return_as_dict(self, method: str, params: Dict = None) -> Any: + async def send_return_as_dict( + self, + method: str, + timeout_calculator: TimeoutCalculator, + params: Dict = None, + is_internal: bool = False, + title: str = None, + ) -> Any: return await self._connection.wrap_api_call( - lambda: self.inner_send(method, params, True) + lambda: self._inner_send(method, timeout_calculator, params, True), + is_internal, + title, ) - def send_no_reply(self, method: str, params: Dict = None) -> None: + def send_no_reply( + self, + method: str, + timeout_calculator: TimeoutCalculator, + params: Dict = None, + is_internal: bool = False, + title: str = None, + ) -> None: # No reply messages are used to e.g. waitForEventInfo(after). self._connection.wrap_api_call_sync( lambda: self._connection._send_message_to_server( - self._object, method, {} if params is None else params, True - ) + self._object, + method, + _augment_params(params, timeout_calculator), + True, + ), + is_internal, + title, ) - async def inner_send( - self, method: str, params: Optional[Dict], return_as_dict: bool + async def _inner_send( + self, + method: str, + timeout_calculator: TimeoutCalculator, + params: Optional[Dict], + return_as_dict: bool, ) -> Any: - if params is None: - params = {} if self._connection._error: error = self._connection._error self._connection._error = None raise error callback = self._connection._send_message_to_server( - self._object, method, _filter_none(params) + self._object, method, _augment_params(params, timeout_calculator) ) done, _ = await asyncio.wait( { @@ -164,7 +199,9 @@ def _update_subscription(self, event: str, enabled: bool) -> None: if protocol_event: self._connection.wrap_api_call_sync( lambda: self._channel.send_no_reply( - "updateSubscription", {"event": protocol_event, "enabled": enabled} + "updateSubscription", + None, + {"event": protocol_event, "enabled": enabled}, ), True, ) @@ -181,10 +218,12 @@ def remove_listener(self, event: str, f: Any) -> None: class ProtocolCallback: - def __init__(self, loop: asyncio.AbstractEventLoop) -> None: + def __init__(self, loop: asyncio.AbstractEventLoop, no_reply: bool = False) -> None: self.stack_trace: traceback.StackSummary - self.no_reply: bool + self.no_reply = no_reply self.future = loop.create_future() + if no_reply: + self.future.set_result(None) # The outer task can get cancelled by the user, this forwards the cancellation to the inner task. current_task = asyncio.current_task() @@ -197,9 +236,9 @@ def cb(task: asyncio.Task) -> None: if current_task: current_task.add_done_callback(cb) self.future.add_done_callback( - lambda _: current_task.remove_done_callback(cb) - if current_task - else None + lambda _: ( + current_task.remove_done_callback(cb) if current_task else None + ) ) @@ -211,6 +250,7 @@ async def initialize(self) -> "Playwright": return from_channel( await self._channel.send( "initialize", + None, { "sdkLanguage": "python", }, @@ -243,9 +283,9 @@ def __init__( self._error: Optional[BaseException] = None self.is_remote = False self._init_task: Optional[asyncio.Task] = None - self._api_zone: contextvars.ContextVar[ - Optional[ParsedStackTrace] - ] = contextvars.ContextVar("ApiZone", default=None) + self._api_zone: contextvars.ContextVar[Optional[ParsedStackTrace]] = ( + contextvars.ContextVar("ApiZone", default=None) + ) self._local_utils: Optional["LocalUtils"] = local_utils self._tracing_count = 0 self._closed_error: Optional[Exception] = None @@ -294,6 +334,8 @@ def cleanup(self, cause: str = None) -> None: # To prevent 'Future exception was never retrieved' we ignore all callbacks that are no_reply. if callback.no_reply: continue + if callback.future.cancelled(): + continue callback.future.set_exception(self._closed_error) self._callbacks.clear() self.emit("close") @@ -320,14 +362,13 @@ def _send_message_to_server( ) self._last_id += 1 id = self._last_id - callback = ProtocolCallback(self._loop) + callback = ProtocolCallback(self._loop, no_reply=no_reply) task = asyncio.current_task(self._loop) callback.stack_trace = cast( traceback.StackSummary, - getattr(task, "__pw_stack_trace__", traceback.extract_stack()), + getattr(task, "__pw_stack_trace__", traceback.extract_stack(limit=10)), ) callback.no_reply = no_reply - self._callbacks[id] = callback stack_trace_information = cast(ParsedStackTrace, self._api_zone.get()) frames = stack_trace_information.get("frames", []) location = ( @@ -346,6 +387,9 @@ def _send_message_to_server( } if location: metadata["location"] = location # type: ignore + title = stack_trace_information["title"] + if title: + metadata["title"] = title message = { "id": id, "guid": object._guid, @@ -356,8 +400,8 @@ def _send_message_to_server( if self._tracing_count > 0 and frames and object._guid != "localUtils": self.local_utils.add_stack_to_tracing_no_reply(id, frames) - self._transport.send(message) self._callbacks[id] = callback + self._transport.send(message) return callback @@ -378,9 +422,7 @@ def dispatch(self, msg: ParsedMessagePayload) -> None: parsed_error = parse_error( error["error"], format_call_log(msg.get("log")) # type: ignore ) - parsed_error._stack = "".join( - traceback.format_list(callback.stack_trace)[-10:] - ) + parsed_error._stack = "".join(callback.stack_trace.format()) callback.future.set_exception(parsed_error) else: result = self._replace_guids_with_channels(msg.get("result")) @@ -500,13 +542,16 @@ def _replace_guids_with_channels(self, payload: Any) -> Any: return payload async def wrap_api_call( - self, cb: Callable[[], Any], is_internal: bool = False + self, cb: Callable[[], Any], is_internal: bool = False, title: str = None ) -> Any: if self._api_zone.get(): return await cb() task = asyncio.current_task(self._loop) - st: List[inspect.FrameInfo] = getattr(task, "__pw_stack__", inspect.stack()) - parsed_st = _extract_stack_trace_information_from_stack(st, is_internal) + st: List[inspect.FrameInfo] = getattr( + task, "__pw_stack__", None + ) or inspect.stack(0) + + parsed_st = _extract_stack_trace_information_from_stack(st, is_internal, title) self._api_zone.set(parsed_st) try: return await cb() @@ -516,13 +561,15 @@ async def wrap_api_call( self._api_zone.set(None) def wrap_api_call_sync( - self, cb: Callable[[], Any], is_internal: bool = False + self, cb: Callable[[], Any], is_internal: bool = False, title: str = None ) -> Any: if self._api_zone.get(): return cb() task = asyncio.current_task(self._loop) - st: List[inspect.FrameInfo] = getattr(task, "__pw_stack__", inspect.stack()) - parsed_st = _extract_stack_trace_information_from_stack(st, is_internal) + st: List[inspect.FrameInfo] = getattr( + task, "__pw_stack__", None + ) or inspect.stack(0) + parsed_st = _extract_stack_trace_information_from_stack(st, is_internal, title) self._api_zone.set(parsed_st) try: return cb() @@ -550,16 +597,23 @@ class StackFrame(TypedDict): class ParsedStackTrace(TypedDict): frames: List[StackFrame] apiName: Optional[str] + title: Optional[str] def _extract_stack_trace_information_from_stack( - st: List[inspect.FrameInfo], is_internal: bool + st: List[inspect.FrameInfo], is_internal: bool, title: str = None ) -> ParsedStackTrace: playwright_module_path = str(Path(playwright.__file__).parents[0]) last_internal_api_name = "" api_name = "" parsed_frames: List[StackFrame] = [] for frame in st: + # Sync and Async implementations can have event handlers. When these are sync, they + # get evaluated in the context of the event loop, so they contain the stack trace of when + # the message was received. _impl_to_api_mapping is glue between the user-code and internal + # code to translate impl classes to api classes. We want to ignore these frames. + if playwright._impl._impl_to_api_mapping.__file__ == frame.filename: + continue is_playwright_internal = frame.filename.startswith(playwright_module_path) method_name = "" @@ -587,11 +641,28 @@ def _extract_stack_trace_information_from_stack( return { "frames": parsed_frames, "apiName": "" if is_internal else api_name, + "title": title, } +def _augment_params( + params: Optional[Dict], + timeout_calculator: Optional[Callable[[Optional[float]], float]], +) -> Dict: + if params is None: + params = {} + if timeout_calculator: + params["timeout"] = timeout_calculator(params.get("timeout")) + return _filter_none(params) + + def _filter_none(d: Mapping) -> Dict: - return {k: v for k, v in d.items() if v is not None} + result = {} + for k, v in d.items(): + if v is None: + continue + result[k] = _filter_none(v) if isinstance(v, dict) else v + return result def format_call_log(log: Optional[List[str]]) -> str: @@ -599,4 +670,4 @@ def format_call_log(log: Optional[List[str]]) -> str: return "" if len(list(filter(lambda x: x.strip(), log))) == 0: return "" - return "\nCall log:\n" + "\n - ".join(log) + "\n" + return "\nCall log:\n" + "\n".join(log) + "\n" diff --git a/playwright/_impl/_console_message.py b/playwright/_impl/_console_message.py index ba8fc0a38..f37e3dd4d 100644 --- a/playwright/_impl/_console_message.py +++ b/playwright/_impl/_console_message.py @@ -13,7 +13,7 @@ # limitations under the License. from asyncio import AbstractEventLoop -from typing import TYPE_CHECKING, Any, Dict, List, Optional +from typing import TYPE_CHECKING, Any, Dict, List, Literal, Optional, Union from playwright._impl._api_structures import SourceLocation from playwright._impl._connection import from_channel, from_nullable_channel @@ -21,6 +21,7 @@ if TYPE_CHECKING: # pragma: no cover from playwright._impl._page import Page + from playwright._impl._worker import Worker class ConsoleMessage: @@ -31,6 +32,7 @@ def __init__( self._loop = loop self._dispatcher_fiber = dispatcher_fiber self._page: Optional["Page"] = from_nullable_channel(event.get("page")) + self._worker: Optional["Worker"] = from_nullable_channel(event.get("worker")) def __repr__(self) -> str: return f"" @@ -39,7 +41,27 @@ def __str__(self) -> str: return self.text @property - def type(self) -> str: + def type(self) -> Union[ + Literal["assert"], + Literal["clear"], + Literal["count"], + Literal["debug"], + Literal["dir"], + Literal["dirxml"], + Literal["endGroup"], + Literal["error"], + Literal["info"], + Literal["log"], + Literal["profile"], + Literal["profileEnd"], + Literal["startGroup"], + Literal["startGroupCollapsed"], + Literal["table"], + Literal["time"], + Literal["timeEnd"], + Literal["trace"], + Literal["warning"], + ]: return self._event["type"] @property @@ -57,3 +79,7 @@ def location(self) -> SourceLocation: @property def page(self) -> Optional["Page"]: return self._page + + @property + def worker(self) -> Optional["Worker"]: + return self._worker diff --git a/playwright/_impl/_dialog.py b/playwright/_impl/_dialog.py index a0c6ca77f..226e703b9 100644 --- a/playwright/_impl/_dialog.py +++ b/playwright/_impl/_dialog.py @@ -48,7 +48,10 @@ def page(self) -> Optional["Page"]: return self._page async def accept(self, promptText: str = None) -> None: - await self._channel.send("accept", locals_to_params(locals())) + await self._channel.send("accept", None, locals_to_params(locals())) async def dismiss(self) -> None: - await self._channel.send("dismiss") + await self._channel.send( + "dismiss", + None, + ) diff --git a/playwright/_impl/_element_handle.py b/playwright/_impl/_element_handle.py index d7482fdea..3854669d0 100644 --- a/playwright/_impl/_element_handle.py +++ b/playwright/_impl/_element_handle.py @@ -13,6 +13,7 @@ # limitations under the License. import base64 +import mimetypes from pathlib import Path from typing import ( TYPE_CHECKING, @@ -55,56 +56,63 @@ def __init__( self, parent: ChannelOwner, type: str, guid: str, initializer: Dict ) -> None: super().__init__(parent, type, guid, initializer) + self._frame = cast("Frame", parent) async def _createSelectorForTest(self, name: str) -> Optional[str]: - return await self._channel.send("createSelectorForTest", dict(name=name)) + return await self._channel.send( + "createSelectorForTest", self._frame._timeout, dict(name=name) + ) def as_element(self) -> Optional["ElementHandle"]: return self async def owner_frame(self) -> Optional["Frame"]: - return from_nullable_channel(await self._channel.send("ownerFrame")) + return from_nullable_channel(await self._channel.send("ownerFrame", None)) async def content_frame(self) -> Optional["Frame"]: - return from_nullable_channel(await self._channel.send("contentFrame")) + return from_nullable_channel(await self._channel.send("contentFrame", None)) async def get_attribute(self, name: str) -> Optional[str]: - return await self._channel.send("getAttribute", dict(name=name)) + return await self._channel.send("getAttribute", None, dict(name=name)) async def text_content(self) -> Optional[str]: - return await self._channel.send("textContent") + return await self._channel.send("textContent", None) async def inner_text(self) -> str: - return await self._channel.send("innerText") + return await self._channel.send("innerText", None) async def inner_html(self) -> str: - return await self._channel.send("innerHTML") + return await self._channel.send("innerHTML", None) async def is_checked(self) -> bool: - return await self._channel.send("isChecked") + return await self._channel.send("isChecked", None) async def is_disabled(self) -> bool: - return await self._channel.send("isDisabled") + return await self._channel.send("isDisabled", None) async def is_editable(self) -> bool: - return await self._channel.send("isEditable") + return await self._channel.send("isEditable", None) async def is_enabled(self) -> bool: - return await self._channel.send("isEnabled") + return await self._channel.send("isEnabled", None) async def is_hidden(self) -> bool: - return await self._channel.send("isHidden") + return await self._channel.send("isHidden", None) async def is_visible(self) -> bool: - return await self._channel.send("isVisible") + return await self._channel.send("isVisible", None) async def dispatch_event(self, type: str, eventInit: Dict = None) -> None: await self._channel.send( - "dispatchEvent", dict(type=type, eventInit=serialize_argument(eventInit)) + "dispatchEvent", + None, + dict(type=type, eventInit=serialize_argument(eventInit)), ) async def scroll_into_view_if_needed(self, timeout: float = None) -> None: - await self._channel.send("scrollIntoViewIfNeeded", locals_to_params(locals())) + await self._channel.send( + "scrollIntoViewIfNeeded", self._frame._timeout, locals_to_params(locals()) + ) async def hover( self, @@ -115,7 +123,9 @@ async def hover( force: bool = None, trial: bool = None, ) -> None: - await self._channel.send("hover", locals_to_params(locals())) + await self._channel.send( + "hover", self._frame._timeout, locals_to_params(locals()) + ) async def click( self, @@ -128,8 +138,11 @@ async def click( force: bool = None, noWaitAfter: bool = None, trial: bool = None, + steps: int = None, ) -> None: - await self._channel.send("click", locals_to_params(locals())) + await self._channel.send( + "click", self._frame._timeout, locals_to_params(locals()) + ) async def dblclick( self, @@ -141,8 +154,11 @@ async def dblclick( force: bool = None, noWaitAfter: bool = None, trial: bool = None, + steps: int = None, ) -> None: - await self._channel.send("dblclick", locals_to_params(locals())) + await self._channel.send( + "dblclick", self._frame._timeout, locals_to_params(locals()) + ) async def select_option( self, @@ -158,10 +174,10 @@ async def select_option( dict( timeout=timeout, force=force, - **convert_select_option_values(value, index, label, element) + **convert_select_option_values(value, index, label, element), ) ) - return await self._channel.send("selectOption", params) + return await self._channel.send("selectOption", self._frame._timeout, params) async def tap( self, @@ -172,7 +188,9 @@ async def tap( noWaitAfter: bool = None, trial: bool = None, ) -> None: - await self._channel.send("tap", locals_to_params(locals())) + await self._channel.send( + "tap", self._frame._timeout, locals_to_params(locals()) + ) async def fill( self, @@ -181,13 +199,19 @@ async def fill( noWaitAfter: bool = None, force: bool = None, ) -> None: - await self._channel.send("fill", locals_to_params(locals())) + await self._channel.send( + "fill", self._frame._timeout, locals_to_params(locals()) + ) async def select_text(self, force: bool = None, timeout: float = None) -> None: - await self._channel.send("selectText", locals_to_params(locals())) + await self._channel.send( + "selectText", self._frame._timeout, locals_to_params(locals()) + ) async def input_value(self, timeout: float = None) -> str: - return await self._channel.send("inputValue", locals_to_params(locals())) + return await self._channel.send( + "inputValue", self._frame._timeout, locals_to_params(locals()) + ) async def set_input_files( self, @@ -203,6 +227,7 @@ async def set_input_files( converted = await convert_input_files(files, frame.page.context) await self._channel.send( "setInputFiles", + self._frame._timeout, { "timeout": timeout, **converted, @@ -210,7 +235,7 @@ async def set_input_files( ) async def focus(self) -> None: - await self._channel.send("focus") + await self._channel.send("focus", None) async def type( self, @@ -219,7 +244,9 @@ async def type( timeout: float = None, noWaitAfter: bool = None, ) -> None: - await self._channel.send("type", locals_to_params(locals())) + await self._channel.send( + "type", self._frame._timeout, locals_to_params(locals()) + ) async def press( self, @@ -228,7 +255,9 @@ async def press( timeout: float = None, noWaitAfter: bool = None, ) -> None: - await self._channel.send("press", locals_to_params(locals())) + await self._channel.send( + "press", self._frame._timeout, locals_to_params(locals()) + ) async def set_checked( self, @@ -262,7 +291,9 @@ async def check( noWaitAfter: bool = None, trial: bool = None, ) -> None: - await self._channel.send("check", locals_to_params(locals())) + await self._channel.send( + "check", self._frame._timeout, locals_to_params(locals()) + ) async def uncheck( self, @@ -272,10 +303,12 @@ async def uncheck( noWaitAfter: bool = None, trial: bool = None, ) -> None: - await self._channel.send("uncheck", locals_to_params(locals())) + await self._channel.send( + "uncheck", self._frame._timeout, locals_to_params(locals()) + ) async def bounding_box(self) -> Optional[FloatRect]: - return await self._channel.send("boundingBox") + return await self._channel.send("boundingBox", None) async def screenshot( self, @@ -293,6 +326,8 @@ async def screenshot( ) -> bytes: params = locals_to_params(locals()) if "path" in params: + if "type" not in params: + params["type"] = determine_screenshot_type(params["path"]) del params["path"] if "mask" in params: params["mask"] = list( @@ -306,7 +341,9 @@ async def screenshot( params["mask"], ) ) - encoded_binary = await self._channel.send("screenshot", params) + encoded_binary = await self._channel.send( + "screenshot", self._frame._timeout, params + ) decoded_binary = base64.b64decode(encoded_binary) if path: make_dirs_for_file(path) @@ -315,14 +352,16 @@ async def screenshot( async def query_selector(self, selector: str) -> Optional["ElementHandle"]: return from_nullable_channel( - await self._channel.send("querySelector", dict(selector=selector)) + await self._channel.send("querySelector", None, dict(selector=selector)) ) async def query_selector_all(self, selector: str) -> List["ElementHandle"]: return list( map( cast(Callable[[Any], Any], from_nullable_channel), - await self._channel.send("querySelectorAll", dict(selector=selector)), + await self._channel.send( + "querySelectorAll", None, dict(selector=selector) + ), ) ) @@ -335,6 +374,7 @@ async def eval_on_selector( return parse_result( await self._channel.send( "evalOnSelector", + None, dict( selector=selector, expression=expression, @@ -352,6 +392,7 @@ async def eval_on_selector_all( return parse_result( await self._channel.send( "evalOnSelectorAll", + None, dict( selector=selector, expression=expression, @@ -367,7 +408,9 @@ async def wait_for_element_state( ], timeout: float = None, ) -> None: - await self._channel.send("waitForElementState", locals_to_params(locals())) + await self._channel.send( + "waitForElementState", self._frame._timeout, locals_to_params(locals()) + ) async def wait_for_selector( self, @@ -377,7 +420,9 @@ async def wait_for_selector( strict: bool = None, ) -> Optional["ElementHandle"]: return from_nullable_channel( - await self._channel.send("waitForSelector", locals_to_params(locals())) + await self._channel.send( + "waitForSelector", self._frame._timeout, locals_to_params(locals()) + ) ) @@ -392,15 +437,15 @@ def convert_select_option_values( options: Any = None elements: Any = None - if value: + if value is not None: if isinstance(value, str): value = [value] options = (options or []) + list(map(lambda e: dict(valueOrLabel=e), value)) - if index: + if index is not None: if isinstance(index, int): index = [index] options = (options or []) + list(map(lambda e: dict(index=e), index)) - if label: + if label is not None: if isinstance(label, str): label = [label] options = (options or []) + list(map(lambda e: dict(label=e), label)) @@ -410,3 +455,12 @@ def convert_select_option_values( elements = list(map(lambda e: e._channel, element)) return dict(options=options, elements=elements) + + +def determine_screenshot_type(path: Union[str, Path]) -> Literal["jpeg", "png"]: + mime_type, _ = mimetypes.guess_type(path) + if mime_type == "image/png": + return "png" + if mime_type == "image/jpeg": + return "jpeg" + raise Error(f'Unsupported screenshot mime type for path "{path}": {mime_type}') diff --git a/playwright/_impl/_fetch.py b/playwright/_impl/_fetch.py index a4de751bd..50bf4ad4a 100644 --- a/playwright/_impl/_fetch.py +++ b/playwright/_impl/_fetch.py @@ -18,7 +18,6 @@ import typing from pathlib import Path from typing import Any, Dict, List, Optional, Union, cast -from urllib.parse import parse_qs import playwright._impl._network as network from playwright._impl._api_structures import ( @@ -37,6 +36,7 @@ Error, NameValue, TargetClosedError, + TimeoutSettings, async_readfile, async_writefile, is_file_payload, @@ -74,6 +74,8 @@ async def new_context( timeout: float = None, storageState: Union[StorageState, str, Path] = None, clientCertificates: List[ClientCertificate] = None, + failOnStatusCode: bool = None, + maxRedirects: int = None, ) -> "APIRequestContext": params = locals_to_params(locals()) if "storageState" in params: @@ -89,8 +91,11 @@ async def new_context( ) context = cast( APIRequestContext, - from_channel(await self.playwright._channel.send("newRequest", params)), + from_channel( + await self.playwright._channel.send("newRequest", None, params) + ), ) + context._timeout_settings.set_default_timeout(timeout) return context @@ -101,11 +106,12 @@ def __init__( super().__init__(parent, type, guid, initializer) self._tracing: Tracing = from_channel(initializer["tracing"]) self._close_reason: Optional[str] = None + self._timeout_settings = TimeoutSettings(None) async def dispose(self, reason: str = None) -> None: self._close_reason = reason try: - await self._channel.send("dispose", {"reason": reason}) + await self._channel.send("dispose", None, {"reason": reason}) except Error as e: if is_target_closed_error(e): return @@ -403,16 +409,18 @@ async def _inner_fetch( response = await self._channel.send( "fetch", + self._timeout_settings.timeout, { "url": url, - "params": params_to_protocol(params), + "timeout": timeout, + "params": object_to_array(params) if isinstance(params, dict) else None, + "encodedParams": params if isinstance(params, str) else None, "method": method, "headers": serialized_headers, "postData": post_data, "jsonData": json_data, "formData": form_data, "multipartData": multipart_data, - "timeout": timeout, "failOnStatusCode": failOnStatusCode, "ignoreHTTPSErrors": ignoreHTTPSErrors, "maxRedirects": maxRedirects, @@ -422,31 +430,18 @@ async def _inner_fetch( return APIResponse(self, response) async def storage_state( - self, path: Union[pathlib.Path, str] = None + self, + path: Union[pathlib.Path, str] = None, + indexedDB: bool = None, ) -> StorageState: - result = await self._channel.send_return_as_dict("storageState") + result = await self._channel.send_return_as_dict( + "storageState", None, {"indexedDB": indexedDB} + ) if path: await async_writefile(path, json.dumps(result)) return result -def params_to_protocol(params: Optional[ParamsType]) -> Optional[List[NameValue]]: - if not params: - return None - if isinstance(params, dict): - return object_to_array(params) - if params.startswith("?"): - params = params[1:] - parsed = parse_qs(params) - if not parsed: - return None - out = [] - for name, values in parsed.items(): - for value in values: - out.append(NameValue(name=name, value=value)) - return out - - def file_payload_to_json(payload: FilePayload) -> ServerFilePayload: return ServerFilePayload( name=payload["name"], @@ -492,11 +487,15 @@ def headers_array(self) -> network.HeadersArray: async def body(self) -> bytes: try: - result = await self._request._channel.send_return_as_dict( - "fetchResponseBody", - { - "fetchUid": self._fetch_uid, - }, + result = await self._request._connection.wrap_api_call( + lambda: self._request._channel.send_return_as_dict( + "fetchResponseBody", + None, + { + "fetchUid": self._fetch_uid, + }, + ), + True, ) if result is None: raise Error("Response has been disposed") @@ -517,6 +516,7 @@ async def json(self) -> Any: async def dispose(self) -> None: await self._request._channel.send( "disposeAPIResponse", + None, { "fetchUid": self._fetch_uid, }, @@ -529,6 +529,7 @@ def _fetch_uid(self) -> str: async def _fetch_log(self) -> List[str]: return await self._request._channel.send( "fetchLog", + None, { "fetchUid": self._fetch_uid, }, diff --git a/playwright/_impl/_frame.py b/playwright/_impl/_frame.py index 1ce813636..b976667e7 100644 --- a/playwright/_impl/_frame.py +++ b/playwright/_impl/_frame.py @@ -19,6 +19,7 @@ Any, Dict, List, + Literal, Optional, Pattern, Sequence, @@ -29,7 +30,13 @@ from pyee import EventEmitter -from playwright._impl._api_structures import AriaRole, FilePayload, Position +from playwright._impl._api_structures import ( + AriaRole, + FilePayload, + FrameExpectOptions, + FrameExpectResult, + Position, +) from playwright._impl._connection import ( ChannelOwner, from_channel, @@ -42,19 +49,20 @@ DocumentLoadState, FrameNavigatedEvent, KeyboardModifier, - Literal, MouseButton, + TimeoutSettings, URLMatch, - URLMatcher, async_readfile, locals_to_params, monotonic_time, + url_matches, ) from playwright._impl._js_handle import ( JSHandle, Serializable, add_source_url_to_script, parse_result, + parse_value, serialize_argument, ) from playwright._impl._locator import ( @@ -125,7 +133,7 @@ def _on_frame_navigated(self, event: FrameNavigatedEvent) -> None: self._page.emit("framenavigated", self) async def _query_count(self, selector: str) -> int: - return await self._channel.send("queryCount", {"selector": selector}) + return await self._channel.send("queryCount", None, {"selector": selector}) @property def page(self) -> "Page": @@ -142,7 +150,9 @@ async def goto( return cast( Optional[Response], from_nullable_channel( - await self._channel.send("goto", locals_to_params(locals())) + await self._channel.send( + "goto", self._navigation_timeout, locals_to_params(locals()) + ) ), ) @@ -163,11 +173,33 @@ def _setup_navigation_waiter(self, wait_name: str, timeout: float = None) -> Wai Error("Navigating frame was detached!"), lambda frame: frame == self, ) - if timeout is None: - timeout = self._page._timeout_settings.navigation_timeout() + timeout = self._page._timeout_settings.navigation_timeout(timeout) waiter.reject_on_timeout(timeout, f"Timeout {timeout}ms exceeded.") return waiter + async def _expect( + self, + selector: Optional[str], + expression: str, + options: FrameExpectOptions, + title: str = None, + ) -> FrameExpectResult: + if "expectedValue" in options: + options["expectedValue"] = serialize_argument(options["expectedValue"]) + result = await self._channel.send_return_as_dict( + "expect", + self._timeout, + { + "selector": selector, + "expression": expression, + **options, + }, + title=title, + ) + if result.get("received"): + result["received"] = parse_value(result["received"]) + return result + def expect_navigation( self, url: URLMatch = None, @@ -185,18 +217,17 @@ def expect_navigation( to_url = f' to "{url}"' if url else "" waiter.log(f"waiting for navigation{to_url} until '{waitUntil}'") - matcher = ( - URLMatcher(self._page._browser_context._options.get("baseURL"), url) - if url - else None - ) def predicate(event: Any) -> bool: # Any failed navigation results in a rejection. if event.get("error"): return True waiter.log(f' navigated to "{event["url"]}"') - return not matcher or matcher.matches(event["url"]) + return url_matches( + cast("Page", self._page)._browser_context._base_url, + event["url"], + url, + ) waiter.wait_for_event( self._event_emitter, @@ -226,8 +257,7 @@ async def wait_for_url( timeout: float = None, ) -> None: assert self._page - matcher = URLMatcher(self._page._browser_context._options.get("baseURL"), url) - if matcher.matches(self.url): + if url_matches(self._page._browser_context._base_url, self.url, url): await self._wait_for_load_state_impl(state=waitUntil, timeout=timeout) return async with self.expect_navigation( @@ -270,13 +300,26 @@ def handle_load_state_event(actual_state: str) -> bool: ) await waiter.result() + def _timeout(self, timeout: Optional[float]) -> float: + timeout_settings = ( + self._page._timeout_settings if self._page else TimeoutSettings(None) + ) + return timeout_settings.timeout(timeout) + + def _navigation_timeout(self, timeout: Optional[float]) -> float: + timeout_settings = ( + self._page._timeout_settings if self._page else TimeoutSettings(None) + ) + return timeout_settings.navigation_timeout(timeout) + async def frame_element(self) -> ElementHandle: - return from_channel(await self._channel.send("frameElement")) + return from_channel(await self._channel.send("frameElement", None)) async def evaluate(self, expression: str, arg: Serializable = None) -> Any: return parse_result( await self._channel.send( "evaluateExpression", + None, dict( expression=expression, arg=serialize_argument(arg), @@ -290,6 +333,7 @@ async def evaluate_handle( return from_channel( await self._channel.send( "evaluateExpressionHandle", + None, dict( expression=expression, arg=serialize_argument(arg), @@ -301,14 +345,16 @@ async def query_selector( self, selector: str, strict: bool = None ) -> Optional[ElementHandle]: return from_nullable_channel( - await self._channel.send("querySelector", locals_to_params(locals())) + await self._channel.send("querySelector", None, locals_to_params(locals())) ) async def query_selector_all(self, selector: str) -> List[ElementHandle]: return list( map( from_channel, - await self._channel.send("querySelectorAll", dict(selector=selector)), + await self._channel.send( + "querySelectorAll", None, dict(selector=selector) + ), ) ) @@ -320,38 +366,48 @@ async def wait_for_selector( state: Literal["attached", "detached", "hidden", "visible"] = None, ) -> Optional[ElementHandle]: return from_nullable_channel( - await self._channel.send("waitForSelector", locals_to_params(locals())) + await self._channel.send( + "waitForSelector", self._timeout, locals_to_params(locals()) + ) ) async def is_checked( self, selector: str, strict: bool = None, timeout: float = None ) -> bool: - return await self._channel.send("isChecked", locals_to_params(locals())) + return await self._channel.send( + "isChecked", self._timeout, locals_to_params(locals()) + ) async def is_disabled( self, selector: str, strict: bool = None, timeout: float = None ) -> bool: - return await self._channel.send("isDisabled", locals_to_params(locals())) + return await self._channel.send( + "isDisabled", self._timeout, locals_to_params(locals()) + ) async def is_editable( self, selector: str, strict: bool = None, timeout: float = None ) -> bool: - return await self._channel.send("isEditable", locals_to_params(locals())) + return await self._channel.send( + "isEditable", self._timeout, locals_to_params(locals()) + ) async def is_enabled( self, selector: str, strict: bool = None, timeout: float = None ) -> bool: - return await self._channel.send("isEnabled", locals_to_params(locals())) + return await self._channel.send( + "isEnabled", self._timeout, locals_to_params(locals()) + ) - async def is_hidden( - self, selector: str, strict: bool = None, timeout: float = None - ) -> bool: - return await self._channel.send("isHidden", locals_to_params(locals())) + async def is_hidden(self, selector: str, strict: bool = None) -> bool: + return await self._channel.send( + "isHidden", self._timeout, locals_to_params(locals()) + ) - async def is_visible( - self, selector: str, strict: bool = None, timeout: float = None - ) -> bool: - return await self._channel.send("isVisible", locals_to_params(locals())) + async def is_visible(self, selector: str, strict: bool = None) -> bool: + return await self._channel.send( + "isVisible", self._timeout, locals_to_params(locals()) + ) async def dispatch_event( self, @@ -363,6 +419,7 @@ async def dispatch_event( ) -> None: await self._channel.send( "dispatchEvent", + self._timeout, locals_to_params( dict( selector=selector, @@ -384,6 +441,7 @@ async def eval_on_selector( return parse_result( await self._channel.send( "evalOnSelector", + None, locals_to_params( dict( selector=selector, @@ -404,6 +462,7 @@ async def eval_on_selector_all( return parse_result( await self._channel.send( "evalOnSelectorAll", + None, dict( selector=selector, expression=expression, @@ -413,7 +472,7 @@ async def eval_on_selector_all( ) async def content(self) -> str: - return await self._channel.send("content") + return await self._channel.send("content", None) async def set_content( self, @@ -421,7 +480,9 @@ async def set_content( timeout: float = None, waitUntil: DocumentLoadState = None, ) -> None: - await self._channel.send("setContent", locals_to_params(locals())) + await self._channel.send( + "setContent", self._navigation_timeout, locals_to_params(locals()) + ) @property def name(self) -> str: @@ -455,7 +516,7 @@ async def add_script_tag( (await async_readfile(path)).decode(), path ) del params["path"] - return from_channel(await self._channel.send("addScriptTag", params)) + return from_channel(await self._channel.send("addScriptTag", None, params)) async def add_style_tag( self, url: str = None, path: Union[str, Path] = None, content: str = None @@ -469,7 +530,7 @@ async def add_style_tag( + "*/" ) del params["path"] - return from_channel(await self._channel.send("addStyleTag", params)) + return from_channel(await self._channel.send("addStyleTag", None, params)) async def click( self, @@ -485,7 +546,24 @@ async def click( strict: bool = None, trial: bool = None, ) -> None: - await self._channel.send("click", locals_to_params(locals())) + await self._click(**locals_to_params(locals())) + + async def _click( + self, + selector: str, + modifiers: Sequence[KeyboardModifier] = None, + position: Position = None, + delay: float = None, + button: MouseButton = None, + clickCount: int = None, + timeout: float = None, + force: bool = None, + noWaitAfter: bool = None, + strict: bool = None, + trial: bool = None, + steps: int = None, + ) -> None: + await self._channel.send("click", self._timeout, locals_to_params(locals())) async def dblclick( self, @@ -500,7 +578,9 @@ async def dblclick( strict: bool = None, trial: bool = None, ) -> None: - await self._channel.send("dblclick", locals_to_params(locals())) + await self._channel.send( + "dblclick", self._timeout, locals_to_params(locals()), title="Double click" + ) async def tap( self, @@ -513,7 +593,7 @@ async def tap( strict: bool = None, trial: bool = None, ) -> None: - await self._channel.send("tap", locals_to_params(locals())) + await self._channel.send("tap", self._timeout, locals_to_params(locals())) async def fill( self, @@ -524,7 +604,19 @@ async def fill( strict: bool = None, force: bool = None, ) -> None: - await self._channel.send("fill", locals_to_params(locals())) + await self._fill(**locals_to_params(locals())) + + async def _fill( + self, + selector: str, + value: str, + timeout: float = None, + noWaitAfter: bool = None, + strict: bool = None, + force: bool = None, + title: str = None, + ) -> None: + await self._channel.send("fill", self._timeout, locals_to_params(locals())) def locator( self, @@ -605,27 +697,35 @@ def frame_locator(self, selector: str) -> FrameLocator: async def focus( self, selector: str, strict: bool = None, timeout: float = None ) -> None: - await self._channel.send("focus", locals_to_params(locals())) + await self._channel.send("focus", self._timeout, locals_to_params(locals())) async def text_content( self, selector: str, strict: bool = None, timeout: float = None ) -> Optional[str]: - return await self._channel.send("textContent", locals_to_params(locals())) + return await self._channel.send( + "textContent", self._timeout, locals_to_params(locals()) + ) async def inner_text( self, selector: str, strict: bool = None, timeout: float = None ) -> str: - return await self._channel.send("innerText", locals_to_params(locals())) + return await self._channel.send( + "innerText", self._timeout, locals_to_params(locals()) + ) async def inner_html( self, selector: str, strict: bool = None, timeout: float = None ) -> str: - return await self._channel.send("innerHTML", locals_to_params(locals())) + return await self._channel.send( + "innerHTML", self._timeout, locals_to_params(locals()) + ) async def get_attribute( self, selector: str, name: str, strict: bool = None, timeout: float = None ) -> Optional[str]: - return await self._channel.send("getAttribute", locals_to_params(locals())) + return await self._channel.send( + "getAttribute", self._timeout, locals_to_params(locals()) + ) async def hover( self, @@ -638,7 +738,7 @@ async def hover( strict: bool = None, trial: bool = None, ) -> None: - await self._channel.send("hover", locals_to_params(locals())) + await self._channel.send("hover", self._timeout, locals_to_params(locals())) async def drag_and_drop( self, @@ -651,8 +751,11 @@ async def drag_and_drop( strict: bool = None, timeout: float = None, trial: bool = None, + steps: int = None, ) -> None: - await self._channel.send("dragAndDrop", locals_to_params(locals())) + await self._channel.send( + "dragAndDrop", self._timeout, locals_to_params(locals()) + ) async def select_option( self, @@ -675,7 +778,7 @@ async def select_option( **convert_select_option_values(value, index, label, element), ) ) - return await self._channel.send("selectOption", params) + return await self._channel.send("selectOption", self._timeout, params) async def input_value( self, @@ -683,7 +786,9 @@ async def input_value( strict: bool = None, timeout: float = None, ) -> str: - return await self._channel.send("inputValue", locals_to_params(locals())) + return await self._channel.send( + "inputValue", self._timeout, locals_to_params(locals()) + ) async def set_input_files( self, @@ -698,10 +803,11 @@ async def set_input_files( converted = await convert_input_files(files, self.page.context) await self._channel.send( "setInputFiles", + self._timeout, { "selector": selector, "strict": strict, - "timeout": timeout, + "timeout": self._timeout(timeout), **converted, }, ) @@ -715,7 +821,7 @@ async def type( timeout: float = None, noWaitAfter: bool = None, ) -> None: - await self._channel.send("type", locals_to_params(locals())) + await self._channel.send("type", self._timeout, locals_to_params(locals())) async def press( self, @@ -726,7 +832,7 @@ async def press( timeout: float = None, noWaitAfter: bool = None, ) -> None: - await self._channel.send("press", locals_to_params(locals())) + await self._channel.send("press", self._timeout, locals_to_params(locals())) async def check( self, @@ -738,7 +844,7 @@ async def check( strict: bool = None, trial: bool = None, ) -> None: - await self._channel.send("check", locals_to_params(locals())) + await self._channel.send("check", self._timeout, locals_to_params(locals())) async def uncheck( self, @@ -750,10 +856,10 @@ async def uncheck( strict: bool = None, trial: bool = None, ) -> None: - await self._channel.send("uncheck", locals_to_params(locals())) + await self._channel.send("uncheck", self._timeout, locals_to_params(locals())) async def wait_for_timeout(self, timeout: float) -> None: - await self._channel.send("waitForTimeout", locals_to_params(locals())) + await self._channel.send("waitForTimeout", None, {"waitTimeout": timeout}) async def wait_for_function( self, @@ -768,10 +874,12 @@ async def wait_for_function( params["arg"] = serialize_argument(arg) if polling is not None and polling != "raf": params["pollingInterval"] = polling - return from_channel(await self._channel.send("waitForFunction", params)) + return from_channel( + await self._channel.send("waitForFunction", self._timeout, params) + ) async def title(self) -> str: - return await self._channel.send("title") + return await self._channel.send("title", None) async def set_checked( self, @@ -804,4 +912,4 @@ async def set_checked( ) async def _highlight(self, selector: str) -> None: - await self._channel.send("highlight", {"selector": selector}) + await self._channel.send("highlight", None, {"selector": selector}) diff --git a/playwright/_impl/_glob.py b/playwright/_impl/_glob.py index 2d899a789..b38826996 100644 --- a/playwright/_impl/_glob.py +++ b/playwright/_impl/_glob.py @@ -11,13 +11,12 @@ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. -import re # https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_expressions#escaping escaped_chars = {"$", "^", "+", ".", "*", "(", ")", "|", "\\", "?", "{", "}", "[", "]"} -def glob_to_regex(glob: str) -> "re.Pattern[str]": +def glob_to_regex_pattern(glob: str) -> str: tokens = ["^"] in_group = False @@ -29,40 +28,38 @@ def glob_to_regex(glob: str) -> "re.Pattern[str]": tokens.append("\\" + char if char in escaped_chars else char) i += 1 elif c == "*": - before_deep = glob[i - 1] if i > 0 else None + char_before = glob[i - 1] if i > 0 else None star_count = 1 while i + 1 < len(glob) and glob[i + 1] == "*": star_count += 1 i += 1 - after_deep = glob[i + 1] if i + 1 < len(glob) else None - is_deep = ( - star_count > 1 - and (before_deep == "/" or before_deep is None) - and (after_deep == "/" or after_deep is None) - ) - if is_deep: - tokens.append("((?:[^/]*(?:/|$))*)") - i += 1 + if star_count > 1: + char_after = glob[i + 1] if i + 1 < len(glob) else None + if char_after == "/": + if char_before == "/": + tokens.append("((.+/)|)") + else: + tokens.append("(.*/)") + i += 1 + else: + tokens.append("(.*)") else: tokens.append("([^/]*)") else: - if c == "?": - tokens.append(".") - elif c == "[": - tokens.append("[") - elif c == "]": - tokens.append("]") - elif c == "{": + if c == "{": in_group = True tokens.append("(") elif c == "}": in_group = False tokens.append(")") - elif c == "," and in_group: - tokens.append("|") + elif c == ",": + if in_group: + tokens.append("|") + else: + tokens.append("\\" + c) else: tokens.append("\\" + c if c in escaped_chars else c) i += 1 tokens.append("$") - return re.compile("".join(tokens)) + return "".join(tokens) diff --git a/playwright/_impl/_har_router.py b/playwright/_impl/_har_router.py index 33ff37871..1fa1b0433 100644 --- a/playwright/_impl/_har_router.py +++ b/playwright/_impl/_har_router.py @@ -49,7 +49,7 @@ async def create( not_found_action: RouteFromHarNotFoundPolicy, url_matcher: Optional[URLMatch] = None, ) -> "HarRouter": - har_id = await local_utils._channel.send("harOpen", {"file": file}) + har_id = await local_utils._channel.send("harOpen", None, {"file": file}) return HarRouter( local_utils=local_utils, har_id=har_id, @@ -118,5 +118,5 @@ async def add_page_route(self, page: "Page") -> None: def dispose(self) -> None: asyncio.create_task( - self._local_utils._channel.send("harClose", {"harId": self._har_id}) + self._local_utils._channel.send("harClose", None, {"harId": self._har_id}) ) diff --git a/playwright/_impl/_helper.py b/playwright/_impl/_helper.py index a27f4a789..1d7e4f67b 100644 --- a/playwright/_impl/_helper.py +++ b/playwright/_impl/_helper.py @@ -29,12 +29,13 @@ Optional, Pattern, Set, + Tuple, TypedDict, TypeVar, Union, cast, ) -from urllib.parse import urljoin +from urllib.parse import ParseResult, urljoin, urlparse, urlunparse from playwright._impl._api_structures import NameValue from playwright._impl._errors import ( @@ -44,13 +45,13 @@ is_target_closed_error, rewrite_error, ) -from playwright._impl._glob import glob_to_regex +from playwright._impl._glob import glob_to_regex_pattern from playwright._impl._greenlets import RouteGreenlet from playwright._impl._str_utils import escape_regex_flags if TYPE_CHECKING: # pragma: no cover from playwright._impl._api_structures import HeadersArray - from playwright._impl._network import Request, Response, Route + from playwright._impl._network import Request, Response, Route, WebSocketRoute URLMatch = Union[str, Pattern[str], Callable[[str], bool]] URLMatchRequest = Union[str, Pattern[str], Callable[["Request"], bool]] @@ -58,9 +59,11 @@ RouteHandlerCallback = Union[ Callable[["Route"], Any], Callable[["Route", "Request"], Any] ] +WebSocketRouteHandlerCallback = Callable[["WebSocketRoute"], Any] ColorScheme = Literal["dark", "light", "no-preference", "null"] ForcedColors = Literal["active", "none", "null"] +Contrast = Literal["more", "no-preference", "null"] ReducedMotion = Literal["no-preference", "null", "reduce"] DocumentLoadState = Literal["commit", "domcontentloaded", "load", "networkidle"] KeyboardModifier = Literal["Alt", "Control", "ControlOrMeta", "Meta", "Shift"] @@ -141,27 +144,131 @@ class FrameNavigatedEvent(TypedDict): Env = Dict[str, Union[str, float, bool]] -class URLMatcher: - def __init__(self, base_url: Union[str, None], match: URLMatch) -> None: - self._callback: Optional[Callable[[str], bool]] = None - self._regex_obj: Optional[Pattern[str]] = None - if isinstance(match, str): - if base_url and not match.startswith("*"): - match = urljoin(base_url, match) - regex = glob_to_regex(match) - self._regex_obj = re.compile(regex) - elif isinstance(match, Pattern): - self._regex_obj = match +def url_matches( + base_url: Optional[str], + url_string: str, + match: Optional[URLMatch], + websocket_url: bool = None, +) -> bool: + if not match: + return True + if isinstance(match, str): + match = re.compile( + resolve_glob_to_regex_pattern(base_url, match, websocket_url) + ) + if isinstance(match, Pattern): + return bool(match.search(url_string)) + return match(url_string) + + +def resolve_glob_to_regex_pattern( + base_url: Optional[str], glob: str, websocket_url: bool = None +) -> str: + if websocket_url: + base_url = to_websocket_base_url(base_url) + glob = resolve_glob_base(base_url, glob) + return glob_to_regex_pattern(glob) + + +def to_websocket_base_url(base_url: Optional[str]) -> Optional[str]: + if base_url is not None and re.match(r"^https?://", base_url): + base_url = re.sub(r"^http", "ws", base_url) + return base_url + + +def resolve_glob_base(base_url: Optional[str], match: str) -> str: + if match[0] == "*": + return match + + token_map: Dict[str, str] = {} + + def map_token(original: str, replacement: str) -> str: + if len(original) == 0: + return "" + token_map[replacement] = original + return replacement + + # Escaped `\\?` behaves the same as `?` in our glob patterns. + match = match.replace(r"\\?", "?") + # Special case about: URLs as they are not relative to base_url + if ( + match.startswith("about:") + or match.startswith("data:") + or match.startswith("chrome:") + or match.startswith("edge:") + or match.startswith("file:") + ): + # about: and data: URLs are not relative to base_url, so we return them as is. + return match + # Glob symbols may be escaped in the URL and some of them such as ? affect resolution, + # so we replace them with safe components first. + processed_parts = [] + for index, token in enumerate(match.split("/")): + if token in (".", "..", ""): + processed_parts.append(token) + continue + # Handle special case of http*://, note that the new schema has to be + # a web schema so that slashes are properly inserted after domain. + if index == 0 and token.endswith(":"): + # Replace any pattern with http: + if "*" in token or "{" in token: + processed_parts.append(map_token(token, "http:")) + else: + # Preserve explicit schema as is as it may affect trailing slashes after domain. + processed_parts.append(token) + continue + question_index = token.find("?") + if question_index == -1: + processed_parts.append(map_token(token, f"$_{index}_$")) else: - self._callback = match - self.match = match + new_prefix = map_token(token[:question_index], f"$_{index}_$") + new_suffix = map_token(token[question_index:], f"?$_{index}_$") + processed_parts.append(new_prefix + new_suffix) + + relative_path = "/".join(processed_parts) + resolved, case_insensitive_part = resolve_base_url(base_url, relative_path) + + for token, original in token_map.items(): + normalize = case_insensitive_part and token in case_insensitive_part + resolved = resolved.replace( + token, original.lower() if normalize else original, 1 + ) + + return resolved + + +def resolve_base_url( + base_url: Optional[str], given_url: str +) -> Tuple[str, Optional[str]]: + try: + url = nodelike_urlparse( + urljoin(base_url if base_url is not None else "", given_url) + ) + resolved = urlunparse(url) + # Schema and domain are case-insensitive. + hostname_port = ( + url.hostname or "" + ) # can't use parsed.netloc because it includes userinfo (username:password) + if url.port: + hostname_port += f":{url.port}" + case_insensitive_prefix = f"{url.scheme}://{hostname_port}" + return resolved, case_insensitive_prefix + except Exception: + return given_url, None + - def matches(self, url: str) -> bool: - if self._callback: - return self._callback(url) - if self._regex_obj: - return cast(bool, self._regex_obj.search(url)) - return False +def nodelike_urlparse(url: str) -> ParseResult: + parsed = urlparse(url, allow_fragments=True) + + # https://url.spec.whatwg.org/#special-scheme + is_special_url = parsed.scheme in ["http", "https", "ws", "wss", "ftp", "file"] + if is_special_url: + # special urls have a list path, list paths are serialized as follows: https://url.spec.whatwg.org/#url-path-serializer + # urllib diverges, so we patch it here + if parsed.path == "": + parsed = parsed._replace(path="/") + + return parsed class HarLookupResult(TypedDict, total=False): @@ -173,7 +280,21 @@ class HarLookupResult(TypedDict, total=False): body: Optional[str] +DEFAULT_PLAYWRIGHT_TIMEOUT_IN_MILLISECONDS = 30000 +DEFAULT_PLAYWRIGHT_LAUNCH_TIMEOUT_IN_MILLISECONDS = 180000 +PLAYWRIGHT_MAX_DEADLINE = 2147483647 # 2^31-1 + + class TimeoutSettings: + + @staticmethod + def launch_timeout(timeout: Optional[float] = None) -> float: + return ( + timeout + if timeout is not None + else DEFAULT_PLAYWRIGHT_LAUNCH_TIMEOUT_IN_MILLISECONDS + ) + def __init__(self, parent: Optional["TimeoutSettings"]) -> None: self._parent = parent self._default_timeout: Optional[float] = None @@ -189,7 +310,7 @@ def timeout(self, timeout: float = None) -> float: return self._default_timeout if self._parent: return self._parent.timeout() - return 30000 + return DEFAULT_PLAYWRIGHT_TIMEOUT_IN_MILLISECONDS def set_default_navigation_timeout( self, navigation_timeout: Optional[float] @@ -202,12 +323,16 @@ def default_navigation_timeout(self) -> Optional[float]: def default_timeout(self) -> Optional[float]: return self._default_timeout - def navigation_timeout(self) -> float: + def navigation_timeout(self, timeout: float = None) -> float: + if timeout is not None: + return timeout if self._default_navigation_timeout is not None: return self._default_navigation_timeout + if self._default_timeout is not None: + return self._default_timeout if self._parent: return self._parent.navigation_timeout() - return 30000 + return DEFAULT_PLAYWRIGHT_TIMEOUT_IN_MILLISECONDS def serialize_error(ex: Exception, tb: Optional[TracebackType]) -> ErrorPayload: @@ -270,12 +395,14 @@ def __init__(self, complete: "asyncio.Future", route: "Route") -> None: class RouteHandler: def __init__( self, - matcher: URLMatcher, + base_url: Optional[str], + url: URLMatch, handler: RouteHandlerCallback, is_sync: bool, times: Optional[int] = None, ): - self.matcher = matcher + self._base_url = base_url + self.url = url self.handler = handler self._times = times if times else math.inf self._handled_count = 0 @@ -284,7 +411,7 @@ def __init__( self._active_invocations: Set[RouteHandlerInvocation] = set() def matches(self, request_url: str) -> bool: - return self.matcher.matches(request_url) + return url_matches(self._base_url, request_url, self.url) async def handle(self, route: "Route") -> bool: handler_invocation = RouteHandlerInvocation( @@ -361,13 +488,13 @@ def prepare_interception_patterns( patterns = [] all = False for handler in handlers: - if isinstance(handler.matcher.match, str): - patterns.append({"glob": handler.matcher.match}) - elif isinstance(handler.matcher._regex_obj, re.Pattern): + if isinstance(handler.url, str): + patterns.append({"glob": handler.url}) + elif isinstance(handler.url, re.Pattern): patterns.append( { - "regexSource": handler.matcher._regex_obj.pattern, - "regexFlags": escape_regex_flags(handler.matcher._regex_obj), + "regexSource": handler.url.pattern, + "regexFlags": escape_regex_flags(handler.url), } ) else: diff --git a/playwright/_impl/_impl_to_api_mapping.py b/playwright/_impl/_impl_to_api_mapping.py index 4315e1868..e26d22025 100644 --- a/playwright/_impl/_impl_to_api_mapping.py +++ b/playwright/_impl/_impl_to_api_mapping.py @@ -117,7 +117,7 @@ def to_impl( except RecursionError: raise Error("Maximum argument depth exceeded") - def wrap_handler(self, handler: Callable[..., None]) -> Callable[..., None]: + def wrap_handler(self, handler: Callable[..., Any]) -> Callable[..., None]: def wrapper_func(*args: Any) -> Any: arg_count = len(inspect.signature(handler).parameters) return handler( diff --git a/playwright/_impl/_input.py b/playwright/_impl/_input.py index a97ba5d11..8a39242ee 100644 --- a/playwright/_impl/_input.py +++ b/playwright/_impl/_input.py @@ -23,19 +23,19 @@ def __init__(self, channel: Channel) -> None: self._dispatcher_fiber = channel._connection._dispatcher_fiber async def down(self, key: str) -> None: - await self._channel.send("keyboardDown", locals_to_params(locals())) + await self._channel.send("keyboardDown", None, locals_to_params(locals())) async def up(self, key: str) -> None: - await self._channel.send("keyboardUp", locals_to_params(locals())) + await self._channel.send("keyboardUp", None, locals_to_params(locals())) async def insert_text(self, text: str) -> None: - await self._channel.send("keyboardInsertText", locals_to_params(locals())) + await self._channel.send("keyboardInsertText", None, locals_to_params(locals())) async def type(self, text: str, delay: float = None) -> None: - await self._channel.send("keyboardType", locals_to_params(locals())) + await self._channel.send("keyboardType", None, locals_to_params(locals())) async def press(self, key: str, delay: float = None) -> None: - await self._channel.send("keyboardPress", locals_to_params(locals())) + await self._channel.send("keyboardPress", None, locals_to_params(locals())) class Mouse: @@ -45,21 +45,34 @@ def __init__(self, channel: Channel) -> None: self._dispatcher_fiber = channel._connection._dispatcher_fiber async def move(self, x: float, y: float, steps: int = None) -> None: - await self._channel.send("mouseMove", locals_to_params(locals())) + await self._channel.send("mouseMove", None, locals_to_params(locals())) async def down( self, button: MouseButton = None, clickCount: int = None, ) -> None: - await self._channel.send("mouseDown", locals_to_params(locals())) + await self._channel.send("mouseDown", None, locals_to_params(locals())) async def up( self, button: MouseButton = None, clickCount: int = None, ) -> None: - await self._channel.send("mouseUp", locals_to_params(locals())) + await self._channel.send("mouseUp", None, locals_to_params(locals())) + + async def _click( + self, + x: float, + y: float, + delay: float = None, + button: MouseButton = None, + clickCount: int = None, + title: str = None, + ) -> None: + await self._channel.send( + "mouseClick", None, locals_to_params(locals()), title=title + ) async def click( self, @@ -69,7 +82,9 @@ async def click( button: MouseButton = None, clickCount: int = None, ) -> None: - await self._channel.send("mouseClick", locals_to_params(locals())) + params = locals() + del params["self"] + await self._click(**params) async def dblclick( self, @@ -78,10 +93,12 @@ async def dblclick( delay: float = None, button: MouseButton = None, ) -> None: - await self.click(x, y, delay=delay, button=button, clickCount=2) + await self._click( + x, y, delay=delay, button=button, clickCount=2, title="Double click" + ) async def wheel(self, deltaX: float, deltaY: float) -> None: - await self._channel.send("mouseWheel", locals_to_params(locals())) + await self._channel.send("mouseWheel", None, locals_to_params(locals())) class Touchscreen: @@ -91,4 +108,4 @@ def __init__(self, channel: Channel) -> None: self._dispatcher_fiber = channel._connection._dispatcher_fiber async def tap(self, x: float, y: float) -> None: - await self._channel.send("touchscreenTap", locals_to_params(locals())) + await self._channel.send("touchscreenTap", None, locals_to_params(locals())) diff --git a/playwright/_impl/_js_handle.py b/playwright/_impl/_js_handle.py index a8be0ee18..84ef40d18 100644 --- a/playwright/_impl/_js_handle.py +++ b/playwright/_impl/_js_handle.py @@ -12,9 +12,11 @@ # See the License for the specific language governing permissions and # limitations under the License. +import base64 import collections.abc import datetime import math +import struct import traceback from pathlib import Path from typing import TYPE_CHECKING, Any, Dict, List, Optional, Union @@ -69,6 +71,7 @@ async def evaluate(self, expression: str, arg: Serializable = None) -> Any: return parse_result( await self._channel.send( "evaluateExpression", + None, dict( expression=expression, arg=serialize_argument(arg), @@ -82,6 +85,7 @@ async def evaluate_handle( return from_channel( await self._channel.send( "evaluateExpressionHandle", + None, dict( expression=expression, arg=serialize_argument(arg), @@ -91,13 +95,16 @@ async def evaluate_handle( async def get_property(self, propertyName: str) -> "JSHandle": return from_channel( - await self._channel.send("getProperty", dict(name=propertyName)) + await self._channel.send("getProperty", None, dict(name=propertyName)) ) async def get_properties(self) -> Dict[str, "JSHandle"]: return { prop["name"]: from_channel(prop["value"]) - for prop in await self._channel.send("getPropertyList") + for prop in await self._channel.send( + "getPropertyList", + None, + ) } def as_element(self) -> Optional["ElementHandle"]: @@ -105,13 +112,21 @@ def as_element(self) -> Optional["ElementHandle"]: async def dispose(self) -> None: try: - await self._channel.send("dispose") + await self._channel.send( + "dispose", + None, + ) except Exception as e: if not is_target_closed_error(e): raise e async def json_value(self) -> Any: - return parse_result(await self._channel.send("jsonValue")) + return parse_result( + await self._channel.send( + "jsonValue", + None, + ) + ) def serialize_value( @@ -145,13 +160,17 @@ def serialize_value( return { "e": { "m": str(value), - "n": (value.name or "") - if isinstance(value, Error) - else value.__class__.__name__, - "s": (value.stack or "") - if isinstance(value, Error) - else "".join( - traceback.format_exception(type(value), value=value, tb=None) + "n": ( + (value.name or "") + if isinstance(value, Error) + else value.__class__.__name__ + ), + "s": ( + (value.stack or "") + if isinstance(value, Error) + else "".join( + traceback.format_exception(type(value), value=value, tb=None) + ) ), } } @@ -256,6 +275,56 @@ def parse_value(value: Any, refs: Optional[Dict[int, Any]] = None) -> Any: if "b" in value: return value["b"] + + if "ta" in value: + encoded_bytes = value["ta"]["b"] + decoded_bytes = base64.b64decode(encoded_bytes) + array_type = value["ta"]["k"] + if array_type == "i8": + word_size = 1 + fmt = "b" + elif array_type == "ui8" or array_type == "ui8c": + word_size = 1 + fmt = "B" + elif array_type == "i16": + word_size = 2 + fmt = "h" + elif array_type == "ui16": + word_size = 2 + fmt = "H" + elif array_type == "i32": + word_size = 4 + fmt = "i" + elif array_type == "ui32": + word_size = 4 + fmt = "I" + elif array_type == "f32": + word_size = 4 + fmt = "f" + elif array_type == "f64": + word_size = 8 + fmt = "d" + elif array_type == "bi64": + word_size = 8 + fmt = "q" + elif array_type == "bui64": + word_size = 8 + fmt = "Q" + else: + raise ValueError(f"Unsupported array type: {array_type}") + + byte_len = len(decoded_bytes) + if byte_len % word_size != 0: + raise ValueError( + f"Decoded bytes length {byte_len} is not a multiple of word size {word_size}" + ) + + if byte_len == 0: + return [] + array_len = byte_len // word_size + # "<" denotes little-endian + format_string = f"<{array_len}{fmt}" + return list(struct.unpack(format_string, decoded_bytes)) return value diff --git a/playwright/_impl/_json_pipe.py b/playwright/_impl/_json_pipe.py index f76bc7175..41973b8c7 100644 --- a/playwright/_impl/_json_pipe.py +++ b/playwright/_impl/_json_pipe.py @@ -33,11 +33,10 @@ def __init__( Transport.__init__(self, loop) self._stop_requested = False self._pipe_channel = pipe_channel - self._loop: asyncio.AbstractEventLoop def request_stop(self) -> None: self._stop_requested = True - self._pipe_channel.send_no_reply("close", {}) + self._pipe_channel.send_no_reply("close", None, {}) def dispose(self) -> None: self.on_error_future.cancel() @@ -75,4 +74,4 @@ async def run(self) -> None: def send(self, message: Dict) -> None: if self._stop_requested: raise Error("Playwright connection closed") - self._pipe_channel.send_no_reply("send", {"message": message}) + self._pipe_channel.send_no_reply("send", None, {"message": message}) diff --git a/playwright/_impl/_local_utils.py b/playwright/_impl/_local_utils.py index 7172ee58a..c2d2d3fca 100644 --- a/playwright/_impl/_local_utils.py +++ b/playwright/_impl/_local_utils.py @@ -31,11 +31,11 @@ def __init__( } async def zip(self, params: Dict) -> None: - await self._channel.send("zip", params) + await self._channel.send("zip", None, params) async def har_open(self, file: str) -> None: params = locals_to_params(locals()) - await self._channel.send("harOpen", params) + await self._channel.send("harOpen", None, params) async def har_lookup( self, @@ -51,27 +51,28 @@ async def har_lookup( params["postData"] = base64.b64encode(params["postData"]).decode() return cast( HarLookupResult, - await self._channel.send_return_as_dict("harLookup", params), + await self._channel.send_return_as_dict("harLookup", None, params), ) async def har_close(self, harId: str) -> None: params = locals_to_params(locals()) - await self._channel.send("harClose", params) + await self._channel.send("harClose", None, params) async def har_unzip(self, zipFile: str, harFile: str) -> None: params = locals_to_params(locals()) - await self._channel.send("harUnzip", params) + await self._channel.send("harUnzip", None, params) async def tracing_started(self, tracesDir: Optional[str], traceName: str) -> str: params = locals_to_params(locals()) - return await self._channel.send("tracingStarted", params) + return await self._channel.send("tracingStarted", None, params) async def trace_discarded(self, stacks_id: str) -> None: - return await self._channel.send("traceDiscarded", {"stacksId": stacks_id}) + return await self._channel.send("traceDiscarded", None, {"stacksId": stacks_id}) def add_stack_to_tracing_no_reply(self, id: int, frames: List[StackFrame]) -> None: self._channel.send_no_reply( "addStackToTracingNoReply", + None, { "callData": { "stack": frames, diff --git a/playwright/_impl/_locator.py b/playwright/_impl/_locator.py index 521897978..2e6a7abed 100644 --- a/playwright/_impl/_locator.py +++ b/playwright/_impl/_locator.py @@ -14,6 +14,7 @@ import json import pathlib +import re from typing import ( TYPE_CHECKING, Any, @@ -47,7 +48,7 @@ monotonic_time, to_impl, ) -from playwright._impl._js_handle import Serializable, parse_value, serialize_argument +from playwright._impl._js_handle import Serializable from playwright._impl._str_utils import ( escape_for_attribute_selector, escape_for_text_selector, @@ -70,6 +71,7 @@ def __init__( has_not_text: Union[str, Pattern[str]] = None, has: "Locator" = None, has_not: "Locator" = None, + visible: bool = None, ) -> None: self._frame = frame self._selector = selector @@ -95,6 +97,9 @@ def __init__( raise Error('Inner "has_not" locator must belong to the same frame.') self._selector += " >> internal:has-not=" + json.dumps(locator._selector) + if visible is not None: + self._selector += f" >> visible={bool_to_js_bool(visible)}" + def __repr__(self) -> str: return f"" @@ -103,7 +108,7 @@ async def _with_element( task: Callable[[ElementHandle, float], Awaitable[T]], timeout: float = None, ) -> T: - timeout = self._frame.page._timeout_settings.timeout(timeout) + timeout = self._frame._timeout(timeout) deadline = (monotonic_time() + timeout) if timeout else 0 handle = await self.element_handle(timeout=timeout) if not handle: @@ -151,9 +156,10 @@ async def click( force: bool = None, noWaitAfter: bool = None, trial: bool = None, + steps: int = None, ) -> None: params = locals_to_params(locals()) - return await self._frame.click(self._selector, strict=True, **params) + return await self._frame._click(self._selector, strict=True, **params) async def dblclick( self, @@ -165,6 +171,7 @@ async def dblclick( force: bool = None, noWaitAfter: bool = None, trial: bool = None, + steps: int = None, ) -> None: params = locals_to_params(locals()) return await self._frame.dblclick(self._selector, strict=True, **params) @@ -213,7 +220,8 @@ async def clear( noWaitAfter: bool = None, force: bool = None, ) -> None: - await self.fill("", timeout=timeout, force=force) + params = locals_to_params(locals()) + await self._frame._fill(self._selector, value="", title="Clear", **params) def locator( self, @@ -332,12 +340,33 @@ def nth(self, index: int) -> "Locator": def content_frame(self) -> "FrameLocator": return FrameLocator(self._frame, self._selector) + def describe(self, description: str) -> "Locator": + return Locator( + self._frame, + f"{self._selector} >> internal:describe={json.dumps(description)}", + ) + + @property + def description(self) -> Optional[str]: + try: + match = re.search( + r' >> internal:describe=("(?:[^"\\]|\\.)*")$', self._selector + ) + if match: + description = json.loads(match.group(1)) + if isinstance(description, str): + return description + except (json.JSONDecodeError, ValueError): + pass + return None + def filter( self, hasText: Union[str, Pattern[str]] = None, hasNotText: Union[str, Pattern[str]] = None, has: "Locator" = None, hasNot: "Locator" = None, + visible: bool = None, ) -> "Locator": return Locator( self._frame, @@ -346,6 +375,7 @@ def filter( has_not_text=hasNotText, has=has, has_not=hasNot, + visible=visible, ) def or_(self, locator: "Locator") -> "Locator": @@ -371,6 +401,7 @@ async def focus(self, timeout: float = None) -> None: async def blur(self, timeout: float = None) -> None: await self._frame._channel.send( "blur", + self._frame._timeout, { "selector": self._selector, "strict": True, @@ -400,6 +431,7 @@ async def drag_to( trial: bool = None, sourcePosition: Position = None, targetPosition: Position = None, + steps: int = None, ) -> None: params = locals_to_params(locals()) del params["target"] @@ -481,26 +513,24 @@ async def is_editable(self, timeout: float = None) -> bool: async def is_enabled(self, timeout: float = None) -> bool: params = locals_to_params(locals()) - return await self._frame.is_editable( + return await self._frame.is_enabled( self._selector, strict=True, **params, ) async def is_hidden(self, timeout: float = None) -> bool: - params = locals_to_params(locals()) + # timeout is deprecated and does nothing return await self._frame.is_hidden( self._selector, strict=True, - **params, ) async def is_visible(self, timeout: float = None) -> bool: - params = locals_to_params(locals()) + # timeout is deprecated and does nothing return await self._frame.is_visible( self._selector, strict=True, - **params, ) async def press( @@ -534,6 +564,16 @@ async def screenshot( ), ) + async def aria_snapshot(self, timeout: float = None) -> str: + return await self._frame._channel.send( + "ariaSnapshot", + self._frame._timeout, + { + "selector": self._selector, + **locals_to_params(locals()), + }, + ) + async def scroll_into_view_if_needed( self, timeout: float = None, @@ -696,21 +736,12 @@ async def set_checked( ) async def _expect( - self, expression: str, options: FrameExpectOptions + self, + expression: str, + options: FrameExpectOptions, + title: str = None, ) -> FrameExpectResult: - if "expectedValue" in options: - options["expectedValue"] = serialize_argument(options["expectedValue"]) - result = await self._frame._channel.send_return_as_dict( - "expect", - { - "selector": self._selector, - "expression": expression, - **options, - }, - ) - if result.get("received"): - result["received"] = parse_value(result["received"]) - return result + return await self._frame._expect(self._selector, expression, options, title) async def highlight(self) -> None: await self._frame._highlight(self._selector) diff --git a/playwright/_impl/_network.py b/playwright/_impl/_network.py index 91c2a460c..9f2c29f6e 100644 --- a/playwright/_impl/_network.py +++ b/playwright/_impl/_network.py @@ -18,6 +18,7 @@ import json import json as json_utils import mimetypes +import re from collections import defaultdict from pathlib import Path from types import SimpleNamespace @@ -51,14 +52,21 @@ ) from playwright._impl._errors import Error from playwright._impl._event_context_manager import EventContextManagerImpl -from playwright._impl._helper import async_readfile, locals_to_params +from playwright._impl._helper import ( + URLMatch, + WebSocketRouteHandlerCallback, + async_readfile, + locals_to_params, + url_matches, +) +from playwright._impl._str_utils import escape_regex_flags from playwright._impl._waiter import Waiter if TYPE_CHECKING: # pragma: no cover from playwright._impl._browser_context import BrowserContext from playwright._impl._fetch import APIResponse from playwright._impl._frame import Frame - from playwright._impl._page import Page + from playwright._impl._page import Page, Worker class FallbackOverrideParameters(TypedDict, total=False): @@ -176,6 +184,13 @@ def url(self) -> str: def resource_type(self) -> str: return self._initializer["resourceType"] + @property + def service_worker(self) -> Optional["Worker"]: + return cast( + Optional["Worker"], + from_nullable_channel(self._initializer.get("serviceWorker")), + ) + @property def method(self) -> str: return cast(str, self._fallback_overrides.method or self._initializer["method"]) @@ -184,7 +199,10 @@ async def sizes(self) -> RequestSizes: response = await self.response() if not response: raise Error("Unable to fetch sizes for failed request") - return await response._channel.send("sizes") + return await response._channel.send( + "sizes", + None, + ) @property def post_data(self) -> Optional[str]: @@ -218,7 +236,12 @@ def post_data_buffer(self) -> Optional[bytes]: return None async def response(self) -> Optional["Response"]: - return from_nullable_channel(await self._channel.send("response")) + return from_nullable_channel( + await self._channel.send( + "response", + None, + ) + ) @property def frame(self) -> "Frame": @@ -283,7 +306,9 @@ async def _actual_headers(self) -> "RawHeaders": return RawHeaders(serialize_headers(override)) if not self._all_headers_future: self._all_headers_future = asyncio.Future() - headers = await self._channel.send("rawRequestHeaders") + headers = await self._channel.send( + "rawRequestHeaders", None, is_internal=True + ) self._all_headers_future.set_result(RawHeaders(headers)) return await self._all_headers_future @@ -340,9 +365,9 @@ async def abort(self, errorCode: str = None) -> None: lambda: self._race_with_page_close( self._channel.send( "abort", + None, { "errorCode": errorCode, - "requestUrl": self.request._initializer["url"], }, ) ) @@ -425,9 +450,8 @@ async def _inner_fulfill( if length and "content-length" not in headers: headers["content-length"] = str(length) params["headers"] = serialize_headers(headers) - params["requestUrl"] = self.request._initializer["url"] - await self._race_with_page_close(self._channel.send("fulfill", params)) + await self._race_with_page_close(self._channel.send("fulfill", None, params)) async def _handle_route(self, callback: Callable) -> None: self._check_not_handled() @@ -484,48 +508,36 @@ async def continue_( async def _inner() -> None: self.request._apply_fallback_overrides(overrides) - await self._internal_continue() + await self._inner_continue(False) return await self._handle_route(_inner) - def _internal_continue( - self, is_internal: bool = False - ) -> Coroutine[Any, Any, None]: - async def continue_route() -> None: - try: - params: Dict[str, Any] = {} - params["url"] = self.request._fallback_overrides.url - params["method"] = self.request._fallback_overrides.method - params["headers"] = self.request._fallback_overrides.headers - if self.request._fallback_overrides.post_data_buffer is not None: - params["postData"] = base64.b64encode( - self.request._fallback_overrides.post_data_buffer - ).decode() - params = locals_to_params(params) - - if "headers" in params: - params["headers"] = serialize_headers(params["headers"]) - params["requestUrl"] = self.request._initializer["url"] - params["isFallback"] = is_internal - await self._connection.wrap_api_call( - lambda: self._race_with_page_close( - self._channel.send( - "continue", - params, - ) + async def _inner_continue(self, is_fallback: bool = False) -> None: + options = self.request._fallback_overrides + await self._race_with_page_close( + self._channel.send( + "continue", + None, + { + "url": options.url, + "method": options.method, + "headers": ( + serialize_headers(options.headers) if options.headers else None ), - is_internal, - ) - except Exception as e: - if not is_internal: - raise e - - return continue_route() + "postData": ( + base64.b64encode(options.post_data_buffer).decode() + if options.post_data_buffer is not None + else None + ), + "isFallback": is_fallback, + }, + ) + ) async def _redirected_navigation_request(self, url: str) -> None: await self._handle_route( lambda: self._race_with_page_close( - self._channel.send("redirectNavigationRequest", {"url": url}) + self._channel.send("redirectNavigationRequest", None, {"url": url}) ) ) @@ -535,7 +547,7 @@ async def _race_with_page_close(self, future: Coroutine) -> None: setattr( fut, "__pw_stack__", - getattr(asyncio.current_task(self._loop), "__pw_stack__", inspect.stack()), + getattr(asyncio.current_task(self._loop), "__pw_stack__", inspect.stack(0)), ) target_closed_future = self.request._target_closed_future() await asyncio.wait( @@ -548,6 +560,239 @@ async def _race_with_page_close(self, future: Coroutine) -> None: await asyncio.gather(fut, return_exceptions=True) +def _create_task_and_ignore_exception( + loop: asyncio.AbstractEventLoop, coro: Coroutine +) -> None: + async def _ignore_exception() -> None: + try: + await coro + except Exception: + pass + + loop.create_task(_ignore_exception()) + + +class ServerWebSocketRoute: + def __init__(self, ws: "WebSocketRoute"): + self._ws = ws + + def on_message(self, handler: Callable[[Union[str, bytes]], Any]) -> None: + self._ws._on_server_message = handler + + def on_close(self, handler: Callable[[Optional[int], Optional[str]], Any]) -> None: + self._ws._on_server_close = handler + + def connect_to_server(self) -> None: + raise NotImplementedError( + "connectToServer must be called on the page-side WebSocketRoute" + ) + + @property + def url(self) -> str: + return self._ws._initializer["url"] + + def close(self, code: int = None, reason: str = None) -> None: + _create_task_and_ignore_exception( + self._ws._loop, + self._ws._channel.send( + "closeServer", + None, + { + "code": code, + "reason": reason, + "wasClean": True, + }, + ), + ) + + def send(self, message: Union[str, bytes]) -> None: + if isinstance(message, str): + _create_task_and_ignore_exception( + self._ws._loop, + self._ws._channel.send( + "sendToServer", None, {"message": message, "isBase64": False} + ), + ) + else: + _create_task_and_ignore_exception( + self._ws._loop, + self._ws._channel.send( + "sendToServer", + None, + {"message": base64.b64encode(message).decode(), "isBase64": True}, + ), + ) + + +class WebSocketRoute(ChannelOwner): + def __init__( + self, parent: ChannelOwner, type: str, guid: str, initializer: Dict + ) -> None: + super().__init__(parent, type, guid, initializer) + self._on_page_message: Optional[Callable[[Union[str, bytes]], Any]] = None + self._on_page_close: Optional[Callable[[Optional[int], Optional[str]], Any]] = ( + None + ) + self._on_server_message: Optional[Callable[[Union[str, bytes]], Any]] = None + self._on_server_close: Optional[ + Callable[[Optional[int], Optional[str]], Any] + ] = None + self._server = ServerWebSocketRoute(self) + self._connected = False + + self._channel.on("messageFromPage", self._channel_message_from_page) + self._channel.on("messageFromServer", self._channel_message_from_server) + self._channel.on("closePage", self._channel_close_page) + self._channel.on("closeServer", self._channel_close_server) + + def _channel_message_from_page(self, event: Dict) -> None: + if self._on_page_message: + self._on_page_message( + base64.b64decode(event["message"]) + if event["isBase64"] + else event["message"] + ) + elif self._connected: + _create_task_and_ignore_exception( + self._loop, self._channel.send("sendToServer", None, event) + ) + + def _channel_message_from_server(self, event: Dict) -> None: + if self._on_server_message: + self._on_server_message( + base64.b64decode(event["message"]) + if event["isBase64"] + else event["message"] + ) + else: + _create_task_and_ignore_exception( + self._loop, self._channel.send("sendToPage", None, event) + ) + + def _channel_close_page(self, event: Dict) -> None: + if self._on_page_close: + self._on_page_close(event["code"], event["reason"]) + else: + _create_task_and_ignore_exception( + self._loop, self._channel.send("closeServer", None, event) + ) + + def _channel_close_server(self, event: Dict) -> None: + if self._on_server_close: + self._on_server_close(event["code"], event["reason"]) + else: + _create_task_and_ignore_exception( + self._loop, self._channel.send("closePage", None, event) + ) + + @property + def url(self) -> str: + return self._initializer["url"] + + async def close(self, code: int = None, reason: str = None) -> None: + try: + await self._channel.send( + "closePage", None, {"code": code, "reason": reason, "wasClean": True} + ) + except Exception: + pass + + def connect_to_server(self) -> "WebSocketRoute": + if self._connected: + raise Error("Already connected to the server") + self._connected = True + asyncio.create_task( + self._channel.send( + "connect", + None, + ) + ) + return cast("WebSocketRoute", self._server) + + def send(self, message: Union[str, bytes]) -> None: + if isinstance(message, str): + _create_task_and_ignore_exception( + self._loop, + self._channel.send( + "sendToPage", None, {"message": message, "isBase64": False} + ), + ) + else: + _create_task_and_ignore_exception( + self._loop, + self._channel.send( + "sendToPage", + None, + { + "message": base64.b64encode(message).decode(), + "isBase64": True, + }, + ), + ) + + def on_message(self, handler: Callable[[Union[str, bytes]], Any]) -> None: + self._on_page_message = handler + + def on_close(self, handler: Callable[[Optional[int], Optional[str]], Any]) -> None: + self._on_page_close = handler + + async def _after_handle(self) -> None: + if self._connected: + return + # Ensure that websocket is "open" and can send messages without an actual server connection. + try: + await self._channel.send( + "ensureOpened", + None, + ) + except Exception: + pass + + +class WebSocketRouteHandler: + def __init__( + self, + base_url: Optional[str], + url: URLMatch, + handler: WebSocketRouteHandlerCallback, + ): + self._base_url = base_url + self.url = url + self.handler = handler + + @staticmethod + def prepare_interception_patterns( + handlers: List["WebSocketRouteHandler"], + ) -> List[dict]: + patterns = [] + all_urls = False + for handler in handlers: + if isinstance(handler.url, str): + patterns.append({"glob": handler.url}) + elif isinstance(handler.url, re.Pattern): + patterns.append( + { + "regexSource": handler.url.pattern, + "regexFlags": escape_regex_flags(handler.url), + } + ) + else: + all_urls = True + + if all_urls: + return [{"glob": "**/*"}] + return patterns + + def matches(self, ws_url: str) -> bool: + return url_matches(self._base_url, ws_url, self.url, True) + + async def handle(self, websocket_route: "WebSocketRoute") -> None: + coro_or_future = self.handler(websocket_route) + if asyncio.iscoroutine(coro_or_future): + await coro_or_future + await websocket_route._after_handle() + + class Response(ChannelOwner): def __init__( self, parent: ChannelOwner, type: str, guid: str, initializer: Dict @@ -614,15 +859,27 @@ async def header_values(self, name: str) -> List[str]: async def _actual_headers(self) -> "RawHeaders": if not self._raw_headers_future: self._raw_headers_future = asyncio.Future() - headers = cast(HeadersArray, await self._channel.send("rawResponseHeaders")) + headers = cast( + HeadersArray, + await self._channel.send( + "rawResponseHeaders", + None, + ), + ) self._raw_headers_future.set_result(RawHeaders(headers)) return await self._raw_headers_future async def server_addr(self) -> Optional[RemoteAddr]: - return await self._channel.send("serverAddr") + return await self._channel.send( + "serverAddr", + None, + ) async def security_details(self) -> Optional[SecurityDetails]: - return await self._channel.send("securityDetails") + return await self._channel.send( + "securityDetails", + None, + ) async def finished(self) -> None: async def on_finished() -> None: @@ -641,7 +898,10 @@ async def on_finished() -> None: await on_finished_task async def body(self) -> bytes: - binary = await self._channel.send("body") + binary = await self._channel.send( + "body", + None, + ) return base64.b64decode(binary) async def text(self) -> str: diff --git a/playwright/_impl/_object_factory.py b/playwright/_impl/_object_factory.py index 2652e41fe..b44009bc3 100644 --- a/playwright/_impl/_object_factory.py +++ b/playwright/_impl/_object_factory.py @@ -26,10 +26,15 @@ from playwright._impl._frame import Frame from playwright._impl._js_handle import JSHandle from playwright._impl._local_utils import LocalUtils -from playwright._impl._network import Request, Response, Route, WebSocket +from playwright._impl._network import ( + Request, + Response, + Route, + WebSocket, + WebSocketRoute, +) from playwright._impl._page import BindingCall, Page, Worker from playwright._impl._playwright import Playwright -from playwright._impl._selectors import SelectorsOwner from playwright._impl._stream import Stream from playwright._impl._tracing import Tracing from playwright._impl._writable_stream import WritableStream @@ -88,10 +93,10 @@ def create_remote_object( return Tracing(parent, type, guid, initializer) if type == "WebSocket": return WebSocket(parent, type, guid, initializer) + if type == "WebSocketRoute": + return WebSocketRoute(parent, type, guid, initializer) if type == "Worker": return Worker(parent, type, guid, initializer) if type == "WritableStream": return WritableStream(parent, type, guid, initializer) - if type == "Selectors": - return SelectorsOwner(parent, type, guid, initializer) return DummyObject(parent, type, guid, initializer) diff --git a/playwright/_impl/_page.py b/playwright/_impl/_page.py index 88c6da720..1f05a9048 100644 --- a/playwright/_impl/_page.py +++ b/playwright/_impl/_page.py @@ -33,7 +33,6 @@ cast, ) -from playwright._impl._accessibility import Accessibility from playwright._impl._api_structures import ( AriaRole, FilePayload, @@ -51,7 +50,7 @@ ) from playwright._impl._console_message import ConsoleMessage from playwright._impl._download import Download -from playwright._impl._element_handle import ElementHandle +from playwright._impl._element_handle import ElementHandle, determine_screenshot_type from playwright._impl._errors import Error, TargetClosedError, is_target_closed_error from playwright._impl._event_context_manager import EventContextManagerImpl from playwright._impl._file_chooser import FileChooser @@ -60,6 +59,7 @@ from playwright._impl._har_router import HarRouter from playwright._impl._helper import ( ColorScheme, + Contrast, DocumentLoadState, ForcedColors, HarMode, @@ -71,14 +71,16 @@ RouteHandlerCallback, TimeoutSettings, URLMatch, - URLMatcher, URLMatchRequest, URLMatchResponse, + WebSocketRouteHandlerCallback, async_readfile, async_writefile, locals_to_params, make_dirs_for_file, + parse_error, serialize_error, + url_matches, ) from playwright._impl._input import Keyboard, Mouse, Touchscreen from playwright._impl._js_handle import ( @@ -88,7 +90,14 @@ parse_result, serialize_argument, ) -from playwright._impl._network import Request, Response, Route, serialize_headers +from playwright._impl._network import ( + Request, + Response, + Route, + WebSocketRoute, + WebSocketRouteHandler, + serialize_headers, +) from playwright._impl._video import Video from playwright._impl._waiter import Waiter @@ -140,7 +149,6 @@ class Page(ChannelOwner): WebSocket="websocket", Worker="worker", ) - accessibility: Accessibility keyboard: Keyboard mouse: Mouse touchscreen: Touchscreen @@ -150,7 +158,6 @@ def __init__( ) -> None: super().__init__(parent, type, guid, initializer) self._browser_context = cast("BrowserContext", parent) - self.accessibility = Accessibility(self._channel) self.keyboard = Keyboard(self._channel) self.mouse = Mouse(self._channel) self.touchscreen = Touchscreen(self._channel) @@ -163,6 +170,7 @@ def __init__( self._workers: List["Worker"] = [] self._bindings: Dict[str, Any] = {} self._routes: List[RouteHandler] = [] + self._web_socket_routes: List[WebSocketRouteHandler] = [] self._owned_context: Optional["BrowserContext"] = None self._timeout_settings: TimeoutSettings = TimeoutSettings( self._browser_context._timeout_settings @@ -210,7 +218,14 @@ def __init__( self._on_route(from_channel(params["route"])) ), ) + self._channel.on( + "webSocketRoute", + lambda params: self._loop.create_task( + self._on_web_socket_route(from_channel(params["webSocketRoute"])) + ), + ) self._channel.on("video", lambda params: self._on_video(params)) + self._channel.on("viewportSizeChanged", self._on_viewport_size_changed) self._channel.on( "webSocket", lambda params: self.emit( @@ -270,7 +285,7 @@ async def _on_route(self, route: Route) -> None: route_handlers = self._routes.copy() for route_handler in route_handlers: # If the page was closed we stall all requests right away. - if self._close_was_called or self.context._close_was_called: + if self._close_was_called or self.context._closing_or_closed: return if not route_handler.matches(route.request.url): continue @@ -298,6 +313,20 @@ async def _update_interceptor_patterns_ignore_exceptions() -> None: return await self._browser_context._on_route(route) + async def _on_web_socket_route(self, web_socket_route: WebSocketRoute) -> None: + route_handler = next( + ( + route_handler + for route_handler in self._web_socket_routes + if route_handler.matches(web_socket_route.url) + ), + None, + ) + if route_handler: + await route_handler.handle(web_socket_route) + else: + await self._browser_context._on_web_socket_route(web_socket_route) + def _on_binding(self, binding_call: "BindingCall") -> None: func = self._bindings.get(binding_call._initializer["name"]) if func: @@ -313,8 +342,6 @@ def _on_close(self) -> None: self._is_closed = True if self in self._browser_context._pages: self._browser_context._pages.remove(self) - if self in self._browser_context._background_pages: - self._browser_context._background_pages.remove(self) self._dispose_har_routers() self.emit(Page.Events.Close, self) @@ -333,6 +360,9 @@ def _on_video(self, params: Any) -> None: artifact = from_channel(params["artifact"]) self._force_video()._artifact_ready(artifact) + def _on_viewport_size_changed(self, params: Any) -> None: + self._viewport_size = params["viewportSize"] + @property def context(self) -> "BrowserContext": return self._browser_context @@ -351,16 +381,12 @@ def main_frame(self) -> Frame: return self._main_frame def frame(self, name: str = None, url: URLMatch = None) -> Optional[Frame]: - matcher = ( - URLMatcher(self._browser_context._options.get("baseURL"), url) - if url - else None - ) for frame in self._frames: if name and frame.name == name: return frame - if url and matcher and matcher.matches(frame.url): + if url and url_matches(self._browser_context._base_url, frame.url, url): return frame + return None @property @@ -369,13 +395,9 @@ def frames(self) -> List[Frame]: def set_default_navigation_timeout(self, timeout: float) -> None: self._timeout_settings.set_default_navigation_timeout(timeout) - self._channel.send_no_reply( - "setDefaultNavigationTimeoutNoReply", dict(timeout=timeout) - ) def set_default_timeout(self, timeout: float) -> None: self._timeout_settings.set_default_timeout(timeout) - self._channel.send_no_reply("setDefaultTimeoutNoReply", dict(timeout=timeout)) async def query_selector( self, @@ -419,12 +441,14 @@ async def is_enabled( async def is_hidden( self, selector: str, strict: bool = None, timeout: float = None ) -> bool: - return await self._main_frame.is_hidden(**locals_to_params(locals())) + # timeout is deprecated and does nothing + return await self._main_frame.is_hidden(selector=selector, strict=strict) async def is_visible( self, selector: str, strict: bool = None, timeout: float = None ) -> bool: - return await self._main_frame.is_visible(**locals_to_params(locals())) + # timeout is deprecated and does nothing + return await self._main_frame.is_visible(selector=selector, strict=strict) async def dispatch_event( self, @@ -491,12 +515,16 @@ async def expose_binding( ) self._bindings[name] = callback await self._channel.send( - "exposeBinding", dict(name=name, needsHandle=handle or False) + "exposeBinding", + None, + dict(name=name, needsHandle=handle or False), ) async def set_extra_http_headers(self, headers: Dict[str, str]) -> None: await self._channel.send( - "setExtraHTTPHeaders", dict(headers=serialize_headers(headers)) + "setExtraHTTPHeaders", + None, + dict(headers=serialize_headers(headers)), ) @property @@ -529,7 +557,11 @@ async def reload( waitUntil: DocumentLoadState = None, ) -> Optional[Response]: return from_nullable_channel( - await self._channel.send("reload", locals_to_params(locals())) + await self._channel.send( + "reload", + self._timeout_settings.navigation_timeout, + locals_to_params(locals()), + ) ) async def wait_for_load_state( @@ -560,7 +592,11 @@ async def go_back( waitUntil: DocumentLoadState = None, ) -> Optional[Response]: return from_nullable_channel( - await self._channel.send("goBack", locals_to_params(locals())) + await self._channel.send( + "goBack", + self._timeout_settings.navigation_timeout, + locals_to_params(locals()), + ) ) async def go_forward( @@ -569,15 +605,23 @@ async def go_forward( waitUntil: DocumentLoadState = None, ) -> Optional[Response]: return from_nullable_channel( - await self._channel.send("goForward", locals_to_params(locals())) + await self._channel.send( + "goForward", + self._timeout_settings.navigation_timeout, + locals_to_params(locals()), + ) ) + async def request_gc(self) -> None: + await self._channel.send("requestGC", None) + async def emulate_media( self, media: Literal["null", "print", "screen"] = None, colorScheme: ColorScheme = None, reducedMotion: ReducedMotion = None, forcedColors: ForcedColors = None, + contrast: Contrast = None, ) -> None: params = locals_to_params(locals()) if "media" in params: @@ -594,18 +638,26 @@ async def emulate_media( params["forcedColors"] = ( "no-override" if params["forcedColors"] == "null" else forcedColors ) - await self._channel.send("emulateMedia", params) + if "contrast" in params: + params["contrast"] = ( + "no-override" if params["contrast"] == "null" else contrast + ) + await self._channel.send("emulateMedia", None, params) async def set_viewport_size(self, viewportSize: ViewportSize) -> None: self._viewport_size = viewportSize - await self._channel.send("setViewportSize", locals_to_params(locals())) + await self._channel.send( + "setViewportSize", + None, + locals_to_params(locals()), + ) @property def viewport_size(self) -> Optional[ViewportSize]: return self._viewport_size async def bring_to_front(self) -> None: - await self._channel.send("bringToFront") + await self._channel.send("bringToFront", None) async def add_init_script( self, script: str = None, path: Union[str, Path] = None @@ -616,7 +668,7 @@ async def add_init_script( ) if not isinstance(script, str): raise Error("Either path or script parameter must be specified") - await self._channel.send("addInitScript", dict(source=script)) + await self._channel.send("addInitScript", None, dict(source=script)) async def route( self, url: URLMatch, handler: RouteHandlerCallback, times: int = None @@ -624,7 +676,8 @@ async def route( self._routes.insert( 0, RouteHandler( - URLMatcher(self._browser_context._options.get("baseURL"), url), + self._browser_context._base_url, + url, handler, True if self._dispatcher_fiber else False, times, @@ -638,7 +691,7 @@ async def unroute( removed = [] remaining = [] for route in self._routes: - if route.matcher.match != url or (handler and route.handler != handler): + if route.url != url or (handler and route.handler != handler): remaining.append(route) else: removed.append(route) @@ -651,15 +704,23 @@ async def _unroute_internal( behavior: Literal["default", "ignoreErrors", "wait"] = None, ) -> None: self._routes = remaining - await self._update_interception_patterns() - if behavior is None or behavior == "default": - return - await asyncio.gather( - *map( - lambda route: route.stop(behavior), # type: ignore - removed, + if behavior is not None and behavior != "default": + await asyncio.gather( + *map( + lambda route: route.stop(behavior), # type: ignore + removed, + ) ) + await self._update_interception_patterns() + + async def route_web_socket( + self, url: URLMatch, handler: WebSocketRouteHandlerCallback + ) -> None: + self._web_socket_routes.insert( + 0, + WebSocketRouteHandler(self._browser_context._base_url, url, handler), ) + await self._update_web_socket_interception_patterns() def _dispose_har_routers(self) -> None: for router in self._har_routers: @@ -702,7 +763,19 @@ async def route_from_har( async def _update_interception_patterns(self) -> None: patterns = RouteHandler.prepare_interception_patterns(self._routes) await self._channel.send( - "setNetworkInterceptionPatterns", {"patterns": patterns} + "setNetworkInterceptionPatterns", + None, + {"patterns": patterns}, + ) + + async def _update_web_socket_interception_patterns(self) -> None: + patterns = WebSocketRouteHandler.prepare_interception_patterns( + self._web_socket_routes + ) + await self._channel.send( + "setWebSocketInterceptionPatterns", + None, + {"patterns": patterns}, ) async def screenshot( @@ -723,6 +796,8 @@ async def screenshot( ) -> bytes: params = locals_to_params(locals()) if "path" in params: + if "type" not in params: + params["type"] = determine_screenshot_type(params["path"]) del params["path"] if "mask" in params: params["mask"] = list( @@ -736,7 +811,9 @@ async def screenshot( params["mask"], ) ) - encoded_binary = await self._channel.send("screenshot", params) + encoded_binary = await self._channel.send( + "screenshot", self._timeout_settings.timeout, params + ) decoded_binary = base64.b64decode(encoded_binary) if path: make_dirs_for_file(path) @@ -750,7 +827,7 @@ async def close(self, runBeforeUnload: bool = None, reason: str = None) -> None: self._close_reason = reason self._close_was_called = True try: - await self._channel.send("close", locals_to_params(locals())) + await self._channel.send("close", None, locals_to_params(locals())) if self._owned_context: await self._owned_context.close() except Exception as e: @@ -774,7 +851,7 @@ async def click( trial: bool = None, strict: bool = None, ) -> None: - return await self._main_frame.click(**locals_to_params(locals())) + return await self._main_frame._click(**locals_to_params(locals())) async def dblclick( self, @@ -937,6 +1014,7 @@ async def drag_and_drop( timeout: float = None, strict: bool = None, trial: bool = None, + steps: int = None, ) -> None: return await self._main_frame.drag_and_drop(**locals_to_params(locals())) @@ -1049,7 +1127,9 @@ async def pause(self) -> None: try: await asyncio.wait( [ - asyncio.create_task(self._browser_context._channel.send("pause")), + asyncio.create_task( + self._browser_context._channel.send("pause", None) + ), self._closed_or_crashed_future, ], return_when=asyncio.FIRST_COMPLETED, @@ -1081,7 +1161,7 @@ async def pdf( params = locals_to_params(locals()) if "path" in params: del params["path"] - encoded_binary = await self._channel.send("pdf", params) + encoded_binary = await self._channel.send("pdf", None, params) decoded_binary = base64.b64decode(encoded_binary) if path: make_dirs_for_file(path) @@ -1100,7 +1180,7 @@ def video( # Note: we are creating Video object lazily, because we do not know # BrowserContextOptions when constructing the page - it is assigned # too late during launchPersistentContext. - if not self._browser_context._options.get("recordVideo"): + if not self._browser_context._videos_dir: return None return self._force_video() @@ -1184,21 +1264,14 @@ def expect_request( urlOrPredicate: URLMatchRequest, timeout: float = None, ) -> EventContextManagerImpl[Request]: - matcher = ( - None - if callable(urlOrPredicate) - else URLMatcher( - self._browser_context._options.get("baseURL"), urlOrPredicate - ) - ) - predicate = urlOrPredicate if callable(urlOrPredicate) else None - def my_predicate(request: Request) -> bool: - if matcher: - return matcher.matches(request.url) - if predicate: - return predicate(request) - return True + if not callable(urlOrPredicate): + return url_matches( + self._browser_context._base_url, + request.url, + urlOrPredicate, + ) + return urlOrPredicate(request) trimmed_url = trim_url(urlOrPredicate) log_line = f"waiting for request {trimmed_url}" if trimmed_url else None @@ -1223,21 +1296,14 @@ def expect_response( urlOrPredicate: URLMatchResponse, timeout: float = None, ) -> EventContextManagerImpl[Response]: - matcher = ( - None - if callable(urlOrPredicate) - else URLMatcher( - self._browser_context._options.get("baseURL"), urlOrPredicate - ) - ) - predicate = urlOrPredicate if callable(urlOrPredicate) else None - - def my_predicate(response: Response) -> bool: - if matcher: - return matcher.matches(response.url) - if predicate: - return predicate(response) - return True + def my_predicate(request: Response) -> bool: + if not callable(urlOrPredicate): + return url_matches( + self._browser_context._base_url, + request.url, + urlOrPredicate, + ) + return urlOrPredicate(request) trimmed_url = trim_url(urlOrPredicate) log_line = f"waiting for response {trimmed_url}" if trimmed_url else None @@ -1305,6 +1371,7 @@ async def add_locator_handler( return uid = await self._channel.send( "registerLocatorHandler", + None, { "selector": locator._selector, "noWaitAfter": noWaitAfter, @@ -1345,7 +1412,9 @@ def _handler() -> None: try: await self._connection.wrap_api_call( lambda: self._channel.send( - "resolveLocatorHandlerNoReply", {"uid": uid, "remove": remove} + "resolveLocatorHandlerNoReply", + None, + {"uid": uid, "remove": remove}, ), is_internal=True, ) @@ -1356,16 +1425,38 @@ async def remove_locator_handler(self, locator: "Locator") -> None: for uid, data in self._locator_handlers.copy().items(): if data.locator._equals(locator): del self._locator_handlers[uid] - self._channel.send_no_reply("unregisterLocatorHandler", {"uid": uid}) + self._channel.send_no_reply( + "unregisterLocatorHandler", + None, + {"uid": uid}, + ) + + async def requests(self) -> List[Request]: + request_objects = await self._channel.send("requests", None) + return [from_channel(r) for r in request_objects] + + async def console_messages(self) -> List[ConsoleMessage]: + message_dicts = await self._channel.send("consoleMessages", None) + return [ + ConsoleMessage( + {**event, "page": self._channel}, self._loop, self._dispatcher_fiber + ) + for event in message_dicts + ] + + async def page_errors(self) -> List[Error]: + error_objects = await self._channel.send("pageErrors", None) + return [parse_error(error["error"]) for error in error_objects] class Worker(ChannelOwner): - Events = SimpleNamespace(Close="close") + Events = SimpleNamespace(Close="close", Console="console") def __init__( self, parent: ChannelOwner, type: str, guid: str, initializer: Dict ) -> None: super().__init__(parent, type, guid, initializer) + self._set_event_to_subscription_mapping({Worker.Events.Console: "console"}) self._channel.on("close", lambda _: self._on_close()) self._page: Optional[Page] = None self._context: Optional["BrowserContext"] = None @@ -1388,6 +1479,7 @@ async def evaluate(self, expression: str, arg: Serializable = None) -> Any: return parse_result( await self._channel.send( "evaluateExpression", + None, dict( expression=expression, arg=serialize_argument(arg), @@ -1401,6 +1493,7 @@ async def evaluate_handle( return from_channel( await self._channel.send( "evaluateExpressionHandle", + None, dict( expression=expression, arg=serialize_argument(arg), @@ -1408,6 +1501,31 @@ async def evaluate_handle( ) ) + def expect_event( + self, + event: str, + predicate: Callable = None, + timeout: float = None, + ) -> EventContextManagerImpl: + if timeout is None: + if self._page: + timeout = self._page._timeout_settings.timeout() + elif self._context: + timeout = self._context._timeout_settings.timeout() + else: + timeout = 30000 + waiter = Waiter(self, f"worker.expect_event({event})") + waiter.reject_on_timeout( + cast(float, timeout), + f'Timeout {timeout}ms exceeded while waiting for event "{event}"', + ) + if event != Worker.Events.Close: + waiter.reject_on_event( + self, Worker.Events.Close, lambda: TargetClosedError() + ) + waiter.wait_for_event(self, event, predicate) + return EventContextManagerImpl(waiter.result()) + class BindingCall(ChannelOwner): def __init__( @@ -1426,12 +1544,14 @@ async def call(self, func: Callable) -> None: result = func(source, *func_args) if inspect.iscoroutine(result): result = await result - await self._channel.send("resolve", dict(result=serialize_argument(result))) + await self._channel.send( + "resolve", None, dict(result=serialize_argument(result)) + ) except Exception as e: tb = sys.exc_info()[2] asyncio.create_task( self._channel.send( - "reject", dict(error=dict(error=serialize_error(e, tb))) + "reject", None, dict(error=dict(error=serialize_error(e, tb))) ) ) diff --git a/playwright/_impl/_path_utils.py b/playwright/_impl/_path_utils.py index 267a82ab0..b405a0675 100644 --- a/playwright/_impl/_path_utils.py +++ b/playwright/_impl/_path_utils.py @@ -14,12 +14,14 @@ import inspect from pathlib import Path +from types import FrameType +from typing import cast def get_file_dirname() -> Path: """Returns the callee (`__file__`) directory name""" - frame = inspect.stack()[1] - module = inspect.getmodule(frame[0]) + frame = cast(FrameType, inspect.currentframe()).f_back + module = inspect.getmodule(frame) assert module assert module.__file__ return Path(module.__file__).parent.absolute() diff --git a/playwright/_impl/_playwright.py b/playwright/_impl/_playwright.py index c02e73316..5c0151158 100644 --- a/playwright/_impl/_playwright.py +++ b/playwright/_impl/_playwright.py @@ -17,7 +17,7 @@ from playwright._impl._browser_type import BrowserType from playwright._impl._connection import ChannelOwner, from_channel from playwright._impl._fetch import APIRequest -from playwright._impl._selectors import Selectors, SelectorsOwner +from playwright._impl._selectors import Selectors class Playwright(ChannelOwner): @@ -41,12 +41,7 @@ def __init__( self.webkit._playwright = self self.selectors = Selectors(self._loop, self._dispatcher_fiber) - selectors_owner: SelectorsOwner = from_channel(initializer["selectors"]) - self.selectors._add_channel(selectors_owner) - self._connection.on( - "close", lambda: self.selectors._remove_channel(selectors_owner) - ) self.devices = self._connection.local_utils.devices def __getitem__(self, value: str) -> "BrowserType": @@ -59,10 +54,7 @@ def __getitem__(self, value: str) -> "BrowserType": raise ValueError("Invalid browser " + value) def _set_selectors(self, selectors: Selectors) -> None: - selectors_owner = from_channel(self._initializer["selectors"]) - self.selectors._remove_channel(selectors_owner) self.selectors = selectors - self.selectors._add_channel(selectors_owner) async def stop(self) -> None: pass diff --git a/playwright/_impl/_selectors.py b/playwright/_impl/_selectors.py index cf8af8c06..c3bac78e5 100644 --- a/playwright/_impl/_selectors.py +++ b/playwright/_impl/_selectors.py @@ -14,20 +14,21 @@ import asyncio from pathlib import Path -from typing import Any, Dict, List, Set, Union +from typing import Any, Dict, List, Optional, Set, Union -from playwright._impl._connection import ChannelOwner +from playwright._impl._browser_context import BrowserContext from playwright._impl._errors import Error from playwright._impl._helper import async_readfile -from playwright._impl._locator import set_test_id_attribute_name, test_id_attribute_name +from playwright._impl._locator import set_test_id_attribute_name class Selectors: def __init__(self, loop: asyncio.AbstractEventLoop, dispatcher_fiber: Any) -> None: self._loop = loop - self._channels: Set[SelectorsOwner] = set() - self._registrations: List[Dict] = [] + self._contexts_for_selectors: Set[BrowserContext] = set() + self._selector_engines: List[Dict] = [] self._dispatcher_fiber = dispatcher_fiber + self._test_id_attribute_name: Optional[str] = None async def register( self, @@ -36,41 +37,31 @@ async def register( path: Union[str, Path] = None, contentScript: bool = None, ) -> None: + if any(engine for engine in self._selector_engines if engine["name"] == name): + raise Error( + f'Selectors.register: "{name}" selector engine has been already registered' + ) if not script and not path: raise Error("Either source or path should be specified") if path: script = (await async_readfile(path)).decode() - params: Dict[str, Any] = dict(name=name, source=script) + engine: Dict[str, Any] = dict(name=name, source=script) if contentScript: - params["contentScript"] = True - for channel in self._channels: - await channel._channel.send("register", params) - self._registrations.append(params) + engine["contentScript"] = contentScript + for context in self._contexts_for_selectors: + await context._channel.send( + "registerSelectorEngine", + None, + {"selectorEngine": engine}, + ) + self._selector_engines.append(engine) def set_test_id_attribute(self, attributeName: str) -> None: set_test_id_attribute_name(attributeName) - for channel in self._channels: - channel._channel.send_no_reply( - "setTestIdAttributeName", {"testIdAttributeName": attributeName} - ) - - def _add_channel(self, channel: "SelectorsOwner") -> None: - self._channels.add(channel) - for params in self._registrations: - # This should not fail except for connection closure, but just in case we catch. - channel._channel.send_no_reply("register", params) - channel._channel.send_no_reply( + self._test_id_attribute_name = attributeName + for context in self._contexts_for_selectors: + context._channel.send_no_reply( "setTestIdAttributeName", - {"testIdAttributeName": test_id_attribute_name()}, + None, + {"testIdAttributeName": attributeName}, ) - - def _remove_channel(self, channel: "SelectorsOwner") -> None: - if channel in self._channels: - self._channels.remove(channel) - - -class SelectorsOwner(ChannelOwner): - def __init__( - self, parent: ChannelOwner, type: str, guid: str, initializer: Dict - ) -> None: - super().__init__(parent, type, guid, initializer) diff --git a/playwright/_impl/_set_input_files_helpers.py b/playwright/_impl/_set_input_files_helpers.py index ababf5fab..65307e0a2 100644 --- a/playwright/_impl/_set_input_files_helpers.py +++ b/playwright/_impl/_set_input_files_helpers.py @@ -14,6 +14,7 @@ import base64 import collections.abc import os +import stat from pathlib import Path from typing import ( TYPE_CHECKING, @@ -84,6 +85,7 @@ async def convert_input_files( result = await context._connection.wrap_api_call( lambda: context._channel.send_return_as_dict( "createTempFiles", + None, { "rootDirName": ( os.path.basename(local_directory) @@ -138,12 +140,13 @@ async def convert_input_files( def resolve_paths_and_directory_for_input_files( - items: Sequence[Union[str, Path]] + items: Sequence[Union[str, Path]], ) -> Tuple[Optional[List[str]], Optional[str]]: local_paths: Optional[List[str]] = None local_directory: Optional[str] = None for item in items: - if os.path.isdir(item): + item_stat = os.stat(item) # Raises FileNotFoundError if doesn't exist + if stat.S_ISDIR(item_stat.st_mode): if local_directory: raise Error("Multiple directories are not supported") local_directory = str(Path(item).resolve()) diff --git a/playwright/_impl/_stream.py b/playwright/_impl/_stream.py index d27427589..04afa48e1 100644 --- a/playwright/_impl/_stream.py +++ b/playwright/_impl/_stream.py @@ -28,7 +28,7 @@ def __init__( async def save_as(self, path: Union[str, Path]) -> None: file = await self._loop.run_in_executor(None, lambda: open(path, "wb")) while True: - binary = await self._channel.send("read", {"size": 1024 * 1024}) + binary = await self._channel.send("read", None, {"size": 1024 * 1024}) if not binary: break await self._loop.run_in_executor( @@ -39,7 +39,7 @@ async def save_as(self, path: Union[str, Path]) -> None: async def read_all(self) -> bytes: binary = b"" while True: - chunk = await self._channel.send("read", {"size": 1024 * 1024}) + chunk = await self._channel.send("read", None, {"size": 1024 * 1024}) if not chunk: break binary += base64.b64decode(chunk) diff --git a/playwright/_impl/_sync_base.py b/playwright/_impl/_sync_base.py index f07b947b2..3fef433b5 100644 --- a/playwright/_impl/_sync_base.py +++ b/playwright/_impl/_sync_base.py @@ -105,8 +105,8 @@ def _sync( g_self = greenlet.getcurrent() task: asyncio.tasks.Task[Any] = self._loop.create_task(coro) - setattr(task, "__pw_stack__", inspect.stack()) - setattr(task, "__pw_stack_trace__", traceback.extract_stack()) + setattr(task, "__pw_stack__", inspect.stack(0)) + setattr(task, "__pw_stack_trace__", traceback.extract_stack(limit=10)) task.add_done_callback(lambda _: g_self.switch()) while not task.done(): @@ -114,7 +114,9 @@ def _sync( asyncio._set_running_loop(self._loop) return task.result() - def _wrap_handler(self, handler: Any) -> Callable[..., None]: + def _wrap_handler( + self, handler: Union[Callable[..., Any], Any] + ) -> Callable[..., None]: if callable(handler): return mapping.wrap_handler(handler) return handler @@ -140,11 +142,10 @@ def __enter__(self: Self) -> Self: def __exit__( self, - exc_type: Type[BaseException], - exc_val: BaseException, - _traceback: TracebackType, + exc_type: Optional[Type[BaseException]], + exc_val: Optional[BaseException], + _traceback: Optional[TracebackType], ) -> None: self.close() - def close(self) -> None: - ... + def close(self) -> None: ... diff --git a/playwright/_impl/_tracing.py b/playwright/_impl/_tracing.py index b2d4b5df9..bbc6ec35e 100644 --- a/playwright/_impl/_tracing.py +++ b/playwright/_impl/_tracing.py @@ -15,6 +15,7 @@ import pathlib from typing import Dict, Optional, Union, cast +from playwright._impl._api_structures import TracingGroupLocation from playwright._impl._artifact import Artifact from playwright._impl._connection import ChannelOwner, from_nullable_channel from playwright._impl._helper import locals_to_params @@ -41,18 +42,15 @@ async def start( params = locals_to_params(locals()) self._include_sources = bool(sources) - async def _inner_start() -> str: - await self._channel.send("tracingStart", params) - return await self._channel.send( - "tracingStartChunk", {"title": title, "name": name} - ) - - trace_name = await self._connection.wrap_api_call(_inner_start, True) + await self._channel.send("tracingStart", None, params) + trace_name = await self._channel.send( + "tracingStartChunk", None, {"title": title, "name": name} + ) await self._start_collecting_stacks(trace_name) async def start_chunk(self, title: str = None, name: str = None) -> None: params = locals_to_params(locals()) - trace_name = await self._channel.send("tracingStartChunk", params) + trace_name = await self._channel.send("tracingStartChunk", None, params) await self._start_collecting_stacks(trace_name) async def _start_collecting_stacks(self, trace_name: str) -> None: @@ -64,21 +62,21 @@ async def _start_collecting_stacks(self, trace_name: str) -> None: ) async def stop_chunk(self, path: Union[pathlib.Path, str] = None) -> None: - await self._connection.wrap_api_call(lambda: self._do_stop_chunk(path), True) + await self._do_stop_chunk(path) async def stop(self, path: Union[pathlib.Path, str] = None) -> None: - async def _inner() -> None: - await self._do_stop_chunk(path) - await self._channel.send("tracingStop") - - await self._connection.wrap_api_call(_inner, True) + await self._do_stop_chunk(path) + await self._channel.send( + "tracingStop", + None, + ) async def _do_stop_chunk(self, file_path: Union[pathlib.Path, str] = None) -> None: self._reset_stack_counter() if not file_path: # Not interested in any artifacts - await self._channel.send("tracingStopChunk", {"mode": "discard"}) + await self._channel.send("tracingStopChunk", None, {"mode": "discard"}) if self._stacks_id: await self._connection.local_utils.trace_discarded(self._stacks_id) return @@ -87,7 +85,7 @@ async def _do_stop_chunk(self, file_path: Union[pathlib.Path, str] = None) -> No if is_local: result = await self._channel.send_return_as_dict( - "tracingStopChunk", {"mode": "entries"} + "tracingStopChunk", None, {"mode": "entries"} ) await self._connection.local_utils.zip( { @@ -102,6 +100,7 @@ async def _do_stop_chunk(self, file_path: Union[pathlib.Path, str] = None) -> No result = await self._channel.send_return_as_dict( "tracingStopChunk", + None, { "mode": "archive", }, @@ -136,3 +135,12 @@ def _reset_stack_counter(self) -> None: if self._is_tracing: self._is_tracing = False self._connection.set_is_tracing(False) + + async def group(self, name: str, location: TracingGroupLocation = None) -> None: + await self._channel.send("tracingGroup", None, locals_to_params(locals())) + + async def group_end(self) -> None: + await self._channel.send( + "tracingGroupEnd", + None, + ) diff --git a/playwright/_impl/_transport.py b/playwright/_impl/_transport.py index 124f57823..2ca84d459 100644 --- a/playwright/_impl/_transport.py +++ b/playwright/_impl/_transport.py @@ -167,7 +167,7 @@ async def run(self) -> None: break await asyncio.sleep(0) - await self._proc.wait() + await self._proc.communicate() self._stopped_future.set_result(None) def send(self, message: Dict) -> None: diff --git a/playwright/_impl/_waiter.py b/playwright/_impl/_waiter.py index 7b0ad2cc6..f7ff4b6c1 100644 --- a/playwright/_impl/_waiter.py +++ b/playwright/_impl/_waiter.py @@ -38,6 +38,7 @@ def __init__(self, channel_owner: ChannelOwner, event: str) -> None: def _wait_for_event_info_before(self, wait_id: str, event: str) -> None: self._channel.send_no_reply( "waitForEventInfo", + None, { "info": { "waitId": wait_id, @@ -51,6 +52,7 @@ def _wait_for_event_info_after(self, wait_id: str, error: Exception = None) -> N self._channel._connection.wrap_api_call_sync( lambda: self._channel.send_no_reply( "waitForEventInfo", + None, { "info": { "waitId": wait_id, @@ -130,6 +132,7 @@ def log(self, message: str) -> None: self._channel._connection.wrap_api_call_sync( lambda: self._channel.send_no_reply( "waitForEventInfo", + None, { "info": { "waitId": self._wait_id, diff --git a/playwright/_impl/_web_error.py b/playwright/_impl/_web_error.py index eb1b51948..345f95b8f 100644 --- a/playwright/_impl/_web_error.py +++ b/playwright/_impl/_web_error.py @@ -13,7 +13,7 @@ # limitations under the License. from asyncio import AbstractEventLoop -from typing import Optional +from typing import Any, Optional from playwright._impl._helper import Error from playwright._impl._page import Page @@ -21,9 +21,14 @@ class WebError: def __init__( - self, loop: AbstractEventLoop, page: Optional[Page], error: Error + self, + loop: AbstractEventLoop, + dispatcher_fiber: Any, + page: Optional[Page], + error: Error, ) -> None: self._loop = loop + self._dispatcher_fiber = dispatcher_fiber self._page = page self._error = error diff --git a/playwright/_impl/_writable_stream.py b/playwright/_impl/_writable_stream.py index 702adf153..7d5b7704b 100644 --- a/playwright/_impl/_writable_stream.py +++ b/playwright/_impl/_writable_stream.py @@ -37,6 +37,6 @@ async def copy(self, path: Union[str, Path]) -> None: if not data: break await self._channel.send( - "write", {"binary": base64.b64encode(data).decode()} + "write", None, {"binary": base64.b64encode(data).decode()} ) - await self._channel.send("close") + await self._channel.send("close", None) diff --git a/playwright/async_api/__init__.py b/playwright/async_api/__init__.py index 554e83927..c05735fcd 100644 --- a/playwright/async_api/__init__.py +++ b/playwright/async_api/__init__.py @@ -30,7 +30,6 @@ from playwright._impl._assertions import PageAssertions as PageAssertionsImpl from playwright.async_api._context_manager import PlaywrightContextManager from playwright.async_api._generated import ( - Accessibility, APIRequest, APIRequestContext, APIResponse, @@ -60,7 +59,9 @@ Selectors, Touchscreen, Video, + WebError, WebSocket, + WebSocketRoute, Worker, ) @@ -77,6 +78,7 @@ ResourceTiming = playwright._impl._api_structures.ResourceTiming SourceLocation = playwright._impl._api_structures.SourceLocation StorageState = playwright._impl._api_structures.StorageState +StorageStateCookie = playwright._impl._api_structures.StorageStateCookie ViewportSize = playwright._impl._api_structures.ViewportSize Error = playwright._impl._errors.Error @@ -107,20 +109,19 @@ def set_options(self, timeout: Optional[float] = _unset) -> None: self._timeout = timeout @overload - def __call__(self, actual: Page, message: Optional[str] = None) -> PageAssertions: - ... + def __call__( + self, actual: Page, message: Optional[str] = None + ) -> PageAssertions: ... @overload def __call__( self, actual: Locator, message: Optional[str] = None - ) -> LocatorAssertions: - ... + ) -> LocatorAssertions: ... @overload def __call__( self, actual: APIResponse, message: Optional[str] = None - ) -> APIResponseAssertions: - ... + ) -> APIResponseAssertions: ... def __call__( self, actual: Union[Page, Locator, APIResponse], message: Optional[str] = None @@ -148,7 +149,6 @@ def __call__( __all__ = [ "expect", "async_playwright", - "Accessibility", "APIRequest", "APIRequestContext", "APIResponse", @@ -186,10 +186,13 @@ def __call__( "Selectors", "SourceLocation", "StorageState", + "StorageStateCookie", "TimeoutError", "Touchscreen", "Video", "ViewportSize", + "WebError", "WebSocket", + "WebSocketRoute", "Worker", ] diff --git a/playwright/async_api/_generated.py b/playwright/async_api/_generated.py index 98bf96cc0..bd694886d 100644 --- a/playwright/async_api/_generated.py +++ b/playwright/async_api/_generated.py @@ -18,7 +18,6 @@ import typing from typing import Literal -from playwright._impl._accessibility import Accessibility as AccessibilityImpl from playwright._impl._api_structures import ( ClientCertificate, Cookie, @@ -37,6 +36,7 @@ SetCookieParam, SourceLocation, StorageState, + TracingGroupLocation, ViewportSize, ) from playwright._impl._assertions import ( @@ -75,6 +75,7 @@ from playwright._impl._network import Response as ResponseImpl from playwright._impl._network import Route as RouteImpl from playwright._impl._network import WebSocket as WebSocketImpl +from playwright._impl._network import WebSocketRoute as WebSocketRouteImpl from playwright._impl._page import Page as PageImpl from playwright._impl._page import Worker as WorkerImpl from playwright._impl._playwright import Playwright as PlaywrightImpl @@ -85,6 +86,7 @@ class Request(AsyncBase): + @property def url(self) -> str: """Request.url @@ -111,6 +113,24 @@ def resource_type(self) -> str: """ return mapping.from_maybe_impl(self._impl_obj.resource_type) + @property + def service_worker(self) -> typing.Optional["Worker"]: + """Request.service_worker + + The Service `Worker` that is performing the request. + + **Details** + + This method is Chromium only. It's safe to call when using other browsers, but it will always be `null`. + + Requests originated in a Service Worker do not have a `request.frame()` available. + + Returns + ------- + Union[Worker, None] + """ + return mapping.from_impl_nullable(self._impl_obj.service_worker) + @property def method(self) -> str: """Request.method @@ -385,6 +405,7 @@ async def header_value(self, name: str) -> typing.Optional[str]: class Response(AsyncBase): + @property def url(self) -> str: """Response.url @@ -621,6 +642,7 @@ async def json(self) -> typing.Any: class Route(AsyncBase): + @property def request(self) -> "Request": """Route.request @@ -669,9 +691,9 @@ async def fulfill( headers: typing.Optional[typing.Dict[str, str]] = None, body: typing.Optional[typing.Union[str, bytes]] = None, json: typing.Optional[typing.Any] = None, - path: typing.Optional[typing.Union[str, pathlib.Path]] = None, + path: typing.Optional[typing.Union[pathlib.Path, str]] = None, content_type: typing.Optional[str] = None, - response: typing.Optional["APIResponse"] = None + response: typing.Optional["APIResponse"] = None, ) -> None: """Route.fulfill @@ -735,7 +757,7 @@ async def fetch( post_data: typing.Optional[typing.Union[typing.Any, str, bytes]] = None, max_redirects: typing.Optional[int] = None, max_retries: typing.Optional[int] = None, - timeout: typing.Optional[float] = None + timeout: typing.Optional[float] = None, ) -> "APIResponse": """Route.fetch @@ -804,7 +826,7 @@ async def fallback( url: typing.Optional[str] = None, method: typing.Optional[str] = None, headers: typing.Optional[typing.Dict[str, str]] = None, - post_data: typing.Optional[typing.Union[typing.Any, str, bytes]] = None + post_data: typing.Optional[typing.Union[typing.Any, str, bytes]] = None, ) -> None: """Route.fallback @@ -895,7 +917,7 @@ async def continue_( url: typing.Optional[str] = None, method: typing.Optional[str] = None, headers: typing.Optional[typing.Dict[str, str]] = None, - post_data: typing.Optional[typing.Union[typing.Any, str, bytes]] = None + post_data: typing.Optional[typing.Union[typing.Any, str, bytes]] = None, ) -> None: """Route.continue_ @@ -918,13 +940,19 @@ async def handle(route, request): **Details** - Note that any overrides such as `url` or `headers` only apply to the request being routed. If this request results - in a redirect, overrides will not be applied to the new redirected request. If you want to propagate a header - through redirects, use the combination of `route.fetch()` and `route.fulfill()` instead. + The `headers` option applies to both the routed request and any redirects it initiates. However, `url`, `method`, + and `postData` only apply to the original request and are not carried over to redirected requests. `route.continue_()` will immediately send the request to the network, other matching handlers won't be invoked. Use `route.fallback()` If you want next matching handler in the chain to be invoked. + **NOTE** Some request headers are **forbidden** and cannot be overridden (for example, `Cookie`, `Host`, + `Content-Length` and others, see + [this MDN page](https://developer.mozilla.org/en-US/docs/Glossary/Forbidden_request_header) for full list). If an + override is provided for a forbidden header, it will be ignored and the original request header will be used. + + To set custom cookies, use `browser_context.add_cookies()`. + Parameters ---------- url : Union[str, None] @@ -951,6 +979,7 @@ async def handle(route, request): class WebSocket(AsyncBase): + @typing.overload def on( self, @@ -1062,7 +1091,7 @@ def expect_event( event: str, predicate: typing.Optional[typing.Callable] = None, *, - timeout: typing.Optional[float] = None + timeout: typing.Optional[float] = None, ) -> AsyncEventContextManager: """WebSocket.expect_event @@ -1095,7 +1124,7 @@ async def wait_for_event( event: str, predicate: typing.Optional[typing.Callable] = None, *, - timeout: typing.Optional[float] = None + timeout: typing.Optional[float] = None, ) -> typing.Any: """WebSocket.wait_for_event @@ -1142,7 +1171,135 @@ def is_closed(self) -> bool: mapping.register(WebSocketImpl, WebSocket) +class WebSocketRoute(AsyncBase): + + @property + def url(self) -> str: + """WebSocketRoute.url + + URL of the WebSocket created in the page. + + Returns + ------- + str + """ + return mapping.from_maybe_impl(self._impl_obj.url) + + async def close( + self, *, code: typing.Optional[int] = None, reason: typing.Optional[str] = None + ) -> None: + """WebSocketRoute.close + + Closes one side of the WebSocket connection. + + Parameters + ---------- + code : Union[int, None] + Optional [close code](https://developer.mozilla.org/en-US/docs/Web/API/WebSocket/close#code). + reason : Union[str, None] + Optional [close reason](https://developer.mozilla.org/en-US/docs/Web/API/WebSocket/close#reason). + """ + + return mapping.from_maybe_impl( + await self._impl_obj.close(code=code, reason=reason) + ) + + def connect_to_server(self) -> "WebSocketRoute": + """WebSocketRoute.connect_to_server + + By default, routed WebSocket does not connect to the server, so you can mock entire WebSocket communication. This + method connects to the actual WebSocket server, and returns the server-side `WebSocketRoute` instance, giving the + ability to send and receive messages from the server. + + Once connected to the server: + - Messages received from the server will be **automatically forwarded** to the WebSocket in the page, unless + `web_socket_route.on_message()` is called on the server-side `WebSocketRoute`. + - Messages sent by the [`WebSocket.send()`](https://developer.mozilla.org/en-US/docs/Web/API/WebSocket/send) call + in the page will be **automatically forwarded** to the server, unless `web_socket_route.on_message()` is + called on the original `WebSocketRoute`. + + See examples at the top for more details. + + Returns + ------- + WebSocketRoute + """ + + return mapping.from_impl(self._impl_obj.connect_to_server()) + + def send(self, message: typing.Union[str, bytes]) -> None: + """WebSocketRoute.send + + Sends a message to the WebSocket. When called on the original WebSocket, sends the message to the page. When called + on the result of `web_socket_route.connect_to_server()`, sends the message to the server. See examples at the + top for more details. + + Parameters + ---------- + message : Union[bytes, str] + Message to send. + """ + + return mapping.from_maybe_impl(self._impl_obj.send(message=message)) + + def on_message( + self, handler: typing.Callable[[typing.Union[str, bytes]], typing.Any] + ) -> None: + """WebSocketRoute.on_message + + This method allows to handle messages that are sent by the WebSocket, either from the page or from the server. + + When called on the original WebSocket route, this method handles messages sent from the page. You can handle this + messages by responding to them with `web_socket_route.send()`, forwarding them to the server-side connection + returned by `web_socket_route.connect_to_server()` or do something else. + + Once this method is called, messages are not automatically forwarded to the server or to the page - you should do + that manually by calling `web_socket_route.send()`. See examples at the top for more details. + + Calling this method again will override the handler with a new one. + + Parameters + ---------- + handler : Callable[[Union[bytes, str]], Any] + Function that will handle messages. + """ + + return mapping.from_maybe_impl( + self._impl_obj.on_message(handler=self._wrap_handler(handler)) + ) + + def on_close( + self, + handler: typing.Callable[ + [typing.Optional[int], typing.Optional[str]], typing.Any + ], + ) -> None: + """WebSocketRoute.on_close + + Allows to handle [`WebSocket.close`](https://developer.mozilla.org/en-US/docs/Web/API/WebSocket/close). + + By default, closing one side of the connection, either in the page or on the server, will close the other side. + However, when `web_socket_route.on_close()` handler is set up, the default forwarding of closure is disabled, + and handler should take care of it. + + Parameters + ---------- + handler : Callable[[Union[int, None], Union[str, None]], Any] + Function that will handle WebSocket closure. Received an optional + [close code](https://developer.mozilla.org/en-US/docs/Web/API/WebSocket/close#code) and an optional + [close reason](https://developer.mozilla.org/en-US/docs/Web/API/WebSocket/close#reason). + """ + + return mapping.from_maybe_impl( + self._impl_obj.on_close(handler=self._wrap_handler(handler)) + ) + + +mapping.register(WebSocketRouteImpl, WebSocketRoute) + + class Keyboard(AsyncBase): + async def down(self, key: str) -> None: """Keyboard.down @@ -1306,6 +1463,7 @@ async def press(self, key: str, *, delay: typing.Optional[float] = None) -> None class Mouse(AsyncBase): + async def move( self, x: float, y: float, *, steps: typing.Optional[int] = None ) -> None: @@ -1320,7 +1478,8 @@ async def move( y : float Y coordinate relative to the main frame's viewport in CSS pixels. steps : Union[int, None] - Defaults to 1. Sends intermediate `mousemove` events. + Defaults to 1. Sends `n` interpolated `mousemove` events to represent travel between Playwright's current cursor + position and the provided destination. When set to 1, emits a single `mousemove` event at the destination location. """ return mapping.from_maybe_impl(await self._impl_obj.move(x=x, y=y, steps=steps)) @@ -1329,7 +1488,7 @@ async def down( self, *, button: typing.Optional[Literal["left", "middle", "right"]] = None, - click_count: typing.Optional[int] = None + click_count: typing.Optional[int] = None, ) -> None: """Mouse.down @@ -1351,7 +1510,7 @@ async def up( self, *, button: typing.Optional[Literal["left", "middle", "right"]] = None, - click_count: typing.Optional[int] = None + click_count: typing.Optional[int] = None, ) -> None: """Mouse.up @@ -1376,7 +1535,7 @@ async def click( *, delay: typing.Optional[float] = None, button: typing.Optional[Literal["left", "middle", "right"]] = None, - click_count: typing.Optional[int] = None + click_count: typing.Optional[int] = None, ) -> None: """Mouse.click @@ -1408,7 +1567,7 @@ async def dblclick( y: float, *, delay: typing.Optional[float] = None, - button: typing.Optional[Literal["left", "middle", "right"]] = None + button: typing.Optional[Literal["left", "middle", "right"]] = None, ) -> None: """Mouse.dblclick @@ -1457,6 +1616,7 @@ async def wheel(self, delta_x: float, delta_y: float) -> None: class Touchscreen(AsyncBase): + async def tap(self, x: float, y: float) -> None: """Touchscreen.tap @@ -1479,6 +1639,7 @@ async def tap(self, x: float, y: float) -> None: class JSHandle(AsyncBase): + async def evaluate( self, expression: str, arg: typing.Optional[typing.Any] = None ) -> typing.Any: @@ -1634,6 +1795,7 @@ async def json_value(self) -> typing.Any: class ElementHandle(JSHandle): + def as_element(self) -> typing.Optional["ElementHandle"]: """ElementHandle.as_element @@ -1882,7 +2044,7 @@ async def hover( timeout: typing.Optional[float] = None, no_wait_after: typing.Optional[bool] = None, force: typing.Optional[bool] = None, - trial: typing.Optional[bool] = None + trial: typing.Optional[bool] = None, ) -> None: """ElementHandle.hover @@ -1942,7 +2104,8 @@ async def click( timeout: typing.Optional[float] = None, force: typing.Optional[bool] = None, no_wait_after: typing.Optional[bool] = None, - trial: typing.Optional[bool] = None + trial: typing.Optional[bool] = None, + steps: typing.Optional[int] = None, ) -> None: """ElementHandle.click @@ -1985,6 +2148,9 @@ async def click( trial : Union[bool, None] When set, this method only performs the [actionability](../actionability.md) checks and skips the action. Defaults to `false`. Useful to wait until the element is ready for the action without performing it. + steps : Union[int, None] + Defaults to 1. Sends `n` interpolated `mousemove` events to represent travel between Playwright's current cursor + position and the provided destination. When set to 1, emits a single `mousemove` event at the destination location. """ return mapping.from_maybe_impl( @@ -1998,6 +2164,7 @@ async def click( force=force, noWaitAfter=no_wait_after, trial=trial, + steps=steps, ) ) @@ -2013,7 +2180,8 @@ async def dblclick( timeout: typing.Optional[float] = None, force: typing.Optional[bool] = None, no_wait_after: typing.Optional[bool] = None, - trial: typing.Optional[bool] = None + trial: typing.Optional[bool] = None, + steps: typing.Optional[int] = None, ) -> None: """ElementHandle.dblclick @@ -2053,6 +2221,9 @@ async def dblclick( trial : Union[bool, None] When set, this method only performs the [actionability](../actionability.md) checks and skips the action. Defaults to `false`. Useful to wait until the element is ready for the action without performing it. + steps : Union[int, None] + Defaults to 1. Sends `n` interpolated `mousemove` events to represent travel between Playwright's current cursor + position and the provided destination. When set to 1, emits a single `mousemove` event at the destination location. """ return mapping.from_maybe_impl( @@ -2065,6 +2236,7 @@ async def dblclick( force=force, noWaitAfter=no_wait_after, trial=trial, + steps=steps, ) ) @@ -2079,7 +2251,7 @@ async def select_option( ] = None, timeout: typing.Optional[float] = None, force: typing.Optional[bool] = None, - no_wait_after: typing.Optional[bool] = None + no_wait_after: typing.Optional[bool] = None, ) -> typing.List[str]: """ElementHandle.select_option @@ -2154,7 +2326,7 @@ async def tap( timeout: typing.Optional[float] = None, force: typing.Optional[bool] = None, no_wait_after: typing.Optional[bool] = None, - trial: typing.Optional[bool] = None + trial: typing.Optional[bool] = None, ) -> None: """ElementHandle.tap @@ -2209,7 +2381,7 @@ async def fill( *, timeout: typing.Optional[float] = None, no_wait_after: typing.Optional[bool] = None, - force: typing.Optional[bool] = None + force: typing.Optional[bool] = None, ) -> None: """ElementHandle.fill @@ -2247,7 +2419,7 @@ async def select_text( self, *, force: typing.Optional[bool] = None, - timeout: typing.Optional[float] = None + timeout: typing.Optional[float] = None, ) -> None: """ElementHandle.select_text @@ -2306,7 +2478,7 @@ async def set_input_files( ], *, timeout: typing.Optional[float] = None, - no_wait_after: typing.Optional[bool] = None + no_wait_after: typing.Optional[bool] = None, ) -> None: """ElementHandle.set_input_files @@ -2350,7 +2522,7 @@ async def type( *, delay: typing.Optional[float] = None, timeout: typing.Optional[float] = None, - no_wait_after: typing.Optional[bool] = None + no_wait_after: typing.Optional[bool] = None, ) -> None: """ElementHandle.type @@ -2387,7 +2559,7 @@ async def press( *, delay: typing.Optional[float] = None, timeout: typing.Optional[float] = None, - no_wait_after: typing.Optional[bool] = None + no_wait_after: typing.Optional[bool] = None, ) -> None: """ElementHandle.press @@ -2443,7 +2615,7 @@ async def set_checked( timeout: typing.Optional[float] = None, force: typing.Optional[bool] = None, no_wait_after: typing.Optional[bool] = None, - trial: typing.Optional[bool] = None + trial: typing.Optional[bool] = None, ) -> None: """ElementHandle.set_checked @@ -2497,7 +2669,7 @@ async def check( timeout: typing.Optional[float] = None, force: typing.Optional[bool] = None, no_wait_after: typing.Optional[bool] = None, - trial: typing.Optional[bool] = None + trial: typing.Optional[bool] = None, ) -> None: """ElementHandle.check @@ -2549,7 +2721,7 @@ async def uncheck( timeout: typing.Optional[float] = None, force: typing.Optional[bool] = None, no_wait_after: typing.Optional[bool] = None, - trial: typing.Optional[bool] = None + trial: typing.Optional[bool] = None, ) -> None: """ElementHandle.uncheck @@ -2629,7 +2801,7 @@ async def screenshot( *, timeout: typing.Optional[float] = None, type: typing.Optional[Literal["jpeg", "png"]] = None, - path: typing.Optional[typing.Union[str, pathlib.Path]] = None, + path: typing.Optional[typing.Union[pathlib.Path, str]] = None, quality: typing.Optional[int] = None, omit_background: typing.Optional[bool] = None, animations: typing.Optional[Literal["allow", "disabled"]] = None, @@ -2637,7 +2809,7 @@ async def screenshot( scale: typing.Optional[Literal["css", "device"]] = None, mask: typing.Optional[typing.Sequence["Locator"]] = None, mask_color: typing.Optional[str] = None, - style: typing.Optional[str] = None + style: typing.Optional[str] = None, ) -> bytes: """ElementHandle.screenshot @@ -2684,7 +2856,9 @@ async def screenshot( Defaults to `"device"`. mask : Union[Sequence[Locator], None] Specify locators that should be masked when the screenshot is taken. Masked elements will be overlaid with a pink - box `#FF00FF` (customized by `maskColor`) that completely covers its bounding box. + box `#FF00FF` (customized by `maskColor`) that completely covers its bounding box. The mask is also applied to + invisible elements, see [Matching only visible elements](../locators.md#matching-only-visible-elements) to disable + that. mask_color : Union[str, None] Specify the color of the overlay box for masked elements, in [CSS color format](https://developer.mozilla.org/en-US/docs/Web/CSS/color_value). Default color is pink `#FF00FF`. @@ -2850,7 +3024,7 @@ async def wait_for_element_state( "disabled", "editable", "enabled", "hidden", "stable", "visible" ], *, - timeout: typing.Optional[float] = None + timeout: typing.Optional[float] = None, ) -> None: """ElementHandle.wait_for_element_state @@ -2890,7 +3064,7 @@ async def wait_for_selector( Literal["attached", "detached", "hidden", "visible"] ] = None, timeout: typing.Optional[float] = None, - strict: typing.Optional[bool] = None + strict: typing.Optional[bool] = None, ) -> typing.Optional["ElementHandle"]: """ElementHandle.wait_for_selector @@ -2947,72 +3121,8 @@ async def wait_for_selector( mapping.register(ElementHandleImpl, ElementHandle) -class Accessibility(AsyncBase): - async def snapshot( - self, - *, - interesting_only: typing.Optional[bool] = None, - root: typing.Optional["ElementHandle"] = None - ) -> typing.Optional[typing.Dict]: - """Accessibility.snapshot - - Captures the current state of the accessibility tree. The returned object represents the root accessible node of - the page. - - **NOTE** The Chromium accessibility tree contains nodes that go unused on most platforms and by most screen - readers. Playwright will discard them as well for an easier to process tree, unless `interestingOnly` is set to - `false`. - - **Usage** - - An example of dumping the entire accessibility tree: - - ```py - snapshot = await page.accessibility.snapshot() - print(snapshot) - ``` - - An example of logging the focused node's name: - - ```py - def find_focused_node(node): - if node.get(\"focused\"): - return node - for child in (node.get(\"children\") or []): - found_node = find_focused_node(child) - if found_node: - return found_node - return None - - snapshot = await page.accessibility.snapshot() - node = find_focused_node(snapshot) - if node: - print(node[\"name\"]) - ``` - - Parameters - ---------- - interesting_only : Union[bool, None] - Prune uninteresting nodes from the tree. Defaults to `true`. - root : Union[ElementHandle, None] - The root DOM element for the snapshot. Defaults to the whole page. - - Returns - ------- - Union[Dict, None] - """ - - return mapping.from_maybe_impl( - await self._impl_obj.snapshot( - interestingOnly=interesting_only, root=mapping.to_impl(root) - ) - ) - - -mapping.register(AccessibilityImpl, Accessibility) - - class FileChooser(AsyncBase): + @property def page(self) -> "Page": """FileChooser.page @@ -3060,7 +3170,7 @@ async def set_files( ], *, timeout: typing.Optional[float] = None, - no_wait_after: typing.Optional[bool] = None + no_wait_after: typing.Optional[bool] = None, ) -> None: """FileChooser.set_files @@ -3089,6 +3199,7 @@ async def set_files( class Frame(AsyncBase): + @property def page(self) -> "Page": """Frame.page @@ -3160,7 +3271,7 @@ async def goto( wait_until: typing.Optional[ Literal["commit", "domcontentloaded", "load", "networkidle"] ] = None, - referer: typing.Optional[str] = None + referer: typing.Optional[str] = None, ) -> typing.Optional["Response"]: """Frame.goto @@ -3225,7 +3336,7 @@ def expect_navigation( wait_until: typing.Optional[ Literal["commit", "domcontentloaded", "load", "networkidle"] ] = None, - timeout: typing.Optional[float] = None + timeout: typing.Optional[float] = None, ) -> AsyncEventContextManager["Response"]: """Frame.expect_navigation @@ -3285,7 +3396,7 @@ async def wait_for_url( wait_until: typing.Optional[ Literal["commit", "domcontentloaded", "load", "networkidle"] ] = None, - timeout: typing.Optional[float] = None + timeout: typing.Optional[float] = None, ) -> None: """Frame.wait_for_url @@ -3331,7 +3442,7 @@ async def wait_for_load_state( Literal["domcontentloaded", "load", "networkidle"] ] = None, *, - timeout: typing.Optional[float] = None + timeout: typing.Optional[float] = None, ) -> None: """Frame.wait_for_load_state @@ -3567,7 +3678,7 @@ async def wait_for_selector( timeout: typing.Optional[float] = None, state: typing.Optional[ Literal["attached", "detached", "hidden", "visible"] - ] = None + ] = None, ) -> typing.Optional["ElementHandle"]: """Frame.wait_for_selector @@ -3640,7 +3751,7 @@ async def is_checked( selector: str, *, strict: typing.Optional[bool] = None, - timeout: typing.Optional[float] = None + timeout: typing.Optional[float] = None, ) -> bool: """Frame.is_checked @@ -3674,7 +3785,7 @@ async def is_disabled( selector: str, *, strict: typing.Optional[bool] = None, - timeout: typing.Optional[float] = None + timeout: typing.Optional[float] = None, ) -> bool: """Frame.is_disabled @@ -3708,7 +3819,7 @@ async def is_editable( selector: str, *, strict: typing.Optional[bool] = None, - timeout: typing.Optional[float] = None + timeout: typing.Optional[float] = None, ) -> bool: """Frame.is_editable @@ -3742,7 +3853,7 @@ async def is_enabled( selector: str, *, strict: typing.Optional[bool] = None, - timeout: typing.Optional[float] = None + timeout: typing.Optional[float] = None, ) -> bool: """Frame.is_enabled @@ -3772,11 +3883,7 @@ async def is_enabled( ) async def is_hidden( - self, - selector: str, - *, - strict: typing.Optional[bool] = None, - timeout: typing.Optional[float] = None + self, selector: str, *, strict: typing.Optional[bool] = None ) -> bool: """Frame.is_hidden @@ -3791,8 +3898,6 @@ async def is_hidden( strict : Union[bool, None] When true, the call requires selector to resolve to a single element. If given selector resolves to more than one element, the call throws an exception. - timeout : Union[float, None] - Deprecated: This option is ignored. `frame.is_hidden()` does not wait for the element to become hidden and returns immediately. Returns ------- @@ -3800,17 +3905,11 @@ async def is_hidden( """ return mapping.from_maybe_impl( - await self._impl_obj.is_hidden( - selector=selector, strict=strict, timeout=timeout - ) + await self._impl_obj.is_hidden(selector=selector, strict=strict) ) async def is_visible( - self, - selector: str, - *, - strict: typing.Optional[bool] = None, - timeout: typing.Optional[float] = None + self, selector: str, *, strict: typing.Optional[bool] = None ) -> bool: """Frame.is_visible @@ -3825,8 +3924,6 @@ async def is_visible( strict : Union[bool, None] When true, the call requires selector to resolve to a single element. If given selector resolves to more than one element, the call throws an exception. - timeout : Union[float, None] - Deprecated: This option is ignored. `frame.is_visible()` does not wait for the element to become visible and returns immediately. Returns ------- @@ -3834,9 +3931,7 @@ async def is_visible( """ return mapping.from_maybe_impl( - await self._impl_obj.is_visible( - selector=selector, strict=strict, timeout=timeout - ) + await self._impl_obj.is_visible(selector=selector, strict=strict) ) async def dispatch_event( @@ -3846,7 +3941,7 @@ async def dispatch_event( event_init: typing.Optional[typing.Dict] = None, *, strict: typing.Optional[bool] = None, - timeout: typing.Optional[float] = None + timeout: typing.Optional[float] = None, ) -> None: """Frame.dispatch_event @@ -3916,7 +4011,7 @@ async def eval_on_selector( expression: str, arg: typing.Optional[typing.Any] = None, *, - strict: typing.Optional[bool] = None + strict: typing.Optional[bool] = None, ) -> typing.Any: """Frame.eval_on_selector @@ -4022,7 +4117,7 @@ async def set_content( timeout: typing.Optional[float] = None, wait_until: typing.Optional[ Literal["commit", "domcontentloaded", "load", "networkidle"] - ] = None + ] = None, ) -> None: """Frame.set_content @@ -4070,9 +4165,9 @@ async def add_script_tag( self, *, url: typing.Optional[str] = None, - path: typing.Optional[typing.Union[str, pathlib.Path]] = None, + path: typing.Optional[typing.Union[pathlib.Path, str]] = None, content: typing.Optional[str] = None, - type: typing.Optional[str] = None + type: typing.Optional[str] = None, ) -> "ElementHandle": """Frame.add_script_tag @@ -4108,8 +4203,8 @@ async def add_style_tag( self, *, url: typing.Optional[str] = None, - path: typing.Optional[typing.Union[str, pathlib.Path]] = None, - content: typing.Optional[str] = None + path: typing.Optional[typing.Union[pathlib.Path, str]] = None, + content: typing.Optional[str] = None, ) -> "ElementHandle": """Frame.add_style_tag @@ -4152,7 +4247,7 @@ async def click( force: typing.Optional[bool] = None, no_wait_after: typing.Optional[bool] = None, strict: typing.Optional[bool] = None, - trial: typing.Optional[bool] = None + trial: typing.Optional[bool] = None, ) -> None: """Frame.click @@ -4200,7 +4295,9 @@ async def click( element, the call throws an exception. trial : Union[bool, None] When set, this method only performs the [actionability](../actionability.md) checks and skips the action. Defaults - to `false`. Useful to wait until the element is ready for the action without performing it. + to `false`. Useful to wait until the element is ready for the action without performing it. Note that keyboard + `modifiers` will be pressed regardless of `trial` to allow testing elements which are only visible when those keys + are pressed. """ return mapping.from_maybe_impl( @@ -4233,7 +4330,7 @@ async def dblclick( force: typing.Optional[bool] = None, no_wait_after: typing.Optional[bool] = None, strict: typing.Optional[bool] = None, - trial: typing.Optional[bool] = None + trial: typing.Optional[bool] = None, ) -> None: """Frame.dblclick @@ -4279,7 +4376,9 @@ async def dblclick( element, the call throws an exception. trial : Union[bool, None] When set, this method only performs the [actionability](../actionability.md) checks and skips the action. Defaults - to `false`. Useful to wait until the element is ready for the action without performing it. + to `false`. Useful to wait until the element is ready for the action without performing it. Note that keyboard + `modifiers` will be pressed regardless of `trial` to allow testing elements which are only visible when those keys + are pressed. """ return mapping.from_maybe_impl( @@ -4309,7 +4408,7 @@ async def tap( force: typing.Optional[bool] = None, no_wait_after: typing.Optional[bool] = None, strict: typing.Optional[bool] = None, - trial: typing.Optional[bool] = None + trial: typing.Optional[bool] = None, ) -> None: """Frame.tap @@ -4350,7 +4449,9 @@ async def tap( element, the call throws an exception. trial : Union[bool, None] When set, this method only performs the [actionability](../actionability.md) checks and skips the action. Defaults - to `false`. Useful to wait until the element is ready for the action without performing it. + to `false`. Useful to wait until the element is ready for the action without performing it. Note that keyboard + `modifiers` will be pressed regardless of `trial` to allow testing elements which are only visible when those keys + are pressed. """ return mapping.from_maybe_impl( @@ -4374,7 +4475,7 @@ async def fill( timeout: typing.Optional[float] = None, no_wait_after: typing.Optional[bool] = None, strict: typing.Optional[bool] = None, - force: typing.Optional[bool] = None + force: typing.Optional[bool] = None, ) -> None: """Frame.fill @@ -4424,10 +4525,10 @@ def locator( self, selector: str, *, - has_text: typing.Optional[typing.Union[str, typing.Pattern[str]]] = None, - has_not_text: typing.Optional[typing.Union[str, typing.Pattern[str]]] = None, + has_text: typing.Optional[typing.Union[typing.Pattern[str], str]] = None, + has_not_text: typing.Optional[typing.Union[typing.Pattern[str], str]] = None, has: typing.Optional["Locator"] = None, - has_not: typing.Optional["Locator"] = None + has_not: typing.Optional["Locator"] = None, ) -> "Locator": """Frame.locator @@ -4485,7 +4586,7 @@ def get_by_alt_text( self, text: typing.Union[str, typing.Pattern[str]], *, - exact: typing.Optional[bool] = None + exact: typing.Optional[bool] = None, ) -> "Locator": """Frame.get_by_alt_text @@ -4522,7 +4623,7 @@ def get_by_label( self, text: typing.Union[str, typing.Pattern[str]], *, - exact: typing.Optional[bool] = None + exact: typing.Optional[bool] = None, ) -> "Locator": """Frame.get_by_label @@ -4563,7 +4664,7 @@ def get_by_placeholder( self, text: typing.Union[str, typing.Pattern[str]], *, - exact: typing.Optional[bool] = None + exact: typing.Optional[bool] = None, ) -> "Locator": """Frame.get_by_placeholder @@ -4692,10 +4793,10 @@ def get_by_role( expanded: typing.Optional[bool] = None, include_hidden: typing.Optional[bool] = None, level: typing.Optional[int] = None, - name: typing.Optional[typing.Union[str, typing.Pattern[str]]] = None, + name: typing.Optional[typing.Union[typing.Pattern[str], str]] = None, pressed: typing.Optional[bool] = None, selected: typing.Optional[bool] = None, - exact: typing.Optional[bool] = None + exact: typing.Optional[bool] = None, ) -> "Locator": """Frame.get_by_role @@ -4749,6 +4850,7 @@ def get_by_role( **NOTE** Unlike most other attributes, `disabled` is inherited through the DOM hierarchy. Learn more about [`aria-disabled`](https://www.w3.org/TR/wai-aria-1.2/#aria-disabled). + expanded : Union[bool, None] An attribute that is usually set by `aria-expanded`. @@ -4842,7 +4944,7 @@ def get_by_text( self, text: typing.Union[str, typing.Pattern[str]], *, - exact: typing.Optional[bool] = None + exact: typing.Optional[bool] = None, ) -> "Locator": """Frame.get_by_text @@ -4906,7 +5008,7 @@ def get_by_title( self, text: typing.Union[str, typing.Pattern[str]], *, - exact: typing.Optional[bool] = None + exact: typing.Optional[bool] = None, ) -> "Locator": """Frame.get_by_title @@ -4974,7 +5076,7 @@ async def focus( selector: str, *, strict: typing.Optional[bool] = None, - timeout: typing.Optional[float] = None + timeout: typing.Optional[float] = None, ) -> None: """Frame.focus @@ -5005,7 +5107,7 @@ async def text_content( selector: str, *, strict: typing.Optional[bool] = None, - timeout: typing.Optional[float] = None + timeout: typing.Optional[float] = None, ) -> typing.Optional[str]: """Frame.text_content @@ -5039,7 +5141,7 @@ async def inner_text( selector: str, *, strict: typing.Optional[bool] = None, - timeout: typing.Optional[float] = None + timeout: typing.Optional[float] = None, ) -> str: """Frame.inner_text @@ -5073,7 +5175,7 @@ async def inner_html( selector: str, *, strict: typing.Optional[bool] = None, - timeout: typing.Optional[float] = None + timeout: typing.Optional[float] = None, ) -> str: """Frame.inner_html @@ -5108,7 +5210,7 @@ async def get_attribute( name: str, *, strict: typing.Optional[bool] = None, - timeout: typing.Optional[float] = None + timeout: typing.Optional[float] = None, ) -> typing.Optional[str]: """Frame.get_attribute @@ -5151,7 +5253,7 @@ async def hover( no_wait_after: typing.Optional[bool] = None, force: typing.Optional[bool] = None, strict: typing.Optional[bool] = None, - trial: typing.Optional[bool] = None + trial: typing.Optional[bool] = None, ) -> None: """Frame.hover @@ -5190,7 +5292,9 @@ async def hover( element, the call throws an exception. trial : Union[bool, None] When set, this method only performs the [actionability](../actionability.md) checks and skips the action. Defaults - to `false`. Useful to wait until the element is ready for the action without performing it. + to `false`. Useful to wait until the element is ready for the action without performing it. Note that keyboard + `modifiers` will be pressed regardless of `trial` to allow testing elements which are only visible when those keys + are pressed. """ return mapping.from_maybe_impl( @@ -5217,7 +5321,8 @@ async def drag_and_drop( no_wait_after: typing.Optional[bool] = None, strict: typing.Optional[bool] = None, timeout: typing.Optional[float] = None, - trial: typing.Optional[bool] = None + trial: typing.Optional[bool] = None, + steps: typing.Optional[int] = None, ) -> None: """Frame.drag_and_drop @@ -5249,6 +5354,9 @@ async def drag_and_drop( trial : Union[bool, None] When set, this method only performs the [actionability](../actionability.md) checks and skips the action. Defaults to `false`. Useful to wait until the element is ready for the action without performing it. + steps : Union[int, None] + Defaults to 1. Sends `n` interpolated `mousemove` events to represent travel between the `mousedown` and `mouseup` + of the drag. When set to 1, emits a single `mousemove` event at the destination location. """ return mapping.from_maybe_impl( @@ -5262,6 +5370,7 @@ async def drag_and_drop( strict=strict, timeout=timeout, trial=trial, + steps=steps, ) ) @@ -5278,7 +5387,7 @@ async def select_option( timeout: typing.Optional[float] = None, no_wait_after: typing.Optional[bool] = None, strict: typing.Optional[bool] = None, - force: typing.Optional[bool] = None + force: typing.Optional[bool] = None, ) -> typing.List[str]: """Frame.select_option @@ -5355,7 +5464,7 @@ async def input_value( selector: str, *, strict: typing.Optional[bool] = None, - timeout: typing.Optional[float] = None + timeout: typing.Optional[float] = None, ) -> str: """Frame.input_value @@ -5401,7 +5510,7 @@ async def set_input_files( *, strict: typing.Optional[bool] = None, timeout: typing.Optional[float] = None, - no_wait_after: typing.Optional[bool] = None + no_wait_after: typing.Optional[bool] = None, ) -> None: """Frame.set_input_files @@ -5448,7 +5557,7 @@ async def type( delay: typing.Optional[float] = None, strict: typing.Optional[bool] = None, timeout: typing.Optional[float] = None, - no_wait_after: typing.Optional[bool] = None + no_wait_after: typing.Optional[bool] = None, ) -> None: """Frame.type @@ -5498,7 +5607,7 @@ async def press( delay: typing.Optional[float] = None, strict: typing.Optional[bool] = None, timeout: typing.Optional[float] = None, - no_wait_after: typing.Optional[bool] = None + no_wait_after: typing.Optional[bool] = None, ) -> None: """Frame.press @@ -5564,7 +5673,7 @@ async def check( force: typing.Optional[bool] = None, no_wait_after: typing.Optional[bool] = None, strict: typing.Optional[bool] = None, - trial: typing.Optional[bool] = None + trial: typing.Optional[bool] = None, ) -> None: """Frame.check @@ -5626,7 +5735,7 @@ async def uncheck( force: typing.Optional[bool] = None, no_wait_after: typing.Optional[bool] = None, strict: typing.Optional[bool] = None, - trial: typing.Optional[bool] = None + trial: typing.Optional[bool] = None, ) -> None: """Frame.uncheck @@ -5703,7 +5812,7 @@ async def wait_for_function( *, arg: typing.Optional[typing.Any] = None, timeout: typing.Optional[float] = None, - polling: typing.Optional[typing.Union[float, Literal["raf"]]] = None + polling: typing.Optional[typing.Union[float, Literal["raf"]]] = None, ) -> "JSHandle": """Frame.wait_for_function @@ -5790,7 +5899,7 @@ async def set_checked( force: typing.Optional[bool] = None, no_wait_after: typing.Optional[bool] = None, strict: typing.Optional[bool] = None, - trial: typing.Optional[bool] = None + trial: typing.Optional[bool] = None, ) -> None: """Frame.set_checked @@ -5851,6 +5960,7 @@ async def set_checked( class FrameLocator(AsyncBase): + @property def first(self) -> "FrameLocator": """FrameLocator.first @@ -5889,7 +5999,7 @@ def owner(self) -> "Locator": **Usage** ```py - frame_locator = page.frame_locator(\"iframe[name=\\\"embedded\\\"]\") + frame_locator = page.locator(\"iframe[name=\\\"embedded\\\"]\").content_frame # ... locator = frame_locator.owner await expect(locator).to_be_visible() @@ -5905,10 +6015,10 @@ def locator( self, selector_or_locator: typing.Union["Locator", str], *, - has_text: typing.Optional[typing.Union[str, typing.Pattern[str]]] = None, - has_not_text: typing.Optional[typing.Union[str, typing.Pattern[str]]] = None, + has_text: typing.Optional[typing.Union[typing.Pattern[str], str]] = None, + has_not_text: typing.Optional[typing.Union[typing.Pattern[str], str]] = None, has: typing.Optional["Locator"] = None, - has_not: typing.Optional["Locator"] = None + has_not: typing.Optional["Locator"] = None, ) -> "Locator": """FrameLocator.locator @@ -5963,7 +6073,7 @@ def get_by_alt_text( self, text: typing.Union[str, typing.Pattern[str]], *, - exact: typing.Optional[bool] = None + exact: typing.Optional[bool] = None, ) -> "Locator": """FrameLocator.get_by_alt_text @@ -6000,7 +6110,7 @@ def get_by_label( self, text: typing.Union[str, typing.Pattern[str]], *, - exact: typing.Optional[bool] = None + exact: typing.Optional[bool] = None, ) -> "Locator": """FrameLocator.get_by_label @@ -6041,7 +6151,7 @@ def get_by_placeholder( self, text: typing.Union[str, typing.Pattern[str]], *, - exact: typing.Optional[bool] = None + exact: typing.Optional[bool] = None, ) -> "Locator": """FrameLocator.get_by_placeholder @@ -6170,10 +6280,10 @@ def get_by_role( expanded: typing.Optional[bool] = None, include_hidden: typing.Optional[bool] = None, level: typing.Optional[int] = None, - name: typing.Optional[typing.Union[str, typing.Pattern[str]]] = None, + name: typing.Optional[typing.Union[typing.Pattern[str], str]] = None, pressed: typing.Optional[bool] = None, selected: typing.Optional[bool] = None, - exact: typing.Optional[bool] = None + exact: typing.Optional[bool] = None, ) -> "Locator": """FrameLocator.get_by_role @@ -6227,6 +6337,7 @@ def get_by_role( **NOTE** Unlike most other attributes, `disabled` is inherited through the DOM hierarchy. Learn more about [`aria-disabled`](https://www.w3.org/TR/wai-aria-1.2/#aria-disabled). + expanded : Union[bool, None] An attribute that is usually set by `aria-expanded`. @@ -6320,7 +6431,7 @@ def get_by_text( self, text: typing.Union[str, typing.Pattern[str]], *, - exact: typing.Optional[bool] = None + exact: typing.Optional[bool] = None, ) -> "Locator": """FrameLocator.get_by_text @@ -6384,7 +6495,7 @@ def get_by_title( self, text: typing.Union[str, typing.Pattern[str]], *, - exact: typing.Optional[bool] = None + exact: typing.Optional[bool] = None, ) -> "Locator": """FrameLocator.get_by_title @@ -6458,6 +6569,8 @@ def nth(self, index: int) -> "FrameLocator": class Worker(AsyncBase): + + @typing.overload def on( self, event: Literal["close"], @@ -6466,8 +6579,27 @@ def on( """ Emitted when this dedicated [WebWorker](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API) is terminated.""" + + @typing.overload + def on( + self, + event: Literal["console"], + f: typing.Callable[ + ["ConsoleMessage"], "typing.Union[typing.Awaitable[None], None]" + ], + ) -> None: + """ + Emitted when JavaScript within the worker calls one of console API methods, e.g. `console.log` or `console.dir`. + """ + + def on( + self, + event: str, + f: typing.Callable[..., typing.Union[typing.Awaitable[None], None]], + ) -> None: return super().on(event=event, f=f) + @typing.overload def once( self, event: Literal["close"], @@ -6476,6 +6608,24 @@ def once( """ Emitted when this dedicated [WebWorker](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API) is terminated.""" + + @typing.overload + def once( + self, + event: Literal["console"], + f: typing.Callable[ + ["ConsoleMessage"], "typing.Union[typing.Awaitable[None], None]" + ], + ) -> None: + """ + Emitted when JavaScript within the worker calls one of console API methods, e.g. `console.log` or `console.dir`. + """ + + def once( + self, + event: str, + f: typing.Callable[..., typing.Union[typing.Awaitable[None], None]], + ) -> None: return super().once(event=event, f=f) @property @@ -6553,18 +6703,60 @@ async def evaluate_handle( ) ) + def expect_event( + self, + event: str, + predicate: typing.Optional[typing.Callable] = None, + *, + timeout: typing.Optional[float] = None, + ) -> AsyncEventContextManager: + """Worker.expect_event -mapping.register(WorkerImpl, Worker) + Waits for event to fire and passes its value into the predicate function. Returns when the predicate returns truthy + value. Will throw an error if the page is closed before the event is fired. Returns the event data value. + **Usage** -class Selectors(AsyncBase): - async def register( + ```py + async with worker.expect_event(\"console\") as event_info: + await worker.evaluate(\"console.log(42)\") + message = await event_info.value + ``` + + Parameters + ---------- + event : str + Event name, same one typically passed into `*.on(event)`. + predicate : Union[Callable, None] + Receives the event data and resolves to truthy value when the waiting should resolve. + timeout : Union[float, None] + Maximum time to wait for in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The + default value can be changed by using the `browser_context.set_default_timeout()`. + + Returns + ------- + EventContextManager + """ + + return AsyncEventContextManager( + self._impl_obj.expect_event( + event=event, predicate=self._wrap_handler(predicate), timeout=timeout + ).future + ) + + +mapping.register(WorkerImpl, Worker) + + +class Selectors(AsyncBase): + + async def register( self, name: str, script: typing.Optional[str] = None, *, - path: typing.Optional[typing.Union[str, pathlib.Path]] = None, - content_script: typing.Optional[bool] = None + path: typing.Optional[typing.Union[pathlib.Path, str]] = None, + content_script: typing.Optional[bool] = None, ) -> None: """Selectors.register @@ -6655,10 +6847,11 @@ def set_test_id_attribute(self, attribute_name: str) -> None: class Clock(AsyncBase): + async def install( self, *, - time: typing.Optional[typing.Union[float, str, datetime.datetime]] = None + time: typing.Optional[typing.Union[float, str, datetime.datetime]] = None, ) -> None: """Clock.install @@ -6725,6 +6918,18 @@ async def pause_at(self, time: typing.Union[float, str, datetime.datetime]) -> N await page.clock.pause_at(\"2020-02-02\") ``` + For best results, install the clock before navigating the page and set it to a time slightly before the intended + test time. This ensures that all timers run normally during page loading, preventing the page from getting stuck. + Once the page has fully loaded, you can safely use `clock.pause_at()` to pause the clock. + + ```py + # Initialize clock with some time before the test time and let the page load + # naturally. `Date.now` will progress as the timers fire. + await page.clock.install(time=datetime.datetime(2024, 12, 10, 8, 0, 0)) + await page.goto(\"http://localhost:3333\") + await page.clock.pause_at(datetime.datetime(2024, 12, 10, 10, 0, 0)) + ``` + Parameters ---------- time : Union[datetime.datetime, float, str] @@ -6769,6 +6974,9 @@ async def set_fixed_time( Makes `Date.now` and `new Date()` return fixed fake time at all times, keeps all the timers running. + Use this method for simple scenarios where you only need to test with a predefined time. For more advanced + scenarios, use `clock.install()` instead. Read docs on [clock emulation](https://playwright.dev/python/docs/clock) to learn more. + **Usage** ```py @@ -6790,7 +6998,8 @@ async def set_system_time( ) -> None: """Clock.set_system_time - Sets current system time but does not trigger any timers. + Sets system time, but does not trigger any timers. Use this to test how the web page reacts to a time shift, for + example switching from summer to winter time, or changing time zones. **Usage** @@ -6813,17 +7022,36 @@ async def set_system_time( class ConsoleMessage(AsyncBase): + @property - def type(self) -> str: + def type( + self, + ) -> typing.Union[ + Literal["assert"], + Literal["clear"], + Literal["count"], + Literal["debug"], + Literal["dir"], + Literal["dirxml"], + Literal["endGroup"], + Literal["error"], + Literal["info"], + Literal["log"], + Literal["profile"], + Literal["profileEnd"], + Literal["startGroup"], + Literal["startGroupCollapsed"], + Literal["table"], + Literal["time"], + Literal["timeEnd"], + Literal["trace"], + Literal["warning"], + ]: """ConsoleMessage.type - One of the following values: `'log'`, `'debug'`, `'info'`, `'error'`, `'warning'`, `'dir'`, `'dirxml'`, `'table'`, - `'trace'`, `'clear'`, `'startGroup'`, `'startGroupCollapsed'`, `'endGroup'`, `'assert'`, `'profile'`, - `'profileEnd'`, `'count'`, `'timeEnd'`. - Returns ------- - str + Union["assert", "clear", "count", "debug", "dir", "dirxml", "endGroup", "error", "info", "log", "profile", "profileEnd", "startGroup", "startGroupCollapsed", "table", "time", "timeEnd", "trace", "warning"] """ return mapping.from_maybe_impl(self._impl_obj.type) @@ -6873,11 +7101,25 @@ def page(self) -> typing.Optional["Page"]: """ return mapping.from_impl_nullable(self._impl_obj.page) + @property + def worker(self) -> typing.Optional["Worker"]: + """ConsoleMessage.worker + + The web worker or service worker that produced this console message, if any. Note that console messages from web + workers also have non-null `console_message.page()`. + + Returns + ------- + Union[Worker, None] + """ + return mapping.from_impl_nullable(self._impl_obj.worker) + mapping.register(ConsoleMessageImpl, ConsoleMessage) class Dialog(AsyncBase): + @property def type(self) -> str: """Dialog.type @@ -6954,6 +7196,7 @@ async def dismiss(self) -> None: class Download(AsyncBase): + @property def page(self) -> "Page": """Download.page @@ -7063,6 +7306,7 @@ async def cancel(self) -> None: class Video(AsyncBase): + async def path(self) -> pathlib.Path: """Video.path @@ -7103,6 +7347,7 @@ async def delete(self) -> None: class Page(AsyncContextManager): + @typing.overload def on( self, @@ -7643,16 +7888,6 @@ def once( ) -> None: return super().once(event=event, f=f) - @property - def accessibility(self) -> "Accessibility": - """Page.accessibility - - Returns - ------- - Accessibility - """ - return mapping.from_impl(self._impl_obj.accessibility) - @property def keyboard(self) -> "Keyboard": """Page.keyboard @@ -7810,7 +8045,7 @@ def frame( *, url: typing.Optional[ typing.Union[str, typing.Pattern[str], typing.Callable[[str], bool]] - ] = None + ] = None, ) -> typing.Optional["Frame"]: """Page.frame @@ -7873,7 +8108,7 @@ def set_default_timeout(self, timeout: float) -> None: Parameters ---------- timeout : float - Maximum time in milliseconds + Maximum time in milliseconds. Pass `0` to disable timeout. """ return mapping.from_maybe_impl( @@ -7933,7 +8168,7 @@ async def wait_for_selector( state: typing.Optional[ Literal["attached", "detached", "hidden", "visible"] ] = None, - strict: typing.Optional[bool] = None + strict: typing.Optional[bool] = None, ) -> typing.Optional["ElementHandle"]: """Page.wait_for_selector @@ -8006,7 +8241,7 @@ async def is_checked( selector: str, *, strict: typing.Optional[bool] = None, - timeout: typing.Optional[float] = None + timeout: typing.Optional[float] = None, ) -> bool: """Page.is_checked @@ -8040,7 +8275,7 @@ async def is_disabled( selector: str, *, strict: typing.Optional[bool] = None, - timeout: typing.Optional[float] = None + timeout: typing.Optional[float] = None, ) -> bool: """Page.is_disabled @@ -8074,7 +8309,7 @@ async def is_editable( selector: str, *, strict: typing.Optional[bool] = None, - timeout: typing.Optional[float] = None + timeout: typing.Optional[float] = None, ) -> bool: """Page.is_editable @@ -8108,7 +8343,7 @@ async def is_enabled( selector: str, *, strict: typing.Optional[bool] = None, - timeout: typing.Optional[float] = None + timeout: typing.Optional[float] = None, ) -> bool: """Page.is_enabled @@ -8142,7 +8377,7 @@ async def is_hidden( selector: str, *, strict: typing.Optional[bool] = None, - timeout: typing.Optional[float] = None + timeout: typing.Optional[float] = None, ) -> bool: """Page.is_hidden @@ -8176,7 +8411,7 @@ async def is_visible( selector: str, *, strict: typing.Optional[bool] = None, - timeout: typing.Optional[float] = None + timeout: typing.Optional[float] = None, ) -> bool: """Page.is_visible @@ -8212,7 +8447,7 @@ async def dispatch_event( event_init: typing.Optional[typing.Dict] = None, *, timeout: typing.Optional[float] = None, - strict: typing.Optional[bool] = None + strict: typing.Optional[bool] = None, ) -> None: """Page.dispatch_event @@ -8394,7 +8629,7 @@ async def eval_on_selector( expression: str, arg: typing.Optional[typing.Any] = None, *, - strict: typing.Optional[bool] = None + strict: typing.Optional[bool] = None, ) -> typing.Any: """Page.eval_on_selector @@ -8481,9 +8716,9 @@ async def add_script_tag( self, *, url: typing.Optional[str] = None, - path: typing.Optional[typing.Union[str, pathlib.Path]] = None, + path: typing.Optional[typing.Union[pathlib.Path, str]] = None, content: typing.Optional[str] = None, - type: typing.Optional[str] = None + type: typing.Optional[str] = None, ) -> "ElementHandle": """Page.add_script_tag @@ -8518,8 +8753,8 @@ async def add_style_tag( self, *, url: typing.Optional[str] = None, - path: typing.Optional[typing.Union[str, pathlib.Path]] = None, - content: typing.Optional[str] = None + path: typing.Optional[typing.Union[pathlib.Path, str]] = None, + content: typing.Optional[str] = None, ) -> "ElementHandle": """Page.add_style_tag @@ -8612,7 +8847,7 @@ async def expose_binding( name: str, callback: typing.Callable, *, - handle: typing.Optional[bool] = None + handle: typing.Optional[bool] = None, ) -> None: """Page.expose_binding @@ -8714,7 +8949,7 @@ async def set_content( timeout: typing.Optional[float] = None, wait_until: typing.Optional[ Literal["commit", "domcontentloaded", "load", "networkidle"] - ] = None + ] = None, ) -> None: """Page.set_content @@ -8754,7 +8989,7 @@ async def goto( wait_until: typing.Optional[ Literal["commit", "domcontentloaded", "load", "networkidle"] ] = None, - referer: typing.Optional[str] = None + referer: typing.Optional[str] = None, ) -> typing.Optional["Response"]: """Page.goto @@ -8818,7 +9053,7 @@ async def reload( timeout: typing.Optional[float] = None, wait_until: typing.Optional[ Literal["commit", "domcontentloaded", "load", "networkidle"] - ] = None + ] = None, ) -> typing.Optional["Response"]: """Page.reload @@ -8857,7 +9092,7 @@ async def wait_for_load_state( Literal["domcontentloaded", "load", "networkidle"] ] = None, *, - timeout: typing.Optional[float] = None + timeout: typing.Optional[float] = None, ) -> None: """Page.wait_for_load_state @@ -8913,7 +9148,7 @@ async def wait_for_url( wait_until: typing.Optional[ Literal["commit", "domcontentloaded", "load", "networkidle"] ] = None, - timeout: typing.Optional[float] = None + timeout: typing.Optional[float] = None, ) -> None: """Page.wait_for_url @@ -8958,7 +9193,7 @@ async def wait_for_event( event: str, predicate: typing.Optional[typing.Callable] = None, *, - timeout: typing.Optional[float] = None + timeout: typing.Optional[float] = None, ) -> typing.Any: """Page.wait_for_event @@ -8995,7 +9230,7 @@ async def go_back( timeout: typing.Optional[float] = None, wait_until: typing.Optional[ Literal["commit", "domcontentloaded", "load", "networkidle"] - ] = None + ] = None, ) -> typing.Optional["Response"]: """Page.go_back @@ -9035,7 +9270,7 @@ async def go_forward( timeout: typing.Optional[float] = None, wait_until: typing.Optional[ Literal["commit", "domcontentloaded", "load", "networkidle"] - ] = None + ] = None, ) -> typing.Optional["Response"]: """Page.go_forward @@ -9069,6 +9304,28 @@ async def go_forward( await self._impl_obj.go_forward(timeout=timeout, waitUntil=wait_until) ) + async def request_gc(self) -> None: + """Page.request_gc + + Request the page to perform garbage collection. Note that there is no guarantee that all unreachable objects will + be collected. + + This is useful to help detect memory leaks. For example, if your page has a large object `'suspect'` that might be + leaked, you can check that it does not leak by using a + [`WeakRef`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/WeakRef). + + ```py + # 1. In your page, save a WeakRef for the \"suspect\". + await page.evaluate(\"globalThis.suspectWeakRef = new WeakRef(suspect)\") + # 2. Request garbage collection. + await page.request_gc() + # 3. Check that weak ref does not deref to the original object. + assert await page.evaluate(\"!globalThis.suspectWeakRef.deref()\") + ``` + """ + + return mapping.from_maybe_impl(await self._impl_obj.request_gc()) + async def emulate_media( self, *, @@ -9079,7 +9336,8 @@ async def emulate_media( reduced_motion: typing.Optional[ Literal["no-preference", "null", "reduce"] ] = None, - forced_colors: typing.Optional[Literal["active", "none", "null"]] = None + forced_colors: typing.Optional[Literal["active", "none", "null"]] = None, + contrast: typing.Optional[Literal["more", "no-preference", "null"]] = None, ) -> None: """Page.emulate_media @@ -9113,8 +9371,6 @@ async def emulate_media( # → True await page.evaluate(\"matchMedia('(prefers-color-scheme: light)').matches\") # → False - await page.evaluate(\"matchMedia('(prefers-color-scheme: no-preference)').matches\") - # → False ``` Parameters @@ -9123,12 +9379,14 @@ async def emulate_media( Changes the CSS media type of the page. The only allowed values are `'Screen'`, `'Print'` and `'Null'`. Passing `'Null'` disables CSS media emulation. color_scheme : Union["dark", "light", "no-preference", "null", None] - Emulates `'prefers-colors-scheme'` media feature, supported values are `'light'`, `'dark'`, `'no-preference'`. - Passing `'Null'` disables color scheme emulation. + Emulates [prefers-colors-scheme](https://developer.mozilla.org/en-US/docs/Web/CSS/@media/prefers-color-scheme) + media feature, supported values are `'light'` and `'dark'`. Passing `'Null'` disables color scheme emulation. + `'no-preference'` is deprecated. reduced_motion : Union["no-preference", "null", "reduce", None] Emulates `'prefers-reduced-motion'` media feature, supported values are `'reduce'`, `'no-preference'`. Passing `null` disables reduced motion emulation. forced_colors : Union["active", "none", "null", None] + contrast : Union["more", "no-preference", "null", None] """ return mapping.from_maybe_impl( @@ -9137,6 +9395,7 @@ async def emulate_media( colorScheme=color_scheme, reducedMotion=reduced_motion, forcedColors=forced_colors, + contrast=contrast, ) ) @@ -9180,7 +9439,7 @@ async def add_init_script( self, script: typing.Optional[str] = None, *, - path: typing.Optional[typing.Union[str, pathlib.Path]] = None + path: typing.Optional[typing.Union[pathlib.Path, str]] = None, ) -> None: """Page.add_init_script @@ -9225,7 +9484,7 @@ async def route( typing.Callable[["Route", "Request"], typing.Any], ], *, - times: typing.Optional[int] = None + times: typing.Optional[int] = None, ) -> None: """Page.route @@ -9238,7 +9497,7 @@ async def route( **NOTE** `page.route()` will not intercept requests intercepted by Service Worker. See [this](https://github.com/microsoft/playwright/issues/1090) issue. We recommend disabling Service Workers when - using request interception by setting `Browser.newContext.serviceWorkers` to `'block'`. + using request interception by setting `serviceWorkers` to `'block'`. **NOTE** `page.route()` will not intercept the first request of a popup page. Use `browser_context.route()` instead. @@ -9285,8 +9544,8 @@ async def handle_route(route: Route): Parameters ---------- url : Union[Callable[[str], bool], Pattern[str], str] - A glob pattern, regex pattern or predicate receiving [URL] to match while routing. When a `baseURL` via the context - options was provided and the passed URL is a path, it gets merged via the + A glob pattern, regex pattern, or predicate that receives a [URL] to match during routing. If `baseURL` is set in + the context options and the provided URL is a string that does not start with `*`, it is resolved using the [`new URL()`](https://developer.mozilla.org/en-US/docs/Web/API/URL/URL) constructor. handler : Union[Callable[[Route, Request], Any], Callable[[Route], Any]] handler function to route the request. @@ -9331,10 +9590,53 @@ async def unroute( ) ) + async def route_web_socket( + self, + url: typing.Union[str, typing.Pattern[str], typing.Callable[[str], bool]], + handler: typing.Callable[["WebSocketRoute"], typing.Any], + ) -> None: + """Page.route_web_socket + + This method allows to modify websocket connections that are made by the page. + + Note that only `WebSocket`s created after this method was called will be routed. It is recommended to call this + method before navigating the page. + + **Usage** + + Below is an example of a simple mock that responds to a single message. See `WebSocketRoute` for more details and + examples. + + ```py + def message_handler(ws: WebSocketRoute, message: Union[str, bytes]): + if message == \"request\": + ws.send(\"response\") + + def handler(ws: WebSocketRoute): + ws.on_message(lambda message: message_handler(ws, message)) + + await page.route_web_socket(\"/ws\", handler) + ``` + + Parameters + ---------- + url : Union[Callable[[str], bool], Pattern[str], str] + Only WebSockets with the url matching this pattern will be routed. A string pattern can be relative to the + `baseURL` context option. + handler : Callable[[WebSocketRoute], Any] + Handler function to route the WebSocket. + """ + + return mapping.from_maybe_impl( + await self._impl_obj.route_web_socket( + url=self._wrap_handler(url), handler=self._wrap_handler(handler) + ) + ) + async def unroute_all( self, *, - behavior: typing.Optional[Literal["default", "ignoreErrors", "wait"]] = None + behavior: typing.Optional[Literal["default", "ignoreErrors", "wait"]] = None, ) -> None: """Page.unroute_all @@ -9359,11 +9661,11 @@ async def route_from_har( self, har: typing.Union[pathlib.Path, str], *, - url: typing.Optional[typing.Union[str, typing.Pattern[str]]] = None, + url: typing.Optional[typing.Union[typing.Pattern[str], str]] = None, not_found: typing.Optional[Literal["abort", "fallback"]] = None, update: typing.Optional[bool] = None, update_content: typing.Optional[Literal["attach", "embed"]] = None, - update_mode: typing.Optional[Literal["full", "minimal"]] = None + update_mode: typing.Optional[Literal["full", "minimal"]] = None, ) -> None: """Page.route_from_har @@ -9372,7 +9674,7 @@ async def route_from_har( Playwright will not serve requests intercepted by Service Worker from the HAR file. See [this](https://github.com/microsoft/playwright/issues/1090) issue. We recommend disabling Service Workers when - using request interception by setting `Browser.newContext.serviceWorkers` to `'block'`. + using request interception by setting `serviceWorkers` to `'block'`. Parameters ---------- @@ -9415,7 +9717,7 @@ async def screenshot( *, timeout: typing.Optional[float] = None, type: typing.Optional[Literal["jpeg", "png"]] = None, - path: typing.Optional[typing.Union[str, pathlib.Path]] = None, + path: typing.Optional[typing.Union[pathlib.Path, str]] = None, quality: typing.Optional[int] = None, omit_background: typing.Optional[bool] = None, full_page: typing.Optional[bool] = None, @@ -9425,7 +9727,7 @@ async def screenshot( scale: typing.Optional[Literal["css", "device"]] = None, mask: typing.Optional[typing.Sequence["Locator"]] = None, mask_color: typing.Optional[str] = None, - style: typing.Optional[str] = None + style: typing.Optional[str] = None, ) -> bytes: """Page.screenshot @@ -9470,7 +9772,9 @@ async def screenshot( Defaults to `"device"`. mask : Union[Sequence[Locator], None] Specify locators that should be masked when the screenshot is taken. Masked elements will be overlaid with a pink - box `#FF00FF` (customized by `maskColor`) that completely covers its bounding box. + box `#FF00FF` (customized by `maskColor`) that completely covers its bounding box. The mask is also applied to + invisible elements, see [Matching only visible elements](../locators.md#matching-only-visible-elements) to disable + that. mask_color : Union[str, None] Specify the color of the overlay box for masked elements, in [CSS color format](https://developer.mozilla.org/en-US/docs/Web/CSS/color_value). Default color is pink `#FF00FF`. @@ -9518,7 +9822,7 @@ async def close( self, *, run_before_unload: typing.Optional[bool] = None, - reason: typing.Optional[str] = None + reason: typing.Optional[str] = None, ) -> None: """Page.close @@ -9570,7 +9874,7 @@ async def click( force: typing.Optional[bool] = None, no_wait_after: typing.Optional[bool] = None, trial: typing.Optional[bool] = None, - strict: typing.Optional[bool] = None + strict: typing.Optional[bool] = None, ) -> None: """Page.click @@ -9615,7 +9919,9 @@ async def click( Deprecated: This option will default to `true` in the future. trial : Union[bool, None] When set, this method only performs the [actionability](../actionability.md) checks and skips the action. Defaults - to `false`. Useful to wait until the element is ready for the action without performing it. + to `false`. Useful to wait until the element is ready for the action without performing it. Note that keyboard + `modifiers` will be pressed regardless of `trial` to allow testing elements which are only visible when those keys + are pressed. strict : Union[bool, None] When true, the call requires selector to resolve to a single element. If given selector resolves to more than one element, the call throws an exception. @@ -9651,7 +9957,7 @@ async def dblclick( force: typing.Optional[bool] = None, no_wait_after: typing.Optional[bool] = None, strict: typing.Optional[bool] = None, - trial: typing.Optional[bool] = None + trial: typing.Optional[bool] = None, ) -> None: """Page.dblclick @@ -9696,7 +10002,9 @@ async def dblclick( element, the call throws an exception. trial : Union[bool, None] When set, this method only performs the [actionability](../actionability.md) checks and skips the action. Defaults - to `false`. Useful to wait until the element is ready for the action without performing it. + to `false`. Useful to wait until the element is ready for the action without performing it. Note that keyboard + `modifiers` will be pressed regardless of `trial` to allow testing elements which are only visible when those keys + are pressed. """ return mapping.from_maybe_impl( @@ -9726,7 +10034,7 @@ async def tap( force: typing.Optional[bool] = None, no_wait_after: typing.Optional[bool] = None, strict: typing.Optional[bool] = None, - trial: typing.Optional[bool] = None + trial: typing.Optional[bool] = None, ) -> None: """Page.tap @@ -9767,7 +10075,9 @@ async def tap( element, the call throws an exception. trial : Union[bool, None] When set, this method only performs the [actionability](../actionability.md) checks and skips the action. Defaults - to `false`. Useful to wait until the element is ready for the action without performing it. + to `false`. Useful to wait until the element is ready for the action without performing it. Note that keyboard + `modifiers` will be pressed regardless of `trial` to allow testing elements which are only visible when those keys + are pressed. """ return mapping.from_maybe_impl( @@ -9791,7 +10101,7 @@ async def fill( timeout: typing.Optional[float] = None, no_wait_after: typing.Optional[bool] = None, strict: typing.Optional[bool] = None, - force: typing.Optional[bool] = None + force: typing.Optional[bool] = None, ) -> None: """Page.fill @@ -9841,10 +10151,10 @@ def locator( self, selector: str, *, - has_text: typing.Optional[typing.Union[str, typing.Pattern[str]]] = None, - has_not_text: typing.Optional[typing.Union[str, typing.Pattern[str]]] = None, + has_text: typing.Optional[typing.Union[typing.Pattern[str], str]] = None, + has_not_text: typing.Optional[typing.Union[typing.Pattern[str], str]] = None, has: typing.Optional["Locator"] = None, - has_not: typing.Optional["Locator"] = None + has_not: typing.Optional["Locator"] = None, ) -> "Locator": """Page.locator @@ -9900,7 +10210,7 @@ def get_by_alt_text( self, text: typing.Union[str, typing.Pattern[str]], *, - exact: typing.Optional[bool] = None + exact: typing.Optional[bool] = None, ) -> "Locator": """Page.get_by_alt_text @@ -9937,7 +10247,7 @@ def get_by_label( self, text: typing.Union[str, typing.Pattern[str]], *, - exact: typing.Optional[bool] = None + exact: typing.Optional[bool] = None, ) -> "Locator": """Page.get_by_label @@ -9978,7 +10288,7 @@ def get_by_placeholder( self, text: typing.Union[str, typing.Pattern[str]], *, - exact: typing.Optional[bool] = None + exact: typing.Optional[bool] = None, ) -> "Locator": """Page.get_by_placeholder @@ -10107,10 +10417,10 @@ def get_by_role( expanded: typing.Optional[bool] = None, include_hidden: typing.Optional[bool] = None, level: typing.Optional[int] = None, - name: typing.Optional[typing.Union[str, typing.Pattern[str]]] = None, + name: typing.Optional[typing.Union[typing.Pattern[str], str]] = None, pressed: typing.Optional[bool] = None, selected: typing.Optional[bool] = None, - exact: typing.Optional[bool] = None + exact: typing.Optional[bool] = None, ) -> "Locator": """Page.get_by_role @@ -10164,6 +10474,7 @@ def get_by_role( **NOTE** Unlike most other attributes, `disabled` is inherited through the DOM hierarchy. Learn more about [`aria-disabled`](https://www.w3.org/TR/wai-aria-1.2/#aria-disabled). + expanded : Union[bool, None] An attribute that is usually set by `aria-expanded`. @@ -10257,7 +10568,7 @@ def get_by_text( self, text: typing.Union[str, typing.Pattern[str]], *, - exact: typing.Optional[bool] = None + exact: typing.Optional[bool] = None, ) -> "Locator": """Page.get_by_text @@ -10321,7 +10632,7 @@ def get_by_title( self, text: typing.Union[str, typing.Pattern[str]], *, - exact: typing.Optional[bool] = None + exact: typing.Optional[bool] = None, ) -> "Locator": """Page.get_by_title @@ -10389,7 +10700,7 @@ async def focus( selector: str, *, strict: typing.Optional[bool] = None, - timeout: typing.Optional[float] = None + timeout: typing.Optional[float] = None, ) -> None: """Page.focus @@ -10420,7 +10731,7 @@ async def text_content( selector: str, *, strict: typing.Optional[bool] = None, - timeout: typing.Optional[float] = None + timeout: typing.Optional[float] = None, ) -> typing.Optional[str]: """Page.text_content @@ -10454,7 +10765,7 @@ async def inner_text( selector: str, *, strict: typing.Optional[bool] = None, - timeout: typing.Optional[float] = None + timeout: typing.Optional[float] = None, ) -> str: """Page.inner_text @@ -10488,7 +10799,7 @@ async def inner_html( selector: str, *, strict: typing.Optional[bool] = None, - timeout: typing.Optional[float] = None + timeout: typing.Optional[float] = None, ) -> str: """Page.inner_html @@ -10523,7 +10834,7 @@ async def get_attribute( name: str, *, strict: typing.Optional[bool] = None, - timeout: typing.Optional[float] = None + timeout: typing.Optional[float] = None, ) -> typing.Optional[str]: """Page.get_attribute @@ -10566,7 +10877,7 @@ async def hover( no_wait_after: typing.Optional[bool] = None, force: typing.Optional[bool] = None, strict: typing.Optional[bool] = None, - trial: typing.Optional[bool] = None + trial: typing.Optional[bool] = None, ) -> None: """Page.hover @@ -10605,7 +10916,9 @@ async def hover( element, the call throws an exception. trial : Union[bool, None] When set, this method only performs the [actionability](../actionability.md) checks and skips the action. Defaults - to `false`. Useful to wait until the element is ready for the action without performing it. + to `false`. Useful to wait until the element is ready for the action without performing it. Note that keyboard + `modifiers` will be pressed regardless of `trial` to allow testing elements which are only visible when those keys + are pressed. """ return mapping.from_maybe_impl( @@ -10632,7 +10945,8 @@ async def drag_and_drop( no_wait_after: typing.Optional[bool] = None, timeout: typing.Optional[float] = None, strict: typing.Optional[bool] = None, - trial: typing.Optional[bool] = None + trial: typing.Optional[bool] = None, + steps: typing.Optional[int] = None, ) -> None: """Page.drag_and_drop @@ -10680,6 +10994,9 @@ async def drag_and_drop( trial : Union[bool, None] When set, this method only performs the [actionability](../actionability.md) checks and skips the action. Defaults to `false`. Useful to wait until the element is ready for the action without performing it. + steps : Union[int, None] + Defaults to 1. Sends `n` interpolated `mousemove` events to represent travel between the `mousedown` and `mouseup` + of the drag. When set to 1, emits a single `mousemove` event at the destination location. """ return mapping.from_maybe_impl( @@ -10693,6 +11010,7 @@ async def drag_and_drop( timeout=timeout, strict=strict, trial=trial, + steps=steps, ) ) @@ -10709,7 +11027,7 @@ async def select_option( timeout: typing.Optional[float] = None, no_wait_after: typing.Optional[bool] = None, force: typing.Optional[bool] = None, - strict: typing.Optional[bool] = None + strict: typing.Optional[bool] = None, ) -> typing.List[str]: """Page.select_option @@ -10787,7 +11105,7 @@ async def input_value( selector: str, *, strict: typing.Optional[bool] = None, - timeout: typing.Optional[float] = None + timeout: typing.Optional[float] = None, ) -> str: """Page.input_value @@ -10833,7 +11151,7 @@ async def set_input_files( *, timeout: typing.Optional[float] = None, strict: typing.Optional[bool] = None, - no_wait_after: typing.Optional[bool] = None + no_wait_after: typing.Optional[bool] = None, ) -> None: """Page.set_input_files @@ -10881,7 +11199,7 @@ async def type( delay: typing.Optional[float] = None, timeout: typing.Optional[float] = None, no_wait_after: typing.Optional[bool] = None, - strict: typing.Optional[bool] = None + strict: typing.Optional[bool] = None, ) -> None: """Page.type @@ -10931,7 +11249,7 @@ async def press( delay: typing.Optional[float] = None, timeout: typing.Optional[float] = None, no_wait_after: typing.Optional[bool] = None, - strict: typing.Optional[bool] = None + strict: typing.Optional[bool] = None, ) -> None: """Page.press @@ -11013,7 +11331,7 @@ async def check( force: typing.Optional[bool] = None, no_wait_after: typing.Optional[bool] = None, strict: typing.Optional[bool] = None, - trial: typing.Optional[bool] = None + trial: typing.Optional[bool] = None, ) -> None: """Page.check @@ -11075,7 +11393,7 @@ async def uncheck( force: typing.Optional[bool] = None, no_wait_after: typing.Optional[bool] = None, strict: typing.Optional[bool] = None, - trial: typing.Optional[bool] = None + trial: typing.Optional[bool] = None, ) -> None: """Page.uncheck @@ -11159,7 +11477,7 @@ async def wait_for_function( *, arg: typing.Optional[typing.Any] = None, timeout: typing.Optional[float] = None, - polling: typing.Optional[typing.Union[float, Literal["raf"]]] = None + polling: typing.Optional[typing.Union[float, Literal["raf"]]] = None, ) -> "JSHandle": """Page.wait_for_function @@ -11227,14 +11545,13 @@ async def main(): async def pause(self) -> None: """Page.pause - Pauses script execution. Playwright will stop executing the script and wait for the user to either press 'Resume' - button in the page overlay or to call `playwright.resume()` in the DevTools console. + Pauses script execution. Playwright will stop executing the script and wait for the user to either press the + 'Resume' button in the page overlay or to call `playwright.resume()` in the DevTools console. User can inspect selectors or perform manual steps while paused. Resume will continue running the original script from the place it was paused. - **NOTE** This method requires Playwright to be started in a headed mode, with a falsy `headless` value in the - `browser_type.launch()`. + **NOTE** This method requires Playwright to be started in a headed mode, with a falsy `headless` option. """ return mapping.from_maybe_impl(await self._impl_obj.pause()) @@ -11254,16 +11571,14 @@ async def pdf( height: typing.Optional[typing.Union[str, float]] = None, prefer_css_page_size: typing.Optional[bool] = None, margin: typing.Optional[PdfMargins] = None, - path: typing.Optional[typing.Union[str, pathlib.Path]] = None, + path: typing.Optional[typing.Union[pathlib.Path, str]] = None, outline: typing.Optional[bool] = None, - tagged: typing.Optional[bool] = None + tagged: typing.Optional[bool] = None, ) -> bytes: """Page.pdf Returns the PDF buffer. - **NOTE** Generating a pdf is currently only supported in Chromium headless. - `page.pdf()` generates a pdf of the page with `print` css media. To generate a pdf with `screen` media, call `page.emulate_media()` before calling `page.pdf()`: @@ -11380,7 +11695,7 @@ def expect_event( event: str, predicate: typing.Optional[typing.Callable] = None, *, - timeout: typing.Optional[float] = None + timeout: typing.Optional[float] = None, ) -> AsyncEventContextManager: """Page.expect_event @@ -11420,7 +11735,7 @@ def expect_console_message( self, predicate: typing.Optional[typing.Callable[["ConsoleMessage"], bool]] = None, *, - timeout: typing.Optional[float] = None + timeout: typing.Optional[float] = None, ) -> AsyncEventContextManager["ConsoleMessage"]: """Page.expect_console_message @@ -11451,7 +11766,7 @@ def expect_download( self, predicate: typing.Optional[typing.Callable[["Download"], bool]] = None, *, - timeout: typing.Optional[float] = None + timeout: typing.Optional[float] = None, ) -> AsyncEventContextManager["Download"]: """Page.expect_download @@ -11482,7 +11797,7 @@ def expect_file_chooser( self, predicate: typing.Optional[typing.Callable[["FileChooser"], bool]] = None, *, - timeout: typing.Optional[float] = None + timeout: typing.Optional[float] = None, ) -> AsyncEventContextManager["FileChooser"]: """Page.expect_file_chooser @@ -11518,7 +11833,7 @@ def expect_navigation( wait_until: typing.Optional[ Literal["commit", "domcontentloaded", "load", "networkidle"] ] = None, - timeout: typing.Optional[float] = None + timeout: typing.Optional[float] = None, ) -> AsyncEventContextManager["Response"]: """Page.expect_navigation @@ -11577,7 +11892,7 @@ def expect_popup( self, predicate: typing.Optional[typing.Callable[["Page"], bool]] = None, *, - timeout: typing.Optional[float] = None + timeout: typing.Optional[float] = None, ) -> AsyncEventContextManager["Page"]: """Page.expect_popup @@ -11610,7 +11925,7 @@ def expect_request( str, typing.Pattern[str], typing.Callable[["Request"], bool] ], *, - timeout: typing.Optional[float] = None + timeout: typing.Optional[float] = None, ) -> AsyncEventContextManager["Request"]: """Page.expect_request @@ -11655,7 +11970,7 @@ def expect_request_finished( self, predicate: typing.Optional[typing.Callable[["Request"], bool]] = None, *, - timeout: typing.Optional[float] = None + timeout: typing.Optional[float] = None, ) -> AsyncEventContextManager["Request"]: """Page.expect_request_finished @@ -11688,7 +12003,7 @@ def expect_response( str, typing.Pattern[str], typing.Callable[["Response"], bool] ], *, - timeout: typing.Optional[float] = None + timeout: typing.Optional[float] = None, ) -> AsyncEventContextManager["Response"]: """Page.expect_response @@ -11735,7 +12050,7 @@ def expect_websocket( self, predicate: typing.Optional[typing.Callable[["WebSocket"], bool]] = None, *, - timeout: typing.Optional[float] = None + timeout: typing.Optional[float] = None, ) -> AsyncEventContextManager["WebSocket"]: """Page.expect_websocket @@ -11766,7 +12081,7 @@ def expect_worker( self, predicate: typing.Optional[typing.Callable[["Worker"], bool]] = None, *, - timeout: typing.Optional[float] = None + timeout: typing.Optional[float] = None, ) -> AsyncEventContextManager["Worker"]: """Page.expect_worker @@ -11803,7 +12118,7 @@ async def set_checked( force: typing.Optional[bool] = None, no_wait_after: typing.Optional[bool] = None, strict: typing.Optional[bool] = None, - trial: typing.Optional[bool] = None + trial: typing.Optional[bool] = None, ) -> None: """Page.set_checked @@ -11867,7 +12182,7 @@ async def add_locator_handler( ], *, no_wait_after: typing.Optional[bool] = None, - times: typing.Optional[int] = None + times: typing.Optional[int] = None, ) -> None: """Page.add_locator_handler @@ -11895,13 +12210,16 @@ async def add_locator_handler( **NOTE** Running the handler will alter your page state mid-test. For example it will change the currently focused element and move the mouse. Make sure that actions that run after the handler are self-contained and do not rely on - the focus and mouse state being unchanged.

For example, consider a test that calls - `locator.focus()` followed by `keyboard.press()`. If your handler clicks a button between these two - actions, the focused element most likely will be wrong, and key press will happen on the unexpected element. Use - `locator.press()` instead to avoid this problem.

Another example is a series of mouse - actions, where `mouse.move()` is followed by `mouse.down()`. Again, when the handler runs between - these two actions, the mouse position will be wrong during the mouse down. Prefer self-contained actions like - `locator.click()` that do not rely on the state being unchanged by a handler. + the focus and mouse state being unchanged. + + For example, consider a test that calls `locator.focus()` followed by `keyboard.press()`. If your + handler clicks a button between these two actions, the focused element most likely will be wrong, and key press + will happen on the unexpected element. Use `locator.press()` instead to avoid this problem. + + Another example is a series of mouse actions, where `mouse.move()` is followed by `mouse.down()`. + Again, when the handler runs between these two actions, the mouse position will be wrong during the mouse down. + Prefer self-contained actions like `locator.click()` that do not rely on the state being unchanged by a + handler. **Usage** @@ -11994,11 +12312,55 @@ async def remove_locator_handler(self, locator: "Locator") -> None: await self._impl_obj.remove_locator_handler(locator=locator._impl_obj) ) + async def requests(self) -> typing.List["Request"]: + """Page.requests + + Returns up to (currently) 100 last network request from this page. See `page.on('request')` for more details. + + Returned requests should be accessed immediately, otherwise they might be collected to prevent unbounded memory + growth as new requests come in. Once collected, retrieving most information about the request is impossible. + + Note that requests reported through the `page.on('request')` request are not collected, so there is a trade off + between efficient memory usage with `page.requests()` and the amount of available information reported + through `page.on('request')`. + + Returns + ------- + List[Request] + """ + + return mapping.from_impl_list(await self._impl_obj.requests()) + + async def console_messages(self) -> typing.List["ConsoleMessage"]: + """Page.console_messages + + Returns up to (currently) 200 last console messages from this page. See `page.on('console')` for more details. + + Returns + ------- + List[ConsoleMessage] + """ + + return mapping.from_impl_list(await self._impl_obj.console_messages()) + + async def page_errors(self) -> typing.List["Error"]: + """Page.page_errors + + Returns up to (currently) 200 last page errors from this page. See `page.on('page_error')` for more details. + + Returns + ------- + List[Error] + """ + + return mapping.from_impl_list(await self._impl_obj.page_errors()) + mapping.register(PageImpl, Page) class WebError(AsyncBase): + @property def page(self) -> typing.Optional["Page"]: """WebError.page @@ -12028,6 +12390,7 @@ def error(self) -> "Error": class BrowserContext(AsyncContextManager): + @typing.overload def on( self, @@ -12035,13 +12398,7 @@ def on( f: typing.Callable[["Page"], "typing.Union[typing.Awaitable[None], None]"], ) -> None: """ - **NOTE** Only works with Chromium browser's persistent context. - - Emitted when new background page is created in the context. - - ```py - background_page = await context.wait_for_event(\"backgroundpage\") - ```""" + This event is not emitted.""" @typing.overload def on( @@ -12215,13 +12572,7 @@ def once( f: typing.Callable[["Page"], "typing.Union[typing.Awaitable[None], None]"], ) -> None: """ - **NOTE** Only works with Chromium browser's persistent context. - - Emitted when new background page is created in the context. - - ```py - background_page = await context.wait_for_event(\"backgroundpage\") - ```""" + This event is not emitted.""" @typing.overload def once( @@ -12404,7 +12755,8 @@ def pages(self) -> typing.List["Page"]: def browser(self) -> typing.Optional["Browser"]: """BrowserContext.browser - Returns the browser instance of the context. If it was launched as a persistent context null gets returned. + Gets the browser instance that owns the context. Returns `null` if the context is created outside of normal + browser, e.g. Android or Electron. Returns ------- @@ -12416,9 +12768,7 @@ def browser(self) -> typing.Optional["Browser"]: def background_pages(self) -> typing.List["Page"]: """BrowserContext.background_pages - **NOTE** Background pages are only supported on Chromium-based browsers. - - All existing background pages in the context. + Returns an empty list. Returns ------- @@ -12510,7 +12860,7 @@ def set_default_timeout(self, timeout: float) -> None: Parameters ---------- timeout : float - Maximum time in milliseconds + Maximum time in milliseconds. Pass `0` to disable timeout. """ return mapping.from_maybe_impl( @@ -12544,7 +12894,7 @@ async def cookies( Returns ------- - List[{name: str, value: str, domain: str, path: str, expires: float, httpOnly: bool, secure: bool, sameSite: Union["Lax", "None", "Strict"]}] + List[{name: str, value: str, domain: str, path: str, expires: float, httpOnly: bool, secure: bool, sameSite: Union["Lax", "None", "Strict"], partitionKey: Union[str, None]}] """ return mapping.from_impl_list( @@ -12565,7 +12915,7 @@ async def add_cookies(self, cookies: typing.Sequence[SetCookieParam]) -> None: Parameters ---------- - cookies : Sequence[{name: str, value: str, url: Union[str, None], domain: Union[str, None], path: Union[str, None], expires: Union[float, None], httpOnly: Union[bool, None], secure: Union[bool, None], sameSite: Union["Lax", "None", "Strict", None]}] + cookies : Sequence[{name: str, value: str, url: Union[str, None], domain: Union[str, None], path: Union[str, None], expires: Union[float, None], httpOnly: Union[bool, None], secure: Union[bool, None], sameSite: Union["Lax", "None", "Strict", None], partitionKey: Union[str, None]}] """ return mapping.from_maybe_impl( @@ -12575,9 +12925,9 @@ async def add_cookies(self, cookies: typing.Sequence[SetCookieParam]) -> None: async def clear_cookies( self, *, - name: typing.Optional[typing.Union[str, typing.Pattern[str]]] = None, - domain: typing.Optional[typing.Union[str, typing.Pattern[str]]] = None, - path: typing.Optional[typing.Union[str, typing.Pattern[str]]] = None + name: typing.Optional[typing.Union[typing.Pattern[str], str]] = None, + domain: typing.Optional[typing.Union[typing.Pattern[str], str]] = None, + path: typing.Optional[typing.Union[typing.Pattern[str], str]] = None, ) -> None: """BrowserContext.clear_cookies @@ -12618,9 +12968,13 @@ async def grant_permissions( Parameters ---------- permissions : Sequence[str] - A permission or an array of permissions to grant. Permissions can be one of the following values: + A list of permissions to grant. + + **NOTE** Supported permissions differ between browsers, and even between different versions of the same browser. + Any permission may stop working after an update. + + Here are some permissions that may be supported by some browsers: - `'accelerometer'` - - `'accessibility-events'` - `'ambient-light-sensor'` - `'background-sync'` - `'camera'` @@ -12628,6 +12982,8 @@ async def grant_permissions( - `'clipboard-write'` - `'geolocation'` - `'gyroscope'` + - `'local-fonts'` + - `'local-network-access'` - `'magnetometer'` - `'microphone'` - `'midi-sysex'` (system-exclusive midi) @@ -12726,7 +13082,7 @@ async def add_init_script( self, script: typing.Optional[str] = None, *, - path: typing.Optional[typing.Union[str, pathlib.Path]] = None + path: typing.Optional[typing.Union[pathlib.Path, str]] = None, ) -> None: """BrowserContext.add_init_script @@ -12768,7 +13124,7 @@ async def expose_binding( name: str, callback: typing.Callable, *, - handle: typing.Optional[bool] = None + handle: typing.Optional[bool] = None, ) -> None: """BrowserContext.expose_binding @@ -12899,7 +13255,7 @@ async def route( typing.Callable[["Route", "Request"], typing.Any], ], *, - times: typing.Optional[int] = None + times: typing.Optional[int] = None, ) -> None: """BrowserContext.route @@ -12908,7 +13264,7 @@ async def route( **NOTE** `browser_context.route()` will not intercept requests intercepted by Service Worker. See [this](https://github.com/microsoft/playwright/issues/1090) issue. We recommend disabling Service Workers when - using request interception by setting `Browser.newContext.serviceWorkers` to `'block'`. + using request interception by setting `serviceWorkers` to `'block'`. **Usage** @@ -12955,8 +13311,8 @@ async def handle_route(route: Route): Parameters ---------- url : Union[Callable[[str], bool], Pattern[str], str] - A glob pattern, regex pattern or predicate receiving [URL] to match while routing. When a `baseURL` via the context - options was provided and the passed URL is a path, it gets merged via the + A glob pattern, regex pattern, or predicate that receives a [URL] to match during routing. If `baseURL` is set in + the context options and the provided URL is a string that does not start with `*`, it is resolved using the [`new URL()`](https://developer.mozilla.org/en-US/docs/Web/API/URL/URL) constructor. handler : Union[Callable[[Route, Request], Any], Callable[[Route], Any]] handler function to route the request. @@ -13002,10 +13358,55 @@ async def unroute( ) ) + async def route_web_socket( + self, + url: typing.Union[str, typing.Pattern[str], typing.Callable[[str], bool]], + handler: typing.Callable[["WebSocketRoute"], typing.Any], + ) -> None: + """BrowserContext.route_web_socket + + This method allows to modify websocket connections that are made by any page in the browser context. + + Note that only `WebSocket`s created after this method was called will be routed. It is recommended to call this + method before creating any pages. + + **Usage** + + Below is an example of a simple handler that blocks some websocket messages. See `WebSocketRoute` for more details + and examples. + + ```py + def message_handler(ws: WebSocketRoute, message: Union[str, bytes]): + if message == \"to-be-blocked\": + return + ws.send(message) + + async def handler(ws: WebSocketRoute): + ws.route_send(lambda message: message_handler(ws, message)) + await ws.connect() + + await context.route_web_socket(\"/ws\", handler) + ``` + + Parameters + ---------- + url : Union[Callable[[str], bool], Pattern[str], str] + Only WebSockets with the url matching this pattern will be routed. A string pattern can be relative to the + `baseURL` context option. + handler : Callable[[WebSocketRoute], Any] + Handler function to route the WebSocket. + """ + + return mapping.from_maybe_impl( + await self._impl_obj.route_web_socket( + url=self._wrap_handler(url), handler=self._wrap_handler(handler) + ) + ) + async def unroute_all( self, *, - behavior: typing.Optional[Literal["default", "ignoreErrors", "wait"]] = None + behavior: typing.Optional[Literal["default", "ignoreErrors", "wait"]] = None, ) -> None: """BrowserContext.unroute_all @@ -13030,11 +13431,11 @@ async def route_from_har( self, har: typing.Union[pathlib.Path, str], *, - url: typing.Optional[typing.Union[str, typing.Pattern[str]]] = None, + url: typing.Optional[typing.Union[typing.Pattern[str], str]] = None, not_found: typing.Optional[Literal["abort", "fallback"]] = None, update: typing.Optional[bool] = None, update_content: typing.Optional[Literal["attach", "embed"]] = None, - update_mode: typing.Optional[Literal["full", "minimal"]] = None + update_mode: typing.Optional[Literal["full", "minimal"]] = None, ) -> None: """BrowserContext.route_from_har @@ -13043,7 +13444,7 @@ async def route_from_har( Playwright will not serve requests intercepted by Service Worker from the HAR file. See [this](https://github.com/microsoft/playwright/issues/1090) issue. We recommend disabling Service Workers when - using request interception by setting `Browser.newContext.serviceWorkers` to `'block'`. + using request interception by setting `serviceWorkers` to `'block'`. Parameters ---------- @@ -13086,7 +13487,7 @@ def expect_event( event: str, predicate: typing.Optional[typing.Callable] = None, *, - timeout: typing.Optional[float] = None + timeout: typing.Optional[float] = None, ) -> AsyncEventContextManager: """BrowserContext.expect_event @@ -13138,31 +13539,41 @@ async def close(self, *, reason: typing.Optional[str] = None) -> None: return mapping.from_maybe_impl(await self._impl_obj.close(reason=reason)) async def storage_state( - self, *, path: typing.Optional[typing.Union[str, pathlib.Path]] = None + self, + *, + path: typing.Optional[typing.Union[pathlib.Path, str]] = None, + indexed_db: typing.Optional[bool] = None, ) -> StorageState: """BrowserContext.storage_state - Returns storage state for this browser context, contains current cookies and local storage snapshot. + Returns storage state for this browser context, contains current cookies, local storage snapshot and IndexedDB + snapshot. Parameters ---------- path : Union[pathlib.Path, str, None] The file path to save the storage state to. If `path` is a relative path, then it is resolved relative to current working directory. If no path is provided, storage state is still returned, but won't be saved to the disk. + indexed_db : Union[bool, None] + Set to `true` to include [IndexedDB](https://developer.mozilla.org/en-US/docs/Web/API/IndexedDB_API) in the storage + state snapshot. If your application uses IndexedDB to store authentication tokens, like Firebase Authentication, + enable this. Returns ------- {cookies: List[{name: str, value: str, domain: str, path: str, expires: float, httpOnly: bool, secure: bool, sameSite: Union["Lax", "None", "Strict"]}], origins: List[{origin: str, localStorage: List[{name: str, value: str}]}]} """ - return mapping.from_impl(await self._impl_obj.storage_state(path=path)) + return mapping.from_impl( + await self._impl_obj.storage_state(path=path, indexedDB=indexed_db) + ) async def wait_for_event( self, event: str, predicate: typing.Optional[typing.Callable] = None, *, - timeout: typing.Optional[float] = None + timeout: typing.Optional[float] = None, ) -> typing.Any: """BrowserContext.wait_for_event @@ -13197,7 +13608,7 @@ def expect_console_message( self, predicate: typing.Optional[typing.Callable[["ConsoleMessage"], bool]] = None, *, - timeout: typing.Optional[float] = None + timeout: typing.Optional[float] = None, ) -> AsyncEventContextManager["ConsoleMessage"]: """BrowserContext.expect_console_message @@ -13229,7 +13640,7 @@ def expect_page( self, predicate: typing.Optional[typing.Callable[["Page"], bool]] = None, *, - timeout: typing.Optional[float] = None + timeout: typing.Optional[float] = None, ) -> AsyncEventContextManager["Page"]: """BrowserContext.expect_page @@ -13283,6 +13694,7 @@ async def new_cdp_session( class CDPSession(AsyncBase): + async def send( self, method: str, params: typing.Optional[typing.Dict] = None ) -> typing.Dict: @@ -13318,6 +13730,7 @@ async def detach(self) -> None: class Browser(AsyncContextManager): + def on( self, event: Literal["disconnected"], @@ -13426,12 +13839,13 @@ async def new_context( Literal["no-preference", "null", "reduce"] ] = None, forced_colors: typing.Optional[Literal["active", "none", "null"]] = None, + contrast: typing.Optional[Literal["more", "no-preference", "null"]] = None, accept_downloads: typing.Optional[bool] = None, default_browser_type: typing.Optional[str] = None, proxy: typing.Optional[ProxySettings] = None, - record_har_path: typing.Optional[typing.Union[str, pathlib.Path]] = None, + record_har_path: typing.Optional[typing.Union[pathlib.Path, str]] = None, record_har_omit_content: typing.Optional[bool] = None, - record_video_dir: typing.Optional[typing.Union[str, pathlib.Path]] = None, + record_video_dir: typing.Optional[typing.Union[pathlib.Path, str]] = None, record_video_size: typing.Optional[ViewportSize] = None, storage_state: typing.Optional[ typing.Union[StorageState, str, pathlib.Path] @@ -13440,11 +13854,11 @@ async def new_context( strict_selectors: typing.Optional[bool] = None, service_workers: typing.Optional[Literal["allow", "block"]] = None, record_har_url_filter: typing.Optional[ - typing.Union[str, typing.Pattern[str]] + typing.Union[typing.Pattern[str], str] ] = None, record_har_mode: typing.Optional[Literal["full", "minimal"]] = None, record_har_content: typing.Optional[Literal["attach", "embed", "omit"]] = None, - client_certificates: typing.Optional[typing.List[ClientCertificate]] = None + client_certificates: typing.Optional[typing.List[ClientCertificate]] = None, ) -> "BrowserContext": """Browser.new_context @@ -13520,9 +13934,9 @@ async def new_context( Specifies if viewport supports touch events. Defaults to false. Learn more about [mobile emulation](../emulation.md#devices). color_scheme : Union["dark", "light", "no-preference", "null", None] - Emulates `'prefers-colors-scheme'` media feature, supported values are `'light'`, `'dark'`, `'no-preference'`. See - `page.emulate_media()` for more details. Passing `'null'` resets emulation to system defaults. Defaults to - `'light'`. + Emulates [prefers-colors-scheme](https://developer.mozilla.org/en-US/docs/Web/CSS/@media/prefers-color-scheme) + media feature, supported values are `'light'` and `'dark'`. See `page.emulate_media()` for more details. + Passing `'null'` resets emulation to system defaults. Defaults to `'light'`. reduced_motion : Union["no-preference", "null", "reduce", None] Emulates `'prefers-reduced-motion'` media feature, supported values are `'reduce'`, `'no-preference'`. See `page.emulate_media()` for more details. Passing `'null'` resets emulation to system defaults. Defaults to @@ -13531,6 +13945,10 @@ async def new_context( Emulates `'forced-colors'` media feature, supported values are `'active'`, `'none'`. See `page.emulate_media()` for more details. Passing `'null'` resets emulation to system defaults. Defaults to `'none'`. + contrast : Union["more", "no-preference", "null", None] + Emulates `'prefers-contrast'` media feature, supported values are `'no-preference'`, `'more'`. See + `page.emulate_media()` for more details. Passing `'null'` resets emulation to system defaults. Defaults to + `'no-preference'`. accept_downloads : Union[bool, None] Whether to automatically download all the attachments. Defaults to `true` where all the downloads are accepted. proxy : Union[{server: str, bypass: Union[str, None], username: Union[str, None], password: Union[str, None]}, None] @@ -13591,11 +14009,14 @@ async def new_context( `passphrase` property should be provided if the certificate is encrypted. The `origin` property should be provided with an exact match to the request origin that the certificate is valid for. - **NOTE** Using Client Certificates in combination with Proxy Servers is not supported. + Client certificate authentication is only active when at least one client certificate is provided. If you want to + reject all client certificates sent by the server, you need to provide a client certificate with an `origin` that + does not match any of the domains you plan to visit. **NOTE** When using WebKit on macOS, accessing `localhost` will not pick up client certificates. You can make it work by replacing `localhost` with `local.playwright`. + Returns ------- BrowserContext @@ -13623,6 +14044,7 @@ async def new_context( colorScheme=color_scheme, reducedMotion=reduced_motion, forcedColors=forced_colors, + contrast=contrast, acceptDownloads=accept_downloads, defaultBrowserType=default_browser_type, proxy=proxy, @@ -13665,15 +14087,16 @@ async def new_page( Literal["dark", "light", "no-preference", "null"] ] = None, forced_colors: typing.Optional[Literal["active", "none", "null"]] = None, + contrast: typing.Optional[Literal["more", "no-preference", "null"]] = None, reduced_motion: typing.Optional[ Literal["no-preference", "null", "reduce"] ] = None, accept_downloads: typing.Optional[bool] = None, default_browser_type: typing.Optional[str] = None, proxy: typing.Optional[ProxySettings] = None, - record_har_path: typing.Optional[typing.Union[str, pathlib.Path]] = None, + record_har_path: typing.Optional[typing.Union[pathlib.Path, str]] = None, record_har_omit_content: typing.Optional[bool] = None, - record_video_dir: typing.Optional[typing.Union[str, pathlib.Path]] = None, + record_video_dir: typing.Optional[typing.Union[pathlib.Path, str]] = None, record_video_size: typing.Optional[ViewportSize] = None, storage_state: typing.Optional[ typing.Union[StorageState, str, pathlib.Path] @@ -13682,11 +14105,11 @@ async def new_page( strict_selectors: typing.Optional[bool] = None, service_workers: typing.Optional[Literal["allow", "block"]] = None, record_har_url_filter: typing.Optional[ - typing.Union[str, typing.Pattern[str]] + typing.Union[typing.Pattern[str], str] ] = None, record_har_mode: typing.Optional[Literal["full", "minimal"]] = None, record_har_content: typing.Optional[Literal["attach", "embed", "omit"]] = None, - client_certificates: typing.Optional[typing.List[ClientCertificate]] = None + client_certificates: typing.Optional[typing.List[ClientCertificate]] = None, ) -> "Page": """Browser.new_page @@ -13746,13 +14169,17 @@ async def new_page( Specifies if viewport supports touch events. Defaults to false. Learn more about [mobile emulation](../emulation.md#devices). color_scheme : Union["dark", "light", "no-preference", "null", None] - Emulates `'prefers-colors-scheme'` media feature, supported values are `'light'`, `'dark'`, `'no-preference'`. See - `page.emulate_media()` for more details. Passing `'null'` resets emulation to system defaults. Defaults to - `'light'`. + Emulates [prefers-colors-scheme](https://developer.mozilla.org/en-US/docs/Web/CSS/@media/prefers-color-scheme) + media feature, supported values are `'light'` and `'dark'`. See `page.emulate_media()` for more details. + Passing `'null'` resets emulation to system defaults. Defaults to `'light'`. forced_colors : Union["active", "none", "null", None] Emulates `'forced-colors'` media feature, supported values are `'active'`, `'none'`. See `page.emulate_media()` for more details. Passing `'null'` resets emulation to system defaults. Defaults to `'none'`. + contrast : Union["more", "no-preference", "null", None] + Emulates `'prefers-contrast'` media feature, supported values are `'no-preference'`, `'more'`. See + `page.emulate_media()` for more details. Passing `'null'` resets emulation to system defaults. Defaults to + `'no-preference'`. reduced_motion : Union["no-preference", "null", "reduce", None] Emulates `'prefers-reduced-motion'` media feature, supported values are `'reduce'`, `'no-preference'`. See `page.emulate_media()` for more details. Passing `'null'` resets emulation to system defaults. Defaults to @@ -13817,11 +14244,14 @@ async def new_page( `passphrase` property should be provided if the certificate is encrypted. The `origin` property should be provided with an exact match to the request origin that the certificate is valid for. - **NOTE** Using Client Certificates in combination with Proxy Servers is not supported. + Client certificate authentication is only active when at least one client certificate is provided. If you want to + reject all client certificates sent by the server, you need to provide a client certificate with an `origin` that + does not match any of the domains you plan to visit. **NOTE** When using WebKit on macOS, accessing `localhost` will not pick up client certificates. You can make it work by replacing `localhost` with `local.playwright`. + Returns ------- Page @@ -13848,6 +14278,7 @@ async def new_page( hasTouch=has_touch, colorScheme=color_scheme, forcedColors=forced_colors, + contrast=contrast, reducedMotion=reduced_motion, acceptDownloads=accept_downloads, defaultBrowserType=default_browser_type, @@ -13876,9 +14307,9 @@ async def close(self, *, reason: typing.Optional[str] = None) -> None: In case this browser is connected to, clears all created contexts belonging to this browser and disconnects from the browser server. - **NOTE** This is similar to force quitting the browser. Therefore, you should call `browser_context.close()` - on any `BrowserContext`'s you explicitly created earlier with `browser.new_context()` **before** calling - `browser.close()`. + **NOTE** This is similar to force-quitting the browser. To close pages gracefully and ensure you receive page close + events, call `browser_context.close()` on any `BrowserContext` instances you explicitly created earlier + using `browser.new_context()` **before** calling `browser.close()`. The `Browser` object itself is considered to be disposed and cannot be used anymore. @@ -13908,9 +14339,9 @@ async def start_tracing( self, *, page: typing.Optional["Page"] = None, - path: typing.Optional[typing.Union[str, pathlib.Path]] = None, + path: typing.Optional[typing.Union[pathlib.Path, str]] = None, screenshots: typing.Optional[bool] = None, - categories: typing.Optional[typing.Sequence[str]] = None + categories: typing.Optional[typing.Sequence[str]] = None, ) -> None: """Browser.start_tracing @@ -13973,6 +14404,7 @@ async def stop_tracing(self) -> bytes: class BrowserType(AsyncBase): + @property def name(self) -> str: """BrowserType.name @@ -14000,7 +14432,7 @@ def executable_path(self) -> str: async def launch( self, *, - executable_path: typing.Optional[typing.Union[str, pathlib.Path]] = None, + executable_path: typing.Optional[typing.Union[pathlib.Path, str]] = None, channel: typing.Optional[str] = None, args: typing.Optional[typing.Sequence[str]] = None, ignore_default_args: typing.Optional[ @@ -14012,15 +14444,14 @@ async def launch( timeout: typing.Optional[float] = None, env: typing.Optional[typing.Dict[str, typing.Union[str, float, bool]]] = None, headless: typing.Optional[bool] = None, - devtools: typing.Optional[bool] = None, proxy: typing.Optional[ProxySettings] = None, - downloads_path: typing.Optional[typing.Union[str, pathlib.Path]] = None, + downloads_path: typing.Optional[typing.Union[pathlib.Path, str]] = None, slow_mo: typing.Optional[float] = None, - traces_dir: typing.Optional[typing.Union[str, pathlib.Path]] = None, + traces_dir: typing.Optional[typing.Union[pathlib.Path, str]] = None, chromium_sandbox: typing.Optional[bool] = None, firefox_user_prefs: typing.Optional[ typing.Dict[str, typing.Union[str, float, bool]] - ] = None + ] = None, ) -> "Browser": """BrowserType.launch @@ -14058,9 +14489,12 @@ async def launch( resolved relative to the current working directory. Note that Playwright only works with the bundled Chromium, Firefox or WebKit, use at your own risk. channel : Union[str, None] - Browser distribution channel. Supported values are "chrome", "chrome-beta", "chrome-dev", "chrome-canary", - "msedge", "msedge-beta", "msedge-dev", "msedge-canary". Read more about using - [Google Chrome and Microsoft Edge](../browsers.md#google-chrome--microsoft-edge). + Browser distribution channel. + + Use "chromium" to [opt in to new headless mode](../browsers.md#chromium-new-headless-mode). + + Use "chrome", "chrome-beta", "chrome-dev", "chrome-canary", "msedge", "msedge-beta", "msedge-dev", or + "msedge-canary" to use branded [Google Chrome and Microsoft Edge](../browsers.md#google-chrome--microsoft-edge). args : Union[Sequence[str], None] **NOTE** Use custom browser args at your own risk, as some of them may break Playwright functionality. @@ -14083,12 +14517,7 @@ async def launch( headless : Union[bool, None] Whether to run browser in headless mode. More details for [Chromium](https://developers.google.com/web/updates/2017/04/headless-chrome) and - [Firefox](https://developer.mozilla.org/en-US/docs/Mozilla/Firefox/Headless_mode). Defaults to `true` unless the - `devtools` option is `true`. - devtools : Union[bool, None] - **Chromium-only** Whether to auto-open a Developer Tools panel for each tab. If this option is `true`, the - `headless` option will be set `false`. - Deprecated: Use [debugging tools](../debug.md) instead. + [Firefox](https://hacks.mozilla.org/2017/12/using-headless-mode-in-firefox/). Defaults to `true`. proxy : Union[{server: str, bypass: Union[str, None], username: Union[str, None], password: Union[str, None]}, None] Network proxy settings. downloads_path : Union[pathlib.Path, str, None] @@ -14106,6 +14535,9 @@ async def launch( Firefox user preferences. Learn more about the Firefox user preferences at [`about:config`](https://support.mozilla.org/en-US/kb/about-config-editor-firefox). + You can also provide a path to a custom [`policies.json` file](https://mozilla.github.io/policy-templates/) via + `PLAYWRIGHT_FIREFOX_POLICIES_JSON` environment variable. + Returns ------- Browser @@ -14123,7 +14555,6 @@ async def launch( timeout=timeout, env=mapping.to_impl(env), headless=headless, - devtools=devtools, proxy=proxy, downloadsPath=downloads_path, slowMo=slow_mo, @@ -14138,7 +14569,7 @@ async def launch_persistent_context( user_data_dir: typing.Union[str, pathlib.Path], *, channel: typing.Optional[str] = None, - executable_path: typing.Optional[typing.Union[str, pathlib.Path]] = None, + executable_path: typing.Optional[typing.Union[pathlib.Path, str]] = None, args: typing.Optional[typing.Sequence[str]] = None, ignore_default_args: typing.Optional[ typing.Union[bool, typing.Sequence[str]] @@ -14149,9 +14580,8 @@ async def launch_persistent_context( timeout: typing.Optional[float] = None, env: typing.Optional[typing.Dict[str, typing.Union[str, float, bool]]] = None, headless: typing.Optional[bool] = None, - devtools: typing.Optional[bool] = None, proxy: typing.Optional[ProxySettings] = None, - downloads_path: typing.Optional[typing.Union[str, pathlib.Path]] = None, + downloads_path: typing.Optional[typing.Union[pathlib.Path, str]] = None, slow_mo: typing.Optional[float] = None, viewport: typing.Optional[ViewportSize] = None, screen: typing.Optional[ViewportSize] = None, @@ -14177,25 +14607,26 @@ async def launch_persistent_context( Literal["no-preference", "null", "reduce"] ] = None, forced_colors: typing.Optional[Literal["active", "none", "null"]] = None, + contrast: typing.Optional[Literal["more", "no-preference", "null"]] = None, accept_downloads: typing.Optional[bool] = None, - traces_dir: typing.Optional[typing.Union[str, pathlib.Path]] = None, + traces_dir: typing.Optional[typing.Union[pathlib.Path, str]] = None, chromium_sandbox: typing.Optional[bool] = None, firefox_user_prefs: typing.Optional[ typing.Dict[str, typing.Union[str, float, bool]] ] = None, - record_har_path: typing.Optional[typing.Union[str, pathlib.Path]] = None, + record_har_path: typing.Optional[typing.Union[pathlib.Path, str]] = None, record_har_omit_content: typing.Optional[bool] = None, - record_video_dir: typing.Optional[typing.Union[str, pathlib.Path]] = None, + record_video_dir: typing.Optional[typing.Union[pathlib.Path, str]] = None, record_video_size: typing.Optional[ViewportSize] = None, base_url: typing.Optional[str] = None, strict_selectors: typing.Optional[bool] = None, service_workers: typing.Optional[Literal["allow", "block"]] = None, record_har_url_filter: typing.Optional[ - typing.Union[str, typing.Pattern[str]] + typing.Union[typing.Pattern[str], str] ] = None, record_har_mode: typing.Optional[Literal["full", "minimal"]] = None, record_har_content: typing.Optional[Literal["attach", "embed", "omit"]] = None, - client_certificates: typing.Optional[typing.List[ClientCertificate]] = None + client_certificates: typing.Optional[typing.List[ClientCertificate]] = None, ) -> "BrowserContext": """BrowserType.launch_persistent_context @@ -14207,15 +14638,29 @@ async def launch_persistent_context( Parameters ---------- user_data_dir : Union[pathlib.Path, str] - Path to a User Data Directory, which stores browser session data like cookies and local storage. More details for + Path to a User Data Directory, which stores browser session data like cookies and local storage. Pass an empty + string to create a temporary directory. + + More details for [Chromium](https://chromium.googlesource.com/chromium/src/+/master/docs/user_data_dir.md#introduction) and - [Firefox](https://developer.mozilla.org/en-US/docs/Mozilla/Command_Line_Options#User_Profile). Note that Chromium's - user data directory is the **parent** directory of the "Profile Path" seen at `chrome://version`. Pass an empty - string to use a temporary directory instead. + [Firefox](https://wiki.mozilla.org/Firefox/CommandLineOptions#User_profile). Chromium's user data directory is the + **parent** directory of the "Profile Path" seen at `chrome://version`. + + Note that browsers do not allow launching multiple instances with the same User Data Directory. + + **NOTE** Chromium/Chrome: Due to recent Chrome policy changes, automating the default Chrome user profile is not + supported. Pointing `userDataDir` to Chrome's main "User Data" directory (the profile used for your regular + browsing) may result in pages not loading or the browser exiting. Create and use a separate directory (for example, + an empty folder) as your automation profile instead. See https://developer.chrome.com/blog/remote-debugging-port + for details. + channel : Union[str, None] - Browser distribution channel. Supported values are "chrome", "chrome-beta", "chrome-dev", "chrome-canary", - "msedge", "msedge-beta", "msedge-dev", "msedge-canary". Read more about using - [Google Chrome and Microsoft Edge](../browsers.md#google-chrome--microsoft-edge). + Browser distribution channel. + + Use "chromium" to [opt in to new headless mode](../browsers.md#chromium-new-headless-mode). + + Use "chrome", "chrome-beta", "chrome-dev", "chrome-canary", "msedge", "msedge-beta", "msedge-dev", or + "msedge-canary" to use branded [Google Chrome and Microsoft Edge](../browsers.md#google-chrome--microsoft-edge). executable_path : Union[pathlib.Path, str, None] Path to a browser executable to run instead of the bundled one. If `executablePath` is a relative path, then it is resolved relative to the current working directory. Note that Playwright only works with the bundled Chromium, @@ -14242,12 +14687,7 @@ async def launch_persistent_context( headless : Union[bool, None] Whether to run browser in headless mode. More details for [Chromium](https://developers.google.com/web/updates/2017/04/headless-chrome) and - [Firefox](https://developer.mozilla.org/en-US/docs/Mozilla/Firefox/Headless_mode). Defaults to `true` unless the - `devtools` option is `true`. - devtools : Union[bool, None] - **Chromium-only** Whether to auto-open a Developer Tools panel for each tab. If this option is `true`, the - `headless` option will be set `false`. - Deprecated: Use [debugging tools](../debug.md) instead. + [Firefox](https://hacks.mozilla.org/2017/12/using-headless-mode-in-firefox/). Defaults to `true`. proxy : Union[{server: str, bypass: Union[str, None], username: Union[str, None], password: Union[str, None]}, None] Network proxy settings. downloads_path : Union[pathlib.Path, str, None] @@ -14305,9 +14745,9 @@ async def launch_persistent_context( Specifies if viewport supports touch events. Defaults to false. Learn more about [mobile emulation](../emulation.md#devices). color_scheme : Union["dark", "light", "no-preference", "null", None] - Emulates `'prefers-colors-scheme'` media feature, supported values are `'light'`, `'dark'`, `'no-preference'`. See - `page.emulate_media()` for more details. Passing `'null'` resets emulation to system defaults. Defaults to - `'light'`. + Emulates [prefers-colors-scheme](https://developer.mozilla.org/en-US/docs/Web/CSS/@media/prefers-color-scheme) + media feature, supported values are `'light'` and `'dark'`. See `page.emulate_media()` for more details. + Passing `'null'` resets emulation to system defaults. Defaults to `'light'`. reduced_motion : Union["no-preference", "null", "reduce", None] Emulates `'prefers-reduced-motion'` media feature, supported values are `'reduce'`, `'no-preference'`. See `page.emulate_media()` for more details. Passing `'null'` resets emulation to system defaults. Defaults to @@ -14316,6 +14756,10 @@ async def launch_persistent_context( Emulates `'forced-colors'` media feature, supported values are `'active'`, `'none'`. See `page.emulate_media()` for more details. Passing `'null'` resets emulation to system defaults. Defaults to `'none'`. + contrast : Union["more", "no-preference", "null", None] + Emulates `'prefers-contrast'` media feature, supported values are `'no-preference'`, `'more'`. See + `page.emulate_media()` for more details. Passing `'null'` resets emulation to system defaults. Defaults to + `'no-preference'`. accept_downloads : Union[bool, None] Whether to automatically download all the attachments. Defaults to `true` where all the downloads are accepted. traces_dir : Union[pathlib.Path, str, None] @@ -14325,6 +14769,9 @@ async def launch_persistent_context( firefox_user_prefs : Union[Dict[str, Union[bool, float, str]], None] Firefox user preferences. Learn more about the Firefox user preferences at [`about:config`](https://support.mozilla.org/en-US/kb/about-config-editor-firefox). + + You can also provide a path to a custom [`policies.json` file](https://mozilla.github.io/policy-templates/) via + `PLAYWRIGHT_FIREFOX_POLICIES_JSON` environment variable. record_har_path : Union[pathlib.Path, str, None] Enables [HAR](http://www.softwareishard.com/blog/har-12-spec) recording for all pages into the specified HAR file on the filesystem. If not specified, the HAR is not recorded. Make sure to call `browser_context.close()` @@ -14376,11 +14823,14 @@ async def launch_persistent_context( `passphrase` property should be provided if the certificate is encrypted. The `origin` property should be provided with an exact match to the request origin that the certificate is valid for. - **NOTE** Using Client Certificates in combination with Proxy Servers is not supported. + Client certificate authentication is only active when at least one client certificate is provided. If you want to + reject all client certificates sent by the server, you need to provide a client certificate with an `origin` that + does not match any of the domains you plan to visit. **NOTE** When using WebKit on macOS, accessing `localhost` will not pick up client certificates. You can make it work by replacing `localhost` with `local.playwright`. + Returns ------- BrowserContext @@ -14399,7 +14849,6 @@ async def launch_persistent_context( timeout=timeout, env=mapping.to_impl(env), headless=headless, - devtools=devtools, proxy=proxy, downloadsPath=downloads_path, slowMo=slow_mo, @@ -14423,6 +14872,7 @@ async def launch_persistent_context( colorScheme=color_scheme, reducedMotion=reduced_motion, forcedColors=forced_colors, + contrast=contrast, acceptDownloads=accept_downloads, tracesDir=traces_dir, chromiumSandbox=chromium_sandbox, @@ -14447,7 +14897,8 @@ async def connect_over_cdp( *, timeout: typing.Optional[float] = None, slow_mo: typing.Optional[float] = None, - headers: typing.Optional[typing.Dict[str, str]] = None + headers: typing.Optional[typing.Dict[str, str]] = None, + is_local: typing.Optional[bool] = None, ) -> "Browser": """BrowserType.connect_over_cdp @@ -14457,6 +14908,10 @@ async def connect_over_cdp( **NOTE** Connecting over the Chrome DevTools Protocol is only supported for Chromium-based browsers. + **NOTE** This connection is significantly lower fidelity than the Playwright protocol connection via + `browser_type.connect()`. If you are experiencing issues or attempting to use advanced functionality, you + probably want to use `browser_type.connect()`. + **Usage** ```py @@ -14478,6 +14933,9 @@ async def connect_over_cdp( on. Defaults to 0. headers : Union[Dict[str, str], None] Additional HTTP headers to be sent with connect request. Optional. + is_local : Union[bool, None] + Tells Playwright that it runs on the same host as the CDP server. It will enable certain optimizations that rely + upon the file system being the same between Playwright and the Browser. Returns ------- @@ -14490,6 +14948,7 @@ async def connect_over_cdp( timeout=timeout, slowMo=slow_mo, headers=mapping.to_impl(headers), + isLocal=is_local, ) ) @@ -14500,18 +14959,19 @@ async def connect( timeout: typing.Optional[float] = None, slow_mo: typing.Optional[float] = None, headers: typing.Optional[typing.Dict[str, str]] = None, - expose_network: typing.Optional[str] = None + expose_network: typing.Optional[str] = None, ) -> "Browser": """BrowserType.connect - This method attaches Playwright to an existing browser instance. When connecting to another browser launched via - `BrowserType.launchServer` in Node.js, the major and minor version needs to match the client version (1.2.3 → is - compatible with 1.2.x). + This method attaches Playwright to an existing browser instance created via `BrowserType.launchServer` in Node.js. + + **NOTE** The major and minor version of the Playwright instance that connects needs to match the version of + Playwright that launches the browser (1.2.3 → is compatible with 1.2.x). Parameters ---------- ws_endpoint : str - A browser websocket endpoint to connect to. + A Playwright browser websocket endpoint to connect to. You obtain this endpoint via `BrowserServer.wsEndpoint`. timeout : Union[float, None] Maximum time in milliseconds to wait for the connection to be established. Defaults to `0` (no timeout). slow_mo : Union[float, None] @@ -14554,6 +15014,7 @@ async def connect( class Playwright(AsyncBase): + @property def devices(self) -> typing.Dict: """Playwright.devices @@ -14648,6 +15109,7 @@ def request(self) -> "APIRequest": return mapping.from_impl(self._impl_obj.request) def __getitem__(self, value: str) -> "BrowserType": + return mapping.from_impl(self._impl_obj.__getitem__(value=value)) async def stop(self) -> None: @@ -14678,6 +15140,7 @@ async def stop(self) -> None: class Tracing(AsyncBase): + async def start( self, *, @@ -14685,12 +15148,21 @@ async def start( title: typing.Optional[str] = None, snapshots: typing.Optional[bool] = None, screenshots: typing.Optional[bool] = None, - sources: typing.Optional[bool] = None + sources: typing.Optional[bool] = None, ) -> None: """Tracing.start Start tracing. + **NOTE** You probably want to + [enable tracing in your config file](https://playwright.dev/docs/api/class-testoptions#test-options-trace) instead + of using `Tracing.start`. + + The `context.tracing` API captures browser operations and network activity, but it doesn't record test assertions + (like `expect` calls). We recommend + [enabling tracing through Playwright Test configuration](https://playwright.dev/docs/api/class-testoptions#test-options-trace), + which includes those assertions and provides a more complete trace for debugging test failures. + **Usage** ```py @@ -14704,8 +15176,8 @@ async def start( ---------- name : Union[str, None] If specified, intermediate trace files are going to be saved into the files with the given name prefix inside the - `tracesDir` folder specified in `browser_type.launch()`. To specify the final trace zip file name, you need - to pass `path` option to `tracing.stop()` instead. + `tracesDir` directory specified in `browser_type.launch()`. To specify the final trace zip file name, you + need to pass `path` option to `tracing.stop()` instead. title : Union[str, None] Trace name to be shown in the Trace Viewer. snapshots : Union[bool, None] @@ -14761,8 +15233,8 @@ async def start_chunk( Trace name to be shown in the Trace Viewer. name : Union[str, None] If specified, intermediate trace files are going to be saved into the files with the given name prefix inside the - `tracesDir` folder specified in `browser_type.launch()`. To specify the final trace zip file name, you need - to pass `path` option to `tracing.stop_chunk()` instead. + `tracesDir` directory specified in `browser_type.launch()`. To specify the final trace zip file name, you + need to pass `path` option to `tracing.stop_chunk()` instead. """ return mapping.from_maybe_impl( @@ -14770,7 +15242,7 @@ async def start_chunk( ) async def stop_chunk( - self, *, path: typing.Optional[typing.Union[str, pathlib.Path]] = None + self, *, path: typing.Optional[typing.Union[pathlib.Path, str]] = None ) -> None: """Tracing.stop_chunk @@ -14785,7 +15257,7 @@ async def stop_chunk( return mapping.from_maybe_impl(await self._impl_obj.stop_chunk(path=path)) async def stop( - self, *, path: typing.Optional[typing.Union[str, pathlib.Path]] = None + self, *, path: typing.Optional[typing.Union[pathlib.Path, str]] = None ) -> None: """Tracing.stop @@ -14799,13 +15271,56 @@ async def stop( return mapping.from_maybe_impl(await self._impl_obj.stop(path=path)) + async def group( + self, name: str, *, location: typing.Optional[TracingGroupLocation] = None + ) -> None: + """Tracing.group -mapping.register(TracingImpl, Tracing) + **NOTE** Use `test.step` instead when available. + Creates a new group within the trace, assigning any subsequent API calls to this group, until + `tracing.group_end()` is called. Groups can be nested and will be visible in the trace viewer. -class Locator(AsyncBase): - @property - def page(self) -> "Page": + **Usage** + + ```py + # All actions between group and group_end + # will be shown in the trace viewer as a group. + page.context.tracing.group(\"Open Playwright.dev > API\") + page.goto(\"https://playwright.dev/\") + page.get_by_role(\"link\", name=\"API\").click() + page.context.tracing.group_end() + ``` + + Parameters + ---------- + name : str + Group name shown in the trace viewer. + location : Union[{file: str, line: Union[int, None], column: Union[int, None]}, None] + Specifies a custom location for the group to be shown in the trace viewer. Defaults to the location of the + `tracing.group()` call. + """ + + return mapping.from_maybe_impl( + await self._impl_obj.group(name=name, location=location) + ) + + async def group_end(self) -> None: + """Tracing.group_end + + Closes the last group created by `tracing.group()`. + """ + + return mapping.from_maybe_impl(await self._impl_obj.group_end()) + + +mapping.register(TracingImpl, Tracing) + + +class Locator(AsyncBase): + + @property + def page(self) -> "Page": """Locator.page A page this locator belongs to. @@ -14872,6 +15387,29 @@ def content_frame(self) -> "FrameLocator": """ return mapping.from_impl(self._impl_obj.content_frame) + @property + def description(self) -> typing.Optional[str]: + """Locator.description + + Returns locator description previously set with `locator.describe()`. Returns `null` if no custom + description has been set. + + **Usage** + + ```py + button = page.get_by_role(\"button\").describe(\"Subscribe button\") + print(button.description()) # \"Subscribe button\" + + input = page.get_by_role(\"textbox\") + print(input.description()) # None + ``` + + Returns + ------- + Union[str, None] + """ + return mapping.from_maybe_impl(self._impl_obj.description) + async def bounding_box( self, *, timeout: typing.Optional[float] = None ) -> typing.Optional[FloatRect]: @@ -14922,7 +15460,7 @@ async def check( timeout: typing.Optional[float] = None, force: typing.Optional[bool] = None, no_wait_after: typing.Optional[bool] = None, - trial: typing.Optional[bool] = None + trial: typing.Optional[bool] = None, ) -> None: """Locator.check @@ -14990,7 +15528,8 @@ async def click( timeout: typing.Optional[float] = None, force: typing.Optional[bool] = None, no_wait_after: typing.Optional[bool] = None, - trial: typing.Optional[bool] = None + trial: typing.Optional[bool] = None, + steps: typing.Optional[int] = None, ) -> None: """Locator.click @@ -15052,7 +15591,12 @@ async def click( Deprecated: This option will default to `true` in the future. trial : Union[bool, None] When set, this method only performs the [actionability](../actionability.md) checks and skips the action. Defaults - to `false`. Useful to wait until the element is ready for the action without performing it. + to `false`. Useful to wait until the element is ready for the action without performing it. Note that keyboard + `modifiers` will be pressed regardless of `trial` to allow testing elements which are only visible when those keys + are pressed. + steps : Union[int, None] + Defaults to 1. Sends `n` interpolated `mousemove` events to represent travel between Playwright's current cursor + position and the provided destination. When set to 1, emits a single `mousemove` event at the destination location. """ return mapping.from_maybe_impl( @@ -15066,6 +15610,7 @@ async def click( force=force, noWaitAfter=no_wait_after, trial=trial, + steps=steps, ) ) @@ -15081,7 +15626,8 @@ async def dblclick( timeout: typing.Optional[float] = None, force: typing.Optional[bool] = None, no_wait_after: typing.Optional[bool] = None, - trial: typing.Optional[bool] = None + trial: typing.Optional[bool] = None, + steps: typing.Optional[int] = None, ) -> None: """Locator.dblclick @@ -15124,7 +15670,12 @@ async def dblclick( Deprecated: This option has no effect. trial : Union[bool, None] When set, this method only performs the [actionability](../actionability.md) checks and skips the action. Defaults - to `false`. Useful to wait until the element is ready for the action without performing it. + to `false`. Useful to wait until the element is ready for the action without performing it. Note that keyboard + `modifiers` will be pressed regardless of `trial` to allow testing elements which are only visible when those keys + are pressed. + steps : Union[int, None] + Defaults to 1. Sends `n` interpolated `mousemove` events to represent travel between Playwright's current cursor + position and the provided destination. When set to 1, emits a single `mousemove` event at the destination location. """ return mapping.from_maybe_impl( @@ -15137,6 +15688,7 @@ async def dblclick( force=force, noWaitAfter=no_wait_after, trial=trial, + steps=steps, ) ) @@ -15145,7 +15697,7 @@ async def dispatch_event( type: str, event_init: typing.Optional[typing.Dict] = None, *, - timeout: typing.Optional[float] = None + timeout: typing.Optional[float] = None, ) -> None: """Locator.dispatch_event @@ -15181,7 +15733,6 @@ async def dispatch_event( You can also specify `JSHandle` as the property value if you want live objects to be passed into the event: ```py - # note you can only create data_transfer in chromium and firefox data_transfer = await page.evaluate_handle(\"new DataTransfer()\") await locator.dispatch_event(\"#source\", \"dragstart\", {\"dataTransfer\": data_transfer}) ``` @@ -15208,7 +15759,7 @@ async def evaluate( expression: str, arg: typing.Optional[typing.Any] = None, *, - timeout: typing.Optional[float] = None + timeout: typing.Optional[float] = None, ) -> typing.Any: """Locator.evaluate @@ -15225,9 +15776,11 @@ async def evaluate( **Usage** + Passing argument to `expression`: + ```py - tweets = page.locator(\".tweet .retweets\") - assert await tweets.evaluate(\"node => node.innerText\") == \"10 retweets\" + result = await page.get_by_testid(\"myId\").evaluate(\"(element, [x, y]) => element.textContent + ' ' + x * y\", [7, 8]) + print(result) # prints \"myId text 56\" ``` Parameters @@ -15238,8 +15791,8 @@ async def evaluate( arg : Union[Any, None] Optional argument to pass to `expression`. timeout : Union[float, None] - Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can - be changed by using the `browser_context.set_default_timeout()` or `page.set_default_timeout()` methods. + Maximum time in milliseconds to wait for the locator before evaluating. Note that after locator is resolved, + evaluation itself is not limited by the timeout. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. Returns ------- @@ -15299,7 +15852,7 @@ async def evaluate_handle( expression: str, arg: typing.Optional[typing.Any] = None, *, - timeout: typing.Optional[float] = None + timeout: typing.Optional[float] = None, ) -> "JSHandle": """Locator.evaluate_handle @@ -15328,8 +15881,8 @@ async def evaluate_handle( arg : Union[Any, None] Optional argument to pass to `expression`. timeout : Union[float, None] - Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can - be changed by using the `browser_context.set_default_timeout()` or `page.set_default_timeout()` methods. + Maximum time in milliseconds to wait for the locator before evaluating. Note that after locator is resolved, + evaluation itself is not limited by the timeout. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. Returns ------- @@ -15348,7 +15901,7 @@ async def fill( *, timeout: typing.Optional[float] = None, no_wait_after: typing.Optional[bool] = None, - force: typing.Optional[bool] = None + force: typing.Optional[bool] = None, ) -> None: """Locator.fill @@ -15397,7 +15950,7 @@ async def clear( *, timeout: typing.Optional[float] = None, no_wait_after: typing.Optional[bool] = None, - force: typing.Optional[bool] = None + force: typing.Optional[bool] = None, ) -> None: """Locator.clear @@ -15441,10 +15994,10 @@ def locator( self, selector_or_locator: typing.Union[str, "Locator"], *, - has_text: typing.Optional[typing.Union[str, typing.Pattern[str]]] = None, - has_not_text: typing.Optional[typing.Union[str, typing.Pattern[str]]] = None, + has_text: typing.Optional[typing.Union[typing.Pattern[str], str]] = None, + has_not_text: typing.Optional[typing.Union[typing.Pattern[str], str]] = None, has: typing.Optional["Locator"] = None, - has_not: typing.Optional["Locator"] = None + has_not: typing.Optional["Locator"] = None, ) -> "Locator": """Locator.locator @@ -15499,7 +16052,7 @@ def get_by_alt_text( self, text: typing.Union[str, typing.Pattern[str]], *, - exact: typing.Optional[bool] = None + exact: typing.Optional[bool] = None, ) -> "Locator": """Locator.get_by_alt_text @@ -15536,7 +16089,7 @@ def get_by_label( self, text: typing.Union[str, typing.Pattern[str]], *, - exact: typing.Optional[bool] = None + exact: typing.Optional[bool] = None, ) -> "Locator": """Locator.get_by_label @@ -15577,7 +16130,7 @@ def get_by_placeholder( self, text: typing.Union[str, typing.Pattern[str]], *, - exact: typing.Optional[bool] = None + exact: typing.Optional[bool] = None, ) -> "Locator": """Locator.get_by_placeholder @@ -15706,10 +16259,10 @@ def get_by_role( expanded: typing.Optional[bool] = None, include_hidden: typing.Optional[bool] = None, level: typing.Optional[int] = None, - name: typing.Optional[typing.Union[str, typing.Pattern[str]]] = None, + name: typing.Optional[typing.Union[typing.Pattern[str], str]] = None, pressed: typing.Optional[bool] = None, selected: typing.Optional[bool] = None, - exact: typing.Optional[bool] = None + exact: typing.Optional[bool] = None, ) -> "Locator": """Locator.get_by_role @@ -15763,6 +16316,7 @@ def get_by_role( **NOTE** Unlike most other attributes, `disabled` is inherited through the DOM hierarchy. Learn more about [`aria-disabled`](https://www.w3.org/TR/wai-aria-1.2/#aria-disabled). + expanded : Union[bool, None] An attribute that is usually set by `aria-expanded`. @@ -15856,7 +16410,7 @@ def get_by_text( self, text: typing.Union[str, typing.Pattern[str]], *, - exact: typing.Optional[bool] = None + exact: typing.Optional[bool] = None, ) -> "Locator": """Locator.get_by_text @@ -15920,7 +16474,7 @@ def get_by_title( self, text: typing.Union[str, typing.Pattern[str]], *, - exact: typing.Optional[bool] = None + exact: typing.Optional[bool] = None, ) -> "Locator": """Locator.get_by_title @@ -16035,13 +16589,39 @@ def nth(self, index: int) -> "Locator": return mapping.from_impl(self._impl_obj.nth(index=index)) + def describe(self, description: str) -> "Locator": + """Locator.describe + + Describes the locator, description is used in the trace viewer and reports. Returns the locator pointing to the + same element. + + **Usage** + + ```py + button = page.get_by_test_id(\"btn-sub\").describe(\"Subscribe button\") + await button.click() + ``` + + Parameters + ---------- + description : str + Locator description. + + Returns + ------- + Locator + """ + + return mapping.from_impl(self._impl_obj.describe(description=description)) + def filter( self, *, - has_text: typing.Optional[typing.Union[str, typing.Pattern[str]]] = None, - has_not_text: typing.Optional[typing.Union[str, typing.Pattern[str]]] = None, + has_text: typing.Optional[typing.Union[typing.Pattern[str], str]] = None, + has_not_text: typing.Optional[typing.Union[typing.Pattern[str], str]] = None, has: typing.Optional["Locator"] = None, - has_not: typing.Optional["Locator"] = None + has_not: typing.Optional["Locator"] = None, + visible: typing.Optional[bool] = None, ) -> "Locator": """Locator.filter @@ -16083,6 +16663,8 @@ def filter( outer one. For example, `article` that does not have `div` matches `
Playwright
`. Note that outer and inner locators must belong to the same frame. Inner locator must not contain `FrameLocator`s. + visible : Union[bool, None] + Only matches visible or invisible elements. Returns ------- @@ -16095,23 +16677,31 @@ def filter( hasNotText=has_not_text, has=has._impl_obj if has else None, hasNot=has_not._impl_obj if has_not else None, + visible=visible, ) ) def or_(self, locator: "Locator") -> "Locator": """Locator.or_ - Creates a locator that matches either of the two locators. + Creates a locator matching all elements that match one or both of the two locators. + + Note that when both locators match something, the resulting locator will have multiple matches, potentially causing + a [locator strictness](https://playwright.dev/python/docs/locators#strictness) violation. **Usage** Consider a scenario where you'd like to click on a \"New email\" button, but sometimes a security settings dialog shows up instead. In this case, you can wait for either a \"New email\" button, or a dialog and act accordingly. + **NOTE** If both \"New email\" button and security dialog appear on screen, the \"or\" locator will match both of them, + possibly throwing the [\"strict mode violation\" error](https://playwright.dev/python/docs/locators#strictness). In this case, you can use + `locator.first()` to only match one of them. + ```py new_email = page.get_by_role(\"button\", name=\"New\") dialog = page.get_by_text(\"Confirm security settings\") - await expect(new_email.or_(dialog)).to_be_visible() + await expect(new_email.or_(dialog).first).to_be_visible() if (await dialog.is_visible()): await page.get_by_role(\"button\", name=\"Dismiss\").click() await new_email.click() @@ -16139,7 +16729,7 @@ def and_(self, locator: "Locator") -> "Locator": The following example finds a button with a specific title. ```py - button = page.get_by_role(\"button\").and_(page.getByTitle(\"Subscribe\")) + button = page.get_by_role(\"button\").and_(page.get_by_title(\"Subscribe\")) ``` Parameters @@ -16189,9 +16779,13 @@ async def all(self) -> typing.List["Locator"]: elements. **NOTE** `locator.all()` does not wait for elements to match the locator, and instead immediately returns - whatever is present in the page. When the list of elements changes dynamically, `locator.all()` will - produce unpredictable and flaky results. When the list of elements is stable, but loaded dynamically, wait for the - full list to finish loading before calling `locator.all()`. + whatever is present in the page. + + When the list of elements changes dynamically, `locator.all()` will produce unpredictable and flaky + results. + + When the list of elements is stable, but loaded dynamically, wait for the full list to finish loading before + calling `locator.all()`. **Usage** @@ -16237,7 +16831,8 @@ async def drag_to( timeout: typing.Optional[float] = None, trial: typing.Optional[bool] = None, source_position: typing.Optional[Position] = None, - target_position: typing.Optional[Position] = None + target_position: typing.Optional[Position] = None, + steps: typing.Optional[int] = None, ) -> None: """Locator.drag_to @@ -16284,6 +16879,9 @@ async def drag_to( target_position : Union[{x: float, y: float}, None] Drops on the target element at this point relative to the top-left corner of the element's padding box. If not specified, some visible point of the element is used. + steps : Union[int, None] + Defaults to 1. Sends `n` interpolated `mousemove` events to represent travel between the `mousedown` and `mouseup` + of the drag. When set to 1, emits a single `mousemove` event at the destination location. """ return mapping.from_maybe_impl( @@ -16295,6 +16893,7 @@ async def drag_to( trial=trial, sourcePosition=source_position, targetPosition=target_position, + steps=steps, ) ) @@ -16335,7 +16934,7 @@ async def hover( timeout: typing.Optional[float] = None, no_wait_after: typing.Optional[bool] = None, force: typing.Optional[bool] = None, - trial: typing.Optional[bool] = None + trial: typing.Optional[bool] = None, ) -> None: """Locator.hover @@ -16378,7 +16977,9 @@ async def hover( Whether to bypass the [actionability](../actionability.md) checks. Defaults to `false`. trial : Union[bool, None] When set, this method only performs the [actionability](../actionability.md) checks and skips the action. Defaults - to `false`. Useful to wait until the element is ready for the action without performing it. + to `false`. Useful to wait until the element is ready for the action without performing it. Note that keyboard + `modifiers` will be pressed regardless of `trial` to allow testing elements which are only visible when those keys + are pressed. """ return mapping.from_maybe_impl( @@ -16526,7 +17127,9 @@ async def is_disabled(self, *, timeout: typing.Optional[float] = None) -> bool: async def is_editable(self, *, timeout: typing.Optional[float] = None) -> bool: """Locator.is_editable - Returns whether the element is [editable](https://playwright.dev/python/docs/actionability#editable). + Returns whether the element is [editable](https://playwright.dev/python/docs/actionability#editable). If the target element is not an ``, + `