Skip to main content

Undetected Python version of the Playwright testing and automation library.

Project description

🎭 Patchright Python

Patchright Version GitHub Downloads (all assets, all releases)

Patchright is a patched and undetected version of the Playwright Testing and Automation Framework.
It can be used as a drop-in replacement for Playwright.

[!NOTE]
This repository serves the Patchright-Python Package. To use Patchright with NodeJS, check out the NodeJS Package. Also check out the main Patchright Driver Repository


Install it from PyPI

# Install Patchright with Pip from PyPI
pip install patchright
# Install Chromium-Driver for Patchright
patchright install chromium

Usage

Just change the import and use it like playwright. Patchright is a drop-in-replacement for Playwright!

[!IMPORTANT]
Patchright only patches CHROMIUM based browsers. Firefox and Webkit are not supported.

# patchright here!
from patchright.sync_api import sync_playwright

with sync_playwright() as p:
    browser = p.chromium.launch()
    page = browser.new_page()
    page.goto('http://playwright.dev')
    page.screenshot(path=f'example-{p.chromium.name}.png')
    browser.close()
import asyncio
# patchright here!
from patchright.async_api import async_playwright

async def main():
    async with async_playwright() as p:
        browser = await p.chromium.launch()
        page = await browser.new_page()
        await page.goto('http://playwright.dev')
        await page.screenshot(path=f'example-{p.chromium.name}.png')
        await browser.close()

asyncio.run(main())

Best Practice - use Chrome without Fingerprint Injection

To be completely undetected, use the following configuration:

playwright.chromium.launch_persistent_context(
    user_data_dir="...",
    channel="chrome",
    headless=False,
    no_viewport=True,
    # do NOT add custom browser headers or user_agent
    ...
)

[!NOTE]
We recommend using Google Chrome instead of Chromium. You can install it via patchright install chrome (or via any other installation method) and use it with channel="chrome".


Patches

Runtime.enable Leak

This is the biggest Patch Patchright uses. To avoid detection by this leak, patchright avoids using Runtime.enable by executing Javascript in (isolated) ExecutionContexts.

Console.enable Leak

Patchright patches this leak by disabling the Console API all together. This means, console functionality will not work in Patchright. If you really need the console, you might be better off using Javascript loggers, although they also can be easily detected.

Command Flags Leaks

Patchright tweaks the Playwright Default Args to avoid detection by Command Flag Leaks. This (most importantly) affects:

  • --disable-blink-features=AutomationControlled (added) to avoid navigator.webdriver detection.
  • --enable-automation (removed) to avoid navigator.webdriver detection.
  • --disable-popup-blocking (removed) to avoid popup crashing.
  • --disable-component-update (removed) to avoid detection as a Stealth Driver.
  • --disable-default-apps (removed) to enable default apps.
  • --disable-extensions (removed) to enable extensions

General Leaks

Patchright patches some general leaks in the Playwright codebase. This mainly includes poor setups and obvious detection points.

Closed Shadow Roots

Patchright is able to interact with elements in Closed Shadow Roots. Just use normal locators and Patchright will do the rest.
Patchright is now also able to use XPaths in Closed Shadow Roots.


Stealth

With the right setup, Patchright currently is considered undetectable. Patchright passes:


Documentation and API Reference

See the original Playwright Documentation and API Reference

Extended Patchright API

evaluate Method (Frame.evaluate, Page.evaluate, Locator.evaluate, Worker.evaluate)

  • Added isolated_context to choose Execution Context (Main/Isolated). Bool (optional, Defaults to True)
object.evaluate(
    expression: str,
    arg: typing.Optional[typing.Any] = None,
    ...,
+   isolated_context: typing.Optional[bool] = True
)

evaluate_handle Method (Frame.evaluate_handle, Page.evaluate_handle, Locator.evaluate_handle, Worker.evaluate_handle)

  • Added isolated_context to choose Execution Context (Main/Isolated). Bool (optional, Defaults to True)
object.evaluate_handle(
    expression: str,
    arg: typing.Optional[typing.Any] = None,
    ...,
+   isolated_context: typing.Optional[bool] = True
)

Bugs

The bugs are documented in the Patchright Driver Repository.


TODO

The TODO is documented in the Patchright Driver Repository.


Development

Deployment of new Patchright versions are automatic, but bugs due to Playwright codebase changes may occur. Fixes for these bugs might take a few days to be released.


Support our work

If you choose to support our work, please contact @vinyzu or @steve_abcdef on Discord.


Copyright and License

© Vinyzu

Patchright is licensed Apache 2.0


Disclaimer

This repository is provided for educational purposes only.
No warranties are provided regarding accuracy, completeness, or suitability for any purpose. Use at your own risk—the authors and maintainers assume no liability for any damages, legal issues, or warranty breaches resulting from use, modification, or distribution of this code.
Any misuse or legal violations are the sole responsibility of the user.


Authors

Active Maintainer: Vinyzu
Co-Maintainer: Kaliiiiiiiiii

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distributions

patchright-1.51.3-py3-none-win_amd64.whl (34.8 MB view details)

Uploaded Python 3 Windows x86-64

patchright-1.51.3-py3-none-win32.whl (34.8 MB view details)

Uploaded Python 3 Windows x86

patchright-1.51.3-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.whl (44.5 MB view details)

Uploaded Python 3 manylinux: glibc 2.17+ ARM64

patchright-1.51.3-py3-none-macosx_11_0_universal2.whl (39.6 MB view details)

Uploaded Python 3 macOS 11.0+ universal2 (ARM64, x86-64)

patchright-1.51.3-py3-none-macosx_11_0_arm64.whl (38.0 MB view details)

