[ { "path": ".azure-pipelines/guardian/SDL/.gdnsuppress", "content": "{\n \"hydrated\": false,\n \"properties\": {\n \"helpUri\": \"https://eng.ms/docs/microsoft-security/security/azure-security/cloudai-security-fundamentals-engineering/security-integration/guardian-wiki/microsoft-guardian/general/suppressions\",\n \"hydrationStatus\": \"This file does not contain identifying data. It is safe to check into your repo. To hydrate this file with identifying data, run `guardian hydrate --help` and follow the guidance.\"\n },\n \"version\": \"1.0.0\",\n \"suppressionSets\": {\n \"default\": {\n \"name\": \"default\",\n \"createdDate\": \"2024-02-06 21:00:02Z\",\n \"lastUpdatedDate\": \"2024-02-06 21:00:02Z\"\n }\n },\n \"results\": {\n \"bffa73d7410f5963f2538f06124ac5524c076da77867a0a19ccf60e508062dff\": {\n \"signature\": \"bffa73d7410f5963f2538f06124ac5524c076da77867a0a19ccf60e508062dff\",\n \"alternativeSignatures\": [],\n \"memberOf\": [\n \"default\"\n ],\n \"createdDate\": \"2024-02-06 21:00:02Z\"\n },\n \"964642e3cd0f022d5b63f5d3c467d034df4b1664e58dd132b6cd54c98bdae6a1\": {\n \"signature\": \"964642e3cd0f022d5b63f5d3c467d034df4b1664e58dd132b6cd54c98bdae6a1\",\n \"alternativeSignatures\": [\n \"f2d5560538c833834ca11e62fa6509618ab5454e1e71faf2847cb6fd07f4c4e0\"\n ],\n \"memberOf\": [\n \"default\"\n ],\n \"createdDate\": \"2024-02-06 21:00:02Z\"\n },\n \"5b0f97262e176cd67207fd63a2c74b9984829286e9229d10efc32d6b73130e37\": {\n \"signature\": \"5b0f97262e176cd67207fd63a2c74b9984829286e9229d10efc32d6b73130e37\",\n \"alternativeSignatures\": [\n \"29a18985690880b8caeebc339c7d2afd107510838cdc6561c1f5493478712581\"\n ],\n \"memberOf\": [\n \"default\"\n ],\n \"createdDate\": \"2024-02-06 21:00:02Z\"\n },\n \"636fe8a4848f24231e94dc13a238022f90a2894cd47a483e351e467eeb98de52\": {\n \"signature\": \"636fe8a4848f24231e94dc13a238022f90a2894cd47a483e351e467eeb98de52\",\n \"alternativeSignatures\": [\n \"e20632aa7941af4239fd857f802e05582c841fb9ae84e17c71ca6c7fc713246b\"\n ],\n \"memberOf\": [\n \"default\"\n ],\n \"createdDate\": \"2024-02-06 21:00:02Z\"\n },\n \"67ae7118600b0793ec3f0a58a753888e13ce4badcc15575614ee6aa622e5009c\": {\n \"signature\": \"67ae7118600b0793ec3f0a58a753888e13ce4badcc15575614ee6aa622e5009c\",\n \"alternativeSignatures\": [\n \"d1e68c2c7d9815f47331dd34c31db2634804b45b078a53d00843082747155ac9\"\n ],\n \"memberOf\": [\n \"default\"\n ],\n \"createdDate\": \"2024-02-06 21:00:02Z\"\n },\n \"9b7d0de03b9e0e0b2711e31df7c804528c357bf5aa2d689fb5a5f42750e84077\": {\n \"signature\": \"9b7d0de03b9e0e0b2711e31df7c804528c357bf5aa2d689fb5a5f42750e84077\",\n \"alternativeSignatures\": [\n \"e42bf5a49be2b1b815d1fde98ebf9d463fd2e70be1e8ca661f1210ce5b0c4953\"\n ],\n \"memberOf\": [\n \"default\"\n ],\n \"createdDate\": \"2024-02-06 21:00:02Z\"\n },\n \"06ecbceae8bfd10acf8c35f21af3926d172c7930f24a204cc58b61efc6c4c770\": {\n \"signature\": \"06ecbceae8bfd10acf8c35f21af3926d172c7930f24a204cc58b61efc6c4c770\",\n \"alternativeSignatures\": [\n \"035d6eb1444a809987923a39793fbb1ab9e4462405f38f94bc425c579705a9f2\"\n ],\n \"memberOf\": [\n \"default\"\n ],\n \"createdDate\": \"2024-02-06 21:00:02Z\"\n },\n \"c103671af429c32de81f2dc2e7a92999de88a517d916a8f75c8e37448bb2efe9\": {\n \"signature\": \"c103671af429c32de81f2dc2e7a92999de88a517d916a8f75c8e37448bb2efe9\",\n \"alternativeSignatures\": [\n \"3f904a503c12b62c2922900a2e689632e06272a815448939b1fdd435bcf74388\"\n ],\n \"memberOf\": [\n \"default\"\n ],\n \"createdDate\": \"2024-02-06 21:00:02Z\"\n },\n \"d1196285a4e64cf6f0f7f22a29bf5b33b540137da1a89ed2af0c880d2a8c1d64\": {\n \"signature\": \"d1196285a4e64cf6f0f7f22a29bf5b33b540137da1a89ed2af0c880d2a8c1d64\",\n \"alternativeSignatures\": [\n \"1c24094ca9e68a76a81c747853860e46fd139c9f47f0fdbad9133538e7d064b2\"\n ],\n \"memberOf\": [\n \"default\"\n ],\n \"createdDate\": \"2024-02-06 21:00:02Z\"\n }\n }\n}\n" }, { "path": ".azure-pipelines/publish.yml", "content": "pr: none\n\ntrigger:\n tags:\n include:\n - '*'\n\nresources:\n repositories:\n - repository: 1esPipelines\n type: git\n name: 1ESPipelineTemplates/1ESPipelineTemplates\n ref: refs/tags/release\n\nextends:\n template: v1/1ES.Official.PipelineTemplate.yml@1esPipelines\n parameters:\n pool:\n name: DevDivPlaywrightAzurePipelinesUbuntu2204\n os: linux\n sdl:\n sourceAnalysisPool:\n name: DevDivPlaywrightAzurePipelinesWindows2022\n # The image must be windows-based due to restrictions of the SDL tools. See: https://aka.ms/AAo6v8e\n # In the case of a windows build, this can be the same as the above pool image.\n os: windows\n suppression:\n suppressionFile: $(Build.SourcesDirectory)\\.azure-pipelines\\guardian\\SDL\\.gdnsuppress\n stages:\n - stage: Stage\n jobs:\n - job: Build\n templateContext:\n outputs:\n - output: pipelineArtifact\n path: $(Build.ArtifactStagingDirectory)/esrp-build\n artifact: esrp-build\n steps:\n - task: UsePythonVersion@0\n inputs:\n versionSpec: '3.9'\n displayName: 'Use Python'\n - script: |\n python -m pip install --upgrade pip\n pip install -r local-requirements.txt\n pip install -r requirements.txt\n pip install -e .\n for wheel in $(python setup.py --list-wheels); do\n PLAYWRIGHT_TARGET_WHEEL=$wheel python -m build --wheel --outdir $(Build.ArtifactStagingDirectory)/esrp-build\n done\n displayName: 'Install & Build'\n - job: Publish\n dependsOn: Build\n templateContext:\n type: releaseJob\n isProduction: true\n inputs:\n - input: pipelineArtifact\n artifactName: esrp-build\n targetPath: $(Build.ArtifactStagingDirectory)/esrp-build\n steps:\n - checkout: none\n - task: EsrpRelease@9\n inputs:\n connectedservicename: 'Playwright-ESRP-PME'\n usemanagedidentity: true\n keyvaultname: 'playwright-esrp-pme'\n signcertname: 'ESRP-Release-Sign'\n clientid: '13434a40-7de4-4c23-81a3-d843dc81c2c5'\n intent: 'PackageDistribution'\n contenttype: 'PyPi'\n # Keeping it commented out as a workaround for:\n # https://portal.microsofticm.com/imp/v3/incidents/incident/499972482/summary\n # contentsource: 'folder'\n folderlocation: '$(Build.ArtifactStagingDirectory)/esrp-build'\n waitforreleasecompletion: true\n owners: 'yurys@microsoft.com'\n approvers: 'yurys@microsoft.com'\n serviceendpointurl: 'https://api.esrp.microsoft.com'\n mainpublisher: 'Playwright'\n domaintenantid: '975f013f-7f24-47e8-a7d3-abc4752bf346'\n displayName: 'ESRP Release to PIP'\n" }, { "path": ".claude/skills/playwright-roll/SKILL.md", "content": "---\nname: playwright-roll\ndescription: Roll Playwright Python to a new version\n---\n\nHelp the user roll to a new version of Playwright.\n../../../ROLLING.md contains general instructions and scripts.\n\nStart with updating the version and generating the API to see the state of things.\n\nAfterwards, work through the list of changes that need to be backported.\nYou can find a list of pull requests that might need to be taking into account in the issue titled \"Backport changes\".\nWork through them one-by-one and check off the items that you have handled.\nNot all of them will be relevant, some might have partially been reverted, etc. - so feel free to check with the upstream release branch.\n\nRolling includes:\n- updating client implementation to match changes in the upstream JS implementation (see ../playwright/packages/playwright-core/src/client)\n- adding a couple of new tests to verify new/changed functionality\n\n## Tips & Tricks\n- Project checkouts are in the parent directory (`../`).\n- when updating checkboxes, store the issue content into /tmp and edit it there, then update the issue based on the file\n- use the \"gh\" cli to interact with GitHub\n" }, { "path": ".gitattributes", "content": "# text files must be lf for golden file tests to work\n* text=auto eol=lf\n" }, { "path": ".github/ISSUE_TEMPLATE/bug.yml", "content": "name: Bug Report 🪲\ndescription: Create a bug report to help us improve\ntitle: '[Bug]: '\nbody:\n - type: markdown\n attributes:\n value: |\n # Please follow these steps first:\n - type: markdown\n attributes:\n value: |\n ## Troubleshoot\n If Playwright is not behaving the way you expect, we'd ask you to look at the [documentation](https://playwright.dev/python/docs/intro) and search the issue tracker for evidence supporting your expectation.\n Please make reasonable efforts to troubleshoot and rule out issues with your code, the configuration, or any 3rd party libraries you might be using.\n Playwright offers [several debugging tools](https://playwright.dev/python/docs/debug) that you can use to troubleshoot your issues.\n - type: markdown\n attributes:\n value: |\n ## Ask for help through appropriate channels\n If you feel unsure about the cause of the problem, consider asking for help on for example [StackOverflow](https://stackoverflow.com/questions/ask) or our [Discord channel](https://aka.ms/playwright/discord) before posting a bug report. The issue tracker is not a help forum.\n - type: markdown\n attributes:\n value: |\n ## Make a minimal reproduction\n To file the report, you will need a GitHub repository with a minimal (but complete) example and simple/clear steps on how to reproduce the bug.\n The simpler you can make it, the more likely we are to successfully verify and fix the bug.\n - type: markdown\n attributes:\n value: |\n > [!IMPORTANT]\n > Bug reports without a minimal reproduction will be rejected.\n\n ---\n - type: input\n id: version\n attributes:\n label: Version\n description: |\n The version of Playwright you are using.\n Is it the [latest](https://github.com/microsoft/playwright-python/releases)? Test and see if the bug has already been fixed.\n placeholder: ex. 1.41.1\n validations:\n required: true\n - type: textarea\n id: reproduction\n attributes:\n label: Steps to reproduce\n description: Please link to a repository with a minimal reproduction and describe accurately how we can reproduce/verify the bug.\n value: |\n Example steps (replace with your own):\n 1. Clone my repo at https://github.com//example\n 2. pip install -r requirements.txt\n 3. python test.py\n 4. You should see the error come up\n validations:\n required: true\n - type: textarea\n id: expected\n attributes:\n label: Expected behavior\n description: A description of what you expect to happen.\n placeholder: I expect to see X or Y\n validations:\n required: true\n - type: textarea\n id: what-happened\n attributes:\n label: Actual behavior\n description: |\n A clear and concise description of the unexpected behavior.\n Please include any relevant output here, especially any error messages.\n placeholder: A bug happened!\n validations:\n required: true\n - type: textarea\n id: context\n attributes:\n label: Additional context\n description: Anything else that might be relevant\n validations:\n required: false\n - type: textarea\n id: envinfo\n attributes:\n label: Environment\n description: |\n Please provide information about the environment you are running in.\n value: |\n - Operating System: [Ubuntu 22.04]\n - CPU: [arm64]\n - Browser: [All, Chromium, Firefox, WebKit]\n - Python Version: [3.12]\n - Other info:\n render: Text\n validations:\n required: true\n" }, { "path": ".github/ISSUE_TEMPLATE/config.yml", "content": "blank_issues_enabled: false\ncontact_links:\n - name: Join our Discord Server\n url: https://aka.ms/playwright/discord\n about: Ask questions and discuss with other community members\n" }, { "path": ".github/ISSUE_TEMPLATE/documentation.yml", "content": "name: Documentation 📖\ndescription: Submit a request to add or update documentation\ntitle: '[Docs]: '\nlabels: ['Documentation :book:']\nbody:\n - type: markdown\n attributes:\n value: |\n ### Thank you for helping us improve our documentation!\n Please be sure you are looking at [the Next version of the documentation](https://playwright.dev/python/docs/next/intro) before opening an issue here.\n - type: textarea\n id: links\n attributes:\n label: Page(s)\n description: |\n Links to one or more documentation pages that should be modified.\n If you are reporting an issue with a specific section of a page, try to link directly to the nearest anchor.\n If you are suggesting that a new page be created, link to the parent of the proposed page.\n validations:\n required: true\n - type: textarea\n id: description\n attributes:\n label: Description\n description: |\n Describe the change you are requesting.\n If the issue pertains to a single function or matcher, be sure to specify the entire call signature.\n validations:\n required: true\n" }, { "path": ".github/ISSUE_TEMPLATE/feature.yml", "content": "name: Feature Request 🚀\ndescription: Submit a proposal for a new feature\ntitle: '[Feature]: '\nbody:\n - type: markdown\n attributes:\n value: |\n ### Thank you for taking the time to suggest a new feature!\n - type: textarea\n id: description\n attributes:\n label: '🚀 Feature Request'\n description: A clear and concise description of what the feature is.\n validations:\n required: true\n - type: textarea\n id: example\n attributes:\n label: Example\n description: Describe how this feature would be used.\n validations:\n required: false\n - type: textarea\n id: motivation\n attributes:\n label: Motivation\n description: |\n Outline your motivation for the proposal. How will it make Playwright better?\n validations:\n required: true\n" }, { "path": ".github/ISSUE_TEMPLATE/question.yml", "content": "name: 'Questions / Help 💬'\ndescription: If you have questions, please check StackOverflow or Discord\ntitle: '[Please read the message below]'\nlabels: [':speech_balloon: Question']\nbody:\n - type: markdown\n attributes:\n value: |\n ## Questions and Help 💬\n\n This issue tracker is reserved for bug reports and feature requests.\n\n For anything else, such as questions or getting help, please see:\n\n - [The Playwright documentation](https://playwright.dev)\n - [Our Discord server](https://aka.ms/playwright/discord)\n - type: checkboxes\n id: no-post\n attributes:\n label: |\n Please do not submit this issue.\n description: |\n > [!IMPORTANT]\n > This issue will be closed.\n options:\n - label: I understand\n required: true\n" }, { "path": ".github/ISSUE_TEMPLATE/regression.yml", "content": "name: Report regression\ndescription: Functionality that used to work and does not any more\ntitle: \"[Regression]: \"\n\nbody:\n - type: markdown\n attributes:\n value: |\n # Please follow these steps first:\n - type: markdown\n attributes:\n value: |\n ## Make a minimal reproduction\n To file the report, you will need a GitHub repository with a minimal (but complete) example and simple/clear steps on how to reproduce the regression.\n The simpler you can make it, the more likely we are to successfully verify and fix the regression.\n - type: markdown\n attributes:\n value: |\n > [!IMPORTANT]\n > Regression reports without a minimal reproduction will be rejected.\n\n ---\n - type: input\n id: goodVersion\n attributes:\n label: Last Good Version\n description: |\n Last version of Playwright where the feature was working.\n placeholder: ex. 1.40.1\n validations:\n required: true\n - type: input\n id: badVersion\n attributes:\n label: First Bad Version\n description: |\n First version of Playwright where the feature was broken.\n Is it the [latest](https://github.com/microsoft/playwright-python/releases)? Test and see if the regression has already been fixed.\n placeholder: ex. 1.41.1\n validations:\n required: true\n - type: textarea\n id: reproduction\n attributes:\n label: Steps to reproduce\n description: Please link to a repository with a minimal reproduction and describe accurately how we can reproduce/verify the bug.\n value: |\n Example steps (replace with your own):\n 1. Clone my repo at https://github.com//example\n 2. pip -r requirements.txt\n 3. python test.py\n 4. You should see the error come up\n validations:\n required: true\n - type: textarea\n id: expected\n attributes:\n label: Expected behavior\n description: A description of what you expect to happen.\n placeholder: I expect to see X or Y\n validations:\n required: true\n - type: textarea\n id: what-happened\n attributes:\n label: Actual behavior\n description: A clear and concise description of the unexpected behavior.\n placeholder: A bug happened!\n validations:\n required: true\n - type: textarea\n id: context\n attributes:\n label: Additional context\n description: Anything else that might be relevant\n validations:\n required: false\n - type: textarea\n id: envinfo\n attributes:\n label: Environment\n description: |\n Please provide information about the environment you are running in.\n value: |\n - Operating System: [Ubuntu 22.04]\n - CPU: [arm64]\n - Browser: [All, Chromium, Firefox, WebKit]\n - Python Version: [3.12]\n - Other info:\n render: Text\n validations:\n required: true\n" }, { "path": ".github/dependabot.yml", "content": "version: 2\nupdates:\n - package-ecosystem: \"pip\"\n directory: \"/\"\n schedule:\n interval: \"weekly\"\n - package-ecosystem: \"github-actions\"\n directory: \"/\"\n schedule:\n interval: \"weekly\"\n groups:\n actions:\n patterns:\n - \"*\"\n" }, { "path": ".github/workflows/ci.yml", "content": "name: CI\n\non:\n push:\n branches:\n - main\n - release-*\n pull_request:\n branches:\n - main\n - release-*\n\nconcurrency:\n # For pull requests, cancel all currently-running jobs for this workflow\n # https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#concurrency\n group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}\n cancel-in-progress: true\n\njobs:\n infra:\n name: Lint\n runs-on: ubuntu-latest\n steps:\n - uses: actions/checkout@v5\n - name: Set up Python\n uses: actions/setup-python@v6\n with:\n python-version: \"3.10\"\n - name: Install dependencies & browsers\n run: |\n python -m pip install --upgrade pip\n pip install -r local-requirements.txt\n pip install -r requirements.txt\n pip install -e .\n python -m build --wheel\n python -m playwright install --with-deps\n - name: Lint\n run: pre-commit run --show-diff-on-failure --color=always --all-files\n - name: Generate APIs\n run: bash scripts/update_api.sh\n - name: Verify generated API is up to date\n run: git diff --exit-code\n\n build:\n name: Build\n timeout-minutes: 45\n strategy:\n fail-fast: false\n matrix:\n os: [ubuntu-latest, windows-latest, macos-latest]\n python-version: ['3.9', '3.10']\n browser: [chromium, firefox, webkit]\n include:\n - os: windows-latest\n python-version: '3.11'\n browser: chromium\n - os: macos-latest\n python-version: '3.11'\n browser: chromium\n - os: ubuntu-latest\n python-version: '3.11'\n browser: chromium\n - os: windows-latest\n python-version: '3.12'\n browser: chromium\n - os: macos-latest\n python-version: '3.12'\n browser: chromium\n - os: ubuntu-latest\n python-version: '3.12'\n browser: chromium\n - os: windows-latest\n python-version: '3.13'\n browser: chromium\n - os: macos-latest\n python-version: '3.13'\n browser: chromium\n - os: ubuntu-latest\n python-version: '3.13'\n browser: chromium\n runs-on: ${{ matrix.os }}\n steps:\n - uses: actions/checkout@v5\n - name: Set up Python\n uses: actions/setup-python@v6\n with:\n python-version: ${{ matrix.python-version }}\n - name: Install dependencies & browsers\n run: |\n python -m pip install --upgrade pip\n pip install -r local-requirements.txt\n pip install -r requirements.txt\n pip install -e .\n python -m build --wheel\n python -m playwright install --with-deps ${{ matrix.browser }}\n - name: Common Tests\n run: pytest tests/common --browser=${{ matrix.browser }} --timeout 90\n - name: Test Reference count\n run: pytest tests/test_reference_count_async.py --browser=${{ matrix.browser }}\n - name: Test Wheel Installation\n run: pytest tests/test_installation.py --browser=${{ matrix.browser }}\n - name: Test Sync API\n if: matrix.os != 'ubuntu-latest'\n run: pytest tests/sync --browser=${{ matrix.browser }} --timeout 90\n - name: Test Sync API\n if: matrix.os == 'ubuntu-latest'\n run: xvfb-run pytest tests/sync --browser=${{ matrix.browser }} --timeout 90\n - name: Test Async API\n if: matrix.os != 'ubuntu-latest'\n run: pytest tests/async --browser=${{ matrix.browser }} --timeout 90\n - name: Test Async API\n if: matrix.os == 'ubuntu-latest'\n run: xvfb-run pytest tests/async --browser=${{ matrix.browser }} --timeout 90\n\n test-stable:\n name: Stable\n timeout-minutes: 45\n strategy:\n fail-fast: false\n matrix:\n os: [ubuntu-latest, windows-latest, macos-latest]\n browser-channel: [chrome]\n include:\n - os: windows-latest\n browser-channel: msedge\n - os: macos-latest\n browser-channel: msedge\n runs-on: ${{ matrix.os }}\n steps:\n - uses: actions/checkout@v5\n - name: Set up Python\n uses: actions/setup-python@v6\n with:\n python-version: \"3.10\"\n - name: Install dependencies & browsers\n run: |\n python -m pip install --upgrade pip\n pip install -r local-requirements.txt\n pip install -r requirements.txt\n pip install -e .\n python -m build --wheel\n python -m playwright install ${{ matrix.browser-channel }} --with-deps\n - name: Common Tests\n run: pytest tests/common --browser=chromium --browser-channel=${{ matrix.browser-channel }} --timeout 90\n - name: Test Sync API\n if: matrix.os != 'ubuntu-latest'\n run: pytest tests/sync --browser=chromium --browser-channel=${{ matrix.browser-channel }} --timeout 90\n - name: Test Sync API\n if: matrix.os == 'ubuntu-latest'\n run: xvfb-run pytest tests/sync --browser=chromium --browser-channel=${{ matrix.browser-channel }} --timeout 90\n - name: Test Async API\n if: matrix.os != 'ubuntu-latest'\n run: pytest tests/async --browser=chromium --browser-channel=${{ matrix.browser-channel }} --timeout 90\n - name: Test Async API\n if: matrix.os == 'ubuntu-latest'\n run: xvfb-run pytest tests/async --browser=chromium --browser-channel=${{ matrix.browser-channel }} --timeout 90\n\n build-conda:\n name: Conda Build\n strategy:\n fail-fast: false\n matrix:\n os: [ubuntu-22.04, macos-13, windows-2022]\n runs-on: ${{ matrix.os }}\n steps:\n - uses: actions/checkout@v5\n with:\n fetch-depth: 0\n - name: Get conda\n uses: conda-incubator/setup-miniconda@v3\n with:\n python-version: 3.9\n channels: conda-forge\n miniconda-version: latest\n - name: Prepare\n run: conda install conda-build conda-verify\n - name: Build\n run: conda build .\n\n test_examples:\n name: Examples\n runs-on: ubuntu-22.04\n defaults:\n run:\n working-directory: examples/todomvc/\n steps:\n - uses: actions/checkout@v5\n - name: Set up Python\n uses: actions/setup-python@v6\n with:\n python-version: '3.10'\n - name: Install dependencies & browsers\n run: |\n pip install -r requirements.txt\n python -m playwright install --with-deps chromium\n - name: Common Tests\n run: pytest\n" }, { "path": ".github/workflows/publish.yml", "content": "name: Upload Python Package\non:\n release:\n types: [published]\n workflow_dispatch:\njobs:\n deploy-conda:\n strategy:\n fail-fast: false\n matrix:\n include:\n - os: ubuntu-latest\n target-platform: linux-x86_64\n - os: ubuntu-latest\n target-platform: linux-aarch64\n - os: windows-latest\n target-platform: win-64\n - os: macos-latest-large\n target-platform: osx-intel\n - os: macos-latest-xlarge\n target-platform: osx-arm64\n runs-on: ${{ matrix.os }}\n defaults:\n run:\n # Required for conda-incubator/setup-miniconda@v3\n shell: bash -el {0}\n steps:\n - uses: actions/checkout@v5\n with:\n fetch-depth: 0\n - name: Get conda\n uses: conda-incubator/setup-miniconda@v3\n with:\n python-version: 3.9\n channels: conda-forge\n miniconda-version: latest\n - name: Prepare\n run: conda install anaconda-client conda-build conda-verify\n - name: Build and Upload\n env:\n ANACONDA_API_TOKEN: ${{ secrets.ANACONDA_API_TOKEN }}\n run: |\n conda config --set anaconda_upload yes\n if [ \"${{ matrix.target-platform }}\" == \"osx-arm64\" ]; then\n conda build --user microsoft . -m conda_build_config_osx_arm64.yaml\n elif [ \"${{ matrix.target-platform }}\" == \"linux-aarch64\" ]; then\n conda build --user microsoft . -m conda_build_config_linux_aarch64.yaml\n else\n conda build --user microsoft .\n fi\n" }, { "path": ".github/workflows/publish_docker.yml", "content": "name: \"publish release - Docker\"\n\non:\n workflow_dispatch:\n release:\n types: [published]\n\njobs:\n publish-docker-release:\n name: \"publish to DockerHub\"\n runs-on: ubuntu-22.04\n if: github.repository == 'microsoft/playwright-python'\n permissions:\n id-token: write # This is required for OIDC login (azure/login) to succeed\n contents: read # This is required for actions/checkout to succeed\n environment: Docker\n steps:\n - uses: actions/checkout@v5\n - name: Azure login\n uses: azure/login@v2\n with:\n client-id: ${{ secrets.AZURE_DOCKER_CLIENT_ID }}\n tenant-id: ${{ secrets.AZURE_DOCKER_TENANT_ID }}\n subscription-id: ${{ secrets.AZURE_DOCKER_SUBSCRIPTION_ID }}\n - name: Login to ACR via OIDC\n run: az acr login --name playwright\n - name: Set up Python\n uses: actions/setup-python@v6\n with:\n python-version: \"3.10\"\n - name: Set up Docker QEMU for arm64 docker builds\n uses: docker/setup-qemu-action@v3\n with:\n platforms: arm64\n - name: Install dependencies & browsers\n run: |\n python -m pip install --upgrade pip\n pip install -r local-requirements.txt\n pip install -r requirements.txt\n pip install -e .\n - run: ./utils/docker/publish_docker.sh stable\n" }, { "path": ".github/workflows/test_docker.yml", "content": "name: Test Docker\non:\n push:\n paths:\n - '.github/workflows/test_docker.yml'\n - 'setup.py'\n - '**/Dockerfile.*'\n branches:\n - main\n - release-*\n pull_request:\n paths:\n - '.github/workflows/test_docker.yml'\n - 'setup.py'\n - '**/Dockerfile.*'\n branches:\n - main\n - release-*\njobs:\n build:\n timeout-minutes: 120\n runs-on: ${{ matrix.runs-on }}\n strategy:\n fail-fast: false\n matrix:\n docker-image-variant:\n - jammy\n - noble\n runs-on:\n - ubuntu-24.04\n - ubuntu-24.04-arm\n steps:\n - uses: actions/checkout@v5\n - name: Set up Python\n uses: actions/setup-python@v6\n with:\n python-version: \"3.10\"\n - name: Install dependencies\n run: |\n python -m pip install --upgrade pip\n pip install -r local-requirements.txt\n pip install -r requirements.txt\n pip install -e .\n - name: Build Docker image\n run: |\n ARCH=\"${{ matrix.runs-on == 'ubuntu-24.04-arm' && 'arm64' || 'amd64' }}\"\n bash utils/docker/build.sh --$ARCH ${{ matrix.docker-image-variant }} playwright-python:localbuild-${{ matrix.docker-image-variant }}\n - name: Test\n run: |\n 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)\"\n # Fix permissions for Git inside the container\n docker exec \"${CONTAINER_ID}\" chown -R root:root /root/playwright\n docker exec \"${CONTAINER_ID}\" pip install -r local-requirements.txt\n docker exec \"${CONTAINER_ID}\" pip install -r requirements.txt\n docker exec \"${CONTAINER_ID}\" pip install -e .\n docker exec \"${CONTAINER_ID}\" python -m build --wheel\n docker exec \"${CONTAINER_ID}\" xvfb-run pytest tests/sync/\n docker exec \"${CONTAINER_ID}\" xvfb-run pytest tests/async/\n" }, { "path": ".gitignore", "content": "**/__pycache__/\ndriver/\nplaywright/driver/\nplaywright.egg-info/\nbuild/\ndist/\nvenv/\n.idea/\n**/*.pyc\nenv/\nhtmlcov/\n.coverage*\n.DS_Store\n.vscode/\n.eggs\n_repo_version.py\ncoverage.xml\njunit/\nhtmldocs/\nutils/docker/dist/\nPipfile\nPipfile.lock\n.venv/\n" }, { "path": ".pre-commit-config.yaml", "content": "# See https://pre-commit.com for more information\n# See https://pre-commit.com/hooks.html for more hooks\nrepos:\n - repo: https://github.com/pre-commit/pre-commit-hooks\n rev: v5.0.0\n hooks:\n - id: trailing-whitespace\n - id: end-of-file-fixer\n exclude: tests/assets/har-sha1-main-response.txt\n - id: check-yaml\n - id: check-toml\n - id: requirements-txt-fixer\n - id: check-ast\n - id: check-builtin-literals\n - id: check-executables-have-shebangs\n - id: check-merge-conflict\n - repo: https://github.com/psf/black\n rev: 25.1.0\n hooks:\n - id: black\n - repo: https://github.com/pre-commit/mirrors-mypy\n rev: v1.17.0\n hooks:\n - id: mypy\n additional_dependencies: [types-pyOpenSSL==24.1.0.20240722, types-requests==2.32.4.20250611]\n - repo: https://github.com/pycqa/flake8\n rev: 7.3.0\n hooks:\n - id: flake8\n - repo: https://github.com/pycqa/isort\n rev: 6.0.1\n hooks:\n - id: isort\n - repo: local\n hooks:\n - id: pyright\n name: pyright\n entry: pyright\n language: node\n pass_filenames: false\n types: [python]\n additional_dependencies: [\"pyright@1.1.403\"]\n - repo: local\n hooks:\n - id: check-license-header\n name: Check License Header\n entry: ./utils/linting/check_file_header.py\n language: python\n types: [python]\n" }, { "path": "CODE_OF_CONDUCT.md", "content": "# Microsoft Open Source Code of Conduct\n\nThis project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).\n\nResources:\n\n- [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/)\n- [Microsoft Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/)\n- Contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with questions or concerns\n" }, { "path": "CONTRIBUTING.md", "content": "# Contributing\n\n## How to Contribute\n\n### Configuring python environment\n\nThe project development requires Python version 3.9+. To set it as default in the environment run the following commands:\n\n```sh\n# You may need to install python 3.9 venv if it's missing, on Ubuntu just run `sudo apt-get install python3.9-venv`\npython3.9 -m venv env\nsource ./env/bin/activate\n```\n\nInstall required dependencies:\n\n```sh\npython -m pip install --upgrade pip\npip install -r local-requirements.txt\n```\n\nBuild and install drivers:\n\n```sh\npip install -e .\npython -m build --wheel\n```\n\nRun tests:\n\n```sh\npytest --browser chromium\n```\n\nChecking for typing errors\n\n```sh\nmypy playwright\n```\n\nFormat the code\n\n```sh\npre-commit install\npre-commit run --all-files\n```\n\nFor more details look at the [CI configuration](./.github/workflows/ci.yml).\n\nCollect coverage\n\n```sh\npytest --browser chromium --cov-report html --cov=playwright\nopen htmlcov/index.html\n```\n\n### Regenerating APIs\n\n```bash\n./scripts/update_api.sh\npre-commit run --all-files\n```\n\n## Contributor License Agreement\n\nThis project welcomes contributions and suggestions. Most contributions require you to agree to a\nContributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us\nthe rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.\n\nWhen you submit a pull request, a CLA bot will automatically determine whether you need to provide\na CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions\nprovided by the bot. You will only need to do this once across all repos using our CLA.\n\n## Code of Conduct\n\nThis project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).\nFor more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or\ncontact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.\n" }, { "path": "LICENSE", "content": " Apache License\n Version 2.0, January 2004\n http://www.apache.org/licenses/\n\n TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION\n\n 1. Definitions.\n\n \"License\" shall mean the terms and conditions for use, reproduction,\n and distribution as defined by Sections 1 through 9 of this document.\n\n \"Licensor\" shall mean the copyright owner or entity authorized by\n the copyright owner that is granting the License.\n\n \"Legal Entity\" shall mean the union of the acting entity and all\n other entities that control, are controlled by, or are under common\n control with that entity. For the purposes of this definition,\n \"control\" means (i) the power, direct or indirect, to cause the\n direction or management of such entity, whether by contract or\n otherwise, or (ii) ownership of fifty percent (50%) or more of the\n outstanding shares, or (iii) beneficial ownership of such entity.\n\n \"You\" (or \"Your\") shall mean an individual or Legal Entity\n exercising permissions granted by this License.\n\n \"Source\" form shall mean the preferred form for making modifications,\n including but not limited to software source code, documentation\n source, and configuration files.\n\n \"Object\" form shall mean any form resulting from mechanical\n transformation or translation of a Source form, including but\n not limited to compiled object code, generated documentation,\n and conversions to other media types.\n\n \"Work\" shall mean the work of authorship, whether in Source or\n Object form, made available under the License, as indicated by a\n copyright notice that is included in or attached to the work\n (an example is provided in the Appendix below).\n\n \"Derivative Works\" shall mean any work, whether in Source or Object\n form, that is based on (or derived from) the Work and for which the\n editorial revisions, annotations, elaborations, or other modifications\n represent, as a whole, an original work of authorship. For the purposes\n of this License, Derivative Works shall not include works that remain\n separable from, or merely link (or bind by name) to the interfaces of,\n the Work and Derivative Works thereof.\n\n \"Contribution\" shall mean any work of authorship, including\n the original version of the Work and any modifications or additions\n to that Work or Derivative Works thereof, that is intentionally\n submitted to Licensor for inclusion in the Work by the copyright owner\n or by an individual or Legal Entity authorized to submit on behalf of\n the copyright owner. For the purposes of this definition, \"submitted\"\n means any form of electronic, verbal, or written communication sent\n to the Licensor or its representatives, including but not limited to\n communication on electronic mailing lists, source code control systems,\n and issue tracking systems that are managed by, or on behalf of, the\n Licensor for the purpose of discussing and improving the Work, but\n excluding communication that is conspicuously marked or otherwise\n designated in writing by the copyright owner as \"Not a Contribution.\"\n\n \"Contributor\" shall mean Licensor and any individual or Legal Entity\n on behalf of whom a Contribution has been received by Licensor and\n subsequently incorporated within the Work.\n\n 2. Grant of Copyright License. Subject to the terms and conditions of\n this License, each Contributor hereby grants to You a perpetual,\n worldwide, non-exclusive, no-charge, royalty-free, irrevocable\n copyright license to reproduce, prepare Derivative Works of,\n publicly display, publicly perform, sublicense, and distribute the\n Work and such Derivative Works in Source or Object form.\n\n 3. Grant of Patent License. Subject to the terms and conditions of\n this License, each Contributor hereby grants to You a perpetual,\n worldwide, non-exclusive, no-charge, royalty-free, irrevocable\n (except as stated in this section) patent license to make, have made,\n use, offer to sell, sell, import, and otherwise transfer the Work,\n where such license applies only to those patent claims licensable\n by such Contributor that are necessarily infringed by their\n Contribution(s) alone or by combination of their Contribution(s)\n with the Work to which such Contribution(s) was submitted. If You\n institute patent litigation against any entity (including a\n cross-claim or counterclaim in a lawsuit) alleging that the Work\n or a Contribution incorporated within the Work constitutes direct\n or contributory patent infringement, then any patent licenses\n granted to You under this License for that Work shall terminate\n as of the date such litigation is filed.\n\n 4. Redistribution. You may reproduce and distribute copies of the\n Work or Derivative Works thereof in any medium, with or without\n modifications, and in Source or Object form, provided that You\n meet the following conditions:\n\n (a) You must give any other recipients of the Work or\n Derivative Works a copy of this License; and\n\n (b) You must cause any modified files to carry prominent notices\n stating that You changed the files; and\n\n (c) You must retain, in the Source form of any Derivative Works\n that You distribute, all copyright, patent, trademark, and\n attribution notices from the Source form of the Work,\n excluding those notices that do not pertain to any part of\n the Derivative Works; and\n\n (d) If the Work includes a \"NOTICE\" text file as part of its\n distribution, then any Derivative Works that You distribute must\n include a readable copy of the attribution notices contained\n within such NOTICE file, excluding those notices that do not\n pertain to any part of the Derivative Works, in at least one\n of the following places: within a NOTICE text file distributed\n as part of the Derivative Works; within the Source form or\n documentation, if provided along with the Derivative Works; or,\n within a display generated by the Derivative Works, if and\n wherever such third-party notices normally appear. The contents\n of the NOTICE file are for informational purposes only and\n do not modify the License. You may add Your own attribution\n notices within Derivative Works that You distribute, alongside\n or as an addendum to the NOTICE text from the Work, provided\n that such additional attribution notices cannot be construed\n as modifying the License.\n\n You may add Your own copyright statement to Your modifications and\n may provide additional or different license terms and conditions\n for use, reproduction, or distribution of Your modifications, or\n for any such Derivative Works as a whole, provided Your use,\n reproduction, and distribution of the Work otherwise complies with\n the conditions stated in this License.\n\n 5. Submission of Contributions. Unless You explicitly state otherwise,\n any Contribution intentionally submitted for inclusion in the Work\n by You to the Licensor shall be under the terms and conditions of\n this License, without any additional terms or conditions.\n Notwithstanding the above, nothing herein shall supersede or modify\n the terms of any separate license agreement you may have executed\n with Licensor regarding such Contributions.\n\n 6. Trademarks. This License does not grant permission to use the trade\n names, trademarks, service marks, or product names of the Licensor,\n except as required for reasonable and customary use in describing the\n origin of the Work and reproducing the content of the NOTICE file.\n\n 7. Disclaimer of Warranty. Unless required by applicable law or\n agreed to in writing, Licensor provides the Work (and each\n Contributor provides its Contributions) on an \"AS IS\" BASIS,\n WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or\n implied, including, without limitation, any warranties or conditions\n of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A\n PARTICULAR PURPOSE. You are solely responsible for determining the\n appropriateness of using or redistributing the Work and assume any\n risks associated with Your exercise of permissions under this License.\n\n 8. Limitation of Liability. In no event and under no legal theory,\n whether in tort (including negligence), contract, or otherwise,\n unless required by applicable law (such as deliberate and grossly\n negligent acts) or agreed to in writing, shall any Contributor be\n liable to You for damages, including any direct, indirect, special,\n incidental, or consequential damages of any character arising as a\n result of this License or out of the use or inability to use the\n Work (including but not limited to damages for loss of goodwill,\n work stoppage, computer failure or malfunction, or any and all\n other commercial damages or losses), even if such Contributor\n has been advised of the possibility of such damages.\n\n 9. Accepting Warranty or Additional Liability. While redistributing\n the Work or Derivative Works thereof, You may choose to offer,\n and charge a fee for, acceptance of support, warranty, indemnity,\n or other liability obligations and/or rights consistent with this\n License. However, in accepting such obligations, You may act only\n on Your own behalf and on Your sole responsibility, not on behalf\n of any other Contributor, and only if You agree to indemnify,\n defend, and hold each Contributor harmless for any liability\n incurred by, or claims asserted against, such Contributor by reason\n of your accepting any such warranty or additional liability.\n\n END OF TERMS AND CONDITIONS\n\n APPENDIX: How to apply the Apache License to your work.\n\n To apply the Apache License to your work, attach the following\n boilerplate notice, with the fields enclosed by brackets \"[]\"\n replaced with your own identifying information. (Don't include\n the brackets!) The text should be enclosed in the appropriate\n comment syntax for the file format. We also recommend that a\n file or class name and description of purpose be included on the\n same \"printed page\" as the copyright notice for easier\n identification within third-party archives.\n\n Portions Copyright (c) Microsoft Corporation.\n Portions Copyright 2017 Google Inc.\n\n Licensed under the Apache License, Version 2.0 (the \"License\");\n you may not use this file except in compliance with the License.\n You may obtain a copy of the License at\n\n http://www.apache.org/licenses/LICENSE-2.0\n\n Unless required by applicable law or agreed to in writing, software\n distributed under the License is distributed on an \"AS IS\" BASIS,\n WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n See the License for the specific language governing permissions and\n limitations under the License.\n" }, { "path": "README.md", "content": "# 🎭 [Playwright](https://playwright.dev) for Python [![PyPI version](https://badge.fury.io/py/playwright.svg)](https://pypi.python.org/pypi/playwright/) [![Anaconda version](https://img.shields.io/conda/v/microsoft/playwright)](https://anaconda.org/Microsoft/playwright) [![Join Discord](https://img.shields.io/badge/join-discord-infomational)](https://aka.ms/playwright/discord)\n\nPlaywright is a Python library to automate [Chromium](https://www.chromium.org/Home), [Firefox](https://www.mozilla.org/en-US/firefox/new/) and [WebKit](https://webkit.org/) browsers with a single API. Playwright delivers automation that is **ever-green**, **capable**, **reliable** and **fast**. [See how Playwright is better](https://playwright.dev/python).\n\n| | Linux | macOS | Windows |\n| :--- | :---: | :---: | :---: |\n| Chromium 145.0.7632.6 | ✅ | ✅ | ✅ |\n| WebKit 26.0 | ✅ | ✅ | ✅ |\n| Firefox 146.0.1 | ✅ | ✅ | ✅ |\n\n## Documentation\n\n[https://playwright.dev/python/docs/intro](https://playwright.dev/python/docs/intro)\n\n## API Reference\n\n[https://playwright.dev/python/docs/api/class-playwright](https://playwright.dev/python/docs/api/class-playwright)\n\n## Example\n\n```py\nfrom playwright.sync_api import sync_playwright\n\nwith sync_playwright() as p:\n for browser_type in [p.chromium, p.firefox, p.webkit]:\n browser = browser_type.launch()\n page = browser.new_page()\n page.goto('http://playwright.dev')\n page.screenshot(path=f'example-{browser_type.name}.png')\n browser.close()\n```\n\n```py\nimport asyncio\nfrom playwright.async_api import async_playwright\n\nasync def main():\n async with async_playwright() as p:\n for browser_type in [p.chromium, p.firefox, p.webkit]:\n browser = await browser_type.launch()\n page = await browser.new_page()\n await page.goto('http://playwright.dev')\n await page.screenshot(path=f'example-{browser_type.name}.png')\n await browser.close()\n\nasyncio.run(main())\n```\n\n## Other languages\n\nMore comfortable in another programming language? [Playwright](https://playwright.dev) is also available in\n- [Node.js (JavaScript / TypeScript)](https://playwright.dev/docs/intro),\n- [.NET](https://playwright.dev/dotnet/docs/intro),\n- [Java](https://playwright.dev/java/docs/intro).\n" }, { "path": "ROLLING.md", "content": "# Rolling Playwright-Python to the latest Playwright driver\n\n* checkout repo: `git clone https://github.com/microsoft/playwright-python`\n* make sure local python is 3.9\n * create virtual environment, if don't have one: `python -m venv env`\n* activate venv: `source env/bin/activate`\n* install all deps:\n```\npython -m pip install --upgrade pip\npip install -r local-requirements.txt\npre-commit install\npip install -e .\n```\n* change driver version in `setup.py`\n* download new driver: `python -m build --wheel`\n* generate API: `./scripts/update_api.sh`\n* commit changes & send PR\n* wait for bots to pass & merge the PR\n\n\n## Fix typing issues with Playwright ToT\n\n1. `cd playwright`\n1. `API_JSON_MODE=1 node utils/doclint/generateApiJson.js > ../playwright-python/playwright/driver/package/api.json`\n1. `./scripts/update_api.sh`\n" }, { "path": "SECURITY.md", "content": "\n\n## Security\n\nMicrosoft takes the security of our software products and services seriously, which includes all source code repositories managed through our GitHub organizations, which include [Microsoft](https://github.com/Microsoft), [Azure](https://github.com/Azure), [DotNet](https://github.com/dotnet), [AspNet](https://github.com/aspnet), [Xamarin](https://github.com/xamarin), and [our GitHub organizations](https://opensource.microsoft.com/).\n\nIf you believe you have found a security vulnerability in any Microsoft-owned repository that meets [Microsoft's definition of a security vulnerability](https://docs.microsoft.com/en-us/previous-versions/tn-archive/cc751383(v=technet.10)), please report it to us as described below.\n\n## Reporting Security Issues\n\n**Please do not report security vulnerabilities through public GitHub issues.**\n\nInstead, please report them to the Microsoft Security Response Center (MSRC) at [https://msrc.microsoft.com/create-report](https://msrc.microsoft.com/create-report).\n\nIf you prefer to submit without logging in, send email to [secure@microsoft.com](mailto:secure@microsoft.com). If possible, encrypt your message with our PGP key; please download it from the [Microsoft Security Response Center PGP Key page](https://www.microsoft.com/en-us/msrc/pgp-key-msrc).\n\nYou should receive a response within 24 hours. If for some reason you do not, please follow up via email to ensure we received your original message. Additional information can be found at [microsoft.com/msrc](https://www.microsoft.com/msrc).\n\nPlease include the requested information listed below (as much as you can provide) to help us better understand the nature and scope of the possible issue:\n\n * Type of issue (e.g. buffer overflow, SQL injection, cross-site scripting, etc.)\n * Full paths of source file(s) related to the manifestation of the issue\n * The location of the affected source code (tag/branch/commit or direct URL)\n * Any special configuration required to reproduce the issue\n * Step-by-step instructions to reproduce the issue\n * Proof-of-concept or exploit code (if possible)\n * Impact of the issue, including how an attacker might exploit the issue\n\nThis information will help us triage your report more quickly.\n\nIf you are reporting for a bug bounty, more complete reports can contribute to a higher bounty award. Please visit our [Microsoft Bug Bounty Program](https://microsoft.com/msrc/bounty) page for more details about our active programs.\n\n## Preferred Languages\n\nWe prefer all communications to be in English.\n\n## Policy\n\nMicrosoft follows the principle of [Coordinated Vulnerability Disclosure](https://www.microsoft.com/en-us/msrc/cvd).\n\n\n" }, { "path": "SUPPORT.md", "content": "# Support\n\n## How to file issues and get help\n\nThis project uses GitHub issues to track bugs and feature requests. Please search the [existing issues][gh-issues] before filing new ones to avoid duplicates. For new issues, file your bug or feature request as a new issue using corresponding template.\n\nFor help and questions about using this project, please see the [docs site for Playwright for Python][docs].\n\nJoin our community [Discord Server][discord-server] to connect with other developers using Playwright and ask questions in our 'help-playwright' forum.\n\n## Microsoft Support Policy\n\nSupport for Playwright for Python is limited to the resources listed above.\n\n[gh-issues]: https://github.com/microsoft/playwright-python/issues/\n[docs]: https://playwright.dev/python/\n[discord-server]: https://aka.ms/playwright/discord\n" }, { "path": "conda_build_config_linux_aarch64.yaml", "content": "target_platform:\n- linux-aarch64\n" }, { "path": "conda_build_config_osx_arm64.yaml", "content": "target_platform:\n- osx-arm64\n" }, { "path": "examples/todomvc/mvctests/__init__.py", "content": "" }, { "path": "examples/todomvc/mvctests/test_clear_completed_button.py", "content": "# Copyright (c) Microsoft Corporation.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\nfrom typing import Generator\n\nimport pytest\n\nfrom playwright.sync_api import Page, expect\n\nfrom .utils import TODO_ITEMS, create_default_todos\n\n\n@pytest.fixture(autouse=True)\ndef run_around_tests(page: Page) -> Generator[None, None, None]:\n # setup before a test\n page.goto(\"https://demo.playwright.dev/todomvc\")\n create_default_todos(page)\n # run the actual test\n yield\n # run any cleanup code\n\n\ndef test_should_display_the_correct_text(page: Page) -> None:\n page.locator(\".todo-list li .toggle\").first.check()\n expect(page.locator(\".clear-completed\")).to_have_text(\"Clear completed\")\n\n\ndef test_should_clear_completed_items_when_clicked(page: Page) -> None:\n todo_items = page.locator(\".todo-list li\")\n todo_items.nth(1).locator(\".toggle\").check()\n page.locator(\".clear-completed\").click()\n expect(todo_items).to_have_count(2)\n expect(todo_items).to_have_text([TODO_ITEMS[0], TODO_ITEMS[2]])\n\n\ndef test_should_be_hidden_when_there_are_no_items_that_are_completed(\n page: Page,\n) -> None:\n page.locator(\".todo-list li .toggle\").first.check()\n page.locator(\".clear-completed\").click()\n expect(page.locator(\".clear-completed\")).to_be_hidden()\n" }, { "path": "examples/todomvc/mvctests/test_counter.py", "content": "# Copyright (c) Microsoft Corporation.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\nfrom typing import Generator\n\nimport pytest\n\nfrom playwright.sync_api import Page, expect\n\nfrom .utils import TODO_ITEMS, assert_number_of_todos_in_local_storage\n\n\n@pytest.fixture(autouse=True)\ndef run_around_tests(page: Page) -> Generator[None, None, None]:\n # setup before a test\n page.goto(\"https://demo.playwright.dev/todomvc\")\n # run the actual test\n yield\n # run any cleanup code\n\n\ndef test_should_display_the_current_number_of_todo_items(page: Page) -> None:\n page.locator(\".new-todo\").fill(TODO_ITEMS[0])\n page.locator(\".new-todo\").press(\"Enter\")\n expect(page.locator(\".todo-count\")).to_contain_text(\"1\")\n\n page.locator(\".new-todo\").fill(TODO_ITEMS[1])\n page.locator(\".new-todo\").press(\"Enter\")\n expect(page.locator(\".todo-count\")).to_contain_text(\"2\")\n\n assert_number_of_todos_in_local_storage(page, 2)\n" }, { "path": "examples/todomvc/mvctests/test_editing.py", "content": "# Copyright (c) Microsoft Corporation.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\nfrom typing import Generator\n\nimport pytest\n\nfrom playwright.sync_api import Page, expect\n\nfrom .utils import (\n TODO_ITEMS,\n assert_number_of_todos_in_local_storage,\n check_todos_in_local_storage,\n create_default_todos,\n)\n\n\n@pytest.fixture(autouse=True)\ndef run_around_tests(page: Page) -> Generator[None, None, None]:\n # setup before a test\n page.goto(\"https://demo.playwright.dev/todomvc\")\n create_default_todos(page)\n assert_number_of_todos_in_local_storage(page, 3)\n # run the actual test\n yield\n # run any cleanup code\n\n\ndef test_should_hide_other_controls_when_editing(page: Page) -> None:\n todo_item = page.locator(\".todo-list li\").nth(1)\n todo_item.dblclick()\n expect(todo_item.locator(\".toggle\")).not_to_be_visible()\n expect(todo_item.locator(\"label\")).not_to_be_visible()\n assert_number_of_todos_in_local_storage(page, 3)\n\n\ndef test_should_save_edits_on_blur(page: Page) -> None:\n todo_items = page.locator(\".todo-list li\")\n todo_items.nth(1).dblclick()\n todo_items.nth(1).locator(\".edit\").fill(\"buy some sausages\")\n todo_items.nth(1).locator(\".edit\").dispatch_event(\"blur\")\n\n expect(todo_items).to_have_text(\n [\n TODO_ITEMS[0],\n \"buy some sausages\",\n TODO_ITEMS[2],\n ]\n )\n check_todos_in_local_storage(page, \"buy some sausages\")\n\n\ndef test_should_trim_entered_text(page: Page) -> None:\n todo_items = page.locator(\".todo-list li\")\n todo_items.nth(1).dblclick()\n todo_items.nth(1).locator(\".edit\").fill(\" buy some sausages \")\n todo_items.nth(1).locator(\".edit\").press(\"Enter\")\n\n expect(todo_items).to_have_text(\n [\n TODO_ITEMS[0],\n \"buy some sausages\",\n TODO_ITEMS[2],\n ]\n )\n check_todos_in_local_storage(page, \"buy some sausages\")\n\n\ndef test_should_remove_the_item_if_an_empty_text_string_was_entered(page: Page) -> None:\n todo_items = page.locator(\".todo-list li\")\n todo_items.nth(1).dblclick()\n todo_items.nth(1).locator(\".edit\").fill(\"\")\n todo_items.nth(1).locator(\".edit\").press(\"Enter\")\n\n expect(todo_items).to_have_text(\n [\n TODO_ITEMS[0],\n TODO_ITEMS[2],\n ]\n )\n\n\ndef test_should_cancel_edits_on_escape(page: Page) -> None:\n todo_items = page.locator(\".todo-list li\")\n todo_items.nth(1).dblclick()\n todo_items.nth(1).locator(\".edit\").press(\"Escape\")\n expect(todo_items).to_have_text(TODO_ITEMS)\n" }, { "path": "examples/todomvc/mvctests/test_item.py", "content": "# Copyright (c) Microsoft Corporation.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\nfrom typing import Generator\n\nimport pytest\n\nfrom playwright.sync_api import Page, expect\n\nfrom .utils import (\n TODO_ITEMS,\n check_number_of_completed_todos_in_local_storage,\n check_todos_in_local_storage,\n create_default_todos,\n)\n\n\n@pytest.fixture(autouse=True)\ndef run_around_tests(page: Page) -> Generator[None, None, None]:\n # setup before a test\n page.goto(\"https://demo.playwright.dev/todomvc\")\n # run the actual test\n yield\n # run any cleanup code\n\n\ndef test_should_allow_me_to_mark_items_as_completed(page: Page) -> None:\n # Create two items.\n for item in TODO_ITEMS[:2]:\n page.locator(\".new-todo\").fill(item)\n page.locator(\".new-todo\").press(\"Enter\")\n\n # Check first item.\n firstTodo = page.locator(\".todo-list li\").nth(0)\n firstTodo.locator(\".toggle\").check()\n expect(firstTodo).to_have_class(\"completed\")\n\n # Check second item.\n secondTodo = page.locator(\".todo-list li\").nth(1)\n expect(secondTodo).not_to_have_class(\"completed\")\n secondTodo.locator(\".toggle\").check()\n\n # Assert completed class.\n expect(firstTodo).to_have_class(\"completed\")\n expect(secondTodo).to_have_class(\"completed\")\n\n\ndef test_should_allow_me_to_un_mark_items_as_completed(page: Page) -> None:\n # Create two items.\n for item in TODO_ITEMS[:2]:\n page.locator(\".new-todo\").fill(item)\n page.locator(\".new-todo\").press(\"Enter\")\n\n firstTodo = page.locator(\".todo-list li\").nth(0)\n secondTodo = page.locator(\".todo-list li\").nth(1)\n firstTodo.locator(\".toggle\").check()\n expect(firstTodo).to_have_class(\"completed\")\n expect(secondTodo).not_to_have_class(\"completed\")\n check_number_of_completed_todos_in_local_storage(page, 1)\n\n firstTodo.locator(\".toggle\").uncheck()\n expect(firstTodo).not_to_have_class(\"completed\")\n expect(secondTodo).not_to_have_class(\"completed\")\n check_number_of_completed_todos_in_local_storage(page, 0)\n\n\ndef test_should_allow_me_to_edit_an_item(page: Page) -> None:\n create_default_todos(page)\n\n todo_items = page.locator(\".todo-list li\")\n secondTodo = todo_items.nth(1)\n secondTodo.dblclick()\n expect(secondTodo.locator(\".edit\")).to_have_value(TODO_ITEMS[1])\n secondTodo.locator(\".edit\").fill(\"buy some sausages\")\n secondTodo.locator(\".edit\").press(\"Enter\")\n\n # Explicitly assert the new text value.\n expect(todo_items).to_have_text([TODO_ITEMS[0], \"buy some sausages\", TODO_ITEMS[2]])\n check_todos_in_local_storage(page, \"buy some sausages\")\n" }, { "path": "examples/todomvc/mvctests/test_mark_all_as_completed.py", "content": "# Copyright (c) Microsoft Corporation.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\nfrom typing import Generator\n\nimport pytest\n\nfrom playwright.sync_api import Page, expect\n\nfrom .utils import (\n assert_number_of_todos_in_local_storage,\n check_number_of_completed_todos_in_local_storage,\n create_default_todos,\n)\n\n\n@pytest.fixture(autouse=True)\ndef run_around_tests(page: Page) -> Generator[None, None, None]:\n # setup before a test\n page.goto(\"https://demo.playwright.dev/todomvc\")\n # run the actual test\n yield\n # run any cleanup code\n\n\ndef test_should_allow_me_to_mark_all_items_as_completed(page: Page) -> None:\n create_default_todos(page)\n assert_number_of_todos_in_local_storage(page, 3)\n # Complete all todos.\n page.locator(\".toggle-all\").check()\n\n # Ensure all todos have 'completed' class.\n expect(page.locator(\".todo-list li\")).to_have_class(\n [\"completed\", \"completed\", \"completed\"]\n )\n check_number_of_completed_todos_in_local_storage(page, 3)\n assert_number_of_todos_in_local_storage(page, 3)\n\n\ndef test_should_allow_me_to_clear_the_complete_state_of_all_items(page: Page) -> None:\n create_default_todos(page)\n assert_number_of_todos_in_local_storage(page, 3)\n # Check and then immediately uncheck.\n page.locator(\".toggle-all\").check()\n page.locator(\".toggle-all\").uncheck()\n\n # Should be no completed classes.\n expect(page.locator(\".todo-list li\")).to_have_class([\"\", \"\", \"\"])\n assert_number_of_todos_in_local_storage(page, 3)\n\n\ndef test_complete_all_checkbox_should_update_state_when_items_are_completed_or_cleared(\n page: Page,\n) -> None:\n create_default_todos(page)\n assert_number_of_todos_in_local_storage(page, 3)\n toggleAll = page.locator(\".toggle-all\")\n toggleAll.check()\n expect(toggleAll).to_be_checked()\n check_number_of_completed_todos_in_local_storage(page, 3)\n\n # Uncheck first todo.\n firstTodo = page.locator(\".todo-list li\").nth(0)\n firstTodo.locator(\".toggle\").uncheck()\n\n # Reuse toggleAll locator and make sure its not checked.\n expect(toggleAll).not_to_be_checked()\n\n firstTodo.locator(\".toggle\").check()\n check_number_of_completed_todos_in_local_storage(page, 3)\n\n # Assert the toggle all is checked again.\n expect(toggleAll).to_be_checked()\n assert_number_of_todos_in_local_storage(page, 3)\n" }, { "path": "examples/todomvc/mvctests/test_new_todo.py", "content": "# Copyright (c) Microsoft Corporation.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\nimport re\nfrom typing import Generator\n\nimport pytest\n\nfrom playwright.sync_api import Page, expect\n\nfrom .utils import (\n TODO_ITEMS,\n assert_number_of_todos_in_local_storage,\n create_default_todos,\n)\n\n\n@pytest.fixture(autouse=True)\ndef run_around_tests(page: Page) -> Generator[None, None, None]:\n # setup before a test\n page.goto(\"https://demo.playwright.dev/todomvc\")\n # run the actual test\n yield\n # run any cleanup code\n\n\ndef test_new_todo_test_should_allow_me_to_add_todo_items(page: Page) -> None:\n # Create 1st todo.\n page.locator(\".new-todo\").fill(TODO_ITEMS[0])\n page.locator(\".new-todo\").press(\"Enter\")\n\n # Make sure the list only has one todo item.\n expect(page.locator(\".view label\")).to_have_text([TODO_ITEMS[0]])\n\n # Create 2nd todo.\n page.locator(\".new-todo\").fill(TODO_ITEMS[1])\n page.locator(\".new-todo\").press(\"Enter\")\n\n # Make sure the list now has two todo items.\n expect(page.locator(\".view label\")).to_have_text([TODO_ITEMS[0], TODO_ITEMS[1]])\n\n assert_number_of_todos_in_local_storage(page, 2)\n\n\ndef test_new_todo_test_should_clear_text_input_field_when_an_item_is_added(\n page: Page,\n) -> None:\n # Create one todo item.\n page.locator(\".new-todo\").fill(TODO_ITEMS[0])\n page.locator(\".new-todo\").press(\"Enter\")\n\n # Check that input is empty.\n expect(page.locator(\".new-todo\")).to_be_empty()\n assert_number_of_todos_in_local_storage(page, 1)\n\n\ndef test_new_todo_test_should_append_new_items_to_the_bottom_of_the_list(\n page: Page,\n) -> None:\n # Create 3 items.\n create_default_todos(page)\n\n # Check test using different methods.\n expect(page.locator(\".todo-count\")).to_have_text(\"3 items left\")\n expect(page.locator(\".todo-count\")).to_contain_text(\"3\")\n expect(page.locator(\".todo-count\")).to_have_text(re.compile(\"3\"))\n\n # Check all items in one call.\n expect(page.locator(\".view label\")).to_have_text(TODO_ITEMS)\n assert_number_of_todos_in_local_storage(page, 3)\n\n\ndef test_new_todo_should_show_main_and_foter_when_items_added(page: Page) -> None:\n page.locator(\".new-todo\").fill(TODO_ITEMS[0])\n page.locator(\".new-todo\").press(\"Enter\")\n\n expect(page.locator(\".main\")).to_be_visible()\n expect(page.locator(\".footer\")).to_be_visible()\n assert_number_of_todos_in_local_storage(page, 1)\n" }, { "path": "examples/todomvc/mvctests/test_persistence.py", "content": "# Copyright (c) Microsoft Corporation.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\nfrom typing import Generator\n\nimport pytest\n\nfrom playwright.sync_api import Page, expect\n\nfrom .utils import TODO_ITEMS, check_number_of_completed_todos_in_local_storage\n\n\n@pytest.fixture(autouse=True)\ndef run_around_tests(page: Page) -> Generator[None, None, None]:\n # setup before a test\n page.goto(\"https://demo.playwright.dev/todomvc\")\n # run the actual test\n yield\n # run any cleanup code\n\n\ndef test_should_persist_its_data(page: Page) -> None:\n for item in TODO_ITEMS[:2]:\n page.locator(\".new-todo\").fill(item)\n page.locator(\".new-todo\").press(\"Enter\")\n\n todo_items = page.locator(\".todo-list li\")\n todo_items.nth(0).locator(\".toggle\").check()\n expect(todo_items).to_have_text([TODO_ITEMS[0], TODO_ITEMS[1]])\n expect(todo_items).to_have_class([\"completed\", \"\"])\n\n # Ensure there is 1 completed item.\n check_number_of_completed_todos_in_local_storage(page, 1)\n\n # Now reload.\n page.reload()\n expect(todo_items).to_have_text([TODO_ITEMS[0], TODO_ITEMS[1]])\n expect(todo_items).to_have_class([\"completed\", \"\"])\n" }, { "path": "examples/todomvc/mvctests/test_routing.py", "content": "# Copyright (c) Microsoft Corporation.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\nfrom typing import Generator\n\nimport pytest\n\nfrom playwright.sync_api import Page, expect\n\nfrom .utils import (\n TODO_ITEMS,\n check_number_of_completed_todos_in_local_storage,\n check_todos_in_local_storage,\n create_default_todos,\n)\n\n\n@pytest.fixture(autouse=True)\ndef run_around_tests(page: Page) -> Generator[None, None, None]:\n # setup before a test\n page.goto(\"https://demo.playwright.dev/todomvc\")\n create_default_todos(page)\n # make sure the app had a chance to save updated todos in storage\n # before navigating to a new view, otherwise the items can get lost :(\n # in some frameworks like Durandal\n check_todos_in_local_storage(page, TODO_ITEMS[0])\n # run the actual test\n yield\n # run any cleanup code\n\n\ndef test_should_allow_me_to_display_active_item(page: Page) -> None:\n page.locator(\".todo-list li .toggle\").nth(1).check()\n check_number_of_completed_todos_in_local_storage(page, 1)\n page.locator(\".filters >> text=Active\").click()\n expect(page.locator(\".todo-list li\")).to_have_count(2)\n expect(page.locator(\".todo-list li\")).to_have_text([TODO_ITEMS[0], TODO_ITEMS[2]])\n\n\ndef test_should_respect_the_back_button(page: Page) -> None:\n page.locator(\".todo-list li .toggle\").nth(1).check()\n check_number_of_completed_todos_in_local_storage(page, 1)\n\n # Showing all items\n page.locator(\".filters >> text=All\").click()\n expect(page.locator(\".todo-list li\")).to_have_count(3)\n\n # Showing active items\n page.locator(\".filters >> text=Active\").click()\n\n # Showing completed items\n page.locator(\".filters >> text=Completed\").click()\n\n expect(page.locator(\".todo-list li\")).to_have_count(1)\n page.go_back()\n expect(page.locator(\".todo-list li\")).to_have_count(2)\n page.go_back()\n expect(page.locator(\".todo-list li\")).to_have_count(3)\n\n\ndef test_should_allow_me_to_display_completed_items(page: Page) -> None:\n page.locator(\".todo-list li .toggle\").nth(1).check()\n check_number_of_completed_todos_in_local_storage(page, 1)\n page.locator(\".filters >> text=Completed\").click()\n expect(page.locator(\".todo-list li\")).to_have_count(1)\n\n\ndef test_should_allow_me_to_display_all_items(page: Page) -> None:\n page.locator(\".todo-list li .toggle\").nth(1).check()\n check_number_of_completed_todos_in_local_storage(page, 1)\n page.locator(\".filters >> text=Active\").click()\n page.locator(\".filters >> text=Completed\").click()\n page.locator(\".filters >> text=All\").click()\n expect(page.locator(\".todo-list li\")).to_have_count(3)\n\n\ndef test_should_highlight_the_current_applied_filter(page: Page) -> None:\n expect(page.locator(\".filters >> text=All\")).to_have_class(\"selected\")\n page.locator(\".filters >> text=Active\").click()\n # Page change - active items.\n expect(page.locator(\".filters >> text=Active\")).to_have_class(\"selected\")\n page.locator(\".filters >> text=Completed\").click()\n # Page change - completed items.\n expect(page.locator(\".filters >> text=Completed\")).to_have_class(\"selected\")\n" }, { "path": "examples/todomvc/mvctests/utils.py", "content": "# Copyright (c) Microsoft Corporation.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\nfrom playwright.sync_api import Page\n\nTODO_ITEMS = [\"buy some cheese\", \"feed the cat\", \"book a doctors appointment\"]\n\n\ndef create_default_todos(page: Page) -> None:\n for item in TODO_ITEMS:\n page.locator(\".new-todo\").fill(item)\n page.locator(\".new-todo\").press(\"Enter\")\n\n\ndef check_number_of_completed_todos_in_local_storage(page: Page, expected: int) -> None:\n assert (\n page.evaluate(\n \"JSON.parse(localStorage['react-todos']).filter(i => i.completed).length\"\n )\n == expected\n )\n\n\ndef assert_number_of_todos_in_local_storage(page: Page, expected: int) -> None:\n assert len(page.evaluate(\"JSON.parse(localStorage['react-todos'])\")) == expected\n\n\ndef check_todos_in_local_storage(page: Page, title: str) -> None:\n assert title in page.evaluate(\n \"JSON.parse(localStorage['react-todos']).map(i => i.title)\"\n )\n" }, { "path": "examples/todomvc/requirements.txt", "content": "pytest-playwright\n" }, { "path": "local-requirements.txt", "content": "autobahn==23.1.2\nblack==25.1.0\nbuild==1.3.0\nflake8==7.2.0\nmypy==1.17.1\nobjgraph==3.6.2\nPillow==11.3.0\npixelmatch==0.3.0\npre-commit==3.5.0\npyOpenSSL==25.1.0\npytest==8.4.1\npytest-asyncio==1.1.0\npytest-cov==6.3.0\npytest-repeat==0.9.4\npytest-rerunfailures==15.1\npytest-timeout==2.4.0\npytest-xdist==3.8.0\nrequests==2.32.5\nservice_identity==24.2.0\ntwisted==25.5.0\ntypes-pyOpenSSL==24.1.0.20240722\ntypes-requests==2.32.4.20250809\n" }, { "path": "meta.yaml", "content": "package:\n name: playwright\n version: \"{{ environ.get('GIT_DESCRIBE_TAG') | replace('v', '') }}\"\n\nsource:\n path: .\n\nbuild:\n number: 0\n script: \"{{ PYTHON }} -m pip install . --no-deps -vv\"\n binary_relocation: False\n missing_dso_whitelist: \"*\"\n entry_points:\n - playwright = playwright.__main__:main\n\nrequirements:\n build:\n - python >=3.9 # [build_platform != target_platform]\n - pip # [build_platform != target_platform]\n - cross-python_{{ target_platform }} # [build_platform != target_platform]\n host:\n - python >=3.9\n - wheel\n - pip\n - curl\n - setuptools_scm\n run:\n - python >=3.9\n # This should be the same as the dependencies in pyproject.toml\n - greenlet>=3.1.1,<4.0.0\n - pyee>=13,<14\n\ntest: # [build_platform == target_platform]\n files:\n - scripts/example_sync.py\n - scripts/example_async.py\n requires:\n - pip\n imports:\n - playwright\n - playwright.sync_api\n - playwright.async_api\n commands:\n - playwright --help\n - playwright install --with-deps\n - python scripts/example_sync.py\n - python scripts/example_async.py\n\nabout:\n home: https://github.com/microsoft/playwright-python\n license: Apache-2.0\n license_family: Apache\n license_file: LICENSE\n summary: Python version of the Playwright testing and automation library.\n description: |\n Playwright is a Python library to automate Chromium,\n Firefox and WebKit browsers with a single API. Playwright\n delivers automation that is ever-green, capable, reliable\n and fast.\n doc_url: https://playwright.dev/python/docs/intro/\n dev_url: https://github.com/microsoft/playwright-python\n" }, { "path": "playwright/__init__.py", "content": "# Copyright (c) Microsoft Corporation.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n\n\"\"\"\nPython package `playwright` is a Python library to automate Chromium,\nFirefox and WebKit with a single API. Playwright is built to enable cross-browser\nweb automation that is ever-green, capable, reliable and fast.\n\"\"\"\n" }, { "path": "playwright/__main__.py", "content": "# Copyright (c) Microsoft Corporation.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n\nimport subprocess\nimport sys\n\nfrom playwright._impl._driver import compute_driver_executable, get_driver_env\n\n\ndef main() -> None:\n try:\n driver_executable, driver_cli = compute_driver_executable()\n completed_process = subprocess.run(\n [driver_executable, driver_cli, *sys.argv[1:]], env=get_driver_env()\n )\n sys.exit(completed_process.returncode)\n except KeyboardInterrupt:\n sys.exit(130)\n\n\nif __name__ == \"__main__\":\n main()\n" }, { "path": "playwright/_impl/__init__.py", "content": "" }, { "path": "playwright/_impl/__pyinstaller/__init__.py", "content": "# Copyright (c) Microsoft Corporation.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n\nimport os\nfrom typing import List\n\n\ndef get_hook_dirs() -> List[str]:\n return [os.path.dirname(__file__)]\n" }, { "path": "playwright/_impl/__pyinstaller/hook-playwright.async_api.py", "content": "# Copyright (c) Microsoft Corporation.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n\nfrom PyInstaller.utils.hooks import collect_data_files # type: ignore\n\ndatas = collect_data_files(\"playwright\")\n" }, { "path": "playwright/_impl/__pyinstaller/hook-playwright.sync_api.py", "content": "# Copyright (c) Microsoft Corporation.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n\nfrom PyInstaller.utils.hooks import collect_data_files # type: ignore\n\ndatas = collect_data_files(\"playwright\")\n" }, { "path": "playwright/_impl/_api_structures.py", "content": "# Copyright (c) Microsoft Corporation.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n\nfrom pathlib import Path\nfrom typing import Any, Dict, List, Literal, Optional, Sequence, TypedDict, Union\n\n# These are the structures that we like keeping in a JSON form for their potential\n# reuse between SDKs / services. They are public and are a part of the\n# stable API.\n\n# Explicitly mark optional params as such for the documentation\n# If there is at least one optional param, set total=False for better mypy handling.\n\n\nclass Cookie(TypedDict, total=False):\n name: str\n value: str\n domain: str\n path: str\n expires: float\n httpOnly: bool\n secure: bool\n sameSite: Literal[\"Lax\", \"None\", \"Strict\"]\n partitionKey: Optional[str]\n\n\nclass StorageStateCookie(TypedDict, total=False):\n name: str\n value: str\n domain: str\n path: str\n expires: float\n httpOnly: bool\n secure: bool\n sameSite: Literal[\"Lax\", \"None\", \"Strict\"]\n\n\n# TODO: We are waiting for PEP705 so SetCookieParam can be readonly and matches Cookie.\nclass SetCookieParam(TypedDict, total=False):\n name: str\n value: str\n url: Optional[str]\n domain: Optional[str]\n path: Optional[str]\n expires: Optional[float]\n httpOnly: Optional[bool]\n secure: Optional[bool]\n sameSite: Optional[Literal[\"Lax\", \"None\", \"Strict\"]]\n partitionKey: Optional[str]\n\n\nclass FloatRect(TypedDict):\n x: float\n y: float\n width: float\n height: float\n\n\nclass Geolocation(TypedDict, total=False):\n latitude: float\n longitude: float\n accuracy: Optional[float]\n\n\nclass HttpCredentials(TypedDict, total=False):\n username: str\n password: str\n origin: Optional[str]\n send: Optional[Literal[\"always\", \"unauthorized\"]]\n\n\nclass LocalStorageEntry(TypedDict):\n name: str\n value: str\n\n\nclass OriginState(TypedDict):\n origin: str\n localStorage: List[LocalStorageEntry]\n\n\nclass PdfMargins(TypedDict, total=False):\n top: Optional[Union[str, float]]\n right: Optional[Union[str, float]]\n bottom: Optional[Union[str, float]]\n left: Optional[Union[str, float]]\n\n\nclass Position(TypedDict):\n x: float\n y: float\n\n\nclass ProxySettings(TypedDict, total=False):\n server: str\n bypass: Optional[str]\n username: Optional[str]\n password: Optional[str]\n\n\nclass StorageState(TypedDict, total=False):\n cookies: List[StorageStateCookie]\n origins: List[OriginState]\n\n\nclass ClientCertificate(TypedDict, total=False):\n origin: str\n certPath: Optional[Union[str, Path]]\n cert: Optional[bytes]\n keyPath: Optional[Union[str, Path]]\n key: Optional[bytes]\n pfxPath: Optional[Union[str, Path]]\n pfx: Optional[bytes]\n passphrase: Optional[str]\n\n\nclass ResourceTiming(TypedDict):\n startTime: float\n domainLookupStart: float\n domainLookupEnd: float\n connectStart: float\n secureConnectionStart: float\n connectEnd: float\n requestStart: float\n responseStart: float\n responseEnd: float\n\n\nclass RequestSizes(TypedDict):\n requestBodySize: int\n requestHeadersSize: int\n responseBodySize: int\n responseHeadersSize: int\n\n\nclass ViewportSize(TypedDict):\n width: int\n height: int\n\n\nclass SourceLocation(TypedDict):\n url: str\n lineNumber: int\n columnNumber: int\n\n\nclass FilePayload(TypedDict):\n name: str\n mimeType: str\n buffer: bytes\n\n\nclass RemoteAddr(TypedDict):\n ipAddress: str\n port: int\n\n\nclass SecurityDetails(TypedDict):\n issuer: Optional[str]\n protocol: Optional[str]\n subjectName: Optional[str]\n validFrom: Optional[float]\n validTo: Optional[float]\n\n\nclass NameValue(TypedDict):\n name: str\n value: str\n\n\nHeadersArray = List[NameValue]\nHeaders = Dict[str, str]\n\n\nclass ServerFilePayload(TypedDict):\n name: str\n mimeType: str\n buffer: str\n\n\nclass FormField(TypedDict, total=False):\n name: str\n value: Optional[str]\n file: Optional[ServerFilePayload]\n\n\nclass ExpectedTextValue(TypedDict, total=False):\n string: str\n regexSource: str\n regexFlags: str\n matchSubstring: bool\n normalizeWhiteSpace: bool\n ignoreCase: Optional[bool]\n\n\nclass FrameExpectOptions(TypedDict, total=False):\n expressionArg: Any\n expectedText: Optional[Sequence[ExpectedTextValue]]\n expectedNumber: Optional[float]\n expectedValue: Optional[Any]\n useInnerText: Optional[bool]\n isNot: bool\n timeout: Optional[float]\n\n\nclass FrameExpectResult(TypedDict):\n matches: bool\n received: Any\n log: List[str]\n errorMessage: Optional[str]\n\n\nAriaRole = Literal[\n \"alert\",\n \"alertdialog\",\n \"application\",\n \"article\",\n \"banner\",\n \"blockquote\",\n \"button\",\n \"caption\",\n \"cell\",\n \"checkbox\",\n \"code\",\n \"columnheader\",\n \"combobox\",\n \"complementary\",\n \"contentinfo\",\n \"definition\",\n \"deletion\",\n \"dialog\",\n \"directory\",\n \"document\",\n \"emphasis\",\n \"feed\",\n \"figure\",\n \"form\",\n \"generic\",\n \"grid\",\n \"gridcell\",\n \"group\",\n \"heading\",\n \"img\",\n \"insertion\",\n \"link\",\n \"list\",\n \"listbox\",\n \"listitem\",\n \"log\",\n \"main\",\n \"marquee\",\n \"math\",\n \"menu\",\n \"menubar\",\n \"menuitem\",\n \"menuitemcheckbox\",\n \"menuitemradio\",\n \"meter\",\n \"navigation\",\n \"none\",\n \"note\",\n \"option\",\n \"paragraph\",\n \"presentation\",\n \"progressbar\",\n \"radio\",\n \"radiogroup\",\n \"region\",\n \"row\",\n \"rowgroup\",\n \"rowheader\",\n \"scrollbar\",\n \"search\",\n \"searchbox\",\n \"separator\",\n \"slider\",\n \"spinbutton\",\n \"status\",\n \"strong\",\n \"subscript\",\n \"superscript\",\n \"switch\",\n \"tab\",\n \"table\",\n \"tablist\",\n \"tabpanel\",\n \"term\",\n \"textbox\",\n \"time\",\n \"timer\",\n \"toolbar\",\n \"tooltip\",\n \"tree\",\n \"treegrid\",\n \"treeitem\",\n]\n\n\nclass TracingGroupLocation(TypedDict):\n file: str\n line: Optional[int]\n column: Optional[int]\n" }, { "path": "playwright/_impl/_artifact.py", "content": "# Copyright (c) Microsoft Corporation.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n\nimport pathlib\nfrom pathlib import Path\nfrom typing import Dict, Optional, Union, cast\n\nfrom playwright._impl._connection import ChannelOwner, from_channel\nfrom playwright._impl._helper import Error, make_dirs_for_file, patch_error_message\nfrom playwright._impl._stream import Stream\n\n\nclass Artifact(ChannelOwner):\n def __init__(\n self, parent: ChannelOwner, type: str, guid: str, initializer: Dict\n ) -> None:\n super().__init__(parent, type, guid, initializer)\n self.absolute_path = initializer[\"absolutePath\"]\n\n async def path_after_finished(self) -> pathlib.Path:\n if self._connection.is_remote:\n raise Error(\n \"Path is not available when using browser_type.connect(). Use save_as() to save a local copy.\"\n )\n path = await self._channel.send(\n \"pathAfterFinished\",\n None,\n )\n return pathlib.Path(path)\n\n async def save_as(self, path: Union[str, Path]) -> None:\n stream = cast(\n Stream,\n from_channel(\n await self._channel.send(\n \"saveAsStream\",\n None,\n )\n ),\n )\n make_dirs_for_file(path)\n await stream.save_as(path)\n\n async def failure(self) -> Optional[str]:\n reason = await self._channel.send(\n \"failure\",\n None,\n )\n if reason is None:\n return None\n return patch_error_message(reason)\n\n async def delete(self) -> None:\n await self._channel.send(\n \"delete\",\n None,\n )\n\n async def read_info_buffer(self) -> bytes:\n stream = cast(\n Stream,\n from_channel(\n await self._channel.send(\n \"stream\",\n None,\n )\n ),\n )\n buffer = await stream.read_all()\n return buffer\n\n async def cancel(self) -> None: # pyright: ignore[reportIncompatibleMethodOverride]\n await self._channel.send(\n \"cancel\",\n None,\n )\n" }, { "path": "playwright/_impl/_assertions.py", "content": "# Copyright (c) Microsoft Corporation.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n\nimport collections.abc\nfrom typing import Any, List, Optional, Pattern, Sequence, Union\nfrom urllib.parse import urljoin\n\nfrom playwright._impl._api_structures import (\n AriaRole,\n ExpectedTextValue,\n FrameExpectOptions,\n FrameExpectResult,\n)\nfrom playwright._impl._connection import format_call_log\nfrom playwright._impl._errors import Error\nfrom playwright._impl._fetch import APIResponse\nfrom playwright._impl._helper import is_textual_mime_type\nfrom playwright._impl._locator import Locator\nfrom playwright._impl._page import Page\nfrom playwright._impl._str_utils import escape_regex_flags\n\n\nclass AssertionsBase:\n def __init__(\n self,\n locator: Locator,\n timeout: float = None,\n is_not: bool = False,\n message: Optional[str] = None,\n ) -> None:\n self._actual_locator = locator\n self._loop = locator._loop\n self._dispatcher_fiber = locator._dispatcher_fiber\n self._timeout = timeout\n self._is_not = is_not\n self._custom_message = message\n\n async def _call_expect(\n self, expression: str, expect_options: FrameExpectOptions, title: Optional[str]\n ) -> FrameExpectResult:\n raise NotImplementedError(\n \"_call_expect must be implemented in a derived class.\"\n )\n\n async def _expect_impl(\n self,\n expression: str,\n expect_options: FrameExpectOptions,\n expected: Any,\n message: str,\n title: str = None,\n ) -> None:\n __tracebackhide__ = True\n expect_options[\"isNot\"] = self._is_not\n if expect_options.get(\"timeout\") is None:\n expect_options[\"timeout\"] = self._timeout or 5_000\n if expect_options[\"isNot\"]:\n message = message.replace(\"expected to\", \"expected not to\")\n if \"useInnerText\" in expect_options and expect_options[\"useInnerText\"] is None:\n del expect_options[\"useInnerText\"]\n result = await self._call_expect(expression, expect_options, title)\n if result[\"matches\"] == self._is_not:\n actual = result.get(\"received\")\n if self._custom_message:\n out_message = self._custom_message\n if expected is not None:\n out_message += f\"\\nExpected value: '{expected or ''}'\"\n else:\n out_message = (\n f\"{message} '{expected}'\" if expected is not None else f\"{message}\"\n )\n error_message = result.get(\"errorMessage\")\n error_message = f\"\\n{error_message}\" if error_message else \"\"\n raise AssertionError(\n f\"{out_message}\\nActual value: {actual}{error_message} {format_call_log(result.get('log'))}\"\n )\n\n\nclass PageAssertions(AssertionsBase):\n def __init__(\n self,\n page: Page,\n timeout: float = None,\n is_not: bool = False,\n message: Optional[str] = None,\n ) -> None:\n super().__init__(page.locator(\":root\"), timeout, is_not, message)\n self._actual_page = page\n\n async def _call_expect(\n self, expression: str, expect_options: FrameExpectOptions, title: Optional[str]\n ) -> FrameExpectResult:\n __tracebackhide__ = True\n return await self._actual_page.main_frame._expect(\n None, expression, expect_options, title\n )\n\n @property\n def _not(self) -> \"PageAssertions\":\n return PageAssertions(\n self._actual_page, self._timeout, not self._is_not, self._custom_message\n )\n\n async def to_have_title(\n self, titleOrRegExp: Union[Pattern[str], str], timeout: float = None\n ) -> None:\n __tracebackhide__ = True\n expected_values = to_expected_text_values(\n [titleOrRegExp], normalize_white_space=True\n )\n await self._expect_impl(\n \"to.have.title\",\n FrameExpectOptions(expectedText=expected_values, timeout=timeout),\n titleOrRegExp,\n \"Page title expected to be\",\n 'Expect \"to_have_title\"',\n )\n\n async def not_to_have_title(\n self, titleOrRegExp: Union[Pattern[str], str], timeout: float = None\n ) -> None:\n __tracebackhide__ = True\n await self._not.to_have_title(titleOrRegExp, timeout)\n\n async def to_have_url(\n self,\n urlOrRegExp: Union[str, Pattern[str]],\n timeout: float = None,\n ignoreCase: bool = None,\n ) -> None:\n __tracebackhide__ = True\n base_url = self._actual_page.context._base_url\n if isinstance(urlOrRegExp, str) and base_url:\n urlOrRegExp = urljoin(base_url, urlOrRegExp)\n expected_text = to_expected_text_values([urlOrRegExp], ignoreCase=ignoreCase)\n await self._expect_impl(\n \"to.have.url\",\n FrameExpectOptions(expectedText=expected_text, timeout=timeout),\n urlOrRegExp,\n \"Page URL expected to be\",\n 'Expect \"to_have_url\"',\n )\n\n async def not_to_have_url(\n self,\n urlOrRegExp: Union[Pattern[str], str],\n timeout: float = None,\n ignoreCase: bool = None,\n ) -> None:\n __tracebackhide__ = True\n await self._not.to_have_url(urlOrRegExp, timeout, ignoreCase)\n\n\nclass LocatorAssertions(AssertionsBase):\n def __init__(\n self,\n locator: Locator,\n timeout: float = None,\n is_not: bool = False,\n message: Optional[str] = None,\n ) -> None:\n super().__init__(locator, timeout, is_not, message)\n self._actual_locator = locator\n\n async def _call_expect(\n self, expression: str, expect_options: FrameExpectOptions, title: Optional[str]\n ) -> FrameExpectResult:\n __tracebackhide__ = True\n return await self._actual_locator._expect(expression, expect_options, title)\n\n @property\n def _not(self) -> \"LocatorAssertions\":\n return LocatorAssertions(\n self._actual_locator, self._timeout, not self._is_not, self._custom_message\n )\n\n async def to_contain_text(\n self,\n expected: Union[\n Sequence[str],\n Sequence[Pattern[str]],\n Sequence[Union[Pattern[str], str]],\n Pattern[str],\n str,\n ],\n useInnerText: bool = None,\n timeout: float = None,\n ignoreCase: bool = None,\n ) -> None:\n __tracebackhide__ = True\n if isinstance(expected, collections.abc.Sequence) and not isinstance(\n expected, str\n ):\n expected_text = to_expected_text_values(\n expected,\n match_substring=True,\n normalize_white_space=True,\n ignoreCase=ignoreCase,\n )\n await self._expect_impl(\n \"to.contain.text.array\",\n FrameExpectOptions(\n expectedText=expected_text,\n useInnerText=useInnerText,\n timeout=timeout,\n ),\n expected,\n \"Locator expected to contain text\",\n 'Expect \"to_contain_text\"',\n )\n else:\n expected_text = to_expected_text_values(\n [expected],\n match_substring=True,\n normalize_white_space=True,\n ignoreCase=ignoreCase,\n )\n await self._expect_impl(\n \"to.have.text\",\n FrameExpectOptions(\n expectedText=expected_text,\n useInnerText=useInnerText,\n timeout=timeout,\n ),\n expected,\n \"Locator expected to contain text\",\n 'Expect \"to_contain_text\"',\n )\n\n async def not_to_contain_text(\n self,\n expected: Union[\n Sequence[str],\n Sequence[Pattern[str]],\n Sequence[Union[Pattern[str], str]],\n Pattern[str],\n str,\n ],\n useInnerText: bool = None,\n timeout: float = None,\n ignoreCase: bool = None,\n ) -> None:\n __tracebackhide__ = True\n await self._not.to_contain_text(expected, useInnerText, timeout, ignoreCase)\n\n async def to_have_attribute(\n self,\n name: str,\n value: Union[str, Pattern[str]],\n ignoreCase: bool = None,\n timeout: float = None,\n ) -> None:\n __tracebackhide__ = True\n expected_text = to_expected_text_values([value], ignoreCase=ignoreCase)\n await self._expect_impl(\n \"to.have.attribute.value\",\n FrameExpectOptions(\n expressionArg=name, expectedText=expected_text, timeout=timeout\n ),\n value,\n \"Locator expected to have attribute\",\n 'Expect \"to_have_attribute\"',\n )\n\n async def not_to_have_attribute(\n self,\n name: str,\n value: Union[str, Pattern[str]],\n ignoreCase: bool = None,\n timeout: float = None,\n ) -> None:\n __tracebackhide__ = True\n await self._not.to_have_attribute(\n name, value, ignoreCase=ignoreCase, timeout=timeout\n )\n\n async def to_have_class(\n self,\n expected: Union[\n Sequence[str],\n Sequence[Pattern[str]],\n Sequence[Union[Pattern[str], str]],\n Pattern[str],\n str,\n ],\n timeout: float = None,\n ) -> None:\n __tracebackhide__ = True\n if isinstance(expected, collections.abc.Sequence) and not isinstance(\n expected, str\n ):\n expected_text = to_expected_text_values(expected)\n await self._expect_impl(\n \"to.have.class.array\",\n FrameExpectOptions(expectedText=expected_text, timeout=timeout),\n expected,\n \"Locator expected to have class\",\n 'Expect \"to_have_class\"',\n )\n else:\n expected_text = to_expected_text_values([expected])\n await self._expect_impl(\n \"to.have.class\",\n FrameExpectOptions(expectedText=expected_text, timeout=timeout),\n expected,\n \"Locator expected to have class\",\n 'Expect \"to_have_class\"',\n )\n\n async def not_to_have_class(\n self,\n expected: Union[\n Sequence[str],\n Sequence[Pattern[str]],\n Sequence[Union[Pattern[str], str]],\n Pattern[str],\n str,\n ],\n timeout: float = None,\n ) -> None:\n __tracebackhide__ = True\n await self._not.to_have_class(expected, timeout)\n\n async def to_contain_class(\n self,\n expected: Union[\n Sequence[str],\n str,\n ],\n timeout: float = None,\n ) -> None:\n __tracebackhide__ = True\n if isinstance(expected, collections.abc.Sequence) and not isinstance(\n expected, str\n ):\n expected_text = to_expected_text_values(expected)\n await self._expect_impl(\n \"to.contain.class.array\",\n FrameExpectOptions(expectedText=expected_text, timeout=timeout),\n expected,\n \"Locator expected to contain class names\",\n 'Expect \"to_contain_class\"',\n )\n else:\n expected_text = to_expected_text_values([expected])\n await self._expect_impl(\n \"to.contain.class\",\n FrameExpectOptions(expectedText=expected_text, timeout=timeout),\n expected,\n \"Locator expected to contain class\",\n 'Expect \"to_contain_class\"',\n )\n\n async def not_to_contain_class(\n self,\n expected: Union[\n Sequence[str],\n str,\n ],\n timeout: float = None,\n ) -> None:\n __tracebackhide__ = True\n await self._not.to_contain_class(expected, timeout)\n\n async def to_have_count(\n self,\n count: int,\n timeout: float = None,\n ) -> None:\n __tracebackhide__ = True\n await self._expect_impl(\n \"to.have.count\",\n FrameExpectOptions(expectedNumber=count, timeout=timeout),\n count,\n \"Locator expected to have count\",\n 'Expect \"to_have_count\"',\n )\n\n async def not_to_have_count(\n self,\n count: int,\n timeout: float = None,\n ) -> None:\n __tracebackhide__ = True\n await self._not.to_have_count(count, timeout)\n\n async def to_have_css(\n self,\n name: str,\n value: Union[str, Pattern[str]],\n timeout: float = None,\n ) -> None:\n __tracebackhide__ = True\n expected_text = to_expected_text_values([value])\n await self._expect_impl(\n \"to.have.css\",\n FrameExpectOptions(\n expressionArg=name, expectedText=expected_text, timeout=timeout\n ),\n value,\n \"Locator expected to have CSS\",\n 'Expect \"to_have_css\"',\n )\n\n async def not_to_have_css(\n self,\n name: str,\n value: Union[str, Pattern[str]],\n timeout: float = None,\n ) -> None:\n __tracebackhide__ = True\n await self._not.to_have_css(name, value, timeout)\n\n async def to_have_id(\n self,\n id: Union[str, Pattern[str]],\n timeout: float = None,\n ) -> None:\n __tracebackhide__ = True\n expected_text = to_expected_text_values([id])\n await self._expect_impl(\n \"to.have.id\",\n FrameExpectOptions(expectedText=expected_text, timeout=timeout),\n id,\n \"Locator expected to have ID\",\n 'Expect \"to_have_id\"',\n )\n\n async def not_to_have_id(\n self,\n id: Union[str, Pattern[str]],\n timeout: float = None,\n ) -> None:\n __tracebackhide__ = True\n await self._not.to_have_id(id, timeout)\n\n async def to_have_js_property(\n self,\n name: str,\n value: Any,\n timeout: float = None,\n ) -> None:\n __tracebackhide__ = True\n await self._expect_impl(\n \"to.have.property\",\n FrameExpectOptions(\n expressionArg=name, expectedValue=value, timeout=timeout\n ),\n value,\n \"Locator expected to have JS Property\",\n 'Expect \"to_have_property\"',\n )\n\n async def not_to_have_js_property(\n self,\n name: str,\n value: Any,\n timeout: float = None,\n ) -> None:\n __tracebackhide__ = True\n await self._not.to_have_js_property(name, value, timeout)\n\n async def to_have_value(\n self,\n value: Union[str, Pattern[str]],\n timeout: float = None,\n ) -> None:\n __tracebackhide__ = True\n expected_text = to_expected_text_values([value])\n await self._expect_impl(\n \"to.have.value\",\n FrameExpectOptions(expectedText=expected_text, timeout=timeout),\n value,\n \"Locator expected to have Value\",\n 'Expect \"to_have_value\"',\n )\n\n async def not_to_have_value(\n self,\n value: Union[str, Pattern[str]],\n timeout: float = None,\n ) -> None:\n __tracebackhide__ = True\n await self._not.to_have_value(value, timeout)\n\n async def to_have_values(\n self,\n values: Union[\n Sequence[str], Sequence[Pattern[str]], Sequence[Union[Pattern[str], str]]\n ],\n timeout: float = None,\n ) -> None:\n __tracebackhide__ = True\n expected_text = to_expected_text_values(values)\n await self._expect_impl(\n \"to.have.values\",\n FrameExpectOptions(expectedText=expected_text, timeout=timeout),\n values,\n \"Locator expected to have Values\",\n 'Expect \"to_have_values\"',\n )\n\n async def not_to_have_values(\n self,\n values: Union[\n Sequence[str], Sequence[Pattern[str]], Sequence[Union[Pattern[str], str]]\n ],\n timeout: float = None,\n ) -> None:\n __tracebackhide__ = True\n await self._not.to_have_values(values, timeout)\n\n async def to_have_text(\n self,\n expected: Union[\n Sequence[str],\n Sequence[Pattern[str]],\n Sequence[Union[Pattern[str], str]],\n Pattern[str],\n str,\n ],\n useInnerText: bool = None,\n timeout: float = None,\n ignoreCase: bool = None,\n ) -> None:\n __tracebackhide__ = True\n if isinstance(expected, collections.abc.Sequence) and not isinstance(\n expected, str\n ):\n expected_text = to_expected_text_values(\n expected,\n normalize_white_space=True,\n ignoreCase=ignoreCase,\n )\n await self._expect_impl(\n \"to.have.text.array\",\n FrameExpectOptions(\n expectedText=expected_text,\n useInnerText=useInnerText,\n timeout=timeout,\n ),\n expected,\n \"Locator expected to have text\",\n 'Expect \"to_have_text\"',\n )\n else:\n expected_text = to_expected_text_values(\n [expected], normalize_white_space=True, ignoreCase=ignoreCase\n )\n await self._expect_impl(\n \"to.have.text\",\n FrameExpectOptions(\n expectedText=expected_text,\n useInnerText=useInnerText,\n timeout=timeout,\n ),\n expected,\n \"Locator expected to have text\",\n 'Expect \"to_have_text\"',\n )\n\n async def not_to_have_text(\n self,\n expected: Union[\n Sequence[str],\n Sequence[Pattern[str]],\n Sequence[Union[Pattern[str], str]],\n Pattern[str],\n str,\n ],\n useInnerText: bool = None,\n timeout: float = None,\n ignoreCase: bool = None,\n ) -> None:\n __tracebackhide__ = True\n await self._not.to_have_text(expected, useInnerText, timeout, ignoreCase)\n\n async def to_be_attached(\n self,\n attached: bool = None,\n timeout: float = None,\n ) -> None:\n __tracebackhide__ = True\n if attached is None:\n attached = True\n attached_string = \"attached\" if attached else \"detached\"\n await self._expect_impl(\n (\"to.be.attached\" if attached else \"to.be.detached\"),\n FrameExpectOptions(timeout=timeout),\n None,\n f\"Locator expected to be {attached_string}\",\n 'Expect \"to_be_attached\"',\n )\n\n async def to_be_checked(\n self,\n timeout: float = None,\n checked: bool = None,\n indeterminate: bool = None,\n ) -> None:\n __tracebackhide__ = True\n expected_value = {}\n if indeterminate is not None:\n expected_value[\"indeterminate\"] = indeterminate\n if checked is not None:\n expected_value[\"checked\"] = checked\n checked_string: str\n if indeterminate:\n checked_string = \"indeterminate\"\n else:\n checked_string = \"unchecked\" if checked is False else \"checked\"\n await self._expect_impl(\n \"to.be.checked\",\n FrameExpectOptions(timeout=timeout, expectedValue=expected_value),\n None,\n f\"Locator expected to be {checked_string}\",\n 'Expect \"to_be_checked\"',\n )\n\n async def not_to_be_attached(\n self,\n attached: bool = None,\n timeout: float = None,\n ) -> None:\n __tracebackhide__ = True\n await self._not.to_be_attached(attached=attached, timeout=timeout)\n\n async def not_to_be_checked(\n self,\n timeout: float = None,\n ) -> None:\n __tracebackhide__ = True\n await self._not.to_be_checked(timeout)\n\n async def to_be_disabled(\n self,\n timeout: float = None,\n ) -> None:\n __tracebackhide__ = True\n await self._expect_impl(\n \"to.be.disabled\",\n FrameExpectOptions(timeout=timeout),\n None,\n \"Locator expected to be disabled\",\n 'Expect \"to_be_disabled\"',\n )\n\n async def not_to_be_disabled(\n self,\n timeout: float = None,\n ) -> None:\n __tracebackhide__ = True\n await self._not.to_be_disabled(timeout)\n\n async def to_be_editable(\n self,\n editable: bool = None,\n timeout: float = None,\n ) -> None:\n __tracebackhide__ = True\n if editable is None:\n editable = True\n editable_string = \"editable\" if editable else \"readonly\"\n await self._expect_impl(\n \"to.be.editable\" if editable else \"to.be.readonly\",\n FrameExpectOptions(timeout=timeout),\n None,\n f\"Locator expected to be {editable_string}\",\n 'Expect \"to_be_editable\"',\n )\n\n async def not_to_be_editable(\n self,\n editable: bool = None,\n timeout: float = None,\n ) -> None:\n __tracebackhide__ = True\n await self._not.to_be_editable(editable, timeout)\n\n async def to_be_empty(\n self,\n timeout: float = None,\n ) -> None:\n __tracebackhide__ = True\n await self._expect_impl(\n \"to.be.empty\",\n FrameExpectOptions(timeout=timeout),\n None,\n \"Locator expected to be empty\",\n 'Expect \"to_be_empty\"',\n )\n\n async def not_to_be_empty(\n self,\n timeout: float = None,\n ) -> None:\n __tracebackhide__ = True\n await self._not.to_be_empty(timeout)\n\n async def to_be_enabled(\n self,\n enabled: bool = None,\n timeout: float = None,\n ) -> None:\n __tracebackhide__ = True\n if enabled is None:\n enabled = True\n enabled_string = \"enabled\" if enabled else \"disabled\"\n await self._expect_impl(\n \"to.be.enabled\" if enabled else \"to.be.disabled\",\n FrameExpectOptions(timeout=timeout),\n None,\n f\"Locator expected to be {enabled_string}\",\n 'Expect \"to_be_enabled\"',\n )\n\n async def not_to_be_enabled(\n self,\n enabled: bool = None,\n timeout: float = None,\n ) -> None:\n __tracebackhide__ = True\n await self._not.to_be_enabled(enabled, timeout)\n\n async def to_be_hidden(\n self,\n timeout: float = None,\n ) -> None:\n __tracebackhide__ = True\n await self._expect_impl(\n \"to.be.hidden\",\n FrameExpectOptions(timeout=timeout),\n None,\n \"Locator expected to be hidden\",\n 'Expect \"to_be_hidden\"',\n )\n\n async def not_to_be_hidden(\n self,\n timeout: float = None,\n ) -> None:\n __tracebackhide__ = True\n await self._not.to_be_hidden(timeout)\n\n async def to_be_visible(\n self,\n visible: bool = None,\n timeout: float = None,\n ) -> None:\n __tracebackhide__ = True\n if visible is None:\n visible = True\n visible_string = \"visible\" if visible else \"hidden\"\n await self._expect_impl(\n \"to.be.visible\" if visible else \"to.be.hidden\",\n FrameExpectOptions(timeout=timeout),\n None,\n f\"Locator expected to be {visible_string}\",\n 'Expect \"to_be_visible\"',\n )\n\n async def not_to_be_visible(\n self,\n visible: bool = None,\n timeout: float = None,\n ) -> None:\n __tracebackhide__ = True\n await self._not.to_be_visible(visible, timeout)\n\n async def to_be_focused(\n self,\n timeout: float = None,\n ) -> None:\n __tracebackhide__ = True\n await self._expect_impl(\n \"to.be.focused\",\n FrameExpectOptions(timeout=timeout),\n None,\n \"Locator expected to be focused\",\n 'Expect \"to_be_focused\"',\n )\n\n async def not_to_be_focused(\n self,\n timeout: float = None,\n ) -> None:\n __tracebackhide__ = True\n await self._not.to_be_focused(timeout)\n\n async def to_be_in_viewport(\n self,\n ratio: float = None,\n timeout: float = None,\n ) -> None:\n __tracebackhide__ = True\n await self._expect_impl(\n \"to.be.in.viewport\",\n FrameExpectOptions(timeout=timeout, expectedNumber=ratio),\n None,\n \"Locator expected to be in viewport\",\n 'Expect \"to_be_in_viewport\"',\n )\n\n async def not_to_be_in_viewport(\n self, ratio: float = None, timeout: float = None\n ) -> None:\n __tracebackhide__ = True\n await self._not.to_be_in_viewport(ratio=ratio, timeout=timeout)\n\n async def to_have_accessible_description(\n self,\n description: Union[str, Pattern[str]],\n ignoreCase: bool = None,\n timeout: float = None,\n ) -> None:\n __tracebackhide__ = True\n expected_values = to_expected_text_values(\n [description], ignoreCase=ignoreCase, normalize_white_space=True\n )\n await self._expect_impl(\n \"to.have.accessible.description\",\n FrameExpectOptions(expectedText=expected_values, timeout=timeout),\n None,\n \"Locator expected to have accessible description\",\n 'Expect \"to_have_accessible_description\"',\n )\n\n async def not_to_have_accessible_description(\n self,\n name: Union[str, Pattern[str]],\n ignoreCase: bool = None,\n timeout: float = None,\n ) -> None:\n __tracebackhide__ = True\n await self._not.to_have_accessible_description(name, ignoreCase, timeout)\n\n async def to_have_accessible_name(\n self,\n name: Union[str, Pattern[str]],\n ignoreCase: bool = None,\n timeout: float = None,\n ) -> None:\n __tracebackhide__ = True\n expected_values = to_expected_text_values(\n [name], ignoreCase=ignoreCase, normalize_white_space=True\n )\n await self._expect_impl(\n \"to.have.accessible.name\",\n FrameExpectOptions(expectedText=expected_values, timeout=timeout),\n None,\n \"Locator expected to have accessible name\",\n 'Expect \"to_have_accessible_name\"',\n )\n\n async def not_to_have_accessible_name(\n self,\n name: Union[str, Pattern[str]],\n ignoreCase: bool = None,\n timeout: float = None,\n ) -> None:\n __tracebackhide__ = True\n await self._not.to_have_accessible_name(name, ignoreCase, timeout)\n\n async def to_have_role(self, role: AriaRole, timeout: float = None) -> None:\n __tracebackhide__ = True\n if isinstance(role, Pattern):\n raise Error('\"role\" argument in to_have_role must be a string')\n expected_values = to_expected_text_values([role])\n await self._expect_impl(\n \"to.have.role\",\n FrameExpectOptions(expectedText=expected_values, timeout=timeout),\n None,\n \"Locator expected to have accessible role\",\n 'Expect \"to_have_role\"',\n )\n\n async def to_have_accessible_error_message(\n self,\n errorMessage: Union[str, Pattern[str]],\n ignoreCase: bool = None,\n timeout: float = None,\n ) -> None:\n __tracebackhide__ = True\n expected_values = to_expected_text_values(\n [errorMessage], ignoreCase=ignoreCase, normalize_white_space=True\n )\n await self._expect_impl(\n \"to.have.accessible.error.message\",\n FrameExpectOptions(expectedText=expected_values, timeout=timeout),\n None,\n \"Locator expected to have accessible error message\",\n 'Expect \"to_have_accessible_error_message\"',\n )\n\n async def not_to_have_accessible_error_message(\n self,\n errorMessage: Union[str, Pattern[str]],\n ignoreCase: bool = None,\n timeout: float = None,\n ) -> None:\n __tracebackhide__ = True\n await self._not.to_have_accessible_error_message(\n errorMessage=errorMessage, ignoreCase=ignoreCase, timeout=timeout\n )\n\n async def not_to_have_role(self, role: AriaRole, timeout: float = None) -> None:\n __tracebackhide__ = True\n await self._not.to_have_role(role, timeout)\n\n async def to_match_aria_snapshot(\n self, expected: str, timeout: float = None\n ) -> None:\n __tracebackhide__ = True\n await self._expect_impl(\n \"to.match.aria\",\n FrameExpectOptions(expectedValue=expected, timeout=timeout),\n expected,\n \"Locator expected to match Aria snapshot\",\n 'Expect \"to_match_aria_snapshot\"',\n )\n\n async def not_to_match_aria_snapshot(\n self, expected: str, timeout: float = None\n ) -> None:\n __tracebackhide__ = True\n await self._not.to_match_aria_snapshot(expected, timeout)\n\n\nclass APIResponseAssertions:\n def __init__(\n self,\n response: APIResponse,\n timeout: float = None,\n is_not: bool = False,\n message: Optional[str] = None,\n ) -> None:\n self._loop = response._loop\n self._dispatcher_fiber = response._dispatcher_fiber\n self._timeout = timeout\n self._is_not = is_not\n self._actual = response\n self._custom_message = message\n\n @property\n def _not(self) -> \"APIResponseAssertions\":\n return APIResponseAssertions(\n self._actual, self._timeout, not self._is_not, self._custom_message\n )\n\n async def to_be_ok(\n self,\n ) -> None:\n __tracebackhide__ = True\n if self._is_not is not self._actual.ok:\n return\n message = f\"Response status expected to be within [200..299] range, was '{self._actual.status}'\"\n if self._is_not:\n message = message.replace(\"expected to\", \"expected not to\")\n out_message = self._custom_message or message\n out_message += format_call_log(await self._actual._fetch_log())\n\n content_type = self._actual.headers.get(\"content-type\")\n is_text_encoding = content_type and is_textual_mime_type(content_type)\n text = await self._actual.text() if is_text_encoding else None\n if text is not None:\n out_message += f\"\\n Response Text:\\n{text[:1000]}\"\n\n raise AssertionError(out_message)\n\n async def not_to_be_ok(self) -> None:\n __tracebackhide__ = True\n await self._not.to_be_ok()\n\n\ndef expected_regex(\n pattern: Pattern[str],\n match_substring: bool,\n normalize_white_space: bool,\n ignoreCase: Optional[bool] = None,\n) -> ExpectedTextValue:\n expected = ExpectedTextValue(\n regexSource=pattern.pattern,\n regexFlags=escape_regex_flags(pattern),\n matchSubstring=match_substring,\n normalizeWhiteSpace=normalize_white_space,\n ignoreCase=ignoreCase,\n )\n if expected[\"ignoreCase\"] is None:\n del expected[\"ignoreCase\"]\n return expected\n\n\ndef to_expected_text_values(\n items: Union[\n Sequence[Pattern[str]], Sequence[str], Sequence[Union[str, Pattern[str]]]\n ],\n match_substring: bool = False,\n normalize_white_space: bool = False,\n ignoreCase: Optional[bool] = None,\n) -> Sequence[ExpectedTextValue]:\n out: List[ExpectedTextValue] = []\n assert isinstance(items, (list, tuple))\n for item in items:\n if isinstance(item, str):\n o = ExpectedTextValue(\n string=item,\n matchSubstring=match_substring,\n normalizeWhiteSpace=normalize_white_space,\n ignoreCase=ignoreCase,\n )\n if o[\"ignoreCase\"] is None:\n del o[\"ignoreCase\"]\n out.append(o)\n elif isinstance(item, Pattern):\n out.append(\n expected_regex(item, match_substring, normalize_white_space, ignoreCase)\n )\n else:\n raise Error(\"value must be a string or regular expression\")\n return out\n" }, { "path": "playwright/_impl/_async_base.py", "content": "# Copyright (c) Microsoft Corporation.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n\nimport asyncio\nfrom contextlib import AbstractAsyncContextManager\nfrom types import TracebackType\nfrom typing import Any, Callable, Generic, Optional, Type, TypeVar, Union\n\nfrom playwright._impl._impl_to_api_mapping import ImplToApiMapping, ImplWrapper\n\nmapping = ImplToApiMapping()\n\n\nT = TypeVar(\"T\")\nSelf = TypeVar(\"Self\", bound=\"AsyncContextManager\")\n\n\nclass AsyncEventInfo(Generic[T]):\n def __init__(self, future: \"asyncio.Future[T]\") -> None:\n self._future = future\n\n @property\n async def value(self) -> T:\n return mapping.from_maybe_impl(await self._future)\n\n def _cancel(self) -> None:\n self._future.cancel()\n\n def is_done(self) -> bool:\n return self._future.done()\n\n\nclass AsyncEventContextManager(Generic[T], AbstractAsyncContextManager):\n def __init__(self, future: \"asyncio.Future[T]\") -> None:\n self._event = AsyncEventInfo[T](future)\n\n async def __aenter__(self) -> AsyncEventInfo[T]:\n return self._event\n\n async def __aexit__(\n self,\n exc_type: Optional[Type[BaseException]],\n exc_val: Optional[BaseException],\n exc_tb: Optional[TracebackType],\n ) -> None:\n if exc_val:\n self._event._cancel()\n else:\n await self._event.value\n\n\nclass AsyncBase(ImplWrapper):\n def __init__(self, impl_obj: Any) -> None:\n super().__init__(impl_obj)\n self._loop = impl_obj._loop\n\n def __str__(self) -> str:\n return self._impl_obj.__str__()\n\n def _wrap_handler(\n self, handler: Union[Callable[..., Any], Any]\n ) -> Callable[..., None]:\n if callable(handler):\n return mapping.wrap_handler(handler)\n return handler\n\n def on(self, event: Any, f: Any) -> None:\n \"\"\"Registers the function ``f`` to the event name ``event``.\"\"\"\n self._impl_obj.on(event, self._wrap_handler(f))\n\n def once(self, event: Any, f: Any) -> None:\n \"\"\"The same as ``self.on``, except that the listener is automatically\n removed after being called.\n \"\"\"\n self._impl_obj.once(event, self._wrap_handler(f))\n\n def remove_listener(self, event: Any, f: Any) -> None:\n \"\"\"Removes the function ``f`` from ``event``.\"\"\"\n self._impl_obj.remove_listener(event, self._wrap_handler(f))\n\n\nclass AsyncContextManager(AsyncBase):\n async def __aenter__(self: Self) -> Self:\n return self\n\n async def __aexit__(\n self,\n exc_type: Optional[Type[BaseException]],\n exc_val: Optional[BaseException],\n traceback: Optional[TracebackType],\n ) -> None:\n await self.close()\n\n async def close(self) -> None: ...\n" }, { "path": "playwright/_impl/_browser.py", "content": "# Copyright (c) Microsoft Corporation.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n\nfrom pathlib import Path\nfrom types import SimpleNamespace\nfrom typing import (\n TYPE_CHECKING,\n Dict,\n List,\n Optional,\n Pattern,\n Sequence,\n Set,\n Union,\n cast,\n)\n\nfrom playwright._impl._api_structures import (\n ClientCertificate,\n Geolocation,\n HttpCredentials,\n ProxySettings,\n StorageState,\n ViewportSize,\n)\nfrom playwright._impl._artifact import Artifact\nfrom playwright._impl._browser_context import BrowserContext\nfrom playwright._impl._cdp_session import CDPSession\nfrom playwright._impl._connection import ChannelOwner, from_channel\nfrom playwright._impl._errors import is_target_closed_error\nfrom playwright._impl._helper import (\n ColorScheme,\n Contrast,\n ForcedColors,\n HarContentPolicy,\n HarMode,\n ReducedMotion,\n ServiceWorkersPolicy,\n locals_to_params,\n make_dirs_for_file,\n)\nfrom playwright._impl._page import Page\n\nif TYPE_CHECKING: # pragma: no cover\n from playwright._impl._browser_type import BrowserType\n\n\nclass Browser(ChannelOwner):\n Events = SimpleNamespace(\n Disconnected=\"disconnected\",\n )\n\n def __init__(\n self, parent: \"BrowserType\", type: str, guid: str, initializer: Dict\n ) -> None:\n super().__init__(parent, type, guid, initializer)\n self._browser_type: Optional[\"BrowserType\"] = None\n self._is_connected = True\n self._should_close_connection_on_close = False\n self._cr_tracing_path: Optional[str] = None\n\n self._contexts: Set[BrowserContext] = set()\n self._traces_dir: Optional[str] = None\n self._channel.on(\n \"context\",\n lambda params: self._did_create_context(\n cast(BrowserContext, from_channel(params[\"context\"]))\n ),\n )\n self._channel.on(\"close\", lambda _: self._on_close())\n self._close_reason: Optional[str] = None\n\n def __repr__(self) -> str:\n return f\"\"\n\n def _connect_to_browser_type(\n self,\n browser_type: \"BrowserType\",\n traces_dir: Optional[str] = None,\n ) -> None:\n # Note: when using connect(), `browserType` is different from `this.parent`.\n # This is why browser type is not wired up in the constructor, and instead this separate method is called later on.\n self._browser_type = browser_type\n self._traces_dir = traces_dir\n for context in self._contexts:\n self._setup_browser_context(context)\n\n def _did_create_context(self, context: BrowserContext) -> None:\n context._browser = self\n self._contexts.add(context)\n # Note: when connecting to a browser, initial contexts arrive before `_browserType` is set,\n # and will be configured later in `ConnectToBrowserType`.\n if self._browser_type:\n self._setup_browser_context(context)\n\n def _setup_browser_context(self, context: BrowserContext) -> None:\n context._tracing._traces_dir = self._traces_dir\n assert self._browser_type is not None\n self._browser_type._playwright.selectors._contexts_for_selectors.add(context)\n\n def _on_close(self) -> None:\n self._is_connected = False\n self.emit(Browser.Events.Disconnected, self)\n\n @property\n def contexts(self) -> List[BrowserContext]:\n return list(self._contexts)\n\n @property\n def browser_type(self) -> \"BrowserType\":\n assert self._browser_type is not None\n return self._browser_type\n\n def is_connected(self) -> bool:\n return self._is_connected\n\n async def new_context(\n self,\n viewport: ViewportSize = None,\n screen: ViewportSize = None,\n noViewport: bool = None,\n ignoreHTTPSErrors: bool = None,\n javaScriptEnabled: bool = None,\n bypassCSP: bool = None,\n userAgent: str = None,\n locale: str = None,\n timezoneId: str = None,\n geolocation: Geolocation = None,\n permissions: Sequence[str] = None,\n extraHTTPHeaders: Dict[str, str] = None,\n offline: bool = None,\n httpCredentials: HttpCredentials = None,\n deviceScaleFactor: float = None,\n isMobile: bool = None,\n hasTouch: bool = None,\n colorScheme: ColorScheme = None,\n reducedMotion: ReducedMotion = None,\n forcedColors: ForcedColors = None,\n contrast: Contrast = None,\n acceptDownloads: bool = None,\n defaultBrowserType: str = None,\n proxy: ProxySettings = None,\n recordHarPath: Union[Path, str] = None,\n recordHarOmitContent: bool = None,\n recordVideoDir: Union[Path, str] = None,\n recordVideoSize: ViewportSize = None,\n storageState: Union[StorageState, str, Path] = None,\n baseURL: str = None,\n strictSelectors: bool = None,\n serviceWorkers: ServiceWorkersPolicy = None,\n recordHarUrlFilter: Union[Pattern[str], str] = None,\n recordHarMode: HarMode = None,\n recordHarContent: HarContentPolicy = None,\n clientCertificates: List[ClientCertificate] = None,\n ) -> BrowserContext:\n params = locals_to_params(locals())\n assert self._browser_type is not None\n await self._browser_type._prepare_browser_context_params(params)\n\n channel = await self._channel.send(\"newContext\", None, params)\n context = cast(BrowserContext, from_channel(channel))\n await context._initialize_har_from_options(\n record_har_content=recordHarContent,\n record_har_mode=recordHarMode,\n record_har_omit_content=recordHarOmitContent,\n record_har_path=recordHarPath,\n record_har_url_filter=recordHarUrlFilter,\n )\n return context\n\n async def new_page(\n self,\n viewport: ViewportSize = None,\n screen: ViewportSize = None,\n noViewport: bool = None,\n ignoreHTTPSErrors: bool = None,\n javaScriptEnabled: bool = None,\n bypassCSP: bool = None,\n userAgent: str = None,\n locale: str = None,\n timezoneId: str = None,\n geolocation: Geolocation = None,\n permissions: Sequence[str] = None,\n extraHTTPHeaders: Dict[str, str] = None,\n offline: bool = None,\n httpCredentials: HttpCredentials = None,\n deviceScaleFactor: float = None,\n isMobile: bool = None,\n hasTouch: bool = None,\n colorScheme: ColorScheme = None,\n forcedColors: ForcedColors = None,\n contrast: Contrast = None,\n reducedMotion: ReducedMotion = None,\n acceptDownloads: bool = None,\n defaultBrowserType: str = None,\n proxy: ProxySettings = None,\n recordHarPath: Union[Path, str] = None,\n recordHarOmitContent: bool = None,\n recordVideoDir: Union[Path, str] = None,\n recordVideoSize: ViewportSize = None,\n storageState: Union[StorageState, str, Path] = None,\n baseURL: str = None,\n strictSelectors: bool = None,\n serviceWorkers: ServiceWorkersPolicy = None,\n recordHarUrlFilter: Union[Pattern[str], str] = None,\n recordHarMode: HarMode = None,\n recordHarContent: HarContentPolicy = None,\n clientCertificates: List[ClientCertificate] = None,\n ) -> Page:\n params = locals_to_params(locals())\n\n async def inner() -> Page:\n context = await self.new_context(**params)\n page = await context.new_page()\n page._owned_context = context\n context._owner_page = page\n return page\n\n return await self._connection.wrap_api_call(inner, title=\"Create page\")\n\n async def close(self, reason: str = None) -> None:\n self._close_reason = reason\n try:\n if self._should_close_connection_on_close:\n await self._connection.stop_async()\n else:\n await self._channel.send(\"close\", None, {\"reason\": reason})\n except Exception as e:\n if not is_target_closed_error(e):\n raise e\n\n @property\n def version(self) -> str:\n return self._initializer[\"version\"]\n\n async def new_browser_cdp_session(self) -> CDPSession:\n return from_channel(await self._channel.send(\"newBrowserCDPSession\", None))\n\n async def start_tracing(\n self,\n page: Page = None,\n path: Union[str, Path] = None,\n screenshots: bool = None,\n categories: Sequence[str] = None,\n ) -> None:\n params = locals_to_params(locals())\n if page:\n params[\"page\"] = page._channel\n if path:\n self._cr_tracing_path = str(path)\n params[\"path\"] = str(path)\n await self._channel.send(\"startTracing\", None, params)\n\n async def stop_tracing(self) -> bytes:\n artifact = cast(\n Artifact, from_channel(await self._channel.send(\"stopTracing\", None))\n )\n buffer = await artifact.read_info_buffer()\n await artifact.delete()\n if self._cr_tracing_path:\n make_dirs_for_file(self._cr_tracing_path)\n with open(self._cr_tracing_path, \"wb\") as f:\n f.write(buffer)\n self._cr_tracing_path = None\n return buffer\n" }, { "path": "playwright/_impl/_browser_context.py", "content": "# Copyright (c) Microsoft Corporation.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n\nimport asyncio\nimport json\nfrom pathlib import Path\nfrom types import SimpleNamespace\nfrom typing import (\n TYPE_CHECKING,\n Any,\n Callable,\n Dict,\n List,\n Literal,\n Optional,\n Pattern,\n Sequence,\n Set,\n Union,\n cast,\n)\n\nfrom playwright._impl._api_structures import (\n Cookie,\n Geolocation,\n SetCookieParam,\n StorageState,\n)\nfrom playwright._impl._artifact import Artifact\nfrom playwright._impl._cdp_session import CDPSession\nfrom playwright._impl._clock import Clock\nfrom playwright._impl._connection import (\n ChannelOwner,\n from_channel,\n from_nullable_channel,\n)\nfrom playwright._impl._console_message import ConsoleMessage\nfrom playwright._impl._dialog import Dialog\nfrom playwright._impl._errors import Error, TargetClosedError\nfrom playwright._impl._event_context_manager import EventContextManagerImpl\nfrom playwright._impl._fetch import APIRequestContext\nfrom playwright._impl._frame import Frame\nfrom playwright._impl._har_router import HarRouter\nfrom playwright._impl._helper import (\n HarContentPolicy,\n HarMode,\n HarRecordingMetadata,\n RouteFromHarNotFoundPolicy,\n RouteHandler,\n RouteHandlerCallback,\n TimeoutSettings,\n URLMatch,\n WebSocketRouteHandlerCallback,\n async_readfile,\n async_writefile,\n locals_to_params,\n parse_error,\n to_impl,\n)\nfrom playwright._impl._network import (\n Request,\n Response,\n Route,\n WebSocketRoute,\n WebSocketRouteHandler,\n serialize_headers,\n)\nfrom playwright._impl._page import BindingCall, Page, Worker\nfrom playwright._impl._str_utils import escape_regex_flags\nfrom playwright._impl._tracing import Tracing\nfrom playwright._impl._waiter import Waiter\nfrom playwright._impl._web_error import WebError\n\nif TYPE_CHECKING: # pragma: no cover\n from playwright._impl._browser import Browser\n\n\nclass BrowserContext(ChannelOwner):\n Events = SimpleNamespace(\n # Deprecated in v1.56, never emitted anymore.\n BackgroundPage=\"backgroundpage\",\n Close=\"close\",\n Console=\"console\",\n Dialog=\"dialog\",\n Page=\"page\",\n WebError=\"weberror\",\n ServiceWorker=\"serviceworker\",\n Request=\"request\",\n Response=\"response\",\n RequestFailed=\"requestfailed\",\n RequestFinished=\"requestfinished\",\n )\n\n def __init__(\n self, parent: ChannelOwner, type: str, guid: str, initializer: Dict\n ) -> None:\n super().__init__(parent, type, guid, initializer)\n # Browser is null for browser contexts created outside of normal browser, e.g. android or electron.\n # circular import workaround:\n self._browser: Optional[\"Browser\"] = None\n if parent.__class__.__name__ == \"Browser\":\n self._browser = cast(\"Browser\", parent)\n self._pages: List[Page] = []\n self._routes: List[RouteHandler] = []\n self._web_socket_routes: List[WebSocketRouteHandler] = []\n self._bindings: Dict[str, Any] = {}\n self._timeout_settings = TimeoutSettings(None)\n self._owner_page: Optional[Page] = None\n self._options: Dict[str, Any] = initializer[\"options\"]\n self._service_workers: Set[Worker] = set()\n self._base_url: Optional[str] = self._options.get(\"baseURL\")\n self._videos_dir: Optional[str] = self._options.get(\"recordVideo\")\n self._tracing = cast(Tracing, from_channel(initializer[\"tracing\"]))\n self._har_recorders: Dict[str, HarRecordingMetadata] = {}\n self._request: APIRequestContext = from_channel(initializer[\"requestContext\"])\n self._request._timeout_settings = self._timeout_settings\n self._clock = Clock(self)\n self._channel.on(\n \"bindingCall\",\n lambda params: self._on_binding(from_channel(params[\"binding\"])),\n )\n self._channel.on(\"close\", lambda _: self._on_close())\n self._channel.on(\n \"page\", lambda params: self._on_page(from_channel(params[\"page\"]))\n )\n self._channel.on(\n \"route\",\n lambda params: self._loop.create_task(\n self._on_route(\n from_channel(params.get(\"route\")),\n )\n ),\n )\n self._channel.on(\n \"webSocketRoute\",\n lambda params: self._loop.create_task(\n self._on_web_socket_route(\n from_channel(params[\"webSocketRoute\"]),\n )\n ),\n )\n\n self._channel.on(\n \"serviceWorker\",\n lambda params: self._on_service_worker(from_channel(params[\"worker\"])),\n )\n self._channel.on(\n \"console\",\n lambda event: self._on_console_message(event),\n )\n\n self._channel.on(\n \"dialog\", lambda params: self._on_dialog(from_channel(params[\"dialog\"]))\n )\n self._channel.on(\n \"pageError\",\n lambda params: self._on_page_error(\n parse_error(params[\"error\"][\"error\"]),\n from_nullable_channel(params[\"page\"]),\n ),\n )\n self._channel.on(\n \"request\",\n lambda params: self._on_request(\n from_channel(params[\"request\"]),\n from_nullable_channel(params.get(\"page\")),\n ),\n )\n self._channel.on(\n \"response\",\n lambda params: self._on_response(\n from_channel(params[\"response\"]),\n from_nullable_channel(params.get(\"page\")),\n ),\n )\n self._channel.on(\n \"requestFailed\",\n lambda params: self._on_request_failed(\n from_channel(params[\"request\"]),\n params[\"responseEndTiming\"],\n params.get(\"failureText\"),\n from_nullable_channel(params.get(\"page\")),\n ),\n )\n self._channel.on(\n \"requestFinished\",\n lambda params: self._on_request_finished(\n from_channel(params[\"request\"]),\n from_nullable_channel(params.get(\"response\")),\n params[\"responseEndTiming\"],\n from_nullable_channel(params.get(\"page\")),\n ),\n )\n self._closed_future: asyncio.Future = asyncio.Future()\n self.once(\n self.Events.Close, lambda context: self._closed_future.set_result(True)\n )\n self._close_reason: Optional[str] = None\n self._har_routers: List[HarRouter] = []\n self._set_event_to_subscription_mapping(\n {\n BrowserContext.Events.Console: \"console\",\n BrowserContext.Events.Dialog: \"dialog\",\n BrowserContext.Events.Request: \"request\",\n BrowserContext.Events.Response: \"response\",\n BrowserContext.Events.RequestFinished: \"requestFinished\",\n BrowserContext.Events.RequestFailed: \"requestFailed\",\n }\n )\n self._closing_or_closed = False\n\n def __repr__(self) -> str:\n return f\"\"\n\n def _on_page(self, page: Page) -> None:\n self._pages.append(page)\n self.emit(BrowserContext.Events.Page, page)\n if page._opener and not page._opener.is_closed():\n page._opener.emit(Page.Events.Popup, page)\n\n async def _on_route(self, route: Route) -> None:\n route._context = self\n page = route.request._safe_page()\n route_handlers = self._routes.copy()\n for route_handler in route_handlers:\n # If the page or the context was closed we stall all requests right away.\n if (page and page._close_was_called) or self._closing_or_closed:\n return\n if not route_handler.matches(route.request.url):\n continue\n if route_handler not in self._routes:\n continue\n if route_handler.will_expire:\n self._routes.remove(route_handler)\n try:\n handled = await route_handler.handle(route)\n finally:\n if len(self._routes) == 0:\n asyncio.create_task(\n self._connection.wrap_api_call(\n lambda: self._update_interception_patterns(), True\n )\n )\n if handled:\n return\n try:\n # If the page is closed or unrouteAll() was called without waiting and interception disabled,\n # the method will throw an error - silence it.\n await route._inner_continue(True)\n except Exception:\n pass\n\n async def _on_web_socket_route(self, web_socket_route: WebSocketRoute) -> None:\n route_handler = next(\n (\n route_handler\n for route_handler in self._web_socket_routes\n if route_handler.matches(web_socket_route.url)\n ),\n None,\n )\n if route_handler:\n await route_handler.handle(web_socket_route)\n else:\n web_socket_route.connect_to_server()\n\n def _on_binding(self, binding_call: BindingCall) -> None:\n func = self._bindings.get(binding_call._initializer[\"name\"])\n if func is None:\n return\n asyncio.create_task(binding_call.call(func))\n\n def set_default_navigation_timeout(self, timeout: float) -> None:\n return self._set_default_navigation_timeout_impl(timeout)\n\n def _set_default_navigation_timeout_impl(self, timeout: Optional[float]) -> None:\n self._timeout_settings.set_default_navigation_timeout(timeout)\n\n def set_default_timeout(self, timeout: float) -> None:\n return self._set_default_timeout_impl(timeout)\n\n def _set_default_timeout_impl(self, timeout: Optional[float]) -> None:\n self._timeout_settings.set_default_timeout(timeout)\n\n @property\n def pages(self) -> List[Page]:\n return self._pages.copy()\n\n @property\n def browser(self) -> Optional[\"Browser\"]:\n return self._browser\n\n async def _initialize_har_from_options(\n self,\n record_har_path: Optional[Union[Path, str]],\n record_har_content: Optional[HarContentPolicy],\n record_har_omit_content: Optional[bool],\n record_har_url_filter: Optional[Union[Pattern[str], str]],\n record_har_mode: Optional[HarMode],\n ) -> None:\n if not record_har_path:\n return\n record_har_path = str(record_har_path)\n default_policy: HarContentPolicy = (\n \"attach\" if record_har_path.endswith(\".zip\") else \"embed\"\n )\n content_policy: HarContentPolicy = record_har_content or (\n \"omit\" if record_har_omit_content is True else default_policy\n )\n await self._record_into_har(\n har=record_har_path,\n page=None,\n url=record_har_url_filter,\n update_content=content_policy,\n update_mode=(record_har_mode or \"full\"),\n )\n\n async def new_page(self) -> Page:\n if self._owner_page:\n raise Error(\"Please use browser.new_context()\")\n return from_channel(await self._channel.send(\"newPage\", None))\n\n async def cookies(self, urls: Union[str, Sequence[str]] = None) -> List[Cookie]:\n if urls is None:\n urls = []\n if isinstance(urls, str):\n urls = [urls]\n return await self._channel.send(\"cookies\", None, dict(urls=urls))\n\n async def add_cookies(self, cookies: Sequence[SetCookieParam]) -> None:\n await self._channel.send(\"addCookies\", None, dict(cookies=cookies))\n\n async def clear_cookies(\n self,\n name: Union[str, Pattern[str]] = None,\n domain: Union[str, Pattern[str]] = None,\n path: Union[str, Pattern[str]] = None,\n ) -> None:\n await self._channel.send(\n \"clearCookies\",\n None,\n {\n \"name\": name if isinstance(name, str) else None,\n \"nameRegexSource\": name.pattern if isinstance(name, Pattern) else None,\n \"nameRegexFlags\": (\n escape_regex_flags(name) if isinstance(name, Pattern) else None\n ),\n \"domain\": domain if isinstance(domain, str) else None,\n \"domainRegexSource\": (\n domain.pattern if isinstance(domain, Pattern) else None\n ),\n \"domainRegexFlags\": (\n escape_regex_flags(domain) if isinstance(domain, Pattern) else None\n ),\n \"path\": path if isinstance(path, str) else None,\n \"pathRegexSource\": path.pattern if isinstance(path, Pattern) else None,\n \"pathRegexFlags\": (\n escape_regex_flags(path) if isinstance(path, Pattern) else None\n ),\n },\n )\n\n async def grant_permissions(\n self, permissions: Sequence[str], origin: str = None\n ) -> None:\n await self._channel.send(\"grantPermissions\", None, locals_to_params(locals()))\n\n async def clear_permissions(self) -> None:\n await self._channel.send(\"clearPermissions\", None)\n\n async def set_geolocation(self, geolocation: Geolocation = None) -> None:\n await self._channel.send(\"setGeolocation\", None, locals_to_params(locals()))\n\n async def set_extra_http_headers(self, headers: Dict[str, str]) -> None:\n await self._channel.send(\n \"setExtraHTTPHeaders\", None, dict(headers=serialize_headers(headers))\n )\n\n async def set_offline(self, offline: bool) -> None:\n await self._channel.send(\"setOffline\", None, dict(offline=offline))\n\n async def add_init_script(\n self, script: str = None, path: Union[str, Path] = None\n ) -> None:\n if path:\n script = (await async_readfile(path)).decode()\n if not isinstance(script, str):\n raise Error(\"Either path or script parameter must be specified\")\n await self._channel.send(\"addInitScript\", None, dict(source=script))\n\n async def expose_binding(\n self, name: str, callback: Callable, handle: bool = None\n ) -> None:\n for page in self._pages:\n if name in page._bindings:\n raise Error(\n f'Function \"{name}\" has been already registered in one of the pages'\n )\n if name in self._bindings:\n raise Error(f'Function \"{name}\" has been already registered')\n self._bindings[name] = callback\n await self._channel.send(\n \"exposeBinding\", None, dict(name=name, needsHandle=handle or False)\n )\n\n async def expose_function(self, name: str, callback: Callable) -> None:\n await self.expose_binding(name, lambda source, *args: callback(*args))\n\n async def route(\n self, url: URLMatch, handler: RouteHandlerCallback, times: int = None\n ) -> None:\n self._routes.insert(\n 0,\n RouteHandler(\n self._base_url,\n url,\n handler,\n True if self._dispatcher_fiber else False,\n times,\n ),\n )\n await self._update_interception_patterns()\n\n async def unroute(\n self, url: URLMatch, handler: Optional[RouteHandlerCallback] = None\n ) -> None:\n removed = []\n remaining = []\n for route in self._routes:\n if route.url != url or (handler and route.handler != handler):\n remaining.append(route)\n else:\n removed.append(route)\n await self._unroute_internal(removed, remaining, \"default\")\n\n async def _unroute_internal(\n self,\n removed: List[RouteHandler],\n remaining: List[RouteHandler],\n behavior: Literal[\"default\", \"ignoreErrors\", \"wait\"] = None,\n ) -> None:\n self._routes = remaining\n if behavior is not None and behavior != \"default\":\n await asyncio.gather(*map(lambda router: router.stop(behavior), removed)) # type: ignore\n await self._update_interception_patterns()\n\n async def route_web_socket(\n self, url: URLMatch, handler: WebSocketRouteHandlerCallback\n ) -> None:\n self._web_socket_routes.insert(\n 0,\n WebSocketRouteHandler(self._base_url, url, handler),\n )\n await self._update_web_socket_interception_patterns()\n\n def _dispose_har_routers(self) -> None:\n for router in self._har_routers:\n router.dispose()\n self._har_routers = []\n\n async def unroute_all(\n self, behavior: Literal[\"default\", \"ignoreErrors\", \"wait\"] = None\n ) -> None:\n await self._unroute_internal(self._routes, [], behavior)\n self._dispose_har_routers()\n\n async def _record_into_har(\n self,\n har: Union[Path, str],\n page: Optional[Page] = None,\n url: Union[Pattern[str], str] = None,\n update_content: HarContentPolicy = None,\n update_mode: HarMode = None,\n ) -> None:\n update_content = update_content or \"attach\"\n params: Dict[str, Any] = {\n \"options\": {\n \"zip\": str(har).endswith(\".zip\"),\n \"content\": update_content,\n \"urlGlob\": url if isinstance(url, str) else None,\n \"urlRegexSource\": url.pattern if isinstance(url, Pattern) else None,\n \"urlRegexFlags\": (\n escape_regex_flags(url) if isinstance(url, Pattern) else None\n ),\n \"mode\": update_mode or \"minimal\",\n }\n }\n if page:\n params[\"page\"] = page._channel\n har_id = await self._channel.send(\"harStart\", None, params)\n self._har_recorders[har_id] = {\n \"path\": str(har),\n \"content\": update_content,\n }\n\n async def route_from_har(\n self,\n har: Union[Path, str],\n url: Union[Pattern[str], str] = None,\n notFound: RouteFromHarNotFoundPolicy = None,\n update: bool = None,\n updateContent: Literal[\"attach\", \"embed\"] = None,\n updateMode: HarMode = None,\n ) -> None:\n if update:\n await self._record_into_har(\n har=har,\n page=None,\n url=url,\n update_content=updateContent,\n update_mode=updateMode,\n )\n return\n router = await HarRouter.create(\n local_utils=self._connection.local_utils,\n file=str(har),\n not_found_action=notFound or \"abort\",\n url_matcher=url,\n )\n self._har_routers.append(router)\n await router.add_context_route(self)\n\n async def _update_interception_patterns(self) -> None:\n patterns = RouteHandler.prepare_interception_patterns(self._routes)\n await self._channel.send(\n \"setNetworkInterceptionPatterns\", None, {\"patterns\": patterns}\n )\n\n async def _update_web_socket_interception_patterns(self) -> None:\n patterns = WebSocketRouteHandler.prepare_interception_patterns(\n self._web_socket_routes\n )\n await self._channel.send(\n \"setWebSocketInterceptionPatterns\", None, {\"patterns\": patterns}\n )\n\n def expect_event(\n self,\n event: str,\n predicate: Callable = None,\n timeout: float = None,\n ) -> EventContextManagerImpl:\n if timeout is None:\n timeout = self._timeout_settings.timeout()\n waiter = Waiter(self, f\"browser_context.expect_event({event})\")\n waiter.reject_on_timeout(\n timeout, f'Timeout {timeout}ms exceeded while waiting for event \"{event}\"'\n )\n if event != BrowserContext.Events.Close:\n waiter.reject_on_event(\n self, BrowserContext.Events.Close, lambda: TargetClosedError()\n )\n waiter.wait_for_event(self, event, predicate)\n return EventContextManagerImpl(waiter.result())\n\n def _on_close(self) -> None:\n self._closing_or_closed = True\n if self._browser:\n if self in self._browser._contexts:\n self._browser._contexts.remove(self)\n assert self._browser._browser_type is not None\n if (\n self\n in self._browser._browser_type._playwright.selectors._contexts_for_selectors\n ):\n self._browser._browser_type._playwright.selectors._contexts_for_selectors.remove(\n self\n )\n\n self._dispose_har_routers()\n self._tracing._reset_stack_counter()\n self.emit(BrowserContext.Events.Close, self)\n\n async def close(self, reason: str = None) -> None:\n if self._closing_or_closed:\n return\n self._close_reason = reason\n self._closing_or_closed = True\n\n await self.request.dispose(reason=reason)\n\n async def _inner_close() -> None:\n for har_id, params in self._har_recorders.items():\n har = cast(\n Artifact,\n from_channel(\n await self._channel.send(\"harExport\", None, {\"harId\": har_id})\n ),\n )\n # Server side will compress artifact if content is attach or if file is .zip.\n is_compressed = params.get(\"content\") == \"attach\" or params[\n \"path\"\n ].endswith(\".zip\")\n need_compressed = params[\"path\"].endswith(\".zip\")\n if is_compressed and not need_compressed:\n tmp_path = params[\"path\"] + \".tmp\"\n await har.save_as(tmp_path)\n await self._connection.local_utils.har_unzip(\n zipFile=tmp_path, harFile=params[\"path\"]\n )\n else:\n await har.save_as(params[\"path\"])\n await har.delete()\n\n await self._channel._connection.wrap_api_call(_inner_close, True)\n await self._channel.send(\"close\", None, {\"reason\": reason})\n await self._closed_future\n\n async def storage_state(\n self, path: Union[str, Path] = None, indexedDB: bool = None\n ) -> StorageState:\n result = await self._channel.send_return_as_dict(\n \"storageState\", None, {\"indexedDB\": indexedDB}\n )\n if path:\n await async_writefile(path, json.dumps(result))\n return result\n\n def _effective_close_reason(self) -> Optional[str]:\n if self._close_reason:\n return self._close_reason\n if self._browser:\n return self._browser._close_reason\n return None\n\n async def wait_for_event(\n self, event: str, predicate: Callable = None, timeout: float = None\n ) -> Any:\n async with self.expect_event(event, predicate, timeout) as event_info:\n pass\n return await event_info\n\n def expect_console_message(\n self,\n predicate: Callable[[ConsoleMessage], bool] = None,\n timeout: float = None,\n ) -> EventContextManagerImpl[ConsoleMessage]:\n return self.expect_event(Page.Events.Console, predicate, timeout)\n\n def expect_page(\n self,\n predicate: Callable[[Page], bool] = None,\n timeout: float = None,\n ) -> EventContextManagerImpl[Page]:\n return self.expect_event(BrowserContext.Events.Page, predicate, timeout)\n\n def _on_service_worker(self, worker: Worker) -> None:\n worker._context = self\n self._service_workers.add(worker)\n self.emit(BrowserContext.Events.ServiceWorker, worker)\n\n def _on_request_failed(\n self,\n request: Request,\n response_end_timing: float,\n failure_text: Optional[str],\n page: Optional[Page],\n ) -> None:\n request._failure_text = failure_text\n request._set_response_end_timing(response_end_timing)\n self.emit(BrowserContext.Events.RequestFailed, request)\n if page:\n page.emit(Page.Events.RequestFailed, request)\n\n def _on_request_finished(\n self,\n request: Request,\n response: Optional[Response],\n response_end_timing: float,\n page: Optional[Page],\n ) -> None:\n request._set_response_end_timing(response_end_timing)\n self.emit(BrowserContext.Events.RequestFinished, request)\n if page:\n page.emit(Page.Events.RequestFinished, request)\n if response:\n response._finished_future.set_result(True)\n\n def _on_console_message(self, event: Dict) -> None:\n message = ConsoleMessage(event, self._loop, self._dispatcher_fiber)\n worker = message.worker\n if worker:\n worker.emit(Worker.Events.Console, message)\n page = message.page\n if page:\n page.emit(Page.Events.Console, message)\n self.emit(BrowserContext.Events.Console, message)\n\n def _on_dialog(self, dialog: Dialog) -> None:\n has_listeners = self.emit(BrowserContext.Events.Dialog, dialog)\n page = dialog.page\n if page:\n has_listeners = page.emit(Page.Events.Dialog, dialog) or has_listeners\n if not has_listeners:\n # Although we do similar handling on the server side, we still need this logic\n # on the client side due to a possible race condition between two async calls:\n # a) removing \"dialog\" listener subscription (client->server)\n # b) actual \"dialog\" event (server->client)\n if dialog.type == \"beforeunload\":\n asyncio.create_task(dialog.accept())\n else:\n asyncio.create_task(dialog.dismiss())\n\n def _on_page_error(self, error: Error, page: Optional[Page]) -> None:\n self.emit(\n BrowserContext.Events.WebError,\n WebError(self._loop, self._dispatcher_fiber, page, error),\n )\n if page:\n page.emit(Page.Events.PageError, error)\n\n def _on_request(self, request: Request, page: Optional[Page]) -> None:\n self.emit(BrowserContext.Events.Request, request)\n if page:\n page.emit(Page.Events.Request, request)\n\n def _on_response(self, response: Response, page: Optional[Page]) -> None:\n self.emit(BrowserContext.Events.Response, response)\n if page:\n page.emit(Page.Events.Response, response)\n\n @property\n def background_pages(self) -> List[Page]:\n return []\n\n @property\n def service_workers(self) -> List[Worker]:\n return list(self._service_workers)\n\n async def new_cdp_session(self, page: Union[Page, Frame]) -> CDPSession:\n page = to_impl(page)\n params = {}\n if isinstance(page, Page):\n params[\"page\"] = page._channel\n elif isinstance(page, Frame):\n params[\"frame\"] = page._channel\n else:\n raise Error(\"page: expected Page or Frame\")\n return from_channel(await self._channel.send(\"newCDPSession\", None, params))\n\n @property\n def tracing(self) -> Tracing:\n return self._tracing\n\n @property\n def request(self) -> \"APIRequestContext\":\n return self._request\n\n @property\n def clock(self) -> Clock:\n return self._clock\n" }, { "path": "playwright/_impl/_browser_type.py", "content": "# Copyright (c) Microsoft Corporation.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n\nimport asyncio\nimport json\nimport pathlib\nimport sys\nfrom pathlib import Path\nfrom typing import TYPE_CHECKING, Dict, List, Optional, Pattern, Sequence, Union, cast\n\nfrom playwright._impl._api_structures import (\n ClientCertificate,\n Geolocation,\n HttpCredentials,\n ProxySettings,\n ViewportSize,\n)\nfrom playwright._impl._browser import Browser\nfrom playwright._impl._browser_context import BrowserContext\nfrom playwright._impl._connection import ChannelOwner, Connection, from_channel\nfrom playwright._impl._errors import Error\nfrom playwright._impl._helper import (\n PLAYWRIGHT_MAX_DEADLINE,\n ColorScheme,\n Contrast,\n Env,\n ForcedColors,\n HarContentPolicy,\n HarMode,\n ReducedMotion,\n ServiceWorkersPolicy,\n TimeoutSettings,\n async_readfile,\n locals_to_params,\n)\nfrom playwright._impl._json_pipe import JsonPipeTransport\nfrom playwright._impl._network import serialize_headers, to_client_certificates_protocol\nfrom playwright._impl._waiter import throw_on_timeout\n\nif TYPE_CHECKING:\n from playwright._impl._playwright import Playwright\n\n\nclass BrowserType(ChannelOwner):\n def __init__(\n self, parent: ChannelOwner, type: str, guid: str, initializer: Dict\n ) -> None:\n super().__init__(parent, type, guid, initializer)\n self._playwright: \"Playwright\"\n\n def __repr__(self) -> str:\n return f\"\"\n\n @property\n def name(self) -> str:\n return self._initializer[\"name\"]\n\n @property\n def executable_path(self) -> str:\n return self._initializer[\"executablePath\"]\n\n async def launch(\n self,\n executablePath: Union[str, Path] = None,\n channel: str = None,\n args: Sequence[str] = None,\n ignoreDefaultArgs: Union[bool, Sequence[str]] = None,\n handleSIGINT: bool = None,\n handleSIGTERM: bool = None,\n handleSIGHUP: bool = None,\n timeout: float = None,\n env: Env = None,\n headless: bool = None,\n proxy: ProxySettings = None,\n downloadsPath: Union[str, Path] = None,\n slowMo: float = None,\n tracesDir: Union[pathlib.Path, str] = None,\n chromiumSandbox: bool = None,\n firefoxUserPrefs: Dict[str, Union[str, float, bool]] = None,\n ) -> Browser:\n params = locals_to_params(locals())\n normalize_launch_params(params)\n browser = cast(\n Browser,\n from_channel(\n await self._channel.send(\n \"launch\", TimeoutSettings.launch_timeout, params\n )\n ),\n )\n browser._connect_to_browser_type(\n self, str(tracesDir) if tracesDir is not None else None\n )\n return browser\n\n async def launch_persistent_context(\n self,\n userDataDir: Union[str, Path],\n channel: str = None,\n executablePath: Union[str, Path] = None,\n args: Sequence[str] = None,\n ignoreDefaultArgs: Union[bool, Sequence[str]] = None,\n handleSIGINT: bool = None,\n handleSIGTERM: bool = None,\n handleSIGHUP: bool = None,\n timeout: float = None,\n env: Env = None,\n headless: bool = None,\n proxy: ProxySettings = None,\n downloadsPath: Union[str, Path] = None,\n slowMo: float = None,\n viewport: ViewportSize = None,\n screen: ViewportSize = None,\n noViewport: bool = None,\n ignoreHTTPSErrors: bool = None,\n javaScriptEnabled: bool = None,\n bypassCSP: bool = None,\n userAgent: str = None,\n locale: str = None,\n timezoneId: str = None,\n geolocation: Geolocation = None,\n permissions: Sequence[str] = None,\n extraHTTPHeaders: Dict[str, str] = None,\n offline: bool = None,\n httpCredentials: HttpCredentials = None,\n deviceScaleFactor: float = None,\n isMobile: bool = None,\n hasTouch: bool = None,\n colorScheme: ColorScheme = None,\n reducedMotion: ReducedMotion = None,\n forcedColors: ForcedColors = None,\n contrast: Contrast = None,\n acceptDownloads: bool = None,\n tracesDir: Union[pathlib.Path, str] = None,\n chromiumSandbox: bool = None,\n firefoxUserPrefs: Dict[str, Union[str, float, bool]] = None,\n recordHarPath: Union[Path, str] = None,\n recordHarOmitContent: bool = None,\n recordVideoDir: Union[Path, str] = None,\n recordVideoSize: ViewportSize = None,\n baseURL: str = None,\n strictSelectors: bool = None,\n serviceWorkers: ServiceWorkersPolicy = None,\n recordHarUrlFilter: Union[Pattern[str], str] = None,\n recordHarMode: HarMode = None,\n recordHarContent: HarContentPolicy = None,\n clientCertificates: List[ClientCertificate] = None,\n ) -> BrowserContext:\n userDataDir = self._user_data_dir(userDataDir)\n params = locals_to_params(locals())\n await self._prepare_browser_context_params(params)\n normalize_launch_params(params)\n result = await self._channel.send_return_as_dict(\n \"launchPersistentContext\", TimeoutSettings.launch_timeout, params\n )\n browser = cast(\n Browser,\n from_channel(result[\"browser\"]),\n )\n browser._connect_to_browser_type(\n self, str(tracesDir) if tracesDir is not None else None\n )\n context = cast(BrowserContext, from_channel(result[\"context\"]))\n await context._initialize_har_from_options(\n record_har_content=recordHarContent,\n record_har_mode=recordHarMode,\n record_har_omit_content=recordHarOmitContent,\n record_har_path=recordHarPath,\n record_har_url_filter=recordHarUrlFilter,\n )\n return context\n\n def _user_data_dir(self, userDataDir: Optional[Union[str, Path]]) -> str:\n if not userDataDir:\n return \"\"\n if not Path(userDataDir).is_absolute():\n # Can be dropped once we drop Python 3.9 support (10/2025):\n # https://github.com/python/cpython/issues/82852\n if sys.platform == \"win32\" and sys.version_info[:2] < (3, 10):\n return str(pathlib.Path.cwd() / userDataDir)\n return str(Path(userDataDir).resolve())\n return str(Path(userDataDir))\n\n async def connect_over_cdp(\n self,\n endpointURL: str,\n timeout: float = None,\n slowMo: float = None,\n headers: Dict[str, str] = None,\n isLocal: bool = None,\n ) -> Browser:\n params = locals_to_params(locals())\n if params.get(\"headers\"):\n params[\"headers\"] = serialize_headers(params[\"headers\"])\n response = await self._channel.send_return_as_dict(\n \"connectOverCDP\", TimeoutSettings.launch_timeout, params\n )\n browser = cast(Browser, from_channel(response[\"browser\"]))\n browser._connect_to_browser_type(self, None)\n\n return browser\n\n async def connect(\n self,\n wsEndpoint: str,\n timeout: float = None,\n slowMo: float = None,\n headers: Dict[str, str] = None,\n exposeNetwork: str = None,\n ) -> Browser:\n if slowMo is None:\n slowMo = 0\n\n headers = {**(headers if headers else {}), \"x-playwright-browser\": self.name}\n local_utils = self._connection.local_utils\n pipe_channel = (\n await local_utils._channel.send_return_as_dict(\n \"connect\",\n None,\n {\n \"wsEndpoint\": wsEndpoint,\n \"headers\": headers,\n \"slowMo\": slowMo,\n \"timeout\": timeout if timeout is not None else 0,\n \"exposeNetwork\": exposeNetwork,\n },\n )\n )[\"pipe\"]\n transport = JsonPipeTransport(self._connection._loop, pipe_channel)\n\n connection = Connection(\n self._connection._dispatcher_fiber,\n self._connection._object_factory,\n transport,\n self._connection._loop,\n local_utils=self._connection.local_utils,\n )\n connection.mark_as_remote()\n\n browser = None\n\n def handle_transport_close(reason: Optional[str]) -> None:\n if browser:\n for context in browser.contexts:\n for page in context.pages:\n page._on_close()\n context._on_close()\n browser._on_close()\n connection.cleanup(reason)\n # TODO: Backport https://github.com/microsoft/playwright/commit/d8d5289e8692c9b1265d23ee66988d1ac5122f33\n # Give a chance to any API call promises to reject upon page/context closure.\n # This happens naturally when we receive page.onClose and browser.onClose from the server\n # in separate tasks. However, upon pipe closure we used to dispatch them all synchronously\n # here and promises did not have a chance to reject.\n # The order of rejects vs closure is a part of the API contract and our test runner\n # relies on it to attribute rejections to the right test.\n\n transport.once(\"close\", handle_transport_close)\n\n connection._is_sync = self._connection._is_sync\n connection._loop.create_task(connection.run())\n playwright_future = connection.playwright_future\n\n timeout_future = throw_on_timeout(\n timeout if timeout is not None else PLAYWRIGHT_MAX_DEADLINE,\n Error(\"Connection timed out\"),\n )\n done, pending = await asyncio.wait(\n {transport.on_error_future, playwright_future, timeout_future},\n return_when=asyncio.FIRST_COMPLETED,\n )\n if not playwright_future.done():\n playwright_future.cancel()\n if not timeout_future.done():\n timeout_future.cancel()\n playwright: \"Playwright\" = next(iter(done)).result()\n playwright._set_selectors(self._playwright.selectors)\n self._connection._child_ws_connections.append(connection)\n pre_launched_browser = playwright._initializer.get(\"preLaunchedBrowser\")\n assert pre_launched_browser\n browser = cast(Browser, from_channel(pre_launched_browser))\n browser._should_close_connection_on_close = True\n browser._connect_to_browser_type(self, None)\n\n return browser\n\n async def _prepare_browser_context_params(self, params: Dict) -> None:\n if params.get(\"noViewport\"):\n del params[\"noViewport\"]\n params[\"noDefaultViewport\"] = True\n if \"defaultBrowserType\" in params:\n del params[\"defaultBrowserType\"]\n if \"extraHTTPHeaders\" in params:\n params[\"extraHTTPHeaders\"] = serialize_headers(params[\"extraHTTPHeaders\"])\n if \"recordVideoDir\" in params:\n params[\"recordVideo\"] = {\"dir\": Path(params[\"recordVideoDir\"]).absolute()}\n if \"recordVideoSize\" in params:\n params[\"recordVideo\"][\"size\"] = params[\"recordVideoSize\"]\n del params[\"recordVideoSize\"]\n del params[\"recordVideoDir\"]\n if \"storageState\" in params:\n storageState = params[\"storageState\"]\n if not isinstance(storageState, dict):\n params[\"storageState\"] = json.loads(\n (await async_readfile(storageState)).decode()\n )\n if params.get(\"colorScheme\", None) == \"null\":\n params[\"colorScheme\"] = \"no-override\"\n if params.get(\"reducedMotion\", None) == \"null\":\n params[\"reducedMotion\"] = \"no-override\"\n if params.get(\"forcedColors\", None) == \"null\":\n params[\"forcedColors\"] = \"no-override\"\n if params.get(\"contrast\", None) == \"null\":\n params[\"contrast\"] = \"no-override\"\n if \"acceptDownloads\" in params:\n params[\"acceptDownloads\"] = (\n \"accept\" if params[\"acceptDownloads\"] else \"deny\"\n )\n\n if \"clientCertificates\" in params:\n params[\"clientCertificates\"] = await to_client_certificates_protocol(\n params[\"clientCertificates\"]\n )\n params[\"selectorEngines\"] = self._playwright.selectors._selector_engines\n params[\"testIdAttributeName\"] = (\n self._playwright.selectors._test_id_attribute_name\n )\n\n # Remove HAR options\n params.pop(\"recordHarPath\", None)\n params.pop(\"recordHarOmitContent\", None)\n params.pop(\"recordHarUrlFilter\", None)\n params.pop(\"recordHarMode\", None)\n params.pop(\"recordHarContent\", None)\n\n\ndef normalize_launch_params(params: Dict) -> None:\n if \"env\" in params:\n params[\"env\"] = [\n {\"name\": name, \"value\": str(value)}\n for [name, value] in params[\"env\"].items()\n ]\n if \"ignoreDefaultArgs\" in params:\n if params[\"ignoreDefaultArgs\"] is True:\n params[\"ignoreAllDefaultArgs\"] = True\n del params[\"ignoreDefaultArgs\"]\n if \"executablePath\" in params:\n params[\"executablePath\"] = str(Path(params[\"executablePath\"]))\n if \"downloadsPath\" in params:\n params[\"downloadsPath\"] = str(Path(params[\"downloadsPath\"]))\n if \"tracesDir\" in params:\n params[\"tracesDir\"] = str(Path(params[\"tracesDir\"]))\n" }, { "path": "playwright/_impl/_cdp_session.py", "content": "# Copyright (c) Microsoft Corporation.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n\nfrom typing import Any, Dict\n\nfrom playwright._impl._connection import ChannelOwner\nfrom playwright._impl._helper import locals_to_params\n\n\nclass CDPSession(ChannelOwner):\n def __init__(\n self, parent: ChannelOwner, type: str, guid: str, initializer: Dict\n ) -> None:\n super().__init__(parent, type, guid, initializer)\n self._channel.on(\"event\", lambda params: self._on_event(params))\n\n def _on_event(self, params: Any) -> None:\n self.emit(params[\"method\"], params.get(\"params\"))\n\n async def send(self, method: str, params: Dict = None) -> Dict:\n return await self._channel.send(\"send\", None, locals_to_params(locals()))\n\n async def detach(self) -> None:\n await self._channel.send(\n \"detach\",\n None,\n )\n" }, { "path": "playwright/_impl/_clock.py", "content": "# Copyright (c) Microsoft Corporation.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n\nimport datetime\nfrom typing import TYPE_CHECKING, Dict, Union\n\nif TYPE_CHECKING:\n from playwright._impl._browser_context import BrowserContext\n\n\nclass Clock:\n def __init__(self, browser_context: \"BrowserContext\") -> None:\n self._browser_context = browser_context\n self._loop = browser_context._loop\n self._dispatcher_fiber = browser_context._dispatcher_fiber\n\n async def install(self, time: Union[float, str, datetime.datetime] = None) -> None:\n await self._browser_context._channel.send(\n \"clockInstall\",\n None,\n parse_time(time) if time is not None else {},\n )\n\n async def fast_forward(\n self,\n ticks: Union[int, str],\n ) -> None:\n await self._browser_context._channel.send(\n \"clockFastForward\",\n None,\n parse_ticks(ticks),\n )\n\n async def pause_at(\n self,\n time: Union[float, str, datetime.datetime],\n ) -> None:\n await self._browser_context._channel.send(\n \"clockPauseAt\",\n None,\n parse_time(time),\n )\n\n async def resume(\n self,\n ) -> None:\n await self._browser_context._channel.send(\"clockResume\", None)\n\n async def run_for(\n self,\n ticks: Union[int, str],\n ) -> None:\n await self._browser_context._channel.send(\n \"clockRunFor\",\n None,\n parse_ticks(ticks),\n )\n\n async def set_fixed_time(\n self,\n time: Union[float, str, datetime.datetime],\n ) -> None:\n await self._browser_context._channel.send(\n \"clockSetFixedTime\",\n None,\n parse_time(time),\n )\n\n async def set_system_time(\n self,\n time: Union[float, str, datetime.datetime],\n ) -> None:\n await self._browser_context._channel.send(\n \"clockSetSystemTime\",\n None,\n parse_time(time),\n )\n\n\ndef parse_time(\n time: Union[float, str, datetime.datetime],\n) -> Dict[str, Union[int, str]]:\n if isinstance(time, (float, int)):\n return {\"timeNumber\": int(time * 1_000)}\n if isinstance(time, str):\n return {\"timeString\": time}\n return {\"timeNumber\": int(time.timestamp() * 1_000)}\n\n\ndef parse_ticks(ticks: Union[int, str]) -> Dict[str, Union[int, str]]:\n if isinstance(ticks, int):\n return {\"ticksNumber\": ticks}\n return {\"ticksString\": ticks}\n" }, { "path": "playwright/_impl/_connection.py", "content": "# Copyright (c) Microsoft Corporation.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n\nimport asyncio\nimport collections.abc\nimport contextvars\nimport datetime\nimport inspect\nimport sys\nimport traceback\nfrom pathlib import Path\nfrom typing import (\n TYPE_CHECKING,\n Any,\n Callable,\n Dict,\n List,\n Mapping,\n Optional,\n TypedDict,\n Union,\n cast,\n)\n\nfrom pyee import EventEmitter\nfrom pyee.asyncio import AsyncIOEventEmitter\n\nimport playwright\nimport playwright._impl._impl_to_api_mapping\nfrom playwright._impl._errors import TargetClosedError, rewrite_error\nfrom playwright._impl._greenlets import EventGreenlet\nfrom playwright._impl._helper import Error, ParsedMessagePayload, parse_error\nfrom playwright._impl._transport import Transport\n\nif TYPE_CHECKING:\n from playwright._impl._local_utils import LocalUtils\n from playwright._impl._playwright import Playwright\n\nTimeoutCalculator = Optional[Callable[[Optional[float]], float]]\n\n\nclass Channel(AsyncIOEventEmitter):\n def __init__(self, connection: \"Connection\", object: \"ChannelOwner\") -> None:\n super().__init__()\n self._connection = connection\n self._guid = object._guid\n self._object = object\n self.on(\"error\", lambda exc: self._connection._on_event_listener_error(exc))\n\n async def send(\n self,\n method: str,\n timeout_calculator: TimeoutCalculator,\n params: Dict = None,\n is_internal: bool = False,\n title: str = None,\n ) -> Any:\n return await self._connection.wrap_api_call(\n lambda: self._inner_send(method, timeout_calculator, params, False),\n is_internal,\n title,\n )\n\n async def send_return_as_dict(\n self,\n method: str,\n timeout_calculator: TimeoutCalculator,\n params: Dict = None,\n is_internal: bool = False,\n title: str = None,\n ) -> Any:\n return await self._connection.wrap_api_call(\n lambda: self._inner_send(method, timeout_calculator, params, True),\n is_internal,\n title,\n )\n\n def send_no_reply(\n self,\n method: str,\n timeout_calculator: TimeoutCalculator,\n params: Dict = None,\n is_internal: bool = False,\n title: str = None,\n ) -> None:\n # No reply messages are used to e.g. waitForEventInfo(after).\n self._connection.wrap_api_call_sync(\n lambda: self._connection._send_message_to_server(\n self._object,\n method,\n _augment_params(params, timeout_calculator),\n True,\n ),\n is_internal,\n title,\n )\n\n async def _inner_send(\n self,\n method: str,\n timeout_calculator: TimeoutCalculator,\n params: Optional[Dict],\n return_as_dict: bool,\n ) -> Any:\n if self._connection._error:\n error = self._connection._error\n self._connection._error = None\n raise error\n callback = self._connection._send_message_to_server(\n self._object, method, _augment_params(params, timeout_calculator)\n )\n done, _ = await asyncio.wait(\n {\n self._connection._transport.on_error_future,\n callback.future,\n },\n return_when=asyncio.FIRST_COMPLETED,\n )\n if not callback.future.done():\n callback.future.cancel()\n result = next(iter(done)).result()\n # Protocol now has named return values, assume result is one level deeper unless\n # there is explicit ambiguity.\n if not result:\n return None\n assert isinstance(result, dict)\n if return_as_dict:\n return result\n if len(result) == 0:\n return None\n assert len(result) == 1\n key = next(iter(result))\n return result[key]\n\n\nclass ChannelOwner(AsyncIOEventEmitter):\n def __init__(\n self,\n parent: Union[\"ChannelOwner\", \"Connection\"],\n type: str,\n guid: str,\n initializer: Dict,\n ) -> None:\n super().__init__(loop=parent._loop)\n self._loop: asyncio.AbstractEventLoop = parent._loop\n self._dispatcher_fiber: Any = parent._dispatcher_fiber\n self._type = type\n self._guid: str = guid\n self._connection: Connection = (\n parent._connection if isinstance(parent, ChannelOwner) else parent\n )\n self._parent: Optional[ChannelOwner] = (\n parent if isinstance(parent, ChannelOwner) else None\n )\n self._objects: Dict[str, \"ChannelOwner\"] = {}\n self._channel: Channel = Channel(self._connection, self)\n self._initializer = initializer\n self._was_collected = False\n\n self._connection._objects[guid] = self\n if self._parent:\n self._parent._objects[guid] = self\n\n self._event_to_subscription_mapping: Dict[str, str] = {}\n\n def _dispose(self, reason: Optional[str]) -> None:\n # Clean up from parent and connection.\n if self._parent:\n del self._parent._objects[self._guid]\n del self._connection._objects[self._guid]\n self._was_collected = reason == \"gc\"\n\n # Dispose all children.\n for object in list(self._objects.values()):\n object._dispose(reason)\n self._objects.clear()\n\n def _adopt(self, child: \"ChannelOwner\") -> None:\n del cast(\"ChannelOwner\", child._parent)._objects[child._guid]\n self._objects[child._guid] = child\n child._parent = self\n\n def _set_event_to_subscription_mapping(self, mapping: Dict[str, str]) -> None:\n self._event_to_subscription_mapping = mapping\n\n def _update_subscription(self, event: str, enabled: bool) -> None:\n protocol_event = self._event_to_subscription_mapping.get(event)\n if protocol_event:\n self._connection.wrap_api_call_sync(\n lambda: self._channel.send_no_reply(\n \"updateSubscription\",\n None,\n {\"event\": protocol_event, \"enabled\": enabled},\n ),\n True,\n )\n\n def _add_event_handler(self, event: str, k: Any, v: Any) -> None:\n if not self.listeners(event):\n self._update_subscription(event, True)\n super()._add_event_handler(event, k, v)\n\n def remove_listener(self, event: str, f: Any) -> None:\n super().remove_listener(event, f)\n if not self.listeners(event):\n self._update_subscription(event, False)\n\n\nclass ProtocolCallback:\n def __init__(self, loop: asyncio.AbstractEventLoop, no_reply: bool = False) -> None:\n self.stack_trace: traceback.StackSummary\n self.no_reply = no_reply\n self.future = loop.create_future()\n if no_reply:\n self.future.set_result(None)\n # The outer task can get cancelled by the user, this forwards the cancellation to the inner task.\n current_task = asyncio.current_task()\n\n def cb(task: asyncio.Task) -> None:\n if current_task:\n current_task.remove_done_callback(cb)\n if task.cancelled():\n self.future.cancel()\n\n if current_task:\n current_task.add_done_callback(cb)\n self.future.add_done_callback(\n lambda _: (\n current_task.remove_done_callback(cb) if current_task else None\n )\n )\n\n\nclass RootChannelOwner(ChannelOwner):\n def __init__(self, connection: \"Connection\") -> None:\n super().__init__(connection, \"Root\", \"\", {})\n\n async def initialize(self) -> \"Playwright\":\n return from_channel(\n await self._channel.send(\n \"initialize\",\n None,\n {\n \"sdkLanguage\": \"python\",\n },\n )\n )\n\n\nclass Connection(EventEmitter):\n def __init__(\n self,\n dispatcher_fiber: Any,\n object_factory: Callable[[ChannelOwner, str, str, Dict], ChannelOwner],\n transport: Transport,\n loop: asyncio.AbstractEventLoop,\n local_utils: Optional[\"LocalUtils\"] = None,\n ) -> None:\n super().__init__()\n self._dispatcher_fiber = dispatcher_fiber\n self._transport = transport\n self._transport.on_message = lambda msg: self.dispatch(msg)\n self._waiting_for_object: Dict[str, Callable[[ChannelOwner], None]] = {}\n self._last_id = 0\n self._objects: Dict[str, ChannelOwner] = {}\n self._callbacks: Dict[int, ProtocolCallback] = {}\n self._object_factory = object_factory\n self._is_sync = False\n self._child_ws_connections: List[\"Connection\"] = []\n self._loop = loop\n self.playwright_future: asyncio.Future[\"Playwright\"] = loop.create_future()\n self._error: Optional[BaseException] = None\n self.is_remote = False\n self._init_task: Optional[asyncio.Task] = None\n self._api_zone: contextvars.ContextVar[Optional[ParsedStackTrace]] = (\n contextvars.ContextVar(\"ApiZone\", default=None)\n )\n self._local_utils: Optional[\"LocalUtils\"] = local_utils\n self._tracing_count = 0\n self._closed_error: Optional[Exception] = None\n\n @property\n def local_utils(self) -> \"LocalUtils\":\n assert self._local_utils\n return self._local_utils\n\n def mark_as_remote(self) -> None:\n self.is_remote = True\n\n async def run_as_sync(self) -> None:\n self._is_sync = True\n await self.run()\n\n async def run(self) -> None:\n self._loop = asyncio.get_running_loop()\n self._root_object = RootChannelOwner(self)\n\n async def init() -> None:\n self.playwright_future.set_result(await self._root_object.initialize())\n\n await self._transport.connect()\n self._init_task = self._loop.create_task(init())\n await self._transport.run()\n\n def stop_sync(self) -> None:\n self._transport.request_stop()\n self._dispatcher_fiber.switch()\n self._loop.run_until_complete(self._transport.wait_until_stopped())\n self.cleanup()\n\n async def stop_async(self) -> None:\n self._transport.request_stop()\n await self._transport.wait_until_stopped()\n self.cleanup()\n\n def cleanup(self, cause: str = None) -> None:\n self._closed_error = TargetClosedError(cause) if cause else TargetClosedError()\n if self._init_task and not self._init_task.done():\n self._init_task.cancel()\n for ws_connection in self._child_ws_connections:\n ws_connection._transport.dispose()\n for callback in self._callbacks.values():\n # To prevent 'Future exception was never retrieved' we ignore all callbacks that are no_reply.\n if callback.no_reply:\n continue\n if callback.future.cancelled():\n continue\n callback.future.set_exception(self._closed_error)\n self._callbacks.clear()\n self.emit(\"close\")\n\n def call_on_object_with_known_name(\n self, guid: str, callback: Callable[[ChannelOwner], None]\n ) -> None:\n self._waiting_for_object[guid] = callback\n\n def set_is_tracing(self, is_tracing: bool) -> None:\n if is_tracing:\n self._tracing_count += 1\n else:\n self._tracing_count -= 1\n\n def _send_message_to_server(\n self, object: ChannelOwner, method: str, params: Dict, no_reply: bool = False\n ) -> ProtocolCallback:\n if self._closed_error:\n raise self._closed_error\n if object._was_collected:\n raise Error(\n \"The object has been collected to prevent unbounded heap growth.\"\n )\n self._last_id += 1\n id = self._last_id\n callback = ProtocolCallback(self._loop, no_reply=no_reply)\n task = asyncio.current_task(self._loop)\n callback.stack_trace = cast(\n traceback.StackSummary,\n getattr(task, \"__pw_stack_trace__\", traceback.extract_stack(limit=10)),\n )\n callback.no_reply = no_reply\n stack_trace_information = cast(ParsedStackTrace, self._api_zone.get())\n frames = stack_trace_information.get(\"frames\", [])\n location = (\n {\n \"file\": frames[0][\"file\"],\n \"line\": frames[0][\"line\"],\n \"column\": frames[0][\"column\"],\n }\n if frames\n else None\n )\n metadata = {\n \"wallTime\": int(datetime.datetime.now().timestamp() * 1000),\n \"apiName\": stack_trace_information[\"apiName\"],\n \"internal\": not stack_trace_information[\"apiName\"],\n }\n if location:\n metadata[\"location\"] = location # type: ignore\n title = stack_trace_information[\"title\"]\n if title:\n metadata[\"title\"] = title\n message = {\n \"id\": id,\n \"guid\": object._guid,\n \"method\": method,\n \"params\": self._replace_channels_with_guids(params),\n \"metadata\": metadata,\n }\n if self._tracing_count > 0 and frames and object._guid != \"localUtils\":\n self.local_utils.add_stack_to_tracing_no_reply(id, frames)\n\n self._callbacks[id] = callback\n self._transport.send(message)\n\n return callback\n\n def dispatch(self, msg: ParsedMessagePayload) -> None:\n if self._closed_error:\n return\n id = msg.get(\"id\")\n if id:\n callback = self._callbacks.pop(id)\n if callback.future.cancelled():\n return\n # No reply messages are used to e.g. waitForEventInfo(after) which returns exceptions on page close.\n # To prevent 'Future exception was never retrieved' we just ignore such messages.\n if callback.no_reply:\n return\n error = msg.get(\"error\")\n if error and not msg.get(\"result\"):\n parsed_error = parse_error(\n error[\"error\"], format_call_log(msg.get(\"log\")) # type: ignore\n )\n parsed_error._stack = \"\".join(callback.stack_trace.format())\n callback.future.set_exception(parsed_error)\n else:\n result = self._replace_guids_with_channels(msg.get(\"result\"))\n callback.future.set_result(result)\n return\n\n guid = msg[\"guid\"]\n method = msg[\"method\"]\n params = msg.get(\"params\")\n if method == \"__create__\":\n assert params\n parent = self._objects[guid]\n self._create_remote_object(\n parent, params[\"type\"], params[\"guid\"], params[\"initializer\"]\n )\n return\n\n object = self._objects.get(guid)\n if not object:\n raise Exception(f'Cannot find object to \"{method}\": {guid}')\n\n if method == \"__adopt__\":\n child_guid = cast(Dict[str, str], params)[\"guid\"]\n child = self._objects.get(child_guid)\n if not child:\n raise Exception(f\"Unknown new child: {child_guid}\")\n object._adopt(child)\n return\n\n if method == \"__dispose__\":\n assert isinstance(params, dict)\n self._objects[guid]._dispose(cast(Optional[str], params.get(\"reason\")))\n return\n object = self._objects[guid]\n should_replace_guids_with_channels = \"jsonPipe@\" not in guid\n try:\n if self._is_sync:\n for listener in object._channel.listeners(method):\n # Event handlers like route/locatorHandlerTriggered require us to perform async work.\n # In order to report their potential errors to the user, we need to catch it and store it in the connection\n def _done_callback(future: asyncio.Future) -> None:\n exc = future.exception()\n if exc:\n self._on_event_listener_error(exc)\n\n def _listener_with_error_handler_attached(params: Any) -> None:\n potential_future = listener(params)\n if asyncio.isfuture(potential_future):\n potential_future.add_done_callback(_done_callback)\n\n # Each event handler is a potentilly blocking context, create a fiber for each\n # and switch to them in order, until they block inside and pass control to each\n # other and then eventually back to dispatcher as listener functions return.\n g = EventGreenlet(_listener_with_error_handler_attached)\n if should_replace_guids_with_channels:\n g.switch(self._replace_guids_with_channels(params))\n else:\n g.switch(params)\n else:\n if should_replace_guids_with_channels:\n object._channel.emit(\n method, self._replace_guids_with_channels(params)\n )\n else:\n object._channel.emit(method, params)\n except BaseException as exc:\n self._on_event_listener_error(exc)\n\n def _on_event_listener_error(self, exc: BaseException) -> None:\n print(\"Error occurred in event listener\", file=sys.stderr)\n traceback.print_exception(type(exc), exc, exc.__traceback__, file=sys.stderr)\n # Save the error to throw at the next API call. This \"replicates\" unhandled rejection in Node.js.\n self._error = exc\n\n def _create_remote_object(\n self, parent: ChannelOwner, type: str, guid: str, initializer: Dict\n ) -> ChannelOwner:\n initializer = self._replace_guids_with_channels(initializer)\n result = self._object_factory(parent, type, guid, initializer)\n if guid in self._waiting_for_object:\n self._waiting_for_object.pop(guid)(result)\n return result\n\n def _replace_channels_with_guids(\n self,\n payload: Any,\n ) -> Any:\n if payload is None:\n return payload\n if isinstance(payload, Path):\n return str(payload)\n if isinstance(payload, collections.abc.Sequence) and not isinstance(\n payload, str\n ):\n return list(map(self._replace_channels_with_guids, payload))\n if isinstance(payload, Channel):\n return dict(guid=payload._guid)\n if isinstance(payload, dict):\n result = {}\n for key, value in payload.items():\n result[key] = self._replace_channels_with_guids(value)\n return result\n return payload\n\n def _replace_guids_with_channels(self, payload: Any) -> Any:\n if payload is None:\n return payload\n if isinstance(payload, list):\n return list(map(self._replace_guids_with_channels, payload))\n if isinstance(payload, dict):\n if payload.get(\"guid\") in self._objects:\n return self._objects[payload[\"guid\"]]._channel\n result = {}\n for key, value in payload.items():\n result[key] = self._replace_guids_with_channels(value)\n return result\n return payload\n\n async def wrap_api_call(\n self, cb: Callable[[], Any], is_internal: bool = False, title: str = None\n ) -> Any:\n if self._api_zone.get():\n return await cb()\n task = asyncio.current_task(self._loop)\n st: List[inspect.FrameInfo] = getattr(\n task, \"__pw_stack__\", None\n ) or inspect.stack(0)\n\n parsed_st = _extract_stack_trace_information_from_stack(st, is_internal, title)\n self._api_zone.set(parsed_st)\n try:\n return await cb()\n except Exception as error:\n raise rewrite_error(error, f\"{parsed_st['apiName']}: {error}\") from None\n finally:\n self._api_zone.set(None)\n\n def wrap_api_call_sync(\n self, cb: Callable[[], Any], is_internal: bool = False, title: str = None\n ) -> Any:\n if self._api_zone.get():\n return cb()\n task = asyncio.current_task(self._loop)\n st: List[inspect.FrameInfo] = getattr(\n task, \"__pw_stack__\", None\n ) or inspect.stack(0)\n parsed_st = _extract_stack_trace_information_from_stack(st, is_internal, title)\n self._api_zone.set(parsed_st)\n try:\n return cb()\n except Exception as error:\n raise rewrite_error(error, f\"{parsed_st['apiName']}: {error}\") from None\n finally:\n self._api_zone.set(None)\n\n\ndef from_channel(channel: Channel) -> Any:\n return channel._object\n\n\ndef from_nullable_channel(channel: Optional[Channel]) -> Optional[Any]:\n return channel._object if channel else None\n\n\nclass StackFrame(TypedDict):\n file: str\n line: int\n column: int\n function: Optional[str]\n\n\nclass ParsedStackTrace(TypedDict):\n frames: List[StackFrame]\n apiName: Optional[str]\n title: Optional[str]\n\n\ndef _extract_stack_trace_information_from_stack(\n st: List[inspect.FrameInfo], is_internal: bool, title: str = None\n) -> ParsedStackTrace:\n playwright_module_path = str(Path(playwright.__file__).parents[0])\n last_internal_api_name = \"\"\n api_name = \"\"\n parsed_frames: List[StackFrame] = []\n for frame in st:\n # Sync and Async implementations can have event handlers. When these are sync, they\n # get evaluated in the context of the event loop, so they contain the stack trace of when\n # the message was received. _impl_to_api_mapping is glue between the user-code and internal\n # code to translate impl classes to api classes. We want to ignore these frames.\n if playwright._impl._impl_to_api_mapping.__file__ == frame.filename:\n continue\n is_playwright_internal = frame.filename.startswith(playwright_module_path)\n\n method_name = \"\"\n if \"self\" in frame[0].f_locals:\n method_name = frame[0].f_locals[\"self\"].__class__.__name__ + \".\"\n method_name += frame[0].f_code.co_name\n\n if not is_playwright_internal:\n parsed_frames.append(\n {\n \"file\": frame.filename,\n \"line\": frame.lineno,\n \"column\": 0,\n \"function\": method_name,\n }\n )\n if is_playwright_internal:\n last_internal_api_name = method_name\n elif last_internal_api_name:\n api_name = last_internal_api_name\n last_internal_api_name = \"\"\n if not api_name:\n api_name = last_internal_api_name\n\n return {\n \"frames\": parsed_frames,\n \"apiName\": \"\" if is_internal else api_name,\n \"title\": title,\n }\n\n\ndef _augment_params(\n params: Optional[Dict],\n timeout_calculator: Optional[Callable[[Optional[float]], float]],\n) -> Dict:\n if params is None:\n params = {}\n if timeout_calculator:\n params[\"timeout\"] = timeout_calculator(params.get(\"timeout\"))\n return _filter_none(params)\n\n\ndef _filter_none(d: Mapping) -> Dict:\n result = {}\n for k, v in d.items():\n if v is None:\n continue\n result[k] = _filter_none(v) if isinstance(v, dict) else v\n return result\n\n\ndef format_call_log(log: Optional[List[str]]) -> str:\n if not log:\n return \"\"\n if len(list(filter(lambda x: x.strip(), log))) == 0:\n return \"\"\n return \"\\nCall log:\\n\" + \"\\n\".join(log) + \"\\n\"\n" }, { "path": "playwright/_impl/_console_message.py", "content": "# Copyright (c) Microsoft Corporation.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n\nfrom asyncio import AbstractEventLoop\nfrom typing import TYPE_CHECKING, Any, Dict, List, Literal, Optional, Union\n\nfrom playwright._impl._api_structures import SourceLocation\nfrom playwright._impl._connection import from_channel, from_nullable_channel\nfrom playwright._impl._js_handle import JSHandle\n\nif TYPE_CHECKING: # pragma: no cover\n from playwright._impl._page import Page\n from playwright._impl._worker import Worker\n\n\nclass ConsoleMessage:\n def __init__(\n self, event: Dict, loop: AbstractEventLoop, dispatcher_fiber: Any\n ) -> None:\n self._event = event\n self._loop = loop\n self._dispatcher_fiber = dispatcher_fiber\n self._page: Optional[\"Page\"] = from_nullable_channel(event.get(\"page\"))\n self._worker: Optional[\"Worker\"] = from_nullable_channel(event.get(\"worker\"))\n\n def __repr__(self) -> str:\n return f\"\"\n\n def __str__(self) -> str:\n return self.text\n\n @property\n def type(self) -> Union[\n Literal[\"assert\"],\n Literal[\"clear\"],\n Literal[\"count\"],\n Literal[\"debug\"],\n Literal[\"dir\"],\n Literal[\"dirxml\"],\n Literal[\"endGroup\"],\n Literal[\"error\"],\n Literal[\"info\"],\n Literal[\"log\"],\n Literal[\"profile\"],\n Literal[\"profileEnd\"],\n Literal[\"startGroup\"],\n Literal[\"startGroupCollapsed\"],\n Literal[\"table\"],\n Literal[\"time\"],\n Literal[\"timeEnd\"],\n Literal[\"trace\"],\n Literal[\"warning\"],\n ]:\n return self._event[\"type\"]\n\n @property\n def text(self) -> str:\n return self._event[\"text\"]\n\n @property\n def args(self) -> List[JSHandle]:\n return list(map(from_channel, self._event[\"args\"]))\n\n @property\n def location(self) -> SourceLocation:\n return self._event[\"location\"]\n\n @property\n def page(self) -> Optional[\"Page\"]:\n return self._page\n\n @property\n def worker(self) -> Optional[\"Worker\"]:\n return self._worker\n" }, { "path": "playwright/_impl/_dialog.py", "content": "# Copyright (c) Microsoft Corporation.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n\nfrom typing import TYPE_CHECKING, Dict, Optional\n\nfrom playwright._impl._connection import ChannelOwner, from_nullable_channel\nfrom playwright._impl._helper import locals_to_params\n\nif TYPE_CHECKING: # pragma: no cover\n from playwright._impl._page import Page\n\n\nclass Dialog(ChannelOwner):\n def __init__(\n self, parent: ChannelOwner, type: str, guid: str, initializer: Dict\n ) -> None:\n super().__init__(parent, type, guid, initializer)\n self._page: Optional[\"Page\"] = from_nullable_channel(initializer.get(\"page\"))\n\n def __repr__(self) -> str:\n return f\"\"\n\n @property\n def type(self) -> str:\n return self._initializer[\"type\"]\n\n @property\n def message(self) -> str:\n return self._initializer[\"message\"]\n\n @property\n def default_value(self) -> str:\n return self._initializer[\"defaultValue\"]\n\n @property\n def page(self) -> Optional[\"Page\"]:\n return self._page\n\n async def accept(self, promptText: str = None) -> None:\n await self._channel.send(\"accept\", None, locals_to_params(locals()))\n\n async def dismiss(self) -> None:\n await self._channel.send(\n \"dismiss\",\n None,\n )\n" }, { "path": "playwright/_impl/_download.py", "content": "# Copyright (c) Microsoft Corporation.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n\nimport pathlib\nfrom pathlib import Path\nfrom typing import TYPE_CHECKING, Optional, Union\n\nfrom playwright._impl._artifact import Artifact\n\nif TYPE_CHECKING: # pragma: no cover\n from playwright._impl._page import Page\n\n\nclass Download:\n def __init__(\n self, page: \"Page\", url: str, suggested_filename: str, artifact: Artifact\n ) -> None:\n self._page = page\n self._loop = page._loop\n self._dispatcher_fiber = page._dispatcher_fiber\n self._url = url\n self._suggested_filename = suggested_filename\n self._artifact = artifact\n\n def __repr__(self) -> str:\n return f\"\"\n\n @property\n def page(self) -> \"Page\":\n return self._page\n\n @property\n def url(self) -> str:\n return self._url\n\n @property\n def suggested_filename(self) -> str:\n return self._suggested_filename\n\n async def delete(self) -> None:\n await self._artifact.delete()\n\n async def failure(self) -> Optional[str]:\n return await self._artifact.failure()\n\n async def path(self) -> pathlib.Path:\n return await self._artifact.path_after_finished()\n\n async def save_as(self, path: Union[str, Path]) -> None:\n await self._artifact.save_as(path)\n\n async def cancel(self) -> None:\n return await self._artifact.cancel()\n" }, { "path": "playwright/_impl/_driver.py", "content": "# Copyright (c) Microsoft Corporation.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n\nimport inspect\nimport os\nimport sys\nfrom pathlib import Path\nfrom typing import Tuple\n\nimport playwright\nfrom playwright._repo_version import version\n\n\ndef compute_driver_executable() -> Tuple[str, str]:\n driver_path = Path(inspect.getfile(playwright)).parent / \"driver\"\n cli_path = str(driver_path / \"package\" / \"cli.js\")\n if sys.platform == \"win32\":\n return (\n os.getenv(\"PLAYWRIGHT_NODEJS_PATH\", str(driver_path / \"node.exe\")),\n cli_path,\n )\n return (os.getenv(\"PLAYWRIGHT_NODEJS_PATH\", str(driver_path / \"node\")), cli_path)\n\n\ndef get_driver_env() -> dict:\n env = os.environ.copy()\n env[\"PW_LANG_NAME\"] = \"python\"\n env[\"PW_LANG_NAME_VERSION\"] = f\"{sys.version_info.major}.{sys.version_info.minor}\"\n env[\"PW_CLI_DISPLAY_VERSION\"] = version\n return env\n" }, { "path": "playwright/_impl/_element_handle.py", "content": "# Copyright (c) Microsoft Corporation.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n\nimport base64\nimport mimetypes\nfrom pathlib import Path\nfrom typing import (\n TYPE_CHECKING,\n Any,\n Callable,\n Dict,\n List,\n Literal,\n Optional,\n Sequence,\n Union,\n cast,\n)\n\nfrom playwright._impl._api_structures import FilePayload, FloatRect, Position\nfrom playwright._impl._connection import ChannelOwner, from_nullable_channel\nfrom playwright._impl._helper import (\n Error,\n KeyboardModifier,\n MouseButton,\n async_writefile,\n locals_to_params,\n make_dirs_for_file,\n)\nfrom playwright._impl._js_handle import (\n JSHandle,\n Serializable,\n parse_result,\n serialize_argument,\n)\nfrom playwright._impl._set_input_files_helpers import convert_input_files\n\nif TYPE_CHECKING: # pragma: no cover\n from playwright._impl._frame import Frame\n from playwright._impl._locator import Locator\n\n\nclass ElementHandle(JSHandle):\n def __init__(\n self, parent: ChannelOwner, type: str, guid: str, initializer: Dict\n ) -> None:\n super().__init__(parent, type, guid, initializer)\n self._frame = cast(\"Frame\", parent)\n\n async def _createSelectorForTest(self, name: str) -> Optional[str]:\n return await self._channel.send(\n \"createSelectorForTest\", self._frame._timeout, dict(name=name)\n )\n\n def as_element(self) -> Optional[\"ElementHandle\"]:\n return self\n\n async def owner_frame(self) -> Optional[\"Frame\"]:\n return from_nullable_channel(await self._channel.send(\"ownerFrame\", None))\n\n async def content_frame(self) -> Optional[\"Frame\"]:\n return from_nullable_channel(await self._channel.send(\"contentFrame\", None))\n\n async def get_attribute(self, name: str) -> Optional[str]:\n return await self._channel.send(\"getAttribute\", None, dict(name=name))\n\n async def text_content(self) -> Optional[str]:\n return await self._channel.send(\"textContent\", None)\n\n async def inner_text(self) -> str:\n return await self._channel.send(\"innerText\", None)\n\n async def inner_html(self) -> str:\n return await self._channel.send(\"innerHTML\", None)\n\n async def is_checked(self) -> bool:\n return await self._channel.send(\"isChecked\", None)\n\n async def is_disabled(self) -> bool:\n return await self._channel.send(\"isDisabled\", None)\n\n async def is_editable(self) -> bool:\n return await self._channel.send(\"isEditable\", None)\n\n async def is_enabled(self) -> bool:\n return await self._channel.send(\"isEnabled\", None)\n\n async def is_hidden(self) -> bool:\n return await self._channel.send(\"isHidden\", None)\n\n async def is_visible(self) -> bool:\n return await self._channel.send(\"isVisible\", None)\n\n async def dispatch_event(self, type: str, eventInit: Dict = None) -> None:\n await self._channel.send(\n \"dispatchEvent\",\n None,\n dict(type=type, eventInit=serialize_argument(eventInit)),\n )\n\n async def scroll_into_view_if_needed(self, timeout: float = None) -> None:\n await self._channel.send(\n \"scrollIntoViewIfNeeded\", self._frame._timeout, locals_to_params(locals())\n )\n\n async def hover(\n self,\n modifiers: Sequence[KeyboardModifier] = None,\n position: Position = None,\n timeout: float = None,\n noWaitAfter: bool = None,\n force: bool = None,\n trial: bool = None,\n ) -> None:\n await self._channel.send(\n \"hover\", self._frame._timeout, locals_to_params(locals())\n )\n\n async def click(\n self,\n modifiers: Sequence[KeyboardModifier] = None,\n position: Position = None,\n delay: float = None,\n button: MouseButton = None,\n clickCount: int = None,\n timeout: float = None,\n force: bool = None,\n noWaitAfter: bool = None,\n trial: bool = None,\n steps: int = None,\n ) -> None:\n await self._channel.send(\n \"click\", self._frame._timeout, locals_to_params(locals())\n )\n\n async def dblclick(\n self,\n modifiers: Sequence[KeyboardModifier] = None,\n position: Position = None,\n delay: float = None,\n button: MouseButton = None,\n timeout: float = None,\n force: bool = None,\n noWaitAfter: bool = None,\n trial: bool = None,\n steps: int = None,\n ) -> None:\n await self._channel.send(\n \"dblclick\", self._frame._timeout, locals_to_params(locals())\n )\n\n async def select_option(\n self,\n value: Union[str, Sequence[str]] = None,\n index: Union[int, Sequence[int]] = None,\n label: Union[str, Sequence[str]] = None,\n element: Union[\"ElementHandle\", Sequence[\"ElementHandle\"]] = None,\n timeout: float = None,\n force: bool = None,\n noWaitAfter: bool = None,\n ) -> List[str]:\n params = locals_to_params(\n dict(\n timeout=timeout,\n force=force,\n **convert_select_option_values(value, index, label, element),\n )\n )\n return await self._channel.send(\"selectOption\", self._frame._timeout, params)\n\n async def tap(\n self,\n modifiers: Sequence[KeyboardModifier] = None,\n position: Position = None,\n timeout: float = None,\n force: bool = None,\n noWaitAfter: bool = None,\n trial: bool = None,\n ) -> None:\n await self._channel.send(\n \"tap\", self._frame._timeout, locals_to_params(locals())\n )\n\n async def fill(\n self,\n value: str,\n timeout: float = None,\n noWaitAfter: bool = None,\n force: bool = None,\n ) -> None:\n await self._channel.send(\n \"fill\", self._frame._timeout, locals_to_params(locals())\n )\n\n async def select_text(self, force: bool = None, timeout: float = None) -> None:\n await self._channel.send(\n \"selectText\", self._frame._timeout, locals_to_params(locals())\n )\n\n async def input_value(self, timeout: float = None) -> str:\n return await self._channel.send(\n \"inputValue\", self._frame._timeout, locals_to_params(locals())\n )\n\n async def set_input_files(\n self,\n files: Union[\n str, Path, FilePayload, Sequence[Union[str, Path]], Sequence[FilePayload]\n ],\n timeout: float = None,\n noWaitAfter: bool = None,\n ) -> None:\n frame = await self.owner_frame()\n if not frame:\n raise Error(\"Cannot set input files to detached element\")\n converted = await convert_input_files(files, frame.page.context)\n await self._channel.send(\n \"setInputFiles\",\n self._frame._timeout,\n {\n \"timeout\": timeout,\n **converted,\n },\n )\n\n async def focus(self) -> None:\n await self._channel.send(\"focus\", None)\n\n async def type(\n self,\n text: str,\n delay: float = None,\n timeout: float = None,\n noWaitAfter: bool = None,\n ) -> None:\n await self._channel.send(\n \"type\", self._frame._timeout, locals_to_params(locals())\n )\n\n async def press(\n self,\n key: str,\n delay: float = None,\n timeout: float = None,\n noWaitAfter: bool = None,\n ) -> None:\n await self._channel.send(\n \"press\", self._frame._timeout, locals_to_params(locals())\n )\n\n async def set_checked(\n self,\n checked: bool,\n position: Position = None,\n timeout: float = None,\n force: bool = None,\n noWaitAfter: bool = None,\n trial: bool = None,\n ) -> None:\n if checked:\n await self.check(\n position=position,\n timeout=timeout,\n force=force,\n trial=trial,\n )\n else:\n await self.uncheck(\n position=position,\n timeout=timeout,\n force=force,\n trial=trial,\n )\n\n async def check(\n self,\n position: Position = None,\n timeout: float = None,\n force: bool = None,\n noWaitAfter: bool = None,\n trial: bool = None,\n ) -> None:\n await self._channel.send(\n \"check\", self._frame._timeout, locals_to_params(locals())\n )\n\n async def uncheck(\n self,\n position: Position = None,\n timeout: float = None,\n force: bool = None,\n noWaitAfter: bool = None,\n trial: bool = None,\n ) -> None:\n await self._channel.send(\n \"uncheck\", self._frame._timeout, locals_to_params(locals())\n )\n\n async def bounding_box(self) -> Optional[FloatRect]:\n return await self._channel.send(\"boundingBox\", None)\n\n async def screenshot(\n self,\n timeout: float = None,\n type: Literal[\"jpeg\", \"png\"] = None,\n path: Union[str, Path] = None,\n quality: int = None,\n omitBackground: bool = None,\n animations: Literal[\"allow\", \"disabled\"] = None,\n caret: Literal[\"hide\", \"initial\"] = None,\n scale: Literal[\"css\", \"device\"] = None,\n mask: Sequence[\"Locator\"] = None,\n maskColor: str = None,\n style: str = None,\n ) -> bytes:\n params = locals_to_params(locals())\n if \"path\" in params:\n if \"type\" not in params:\n params[\"type\"] = determine_screenshot_type(params[\"path\"])\n del params[\"path\"]\n if \"mask\" in params:\n params[\"mask\"] = list(\n map(\n lambda locator: (\n {\n \"frame\": locator._frame._channel,\n \"selector\": locator._selector,\n }\n ),\n params[\"mask\"],\n )\n )\n encoded_binary = await self._channel.send(\n \"screenshot\", self._frame._timeout, params\n )\n decoded_binary = base64.b64decode(encoded_binary)\n if path:\n make_dirs_for_file(path)\n await async_writefile(path, decoded_binary)\n return decoded_binary\n\n async def query_selector(self, selector: str) -> Optional[\"ElementHandle\"]:\n return from_nullable_channel(\n await self._channel.send(\"querySelector\", None, dict(selector=selector))\n )\n\n async def query_selector_all(self, selector: str) -> List[\"ElementHandle\"]:\n return list(\n map(\n cast(Callable[[Any], Any], from_nullable_channel),\n await self._channel.send(\n \"querySelectorAll\", None, dict(selector=selector)\n ),\n )\n )\n\n async def eval_on_selector(\n self,\n selector: str,\n expression: str,\n arg: Serializable = None,\n ) -> Any:\n return parse_result(\n await self._channel.send(\n \"evalOnSelector\",\n None,\n dict(\n selector=selector,\n expression=expression,\n arg=serialize_argument(arg),\n ),\n )\n )\n\n async def eval_on_selector_all(\n self,\n selector: str,\n expression: str,\n arg: Serializable = None,\n ) -> Any:\n return parse_result(\n await self._channel.send(\n \"evalOnSelectorAll\",\n None,\n dict(\n selector=selector,\n expression=expression,\n arg=serialize_argument(arg),\n ),\n )\n )\n\n async def wait_for_element_state(\n self,\n state: Literal[\n \"disabled\", \"editable\", \"enabled\", \"hidden\", \"stable\", \"visible\"\n ],\n timeout: float = None,\n ) -> None:\n await self._channel.send(\n \"waitForElementState\", self._frame._timeout, locals_to_params(locals())\n )\n\n async def wait_for_selector(\n self,\n selector: str,\n state: Literal[\"attached\", \"detached\", \"hidden\", \"visible\"] = None,\n timeout: float = None,\n strict: bool = None,\n ) -> Optional[\"ElementHandle\"]:\n return from_nullable_channel(\n await self._channel.send(\n \"waitForSelector\", self._frame._timeout, locals_to_params(locals())\n )\n )\n\n\ndef convert_select_option_values(\n value: Union[str, Sequence[str]] = None,\n index: Union[int, Sequence[int]] = None,\n label: Union[str, Sequence[str]] = None,\n element: Union[\"ElementHandle\", Sequence[\"ElementHandle\"]] = None,\n) -> Any:\n if value is None and index is None and label is None and element is None:\n return {}\n\n options: Any = None\n elements: Any = None\n if value is not None:\n if isinstance(value, str):\n value = [value]\n options = (options or []) + list(map(lambda e: dict(valueOrLabel=e), value))\n if index is not None:\n if isinstance(index, int):\n index = [index]\n options = (options or []) + list(map(lambda e: dict(index=e), index))\n if label is not None:\n if isinstance(label, str):\n label = [label]\n options = (options or []) + list(map(lambda e: dict(label=e), label))\n if element:\n if isinstance(element, ElementHandle):\n element = [element]\n elements = list(map(lambda e: e._channel, element))\n\n return dict(options=options, elements=elements)\n\n\ndef determine_screenshot_type(path: Union[str, Path]) -> Literal[\"jpeg\", \"png\"]:\n mime_type, _ = mimetypes.guess_type(path)\n if mime_type == \"image/png\":\n return \"png\"\n if mime_type == \"image/jpeg\":\n return \"jpeg\"\n raise Error(f'Unsupported screenshot mime type for path \"{path}\": {mime_type}')\n" }, { "path": "playwright/_impl/_errors.py", "content": "# Copyright (c) Microsoft Corporation.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n\n# These are types that we use in the API. They are public and are a part of the\n# stable API.\n\n\nfrom typing import Optional\n\n\ndef is_target_closed_error(error: Exception) -> bool:\n return isinstance(error, TargetClosedError)\n\n\nclass Error(Exception):\n def __init__(self, message: str) -> None:\n self._message = message\n self._name: Optional[str] = None\n self._stack: Optional[str] = None\n super().__init__(message)\n\n @property\n def message(self) -> str:\n return self._message\n\n @property\n def name(self) -> Optional[str]:\n return self._name\n\n @property\n def stack(self) -> Optional[str]:\n return self._stack\n\n\nclass TimeoutError(Error):\n pass\n\n\nclass TargetClosedError(Error):\n def __init__(self, message: str = None) -> None:\n super().__init__(message or \"Target page, context or browser has been closed\")\n\n\ndef rewrite_error(error: Exception, message: str) -> Exception:\n rewritten_exc = type(error)(message)\n if isinstance(rewritten_exc, Error) and isinstance(error, Error):\n rewritten_exc._name = error.name\n rewritten_exc._stack = error.stack\n return rewritten_exc\n" }, { "path": "playwright/_impl/_event_context_manager.py", "content": "# Copyright (c) Microsoft Corporation.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n\nimport asyncio\nfrom typing import Any, Generic, TypeVar\n\nT = TypeVar(\"T\")\n\n\nclass EventContextManagerImpl(Generic[T]):\n def __init__(self, future: asyncio.Future) -> None:\n self._future: asyncio.Future = future\n\n @property\n def future(self) -> asyncio.Future:\n return self._future\n\n async def __aenter__(self) -> asyncio.Future:\n return self._future\n\n async def __aexit__(self, *args: Any) -> None:\n await self._future\n" }, { "path": "playwright/_impl/_fetch.py", "content": "# Copyright (c) Microsoft Corporation.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n\nimport base64\nimport json\nimport pathlib\nimport typing\nfrom pathlib import Path\nfrom typing import Any, Dict, List, Optional, Union, cast\n\nimport playwright._impl._network as network\nfrom playwright._impl._api_structures import (\n ClientCertificate,\n FilePayload,\n FormField,\n Headers,\n HttpCredentials,\n ProxySettings,\n ServerFilePayload,\n StorageState,\n)\nfrom playwright._impl._connection import ChannelOwner, from_channel\nfrom playwright._impl._errors import is_target_closed_error\nfrom playwright._impl._helper import (\n Error,\n NameValue,\n TargetClosedError,\n TimeoutSettings,\n async_readfile,\n async_writefile,\n is_file_payload,\n locals_to_params,\n object_to_array,\n to_impl,\n)\nfrom playwright._impl._network import serialize_headers, to_client_certificates_protocol\nfrom playwright._impl._tracing import Tracing\n\nif typing.TYPE_CHECKING:\n from playwright._impl._playwright import Playwright\n\n\nFormType = Dict[str, Union[bool, float, str]]\nDataType = Union[Any, bytes, str]\nMultipartType = Dict[str, Union[bytes, bool, float, str, FilePayload]]\nParamsType = Union[Dict[str, Union[bool, float, str]], str]\n\n\nclass APIRequest:\n def __init__(self, playwright: \"Playwright\") -> None:\n self.playwright = playwright\n self._loop = playwright._loop\n self._dispatcher_fiber = playwright._connection._dispatcher_fiber\n\n async def new_context(\n self,\n baseURL: str = None,\n extraHTTPHeaders: Dict[str, str] = None,\n httpCredentials: HttpCredentials = None,\n ignoreHTTPSErrors: bool = None,\n proxy: ProxySettings = None,\n userAgent: str = None,\n timeout: float = None,\n storageState: Union[StorageState, str, Path] = None,\n clientCertificates: List[ClientCertificate] = None,\n failOnStatusCode: bool = None,\n maxRedirects: int = None,\n ) -> \"APIRequestContext\":\n params = locals_to_params(locals())\n if \"storageState\" in params:\n storage_state = params[\"storageState\"]\n if not isinstance(storage_state, dict) and storage_state:\n params[\"storageState\"] = json.loads(\n (await async_readfile(storage_state)).decode()\n )\n if \"extraHTTPHeaders\" in params:\n params[\"extraHTTPHeaders\"] = serialize_headers(params[\"extraHTTPHeaders\"])\n params[\"clientCertificates\"] = await to_client_certificates_protocol(\n params.get(\"clientCertificates\")\n )\n context = cast(\n APIRequestContext,\n from_channel(\n await self.playwright._channel.send(\"newRequest\", None, params)\n ),\n )\n context._timeout_settings.set_default_timeout(timeout)\n return context\n\n\nclass APIRequestContext(ChannelOwner):\n def __init__(\n self, parent: ChannelOwner, type: str, guid: str, initializer: Dict\n ) -> None:\n super().__init__(parent, type, guid, initializer)\n self._tracing: Tracing = from_channel(initializer[\"tracing\"])\n self._close_reason: Optional[str] = None\n self._timeout_settings = TimeoutSettings(None)\n\n async def dispose(self, reason: str = None) -> None:\n self._close_reason = reason\n try:\n await self._channel.send(\"dispose\", None, {\"reason\": reason})\n except Error as e:\n if is_target_closed_error(e):\n return\n raise e\n self._tracing._reset_stack_counter()\n\n async def delete(\n self,\n url: str,\n params: ParamsType = None,\n headers: Headers = None,\n data: DataType = None,\n form: FormType = None,\n multipart: MultipartType = None,\n timeout: float = None,\n failOnStatusCode: bool = None,\n ignoreHTTPSErrors: bool = None,\n maxRedirects: int = None,\n maxRetries: int = None,\n ) -> \"APIResponse\":\n return await self.fetch(\n url,\n method=\"DELETE\",\n params=params,\n headers=headers,\n data=data,\n form=form,\n multipart=multipart,\n timeout=timeout,\n failOnStatusCode=failOnStatusCode,\n ignoreHTTPSErrors=ignoreHTTPSErrors,\n maxRedirects=maxRedirects,\n maxRetries=maxRetries,\n )\n\n async def head(\n self,\n url: str,\n params: ParamsType = None,\n headers: Headers = None,\n data: DataType = None,\n form: FormType = None,\n multipart: MultipartType = None,\n timeout: float = None,\n failOnStatusCode: bool = None,\n ignoreHTTPSErrors: bool = None,\n maxRedirects: int = None,\n maxRetries: int = None,\n ) -> \"APIResponse\":\n return await self.fetch(\n url,\n method=\"HEAD\",\n params=params,\n headers=headers,\n data=data,\n form=form,\n multipart=multipart,\n timeout=timeout,\n failOnStatusCode=failOnStatusCode,\n ignoreHTTPSErrors=ignoreHTTPSErrors,\n maxRedirects=maxRedirects,\n maxRetries=maxRetries,\n )\n\n async def get(\n self,\n url: str,\n params: ParamsType = None,\n headers: Headers = None,\n data: DataType = None,\n form: FormType = None,\n multipart: MultipartType = None,\n timeout: float = None,\n failOnStatusCode: bool = None,\n ignoreHTTPSErrors: bool = None,\n maxRedirects: int = None,\n maxRetries: int = None,\n ) -> \"APIResponse\":\n return await self.fetch(\n url,\n method=\"GET\",\n params=params,\n headers=headers,\n data=data,\n form=form,\n multipart=multipart,\n timeout=timeout,\n failOnStatusCode=failOnStatusCode,\n ignoreHTTPSErrors=ignoreHTTPSErrors,\n maxRedirects=maxRedirects,\n maxRetries=maxRetries,\n )\n\n async def patch(\n self,\n url: str,\n params: ParamsType = None,\n headers: Headers = None,\n data: DataType = None,\n form: FormType = None,\n multipart: Dict[str, Union[bytes, bool, float, str, FilePayload]] = None,\n timeout: float = None,\n failOnStatusCode: bool = None,\n ignoreHTTPSErrors: bool = None,\n maxRedirects: int = None,\n maxRetries: int = None,\n ) -> \"APIResponse\":\n return await self.fetch(\n url,\n method=\"PATCH\",\n params=params,\n headers=headers,\n data=data,\n form=form,\n multipart=multipart,\n timeout=timeout,\n failOnStatusCode=failOnStatusCode,\n ignoreHTTPSErrors=ignoreHTTPSErrors,\n maxRedirects=maxRedirects,\n maxRetries=maxRetries,\n )\n\n async def put(\n self,\n url: str,\n params: ParamsType = None,\n headers: Headers = None,\n data: DataType = None,\n form: FormType = None,\n multipart: Dict[str, Union[bytes, bool, float, str, FilePayload]] = None,\n timeout: float = None,\n failOnStatusCode: bool = None,\n ignoreHTTPSErrors: bool = None,\n maxRedirects: int = None,\n maxRetries: int = None,\n ) -> \"APIResponse\":\n return await self.fetch(\n url,\n method=\"PUT\",\n params=params,\n headers=headers,\n data=data,\n form=form,\n multipart=multipart,\n timeout=timeout,\n failOnStatusCode=failOnStatusCode,\n ignoreHTTPSErrors=ignoreHTTPSErrors,\n maxRedirects=maxRedirects,\n maxRetries=maxRetries,\n )\n\n async def post(\n self,\n url: str,\n params: ParamsType = None,\n headers: Headers = None,\n data: DataType = None,\n form: FormType = None,\n multipart: Dict[str, Union[bytes, bool, float, str, FilePayload]] = None,\n timeout: float = None,\n failOnStatusCode: bool = None,\n ignoreHTTPSErrors: bool = None,\n maxRedirects: int = None,\n maxRetries: int = None,\n ) -> \"APIResponse\":\n return await self.fetch(\n url,\n method=\"POST\",\n params=params,\n headers=headers,\n data=data,\n form=form,\n multipart=multipart,\n timeout=timeout,\n failOnStatusCode=failOnStatusCode,\n ignoreHTTPSErrors=ignoreHTTPSErrors,\n maxRedirects=maxRedirects,\n maxRetries=maxRetries,\n )\n\n async def fetch(\n self,\n urlOrRequest: Union[str, network.Request],\n params: ParamsType = None,\n method: str = None,\n headers: Headers = None,\n data: DataType = None,\n form: FormType = None,\n multipart: Dict[str, Union[bytes, bool, float, str, FilePayload]] = None,\n timeout: float = None,\n failOnStatusCode: bool = None,\n ignoreHTTPSErrors: bool = None,\n maxRedirects: int = None,\n maxRetries: int = None,\n ) -> \"APIResponse\":\n url = urlOrRequest if isinstance(urlOrRequest, str) else None\n request = (\n cast(network.Request, to_impl(urlOrRequest))\n if isinstance(to_impl(urlOrRequest), network.Request)\n else None\n )\n assert request or isinstance(\n urlOrRequest, str\n ), \"First argument must be either URL string or Request\"\n return await self._inner_fetch(\n request,\n url,\n method,\n headers,\n data,\n params,\n form,\n multipart,\n timeout,\n failOnStatusCode,\n ignoreHTTPSErrors,\n maxRedirects,\n maxRetries,\n )\n\n async def _inner_fetch(\n self,\n request: Optional[network.Request],\n url: Optional[str],\n method: str = None,\n headers: Headers = None,\n data: DataType = None,\n params: ParamsType = None,\n form: FormType = None,\n multipart: Dict[str, Union[bytes, bool, float, str, FilePayload]] = None,\n timeout: float = None,\n failOnStatusCode: bool = None,\n ignoreHTTPSErrors: bool = None,\n maxRedirects: int = None,\n maxRetries: int = None,\n ) -> \"APIResponse\":\n if self._close_reason:\n raise TargetClosedError(self._close_reason)\n assert (\n (1 if data else 0) + (1 if form else 0) + (1 if multipart else 0)\n ) <= 1, \"Only one of 'data', 'form' or 'multipart' can be specified\"\n assert (\n maxRedirects is None or maxRedirects >= 0\n ), \"'max_redirects' must be greater than or equal to '0'\"\n assert (\n maxRetries is None or maxRetries >= 0\n ), \"'max_retries' must be greater than or equal to '0'\"\n url = url or (request.url if request else url)\n method = method or (request.method if request else \"GET\")\n # Cannot call allHeaders() here as the request may be paused inside route handler.\n headers_obj = headers or (request.headers if request else None)\n serialized_headers = serialize_headers(headers_obj) if headers_obj else None\n json_data: Any = None\n form_data: Optional[List[NameValue]] = None\n multipart_data: Optional[List[FormField]] = None\n post_data_buffer: Optional[bytes] = None\n if data is not None:\n if isinstance(data, str):\n if is_json_content_type(serialized_headers):\n json_data = data if is_json_parsable(data) else json.dumps(data)\n else:\n post_data_buffer = data.encode()\n elif isinstance(data, bytes):\n post_data_buffer = data\n elif isinstance(data, (dict, list, int, bool)):\n json_data = json.dumps(data)\n else:\n raise Error(f\"Unsupported 'data' type: {type(data)}\")\n elif form:\n form_data = object_to_array(form)\n elif multipart:\n multipart_data = []\n # Convert file-like values to ServerFilePayload structs.\n for name, value in multipart.items():\n if is_file_payload(value):\n payload = cast(FilePayload, value)\n assert isinstance(\n payload[\"buffer\"], bytes\n ), f\"Unexpected buffer type of 'data.{name}'\"\n multipart_data.append(\n FormField(name=name, file=file_payload_to_json(payload))\n )\n elif isinstance(value, str):\n multipart_data.append(FormField(name=name, value=value))\n if (\n post_data_buffer is None\n and json_data is None\n and form_data is None\n and multipart_data is None\n ):\n post_data_buffer = request.post_data_buffer if request else None\n post_data = (\n base64.b64encode(post_data_buffer).decode() if post_data_buffer else None\n )\n\n response = await self._channel.send(\n \"fetch\",\n self._timeout_settings.timeout,\n {\n \"url\": url,\n \"timeout\": timeout,\n \"params\": object_to_array(params) if isinstance(params, dict) else None,\n \"encodedParams\": params if isinstance(params, str) else None,\n \"method\": method,\n \"headers\": serialized_headers,\n \"postData\": post_data,\n \"jsonData\": json_data,\n \"formData\": form_data,\n \"multipartData\": multipart_data,\n \"failOnStatusCode\": failOnStatusCode,\n \"ignoreHTTPSErrors\": ignoreHTTPSErrors,\n \"maxRedirects\": maxRedirects,\n \"maxRetries\": maxRetries,\n },\n )\n return APIResponse(self, response)\n\n async def storage_state(\n self,\n path: Union[pathlib.Path, str] = None,\n indexedDB: bool = None,\n ) -> StorageState:\n result = await self._channel.send_return_as_dict(\n \"storageState\", None, {\"indexedDB\": indexedDB}\n )\n if path:\n await async_writefile(path, json.dumps(result))\n return result\n\n\ndef file_payload_to_json(payload: FilePayload) -> ServerFilePayload:\n return ServerFilePayload(\n name=payload[\"name\"],\n mimeType=payload[\"mimeType\"],\n buffer=base64.b64encode(payload[\"buffer\"]).decode(),\n )\n\n\nclass APIResponse:\n def __init__(self, context: APIRequestContext, initializer: Dict) -> None:\n self._loop = context._loop\n self._dispatcher_fiber = context._connection._dispatcher_fiber\n self._request = context\n self._initializer = initializer\n self._headers = network.RawHeaders(initializer[\"headers\"])\n\n def __repr__(self) -> str:\n return f\"\"\n\n @property\n def ok(self) -> bool:\n return self.status >= 200 and self.status <= 299\n\n @property\n def url(self) -> str:\n return self._initializer[\"url\"]\n\n @property\n def status(self) -> int:\n return self._initializer[\"status\"]\n\n @property\n def status_text(self) -> str:\n return self._initializer[\"statusText\"]\n\n @property\n def headers(self) -> Headers:\n return self._headers.headers()\n\n @property\n def headers_array(self) -> network.HeadersArray:\n return self._headers.headers_array()\n\n async def body(self) -> bytes:\n try:\n result = await self._request._connection.wrap_api_call(\n lambda: self._request._channel.send_return_as_dict(\n \"fetchResponseBody\",\n None,\n {\n \"fetchUid\": self._fetch_uid,\n },\n ),\n True,\n )\n if result is None:\n raise Error(\"Response has been disposed\")\n return base64.b64decode(result[\"binary\"])\n except Error as exc:\n if is_target_closed_error(exc):\n raise Error(\"Response has been disposed\")\n raise exc\n\n async def text(self) -> str:\n content = await self.body()\n return content.decode()\n\n async def json(self) -> Any:\n content = await self.text()\n return json.loads(content)\n\n async def dispose(self) -> None:\n await self._request._channel.send(\n \"disposeAPIResponse\",\n None,\n {\n \"fetchUid\": self._fetch_uid,\n },\n )\n\n @property\n def _fetch_uid(self) -> str:\n return self._initializer[\"fetchUid\"]\n\n async def _fetch_log(self) -> List[str]:\n return await self._request._channel.send(\n \"fetchLog\",\n None,\n {\n \"fetchUid\": self._fetch_uid,\n },\n )\n\n\ndef is_json_content_type(headers: network.HeadersArray = None) -> bool:\n if not headers:\n return False\n for header in headers:\n if header[\"name\"] == \"Content-Type\":\n return header[\"value\"].startswith(\"application/json\")\n return False\n\n\ndef is_json_parsable(value: Any) -> bool:\n if not isinstance(value, str):\n return False\n try:\n json.loads(value)\n return True\n except json.JSONDecodeError:\n return False\n" }, { "path": "playwright/_impl/_file_chooser.py", "content": "# Copyright (c) Microsoft Corporation.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n\nfrom pathlib import Path\nfrom typing import TYPE_CHECKING, Sequence, Union\n\nfrom playwright._impl._api_structures import FilePayload\n\nif TYPE_CHECKING: # pragma: no cover\n from playwright._impl._element_handle import ElementHandle\n from playwright._impl._page import Page\n\n\nclass FileChooser:\n def __init__(\n self, page: \"Page\", element_handle: \"ElementHandle\", is_multiple: bool\n ) -> None:\n self._page = page\n self._loop = page._loop\n self._dispatcher_fiber = page._dispatcher_fiber\n self._element_handle = element_handle\n self._is_multiple = is_multiple\n\n def __repr__(self) -> str:\n return f\"\"\n\n @property\n def page(self) -> \"Page\":\n return self._page\n\n @property\n def element(self) -> \"ElementHandle\":\n return self._element_handle\n\n def is_multiple(self) -> bool:\n return self._is_multiple\n\n async def set_files(\n self,\n files: Union[\n str, Path, FilePayload, Sequence[Union[str, Path]], Sequence[FilePayload]\n ],\n timeout: float = None,\n noWaitAfter: bool = None,\n ) -> None:\n await self._element_handle.set_input_files(files, timeout, noWaitAfter)\n" }, { "path": "playwright/_impl/_frame.py", "content": "# Copyright (c) Microsoft Corporation.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n\nimport asyncio\nfrom pathlib import Path\nfrom typing import (\n TYPE_CHECKING,\n Any,\n Dict,\n List,\n Literal,\n Optional,\n Pattern,\n Sequence,\n Set,\n Union,\n cast,\n)\n\nfrom pyee import EventEmitter\n\nfrom playwright._impl._api_structures import (\n AriaRole,\n FilePayload,\n FrameExpectOptions,\n FrameExpectResult,\n Position,\n)\nfrom playwright._impl._connection import (\n ChannelOwner,\n from_channel,\n from_nullable_channel,\n)\nfrom playwright._impl._element_handle import ElementHandle, convert_select_option_values\nfrom playwright._impl._errors import Error\nfrom playwright._impl._event_context_manager import EventContextManagerImpl\nfrom playwright._impl._helper import (\n DocumentLoadState,\n FrameNavigatedEvent,\n KeyboardModifier,\n MouseButton,\n TimeoutSettings,\n URLMatch,\n async_readfile,\n locals_to_params,\n monotonic_time,\n url_matches,\n)\nfrom playwright._impl._js_handle import (\n JSHandle,\n Serializable,\n add_source_url_to_script,\n parse_result,\n parse_value,\n serialize_argument,\n)\nfrom playwright._impl._locator import (\n FrameLocator,\n Locator,\n get_by_alt_text_selector,\n get_by_label_selector,\n get_by_placeholder_selector,\n get_by_role_selector,\n get_by_test_id_selector,\n get_by_text_selector,\n get_by_title_selector,\n test_id_attribute_name,\n)\nfrom playwright._impl._network import Response\nfrom playwright._impl._set_input_files_helpers import convert_input_files\nfrom playwright._impl._waiter import Waiter\n\nif TYPE_CHECKING: # pragma: no cover\n from playwright._impl._page import Page\n\n\nclass Frame(ChannelOwner):\n def __init__(\n self, parent: ChannelOwner, type: str, guid: str, initializer: Dict\n ) -> None:\n super().__init__(parent, type, guid, initializer)\n self._parent_frame = from_nullable_channel(initializer.get(\"parentFrame\"))\n if self._parent_frame:\n self._parent_frame._child_frames.append(self)\n self._name = initializer[\"name\"]\n self._url = initializer[\"url\"]\n self._detached = False\n self._child_frames: List[Frame] = []\n self._page: Optional[Page] = None\n self._load_states: Set[str] = set(initializer[\"loadStates\"])\n self._event_emitter = EventEmitter()\n self._channel.on(\n \"loadstate\",\n lambda params: self._on_load_state(params.get(\"add\"), params.get(\"remove\")),\n )\n self._channel.on(\n \"navigated\",\n lambda params: self._on_frame_navigated(params),\n )\n\n def __repr__(self) -> str:\n return f\"\"\n\n def _on_load_state(\n self, add: DocumentLoadState = None, remove: DocumentLoadState = None\n ) -> None:\n if add:\n self._load_states.add(add)\n self._event_emitter.emit(\"loadstate\", add)\n elif remove and remove in self._load_states:\n self._load_states.remove(remove)\n if not self._parent_frame and add == \"load\" and self._page:\n self._page.emit(\"load\", self._page)\n if not self._parent_frame and add == \"domcontentloaded\" and self._page:\n self._page.emit(\"domcontentloaded\", self._page)\n\n def _on_frame_navigated(self, event: FrameNavigatedEvent) -> None:\n self._url = event[\"url\"]\n self._name = event[\"name\"]\n self._event_emitter.emit(\"navigated\", event)\n if \"error\" not in event and self._page:\n self._page.emit(\"framenavigated\", self)\n\n async def _query_count(self, selector: str) -> int:\n return await self._channel.send(\"queryCount\", None, {\"selector\": selector})\n\n @property\n def page(self) -> \"Page\":\n assert self._page\n return self._page\n\n async def goto(\n self,\n url: str,\n timeout: float = None,\n waitUntil: DocumentLoadState = None,\n referer: str = None,\n ) -> Optional[Response]:\n return cast(\n Optional[Response],\n from_nullable_channel(\n await self._channel.send(\n \"goto\", self._navigation_timeout, locals_to_params(locals())\n )\n ),\n )\n\n def _setup_navigation_waiter(self, wait_name: str, timeout: float = None) -> Waiter:\n assert self._page\n waiter = Waiter(self._page, f\"frame.{wait_name}\")\n waiter.reject_on_event(\n self._page,\n \"close\",\n lambda: cast(\"Page\", self._page)._close_error_with_reason(),\n )\n waiter.reject_on_event(\n self._page, \"crash\", Error(\"Navigation failed because page crashed!\")\n )\n waiter.reject_on_event(\n self._page,\n \"framedetached\",\n Error(\"Navigating frame was detached!\"),\n lambda frame: frame == self,\n )\n timeout = self._page._timeout_settings.navigation_timeout(timeout)\n waiter.reject_on_timeout(timeout, f\"Timeout {timeout}ms exceeded.\")\n return waiter\n\n async def _expect(\n self,\n selector: Optional[str],\n expression: str,\n options: FrameExpectOptions,\n title: str = None,\n ) -> FrameExpectResult:\n if \"expectedValue\" in options:\n options[\"expectedValue\"] = serialize_argument(options[\"expectedValue\"])\n result = await self._channel.send_return_as_dict(\n \"expect\",\n self._timeout,\n {\n \"selector\": selector,\n \"expression\": expression,\n **options,\n },\n title=title,\n )\n if result.get(\"received\"):\n result[\"received\"] = parse_value(result[\"received\"])\n return result\n\n def expect_navigation(\n self,\n url: URLMatch = None,\n waitUntil: DocumentLoadState = None,\n timeout: float = None,\n ) -> EventContextManagerImpl[Response]:\n assert self._page\n if not waitUntil:\n waitUntil = \"load\"\n\n if timeout is None:\n timeout = self._page._timeout_settings.navigation_timeout()\n deadline = monotonic_time() + timeout\n waiter = self._setup_navigation_waiter(\"expect_navigation\", timeout)\n\n to_url = f' to \"{url}\"' if url else \"\"\n waiter.log(f\"waiting for navigation{to_url} until '{waitUntil}'\")\n\n def predicate(event: Any) -> bool:\n # Any failed navigation results in a rejection.\n if event.get(\"error\"):\n return True\n waiter.log(f' navigated to \"{event[\"url\"]}\"')\n return url_matches(\n cast(\"Page\", self._page)._browser_context._base_url,\n event[\"url\"],\n url,\n )\n\n waiter.wait_for_event(\n self._event_emitter,\n \"navigated\",\n predicate=predicate,\n )\n\n async def continuation() -> Optional[Response]:\n event = await waiter.result()\n if \"error\" in event:\n raise Error(event[\"error\"])\n if waitUntil not in self._load_states:\n t = deadline - monotonic_time()\n if t > 0:\n await self._wait_for_load_state_impl(state=waitUntil, timeout=t)\n if \"newDocument\" in event and \"request\" in event[\"newDocument\"]:\n request = from_channel(event[\"newDocument\"][\"request\"])\n return await request.response()\n return None\n\n return EventContextManagerImpl(asyncio.create_task(continuation()))\n\n async def wait_for_url(\n self,\n url: URLMatch,\n waitUntil: DocumentLoadState = None,\n timeout: float = None,\n ) -> None:\n assert self._page\n if url_matches(self._page._browser_context._base_url, self.url, url):\n await self._wait_for_load_state_impl(state=waitUntil, timeout=timeout)\n return\n async with self.expect_navigation(\n url=url, waitUntil=waitUntil, timeout=timeout\n ):\n pass\n\n async def wait_for_load_state(\n self,\n state: Literal[\"domcontentloaded\", \"load\", \"networkidle\"] = None,\n timeout: float = None,\n ) -> None:\n return await self._wait_for_load_state_impl(state, timeout)\n\n async def _wait_for_load_state_impl(\n self, state: DocumentLoadState = None, timeout: float = None\n ) -> None:\n if not state:\n state = \"load\"\n if state not in (\"load\", \"domcontentloaded\", \"networkidle\", \"commit\"):\n raise Error(\n \"state: expected one of (load|domcontentloaded|networkidle|commit)\"\n )\n waiter = self._setup_navigation_waiter(\"wait_for_load_state\", timeout)\n\n if state in self._load_states:\n waiter.log(f' not waiting, \"{state}\" event already fired')\n # TODO: align with upstream\n waiter._fulfill(None)\n else:\n\n def handle_load_state_event(actual_state: str) -> bool:\n waiter.log(f'\"{actual_state}\" event fired')\n return actual_state == state\n\n waiter.wait_for_event(\n self._event_emitter,\n \"loadstate\",\n handle_load_state_event,\n )\n await waiter.result()\n\n def _timeout(self, timeout: Optional[float]) -> float:\n timeout_settings = (\n self._page._timeout_settings if self._page else TimeoutSettings(None)\n )\n return timeout_settings.timeout(timeout)\n\n def _navigation_timeout(self, timeout: Optional[float]) -> float:\n timeout_settings = (\n self._page._timeout_settings if self._page else TimeoutSettings(None)\n )\n return timeout_settings.navigation_timeout(timeout)\n\n async def frame_element(self) -> ElementHandle:\n return from_channel(await self._channel.send(\"frameElement\", None))\n\n async def evaluate(self, expression: str, arg: Serializable = None) -> Any:\n return parse_result(\n await self._channel.send(\n \"evaluateExpression\",\n None,\n dict(\n expression=expression,\n arg=serialize_argument(arg),\n ),\n )\n )\n\n async def evaluate_handle(\n self, expression: str, arg: Serializable = None\n ) -> JSHandle:\n return from_channel(\n await self._channel.send(\n \"evaluateExpressionHandle\",\n None,\n dict(\n expression=expression,\n arg=serialize_argument(arg),\n ),\n )\n )\n\n async def query_selector(\n self, selector: str, strict: bool = None\n ) -> Optional[ElementHandle]:\n return from_nullable_channel(\n await self._channel.send(\"querySelector\", None, locals_to_params(locals()))\n )\n\n async def query_selector_all(self, selector: str) -> List[ElementHandle]:\n return list(\n map(\n from_channel,\n await self._channel.send(\n \"querySelectorAll\", None, dict(selector=selector)\n ),\n )\n )\n\n async def wait_for_selector(\n self,\n selector: str,\n strict: bool = None,\n timeout: float = None,\n state: Literal[\"attached\", \"detached\", \"hidden\", \"visible\"] = None,\n ) -> Optional[ElementHandle]:\n return from_nullable_channel(\n await self._channel.send(\n \"waitForSelector\", self._timeout, locals_to_params(locals())\n )\n )\n\n async def is_checked(\n self, selector: str, strict: bool = None, timeout: float = None\n ) -> bool:\n return await self._channel.send(\n \"isChecked\", self._timeout, locals_to_params(locals())\n )\n\n async def is_disabled(\n self, selector: str, strict: bool = None, timeout: float = None\n ) -> bool:\n return await self._channel.send(\n \"isDisabled\", self._timeout, locals_to_params(locals())\n )\n\n async def is_editable(\n self, selector: str, strict: bool = None, timeout: float = None\n ) -> bool:\n return await self._channel.send(\n \"isEditable\", self._timeout, locals_to_params(locals())\n )\n\n async def is_enabled(\n self, selector: str, strict: bool = None, timeout: float = None\n ) -> bool:\n return await self._channel.send(\n \"isEnabled\", self._timeout, locals_to_params(locals())\n )\n\n async def is_hidden(self, selector: str, strict: bool = None) -> bool:\n return await self._channel.send(\n \"isHidden\", self._timeout, locals_to_params(locals())\n )\n\n async def is_visible(self, selector: str, strict: bool = None) -> bool:\n return await self._channel.send(\n \"isVisible\", self._timeout, locals_to_params(locals())\n )\n\n async def dispatch_event(\n self,\n selector: str,\n type: str,\n eventInit: Dict = None,\n strict: bool = None,\n timeout: float = None,\n ) -> None:\n await self._channel.send(\n \"dispatchEvent\",\n self._timeout,\n locals_to_params(\n dict(\n selector=selector,\n type=type,\n eventInit=serialize_argument(eventInit),\n strict=strict,\n timeout=timeout,\n ),\n ),\n )\n\n async def eval_on_selector(\n self,\n selector: str,\n expression: str,\n arg: Serializable = None,\n strict: bool = None,\n ) -> Any:\n return parse_result(\n await self._channel.send(\n \"evalOnSelector\",\n None,\n locals_to_params(\n dict(\n selector=selector,\n expression=expression,\n arg=serialize_argument(arg),\n strict=strict,\n )\n ),\n )\n )\n\n async def eval_on_selector_all(\n self,\n selector: str,\n expression: str,\n arg: Serializable = None,\n ) -> Any:\n return parse_result(\n await self._channel.send(\n \"evalOnSelectorAll\",\n None,\n dict(\n selector=selector,\n expression=expression,\n arg=serialize_argument(arg),\n ),\n )\n )\n\n async def content(self) -> str:\n return await self._channel.send(\"content\", None)\n\n async def set_content(\n self,\n html: str,\n timeout: float = None,\n waitUntil: DocumentLoadState = None,\n ) -> None:\n await self._channel.send(\n \"setContent\", self._navigation_timeout, locals_to_params(locals())\n )\n\n @property\n def name(self) -> str:\n return self._name or \"\"\n\n @property\n def url(self) -> str:\n return self._url or \"\"\n\n @property\n def parent_frame(self) -> Optional[\"Frame\"]:\n return self._parent_frame\n\n @property\n def child_frames(self) -> List[\"Frame\"]:\n return self._child_frames.copy()\n\n def is_detached(self) -> bool:\n return self._detached\n\n async def add_script_tag(\n self,\n url: str = None,\n path: Union[str, Path] = None,\n content: str = None,\n type: str = None,\n ) -> ElementHandle:\n params = locals_to_params(locals())\n if path:\n params[\"content\"] = add_source_url_to_script(\n (await async_readfile(path)).decode(), path\n )\n del params[\"path\"]\n return from_channel(await self._channel.send(\"addScriptTag\", None, params))\n\n async def add_style_tag(\n self, url: str = None, path: Union[str, Path] = None, content: str = None\n ) -> ElementHandle:\n params = locals_to_params(locals())\n if path:\n params[\"content\"] = (\n (await async_readfile(path)).decode()\n + \"\\n/*# sourceURL=\"\n + str(Path(path))\n + \"*/\"\n )\n del params[\"path\"]\n return from_channel(await self._channel.send(\"addStyleTag\", None, params))\n\n async def click(\n self,\n selector: str,\n modifiers: Sequence[KeyboardModifier] = None,\n position: Position = None,\n delay: float = None,\n button: MouseButton = None,\n clickCount: int = None,\n timeout: float = None,\n force: bool = None,\n noWaitAfter: bool = None,\n strict: bool = None,\n trial: bool = None,\n ) -> None:\n await self._click(**locals_to_params(locals()))\n\n async def _click(\n self,\n selector: str,\n modifiers: Sequence[KeyboardModifier] = None,\n position: Position = None,\n delay: float = None,\n button: MouseButton = None,\n clickCount: int = None,\n timeout: float = None,\n force: bool = None,\n noWaitAfter: bool = None,\n strict: bool = None,\n trial: bool = None,\n steps: int = None,\n ) -> None:\n await self._channel.send(\"click\", self._timeout, locals_to_params(locals()))\n\n async def dblclick(\n self,\n selector: str,\n modifiers: Sequence[KeyboardModifier] = None,\n position: Position = None,\n delay: float = None,\n button: MouseButton = None,\n timeout: float = None,\n force: bool = None,\n noWaitAfter: bool = None,\n strict: bool = None,\n trial: bool = None,\n ) -> None:\n await self._channel.send(\n \"dblclick\", self._timeout, locals_to_params(locals()), title=\"Double click\"\n )\n\n async def tap(\n self,\n selector: str,\n modifiers: Sequence[KeyboardModifier] = None,\n position: Position = None,\n timeout: float = None,\n force: bool = None,\n noWaitAfter: bool = None,\n strict: bool = None,\n trial: bool = None,\n ) -> None:\n await self._channel.send(\"tap\", self._timeout, locals_to_params(locals()))\n\n async def fill(\n self,\n selector: str,\n value: str,\n timeout: float = None,\n noWaitAfter: bool = None,\n strict: bool = None,\n force: bool = None,\n ) -> None:\n await self._fill(**locals_to_params(locals()))\n\n async def _fill(\n self,\n selector: str,\n value: str,\n timeout: float = None,\n noWaitAfter: bool = None,\n strict: bool = None,\n force: bool = None,\n title: str = None,\n ) -> None:\n await self._channel.send(\"fill\", self._timeout, locals_to_params(locals()))\n\n def locator(\n self,\n selector: str,\n hasText: Union[str, Pattern[str]] = None,\n hasNotText: Union[str, Pattern[str]] = None,\n has: Locator = None,\n hasNot: Locator = None,\n ) -> Locator:\n return Locator(\n self,\n selector,\n has_text=hasText,\n has_not_text=hasNotText,\n has=has,\n has_not=hasNot,\n )\n\n def get_by_alt_text(\n self, text: Union[str, Pattern[str]], exact: bool = None\n ) -> \"Locator\":\n return self.locator(get_by_alt_text_selector(text, exact=exact))\n\n def get_by_label(\n self, text: Union[str, Pattern[str]], exact: bool = None\n ) -> \"Locator\":\n return self.locator(get_by_label_selector(text, exact=exact))\n\n def get_by_placeholder(\n self, text: Union[str, Pattern[str]], exact: bool = None\n ) -> \"Locator\":\n return self.locator(get_by_placeholder_selector(text, exact=exact))\n\n def get_by_role(\n self,\n role: AriaRole,\n checked: bool = None,\n disabled: bool = None,\n expanded: bool = None,\n includeHidden: bool = None,\n level: int = None,\n name: Union[str, Pattern[str]] = None,\n pressed: bool = None,\n selected: bool = None,\n exact: bool = None,\n ) -> \"Locator\":\n return self.locator(\n get_by_role_selector(\n role,\n checked=checked,\n disabled=disabled,\n expanded=expanded,\n includeHidden=includeHidden,\n level=level,\n name=name,\n pressed=pressed,\n selected=selected,\n exact=exact,\n )\n )\n\n def get_by_test_id(self, testId: Union[str, Pattern[str]]) -> \"Locator\":\n return self.locator(get_by_test_id_selector(test_id_attribute_name(), testId))\n\n def get_by_text(\n self, text: Union[str, Pattern[str]], exact: bool = None\n ) -> \"Locator\":\n return self.locator(get_by_text_selector(text, exact=exact))\n\n def get_by_title(\n self, text: Union[str, Pattern[str]], exact: bool = None\n ) -> \"Locator\":\n return self.locator(get_by_title_selector(text, exact=exact))\n\n def frame_locator(self, selector: str) -> FrameLocator:\n return FrameLocator(self, selector)\n\n async def focus(\n self, selector: str, strict: bool = None, timeout: float = None\n ) -> None:\n await self._channel.send(\"focus\", self._timeout, locals_to_params(locals()))\n\n async def text_content(\n self, selector: str, strict: bool = None, timeout: float = None\n ) -> Optional[str]:\n return await self._channel.send(\n \"textContent\", self._timeout, locals_to_params(locals())\n )\n\n async def inner_text(\n self, selector: str, strict: bool = None, timeout: float = None\n ) -> str:\n return await self._channel.send(\n \"innerText\", self._timeout, locals_to_params(locals())\n )\n\n async def inner_html(\n self, selector: str, strict: bool = None, timeout: float = None\n ) -> str:\n return await self._channel.send(\n \"innerHTML\", self._timeout, locals_to_params(locals())\n )\n\n async def get_attribute(\n self, selector: str, name: str, strict: bool = None, timeout: float = None\n ) -> Optional[str]:\n return await self._channel.send(\n \"getAttribute\", self._timeout, locals_to_params(locals())\n )\n\n async def hover(\n self,\n selector: str,\n modifiers: Sequence[KeyboardModifier] = None,\n position: Position = None,\n timeout: float = None,\n noWaitAfter: bool = None,\n force: bool = None,\n strict: bool = None,\n trial: bool = None,\n ) -> None:\n await self._channel.send(\"hover\", self._timeout, locals_to_params(locals()))\n\n async def drag_and_drop(\n self,\n source: str,\n target: str,\n sourcePosition: Position = None,\n targetPosition: Position = None,\n force: bool = None,\n noWaitAfter: bool = None,\n strict: bool = None,\n timeout: float = None,\n trial: bool = None,\n steps: int = None,\n ) -> None:\n await self._channel.send(\n \"dragAndDrop\", self._timeout, locals_to_params(locals())\n )\n\n async def select_option(\n self,\n selector: str,\n value: Union[str, Sequence[str]] = None,\n index: Union[int, Sequence[int]] = None,\n label: Union[str, Sequence[str]] = None,\n element: Union[\"ElementHandle\", Sequence[\"ElementHandle\"]] = None,\n timeout: float = None,\n noWaitAfter: bool = None,\n strict: bool = None,\n force: bool = None,\n ) -> List[str]:\n params = locals_to_params(\n dict(\n selector=selector,\n timeout=timeout,\n strict=strict,\n force=force,\n **convert_select_option_values(value, index, label, element),\n )\n )\n return await self._channel.send(\"selectOption\", self._timeout, params)\n\n async def input_value(\n self,\n selector: str,\n strict: bool = None,\n timeout: float = None,\n ) -> str:\n return await self._channel.send(\n \"inputValue\", self._timeout, locals_to_params(locals())\n )\n\n async def set_input_files(\n self,\n selector: str,\n files: Union[\n str, Path, FilePayload, Sequence[Union[str, Path]], Sequence[FilePayload]\n ],\n strict: bool = None,\n timeout: float = None,\n noWaitAfter: bool = None,\n ) -> None:\n converted = await convert_input_files(files, self.page.context)\n await self._channel.send(\n \"setInputFiles\",\n self._timeout,\n {\n \"selector\": selector,\n \"strict\": strict,\n \"timeout\": self._timeout(timeout),\n **converted,\n },\n )\n\n async def type(\n self,\n selector: str,\n text: str,\n delay: float = None,\n strict: bool = None,\n timeout: float = None,\n noWaitAfter: bool = None,\n ) -> None:\n await self._channel.send(\"type\", self._timeout, locals_to_params(locals()))\n\n async def press(\n self,\n selector: str,\n key: str,\n delay: float = None,\n strict: bool = None,\n timeout: float = None,\n noWaitAfter: bool = None,\n ) -> None:\n await self._channel.send(\"press\", self._timeout, locals_to_params(locals()))\n\n async def check(\n self,\n selector: str,\n position: Position = None,\n timeout: float = None,\n force: bool = None,\n noWaitAfter: bool = None,\n strict: bool = None,\n trial: bool = None,\n ) -> None:\n await self._channel.send(\"check\", self._timeout, locals_to_params(locals()))\n\n async def uncheck(\n self,\n selector: str,\n position: Position = None,\n timeout: float = None,\n force: bool = None,\n noWaitAfter: bool = None,\n strict: bool = None,\n trial: bool = None,\n ) -> None:\n await self._channel.send(\"uncheck\", self._timeout, locals_to_params(locals()))\n\n async def wait_for_timeout(self, timeout: float) -> None:\n await self._channel.send(\"waitForTimeout\", None, {\"waitTimeout\": timeout})\n\n async def wait_for_function(\n self,\n expression: str,\n arg: Serializable = None,\n timeout: float = None,\n polling: Union[float, Literal[\"raf\"]] = None,\n ) -> JSHandle:\n if isinstance(polling, str) and polling != \"raf\":\n raise Error(f\"Unknown polling option: {polling}\")\n params = locals_to_params(locals())\n params[\"arg\"] = serialize_argument(arg)\n if polling is not None and polling != \"raf\":\n params[\"pollingInterval\"] = polling\n return from_channel(\n await self._channel.send(\"waitForFunction\", self._timeout, params)\n )\n\n async def title(self) -> str:\n return await self._channel.send(\"title\", None)\n\n async def set_checked(\n self,\n selector: str,\n checked: bool,\n position: Position = None,\n timeout: float = None,\n force: bool = None,\n noWaitAfter: bool = None,\n strict: bool = None,\n trial: bool = None,\n ) -> None:\n if checked:\n await self.check(\n selector=selector,\n position=position,\n timeout=timeout,\n force=force,\n strict=strict,\n trial=trial,\n )\n else:\n await self.uncheck(\n selector=selector,\n position=position,\n timeout=timeout,\n force=force,\n strict=strict,\n trial=trial,\n )\n\n async def _highlight(self, selector: str) -> None:\n await self._channel.send(\"highlight\", None, {\"selector\": selector})\n" }, { "path": "playwright/_impl/_glob.py", "content": "# Copyright (c) Microsoft Corporation.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n\n# https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_expressions#escaping\nescaped_chars = {\"$\", \"^\", \"+\", \".\", \"*\", \"(\", \")\", \"|\", \"\\\\\", \"?\", \"{\", \"}\", \"[\", \"]\"}\n\n\ndef glob_to_regex_pattern(glob: str) -> str:\n tokens = [\"^\"]\n in_group = False\n\n i = 0\n while i < len(glob):\n c = glob[i]\n if c == \"\\\\\" and i + 1 < len(glob):\n char = glob[i + 1]\n tokens.append(\"\\\\\" + char if char in escaped_chars else char)\n i += 1\n elif c == \"*\":\n char_before = glob[i - 1] if i > 0 else None\n star_count = 1\n while i + 1 < len(glob) and glob[i + 1] == \"*\":\n star_count += 1\n i += 1\n if star_count > 1:\n char_after = glob[i + 1] if i + 1 < len(glob) else None\n if char_after == \"/\":\n if char_before == \"/\":\n tokens.append(\"((.+/)|)\")\n else:\n tokens.append(\"(.*/)\")\n i += 1\n else:\n tokens.append(\"(.*)\")\n else:\n tokens.append(\"([^/]*)\")\n else:\n if c == \"{\":\n in_group = True\n tokens.append(\"(\")\n elif c == \"}\":\n in_group = False\n tokens.append(\")\")\n elif c == \",\":\n if in_group:\n tokens.append(\"|\")\n else:\n tokens.append(\"\\\\\" + c)\n else:\n tokens.append(\"\\\\\" + c if c in escaped_chars else c)\n i += 1\n\n tokens.append(\"$\")\n return \"\".join(tokens)\n" }, { "path": "playwright/_impl/_greenlets.py", "content": "# Copyright (c) Microsoft Corporation.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\nimport os\nfrom typing import Tuple\n\nimport greenlet\n\n\ndef _greenlet_trace_callback(\n event: str, args: Tuple[greenlet.greenlet, greenlet.greenlet]\n) -> None:\n if event in (\"switch\", \"throw\"):\n origin, target = args\n print(f\"Transfer from {origin} to {target} with {event}\")\n\n\nif os.environ.get(\"INTERNAL_PW_GREENLET_DEBUG\"):\n greenlet.settrace(_greenlet_trace_callback)\n\n\nclass MainGreenlet(greenlet.greenlet):\n def __str__(self) -> str:\n return \"\"\n\n\nclass RouteGreenlet(greenlet.greenlet):\n def __str__(self) -> str:\n return \"\"\n\n\nclass LocatorHandlerGreenlet(greenlet.greenlet):\n def __str__(self) -> str:\n return \"\"\n\n\nclass EventGreenlet(greenlet.greenlet):\n def __str__(self) -> str:\n return \"\"\n" }, { "path": "playwright/_impl/_har_router.py", "content": "# Copyright (c) Microsoft Corporation.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\nimport asyncio\nimport base64\nfrom typing import TYPE_CHECKING, Optional, cast\n\nfrom playwright._impl._api_structures import HeadersArray\nfrom playwright._impl._helper import (\n HarLookupResult,\n RouteFromHarNotFoundPolicy,\n URLMatch,\n)\nfrom playwright._impl._local_utils import LocalUtils\n\nif TYPE_CHECKING: # pragma: no cover\n from playwright._impl._browser_context import BrowserContext\n from playwright._impl._network import Route\n from playwright._impl._page import Page\n\n\nclass HarRouter:\n def __init__(\n self,\n local_utils: LocalUtils,\n har_id: str,\n not_found_action: RouteFromHarNotFoundPolicy,\n url_matcher: Optional[URLMatch] = None,\n ) -> None:\n self._local_utils: LocalUtils = local_utils\n self._har_id: str = har_id\n self._not_found_action: RouteFromHarNotFoundPolicy = not_found_action\n self._options_url_match: Optional[URLMatch] = url_matcher\n\n @staticmethod\n async def create(\n local_utils: LocalUtils,\n file: str,\n not_found_action: RouteFromHarNotFoundPolicy,\n url_matcher: Optional[URLMatch] = None,\n ) -> \"HarRouter\":\n har_id = await local_utils._channel.send(\"harOpen\", None, {\"file\": file})\n return HarRouter(\n local_utils=local_utils,\n har_id=har_id,\n not_found_action=not_found_action,\n url_matcher=url_matcher,\n )\n\n async def _handle(self, route: \"Route\") -> None:\n request = route.request\n response: HarLookupResult = await self._local_utils.har_lookup(\n harId=self._har_id,\n url=request.url,\n method=request.method,\n headers=await request.headers_array(),\n postData=request.post_data_buffer,\n isNavigationRequest=request.is_navigation_request(),\n )\n action = response[\"action\"]\n if action == \"redirect\":\n redirect_url = response[\"redirectURL\"]\n assert redirect_url\n await route._redirected_navigation_request(redirect_url)\n return\n\n if action == \"fulfill\":\n # If the response status is -1, the request was canceled or stalled, so we just stall it here.\n # See https://github.com/microsoft/playwright/issues/29311.\n # TODO: it'd be better to abort such requests, but then we likely need to respect the timing,\n # because the request might have been stalled for a long time until the very end of the\n # test when HAR was recorded but we'd abort it immediately.\n if response.get(\"status\") == -1:\n return\n body = response[\"body\"]\n assert body is not None\n await route.fulfill(\n status=response.get(\"status\"),\n headers={\n v[\"name\"]: v[\"value\"]\n for v in cast(HeadersArray, response.get(\"headers\", []))\n },\n body=base64.b64decode(body),\n )\n return\n\n if action == \"error\":\n pass\n # Report the error, but fall through to the default handler.\n\n if self._not_found_action == \"abort\":\n await route.abort()\n return\n\n await route.fallback()\n\n async def add_context_route(self, context: \"BrowserContext\") -> None:\n await context.route(\n url=self._options_url_match or \"**/*\",\n handler=lambda route, _: asyncio.create_task(self._handle(route)),\n )\n\n async def add_page_route(self, page: \"Page\") -> None:\n await page.route(\n url=self._options_url_match or \"**/*\",\n handler=lambda route, _: asyncio.create_task(self._handle(route)),\n )\n\n def dispose(self) -> None:\n asyncio.create_task(\n self._local_utils._channel.send(\"harClose\", None, {\"harId\": self._har_id})\n )\n" }, { "path": "playwright/_impl/_helper.py", "content": "# Copyright (c) Microsoft Corporation.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\nimport asyncio\nimport math\nimport os\nimport re\nimport time\nimport traceback\nfrom pathlib import Path\nfrom types import TracebackType\nfrom typing import (\n TYPE_CHECKING,\n Any,\n Callable,\n Dict,\n List,\n Literal,\n Optional,\n Pattern,\n Set,\n Tuple,\n TypedDict,\n TypeVar,\n Union,\n cast,\n)\nfrom urllib.parse import ParseResult, urljoin, urlparse, urlunparse\n\nfrom playwright._impl._api_structures import NameValue\nfrom playwright._impl._errors import (\n Error,\n TargetClosedError,\n TimeoutError,\n is_target_closed_error,\n rewrite_error,\n)\nfrom playwright._impl._glob import glob_to_regex_pattern\nfrom playwright._impl._greenlets import RouteGreenlet\nfrom playwright._impl._str_utils import escape_regex_flags\n\nif TYPE_CHECKING: # pragma: no cover\n from playwright._impl._api_structures import HeadersArray\n from playwright._impl._network import Request, Response, Route, WebSocketRoute\n\nURLMatch = Union[str, Pattern[str], Callable[[str], bool]]\nURLMatchRequest = Union[str, Pattern[str], Callable[[\"Request\"], bool]]\nURLMatchResponse = Union[str, Pattern[str], Callable[[\"Response\"], bool]]\nRouteHandlerCallback = Union[\n Callable[[\"Route\"], Any], Callable[[\"Route\", \"Request\"], Any]\n]\nWebSocketRouteHandlerCallback = Callable[[\"WebSocketRoute\"], Any]\n\nColorScheme = Literal[\"dark\", \"light\", \"no-preference\", \"null\"]\nForcedColors = Literal[\"active\", \"none\", \"null\"]\nContrast = Literal[\"more\", \"no-preference\", \"null\"]\nReducedMotion = Literal[\"no-preference\", \"null\", \"reduce\"]\nDocumentLoadState = Literal[\"commit\", \"domcontentloaded\", \"load\", \"networkidle\"]\nKeyboardModifier = Literal[\"Alt\", \"Control\", \"ControlOrMeta\", \"Meta\", \"Shift\"]\nMouseButton = Literal[\"left\", \"middle\", \"right\"]\nServiceWorkersPolicy = Literal[\"allow\", \"block\"]\nHarMode = Literal[\"full\", \"minimal\"]\nHarContentPolicy = Literal[\"attach\", \"embed\", \"omit\"]\nRouteFromHarNotFoundPolicy = Literal[\"abort\", \"fallback\"]\n\n\nclass ErrorPayload(TypedDict, total=False):\n message: str\n name: str\n stack: str\n value: Optional[Any]\n\n\nclass HarRecordingMetadata(TypedDict, total=False):\n path: str\n content: Optional[HarContentPolicy]\n\n\ndef prepare_record_har_options(params: Dict) -> Dict[str, Any]:\n out_params: Dict[str, Any] = {\"path\": str(params[\"recordHarPath\"])}\n if \"recordHarUrlFilter\" in params:\n opt = params[\"recordHarUrlFilter\"]\n if isinstance(opt, str):\n out_params[\"urlGlob\"] = opt\n if isinstance(opt, Pattern):\n out_params[\"urlRegexSource\"] = opt.pattern\n out_params[\"urlRegexFlags\"] = escape_regex_flags(opt)\n del params[\"recordHarUrlFilter\"]\n if \"recordHarMode\" in params:\n out_params[\"mode\"] = params[\"recordHarMode\"]\n del params[\"recordHarMode\"]\n\n new_content_api = None\n old_content_api = None\n if \"recordHarContent\" in params:\n new_content_api = params[\"recordHarContent\"]\n del params[\"recordHarContent\"]\n if \"recordHarOmitContent\" in params:\n old_content_api = params[\"recordHarOmitContent\"]\n del params[\"recordHarOmitContent\"]\n content = new_content_api or (\"omit\" if old_content_api else None)\n if content:\n out_params[\"content\"] = content\n\n return out_params\n\n\nclass ParsedMessageParams(TypedDict):\n type: str\n guid: str\n initializer: Dict\n\n\nclass ParsedMessagePayload(TypedDict, total=False):\n id: int\n guid: str\n method: str\n params: ParsedMessageParams\n result: Any\n error: ErrorPayload\n\n\nclass Document(TypedDict):\n request: Optional[Any]\n\n\nclass FrameNavigatedEvent(TypedDict):\n url: str\n name: str\n newDocument: Optional[Document]\n error: Optional[str]\n\n\nEnv = Dict[str, Union[str, float, bool]]\n\n\ndef url_matches(\n base_url: Optional[str],\n url_string: str,\n match: Optional[URLMatch],\n websocket_url: bool = None,\n) -> bool:\n if not match:\n return True\n if isinstance(match, str):\n match = re.compile(\n resolve_glob_to_regex_pattern(base_url, match, websocket_url)\n )\n if isinstance(match, Pattern):\n return bool(match.search(url_string))\n return match(url_string)\n\n\ndef resolve_glob_to_regex_pattern(\n base_url: Optional[str], glob: str, websocket_url: bool = None\n) -> str:\n if websocket_url:\n base_url = to_websocket_base_url(base_url)\n glob = resolve_glob_base(base_url, glob)\n return glob_to_regex_pattern(glob)\n\n\ndef to_websocket_base_url(base_url: Optional[str]) -> Optional[str]:\n if base_url is not None and re.match(r\"^https?://\", base_url):\n base_url = re.sub(r\"^http\", \"ws\", base_url)\n return base_url\n\n\ndef resolve_glob_base(base_url: Optional[str], match: str) -> str:\n if match[0] == \"*\":\n return match\n\n token_map: Dict[str, str] = {}\n\n def map_token(original: str, replacement: str) -> str:\n if len(original) == 0:\n return \"\"\n token_map[replacement] = original\n return replacement\n\n # Escaped `\\\\?` behaves the same as `?` in our glob patterns.\n match = match.replace(r\"\\\\?\", \"?\")\n # Special case about: URLs as they are not relative to base_url\n if (\n match.startswith(\"about:\")\n or match.startswith(\"data:\")\n or match.startswith(\"chrome:\")\n or match.startswith(\"edge:\")\n or match.startswith(\"file:\")\n ):\n # about: and data: URLs are not relative to base_url, so we return them as is.\n return match\n # Glob symbols may be escaped in the URL and some of them such as ? affect resolution,\n # so we replace them with safe components first.\n processed_parts = []\n for index, token in enumerate(match.split(\"/\")):\n if token in (\".\", \"..\", \"\"):\n processed_parts.append(token)\n continue\n # Handle special case of http*://, note that the new schema has to be\n # a web schema so that slashes are properly inserted after domain.\n if index == 0 and token.endswith(\":\"):\n # Replace any pattern with http:\n if \"*\" in token or \"{\" in token:\n processed_parts.append(map_token(token, \"http:\"))\n else:\n # Preserve explicit schema as is as it may affect trailing slashes after domain.\n processed_parts.append(token)\n continue\n question_index = token.find(\"?\")\n if question_index == -1:\n processed_parts.append(map_token(token, f\"$_{index}_$\"))\n else:\n new_prefix = map_token(token[:question_index], f\"$_{index}_$\")\n new_suffix = map_token(token[question_index:], f\"?$_{index}_$\")\n processed_parts.append(new_prefix + new_suffix)\n\n relative_path = \"/\".join(processed_parts)\n resolved, case_insensitive_part = resolve_base_url(base_url, relative_path)\n\n for token, original in token_map.items():\n normalize = case_insensitive_part and token in case_insensitive_part\n resolved = resolved.replace(\n token, original.lower() if normalize else original, 1\n )\n\n return resolved\n\n\ndef resolve_base_url(\n base_url: Optional[str], given_url: str\n) -> Tuple[str, Optional[str]]:\n try:\n url = nodelike_urlparse(\n urljoin(base_url if base_url is not None else \"\", given_url)\n )\n resolved = urlunparse(url)\n # Schema and domain are case-insensitive.\n hostname_port = (\n url.hostname or \"\"\n ) # can't use parsed.netloc because it includes userinfo (username:password)\n if url.port:\n hostname_port += f\":{url.port}\"\n case_insensitive_prefix = f\"{url.scheme}://{hostname_port}\"\n return resolved, case_insensitive_prefix\n except Exception:\n return given_url, None\n\n\ndef nodelike_urlparse(url: str) -> ParseResult:\n parsed = urlparse(url, allow_fragments=True)\n\n # https://url.spec.whatwg.org/#special-scheme\n is_special_url = parsed.scheme in [\"http\", \"https\", \"ws\", \"wss\", \"ftp\", \"file\"]\n if is_special_url:\n # special urls have a list path, list paths are serialized as follows: https://url.spec.whatwg.org/#url-path-serializer\n # urllib diverges, so we patch it here\n if parsed.path == \"\":\n parsed = parsed._replace(path=\"/\")\n\n return parsed\n\n\nclass HarLookupResult(TypedDict, total=False):\n action: Literal[\"error\", \"redirect\", \"fulfill\", \"noentry\"]\n message: Optional[str]\n redirectURL: Optional[str]\n status: Optional[int]\n headers: Optional[\"HeadersArray\"]\n body: Optional[str]\n\n\nDEFAULT_PLAYWRIGHT_TIMEOUT_IN_MILLISECONDS = 30000\nDEFAULT_PLAYWRIGHT_LAUNCH_TIMEOUT_IN_MILLISECONDS = 180000\nPLAYWRIGHT_MAX_DEADLINE = 2147483647 # 2^31-1\n\n\nclass TimeoutSettings:\n\n @staticmethod\n def launch_timeout(timeout: Optional[float] = None) -> float:\n return (\n timeout\n if timeout is not None\n else DEFAULT_PLAYWRIGHT_LAUNCH_TIMEOUT_IN_MILLISECONDS\n )\n\n def __init__(self, parent: Optional[\"TimeoutSettings\"]) -> None:\n self._parent = parent\n self._default_timeout: Optional[float] = None\n self._default_navigation_timeout: Optional[float] = None\n\n def set_default_timeout(self, timeout: Optional[float]) -> None:\n self._default_timeout = timeout\n\n def timeout(self, timeout: float = None) -> float:\n if timeout is not None:\n return timeout\n if self._default_timeout is not None:\n return self._default_timeout\n if self._parent:\n return self._parent.timeout()\n return DEFAULT_PLAYWRIGHT_TIMEOUT_IN_MILLISECONDS\n\n def set_default_navigation_timeout(\n self, navigation_timeout: Optional[float]\n ) -> None:\n self._default_navigation_timeout = navigation_timeout\n\n def default_navigation_timeout(self) -> Optional[float]:\n return self._default_navigation_timeout\n\n def default_timeout(self) -> Optional[float]:\n return self._default_timeout\n\n def navigation_timeout(self, timeout: float = None) -> float:\n if timeout is not None:\n return timeout\n if self._default_navigation_timeout is not None:\n return self._default_navigation_timeout\n if self._default_timeout is not None:\n return self._default_timeout\n if self._parent:\n return self._parent.navigation_timeout()\n return DEFAULT_PLAYWRIGHT_TIMEOUT_IN_MILLISECONDS\n\n\ndef serialize_error(ex: Exception, tb: Optional[TracebackType]) -> ErrorPayload:\n return ErrorPayload(\n message=str(ex), name=\"Error\", stack=\"\".join(traceback.format_tb(tb))\n )\n\n\ndef parse_error(error: ErrorPayload, log: Optional[str] = None) -> Error:\n base_error_class = Error\n if error.get(\"name\") == \"TimeoutError\":\n base_error_class = TimeoutError\n if error.get(\"name\") == \"TargetClosedError\":\n base_error_class = TargetClosedError\n if not log:\n log = \"\"\n exc = base_error_class(patch_error_message(error[\"message\"]) + log)\n exc._name = error[\"name\"]\n exc._stack = error[\"stack\"]\n return exc\n\n\ndef patch_error_message(message: str) -> str:\n match = re.match(r\"(\\w+)(: expected .*)\", message)\n if match:\n message = to_snake_case(match.group(1)) + match.group(2)\n message = message.replace(\n \"Pass { acceptDownloads: true }\", \"Pass 'accept_downloads=True'\"\n )\n return message\n\n\ndef locals_to_params(args: Dict) -> Dict:\n copy = {}\n for key in args:\n if key == \"self\":\n continue\n if args[key] is not None:\n copy[key] = (\n args[key]\n if not isinstance(args[key], Dict)\n else locals_to_params(args[key])\n )\n return copy\n\n\ndef monotonic_time() -> int:\n return math.floor(time.monotonic() * 1000)\n\n\nclass RouteHandlerInvocation:\n complete: \"asyncio.Future\"\n route: \"Route\"\n\n def __init__(self, complete: \"asyncio.Future\", route: \"Route\") -> None:\n self.complete = complete\n self.route = route\n\n\nclass RouteHandler:\n def __init__(\n self,\n base_url: Optional[str],\n url: URLMatch,\n handler: RouteHandlerCallback,\n is_sync: bool,\n times: Optional[int] = None,\n ):\n self._base_url = base_url\n self.url = url\n self.handler = handler\n self._times = times if times else math.inf\n self._handled_count = 0\n self._is_sync = is_sync\n self._ignore_exception = False\n self._active_invocations: Set[RouteHandlerInvocation] = set()\n\n def matches(self, request_url: str) -> bool:\n return url_matches(self._base_url, request_url, self.url)\n\n async def handle(self, route: \"Route\") -> bool:\n handler_invocation = RouteHandlerInvocation(\n asyncio.get_running_loop().create_future(), route\n )\n self._active_invocations.add(handler_invocation)\n try:\n return await self._handle_internal(route)\n except Exception as e:\n # If the handler was stopped (without waiting for completion), we ignore all exceptions.\n if self._ignore_exception:\n return False\n if is_target_closed_error(e):\n # We are failing in the handler because the target has closed.\n # Give user a hint!\n optional_async_prefix = \"await \" if not self._is_sync else \"\"\n raise rewrite_error(\n e,\n f\"\\\"{str(e)}\\\" while running route callback.\\nConsider awaiting `{optional_async_prefix}page.unroute_all(behavior='ignoreErrors')`\\nbefore the end of the test to ignore remaining routes in flight.\",\n )\n raise e\n finally:\n handler_invocation.complete.set_result(None)\n self._active_invocations.remove(handler_invocation)\n\n async def _handle_internal(self, route: \"Route\") -> bool:\n handled_future = route._start_handling()\n\n self._handled_count += 1\n if self._is_sync:\n handler_finished_future = route._loop.create_future()\n\n def _handler() -> None:\n try:\n self.handler(route, route.request) # type: ignore\n handler_finished_future.set_result(None)\n except Exception as e:\n handler_finished_future.set_exception(e)\n\n # As with event handlers, each route handler is a potentially blocking context\n # so it needs a fiber.\n g = RouteGreenlet(_handler)\n g.switch()\n await handler_finished_future\n else:\n coro_or_future = self.handler(route, route.request) # type: ignore\n if coro_or_future:\n # separate task so that we get a proper stack trace for exceptions / tracing api_name extraction\n await asyncio.ensure_future(coro_or_future)\n return await handled_future\n\n async def stop(self, behavior: Literal[\"ignoreErrors\", \"wait\"]) -> None:\n # When a handler is manually unrouted or its page/context is closed we either\n # - wait for the current handler invocations to finish\n # - or do not wait, if the user opted out of it, but swallow all exceptions\n # that happen after the unroute/close.\n if behavior == \"ignoreErrors\":\n self._ignore_exception = True\n else:\n tasks = []\n for activation in self._active_invocations:\n if not activation.route._did_throw:\n tasks.append(activation.complete)\n await asyncio.gather(*tasks)\n\n @property\n def will_expire(self) -> bool:\n return self._handled_count + 1 >= self._times\n\n @staticmethod\n def prepare_interception_patterns(\n handlers: List[\"RouteHandler\"],\n ) -> List[Dict[str, str]]:\n patterns = []\n all = False\n for handler in handlers:\n if isinstance(handler.url, str):\n patterns.append({\"glob\": handler.url})\n elif isinstance(handler.url, re.Pattern):\n patterns.append(\n {\n \"regexSource\": handler.url.pattern,\n \"regexFlags\": escape_regex_flags(handler.url),\n }\n )\n else:\n all = True\n if all:\n return [{\"glob\": \"**/*\"}]\n return patterns\n\n\nto_snake_case_regex = re.compile(\"((?<=[a-z0-9])[A-Z]|(?!^)[A-Z](?=[a-z]))\")\n\n\ndef to_snake_case(name: str) -> str:\n return to_snake_case_regex.sub(r\"_\\1\", name).lower()\n\n\ndef make_dirs_for_file(path: Union[Path, str]) -> None:\n if not os.path.isabs(path):\n path = Path.cwd() / path\n os.makedirs(os.path.dirname(path), exist_ok=True)\n\n\nasync def async_writefile(file: Union[str, Path], data: Union[str, bytes]) -> None:\n def inner() -> None:\n with open(file, \"w\" if isinstance(data, str) else \"wb\") as fh:\n fh.write(data)\n\n loop = asyncio.get_running_loop()\n await loop.run_in_executor(None, inner)\n\n\nasync def async_readfile(file: Union[str, Path]) -> bytes:\n def inner() -> bytes:\n with open(file, \"rb\") as fh:\n return fh.read()\n\n loop = asyncio.get_running_loop()\n return await loop.run_in_executor(None, inner)\n\n\nT = TypeVar(\"T\")\n\n\ndef to_impl(obj: T) -> T:\n if hasattr(obj, \"_impl_obj\"):\n return cast(Any, obj)._impl_obj\n return obj\n\n\ndef object_to_array(obj: Optional[Dict]) -> Optional[List[NameValue]]:\n if not obj:\n return None\n result = []\n for key, value in obj.items():\n result.append(NameValue(name=key, value=str(value)))\n return result\n\n\ndef is_file_payload(value: Optional[Any]) -> bool:\n return (\n isinstance(value, dict)\n and \"name\" in value\n and \"mimeType\" in value\n and \"buffer\" in value\n )\n\n\nTEXTUAL_MIME_TYPE = re.compile(\n r\"^(text\\/.*?|application\\/(json|(x-)?javascript|xml.*?|ecmascript|graphql|x-www-form-urlencoded)|image\\/svg(\\+xml)?|application\\/.*?(\\+json|\\+xml))(;\\s*charset=.*)?$\"\n)\n\n\ndef is_textual_mime_type(mime_type: str) -> bool:\n return bool(TEXTUAL_MIME_TYPE.match(mime_type))\n" }, { "path": "playwright/_impl/_impl_to_api_mapping.py", "content": "# Copyright (c) Microsoft Corporation.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n\nimport inspect\nfrom typing import Any, Callable, Dict, List, Optional, Sequence, Union\n\nfrom playwright._impl._errors import Error\nfrom playwright._impl._map import Map\n\nAPI_ATTR = \"_pw_api_instance_\"\nIMPL_ATTR = \"_pw_impl_instance_\"\n\n\nclass ImplWrapper:\n def __init__(self, impl_obj: Any) -> None:\n self._impl_obj = impl_obj\n\n def __repr__(self) -> str:\n return self._impl_obj.__repr__()\n\n\nclass ImplToApiMapping:\n def __init__(self) -> None:\n self._mapping: Dict[type, type] = {}\n\n def register(self, impl_class: type, api_class: type) -> None:\n self._mapping[impl_class] = api_class\n\n def from_maybe_impl(\n self, obj: Any, visited: Optional[Map[Any, Union[List, Dict]]] = None\n ) -> Any:\n # Python does share default arguments between calls, so we need to\n # create a new map if it is not provided.\n if not visited:\n visited = Map()\n if not obj:\n return obj\n if isinstance(obj, dict):\n if obj in visited:\n return visited[obj]\n o: Dict = {}\n visited[obj] = o\n for name, value in obj.items():\n o[name] = self.from_maybe_impl(value, visited)\n return o\n if isinstance(obj, list):\n if obj in visited:\n return visited[obj]\n a: List = []\n visited[obj] = a\n for item in obj:\n a.append(self.from_maybe_impl(item, visited))\n return a\n api_class = self._mapping.get(type(obj))\n if api_class:\n api_instance = getattr(obj, API_ATTR, None)\n if not api_instance:\n api_instance = api_class(obj)\n setattr(obj, API_ATTR, api_instance)\n return api_instance\n else:\n return obj\n\n def from_impl(self, obj: Any) -> Any:\n assert obj\n result = self.from_maybe_impl(obj)\n assert result\n return result\n\n def from_impl_nullable(self, obj: Any = None) -> Optional[Any]:\n return self.from_impl(obj) if obj else None\n\n def from_impl_list(self, items: Sequence[Any]) -> List[Any]:\n return list(map(lambda a: self.from_impl(a), items))\n\n def from_impl_dict(self, map: Dict[str, Any]) -> Dict[str, Any]:\n return {name: self.from_impl(value) for name, value in map.items()}\n\n def to_impl(\n self, obj: Any, visited: Optional[Map[Any, Union[List, Dict]]] = None\n ) -> Any:\n if visited is None:\n visited = Map()\n try:\n if not obj:\n return obj\n if isinstance(obj, dict):\n if obj in visited:\n return visited[obj]\n o: Dict = {}\n visited[obj] = o\n for name, value in obj.items():\n o[name] = self.to_impl(value, visited)\n return o\n if isinstance(obj, list):\n if obj in visited:\n return visited[obj]\n a: List = []\n visited[obj] = a\n for item in obj:\n a.append(self.to_impl(item, visited))\n return a\n if isinstance(obj, ImplWrapper):\n return obj._impl_obj\n return obj\n except RecursionError:\n raise Error(\"Maximum argument depth exceeded\")\n\n def wrap_handler(self, handler: Callable[..., Any]) -> Callable[..., None]:\n def wrapper_func(*args: Any) -> Any:\n arg_count = len(inspect.signature(handler).parameters)\n return handler(\n *list(map(lambda a: self.from_maybe_impl(a), args))[:arg_count]\n )\n\n if inspect.ismethod(handler):\n wrapper = getattr(handler.__self__, IMPL_ATTR + handler.__name__, None)\n if not wrapper:\n wrapper = wrapper_func\n setattr(\n handler.__self__,\n IMPL_ATTR + handler.__name__,\n wrapper,\n )\n return wrapper\n\n wrapper = getattr(handler, IMPL_ATTR, None)\n if not wrapper:\n wrapper = wrapper_func\n setattr(handler, IMPL_ATTR, wrapper)\n return wrapper\n" }, { "path": "playwright/_impl/_input.py", "content": "# Copyright (c) Microsoft Corporation.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n\nfrom playwright._impl._connection import Channel\nfrom playwright._impl._helper import MouseButton, locals_to_params\n\n\nclass Keyboard:\n def __init__(self, channel: Channel) -> None:\n self._channel = channel\n self._loop = channel._connection._loop\n self._dispatcher_fiber = channel._connection._dispatcher_fiber\n\n async def down(self, key: str) -> None:\n await self._channel.send(\"keyboardDown\", None, locals_to_params(locals()))\n\n async def up(self, key: str) -> None:\n await self._channel.send(\"keyboardUp\", None, locals_to_params(locals()))\n\n async def insert_text(self, text: str) -> None:\n await self._channel.send(\"keyboardInsertText\", None, locals_to_params(locals()))\n\n async def type(self, text: str, delay: float = None) -> None:\n await self._channel.send(\"keyboardType\", None, locals_to_params(locals()))\n\n async def press(self, key: str, delay: float = None) -> None:\n await self._channel.send(\"keyboardPress\", None, locals_to_params(locals()))\n\n\nclass Mouse:\n def __init__(self, channel: Channel) -> None:\n self._channel = channel\n self._loop = channel._connection._loop\n self._dispatcher_fiber = channel._connection._dispatcher_fiber\n\n async def move(self, x: float, y: float, steps: int = None) -> None:\n await self._channel.send(\"mouseMove\", None, locals_to_params(locals()))\n\n async def down(\n self,\n button: MouseButton = None,\n clickCount: int = None,\n ) -> None:\n await self._channel.send(\"mouseDown\", None, locals_to_params(locals()))\n\n async def up(\n self,\n button: MouseButton = None,\n clickCount: int = None,\n ) -> None:\n await self._channel.send(\"mouseUp\", None, locals_to_params(locals()))\n\n async def _click(\n self,\n x: float,\n y: float,\n delay: float = None,\n button: MouseButton = None,\n clickCount: int = None,\n title: str = None,\n ) -> None:\n await self._channel.send(\n \"mouseClick\", None, locals_to_params(locals()), title=title\n )\n\n async def click(\n self,\n x: float,\n y: float,\n delay: float = None,\n button: MouseButton = None,\n clickCount: int = None,\n ) -> None:\n params = locals()\n del params[\"self\"]\n await self._click(**params)\n\n async def dblclick(\n self,\n x: float,\n y: float,\n delay: float = None,\n button: MouseButton = None,\n ) -> None:\n await self._click(\n x, y, delay=delay, button=button, clickCount=2, title=\"Double click\"\n )\n\n async def wheel(self, deltaX: float, deltaY: float) -> None:\n await self._channel.send(\"mouseWheel\", None, locals_to_params(locals()))\n\n\nclass Touchscreen:\n def __init__(self, channel: Channel) -> None:\n self._channel = channel\n self._loop = channel._connection._loop\n self._dispatcher_fiber = channel._connection._dispatcher_fiber\n\n async def tap(self, x: float, y: float) -> None:\n await self._channel.send(\"touchscreenTap\", None, locals_to_params(locals()))\n" }, { "path": "playwright/_impl/_js_handle.py", "content": "# Copyright (c) Microsoft Corporation.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n\nimport base64\nimport collections.abc\nimport datetime\nimport math\nimport struct\nimport traceback\nfrom pathlib import Path\nfrom typing import TYPE_CHECKING, Any, Dict, List, Optional, Union\nfrom urllib.parse import ParseResult, urlparse, urlunparse\n\nfrom playwright._impl._connection import Channel, ChannelOwner, from_channel\nfrom playwright._impl._errors import Error, is_target_closed_error\nfrom playwright._impl._map import Map\n\nif TYPE_CHECKING: # pragma: no cover\n from playwright._impl._element_handle import ElementHandle\n\n\nSerializable = Any\n\n\nclass VisitorInfo:\n visited: Map[Any, int]\n last_id: int\n\n def __init__(self) -> None:\n self.visited = Map()\n self.last_id = 0\n\n def visit(self, obj: Any) -> int:\n assert obj not in self.visited\n self.last_id += 1\n self.visited[obj] = self.last_id\n return self.last_id\n\n\nclass JSHandle(ChannelOwner):\n def __init__(\n self, parent: ChannelOwner, type: str, guid: str, initializer: Dict\n ) -> None:\n super().__init__(parent, type, guid, initializer)\n self._preview = self._initializer[\"preview\"]\n self._channel.on(\n \"previewUpdated\", lambda params: self._on_preview_updated(params[\"preview\"])\n )\n\n def __repr__(self) -> str:\n return f\"\"\n\n def __str__(self) -> str:\n return self._preview\n\n def _on_preview_updated(self, preview: str) -> None:\n self._preview = preview\n\n async def evaluate(self, expression: str, arg: Serializable = None) -> Any:\n return parse_result(\n await self._channel.send(\n \"evaluateExpression\",\n None,\n dict(\n expression=expression,\n arg=serialize_argument(arg),\n ),\n )\n )\n\n async def evaluate_handle(\n self, expression: str, arg: Serializable = None\n ) -> \"JSHandle\":\n return from_channel(\n await self._channel.send(\n \"evaluateExpressionHandle\",\n None,\n dict(\n expression=expression,\n arg=serialize_argument(arg),\n ),\n )\n )\n\n async def get_property(self, propertyName: str) -> \"JSHandle\":\n return from_channel(\n await self._channel.send(\"getProperty\", None, dict(name=propertyName))\n )\n\n async def get_properties(self) -> Dict[str, \"JSHandle\"]:\n return {\n prop[\"name\"]: from_channel(prop[\"value\"])\n for prop in await self._channel.send(\n \"getPropertyList\",\n None,\n )\n }\n\n def as_element(self) -> Optional[\"ElementHandle\"]:\n return None\n\n async def dispose(self) -> None:\n try:\n await self._channel.send(\n \"dispose\",\n None,\n )\n except Exception as e:\n if not is_target_closed_error(e):\n raise e\n\n async def json_value(self) -> Any:\n return parse_result(\n await self._channel.send(\n \"jsonValue\",\n None,\n )\n )\n\n\ndef serialize_value(\n value: Any, handles: List[Channel], visitor_info: Optional[VisitorInfo] = None\n) -> Any:\n if visitor_info is None:\n visitor_info = VisitorInfo()\n if isinstance(value, JSHandle):\n h = len(handles)\n handles.append(value._channel)\n return dict(h=h)\n if value is None:\n return dict(v=\"null\")\n if isinstance(value, float):\n if value == float(\"inf\"):\n return dict(v=\"Infinity\")\n if value == float(\"-inf\"):\n return dict(v=\"-Infinity\")\n if value == float(\"-0\"):\n return dict(v=\"-0\")\n if math.isnan(value):\n return dict(v=\"NaN\")\n if isinstance(value, datetime.datetime):\n # Node.js Date objects are always in UTC.\n return {\n \"d\": datetime.datetime.strftime(\n value.astimezone(datetime.timezone.utc), \"%Y-%m-%dT%H:%M:%S.%fZ\"\n )\n }\n if isinstance(value, Exception):\n return {\n \"e\": {\n \"m\": str(value),\n \"n\": (\n (value.name or \"\")\n if isinstance(value, Error)\n else value.__class__.__name__\n ),\n \"s\": (\n (value.stack or \"\")\n if isinstance(value, Error)\n else \"\".join(\n traceback.format_exception(type(value), value=value, tb=None)\n )\n ),\n }\n }\n if isinstance(value, bool):\n return {\"b\": value}\n if isinstance(value, (int, float)):\n return {\"n\": value}\n if isinstance(value, str):\n return {\"s\": value}\n if isinstance(value, ParseResult):\n return {\"u\": urlunparse(value)}\n\n if value in visitor_info.visited:\n return dict(ref=visitor_info.visited[value])\n\n if isinstance(value, collections.abc.Sequence) and not isinstance(value, str):\n id = visitor_info.visit(value)\n a = []\n for e in value:\n a.append(serialize_value(e, handles, visitor_info))\n return dict(a=a, id=id)\n\n if isinstance(value, dict):\n id = visitor_info.visit(value)\n o = []\n for name in value:\n o.append(\n {\"k\": name, \"v\": serialize_value(value[name], handles, visitor_info)}\n )\n return dict(o=o, id=id)\n return dict(v=\"undefined\")\n\n\ndef serialize_argument(arg: Serializable = None) -> Any:\n handles: List[Channel] = []\n value = serialize_value(arg, handles)\n return dict(value=value, handles=handles)\n\n\ndef parse_value(value: Any, refs: Optional[Dict[int, Any]] = None) -> Any:\n if refs is None:\n refs = {}\n if value is None:\n return None\n if isinstance(value, dict):\n if \"ref\" in value:\n return refs[value[\"ref\"]]\n\n if \"v\" in value:\n v = value[\"v\"]\n if v == \"Infinity\":\n return float(\"inf\")\n if v == \"-Infinity\":\n return float(\"-inf\")\n if v == \"-0\":\n return float(\"-0\")\n if v == \"NaN\":\n return float(\"nan\")\n if v == \"undefined\":\n return None\n if v == \"null\":\n return None\n return v\n\n if \"u\" in value:\n return urlparse(value[\"u\"])\n\n if \"bi\" in value:\n return int(value[\"bi\"])\n\n if \"e\" in value:\n error = Error(value[\"e\"][\"m\"])\n error._name = value[\"e\"][\"n\"]\n error._stack = value[\"e\"][\"s\"]\n return error\n\n if \"a\" in value:\n a: List = []\n refs[value[\"id\"]] = a\n for e in value[\"a\"]:\n a.append(parse_value(e, refs))\n return a\n\n if \"d\" in value:\n # Node.js Date objects are always in UTC.\n return datetime.datetime.strptime(\n value[\"d\"], \"%Y-%m-%dT%H:%M:%S.%fZ\"\n ).replace(tzinfo=datetime.timezone.utc)\n\n if \"o\" in value:\n o: Dict = {}\n refs[value[\"id\"]] = o\n for e in value[\"o\"]:\n o[e[\"k\"]] = parse_value(e[\"v\"], refs)\n return o\n\n if \"n\" in value:\n return value[\"n\"]\n\n if \"s\" in value:\n return value[\"s\"]\n\n if \"b\" in value:\n return value[\"b\"]\n\n if \"ta\" in value:\n encoded_bytes = value[\"ta\"][\"b\"]\n decoded_bytes = base64.b64decode(encoded_bytes)\n array_type = value[\"ta\"][\"k\"]\n if array_type == \"i8\":\n word_size = 1\n fmt = \"b\"\n elif array_type == \"ui8\" or array_type == \"ui8c\":\n word_size = 1\n fmt = \"B\"\n elif array_type == \"i16\":\n word_size = 2\n fmt = \"h\"\n elif array_type == \"ui16\":\n word_size = 2\n fmt = \"H\"\n elif array_type == \"i32\":\n word_size = 4\n fmt = \"i\"\n elif array_type == \"ui32\":\n word_size = 4\n fmt = \"I\"\n elif array_type == \"f32\":\n word_size = 4\n fmt = \"f\"\n elif array_type == \"f64\":\n word_size = 8\n fmt = \"d\"\n elif array_type == \"bi64\":\n word_size = 8\n fmt = \"q\"\n elif array_type == \"bui64\":\n word_size = 8\n fmt = \"Q\"\n else:\n raise ValueError(f\"Unsupported array type: {array_type}\")\n\n byte_len = len(decoded_bytes)\n if byte_len % word_size != 0:\n raise ValueError(\n f\"Decoded bytes length {byte_len} is not a multiple of word size {word_size}\"\n )\n\n if byte_len == 0:\n return []\n array_len = byte_len // word_size\n # \"<\" denotes little-endian\n format_string = f\"<{array_len}{fmt}\"\n return list(struct.unpack(format_string, decoded_bytes))\n return value\n\n\ndef parse_result(result: Any) -> Any:\n return parse_value(result)\n\n\ndef add_source_url_to_script(source: str, path: Union[str, Path]) -> str:\n return source + \"\\n//# sourceURL=\" + str(path).replace(\"\\n\", \"\")\n" }, { "path": "playwright/_impl/_json_pipe.py", "content": "# Copyright (c) Microsoft Corporation.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n\nimport asyncio\nfrom typing import Dict, Optional, cast\n\nfrom pyee.asyncio import AsyncIOEventEmitter\n\nfrom playwright._impl._connection import Channel\nfrom playwright._impl._errors import TargetClosedError\nfrom playwright._impl._helper import Error, ParsedMessagePayload\nfrom playwright._impl._transport import Transport\n\n\nclass JsonPipeTransport(AsyncIOEventEmitter, Transport):\n def __init__(\n self,\n loop: asyncio.AbstractEventLoop,\n pipe_channel: Channel,\n ) -> None:\n super().__init__(loop)\n Transport.__init__(self, loop)\n self._stop_requested = False\n self._pipe_channel = pipe_channel\n\n def request_stop(self) -> None:\n self._stop_requested = True\n self._pipe_channel.send_no_reply(\"close\", None, {})\n\n def dispose(self) -> None:\n self.on_error_future.cancel()\n self._stopped_future.cancel()\n\n async def wait_until_stopped(self) -> None:\n await self._stopped_future\n\n async def connect(self) -> None:\n self._stopped_future: asyncio.Future = asyncio.Future()\n\n def handle_message(message: Dict) -> None:\n if self._stop_requested:\n return\n self.on_message(cast(ParsedMessagePayload, message))\n\n def handle_closed(reason: Optional[str]) -> None:\n self.emit(\"close\", reason)\n if reason:\n self.on_error_future.set_exception(TargetClosedError(reason))\n self._stopped_future.set_result(None)\n\n self._pipe_channel.on(\n \"message\",\n lambda params: handle_message(params[\"message\"]),\n )\n self._pipe_channel.on(\n \"closed\",\n lambda params: handle_closed(params.get(\"reason\")),\n )\n\n async def run(self) -> None:\n await self._stopped_future\n\n def send(self, message: Dict) -> None:\n if self._stop_requested:\n raise Error(\"Playwright connection closed\")\n self._pipe_channel.send_no_reply(\"send\", None, {\"message\": message})\n" }, { "path": "playwright/_impl/_local_utils.py", "content": "# Copyright (c) Microsoft Corporation.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n\nimport base64\nfrom typing import Dict, List, Optional, cast\n\nfrom playwright._impl._api_structures import HeadersArray\nfrom playwright._impl._connection import ChannelOwner, StackFrame\nfrom playwright._impl._helper import HarLookupResult, locals_to_params\n\n\nclass LocalUtils(ChannelOwner):\n def __init__(\n self, parent: ChannelOwner, type: str, guid: str, initializer: Dict\n ) -> None:\n super().__init__(parent, type, guid, initializer)\n self.devices = {\n device[\"name\"]: parse_device_descriptor(device[\"descriptor\"])\n for device in initializer[\"deviceDescriptors\"]\n }\n\n async def zip(self, params: Dict) -> None:\n await self._channel.send(\"zip\", None, params)\n\n async def har_open(self, file: str) -> None:\n params = locals_to_params(locals())\n await self._channel.send(\"harOpen\", None, params)\n\n async def har_lookup(\n self,\n harId: str,\n url: str,\n method: str,\n headers: HeadersArray,\n isNavigationRequest: bool,\n postData: Optional[bytes] = None,\n ) -> HarLookupResult:\n params = locals_to_params(locals())\n if \"postData\" in params:\n params[\"postData\"] = base64.b64encode(params[\"postData\"]).decode()\n return cast(\n HarLookupResult,\n await self._channel.send_return_as_dict(\"harLookup\", None, params),\n )\n\n async def har_close(self, harId: str) -> None:\n params = locals_to_params(locals())\n await self._channel.send(\"harClose\", None, params)\n\n async def har_unzip(self, zipFile: str, harFile: str) -> None:\n params = locals_to_params(locals())\n await self._channel.send(\"harUnzip\", None, params)\n\n async def tracing_started(self, tracesDir: Optional[str], traceName: str) -> str:\n params = locals_to_params(locals())\n return await self._channel.send(\"tracingStarted\", None, params)\n\n async def trace_discarded(self, stacks_id: str) -> None:\n return await self._channel.send(\"traceDiscarded\", None, {\"stacksId\": stacks_id})\n\n def add_stack_to_tracing_no_reply(self, id: int, frames: List[StackFrame]) -> None:\n self._channel.send_no_reply(\n \"addStackToTracingNoReply\",\n None,\n {\n \"callData\": {\n \"stack\": frames,\n \"id\": id,\n }\n },\n )\n\n\ndef parse_device_descriptor(dict: Dict) -> Dict:\n return {\n \"user_agent\": dict[\"userAgent\"],\n \"viewport\": dict[\"viewport\"],\n \"device_scale_factor\": dict[\"deviceScaleFactor\"],\n \"is_mobile\": dict[\"isMobile\"],\n \"has_touch\": dict[\"hasTouch\"],\n \"default_browser_type\": dict[\"defaultBrowserType\"],\n }\n" }, { "path": "playwright/_impl/_locator.py", "content": "# Copyright (c) Microsoft Corporation.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n\nimport json\nimport pathlib\nimport re\nfrom typing import (\n TYPE_CHECKING,\n Any,\n Awaitable,\n Callable,\n Dict,\n List,\n Literal,\n Optional,\n Pattern,\n Sequence,\n Tuple,\n TypeVar,\n Union,\n)\n\nfrom playwright._impl._api_structures import (\n AriaRole,\n FilePayload,\n FloatRect,\n FrameExpectOptions,\n FrameExpectResult,\n Position,\n)\nfrom playwright._impl._element_handle import ElementHandle\nfrom playwright._impl._helper import (\n Error,\n KeyboardModifier,\n MouseButton,\n locals_to_params,\n monotonic_time,\n to_impl,\n)\nfrom playwright._impl._js_handle import Serializable\nfrom playwright._impl._str_utils import (\n escape_for_attribute_selector,\n escape_for_text_selector,\n)\n\nif TYPE_CHECKING: # pragma: no cover\n from playwright._impl._frame import Frame\n from playwright._impl._js_handle import JSHandle\n from playwright._impl._page import Page\n\nT = TypeVar(\"T\")\n\n\nclass Locator:\n def __init__(\n self,\n frame: \"Frame\",\n selector: str,\n has_text: Union[str, Pattern[str]] = None,\n has_not_text: Union[str, Pattern[str]] = None,\n has: \"Locator\" = None,\n has_not: \"Locator\" = None,\n visible: bool = None,\n ) -> None:\n self._frame = frame\n self._selector = selector\n self._loop = frame._loop\n self._dispatcher_fiber = frame._connection._dispatcher_fiber\n\n if has_text:\n self._selector += f\" >> internal:has-text={escape_for_text_selector(has_text, exact=False)}\"\n\n if has:\n if has._frame != frame:\n raise Error('Inner \"has\" locator must belong to the same frame.')\n self._selector += \" >> internal:has=\" + json.dumps(\n has._selector, ensure_ascii=False\n )\n\n if has_not_text:\n self._selector += f\" >> internal:has-not-text={escape_for_text_selector(has_not_text, exact=False)}\"\n\n if has_not:\n locator = has_not\n if locator._frame != frame:\n raise Error('Inner \"has_not\" locator must belong to the same frame.')\n self._selector += \" >> internal:has-not=\" + json.dumps(locator._selector)\n\n if visible is not None:\n self._selector += f\" >> visible={bool_to_js_bool(visible)}\"\n\n def __repr__(self) -> str:\n return f\"\"\n\n async def _with_element(\n self,\n task: Callable[[ElementHandle, float], Awaitable[T]],\n timeout: float = None,\n ) -> T:\n timeout = self._frame._timeout(timeout)\n deadline = (monotonic_time() + timeout) if timeout else 0\n handle = await self.element_handle(timeout=timeout)\n if not handle:\n raise Error(f\"Could not resolve {self._selector} to DOM Element\")\n try:\n return await task(\n handle,\n (deadline - monotonic_time()) if deadline else 0,\n )\n finally:\n await handle.dispose()\n\n def _equals(self, locator: \"Locator\") -> bool:\n return self._frame == locator._frame and self._selector == locator._selector\n\n @property\n def page(self) -> \"Page\":\n return self._frame.page\n\n async def bounding_box(self, timeout: float = None) -> Optional[FloatRect]:\n return await self._with_element(\n lambda h, _: h.bounding_box(),\n timeout,\n )\n\n async def check(\n self,\n position: Position = None,\n timeout: float = None,\n force: bool = None,\n noWaitAfter: bool = None,\n trial: bool = None,\n ) -> None:\n params = locals_to_params(locals())\n return await self._frame.check(self._selector, strict=True, **params)\n\n async def click(\n self,\n modifiers: Sequence[KeyboardModifier] = None,\n position: Position = None,\n delay: float = None,\n button: MouseButton = None,\n clickCount: int = None,\n timeout: float = None,\n force: bool = None,\n noWaitAfter: bool = None,\n trial: bool = None,\n steps: int = None,\n ) -> None:\n params = locals_to_params(locals())\n return await self._frame._click(self._selector, strict=True, **params)\n\n async def dblclick(\n self,\n modifiers: Sequence[KeyboardModifier] = None,\n position: Position = None,\n delay: float = None,\n button: MouseButton = None,\n timeout: float = None,\n force: bool = None,\n noWaitAfter: bool = None,\n trial: bool = None,\n steps: int = None,\n ) -> None:\n params = locals_to_params(locals())\n return await self._frame.dblclick(self._selector, strict=True, **params)\n\n async def dispatch_event(\n self,\n type: str,\n eventInit: Dict = None,\n timeout: float = None,\n ) -> None:\n params = locals_to_params(locals())\n return await self._frame.dispatch_event(self._selector, strict=True, **params)\n\n async def evaluate(\n self, expression: str, arg: Serializable = None, timeout: float = None\n ) -> Any:\n return await self._with_element(\n lambda h, _: h.evaluate(expression, arg),\n timeout,\n )\n\n async def evaluate_all(self, expression: str, arg: Serializable = None) -> Any:\n params = locals_to_params(locals())\n return await self._frame.eval_on_selector_all(self._selector, **params)\n\n async def evaluate_handle(\n self, expression: str, arg: Serializable = None, timeout: float = None\n ) -> \"JSHandle\":\n return await self._with_element(\n lambda h, _: h.evaluate_handle(expression, arg), timeout\n )\n\n async def fill(\n self,\n value: str,\n timeout: float = None,\n noWaitAfter: bool = None,\n force: bool = None,\n ) -> None:\n params = locals_to_params(locals())\n return await self._frame.fill(self._selector, strict=True, **params)\n\n async def clear(\n self,\n timeout: float = None,\n noWaitAfter: bool = None,\n force: bool = None,\n ) -> None:\n params = locals_to_params(locals())\n await self._frame._fill(self._selector, value=\"\", title=\"Clear\", **params)\n\n def locator(\n self,\n selectorOrLocator: Union[str, \"Locator\"],\n hasText: Union[str, Pattern[str]] = None,\n hasNotText: Union[str, Pattern[str]] = None,\n has: \"Locator\" = None,\n hasNot: \"Locator\" = None,\n ) -> \"Locator\":\n if isinstance(selectorOrLocator, str):\n return Locator(\n self._frame,\n f\"{self._selector} >> {selectorOrLocator}\",\n has_text=hasText,\n has_not_text=hasNotText,\n has_not=hasNot,\n has=has,\n )\n selectorOrLocator = to_impl(selectorOrLocator)\n if selectorOrLocator._frame != self._frame:\n raise Error(\"Locators must belong to the same frame.\")\n return Locator(\n self._frame,\n f\"{self._selector} >> internal:chain={json.dumps(selectorOrLocator._selector)}\",\n has_text=hasText,\n has_not_text=hasNotText,\n has_not=hasNot,\n has=has,\n )\n\n def get_by_alt_text(\n self, text: Union[str, Pattern[str]], exact: bool = None\n ) -> \"Locator\":\n return self.locator(get_by_alt_text_selector(text, exact=exact))\n\n def get_by_label(\n self, text: Union[str, Pattern[str]], exact: bool = None\n ) -> \"Locator\":\n return self.locator(get_by_label_selector(text, exact=exact))\n\n def get_by_placeholder(\n self, text: Union[str, Pattern[str]], exact: bool = None\n ) -> \"Locator\":\n return self.locator(get_by_placeholder_selector(text, exact=exact))\n\n def get_by_role(\n self,\n role: AriaRole,\n checked: bool = None,\n disabled: bool = None,\n expanded: bool = None,\n includeHidden: bool = None,\n level: int = None,\n name: Union[str, Pattern[str]] = None,\n pressed: bool = None,\n selected: bool = None,\n exact: bool = None,\n ) -> \"Locator\":\n return self.locator(\n get_by_role_selector(\n role,\n checked=checked,\n disabled=disabled,\n expanded=expanded,\n includeHidden=includeHidden,\n level=level,\n name=name,\n pressed=pressed,\n selected=selected,\n exact=exact,\n )\n )\n\n def get_by_test_id(self, testId: Union[str, Pattern[str]]) -> \"Locator\":\n return self.locator(get_by_test_id_selector(test_id_attribute_name(), testId))\n\n def get_by_text(\n self, text: Union[str, Pattern[str]], exact: bool = None\n ) -> \"Locator\":\n return self.locator(get_by_text_selector(text, exact=exact))\n\n def get_by_title(\n self, text: Union[str, Pattern[str]], exact: bool = None\n ) -> \"Locator\":\n return self.locator(get_by_title_selector(text, exact=exact))\n\n def frame_locator(self, selector: str) -> \"FrameLocator\":\n return FrameLocator(self._frame, self._selector + \" >> \" + selector)\n\n async def element_handle(\n self,\n timeout: float = None,\n ) -> ElementHandle:\n params = locals_to_params(locals())\n handle = await self._frame.wait_for_selector(\n self._selector, strict=True, state=\"attached\", **params\n )\n assert handle\n return handle\n\n async def element_handles(self) -> List[ElementHandle]:\n return await self._frame.query_selector_all(self._selector)\n\n @property\n def first(self) -> \"Locator\":\n return Locator(self._frame, f\"{self._selector} >> nth=0\")\n\n @property\n def last(self) -> \"Locator\":\n return Locator(self._frame, f\"{self._selector} >> nth=-1\")\n\n def nth(self, index: int) -> \"Locator\":\n return Locator(self._frame, f\"{self._selector} >> nth={index}\")\n\n @property\n def content_frame(self) -> \"FrameLocator\":\n return FrameLocator(self._frame, self._selector)\n\n def describe(self, description: str) -> \"Locator\":\n return Locator(\n self._frame,\n f\"{self._selector} >> internal:describe={json.dumps(description)}\",\n )\n\n @property\n def description(self) -> Optional[str]:\n try:\n match = re.search(\n r' >> internal:describe=(\"(?:[^\"\\\\]|\\\\.)*\")$', self._selector\n )\n if match:\n description = json.loads(match.group(1))\n if isinstance(description, str):\n return description\n except (json.JSONDecodeError, ValueError):\n pass\n return None\n\n def filter(\n self,\n hasText: Union[str, Pattern[str]] = None,\n hasNotText: Union[str, Pattern[str]] = None,\n has: \"Locator\" = None,\n hasNot: \"Locator\" = None,\n visible: bool = None,\n ) -> \"Locator\":\n return Locator(\n self._frame,\n self._selector,\n has_text=hasText,\n has_not_text=hasNotText,\n has=has,\n has_not=hasNot,\n visible=visible,\n )\n\n def or_(self, locator: \"Locator\") -> \"Locator\":\n if locator._frame != self._frame:\n raise Error(\"Locators must belong to the same frame.\")\n return Locator(\n self._frame,\n self._selector + \" >> internal:or=\" + json.dumps(locator._selector),\n )\n\n def and_(self, locator: \"Locator\") -> \"Locator\":\n if locator._frame != self._frame:\n raise Error(\"Locators must belong to the same frame.\")\n return Locator(\n self._frame,\n self._selector + \" >> internal:and=\" + json.dumps(locator._selector),\n )\n\n async def focus(self, timeout: float = None) -> None:\n params = locals_to_params(locals())\n return await self._frame.focus(self._selector, strict=True, **params)\n\n async def blur(self, timeout: float = None) -> None:\n await self._frame._channel.send(\n \"blur\",\n self._frame._timeout,\n {\n \"selector\": self._selector,\n \"strict\": True,\n **locals_to_params(locals()),\n },\n )\n\n async def all(\n self,\n ) -> List[\"Locator\"]:\n result = []\n for index in range(await self.count()):\n result.append(self.nth(index))\n return result\n\n async def count(\n self,\n ) -> int:\n return await self._frame._query_count(self._selector)\n\n async def drag_to(\n self,\n target: \"Locator\",\n force: bool = None,\n noWaitAfter: bool = None,\n timeout: float = None,\n trial: bool = None,\n sourcePosition: Position = None,\n targetPosition: Position = None,\n steps: int = None,\n ) -> None:\n params = locals_to_params(locals())\n del params[\"target\"]\n return await self._frame.drag_and_drop(\n self._selector, target._selector, strict=True, **params\n )\n\n async def get_attribute(self, name: str, timeout: float = None) -> Optional[str]:\n params = locals_to_params(locals())\n return await self._frame.get_attribute(\n self._selector,\n strict=True,\n **params,\n )\n\n async def hover(\n self,\n modifiers: Sequence[KeyboardModifier] = None,\n position: Position = None,\n timeout: float = None,\n noWaitAfter: bool = None,\n force: bool = None,\n trial: bool = None,\n ) -> None:\n params = locals_to_params(locals())\n return await self._frame.hover(\n self._selector,\n strict=True,\n **params,\n )\n\n async def inner_html(self, timeout: float = None) -> str:\n params = locals_to_params(locals())\n return await self._frame.inner_html(\n self._selector,\n strict=True,\n **params,\n )\n\n async def inner_text(self, timeout: float = None) -> str:\n params = locals_to_params(locals())\n return await self._frame.inner_text(\n self._selector,\n strict=True,\n **params,\n )\n\n async def input_value(self, timeout: float = None) -> str:\n params = locals_to_params(locals())\n return await self._frame.input_value(\n self._selector,\n strict=True,\n **params,\n )\n\n async def is_checked(self, timeout: float = None) -> bool:\n params = locals_to_params(locals())\n return await self._frame.is_checked(\n self._selector,\n strict=True,\n **params,\n )\n\n async def is_disabled(self, timeout: float = None) -> bool:\n params = locals_to_params(locals())\n return await self._frame.is_disabled(\n self._selector,\n strict=True,\n **params,\n )\n\n async def is_editable(self, timeout: float = None) -> bool:\n params = locals_to_params(locals())\n return await self._frame.is_editable(\n self._selector,\n strict=True,\n **params,\n )\n\n async def is_enabled(self, timeout: float = None) -> bool:\n params = locals_to_params(locals())\n return await self._frame.is_enabled(\n self._selector,\n strict=True,\n **params,\n )\n\n async def is_hidden(self, timeout: float = None) -> bool:\n # timeout is deprecated and does nothing\n return await self._frame.is_hidden(\n self._selector,\n strict=True,\n )\n\n async def is_visible(self, timeout: float = None) -> bool:\n # timeout is deprecated and does nothing\n return await self._frame.is_visible(\n self._selector,\n strict=True,\n )\n\n async def press(\n self,\n key: str,\n delay: float = None,\n timeout: float = None,\n noWaitAfter: bool = None,\n ) -> None:\n params = locals_to_params(locals())\n return await self._frame.press(self._selector, strict=True, **params)\n\n async def screenshot(\n self,\n timeout: float = None,\n type: Literal[\"jpeg\", \"png\"] = None,\n path: Union[str, pathlib.Path] = None,\n quality: int = None,\n omitBackground: bool = None,\n animations: Literal[\"allow\", \"disabled\"] = None,\n caret: Literal[\"hide\", \"initial\"] = None,\n scale: Literal[\"css\", \"device\"] = None,\n mask: Sequence[\"Locator\"] = None,\n maskColor: str = None,\n style: str = None,\n ) -> bytes:\n params = locals_to_params(locals())\n return await self._with_element(\n lambda h, timeout: h.screenshot(\n **{**params, \"timeout\": timeout},\n ),\n )\n\n async def aria_snapshot(self, timeout: float = None) -> str:\n return await self._frame._channel.send(\n \"ariaSnapshot\",\n self._frame._timeout,\n {\n \"selector\": self._selector,\n **locals_to_params(locals()),\n },\n )\n\n async def scroll_into_view_if_needed(\n self,\n timeout: float = None,\n ) -> None:\n return await self._with_element(\n lambda h, timeout: h.scroll_into_view_if_needed(timeout=timeout),\n timeout,\n )\n\n async def select_option(\n self,\n value: Union[str, Sequence[str]] = None,\n index: Union[int, Sequence[int]] = None,\n label: Union[str, Sequence[str]] = None,\n element: Union[\"ElementHandle\", Sequence[\"ElementHandle\"]] = None,\n timeout: float = None,\n noWaitAfter: bool = None,\n force: bool = None,\n ) -> List[str]:\n params = locals_to_params(locals())\n return await self._frame.select_option(\n self._selector,\n strict=True,\n **params,\n )\n\n async def select_text(self, force: bool = None, timeout: float = None) -> None:\n params = locals_to_params(locals())\n return await self._with_element(\n lambda h, timeout: h.select_text(**{**params, \"timeout\": timeout}),\n timeout,\n )\n\n async def set_input_files(\n self,\n files: Union[\n str,\n pathlib.Path,\n FilePayload,\n Sequence[Union[str, pathlib.Path]],\n Sequence[FilePayload],\n ],\n timeout: float = None,\n noWaitAfter: bool = None,\n ) -> None:\n params = locals_to_params(locals())\n return await self._frame.set_input_files(\n self._selector,\n strict=True,\n **params,\n )\n\n async def tap(\n self,\n modifiers: Sequence[KeyboardModifier] = None,\n position: Position = None,\n timeout: float = None,\n force: bool = None,\n noWaitAfter: bool = None,\n trial: bool = None,\n ) -> None:\n params = locals_to_params(locals())\n return await self._frame.tap(\n self._selector,\n strict=True,\n **params,\n )\n\n async def text_content(self, timeout: float = None) -> Optional[str]:\n params = locals_to_params(locals())\n return await self._frame.text_content(\n self._selector,\n strict=True,\n **params,\n )\n\n async def type(\n self,\n text: str,\n delay: float = None,\n timeout: float = None,\n noWaitAfter: bool = None,\n ) -> None:\n params = locals_to_params(locals())\n return await self._frame.type(\n self._selector,\n strict=True,\n **params,\n )\n\n async def press_sequentially(\n self,\n text: str,\n delay: float = None,\n timeout: float = None,\n noWaitAfter: bool = None,\n ) -> None:\n await self.type(text, delay=delay, timeout=timeout)\n\n async def uncheck(\n self,\n position: Position = None,\n timeout: float = None,\n force: bool = None,\n noWaitAfter: bool = None,\n trial: bool = None,\n ) -> None:\n params = locals_to_params(locals())\n return await self._frame.uncheck(\n self._selector,\n strict=True,\n **params,\n )\n\n async def all_inner_texts(\n self,\n ) -> List[str]:\n return await self._frame.eval_on_selector_all(\n self._selector, \"ee => ee.map(e => e.innerText)\"\n )\n\n async def all_text_contents(\n self,\n ) -> List[str]:\n return await self._frame.eval_on_selector_all(\n self._selector, \"ee => ee.map(e => e.textContent || '')\"\n )\n\n async def wait_for(\n self,\n timeout: float = None,\n state: Literal[\"attached\", \"detached\", \"hidden\", \"visible\"] = None,\n ) -> None:\n await self._frame.wait_for_selector(\n self._selector, strict=True, timeout=timeout, state=state\n )\n\n async def set_checked(\n self,\n checked: bool,\n position: Position = None,\n timeout: float = None,\n force: bool = None,\n noWaitAfter: bool = None,\n trial: bool = None,\n ) -> None:\n if checked:\n await self.check(\n position=position,\n timeout=timeout,\n force=force,\n trial=trial,\n )\n else:\n await self.uncheck(\n position=position,\n timeout=timeout,\n force=force,\n trial=trial,\n )\n\n async def _expect(\n self,\n expression: str,\n options: FrameExpectOptions,\n title: str = None,\n ) -> FrameExpectResult:\n return await self._frame._expect(self._selector, expression, options, title)\n\n async def highlight(self) -> None:\n await self._frame._highlight(self._selector)\n\n\nclass FrameLocator:\n def __init__(self, frame: \"Frame\", frame_selector: str) -> None:\n self._frame = frame\n self._loop = frame._loop\n self._dispatcher_fiber = frame._connection._dispatcher_fiber\n self._frame_selector = frame_selector\n\n def locator(\n self,\n selectorOrLocator: Union[\"Locator\", str],\n hasText: Union[str, Pattern[str]] = None,\n hasNotText: Union[str, Pattern[str]] = None,\n has: Locator = None,\n hasNot: Locator = None,\n ) -> Locator:\n if isinstance(selectorOrLocator, str):\n return Locator(\n self._frame,\n f\"{self._frame_selector} >> internal:control=enter-frame >> {selectorOrLocator}\",\n has_text=hasText,\n has_not_text=hasNotText,\n has=has,\n has_not=hasNot,\n )\n selectorOrLocator = to_impl(selectorOrLocator)\n if selectorOrLocator._frame != self._frame:\n raise ValueError(\"Locators must belong to the same frame.\")\n return Locator(\n self._frame,\n f\"{self._frame_selector} >> internal:control=enter-frame >> {selectorOrLocator._selector}\",\n has_text=hasText,\n has_not_text=hasNotText,\n has=has,\n has_not=hasNot,\n )\n\n def get_by_alt_text(\n self, text: Union[str, Pattern[str]], exact: bool = None\n ) -> \"Locator\":\n return self.locator(get_by_alt_text_selector(text, exact=exact))\n\n def get_by_label(\n self, text: Union[str, Pattern[str]], exact: bool = None\n ) -> \"Locator\":\n return self.locator(get_by_label_selector(text, exact=exact))\n\n def get_by_placeholder(\n self, text: Union[str, Pattern[str]], exact: bool = None\n ) -> \"Locator\":\n return self.locator(get_by_placeholder_selector(text, exact=exact))\n\n def get_by_role(\n self,\n role: AriaRole,\n checked: bool = None,\n disabled: bool = None,\n expanded: bool = None,\n includeHidden: bool = None,\n level: int = None,\n name: Union[str, Pattern[str]] = None,\n pressed: bool = None,\n selected: bool = None,\n exact: bool = None,\n ) -> \"Locator\":\n return self.locator(\n get_by_role_selector(\n role,\n checked=checked,\n disabled=disabled,\n expanded=expanded,\n includeHidden=includeHidden,\n level=level,\n name=name,\n pressed=pressed,\n selected=selected,\n exact=exact,\n )\n )\n\n def get_by_test_id(self, testId: Union[str, Pattern[str]]) -> \"Locator\":\n return self.locator(get_by_test_id_selector(test_id_attribute_name(), testId))\n\n def get_by_text(\n self, text: Union[str, Pattern[str]], exact: bool = None\n ) -> \"Locator\":\n return self.locator(get_by_text_selector(text, exact=exact))\n\n def get_by_title(\n self, text: Union[str, Pattern[str]], exact: bool = None\n ) -> \"Locator\":\n return self.locator(get_by_title_selector(text, exact=exact))\n\n def frame_locator(self, selector: str) -> \"FrameLocator\":\n return FrameLocator(\n self._frame,\n f\"{self._frame_selector} >> internal:control=enter-frame >> {selector}\",\n )\n\n @property\n def first(self) -> \"FrameLocator\":\n return FrameLocator(self._frame, f\"{self._frame_selector} >> nth=0\")\n\n @property\n def last(self) -> \"FrameLocator\":\n return FrameLocator(self._frame, f\"{self._frame_selector} >> nth=-1\")\n\n @property\n def owner(self) -> \"Locator\":\n return Locator(self._frame, self._frame_selector)\n\n def nth(self, index: int) -> \"FrameLocator\":\n return FrameLocator(self._frame, f\"{self._frame_selector} >> nth={index}\")\n\n def __repr__(self) -> str:\n return f\"\"\n\n\n_test_id_attribute_name: str = \"data-testid\"\n\n\ndef test_id_attribute_name() -> str:\n return _test_id_attribute_name\n\n\ndef set_test_id_attribute_name(attribute_name: str) -> None:\n global _test_id_attribute_name\n _test_id_attribute_name = attribute_name\n\n\ndef get_by_test_id_selector(\n test_id_attribute_name: str, test_id: Union[str, Pattern[str]]\n) -> str:\n return f\"internal:testid=[{test_id_attribute_name}={escape_for_attribute_selector(test_id, True)}]\"\n\n\ndef get_by_attribute_text_selector(\n attr_name: str, text: Union[str, Pattern[str]], exact: bool = None\n) -> str:\n return f\"internal:attr=[{attr_name}={escape_for_attribute_selector(text, exact=exact)}]\"\n\n\ndef get_by_label_selector(text: Union[str, Pattern[str]], exact: bool = None) -> str:\n return \"internal:label=\" + escape_for_text_selector(text, exact=exact)\n\n\ndef get_by_alt_text_selector(text: Union[str, Pattern[str]], exact: bool = None) -> str:\n return get_by_attribute_text_selector(\"alt\", text, exact=exact)\n\n\ndef get_by_title_selector(text: Union[str, Pattern[str]], exact: bool = None) -> str:\n return get_by_attribute_text_selector(\"title\", text, exact=exact)\n\n\ndef get_by_placeholder_selector(\n text: Union[str, Pattern[str]], exact: bool = None\n) -> str:\n return get_by_attribute_text_selector(\"placeholder\", text, exact=exact)\n\n\ndef get_by_text_selector(text: Union[str, Pattern[str]], exact: bool = None) -> str:\n return \"internal:text=\" + escape_for_text_selector(text, exact=exact)\n\n\ndef bool_to_js_bool(value: bool) -> str:\n return \"true\" if value else \"false\"\n\n\ndef get_by_role_selector(\n role: AriaRole,\n checked: bool = None,\n disabled: bool = None,\n expanded: bool = None,\n includeHidden: bool = None,\n level: int = None,\n name: Union[str, Pattern[str]] = None,\n pressed: bool = None,\n selected: bool = None,\n exact: bool = None,\n) -> str:\n props: List[Tuple[str, str]] = []\n if checked is not None:\n props.append((\"checked\", bool_to_js_bool(checked)))\n if disabled is not None:\n props.append((\"disabled\", bool_to_js_bool(disabled)))\n if selected is not None:\n props.append((\"selected\", bool_to_js_bool(selected)))\n if expanded is not None:\n props.append((\"expanded\", bool_to_js_bool(expanded)))\n if includeHidden is not None:\n props.append((\"include-hidden\", bool_to_js_bool(includeHidden)))\n if level is not None:\n props.append((\"level\", str(level)))\n if name is not None:\n props.append(\n (\n \"name\",\n escape_for_attribute_selector(name, exact=exact),\n )\n )\n if pressed is not None:\n props.append((\"pressed\", bool_to_js_bool(pressed)))\n props_str = \"\".join([f\"[{t[0]}={t[1]}]\" for t in props])\n return f\"internal:role={role}{props_str}\"\n" }, { "path": "playwright/_impl/_map.py", "content": "# Copyright (c) Microsoft Corporation.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\nfrom typing import Dict, Generic, Tuple, TypeVar\n\nK = TypeVar(\"K\")\nV = TypeVar(\"V\")\n\n\nclass Map(Generic[K, V]):\n def __init__(self) -> None:\n self._entries: Dict[int, Tuple[K, V]] = {}\n\n def __contains__(self, item: K) -> bool:\n return id(item) in self._entries\n\n def __setitem__(self, idx: K, value: V) -> None:\n self._entries[id(idx)] = (idx, value)\n\n def __getitem__(self, obj: K) -> V:\n return self._entries[id(obj)][1]\n" }, { "path": "playwright/_impl/_network.py", "content": "# Copyright (c) Microsoft Corporation.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n\nimport asyncio\nimport base64\nimport inspect\nimport json\nimport json as json_utils\nimport mimetypes\nimport re\nfrom collections import defaultdict\nfrom pathlib import Path\nfrom types import SimpleNamespace\nfrom typing import (\n TYPE_CHECKING,\n Any,\n Callable,\n Coroutine,\n Dict,\n List,\n Optional,\n TypedDict,\n Union,\n cast,\n)\nfrom urllib import parse\n\nfrom playwright._impl._api_structures import (\n ClientCertificate,\n Headers,\n HeadersArray,\n RemoteAddr,\n RequestSizes,\n ResourceTiming,\n SecurityDetails,\n)\nfrom playwright._impl._connection import (\n ChannelOwner,\n from_channel,\n from_nullable_channel,\n)\nfrom playwright._impl._errors import Error\nfrom playwright._impl._event_context_manager import EventContextManagerImpl\nfrom playwright._impl._helper import (\n URLMatch,\n WebSocketRouteHandlerCallback,\n async_readfile,\n locals_to_params,\n url_matches,\n)\nfrom playwright._impl._str_utils import escape_regex_flags\nfrom playwright._impl._waiter import Waiter\n\nif TYPE_CHECKING: # pragma: no cover\n from playwright._impl._browser_context import BrowserContext\n from playwright._impl._fetch import APIResponse\n from playwright._impl._frame import Frame\n from playwright._impl._page import Page, Worker\n\n\nclass FallbackOverrideParameters(TypedDict, total=False):\n url: Optional[str]\n method: Optional[str]\n headers: Optional[Dict[str, str]]\n postData: Optional[Union[str, bytes]]\n\n\nclass SerializedFallbackOverrides:\n def __init__(self) -> None:\n self.url: Optional[str] = None\n self.method: Optional[str] = None\n self.headers: Optional[Dict[str, str]] = None\n self.post_data_buffer: Optional[bytes] = None\n\n\ndef serialize_headers(headers: Dict[str, str]) -> HeadersArray:\n return [\n {\"name\": name, \"value\": value}\n for name, value in headers.items()\n if value is not None\n ]\n\n\nasync def to_client_certificates_protocol(\n clientCertificates: Optional[List[ClientCertificate]],\n) -> Optional[List[Dict[str, str]]]:\n if not clientCertificates:\n return None\n out = []\n for clientCertificate in clientCertificates:\n out_record = {\n \"origin\": clientCertificate[\"origin\"],\n }\n if passphrase := clientCertificate.get(\"passphrase\"):\n out_record[\"passphrase\"] = passphrase\n if pfx := clientCertificate.get(\"pfx\"):\n out_record[\"pfx\"] = base64.b64encode(pfx).decode()\n if pfx_path := clientCertificate.get(\"pfxPath\"):\n out_record[\"pfx\"] = base64.b64encode(\n await async_readfile(pfx_path)\n ).decode()\n if cert := clientCertificate.get(\"cert\"):\n out_record[\"cert\"] = base64.b64encode(cert).decode()\n if cert_path := clientCertificate.get(\"certPath\"):\n out_record[\"cert\"] = base64.b64encode(\n await async_readfile(cert_path)\n ).decode()\n if key := clientCertificate.get(\"key\"):\n out_record[\"key\"] = base64.b64encode(key).decode()\n if key_path := clientCertificate.get(\"keyPath\"):\n out_record[\"key\"] = base64.b64encode(\n await async_readfile(key_path)\n ).decode()\n out.append(out_record)\n return out\n\n\nclass Request(ChannelOwner):\n def __init__(\n self, parent: ChannelOwner, type: str, guid: str, initializer: Dict\n ) -> None:\n super().__init__(parent, type, guid, initializer)\n self._redirected_from: Optional[\"Request\"] = from_nullable_channel(\n initializer.get(\"redirectedFrom\")\n )\n self._redirected_to: Optional[\"Request\"] = None\n if self._redirected_from:\n self._redirected_from._redirected_to = self\n self._failure_text: Optional[str] = None\n self._timing: ResourceTiming = {\n \"startTime\": 0,\n \"domainLookupStart\": -1,\n \"domainLookupEnd\": -1,\n \"connectStart\": -1,\n \"secureConnectionStart\": -1,\n \"connectEnd\": -1,\n \"requestStart\": -1,\n \"responseStart\": -1,\n \"responseEnd\": -1,\n }\n self._provisional_headers = RawHeaders(self._initializer[\"headers\"])\n self._all_headers_future: Optional[asyncio.Future[RawHeaders]] = None\n self._fallback_overrides: SerializedFallbackOverrides = (\n SerializedFallbackOverrides()\n )\n\n def __repr__(self) -> str:\n return f\"\"\n\n def _apply_fallback_overrides(self, overrides: FallbackOverrideParameters) -> None:\n self._fallback_overrides.url = overrides.get(\n \"url\", self._fallback_overrides.url\n )\n self._fallback_overrides.method = overrides.get(\n \"method\", self._fallback_overrides.method\n )\n self._fallback_overrides.headers = overrides.get(\n \"headers\", self._fallback_overrides.headers\n )\n post_data = overrides.get(\"postData\")\n if isinstance(post_data, str):\n self._fallback_overrides.post_data_buffer = post_data.encode()\n elif isinstance(post_data, bytes):\n self._fallback_overrides.post_data_buffer = post_data\n elif post_data is not None:\n self._fallback_overrides.post_data_buffer = json.dumps(post_data).encode()\n\n @property\n def url(self) -> str:\n return cast(str, self._fallback_overrides.url or self._initializer[\"url\"])\n\n @property\n def resource_type(self) -> str:\n return self._initializer[\"resourceType\"]\n\n @property\n def service_worker(self) -> Optional[\"Worker\"]:\n return cast(\n Optional[\"Worker\"],\n from_nullable_channel(self._initializer.get(\"serviceWorker\")),\n )\n\n @property\n def method(self) -> str:\n return cast(str, self._fallback_overrides.method or self._initializer[\"method\"])\n\n async def sizes(self) -> RequestSizes:\n response = await self.response()\n if not response:\n raise Error(\"Unable to fetch sizes for failed request\")\n return await response._channel.send(\n \"sizes\",\n None,\n )\n\n @property\n def post_data(self) -> Optional[str]:\n data = self._fallback_overrides.post_data_buffer\n if data:\n return data.decode()\n base64_post_data = self._initializer.get(\"postData\")\n if base64_post_data is not None:\n return base64.b64decode(base64_post_data).decode()\n return None\n\n @property\n def post_data_json(self) -> Optional[Any]:\n post_data = self.post_data\n if not post_data:\n return None\n content_type = self.headers[\"content-type\"]\n if \"application/x-www-form-urlencoded\" in content_type:\n return dict(parse.parse_qsl(post_data))\n try:\n return json.loads(post_data)\n except Exception:\n raise Error(f\"POST data is not a valid JSON object: {post_data}\")\n\n @property\n def post_data_buffer(self) -> Optional[bytes]:\n if self._fallback_overrides.post_data_buffer:\n return self._fallback_overrides.post_data_buffer\n if self._initializer.get(\"postData\"):\n return base64.b64decode(self._initializer[\"postData\"])\n return None\n\n async def response(self) -> Optional[\"Response\"]:\n return from_nullable_channel(\n await self._channel.send(\n \"response\",\n None,\n )\n )\n\n @property\n def frame(self) -> \"Frame\":\n if not self._initializer.get(\"frame\"):\n raise Error(\"Service Worker requests do not have an associated frame.\")\n frame = cast(\"Frame\", from_channel(self._initializer[\"frame\"]))\n if not frame._page:\n raise Error(\n \"\\n\".join(\n [\n \"Frame for this navigation request is not available, because the request\",\n \"was issued before the frame is created. You can check whether the request\",\n \"is a navigation request by calling isNavigationRequest() method.\",\n ]\n )\n )\n return frame\n\n def is_navigation_request(self) -> bool:\n return self._initializer[\"isNavigationRequest\"]\n\n @property\n def redirected_from(self) -> Optional[\"Request\"]:\n return self._redirected_from\n\n @property\n def redirected_to(self) -> Optional[\"Request\"]:\n return self._redirected_to\n\n @property\n def failure(self) -> Optional[str]:\n return self._failure_text\n\n @property\n def timing(self) -> ResourceTiming:\n return self._timing\n\n def _set_response_end_timing(self, response_end_timing: float) -> None:\n self._timing[\"responseEnd\"] = response_end_timing\n if self._timing[\"responseStart\"] == -1:\n self._timing[\"responseStart\"] = response_end_timing\n\n @property\n def headers(self) -> Headers:\n override = self._fallback_overrides.headers\n if override:\n return RawHeaders._from_headers_dict_lossy(override).headers()\n return self._provisional_headers.headers()\n\n async def all_headers(self) -> Headers:\n return (await self._actual_headers()).headers()\n\n async def headers_array(self) -> HeadersArray:\n return (await self._actual_headers()).headers_array()\n\n async def header_value(self, name: str) -> Optional[str]:\n return (await self._actual_headers()).get(name)\n\n async def _actual_headers(self) -> \"RawHeaders\":\n override = self._fallback_overrides.headers\n if override:\n return RawHeaders(serialize_headers(override))\n if not self._all_headers_future:\n self._all_headers_future = asyncio.Future()\n headers = await self._channel.send(\n \"rawRequestHeaders\", None, is_internal=True\n )\n self._all_headers_future.set_result(RawHeaders(headers))\n return await self._all_headers_future\n\n def _target_closed_future(self) -> asyncio.Future:\n frame = cast(\n Optional[\"Frame\"], from_nullable_channel(self._initializer.get(\"frame\"))\n )\n if not frame:\n return asyncio.Future()\n page = frame._page\n if not page:\n return asyncio.Future()\n return page._closed_or_crashed_future\n\n def _safe_page(self) -> \"Optional[Page]\":\n frame = from_nullable_channel(self._initializer.get(\"frame\"))\n if not frame:\n return None\n return cast(\"Frame\", frame)._page\n\n\nclass Route(ChannelOwner):\n def __init__(\n self, parent: ChannelOwner, type: str, guid: str, initializer: Dict\n ) -> None:\n super().__init__(parent, type, guid, initializer)\n self._handling_future: Optional[asyncio.Future[\"bool\"]] = None\n self._context: \"BrowserContext\" = cast(\"BrowserContext\", None)\n self._did_throw = False\n\n def _start_handling(self) -> \"asyncio.Future[bool]\":\n self._handling_future = asyncio.Future()\n return self._handling_future\n\n def _report_handled(self, done: bool) -> None:\n chain = self._handling_future\n assert chain\n self._handling_future = None\n chain.set_result(done)\n\n def _check_not_handled(self) -> None:\n if not self._handling_future:\n raise Error(\"Route is already handled!\")\n\n def __repr__(self) -> str:\n return f\"\"\n\n @property\n def request(self) -> Request:\n return from_channel(self._initializer[\"request\"])\n\n async def abort(self, errorCode: str = None) -> None:\n await self._handle_route(\n lambda: self._race_with_page_close(\n self._channel.send(\n \"abort\",\n None,\n {\n \"errorCode\": errorCode,\n },\n )\n )\n )\n\n async def fulfill(\n self,\n status: int = None,\n headers: Dict[str, str] = None,\n body: Union[str, bytes] = None,\n json: Any = None,\n path: Union[str, Path] = None,\n contentType: str = None,\n response: \"APIResponse\" = None,\n ) -> None:\n await self._handle_route(\n lambda: self._inner_fulfill(\n status, headers, body, json, path, contentType, response\n )\n )\n\n async def _inner_fulfill(\n self,\n status: int = None,\n headers: Dict[str, str] = None,\n body: Union[str, bytes] = None,\n json: Any = None,\n path: Union[str, Path] = None,\n contentType: str = None,\n response: \"APIResponse\" = None,\n ) -> None:\n params = locals_to_params(locals())\n\n if json is not None:\n if body is not None:\n raise Error(\"Can specify either body or json parameters\")\n body = json_utils.dumps(json)\n\n if response:\n del params[\"response\"]\n params[\"status\"] = (\n params[\"status\"] if params.get(\"status\") else response.status\n )\n params[\"headers\"] = (\n params[\"headers\"] if params.get(\"headers\") else response.headers\n )\n from playwright._impl._fetch import APIResponse\n\n if body is None and path is None and isinstance(response, APIResponse):\n if response._request._connection is self._connection:\n params[\"fetchResponseUid\"] = response._fetch_uid\n else:\n body = await response.body()\n\n length = 0\n if isinstance(body, str):\n params[\"body\"] = body\n params[\"isBase64\"] = False\n length = len(body.encode())\n elif isinstance(body, bytes):\n params[\"body\"] = base64.b64encode(body).decode()\n params[\"isBase64\"] = True\n length = len(body)\n elif path:\n del params[\"path\"]\n file_content = Path(path).read_bytes()\n params[\"body\"] = base64.b64encode(file_content).decode()\n params[\"isBase64\"] = True\n length = len(file_content)\n\n headers = {k.lower(): str(v) for k, v in params.get(\"headers\", {}).items()}\n if params.get(\"contentType\"):\n headers[\"content-type\"] = params[\"contentType\"]\n elif json:\n headers[\"content-type\"] = \"application/json\"\n elif path:\n headers[\"content-type\"] = (\n mimetypes.guess_type(str(Path(path)))[0] or \"application/octet-stream\"\n )\n if length and \"content-length\" not in headers:\n headers[\"content-length\"] = str(length)\n params[\"headers\"] = serialize_headers(headers)\n\n await self._race_with_page_close(self._channel.send(\"fulfill\", None, params))\n\n async def _handle_route(self, callback: Callable) -> None:\n self._check_not_handled()\n try:\n await callback()\n self._report_handled(True)\n except Exception as e:\n self._did_throw = True\n raise e\n\n async def fetch(\n self,\n url: str = None,\n method: str = None,\n headers: Dict[str, str] = None,\n postData: Union[Any, str, bytes] = None,\n maxRedirects: int = None,\n maxRetries: int = None,\n timeout: float = None,\n ) -> \"APIResponse\":\n return await self._connection.wrap_api_call(\n lambda: self._context.request._inner_fetch(\n self.request,\n url,\n method,\n headers,\n postData,\n maxRedirects=maxRedirects,\n maxRetries=maxRetries,\n timeout=timeout,\n )\n )\n\n async def fallback(\n self,\n url: str = None,\n method: str = None,\n headers: Dict[str, str] = None,\n postData: Union[Any, str, bytes] = None,\n ) -> None:\n overrides = cast(FallbackOverrideParameters, locals_to_params(locals()))\n self._check_not_handled()\n self.request._apply_fallback_overrides(overrides)\n self._report_handled(False)\n\n async def continue_(\n self,\n url: str = None,\n method: str = None,\n headers: Dict[str, str] = None,\n postData: Union[Any, str, bytes] = None,\n ) -> None:\n overrides = cast(FallbackOverrideParameters, locals_to_params(locals()))\n\n async def _inner() -> None:\n self.request._apply_fallback_overrides(overrides)\n await self._inner_continue(False)\n\n return await self._handle_route(_inner)\n\n async def _inner_continue(self, is_fallback: bool = False) -> None:\n options = self.request._fallback_overrides\n await self._race_with_page_close(\n self._channel.send(\n \"continue\",\n None,\n {\n \"url\": options.url,\n \"method\": options.method,\n \"headers\": (\n serialize_headers(options.headers) if options.headers else None\n ),\n \"postData\": (\n base64.b64encode(options.post_data_buffer).decode()\n if options.post_data_buffer is not None\n else None\n ),\n \"isFallback\": is_fallback,\n },\n )\n )\n\n async def _redirected_navigation_request(self, url: str) -> None:\n await self._handle_route(\n lambda: self._race_with_page_close(\n self._channel.send(\"redirectNavigationRequest\", None, {\"url\": url})\n )\n )\n\n async def _race_with_page_close(self, future: Coroutine) -> None:\n fut = asyncio.create_task(future)\n # Rewrite the user's stack to the new task which runs in the background.\n setattr(\n fut,\n \"__pw_stack__\",\n getattr(asyncio.current_task(self._loop), \"__pw_stack__\", inspect.stack(0)),\n )\n target_closed_future = self.request._target_closed_future()\n await asyncio.wait(\n [fut, target_closed_future],\n return_when=asyncio.FIRST_COMPLETED,\n )\n if fut.done() and fut.exception():\n raise cast(BaseException, fut.exception())\n if target_closed_future.done():\n await asyncio.gather(fut, return_exceptions=True)\n\n\ndef _create_task_and_ignore_exception(\n loop: asyncio.AbstractEventLoop, coro: Coroutine\n) -> None:\n async def _ignore_exception() -> None:\n try:\n await coro\n except Exception:\n pass\n\n loop.create_task(_ignore_exception())\n\n\nclass ServerWebSocketRoute:\n def __init__(self, ws: \"WebSocketRoute\"):\n self._ws = ws\n\n def on_message(self, handler: Callable[[Union[str, bytes]], Any]) -> None:\n self._ws._on_server_message = handler\n\n def on_close(self, handler: Callable[[Optional[int], Optional[str]], Any]) -> None:\n self._ws._on_server_close = handler\n\n def connect_to_server(self) -> None:\n raise NotImplementedError(\n \"connectToServer must be called on the page-side WebSocketRoute\"\n )\n\n @property\n def url(self) -> str:\n return self._ws._initializer[\"url\"]\n\n def close(self, code: int = None, reason: str = None) -> None:\n _create_task_and_ignore_exception(\n self._ws._loop,\n self._ws._channel.send(\n \"closeServer\",\n None,\n {\n \"code\": code,\n \"reason\": reason,\n \"wasClean\": True,\n },\n ),\n )\n\n def send(self, message: Union[str, bytes]) -> None:\n if isinstance(message, str):\n _create_task_and_ignore_exception(\n self._ws._loop,\n self._ws._channel.send(\n \"sendToServer\", None, {\"message\": message, \"isBase64\": False}\n ),\n )\n else:\n _create_task_and_ignore_exception(\n self._ws._loop,\n self._ws._channel.send(\n \"sendToServer\",\n None,\n {\"message\": base64.b64encode(message).decode(), \"isBase64\": True},\n ),\n )\n\n\nclass WebSocketRoute(ChannelOwner):\n def __init__(\n self, parent: ChannelOwner, type: str, guid: str, initializer: Dict\n ) -> None:\n super().__init__(parent, type, guid, initializer)\n self._on_page_message: Optional[Callable[[Union[str, bytes]], Any]] = None\n self._on_page_close: Optional[Callable[[Optional[int], Optional[str]], Any]] = (\n None\n )\n self._on_server_message: Optional[Callable[[Union[str, bytes]], Any]] = None\n self._on_server_close: Optional[\n Callable[[Optional[int], Optional[str]], Any]\n ] = None\n self._server = ServerWebSocketRoute(self)\n self._connected = False\n\n self._channel.on(\"messageFromPage\", self._channel_message_from_page)\n self._channel.on(\"messageFromServer\", self._channel_message_from_server)\n self._channel.on(\"closePage\", self._channel_close_page)\n self._channel.on(\"closeServer\", self._channel_close_server)\n\n def _channel_message_from_page(self, event: Dict) -> None:\n if self._on_page_message:\n self._on_page_message(\n base64.b64decode(event[\"message\"])\n if event[\"isBase64\"]\n else event[\"message\"]\n )\n elif self._connected:\n _create_task_and_ignore_exception(\n self._loop, self._channel.send(\"sendToServer\", None, event)\n )\n\n def _channel_message_from_server(self, event: Dict) -> None:\n if self._on_server_message:\n self._on_server_message(\n base64.b64decode(event[\"message\"])\n if event[\"isBase64\"]\n else event[\"message\"]\n )\n else:\n _create_task_and_ignore_exception(\n self._loop, self._channel.send(\"sendToPage\", None, event)\n )\n\n def _channel_close_page(self, event: Dict) -> None:\n if self._on_page_close:\n self._on_page_close(event[\"code\"], event[\"reason\"])\n else:\n _create_task_and_ignore_exception(\n self._loop, self._channel.send(\"closeServer\", None, event)\n )\n\n def _channel_close_server(self, event: Dict) -> None:\n if self._on_server_close:\n self._on_server_close(event[\"code\"], event[\"reason\"])\n else:\n _create_task_and_ignore_exception(\n self._loop, self._channel.send(\"closePage\", None, event)\n )\n\n @property\n def url(self) -> str:\n return self._initializer[\"url\"]\n\n async def close(self, code: int = None, reason: str = None) -> None:\n try:\n await self._channel.send(\n \"closePage\", None, {\"code\": code, \"reason\": reason, \"wasClean\": True}\n )\n except Exception:\n pass\n\n def connect_to_server(self) -> \"WebSocketRoute\":\n if self._connected:\n raise Error(\"Already connected to the server\")\n self._connected = True\n asyncio.create_task(\n self._channel.send(\n \"connect\",\n None,\n )\n )\n return cast(\"WebSocketRoute\", self._server)\n\n def send(self, message: Union[str, bytes]) -> None:\n if isinstance(message, str):\n _create_task_and_ignore_exception(\n self._loop,\n self._channel.send(\n \"sendToPage\", None, {\"message\": message, \"isBase64\": False}\n ),\n )\n else:\n _create_task_and_ignore_exception(\n self._loop,\n self._channel.send(\n \"sendToPage\",\n None,\n {\n \"message\": base64.b64encode(message).decode(),\n \"isBase64\": True,\n },\n ),\n )\n\n def on_message(self, handler: Callable[[Union[str, bytes]], Any]) -> None:\n self._on_page_message = handler\n\n def on_close(self, handler: Callable[[Optional[int], Optional[str]], Any]) -> None:\n self._on_page_close = handler\n\n async def _after_handle(self) -> None:\n if self._connected:\n return\n # Ensure that websocket is \"open\" and can send messages without an actual server connection.\n try:\n await self._channel.send(\n \"ensureOpened\",\n None,\n )\n except Exception:\n pass\n\n\nclass WebSocketRouteHandler:\n def __init__(\n self,\n base_url: Optional[str],\n url: URLMatch,\n handler: WebSocketRouteHandlerCallback,\n ):\n self._base_url = base_url\n self.url = url\n self.handler = handler\n\n @staticmethod\n def prepare_interception_patterns(\n handlers: List[\"WebSocketRouteHandler\"],\n ) -> List[dict]:\n patterns = []\n all_urls = False\n for handler in handlers:\n if isinstance(handler.url, str):\n patterns.append({\"glob\": handler.url})\n elif isinstance(handler.url, re.Pattern):\n patterns.append(\n {\n \"regexSource\": handler.url.pattern,\n \"regexFlags\": escape_regex_flags(handler.url),\n }\n )\n else:\n all_urls = True\n\n if all_urls:\n return [{\"glob\": \"**/*\"}]\n return patterns\n\n def matches(self, ws_url: str) -> bool:\n return url_matches(self._base_url, ws_url, self.url, True)\n\n async def handle(self, websocket_route: \"WebSocketRoute\") -> None:\n coro_or_future = self.handler(websocket_route)\n if asyncio.iscoroutine(coro_or_future):\n await coro_or_future\n await websocket_route._after_handle()\n\n\nclass Response(ChannelOwner):\n def __init__(\n self, parent: ChannelOwner, type: str, guid: str, initializer: Dict\n ) -> None:\n super().__init__(parent, type, guid, initializer)\n self._request: Request = from_channel(self._initializer[\"request\"])\n timing = self._initializer[\"timing\"]\n self._request._timing[\"startTime\"] = timing[\"startTime\"]\n self._request._timing[\"domainLookupStart\"] = timing[\"domainLookupStart\"]\n self._request._timing[\"domainLookupEnd\"] = timing[\"domainLookupEnd\"]\n self._request._timing[\"connectStart\"] = timing[\"connectStart\"]\n self._request._timing[\"secureConnectionStart\"] = timing[\"secureConnectionStart\"]\n self._request._timing[\"connectEnd\"] = timing[\"connectEnd\"]\n self._request._timing[\"requestStart\"] = timing[\"requestStart\"]\n self._request._timing[\"responseStart\"] = timing[\"responseStart\"]\n self._provisional_headers = RawHeaders(\n cast(HeadersArray, self._initializer[\"headers\"])\n )\n self._raw_headers_future: Optional[asyncio.Future[RawHeaders]] = None\n self._finished_future: asyncio.Future[bool] = asyncio.Future()\n\n def __repr__(self) -> str:\n return f\"\"\n\n @property\n def url(self) -> str:\n return self._initializer[\"url\"]\n\n @property\n def ok(self) -> bool:\n # Status 0 is for file:// URLs\n return self._initializer[\"status\"] == 0 or (\n self._initializer[\"status\"] >= 200 and self._initializer[\"status\"] <= 299\n )\n\n @property\n def status(self) -> int:\n return self._initializer[\"status\"]\n\n @property\n def status_text(self) -> str:\n return self._initializer[\"statusText\"]\n\n @property\n def headers(self) -> Headers:\n return self._provisional_headers.headers()\n\n @property\n def from_service_worker(self) -> bool:\n return self._initializer[\"fromServiceWorker\"]\n\n async def all_headers(self) -> Headers:\n return (await self._actual_headers()).headers()\n\n async def headers_array(self) -> HeadersArray:\n return (await self._actual_headers()).headers_array()\n\n async def header_value(self, name: str) -> Optional[str]:\n return (await self._actual_headers()).get(name)\n\n async def header_values(self, name: str) -> List[str]:\n return (await self._actual_headers()).get_all(name)\n\n async def _actual_headers(self) -> \"RawHeaders\":\n if not self._raw_headers_future:\n self._raw_headers_future = asyncio.Future()\n headers = cast(\n HeadersArray,\n await self._channel.send(\n \"rawResponseHeaders\",\n None,\n ),\n )\n self._raw_headers_future.set_result(RawHeaders(headers))\n return await self._raw_headers_future\n\n async def server_addr(self) -> Optional[RemoteAddr]:\n return await self._channel.send(\n \"serverAddr\",\n None,\n )\n\n async def security_details(self) -> Optional[SecurityDetails]:\n return await self._channel.send(\n \"securityDetails\",\n None,\n )\n\n async def finished(self) -> None:\n async def on_finished() -> None:\n await self._request._target_closed_future()\n raise Error(\"Target closed\")\n\n on_finished_task = asyncio.create_task(on_finished())\n await asyncio.wait(\n cast(\n List[Union[asyncio.Task, asyncio.Future]],\n [self._finished_future, on_finished_task],\n ),\n return_when=asyncio.FIRST_COMPLETED,\n )\n if on_finished_task.done():\n await on_finished_task\n\n async def body(self) -> bytes:\n binary = await self._channel.send(\n \"body\",\n None,\n )\n return base64.b64decode(binary)\n\n async def text(self) -> str:\n content = await self.body()\n return content.decode()\n\n async def json(self) -> Any:\n return json.loads(await self.text())\n\n @property\n def request(self) -> Request:\n return self._request\n\n @property\n def frame(self) -> \"Frame\":\n return self._request.frame\n\n\nclass WebSocket(ChannelOwner):\n Events = SimpleNamespace(\n Close=\"close\",\n FrameReceived=\"framereceived\",\n FrameSent=\"framesent\",\n Error=\"socketerror\",\n )\n\n def __init__(\n self, parent: ChannelOwner, type: str, guid: str, initializer: Dict\n ) -> None:\n super().__init__(parent, type, guid, initializer)\n self._is_closed = False\n self._page = cast(\"Page\", parent)\n self._channel.on(\n \"frameSent\",\n lambda params: self._on_frame_sent(params[\"opcode\"], params[\"data\"]),\n )\n self._channel.on(\n \"frameReceived\",\n lambda params: self._on_frame_received(params[\"opcode\"], params[\"data\"]),\n )\n self._channel.on(\n \"socketError\",\n lambda params: self.emit(WebSocket.Events.Error, params[\"error\"]),\n )\n self._channel.on(\"close\", lambda params: self._on_close())\n\n def __repr__(self) -> str:\n return f\"\"\n\n @property\n def url(self) -> str:\n return self._initializer[\"url\"]\n\n def expect_event(\n self,\n event: str,\n predicate: Callable = None,\n timeout: float = None,\n ) -> EventContextManagerImpl:\n if timeout is None:\n timeout = cast(Any, self._parent)._timeout_settings.timeout()\n waiter = Waiter(self, f\"web_socket.expect_event({event})\")\n waiter.reject_on_timeout(\n cast(float, timeout),\n f'Timeout {timeout}ms exceeded while waiting for event \"{event}\"',\n )\n if event != WebSocket.Events.Close:\n waiter.reject_on_event(self, WebSocket.Events.Close, Error(\"Socket closed\"))\n if event != WebSocket.Events.Error:\n waiter.reject_on_event(self, WebSocket.Events.Error, Error(\"Socket error\"))\n waiter.reject_on_event(\n self._page, \"close\", lambda: self._page._close_error_with_reason()\n )\n waiter.wait_for_event(self, event, predicate)\n return EventContextManagerImpl(waiter.result())\n\n async def wait_for_event(\n self, event: str, predicate: Callable = None, timeout: float = None\n ) -> Any:\n async with self.expect_event(event, predicate, timeout) as event_info:\n pass\n return await event_info\n\n def _on_frame_sent(self, opcode: int, data: str) -> None:\n if opcode == 2:\n self.emit(WebSocket.Events.FrameSent, base64.b64decode(data))\n elif opcode == 1:\n self.emit(WebSocket.Events.FrameSent, data)\n\n def _on_frame_received(self, opcode: int, data: str) -> None:\n if opcode == 2:\n self.emit(WebSocket.Events.FrameReceived, base64.b64decode(data))\n elif opcode == 1:\n self.emit(WebSocket.Events.FrameReceived, data)\n\n def is_closed(self) -> bool:\n return self._is_closed\n\n def _on_close(self) -> None:\n self._is_closed = True\n self.emit(WebSocket.Events.Close, self)\n\n\nclass RawHeaders:\n def __init__(self, headers: HeadersArray) -> None:\n self._headers_array = headers\n self._headers_map: Dict[str, Dict[str, bool]] = defaultdict(dict)\n for header in headers:\n self._headers_map[header[\"name\"].lower()][header[\"value\"]] = True\n\n @staticmethod\n def _from_headers_dict_lossy(headers: Dict[str, str]) -> \"RawHeaders\":\n return RawHeaders(serialize_headers(headers))\n\n def get(self, name: str) -> Optional[str]:\n values = self.get_all(name)\n if not values:\n return None\n separator = \"\\n\" if name.lower() == \"set-cookie\" else \", \"\n return separator.join(values)\n\n def get_all(self, name: str) -> List[str]:\n return list(self._headers_map[name.lower()].keys())\n\n def headers(self) -> Dict[str, str]:\n result = {}\n for name in self._headers_map.keys():\n result[name] = cast(str, self.get(name))\n return result\n\n def headers_array(self) -> HeadersArray:\n return self._headers_array\n" }, { "path": "playwright/_impl/_object_factory.py", "content": "# Copyright (c) Microsoft Corporation.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n\nfrom typing import Dict, cast\n\nfrom playwright._impl._artifact import Artifact\nfrom playwright._impl._browser import Browser\nfrom playwright._impl._browser_context import BrowserContext\nfrom playwright._impl._browser_type import BrowserType\nfrom playwright._impl._cdp_session import CDPSession\nfrom playwright._impl._connection import ChannelOwner\nfrom playwright._impl._dialog import Dialog\nfrom playwright._impl._element_handle import ElementHandle\nfrom playwright._impl._fetch import APIRequestContext\nfrom playwright._impl._frame import Frame\nfrom playwright._impl._js_handle import JSHandle\nfrom playwright._impl._local_utils import LocalUtils\nfrom playwright._impl._network import (\n Request,\n Response,\n Route,\n WebSocket,\n WebSocketRoute,\n)\nfrom playwright._impl._page import BindingCall, Page, Worker\nfrom playwright._impl._playwright import Playwright\nfrom playwright._impl._stream import Stream\nfrom playwright._impl._tracing import Tracing\nfrom playwright._impl._writable_stream import WritableStream\n\n\nclass DummyObject(ChannelOwner):\n def __init__(\n self, parent: ChannelOwner, type: str, guid: str, initializer: Dict\n ) -> None:\n super().__init__(parent, type, guid, initializer)\n\n\ndef create_remote_object(\n parent: ChannelOwner, type: str, guid: str, initializer: Dict\n) -> ChannelOwner:\n if type == \"Artifact\":\n return Artifact(parent, type, guid, initializer)\n if type == \"APIRequestContext\":\n return APIRequestContext(parent, type, guid, initializer)\n if type == \"BindingCall\":\n return BindingCall(parent, type, guid, initializer)\n if type == \"Browser\":\n return Browser(cast(BrowserType, parent), type, guid, initializer)\n if type == \"BrowserType\":\n return BrowserType(parent, type, guid, initializer)\n if type == \"BrowserContext\":\n return BrowserContext(parent, type, guid, initializer)\n if type == \"CDPSession\":\n return CDPSession(parent, type, guid, initializer)\n if type == \"Dialog\":\n return Dialog(parent, type, guid, initializer)\n if type == \"ElementHandle\":\n return ElementHandle(parent, type, guid, initializer)\n if type == \"Frame\":\n return Frame(parent, type, guid, initializer)\n if type == \"JSHandle\":\n return JSHandle(parent, type, guid, initializer)\n if type == \"LocalUtils\":\n local_utils = LocalUtils(parent, type, guid, initializer)\n if not local_utils._connection._local_utils:\n local_utils._connection._local_utils = local_utils\n return local_utils\n if type == \"Page\":\n return Page(parent, type, guid, initializer)\n if type == \"Playwright\":\n return Playwright(parent, type, guid, initializer)\n if type == \"Request\":\n return Request(parent, type, guid, initializer)\n if type == \"Response\":\n return Response(parent, type, guid, initializer)\n if type == \"Route\":\n return Route(parent, type, guid, initializer)\n if type == \"Stream\":\n return Stream(parent, type, guid, initializer)\n if type == \"Tracing\":\n return Tracing(parent, type, guid, initializer)\n if type == \"WebSocket\":\n return WebSocket(parent, type, guid, initializer)\n if type == \"WebSocketRoute\":\n return WebSocketRoute(parent, type, guid, initializer)\n if type == \"Worker\":\n return Worker(parent, type, guid, initializer)\n if type == \"WritableStream\":\n return WritableStream(parent, type, guid, initializer)\n return DummyObject(parent, type, guid, initializer)\n" }, { "path": "playwright/_impl/_page.py", "content": "# Copyright (c) Microsoft Corporation.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n\nimport asyncio\nimport base64\nimport inspect\nimport re\nimport sys\nfrom pathlib import Path\nfrom types import SimpleNamespace\nfrom typing import (\n TYPE_CHECKING,\n Any,\n Callable,\n Dict,\n List,\n Literal,\n Optional,\n Pattern,\n Sequence,\n Union,\n cast,\n)\n\nfrom playwright._impl._api_structures import (\n AriaRole,\n FilePayload,\n FloatRect,\n PdfMargins,\n Position,\n ViewportSize,\n)\nfrom playwright._impl._artifact import Artifact\nfrom playwright._impl._clock import Clock\nfrom playwright._impl._connection import (\n ChannelOwner,\n from_channel,\n from_nullable_channel,\n)\nfrom playwright._impl._console_message import ConsoleMessage\nfrom playwright._impl._download import Download\nfrom playwright._impl._element_handle import ElementHandle, determine_screenshot_type\nfrom playwright._impl._errors import Error, TargetClosedError, is_target_closed_error\nfrom playwright._impl._event_context_manager import EventContextManagerImpl\nfrom playwright._impl._file_chooser import FileChooser\nfrom playwright._impl._frame import Frame\nfrom playwright._impl._greenlets import LocatorHandlerGreenlet\nfrom playwright._impl._har_router import HarRouter\nfrom playwright._impl._helper import (\n ColorScheme,\n Contrast,\n DocumentLoadState,\n ForcedColors,\n HarMode,\n KeyboardModifier,\n MouseButton,\n ReducedMotion,\n RouteFromHarNotFoundPolicy,\n RouteHandler,\n RouteHandlerCallback,\n TimeoutSettings,\n URLMatch,\n URLMatchRequest,\n URLMatchResponse,\n WebSocketRouteHandlerCallback,\n async_readfile,\n async_writefile,\n locals_to_params,\n make_dirs_for_file,\n parse_error,\n serialize_error,\n url_matches,\n)\nfrom playwright._impl._input import Keyboard, Mouse, Touchscreen\nfrom playwright._impl._js_handle import (\n JSHandle,\n Serializable,\n add_source_url_to_script,\n parse_result,\n serialize_argument,\n)\nfrom playwright._impl._network import (\n Request,\n Response,\n Route,\n WebSocketRoute,\n WebSocketRouteHandler,\n serialize_headers,\n)\nfrom playwright._impl._video import Video\nfrom playwright._impl._waiter import Waiter\n\nif TYPE_CHECKING: # pragma: no cover\n from playwright._impl._browser_context import BrowserContext\n from playwright._impl._fetch import APIRequestContext\n from playwright._impl._locator import FrameLocator, Locator\n from playwright._impl._network import WebSocket\n\n\nclass LocatorHandler:\n locator: \"Locator\"\n handler: Union[Callable[[\"Locator\"], Any], Callable[..., Any]]\n times: Union[int, None]\n\n def __init__(\n self, locator: \"Locator\", handler: Callable[..., Any], times: Union[int, None]\n ) -> None:\n self.locator = locator\n self._handler = handler\n self.times = times\n\n def __call__(self) -> Any:\n arg_count = len(inspect.signature(self._handler).parameters)\n if arg_count == 0:\n return self._handler()\n return self._handler(self.locator)\n\n\nclass Page(ChannelOwner):\n Events = SimpleNamespace(\n Close=\"close\",\n Crash=\"crash\",\n Console=\"console\",\n Dialog=\"dialog\",\n Download=\"download\",\n FileChooser=\"filechooser\",\n DOMContentLoaded=\"domcontentloaded\",\n PageError=\"pageerror\",\n Request=\"request\",\n Response=\"response\",\n RequestFailed=\"requestfailed\",\n RequestFinished=\"requestfinished\",\n FrameAttached=\"frameattached\",\n FrameDetached=\"framedetached\",\n FrameNavigated=\"framenavigated\",\n Load=\"load\",\n Popup=\"popup\",\n WebSocket=\"websocket\",\n Worker=\"worker\",\n )\n keyboard: Keyboard\n mouse: Mouse\n touchscreen: Touchscreen\n\n def __init__(\n self, parent: ChannelOwner, type: str, guid: str, initializer: Dict\n ) -> None:\n super().__init__(parent, type, guid, initializer)\n self._browser_context = cast(\"BrowserContext\", parent)\n self.keyboard = Keyboard(self._channel)\n self.mouse = Mouse(self._channel)\n self.touchscreen = Touchscreen(self._channel)\n\n self._main_frame: Frame = from_channel(initializer[\"mainFrame\"])\n self._main_frame._page = self\n self._frames = [self._main_frame]\n self._viewport_size: Optional[ViewportSize] = initializer.get(\"viewportSize\")\n self._is_closed = False\n self._workers: List[\"Worker\"] = []\n self._bindings: Dict[str, Any] = {}\n self._routes: List[RouteHandler] = []\n self._web_socket_routes: List[WebSocketRouteHandler] = []\n self._owned_context: Optional[\"BrowserContext\"] = None\n self._timeout_settings: TimeoutSettings = TimeoutSettings(\n self._browser_context._timeout_settings\n )\n self._video: Optional[Video] = None\n self._opener = cast(\"Page\", from_nullable_channel(initializer.get(\"opener\")))\n self._close_reason: Optional[str] = None\n self._close_was_called = False\n self._har_routers: List[HarRouter] = []\n self._locator_handlers: Dict[str, LocatorHandler] = {}\n\n self._channel.on(\n \"bindingCall\",\n lambda params: self._on_binding(from_channel(params[\"binding\"])),\n )\n self._channel.on(\"close\", lambda _: self._on_close())\n self._channel.on(\"crash\", lambda _: self._on_crash())\n self._channel.on(\"download\", lambda params: self._on_download(params))\n self._channel.on(\n \"fileChooser\",\n lambda params: self.emit(\n Page.Events.FileChooser,\n FileChooser(\n self, from_channel(params[\"element\"]), params[\"isMultiple\"]\n ),\n ),\n )\n self._channel.on(\n \"frameAttached\",\n lambda params: self._on_frame_attached(from_channel(params[\"frame\"])),\n )\n self._channel.on(\n \"frameDetached\",\n lambda params: self._on_frame_detached(from_channel(params[\"frame\"])),\n )\n self._channel.on(\n \"locatorHandlerTriggered\",\n lambda params: self._loop.create_task(\n self._on_locator_handler_triggered(params[\"uid\"])\n ),\n )\n self._channel.on(\n \"route\",\n lambda params: self._loop.create_task(\n self._on_route(from_channel(params[\"route\"]))\n ),\n )\n self._channel.on(\n \"webSocketRoute\",\n lambda params: self._loop.create_task(\n self._on_web_socket_route(from_channel(params[\"webSocketRoute\"]))\n ),\n )\n self._channel.on(\"video\", lambda params: self._on_video(params))\n self._channel.on(\"viewportSizeChanged\", self._on_viewport_size_changed)\n self._channel.on(\n \"webSocket\",\n lambda params: self.emit(\n Page.Events.WebSocket, from_channel(params[\"webSocket\"])\n ),\n )\n self._channel.on(\n \"worker\", lambda params: self._on_worker(from_channel(params[\"worker\"]))\n )\n self._closed_or_crashed_future: asyncio.Future = asyncio.Future()\n self.on(\n Page.Events.Close,\n lambda _: (\n self._closed_or_crashed_future.set_result(\n self._close_error_with_reason()\n )\n if not self._closed_or_crashed_future.done()\n else None\n ),\n )\n self.on(\n Page.Events.Crash,\n lambda _: (\n self._closed_or_crashed_future.set_result(TargetClosedError())\n if not self._closed_or_crashed_future.done()\n else None\n ),\n )\n\n self._set_event_to_subscription_mapping(\n {\n Page.Events.Console: \"console\",\n Page.Events.Dialog: \"dialog\",\n Page.Events.Request: \"request\",\n Page.Events.Response: \"response\",\n Page.Events.RequestFinished: \"requestFinished\",\n Page.Events.RequestFailed: \"requestFailed\",\n Page.Events.FileChooser: \"fileChooser\",\n }\n )\n\n def __repr__(self) -> str:\n return f\"\"\n\n def _on_frame_attached(self, frame: Frame) -> None:\n frame._page = self\n self._frames.append(frame)\n self.emit(Page.Events.FrameAttached, frame)\n\n def _on_frame_detached(self, frame: Frame) -> None:\n self._frames.remove(frame)\n frame._detached = True\n self.emit(Page.Events.FrameDetached, frame)\n\n async def _on_route(self, route: Route) -> None:\n route._context = self.context\n route_handlers = self._routes.copy()\n for route_handler in route_handlers:\n # If the page was closed we stall all requests right away.\n if self._close_was_called or self.context._closing_or_closed:\n return\n if not route_handler.matches(route.request.url):\n continue\n if route_handler not in self._routes:\n continue\n if route_handler.will_expire:\n self._routes.remove(route_handler)\n try:\n handled = await route_handler.handle(route)\n finally:\n if len(self._routes) == 0:\n\n async def _update_interceptor_patterns_ignore_exceptions() -> None:\n try:\n await self._update_interception_patterns()\n except Error:\n pass\n\n asyncio.create_task(\n self._connection.wrap_api_call(\n _update_interceptor_patterns_ignore_exceptions, True\n )\n )\n if handled:\n return\n await self._browser_context._on_route(route)\n\n async def _on_web_socket_route(self, web_socket_route: WebSocketRoute) -> None:\n route_handler = next(\n (\n route_handler\n for route_handler in self._web_socket_routes\n if route_handler.matches(web_socket_route.url)\n ),\n None,\n )\n if route_handler:\n await route_handler.handle(web_socket_route)\n else:\n await self._browser_context._on_web_socket_route(web_socket_route)\n\n def _on_binding(self, binding_call: \"BindingCall\") -> None:\n func = self._bindings.get(binding_call._initializer[\"name\"])\n if func:\n asyncio.create_task(binding_call.call(func))\n self._browser_context._on_binding(binding_call)\n\n def _on_worker(self, worker: \"Worker\") -> None:\n self._workers.append(worker)\n worker._page = self\n self.emit(Page.Events.Worker, worker)\n\n def _on_close(self) -> None:\n self._is_closed = True\n if self in self._browser_context._pages:\n self._browser_context._pages.remove(self)\n self._dispose_har_routers()\n self.emit(Page.Events.Close, self)\n\n def _on_crash(self) -> None:\n self.emit(Page.Events.Crash, self)\n\n def _on_download(self, params: Any) -> None:\n url = params[\"url\"]\n suggested_filename = params[\"suggestedFilename\"]\n artifact = cast(Artifact, from_channel(params[\"artifact\"]))\n self.emit(\n Page.Events.Download, Download(self, url, suggested_filename, artifact)\n )\n\n def _on_video(self, params: Any) -> None:\n artifact = from_channel(params[\"artifact\"])\n self._force_video()._artifact_ready(artifact)\n\n def _on_viewport_size_changed(self, params: Any) -> None:\n self._viewport_size = params[\"viewportSize\"]\n\n @property\n def context(self) -> \"BrowserContext\":\n return self._browser_context\n\n @property\n def clock(self) -> Clock:\n return self._browser_context.clock\n\n async def opener(self) -> Optional[\"Page\"]:\n if self._opener and self._opener.is_closed():\n return None\n return self._opener\n\n @property\n def main_frame(self) -> Frame:\n return self._main_frame\n\n def frame(self, name: str = None, url: URLMatch = None) -> Optional[Frame]:\n for frame in self._frames:\n if name and frame.name == name:\n return frame\n if url and url_matches(self._browser_context._base_url, frame.url, url):\n return frame\n\n return None\n\n @property\n def frames(self) -> List[Frame]:\n return self._frames.copy()\n\n def set_default_navigation_timeout(self, timeout: float) -> None:\n self._timeout_settings.set_default_navigation_timeout(timeout)\n\n def set_default_timeout(self, timeout: float) -> None:\n self._timeout_settings.set_default_timeout(timeout)\n\n async def query_selector(\n self,\n selector: str,\n strict: bool = None,\n ) -> Optional[ElementHandle]:\n return await self._main_frame.query_selector(selector, strict)\n\n async def query_selector_all(self, selector: str) -> List[ElementHandle]:\n return await self._main_frame.query_selector_all(selector)\n\n async def wait_for_selector(\n self,\n selector: str,\n timeout: float = None,\n state: Literal[\"attached\", \"detached\", \"hidden\", \"visible\"] = None,\n strict: bool = None,\n ) -> Optional[ElementHandle]:\n return await self._main_frame.wait_for_selector(**locals_to_params(locals()))\n\n async def is_checked(\n self, selector: str, strict: bool = None, timeout: float = None\n ) -> bool:\n return await self._main_frame.is_checked(**locals_to_params(locals()))\n\n async def is_disabled(\n self, selector: str, strict: bool = None, timeout: float = None\n ) -> bool:\n return await self._main_frame.is_disabled(**locals_to_params(locals()))\n\n async def is_editable(\n self, selector: str, strict: bool = None, timeout: float = None\n ) -> bool:\n return await self._main_frame.is_editable(**locals_to_params(locals()))\n\n async def is_enabled(\n self, selector: str, strict: bool = None, timeout: float = None\n ) -> bool:\n return await self._main_frame.is_enabled(**locals_to_params(locals()))\n\n async def is_hidden(\n self, selector: str, strict: bool = None, timeout: float = None\n ) -> bool:\n # timeout is deprecated and does nothing\n return await self._main_frame.is_hidden(selector=selector, strict=strict)\n\n async def is_visible(\n self, selector: str, strict: bool = None, timeout: float = None\n ) -> bool:\n # timeout is deprecated and does nothing\n return await self._main_frame.is_visible(selector=selector, strict=strict)\n\n async def dispatch_event(\n self,\n selector: str,\n type: str,\n eventInit: Dict = None,\n timeout: float = None,\n strict: bool = None,\n ) -> None:\n return await self._main_frame.dispatch_event(**locals_to_params(locals()))\n\n async def evaluate(self, expression: str, arg: Serializable = None) -> Any:\n return await self._main_frame.evaluate(expression, arg)\n\n async def evaluate_handle(\n self, expression: str, arg: Serializable = None\n ) -> JSHandle:\n return await self._main_frame.evaluate_handle(expression, arg)\n\n async def eval_on_selector(\n self,\n selector: str,\n expression: str,\n arg: Serializable = None,\n strict: bool = None,\n ) -> Any:\n return await self._main_frame.eval_on_selector(\n selector, expression, arg, strict\n )\n\n async def eval_on_selector_all(\n self,\n selector: str,\n expression: str,\n arg: Serializable = None,\n ) -> Any:\n return await self._main_frame.eval_on_selector_all(selector, expression, arg)\n\n async def add_script_tag(\n self,\n url: str = None,\n path: Union[str, Path] = None,\n content: str = None,\n type: str = None,\n ) -> ElementHandle:\n return await self._main_frame.add_script_tag(**locals_to_params(locals()))\n\n async def add_style_tag(\n self, url: str = None, path: Union[str, Path] = None, content: str = None\n ) -> ElementHandle:\n return await self._main_frame.add_style_tag(**locals_to_params(locals()))\n\n async def expose_function(self, name: str, callback: Callable) -> None:\n await self.expose_binding(name, lambda source, *args: callback(*args))\n\n async def expose_binding(\n self, name: str, callback: Callable, handle: bool = None\n ) -> None:\n if name in self._bindings:\n raise Error(f'Function \"{name}\" has been already registered')\n if name in self._browser_context._bindings:\n raise Error(\n f'Function \"{name}\" has been already registered in the browser context'\n )\n self._bindings[name] = callback\n await self._channel.send(\n \"exposeBinding\",\n None,\n dict(name=name, needsHandle=handle or False),\n )\n\n async def set_extra_http_headers(self, headers: Dict[str, str]) -> None:\n await self._channel.send(\n \"setExtraHTTPHeaders\",\n None,\n dict(headers=serialize_headers(headers)),\n )\n\n @property\n def url(self) -> str:\n return self._main_frame.url\n\n async def content(self) -> str:\n return await self._main_frame.content()\n\n async def set_content(\n self,\n html: str,\n timeout: float = None,\n waitUntil: DocumentLoadState = None,\n ) -> None:\n return await self._main_frame.set_content(**locals_to_params(locals()))\n\n async def goto(\n self,\n url: str,\n timeout: float = None,\n waitUntil: DocumentLoadState = None,\n referer: str = None,\n ) -> Optional[Response]:\n return await self._main_frame.goto(**locals_to_params(locals()))\n\n async def reload(\n self,\n timeout: float = None,\n waitUntil: DocumentLoadState = None,\n ) -> Optional[Response]:\n return from_nullable_channel(\n await self._channel.send(\n \"reload\",\n self._timeout_settings.navigation_timeout,\n locals_to_params(locals()),\n )\n )\n\n async def wait_for_load_state(\n self,\n state: Literal[\"domcontentloaded\", \"load\", \"networkidle\"] = None,\n timeout: float = None,\n ) -> None:\n return await self._main_frame.wait_for_load_state(**locals_to_params(locals()))\n\n async def wait_for_url(\n self,\n url: URLMatch,\n waitUntil: DocumentLoadState = None,\n timeout: float = None,\n ) -> None:\n return await self._main_frame.wait_for_url(**locals_to_params(locals()))\n\n async def wait_for_event(\n self, event: str, predicate: Callable = None, timeout: float = None\n ) -> Any:\n async with self.expect_event(event, predicate, timeout) as event_info:\n pass\n return await event_info\n\n async def go_back(\n self,\n timeout: float = None,\n waitUntil: DocumentLoadState = None,\n ) -> Optional[Response]:\n return from_nullable_channel(\n await self._channel.send(\n \"goBack\",\n self._timeout_settings.navigation_timeout,\n locals_to_params(locals()),\n )\n )\n\n async def go_forward(\n self,\n timeout: float = None,\n waitUntil: DocumentLoadState = None,\n ) -> Optional[Response]:\n return from_nullable_channel(\n await self._channel.send(\n \"goForward\",\n self._timeout_settings.navigation_timeout,\n locals_to_params(locals()),\n )\n )\n\n async def request_gc(self) -> None:\n await self._channel.send(\"requestGC\", None)\n\n async def emulate_media(\n self,\n media: Literal[\"null\", \"print\", \"screen\"] = None,\n colorScheme: ColorScheme = None,\n reducedMotion: ReducedMotion = None,\n forcedColors: ForcedColors = None,\n contrast: Contrast = None,\n ) -> None:\n params = locals_to_params(locals())\n if \"media\" in params:\n params[\"media\"] = \"no-override\" if params[\"media\"] == \"null\" else media\n if \"colorScheme\" in params:\n params[\"colorScheme\"] = (\n \"no-override\" if params[\"colorScheme\"] == \"null\" else colorScheme\n )\n if \"reducedMotion\" in params:\n params[\"reducedMotion\"] = (\n \"no-override\" if params[\"reducedMotion\"] == \"null\" else reducedMotion\n )\n if \"forcedColors\" in params:\n params[\"forcedColors\"] = (\n \"no-override\" if params[\"forcedColors\"] == \"null\" else forcedColors\n )\n if \"contrast\" in params:\n params[\"contrast\"] = (\n \"no-override\" if params[\"contrast\"] == \"null\" else contrast\n )\n await self._channel.send(\"emulateMedia\", None, params)\n\n async def set_viewport_size(self, viewportSize: ViewportSize) -> None:\n self._viewport_size = viewportSize\n await self._channel.send(\n \"setViewportSize\",\n None,\n locals_to_params(locals()),\n )\n\n @property\n def viewport_size(self) -> Optional[ViewportSize]:\n return self._viewport_size\n\n async def bring_to_front(self) -> None:\n await self._channel.send(\"bringToFront\", None)\n\n async def add_init_script(\n self, script: str = None, path: Union[str, Path] = None\n ) -> None:\n if path:\n script = add_source_url_to_script(\n (await async_readfile(path)).decode(), path\n )\n if not isinstance(script, str):\n raise Error(\"Either path or script parameter must be specified\")\n await self._channel.send(\"addInitScript\", None, dict(source=script))\n\n async def route(\n self, url: URLMatch, handler: RouteHandlerCallback, times: int = None\n ) -> None:\n self._routes.insert(\n 0,\n RouteHandler(\n self._browser_context._base_url,\n url,\n handler,\n True if self._dispatcher_fiber else False,\n times,\n ),\n )\n await self._update_interception_patterns()\n\n async def unroute(\n self, url: URLMatch, handler: Optional[RouteHandlerCallback] = None\n ) -> None:\n removed = []\n remaining = []\n for route in self._routes:\n if route.url != url or (handler and route.handler != handler):\n remaining.append(route)\n else:\n removed.append(route)\n await self._unroute_internal(removed, remaining, \"default\")\n\n async def _unroute_internal(\n self,\n removed: List[RouteHandler],\n remaining: List[RouteHandler],\n behavior: Literal[\"default\", \"ignoreErrors\", \"wait\"] = None,\n ) -> None:\n self._routes = remaining\n if behavior is not None and behavior != \"default\":\n await asyncio.gather(\n *map(\n lambda route: route.stop(behavior), # type: ignore\n removed,\n )\n )\n await self._update_interception_patterns()\n\n async def route_web_socket(\n self, url: URLMatch, handler: WebSocketRouteHandlerCallback\n ) -> None:\n self._web_socket_routes.insert(\n 0,\n WebSocketRouteHandler(self._browser_context._base_url, url, handler),\n )\n await self._update_web_socket_interception_patterns()\n\n def _dispose_har_routers(self) -> None:\n for router in self._har_routers:\n router.dispose()\n self._har_routers = []\n\n async def unroute_all(\n self, behavior: Literal[\"default\", \"ignoreErrors\", \"wait\"] = None\n ) -> None:\n await self._unroute_internal(self._routes, [], behavior)\n self._dispose_har_routers()\n\n async def route_from_har(\n self,\n har: Union[Path, str],\n url: Union[Pattern[str], str] = None,\n notFound: RouteFromHarNotFoundPolicy = None,\n update: bool = None,\n updateContent: Literal[\"attach\", \"embed\"] = None,\n updateMode: HarMode = None,\n ) -> None:\n if update:\n await self._browser_context._record_into_har(\n har=har,\n page=self,\n url=url,\n update_content=updateContent,\n update_mode=updateMode,\n )\n return\n router = await HarRouter.create(\n local_utils=self._connection.local_utils,\n file=str(har),\n not_found_action=notFound or \"abort\",\n url_matcher=url,\n )\n self._har_routers.append(router)\n await router.add_page_route(self)\n\n async def _update_interception_patterns(self) -> None:\n patterns = RouteHandler.prepare_interception_patterns(self._routes)\n await self._channel.send(\n \"setNetworkInterceptionPatterns\",\n None,\n {\"patterns\": patterns},\n )\n\n async def _update_web_socket_interception_patterns(self) -> None:\n patterns = WebSocketRouteHandler.prepare_interception_patterns(\n self._web_socket_routes\n )\n await self._channel.send(\n \"setWebSocketInterceptionPatterns\",\n None,\n {\"patterns\": patterns},\n )\n\n async def screenshot(\n self,\n timeout: float = None,\n type: Literal[\"jpeg\", \"png\"] = None,\n path: Union[str, Path] = None,\n quality: int = None,\n omitBackground: bool = None,\n fullPage: bool = None,\n clip: FloatRect = None,\n animations: Literal[\"allow\", \"disabled\"] = None,\n caret: Literal[\"hide\", \"initial\"] = None,\n scale: Literal[\"css\", \"device\"] = None,\n mask: Sequence[\"Locator\"] = None,\n maskColor: str = None,\n style: str = None,\n ) -> bytes:\n params = locals_to_params(locals())\n if \"path\" in params:\n if \"type\" not in params:\n params[\"type\"] = determine_screenshot_type(params[\"path\"])\n del params[\"path\"]\n if \"mask\" in params:\n params[\"mask\"] = list(\n map(\n lambda locator: (\n {\n \"frame\": locator._frame._channel,\n \"selector\": locator._selector,\n }\n ),\n params[\"mask\"],\n )\n )\n encoded_binary = await self._channel.send(\n \"screenshot\", self._timeout_settings.timeout, params\n )\n decoded_binary = base64.b64decode(encoded_binary)\n if path:\n make_dirs_for_file(path)\n await async_writefile(path, decoded_binary)\n return decoded_binary\n\n async def title(self) -> str:\n return await self._main_frame.title()\n\n async def close(self, runBeforeUnload: bool = None, reason: str = None) -> None:\n self._close_reason = reason\n self._close_was_called = True\n try:\n await self._channel.send(\"close\", None, locals_to_params(locals()))\n if self._owned_context:\n await self._owned_context.close()\n except Exception as e:\n if not is_target_closed_error(e) and not runBeforeUnload:\n raise e\n\n def is_closed(self) -> bool:\n return self._is_closed\n\n async def click(\n self,\n selector: str,\n modifiers: Sequence[KeyboardModifier] = None,\n position: Position = None,\n delay: float = None,\n button: MouseButton = None,\n clickCount: int = None,\n timeout: float = None,\n force: bool = None,\n noWaitAfter: bool = None,\n trial: bool = None,\n strict: bool = None,\n ) -> None:\n return await self._main_frame._click(**locals_to_params(locals()))\n\n async def dblclick(\n self,\n selector: str,\n modifiers: Sequence[KeyboardModifier] = None,\n position: Position = None,\n delay: float = None,\n button: MouseButton = None,\n timeout: float = None,\n force: bool = None,\n noWaitAfter: bool = None,\n strict: bool = None,\n trial: bool = None,\n ) -> None:\n return await self._main_frame.dblclick(**locals_to_params(locals()))\n\n async def tap(\n self,\n selector: str,\n modifiers: Sequence[KeyboardModifier] = None,\n position: Position = None,\n timeout: float = None,\n force: bool = None,\n noWaitAfter: bool = None,\n strict: bool = None,\n trial: bool = None,\n ) -> None:\n return await self._main_frame.tap(**locals_to_params(locals()))\n\n async def fill(\n self,\n selector: str,\n value: str,\n timeout: float = None,\n noWaitAfter: bool = None,\n strict: bool = None,\n force: bool = None,\n ) -> None:\n return await self._main_frame.fill(**locals_to_params(locals()))\n\n def locator(\n self,\n selector: str,\n hasText: Union[str, Pattern[str]] = None,\n hasNotText: Union[str, Pattern[str]] = None,\n has: \"Locator\" = None,\n hasNot: \"Locator\" = None,\n ) -> \"Locator\":\n return self._main_frame.locator(\n selector,\n hasText=hasText,\n hasNotText=hasNotText,\n has=has,\n hasNot=hasNot,\n )\n\n def get_by_alt_text(\n self, text: Union[str, Pattern[str]], exact: bool = None\n ) -> \"Locator\":\n return self._main_frame.get_by_alt_text(text, exact=exact)\n\n def get_by_label(\n self, text: Union[str, Pattern[str]], exact: bool = None\n ) -> \"Locator\":\n return self._main_frame.get_by_label(text, exact=exact)\n\n def get_by_placeholder(\n self, text: Union[str, Pattern[str]], exact: bool = None\n ) -> \"Locator\":\n return self._main_frame.get_by_placeholder(text, exact=exact)\n\n def get_by_role(\n self,\n role: AriaRole,\n checked: bool = None,\n disabled: bool = None,\n expanded: bool = None,\n includeHidden: bool = None,\n level: int = None,\n name: Union[str, Pattern[str]] = None,\n pressed: bool = None,\n selected: bool = None,\n exact: bool = None,\n ) -> \"Locator\":\n return self._main_frame.get_by_role(\n role,\n checked=checked,\n disabled=disabled,\n expanded=expanded,\n includeHidden=includeHidden,\n level=level,\n name=name,\n pressed=pressed,\n selected=selected,\n exact=exact,\n )\n\n def get_by_test_id(self, testId: Union[str, Pattern[str]]) -> \"Locator\":\n return self._main_frame.get_by_test_id(testId)\n\n def get_by_text(\n self, text: Union[str, Pattern[str]], exact: bool = None\n ) -> \"Locator\":\n return self._main_frame.get_by_text(text, exact=exact)\n\n def get_by_title(\n self, text: Union[str, Pattern[str]], exact: bool = None\n ) -> \"Locator\":\n return self._main_frame.get_by_title(text, exact=exact)\n\n def frame_locator(self, selector: str) -> \"FrameLocator\":\n return self.main_frame.frame_locator(selector)\n\n async def focus(\n self, selector: str, strict: bool = None, timeout: float = None\n ) -> None:\n return await self._main_frame.focus(**locals_to_params(locals()))\n\n async def text_content(\n self, selector: str, strict: bool = None, timeout: float = None\n ) -> Optional[str]:\n return await self._main_frame.text_content(**locals_to_params(locals()))\n\n async def inner_text(\n self, selector: str, strict: bool = None, timeout: float = None\n ) -> str:\n return await self._main_frame.inner_text(**locals_to_params(locals()))\n\n async def inner_html(\n self, selector: str, strict: bool = None, timeout: float = None\n ) -> str:\n return await self._main_frame.inner_html(**locals_to_params(locals()))\n\n async def get_attribute(\n self, selector: str, name: str, strict: bool = None, timeout: float = None\n ) -> Optional[str]:\n return await self._main_frame.get_attribute(**locals_to_params(locals()))\n\n async def hover(\n self,\n selector: str,\n modifiers: Sequence[KeyboardModifier] = None,\n position: Position = None,\n timeout: float = None,\n noWaitAfter: bool = None,\n force: bool = None,\n strict: bool = None,\n trial: bool = None,\n ) -> None:\n return await self._main_frame.hover(**locals_to_params(locals()))\n\n async def drag_and_drop(\n self,\n source: str,\n target: str,\n sourcePosition: Position = None,\n targetPosition: Position = None,\n force: bool = None,\n noWaitAfter: bool = None,\n timeout: float = None,\n strict: bool = None,\n trial: bool = None,\n steps: int = None,\n ) -> None:\n return await self._main_frame.drag_and_drop(**locals_to_params(locals()))\n\n async def select_option(\n self,\n selector: str,\n value: Union[str, Sequence[str]] = None,\n index: Union[int, Sequence[int]] = None,\n label: Union[str, Sequence[str]] = None,\n element: Union[\"ElementHandle\", Sequence[\"ElementHandle\"]] = None,\n timeout: float = None,\n noWaitAfter: bool = None,\n force: bool = None,\n strict: bool = None,\n ) -> List[str]:\n params = locals_to_params(locals())\n return await self._main_frame.select_option(**params)\n\n async def input_value(\n self, selector: str, strict: bool = None, timeout: float = None\n ) -> str:\n params = locals_to_params(locals())\n return await self._main_frame.input_value(**params)\n\n async def set_input_files(\n self,\n selector: str,\n files: Union[\n str, Path, FilePayload, Sequence[Union[str, Path]], Sequence[FilePayload]\n ],\n timeout: float = None,\n strict: bool = None,\n noWaitAfter: bool = None,\n ) -> None:\n return await self._main_frame.set_input_files(**locals_to_params(locals()))\n\n async def type(\n self,\n selector: str,\n text: str,\n delay: float = None,\n timeout: float = None,\n noWaitAfter: bool = None,\n strict: bool = None,\n ) -> None:\n return await self._main_frame.type(**locals_to_params(locals()))\n\n async def press(\n self,\n selector: str,\n key: str,\n delay: float = None,\n timeout: float = None,\n noWaitAfter: bool = None,\n strict: bool = None,\n ) -> None:\n return await self._main_frame.press(**locals_to_params(locals()))\n\n async def check(\n self,\n selector: str,\n position: Position = None,\n timeout: float = None,\n force: bool = None,\n noWaitAfter: bool = None,\n strict: bool = None,\n trial: bool = None,\n ) -> None:\n return await self._main_frame.check(**locals_to_params(locals()))\n\n async def uncheck(\n self,\n selector: str,\n position: Position = None,\n timeout: float = None,\n force: bool = None,\n noWaitAfter: bool = None,\n strict: bool = None,\n trial: bool = None,\n ) -> None:\n return await self._main_frame.uncheck(**locals_to_params(locals()))\n\n async def wait_for_timeout(self, timeout: float) -> None:\n await self._main_frame.wait_for_timeout(timeout)\n\n async def wait_for_function(\n self,\n expression: str,\n arg: Serializable = None,\n timeout: float = None,\n polling: Union[float, Literal[\"raf\"]] = None,\n ) -> JSHandle:\n return await self._main_frame.wait_for_function(**locals_to_params(locals()))\n\n @property\n def workers(self) -> List[\"Worker\"]:\n return self._workers.copy()\n\n @property\n def request(self) -> \"APIRequestContext\":\n return self.context.request\n\n async def pause(self) -> None:\n default_navigation_timeout = (\n self._browser_context._timeout_settings.default_navigation_timeout()\n )\n default_timeout = self._browser_context._timeout_settings.default_timeout()\n self._browser_context.set_default_navigation_timeout(0)\n self._browser_context.set_default_timeout(0)\n try:\n await asyncio.wait(\n [\n asyncio.create_task(\n self._browser_context._channel.send(\"pause\", None)\n ),\n self._closed_or_crashed_future,\n ],\n return_when=asyncio.FIRST_COMPLETED,\n )\n finally:\n self._browser_context._set_default_navigation_timeout_impl(\n default_navigation_timeout\n )\n self._browser_context._set_default_timeout_impl(default_timeout)\n\n async def pdf(\n self,\n scale: float = None,\n displayHeaderFooter: bool = None,\n headerTemplate: str = None,\n footerTemplate: str = None,\n printBackground: bool = None,\n landscape: bool = None,\n pageRanges: str = None,\n format: str = None,\n width: Union[str, float] = None,\n height: Union[str, float] = None,\n preferCSSPageSize: bool = None,\n margin: PdfMargins = None,\n path: Union[str, Path] = None,\n outline: bool = None,\n tagged: bool = None,\n ) -> bytes:\n params = locals_to_params(locals())\n if \"path\" in params:\n del params[\"path\"]\n encoded_binary = await self._channel.send(\"pdf\", None, params)\n decoded_binary = base64.b64decode(encoded_binary)\n if path:\n make_dirs_for_file(path)\n await async_writefile(path, decoded_binary)\n return decoded_binary\n\n def _force_video(self) -> Video:\n if not self._video:\n self._video = Video(self)\n return self._video\n\n @property\n def video(\n self,\n ) -> Optional[Video]:\n # Note: we are creating Video object lazily, because we do not know\n # BrowserContextOptions when constructing the page - it is assigned\n # too late during launchPersistentContext.\n if not self._browser_context._videos_dir:\n return None\n return self._force_video()\n\n def _close_error_with_reason(self) -> TargetClosedError:\n return TargetClosedError(\n self._close_reason or self._browser_context._effective_close_reason()\n )\n\n def expect_event(\n self,\n event: str,\n predicate: Callable = None,\n timeout: float = None,\n ) -> EventContextManagerImpl:\n return self._expect_event(\n event, predicate, timeout, f'waiting for event \"{event}\"'\n )\n\n def _expect_event(\n self,\n event: str,\n predicate: Callable = None,\n timeout: float = None,\n log_line: str = None,\n ) -> EventContextManagerImpl:\n if timeout is None:\n timeout = self._timeout_settings.timeout()\n waiter = Waiter(self, f\"page.expect_event({event})\")\n waiter.reject_on_timeout(\n timeout, f'Timeout {timeout}ms exceeded while waiting for event \"{event}\"'\n )\n if log_line:\n waiter.log(log_line)\n if event != Page.Events.Crash:\n waiter.reject_on_event(self, Page.Events.Crash, Error(\"Page crashed\"))\n if event != Page.Events.Close:\n waiter.reject_on_event(\n self, Page.Events.Close, lambda: self._close_error_with_reason()\n )\n waiter.wait_for_event(self, event, predicate)\n return EventContextManagerImpl(waiter.result())\n\n def expect_console_message(\n self,\n predicate: Callable[[ConsoleMessage], bool] = None,\n timeout: float = None,\n ) -> EventContextManagerImpl[ConsoleMessage]:\n return self.expect_event(Page.Events.Console, predicate, timeout)\n\n def expect_download(\n self,\n predicate: Callable[[Download], bool] = None,\n timeout: float = None,\n ) -> EventContextManagerImpl[Download]:\n return self.expect_event(Page.Events.Download, predicate, timeout)\n\n def expect_file_chooser(\n self,\n predicate: Callable[[FileChooser], bool] = None,\n timeout: float = None,\n ) -> EventContextManagerImpl[FileChooser]:\n return self.expect_event(Page.Events.FileChooser, predicate, timeout)\n\n def expect_navigation(\n self,\n url: URLMatch = None,\n waitUntil: DocumentLoadState = None,\n timeout: float = None,\n ) -> EventContextManagerImpl[Response]:\n return self.main_frame.expect_navigation(url, waitUntil, timeout)\n\n def expect_popup(\n self,\n predicate: Callable[[\"Page\"], bool] = None,\n timeout: float = None,\n ) -> EventContextManagerImpl[\"Page\"]:\n return self.expect_event(Page.Events.Popup, predicate, timeout)\n\n def expect_request(\n self,\n urlOrPredicate: URLMatchRequest,\n timeout: float = None,\n ) -> EventContextManagerImpl[Request]:\n def my_predicate(request: Request) -> bool:\n if not callable(urlOrPredicate):\n return url_matches(\n self._browser_context._base_url,\n request.url,\n urlOrPredicate,\n )\n return urlOrPredicate(request)\n\n trimmed_url = trim_url(urlOrPredicate)\n log_line = f\"waiting for request {trimmed_url}\" if trimmed_url else None\n return self._expect_event(\n Page.Events.Request,\n predicate=my_predicate,\n timeout=timeout,\n log_line=log_line,\n )\n\n def expect_request_finished(\n self,\n predicate: Callable[[\"Request\"], bool] = None,\n timeout: float = None,\n ) -> EventContextManagerImpl[Request]:\n return self.expect_event(\n Page.Events.RequestFinished, predicate=predicate, timeout=timeout\n )\n\n def expect_response(\n self,\n urlOrPredicate: URLMatchResponse,\n timeout: float = None,\n ) -> EventContextManagerImpl[Response]:\n def my_predicate(request: Response) -> bool:\n if not callable(urlOrPredicate):\n return url_matches(\n self._browser_context._base_url,\n request.url,\n urlOrPredicate,\n )\n return urlOrPredicate(request)\n\n trimmed_url = trim_url(urlOrPredicate)\n log_line = f\"waiting for response {trimmed_url}\" if trimmed_url else None\n return self._expect_event(\n Page.Events.Response,\n predicate=my_predicate,\n timeout=timeout,\n log_line=log_line,\n )\n\n def expect_websocket(\n self,\n predicate: Callable[[\"WebSocket\"], bool] = None,\n timeout: float = None,\n ) -> EventContextManagerImpl[\"WebSocket\"]:\n return self.expect_event(\"websocket\", predicate, timeout)\n\n def expect_worker(\n self,\n predicate: Callable[[\"Worker\"], bool] = None,\n timeout: float = None,\n ) -> EventContextManagerImpl[\"Worker\"]:\n return self.expect_event(\"worker\", predicate, timeout)\n\n async def set_checked(\n self,\n selector: str,\n checked: bool,\n position: Position = None,\n timeout: float = None,\n force: bool = None,\n noWaitAfter: bool = None,\n strict: bool = None,\n trial: bool = None,\n ) -> None:\n if checked:\n await self.check(\n selector=selector,\n position=position,\n timeout=timeout,\n force=force,\n strict=strict,\n trial=trial,\n )\n else:\n await self.uncheck(\n selector=selector,\n position=position,\n timeout=timeout,\n force=force,\n strict=strict,\n trial=trial,\n )\n\n async def add_locator_handler(\n self,\n locator: \"Locator\",\n handler: Union[Callable[[\"Locator\"], Any], Callable[[], Any]],\n noWaitAfter: bool = None,\n times: int = None,\n ) -> None:\n if locator._frame != self._main_frame:\n raise Error(\"Locator must belong to the main frame of this page\")\n if times == 0:\n return\n uid = await self._channel.send(\n \"registerLocatorHandler\",\n None,\n {\n \"selector\": locator._selector,\n \"noWaitAfter\": noWaitAfter,\n },\n )\n self._locator_handlers[uid] = LocatorHandler(\n handler=handler, times=times, locator=locator\n )\n\n async def _on_locator_handler_triggered(self, uid: str) -> None:\n remove = False\n try:\n handler = self._locator_handlers.get(uid)\n if handler and handler.times != 0:\n if handler.times is not None:\n handler.times -= 1\n if self._dispatcher_fiber:\n handler_finished_future = self._loop.create_future()\n\n def _handler() -> None:\n try:\n handler()\n handler_finished_future.set_result(None)\n except Exception as e:\n handler_finished_future.set_exception(e)\n\n g = LocatorHandlerGreenlet(_handler)\n g.switch()\n await handler_finished_future\n else:\n coro_or_future = handler()\n if coro_or_future:\n await coro_or_future\n remove = handler.times == 0\n finally:\n if remove:\n del self._locator_handlers[uid]\n try:\n await self._connection.wrap_api_call(\n lambda: self._channel.send(\n \"resolveLocatorHandlerNoReply\",\n None,\n {\"uid\": uid, \"remove\": remove},\n ),\n is_internal=True,\n )\n except Error:\n pass\n\n async def remove_locator_handler(self, locator: \"Locator\") -> None:\n for uid, data in self._locator_handlers.copy().items():\n if data.locator._equals(locator):\n del self._locator_handlers[uid]\n self._channel.send_no_reply(\n \"unregisterLocatorHandler\",\n None,\n {\"uid\": uid},\n )\n\n async def requests(self) -> List[Request]:\n request_objects = await self._channel.send(\"requests\", None)\n return [from_channel(r) for r in request_objects]\n\n async def console_messages(self) -> List[ConsoleMessage]:\n message_dicts = await self._channel.send(\"consoleMessages\", None)\n return [\n ConsoleMessage(\n {**event, \"page\": self._channel}, self._loop, self._dispatcher_fiber\n )\n for event in message_dicts\n ]\n\n async def page_errors(self) -> List[Error]:\n error_objects = await self._channel.send(\"pageErrors\", None)\n return [parse_error(error[\"error\"]) for error in error_objects]\n\n\nclass Worker(ChannelOwner):\n Events = SimpleNamespace(Close=\"close\", Console=\"console\")\n\n def __init__(\n self, parent: ChannelOwner, type: str, guid: str, initializer: Dict\n ) -> None:\n super().__init__(parent, type, guid, initializer)\n self._set_event_to_subscription_mapping({Worker.Events.Console: \"console\"})\n self._channel.on(\"close\", lambda _: self._on_close())\n self._page: Optional[Page] = None\n self._context: Optional[\"BrowserContext\"] = None\n\n def __repr__(self) -> str:\n return f\"\"\n\n def _on_close(self) -> None:\n if self._page:\n self._page._workers.remove(self)\n if self._context:\n self._context._service_workers.remove(self)\n self.emit(Worker.Events.Close, self)\n\n @property\n def url(self) -> str:\n return self._initializer[\"url\"]\n\n async def evaluate(self, expression: str, arg: Serializable = None) -> Any:\n return parse_result(\n await self._channel.send(\n \"evaluateExpression\",\n None,\n dict(\n expression=expression,\n arg=serialize_argument(arg),\n ),\n )\n )\n\n async def evaluate_handle(\n self, expression: str, arg: Serializable = None\n ) -> JSHandle:\n return from_channel(\n await self._channel.send(\n \"evaluateExpressionHandle\",\n None,\n dict(\n expression=expression,\n arg=serialize_argument(arg),\n ),\n )\n )\n\n def expect_event(\n self,\n event: str,\n predicate: Callable = None,\n timeout: float = None,\n ) -> EventContextManagerImpl:\n if timeout is None:\n if self._page:\n timeout = self._page._timeout_settings.timeout()\n elif self._context:\n timeout = self._context._timeout_settings.timeout()\n else:\n timeout = 30000\n waiter = Waiter(self, f\"worker.expect_event({event})\")\n waiter.reject_on_timeout(\n cast(float, timeout),\n f'Timeout {timeout}ms exceeded while waiting for event \"{event}\"',\n )\n if event != Worker.Events.Close:\n waiter.reject_on_event(\n self, Worker.Events.Close, lambda: TargetClosedError()\n )\n waiter.wait_for_event(self, event, predicate)\n return EventContextManagerImpl(waiter.result())\n\n\nclass BindingCall(ChannelOwner):\n def __init__(\n self, parent: ChannelOwner, type: str, guid: str, initializer: Dict\n ) -> None:\n super().__init__(parent, type, guid, initializer)\n\n async def call(self, func: Callable) -> None:\n try:\n frame = from_channel(self._initializer[\"frame\"])\n source = dict(context=frame._page.context, page=frame._page, frame=frame)\n if self._initializer.get(\"handle\"):\n result = func(source, from_channel(self._initializer[\"handle\"]))\n else:\n func_args = list(map(parse_result, self._initializer[\"args\"]))\n result = func(source, *func_args)\n if inspect.iscoroutine(result):\n result = await result\n await self._channel.send(\n \"resolve\", None, dict(result=serialize_argument(result))\n )\n except Exception as e:\n tb = sys.exc_info()[2]\n asyncio.create_task(\n self._channel.send(\n \"reject\", None, dict(error=dict(error=serialize_error(e, tb)))\n )\n )\n\n\ndef trim_url(param: Union[URLMatchRequest, URLMatchResponse]) -> Optional[str]:\n if isinstance(param, re.Pattern):\n return trim_end(param.pattern)\n if isinstance(param, str):\n return trim_end(param)\n return None\n\n\ndef trim_end(s: str) -> str:\n if len(s) > 50:\n return s[:50] + \"\\u2026\"\n return s\n" }, { "path": "playwright/_impl/_path_utils.py", "content": "# Copyright (c) Microsoft Corporation.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n\nimport inspect\nfrom pathlib import Path\nfrom types import FrameType\nfrom typing import cast\n\n\ndef get_file_dirname() -> Path:\n \"\"\"Returns the callee (`__file__`) directory name\"\"\"\n frame = cast(FrameType, inspect.currentframe()).f_back\n module = inspect.getmodule(frame)\n assert module\n assert module.__file__\n return Path(module.__file__).parent.absolute()\n" }, { "path": "playwright/_impl/_playwright.py", "content": "# Copyright (c) Microsoft Corporation.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n\nfrom typing import Dict\n\nfrom playwright._impl._browser_type import BrowserType\nfrom playwright._impl._connection import ChannelOwner, from_channel\nfrom playwright._impl._fetch import APIRequest\nfrom playwright._impl._selectors import Selectors\n\n\nclass Playwright(ChannelOwner):\n devices: Dict\n selectors: Selectors\n chromium: BrowserType\n firefox: BrowserType\n webkit: BrowserType\n request: APIRequest\n\n def __init__(\n self, parent: ChannelOwner, type: str, guid: str, initializer: Dict\n ) -> None:\n super().__init__(parent, type, guid, initializer)\n self.request = APIRequest(self)\n self.chromium = from_channel(initializer[\"chromium\"])\n self.chromium._playwright = self\n self.firefox = from_channel(initializer[\"firefox\"])\n self.firefox._playwright = self\n self.webkit = from_channel(initializer[\"webkit\"])\n self.webkit._playwright = self\n\n self.selectors = Selectors(self._loop, self._dispatcher_fiber)\n\n self.devices = self._connection.local_utils.devices\n\n def __getitem__(self, value: str) -> \"BrowserType\":\n if value == \"chromium\":\n return self.chromium\n elif value == \"firefox\":\n return self.firefox\n elif value == \"webkit\":\n return self.webkit\n raise ValueError(\"Invalid browser \" + value)\n\n def _set_selectors(self, selectors: Selectors) -> None:\n self.selectors = selectors\n\n async def stop(self) -> None:\n pass\n" }, { "path": "playwright/_impl/_selectors.py", "content": "# Copyright (c) Microsoft Corporation.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n\nimport asyncio\nfrom pathlib import Path\nfrom typing import Any, Dict, List, Optional, Set, Union\n\nfrom playwright._impl._browser_context import BrowserContext\nfrom playwright._impl._errors import Error\nfrom playwright._impl._helper import async_readfile\nfrom playwright._impl._locator import set_test_id_attribute_name\n\n\nclass Selectors:\n def __init__(self, loop: asyncio.AbstractEventLoop, dispatcher_fiber: Any) -> None:\n self._loop = loop\n self._contexts_for_selectors: Set[BrowserContext] = set()\n self._selector_engines: List[Dict] = []\n self._dispatcher_fiber = dispatcher_fiber\n self._test_id_attribute_name: Optional[str] = None\n\n async def register(\n self,\n name: str,\n script: str = None,\n path: Union[str, Path] = None,\n contentScript: bool = None,\n ) -> None:\n if any(engine for engine in self._selector_engines if engine[\"name\"] == name):\n raise Error(\n f'Selectors.register: \"{name}\" selector engine has been already registered'\n )\n if not script and not path:\n raise Error(\"Either source or path should be specified\")\n if path:\n script = (await async_readfile(path)).decode()\n engine: Dict[str, Any] = dict(name=name, source=script)\n if contentScript:\n engine[\"contentScript\"] = contentScript\n for context in self._contexts_for_selectors:\n await context._channel.send(\n \"registerSelectorEngine\",\n None,\n {\"selectorEngine\": engine},\n )\n self._selector_engines.append(engine)\n\n def set_test_id_attribute(self, attributeName: str) -> None:\n set_test_id_attribute_name(attributeName)\n self._test_id_attribute_name = attributeName\n for context in self._contexts_for_selectors:\n context._channel.send_no_reply(\n \"setTestIdAttributeName\",\n None,\n {\"testIdAttributeName\": attributeName},\n )\n" }, { "path": "playwright/_impl/_set_input_files_helpers.py", "content": "# Copyright (c) Microsoft Corporation.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\nimport base64\nimport collections.abc\nimport os\nimport stat\nfrom pathlib import Path\nfrom typing import (\n TYPE_CHECKING,\n Dict,\n List,\n Optional,\n Sequence,\n Tuple,\n TypedDict,\n Union,\n cast,\n)\n\nfrom playwright._impl._connection import Channel, from_channel\nfrom playwright._impl._helper import Error\nfrom playwright._impl._writable_stream import WritableStream\n\nif TYPE_CHECKING: # pragma: no cover\n from playwright._impl._browser_context import BrowserContext\n\nfrom playwright._impl._api_structures import FilePayload\n\nSIZE_LIMIT_IN_BYTES = 50 * 1024 * 1024\n\n\nclass InputFilesList(TypedDict, total=False):\n streams: Optional[List[Channel]]\n directoryStream: Optional[Channel]\n localDirectory: Optional[str]\n localPaths: Optional[List[str]]\n payloads: Optional[List[Dict[str, Union[str, bytes]]]]\n\n\ndef _list_files(directory: str) -> List[str]:\n files = []\n for root, _, filenames in os.walk(directory):\n for filename in filenames:\n files.append(os.path.join(root, filename))\n return files\n\n\nasync def convert_input_files(\n files: Union[\n str, Path, FilePayload, Sequence[Union[str, Path]], Sequence[FilePayload]\n ],\n context: \"BrowserContext\",\n) -> InputFilesList:\n items = (\n files\n if isinstance(files, collections.abc.Sequence) and not isinstance(files, str)\n else [files]\n )\n\n if any([isinstance(item, (str, Path)) for item in items]):\n if not all([isinstance(item, (str, Path)) for item in items]):\n raise Error(\"File paths cannot be mixed with buffers\")\n\n (local_paths, local_directory) = resolve_paths_and_directory_for_input_files(\n cast(Sequence[Union[str, Path]], items)\n )\n\n if context._channel._connection.is_remote:\n files_to_stream = cast(\n List[str],\n (_list_files(local_directory) if local_directory else local_paths),\n )\n streams = []\n result = await context._connection.wrap_api_call(\n lambda: context._channel.send_return_as_dict(\n \"createTempFiles\",\n None,\n {\n \"rootDirName\": (\n os.path.basename(local_directory)\n if local_directory\n else None\n ),\n \"items\": list(\n map(\n lambda file: dict(\n name=(\n os.path.relpath(file, local_directory)\n if local_directory\n else os.path.basename(file)\n ),\n lastModifiedMs=int(os.path.getmtime(file) * 1000),\n ),\n files_to_stream,\n )\n ),\n },\n )\n )\n for i, file in enumerate(result[\"writableStreams\"]):\n stream: WritableStream = from_channel(file)\n await stream.copy(files_to_stream[i])\n streams.append(stream._channel)\n return InputFilesList(\n streams=None if local_directory else streams,\n directoryStream=result.get(\"rootDir\"),\n )\n return InputFilesList(localPaths=local_paths, localDirectory=local_directory)\n\n file_payload_exceeds_size_limit = (\n sum([len(f.get(\"buffer\", \"\")) for f in items if not isinstance(f, (str, Path))])\n > SIZE_LIMIT_IN_BYTES\n )\n if file_payload_exceeds_size_limit:\n raise Error(\n \"Cannot set buffer larger than 50Mb, please write it to a file and pass its path instead.\"\n )\n\n return InputFilesList(\n payloads=[\n {\n \"name\": item[\"name\"],\n \"mimeType\": item[\"mimeType\"],\n \"buffer\": base64.b64encode(item[\"buffer\"]).decode(),\n }\n for item in cast(List[FilePayload], items)\n ]\n )\n\n\ndef resolve_paths_and_directory_for_input_files(\n items: Sequence[Union[str, Path]],\n) -> Tuple[Optional[List[str]], Optional[str]]:\n local_paths: Optional[List[str]] = None\n local_directory: Optional[str] = None\n for item in items:\n item_stat = os.stat(item) # Raises FileNotFoundError if doesn't exist\n if stat.S_ISDIR(item_stat.st_mode):\n if local_directory:\n raise Error(\"Multiple directories are not supported\")\n local_directory = str(Path(item).resolve())\n else:\n local_paths = local_paths or []\n local_paths.append(str(Path(item).resolve()))\n if local_paths and local_directory:\n raise Error(\"File paths must be all files or a single directory\")\n return (local_paths, local_directory)\n" }, { "path": "playwright/_impl/_str_utils.py", "content": "# Copyright (c) Microsoft Corporation.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n\nimport json\nimport re\nfrom typing import Pattern, Union\n\n\ndef escape_regex_flags(pattern: Pattern) -> str:\n flags = \"\"\n if pattern.flags != 0:\n flags = \"\"\n if (pattern.flags & int(re.IGNORECASE)) != 0:\n flags += \"i\"\n if (pattern.flags & int(re.DOTALL)) != 0:\n flags += \"s\"\n if (pattern.flags & int(re.MULTILINE)) != 0:\n flags += \"m\"\n assert (\n pattern.flags\n & ~(int(re.MULTILINE) | int(re.IGNORECASE) | int(re.DOTALL) | int(re.UNICODE))\n == 0\n ), \"Unexpected re.Pattern flag, only MULTILINE, IGNORECASE and DOTALL are supported.\"\n return flags\n\n\ndef escape_for_regex(text: str) -> str:\n return re.sub(r\"[.*+?^>${}()|[\\]\\\\]\", \"\\\\$&\", text)\n\n\ndef escape_regex_for_selector(text: Pattern) -> str:\n # Even number of backslashes followed by the quote -> insert a backslash.\n return (\n \"/\"\n + re.sub(r'(^|[^\\\\])(\\\\\\\\)*([\"\\'`])', r\"\\1\\2\\\\\\3\", text.pattern).replace(\n \">>\", \"\\\\>\\\\>\"\n )\n + \"/\"\n + escape_regex_flags(text)\n )\n\n\ndef escape_for_text_selector(\n text: Union[str, Pattern[str]], exact: bool = None, case_sensitive: bool = None\n) -> str:\n if isinstance(text, Pattern):\n return escape_regex_for_selector(text)\n return json.dumps(text) + (\"s\" if exact else \"i\")\n\n\ndef escape_for_attribute_selector(\n value: Union[str, Pattern], exact: bool = None\n) -> str:\n if isinstance(value, Pattern):\n return escape_regex_for_selector(value)\n # TODO: this should actually be\n # cssEscape(value).replace(/\\\\ /g, ' ')\n # However, our attribute selectors do not conform to CSS parsing spec,\n # so we escape them differently.\n return (\n '\"'\n + value.replace(\"\\\\\", \"\\\\\\\\\").replace('\"', '\\\\\"')\n + '\"'\n + (\"s\" if exact else \"i\")\n )\n" }, { "path": "playwright/_impl/_stream.py", "content": "# Copyright (c) Microsoft Corporation.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n\nimport base64\nfrom pathlib import Path\nfrom typing import Dict, Union\n\nfrom playwright._impl._connection import ChannelOwner\n\n\nclass Stream(ChannelOwner):\n def __init__(\n self, parent: ChannelOwner, type: str, guid: str, initializer: Dict\n ) -> None:\n super().__init__(parent, type, guid, initializer)\n\n async def save_as(self, path: Union[str, Path]) -> None:\n file = await self._loop.run_in_executor(None, lambda: open(path, \"wb\"))\n while True:\n binary = await self._channel.send(\"read\", None, {\"size\": 1024 * 1024})\n if not binary:\n break\n await self._loop.run_in_executor(\n None, lambda: file.write(base64.b64decode(binary))\n )\n await self._loop.run_in_executor(None, lambda: file.close())\n\n async def read_all(self) -> bytes:\n binary = b\"\"\n while True:\n chunk = await self._channel.send(\"read\", None, {\"size\": 1024 * 1024})\n if not chunk:\n break\n binary += base64.b64decode(chunk)\n return binary\n" }, { "path": "playwright/_impl/_sync_base.py", "content": "# Copyright (c) Microsoft Corporation.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n\nimport asyncio\nimport inspect\nimport traceback\nfrom contextlib import AbstractContextManager\nfrom types import TracebackType\nfrom typing import (\n Any,\n Callable,\n Coroutine,\n Generator,\n Generic,\n Optional,\n Type,\n TypeVar,\n Union,\n cast,\n)\n\nimport greenlet\n\nfrom playwright._impl._helper import Error\nfrom playwright._impl._impl_to_api_mapping import ImplToApiMapping, ImplWrapper\n\nmapping = ImplToApiMapping()\n\n\nT = TypeVar(\"T\")\nSelf = TypeVar(\"Self\", bound=\"SyncContextManager\")\n\n\nclass EventInfo(Generic[T]):\n def __init__(self, sync_base: \"SyncBase\", future: \"asyncio.Future[T]\") -> None:\n self._sync_base = sync_base\n self._future = future\n g_self = greenlet.getcurrent()\n self._future.add_done_callback(lambda _: g_self.switch())\n\n @property\n def value(self) -> T:\n while not self._future.done():\n self._sync_base._dispatcher_fiber.switch()\n asyncio._set_running_loop(self._sync_base._loop)\n exception = self._future.exception()\n if exception:\n raise exception\n return cast(T, mapping.from_maybe_impl(self._future.result()))\n\n def _cancel(self) -> None:\n self._future.cancel()\n\n def is_done(self) -> bool:\n return self._future.done()\n\n\nclass EventContextManager(Generic[T], AbstractContextManager):\n def __init__(self, sync_base: \"SyncBase\", future: \"asyncio.Future[T]\") -> None:\n self._event = EventInfo[T](sync_base, future)\n\n def __enter__(self) -> EventInfo[T]:\n return self._event\n\n def __exit__(\n self,\n exc_type: Optional[Type[BaseException]],\n exc_val: Optional[BaseException],\n exc_tb: Optional[TracebackType],\n ) -> None:\n if exc_val:\n self._event._cancel()\n else:\n self._event.value\n\n\nclass SyncBase(ImplWrapper):\n def __init__(self, impl_obj: Any) -> None:\n super().__init__(impl_obj)\n self._loop: asyncio.AbstractEventLoop = impl_obj._loop\n self._dispatcher_fiber = impl_obj._dispatcher_fiber\n\n def __str__(self) -> str:\n return self._impl_obj.__str__()\n\n def _sync(\n self,\n coro: Union[Coroutine[Any, Any, Any], Generator[Any, Any, Any]],\n ) -> Any:\n __tracebackhide__ = True\n if self._loop.is_closed():\n coro.close()\n raise Error(\"Event loop is closed! Is Playwright already stopped?\")\n\n g_self = greenlet.getcurrent()\n task: asyncio.tasks.Task[Any] = self._loop.create_task(coro)\n setattr(task, \"__pw_stack__\", inspect.stack(0))\n setattr(task, \"__pw_stack_trace__\", traceback.extract_stack(limit=10))\n\n task.add_done_callback(lambda _: g_self.switch())\n while not task.done():\n self._dispatcher_fiber.switch()\n asyncio._set_running_loop(self._loop)\n return task.result()\n\n def _wrap_handler(\n self, handler: Union[Callable[..., Any], Any]\n ) -> Callable[..., None]:\n if callable(handler):\n return mapping.wrap_handler(handler)\n return handler\n\n def on(self, event: Any, f: Any) -> None:\n \"\"\"Registers the function ``f`` to the event name ``event``.\"\"\"\n self._impl_obj.on(event, self._wrap_handler(f))\n\n def once(self, event: Any, f: Any) -> None:\n \"\"\"The same as ``self.on``, except that the listener is automatically\n removed after being called.\n \"\"\"\n self._impl_obj.once(event, self._wrap_handler(f))\n\n def remove_listener(self, event: Any, f: Any) -> None:\n \"\"\"Removes the function ``f`` from ``event``.\"\"\"\n self._impl_obj.remove_listener(event, self._wrap_handler(f))\n\n\nclass SyncContextManager(SyncBase):\n def __enter__(self: Self) -> Self:\n return self\n\n def __exit__(\n self,\n exc_type: Optional[Type[BaseException]],\n exc_val: Optional[BaseException],\n _traceback: Optional[TracebackType],\n ) -> None:\n self.close()\n\n def close(self) -> None: ...\n" }, { "path": "playwright/_impl/_tracing.py", "content": "# Copyright (c) Microsoft Corporation.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n\nimport pathlib\nfrom typing import Dict, Optional, Union, cast\n\nfrom playwright._impl._api_structures import TracingGroupLocation\nfrom playwright._impl._artifact import Artifact\nfrom playwright._impl._connection import ChannelOwner, from_nullable_channel\nfrom playwright._impl._helper import locals_to_params\n\n\nclass Tracing(ChannelOwner):\n def __init__(\n self, parent: ChannelOwner, type: str, guid: str, initializer: Dict\n ) -> None:\n super().__init__(parent, type, guid, initializer)\n self._include_sources: bool = False\n self._stacks_id: Optional[str] = None\n self._is_tracing: bool = False\n self._traces_dir: Optional[str] = None\n\n async def start(\n self,\n name: str = None,\n title: str = None,\n snapshots: bool = None,\n screenshots: bool = None,\n sources: bool = None,\n ) -> None:\n params = locals_to_params(locals())\n self._include_sources = bool(sources)\n\n await self._channel.send(\"tracingStart\", None, params)\n trace_name = await self._channel.send(\n \"tracingStartChunk\", None, {\"title\": title, \"name\": name}\n )\n await self._start_collecting_stacks(trace_name)\n\n async def start_chunk(self, title: str = None, name: str = None) -> None:\n params = locals_to_params(locals())\n trace_name = await self._channel.send(\"tracingStartChunk\", None, params)\n await self._start_collecting_stacks(trace_name)\n\n async def _start_collecting_stacks(self, trace_name: str) -> None:\n if not self._is_tracing:\n self._is_tracing = True\n self._connection.set_is_tracing(True)\n self._stacks_id = await self._connection.local_utils.tracing_started(\n self._traces_dir, trace_name\n )\n\n async def stop_chunk(self, path: Union[pathlib.Path, str] = None) -> None:\n await self._do_stop_chunk(path)\n\n async def stop(self, path: Union[pathlib.Path, str] = None) -> None:\n await self._do_stop_chunk(path)\n await self._channel.send(\n \"tracingStop\",\n None,\n )\n\n async def _do_stop_chunk(self, file_path: Union[pathlib.Path, str] = None) -> None:\n self._reset_stack_counter()\n\n if not file_path:\n # Not interested in any artifacts\n await self._channel.send(\"tracingStopChunk\", None, {\"mode\": \"discard\"})\n if self._stacks_id:\n await self._connection.local_utils.trace_discarded(self._stacks_id)\n return\n\n is_local = not self._connection.is_remote\n\n if is_local:\n result = await self._channel.send_return_as_dict(\n \"tracingStopChunk\", None, {\"mode\": \"entries\"}\n )\n await self._connection.local_utils.zip(\n {\n \"zipFile\": str(file_path),\n \"entries\": result[\"entries\"],\n \"stacksId\": self._stacks_id,\n \"mode\": \"write\",\n \"includeSources\": self._include_sources,\n }\n )\n return\n\n result = await self._channel.send_return_as_dict(\n \"tracingStopChunk\",\n None,\n {\n \"mode\": \"archive\",\n },\n )\n\n artifact = cast(\n Optional[Artifact],\n from_nullable_channel(result.get(\"artifact\")),\n )\n\n # The artifact may be missing if the browser closed while stopping tracing.\n if not artifact:\n if self._stacks_id:\n await self._connection.local_utils.trace_discarded(self._stacks_id)\n return\n\n # Save trace to the final local file.\n await artifact.save_as(file_path)\n await artifact.delete()\n\n await self._connection.local_utils.zip(\n {\n \"zipFile\": str(file_path),\n \"entries\": [],\n \"stacksId\": self._stacks_id,\n \"mode\": \"append\",\n \"includeSources\": self._include_sources,\n }\n )\n\n def _reset_stack_counter(self) -> None:\n if self._is_tracing:\n self._is_tracing = False\n self._connection.set_is_tracing(False)\n\n async def group(self, name: str, location: TracingGroupLocation = None) -> None:\n await self._channel.send(\"tracingGroup\", None, locals_to_params(locals()))\n\n async def group_end(self) -> None:\n await self._channel.send(\n \"tracingGroupEnd\",\n None,\n )\n" }, { "path": "playwright/_impl/_transport.py", "content": "# Copyright (c) Microsoft Corporation.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n\nimport asyncio\nimport io\nimport json\nimport os\nimport subprocess\nimport sys\nfrom abc import ABC, abstractmethod\nfrom typing import Callable, Dict, Optional, Union\n\nfrom playwright._impl._driver import compute_driver_executable, get_driver_env\nfrom playwright._impl._helper import ParsedMessagePayload\n\n\n# Sourced from: https://github.com/pytest-dev/pytest/blob/da01ee0a4bb0af780167ecd228ab3ad249511302/src/_pytest/faulthandler.py#L69-L77\ndef _get_stderr_fileno() -> Optional[int]:\n try:\n # when using pythonw, sys.stderr is None.\n # when Pyinstaller is used, there is no closed attribute because Pyinstaller monkey-patches it with a NullWriter class\n if sys.stderr is None or not hasattr(sys.stderr, \"closed\"):\n return None\n if sys.stderr.closed:\n return None\n\n return sys.stderr.fileno()\n except (NotImplementedError, AttributeError, io.UnsupportedOperation):\n # pytest-xdist monkeypatches sys.stderr with an object that is not an actual file.\n # https://docs.python.org/3/library/faulthandler.html#issue-with-file-descriptors\n # This is potentially dangerous, but the best we can do.\n if not hasattr(sys, \"__stderr__\") or not sys.__stderr__:\n return None\n return sys.__stderr__.fileno()\n\n\nclass Transport(ABC):\n def __init__(self, loop: asyncio.AbstractEventLoop) -> None:\n self._loop = loop\n self.on_message: Callable[[ParsedMessagePayload], None] = lambda _: None\n self.on_error_future: asyncio.Future = loop.create_future()\n\n @abstractmethod\n def request_stop(self) -> None:\n pass\n\n def dispose(self) -> None:\n pass\n\n @abstractmethod\n async def wait_until_stopped(self) -> None:\n pass\n\n @abstractmethod\n async def connect(self) -> None:\n pass\n\n @abstractmethod\n async def run(self) -> None:\n pass\n\n @abstractmethod\n def send(self, message: Dict) -> None:\n pass\n\n def serialize_message(self, message: Dict) -> bytes:\n msg = json.dumps(message)\n if \"DEBUGP\" in os.environ: # pragma: no cover\n print(\"\\x1b[32mSEND>\\x1b[0m\", json.dumps(message, indent=2))\n return msg.encode()\n\n def deserialize_message(self, data: Union[str, bytes]) -> ParsedMessagePayload:\n obj = json.loads(data)\n\n if \"DEBUGP\" in os.environ: # pragma: no cover\n print(\"\\x1b[33mRECV>\\x1b[0m\", json.dumps(obj, indent=2))\n return obj\n\n\nclass PipeTransport(Transport):\n def __init__(self, loop: asyncio.AbstractEventLoop) -> None:\n super().__init__(loop)\n self._stopped = False\n\n def request_stop(self) -> None:\n assert self._output\n self._stopped = True\n self._output.close()\n\n async def wait_until_stopped(self) -> None:\n await self._stopped_future\n\n async def connect(self) -> None:\n self._stopped_future: asyncio.Future = asyncio.Future()\n\n try:\n # For pyinstaller and Nuitka\n env = get_driver_env()\n if getattr(sys, \"frozen\", False) or globals().get(\"__compiled__\"):\n env.setdefault(\"PLAYWRIGHT_BROWSERS_PATH\", \"0\")\n\n startupinfo = None\n if sys.platform == \"win32\":\n startupinfo = subprocess.STARTUPINFO()\n startupinfo.dwFlags |= subprocess.STARTF_USESHOWWINDOW\n startupinfo.wShowWindow = subprocess.SW_HIDE\n\n executable_path, entrypoint_path = compute_driver_executable()\n self._proc = await asyncio.create_subprocess_exec(\n executable_path,\n entrypoint_path,\n \"run-driver\",\n stdin=asyncio.subprocess.PIPE,\n stdout=asyncio.subprocess.PIPE,\n stderr=_get_stderr_fileno(),\n limit=32768,\n env=env,\n startupinfo=startupinfo,\n )\n except Exception as exc:\n self.on_error_future.set_exception(exc)\n raise exc\n\n self._output = self._proc.stdin\n\n async def run(self) -> None:\n assert self._proc.stdout\n assert self._proc.stdin\n while not self._stopped:\n try:\n buffer = await self._proc.stdout.readexactly(4)\n if self._stopped:\n break\n length = int.from_bytes(buffer, byteorder=\"little\", signed=False)\n buffer = bytes(0)\n while length:\n to_read = min(length, 32768)\n data = await self._proc.stdout.readexactly(to_read)\n if self._stopped:\n break\n length -= to_read\n if len(buffer):\n buffer = buffer + data\n else:\n buffer = data\n if self._stopped:\n break\n\n obj = self.deserialize_message(buffer)\n self.on_message(obj)\n except asyncio.IncompleteReadError:\n if not self._stopped:\n self.on_error_future.set_exception(\n Exception(\"Connection closed while reading from the driver\")\n )\n break\n await asyncio.sleep(0)\n\n await self._proc.communicate()\n self._stopped_future.set_result(None)\n\n def send(self, message: Dict) -> None:\n assert self._output\n data = self.serialize_message(message)\n self._output.write(\n len(data).to_bytes(4, byteorder=\"little\", signed=False) + data\n )\n" }, { "path": "playwright/_impl/_video.py", "content": "# Copyright (c) Microsoft Corporation.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n\nimport pathlib\nfrom typing import TYPE_CHECKING, Union\n\nfrom playwright._impl._artifact import Artifact\nfrom playwright._impl._helper import Error\n\nif TYPE_CHECKING: # pragma: no cover\n from playwright._impl._page import Page\n\n\nclass Video:\n def __init__(self, page: \"Page\") -> None:\n self._loop = page._loop\n self._dispatcher_fiber = page._dispatcher_fiber\n self._page = page\n self._artifact_future = page._loop.create_future()\n if page.is_closed():\n self._page_closed()\n else:\n page.on(\"close\", lambda page: self._page_closed())\n\n def __repr__(self) -> str:\n return f\"