Uploaded Python 3 macOS 11.0+ ARM64

patchright-1.51.3-py3-none-macosx_10_13_x86_64.whl (39.6 MB view details)

Uploaded Python 3 macOS 10.13+ x86-64

File details

Details for the file patchright-1.51.3-py3-none-win_amd64.whl.

File metadata

File hashes

Hashes for patchright-1.51.3-py3-none-win_amd64.whl
Algorithm Hash digest
SHA256 a64c5c05f724e6097b227142e56cf2e46ce6cd549cdf8f7708c074024b486761
MD5 d32c0672e8820eb1091f18265ae05f5b
BLAKE2b-256 6efd97e3e26893904bdeff36d54e6ea5fe5f81a245a96c1b73ebe37e956ce11d

See more details on using hashes here.

Provenance

The following attestation bundles were made for patchright-1.51.3-py3-none-win_amd64.whl:

Publisher: patchright_workflow.yml on Kaliiiiiiiiii-Vinyzu/patchright-python

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file patchright-1.51.3-py3-none-win32.whl.

File metadata

  • Download URL: patchright-1.51.3-py3-none-win32.whl
  • Upload date:
  • Size: 34.8 MB
  • Tags: Python 3, Windows x86
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for patchright-1.51.3-py3-none-win32.whl
Algorithm Hash digest
SHA256 b0e21d719df80656cfa9066de73b2e4ab4cfddc634829bfa2f6d6c82bc05f3f3
MD5 98e368c085c304102c2a3ae8a1a547c2
BLAKE2b-256 e9c609c37de986bc883f9c9cefec1b9f92857b5db7bfe3915f3cbbcb45d0ef66

See more details on using hashes here.

Provenance

The following attestation bundles were made for patchright-1.51.3-py3-none-win32.whl:

Publisher: patchright_workflow.yml on Kaliiiiiiiiii-Vinyzu/patchright-python

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file patchright-1.51.3-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.whl.

File metadata

File hashes

Hashes for patchright-1.51.3-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.whl
Algorithm Hash digest
SHA256 33d9ec53bdc0c88e869b88beefca5e2a3576693370c4db0235c733b184d7df92
MD5 eb91b1491bca8aa41e3e4dc806498fb1
BLAKE2b-256 8109e6126d32175f96ea963616debbb8e380e7c987ca913efeb59bf7e7f39438

See more details on using hashes here.

Provenance

The following attestation bundles were made for patchright-1.51.3-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.whl:

Publisher: patchright_workflow.yml on Kaliiiiiiiiii-Vinyzu/patchright-python

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file patchright-1.51.3-py3-none-manylinux1_x86_64.whl.

File metadata

File hashes

Hashes for patchright-1.51.3-py3-none-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 6a5259077e9b0b5c8668fe26c9c50725a2691739f2d5d761bc9ff96b8d3e03f5
MD5 cbd44d355f9c36e7428c7956b5832c1a
BLAKE2b-256 70cbe7cd2f6161e30a4009cf38dd00024b1303197afcd4297081b0ccd21016a8

See more details on using hashes here.

Provenance

The following attestation bundles were made for patchright-1.51.3-py3-none-manylinux1_x86_64.whl:

Publisher: patchright_workflow.yml on Kaliiiiiiiiii-Vinyzu/patchright-python

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file patchright-1.51.3-py3-none-macosx_11_0_universal2.whl.

File metadata

File hashes

Hashes for patchright-1.51.3-py3-none-macosx_11_0_universal2.whl
Algorithm Hash digest
SHA256 8b9ab3a9a83bd1a0dd47cc2de74f2064bac25e689b106e6d852951d588fa5c82
MD5 cf566545e8a55e5a8776c83ee4b30069
BLAKE2b-256 1a55d62c85fff36e9e9e515ee92407b02acb556e6832d4fbcc8624b638cf70bb

See more details on using hashes here.

Provenance

The following attestation bundles were made for patchright-1.51.3-py3-none-macosx_11_0_universal2.whl:

Publisher: patchright_workflow.yml on Kaliiiiiiiiii-Vinyzu/patchright-python

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file patchright-1.51.3-py3-none-macosx_11_0_arm64.whl.

File metadata

File hashes

Hashes for patchright-1.51.3-py3-none-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 6db73035997b39b5696bc888a5822b2ee1e63078d23a693861be2087e8b81d79
MD5 cf12df94fc1ba34c129441ef2e6f1b0d
BLAKE2b-256 55204df3f817c28938e22ee7c7c4b28d8b3a212e5a111c3bd9633bc410267daa

See more details on using hashes here.

Provenance

The following attestation bundles were made for patchright-1.51.3-py3-none-macosx_11_0_arm64.whl:

Publisher: patchright_workflow.yml on Kaliiiiiiiiii-Vinyzu/patchright-python

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file patchright-1.51.3-py3-none-macosx_10_13_x86_64.whl.

File metadata

File hashes

Hashes for patchright-1.51.3-py3-none-macosx_10_13_x86_64.whl
Algorithm Hash digest
SHA256 a363d0fbe426e8934f9d27276777d072f102bb990e10f976a320360c5b20214f
MD5 f69ff3bbfdd612780b431e8d6249354d
BLAKE2b-256 16ee41d12534aedaf502f5a7daa791ef08709652c6ee92570fd5089f71631f3c

See more details on using hashes here.

Provenance

The following attestation bundles were made for patchright-1.51.3-py3-none-macosx_10_13_x86_64.whl:

Publisher: patchright_workflow.yml on Kaliiiiiiiiii-Vinyzu/patchright-python

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page